🤖 Merge PR DefinitelyTyped#74613 Add initial typings for @hotwired/turbo-rails by @myabc

Author: myabc

types/hotwired__turbo-rails/.npmignore

@@ -0,0 +1,5 @@
+*
+!**/*.d.ts
+!**/*.d.cts
+!**/*.d.mts
+!**/*.d.*.ts

types/hotwired__turbo-rails/hotwired__turbo-rails-tests.ts

@@ -0,0 +1,83 @@
+import { cable, Turbo } from "@hotwired/turbo-rails";
+
+// === Turbo re-export ===
+
+// $ExpectType void
+Turbo.visit("https://example.com");
+
+// $ExpectType void
+Turbo.visit("https://example.com", { action: "advance" });
+
+// $ExpectType void
+Turbo.start();
+
+const source: Turbo.StreamSource = {
+    addEventListener(
+        type: "message",
+        listener: (event: MessageEvent) => void,
+        options?: AddEventListenerOptions,
+    ): void {},
+    removeEventListener(
+        type: "message",
+        listener: (event: MessageEvent) => void,
+        options?: EventListenerOptions,
+    ): void {},
+};
+
+// $ExpectType void
+Turbo.connectStreamSource(source);
+
+// $ExpectType void
+Turbo.disconnectStreamSource(source);
+
+// === cable namespace ===
+
+async function testCable() {
+    // $ExpectType Consumer
+    const consumer = await cable.getConsumer();
+
+    // $ExpectType Consumer
+    cable.setConsumer(consumer);
+
+    // $ExpectType Consumer
+    const newConsumer = await cable.createConsumer();
+
+    // $ExpectType Subscription<BaseMixin>
+    const subscription = await cable.subscribeTo("ChatChannel");
+
+    // $ExpectType Subscription<BaseMixin>
+    const subscriptionWithParams = await cable.subscribeTo({ channel: "ChatChannel", room: "1" });
+
+    // subscribeTo with mixin
+    const sub = await cable.subscribeTo("ChatChannel", {
+        connected() {},
+        received(data: any) {
+            console.log(data);
+        },
+    });
+}
+
+// @ts-expect-error
+cable.setConsumer("not a consumer");
+
+// === turbo-cable-stream-source custom element ===
+
+const streamSource = document.querySelector("turbo-cable-stream-source")!;
+
+// $ExpectType TurboCableStreamSourceElement
+streamSource;
+
+// $ExpectType Promise<void>
+streamSource.connectedCallback();
+
+// $ExpectType void
+streamSource.disconnectedCallback();
+
+// $ExpectType boolean
+streamSource.dispatchMessageEvent("<turbo-stream action='replace'></turbo-stream>");
+
+// $ExpectType ChannelNameWithParams
+streamSource.channel;
+
+// @ts-expect-error — channel is readonly
+streamSource.channel = { channel: "test" };

types/hotwired__turbo-rails/index.d.ts

@@ -0,0 +1,32 @@
+import * as Turbo from "@hotwired/turbo";
+import { BaseMixin, ChannelNameWithParams, Consumer, Subscription } from "@rails/actioncable";
+
+export { Turbo };
+
+export namespace cable {
+    function getConsumer(): Promise<Consumer>;
+    function setConsumer(newConsumer: Consumer): Consumer;
+    function createConsumer(): Promise<Consumer>;
+    function subscribeTo<M extends BaseMixin = {}>(
+        channel: string | ChannelNameWithParams,
+        mixin?: M & ThisType<Subscription & M>,
+    ): Promise<Subscription & M>;
+}
+
+declare class TurboCableStreamSourceElement extends HTMLElement {
+    static readonly observedAttributes: string[];
+    connectedCallback(): Promise<void>;
+    disconnectedCallback(): void;
+    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): void;
+    dispatchMessageEvent(data: string): boolean;
+    subscriptionConnected(): void;
+    subscriptionDisconnected(): void;
+    readonly channel: ChannelNameWithParams;
+    subscription: Subscription | undefined;
+}
+
+declare global {
+    interface HTMLElementTagNameMap {
+        "turbo-cable-stream-source": TurboCableStreamSourceElement;
+    }
+}

types/hotwired__turbo-rails/package.json

@@ -0,0 +1,25 @@
+{
+    "private": true,
+    "name": "@types/hotwired__turbo-rails",
+    "version": "8.0.9999",
+    "projects": [
+        "https://github.com/hotwired/turbo-rails"
+    ],
+    "dependencies": {
+        "@types/hotwired__turbo": "*",
+        "@types/rails__actioncable": "*"
+    },
+    "devDependencies": {
+        "@types/hotwired__turbo-rails": "workspace:."
+    },
+    "owners": [
+        {
+            "name": "Alexander Brandon Coles",
+            "githubUsername": "myabc"
+        },
+        {
+            "name": "Gareth Jones",
+            "githubUsername": "G-Rath"
+        }
+    ]
+}

types/hotwired__turbo-rails/tsconfig.json

@@ -0,0 +1,20 @@
+{
+    "compilerOptions": {
+        "module": "node16",
+        "lib": [
+            "es6",
+            "dom"
+        ],
+        "noImplicitAny": true,
+        "noImplicitThis": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+        "hotwired__turbo-rails-tests.ts"
+    ]
+}