@types/hotwired__turbo 8.0.0

hotwired__turbo/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

hotwired__turbo/README.md

@@ -0,0 +1,15 @@
+# Installation
+> `npm install --save @types/hotwired__turbo`
+
+# Summary
+This package contains type definitions for @hotwired/turbo (https://turbo.hotwired.dev).
+
+# Details
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hotwired__turbo.
+
+### Additional Details
+ * Last updated: Mon, 26 Feb 2024 17:35:19 GMT
+ * Dependencies: none
+
+# Credits
+These definitions were written by [Gareth Jones](https://github.com/G-Rath), and [Luke Davia](https://github.com/lukeify).

hotwired__turbo/index.d.ts

@@ -0,0 +1,111 @@
+export class FrameElement extends HTMLElement {
+    src: string;
+    disabled: boolean;
+    loading: "eager" | "lazy";
+    loaded: Promise<void>;
+    autoscroll: boolean;
+
+    readonly complete: boolean;
+    readonly isActive: boolean;
+    readonly isPreview: boolean;
+
+    reload(): Promise<void>;
+}
+
+export class StreamElement extends HTMLElement {
+    connectedCallback(): Promise<void>;
+    render(): Promise<void>;
+    disconnect(): void;
+    removeDuplicateTargetChildren(): void;
+
+    /**
+     * The current action.
+     */
+    readonly action: string;
+
+    /**
+     * The current target (an element ID) to which the result will
+     * be rendered.
+     */
+    readonly target: string;
+
+    /**
+     * The current "targets" selector (a CSS selector)
+     */
+    readonly targets: string;
+
+    /**
+     * Reads the request-id attribute
+     */
+    readonly requestId: string;
+}
+
+export class FetchRequest {}
+export class FetchResponse {}
+
+/**
+ * Connects a stream source to the main session.
+ *
+ * @param source Stream source to connect
+ */
+export function connectStreamSource(source: unknown): void;
+
+/**
+ * Disconnects a stream source from the main session.
+ *
+ * @param source Stream source to disconnect
+ */
+export function disconnectStreamSource(source: unknown): void;
+
+/**
+ * Renders a stream message to the main session by appending it to the
+ * current document.
+ *
+ * @param message Message to render
+ */
+export function renderStreamMessage(message: unknown): void;
+
+export interface TurboSession {
+    connectStreamSource(source: unknown): void;
+    disconnectStreamSource(source: unknown): void;
+    renderStreamMessage(message: unknown): void;
+}
+
+export function visit(
+    location: string,
+    options?: { action?: "advance" | "replace"; frame?: string },
+): void;
+
+export interface TurboGlobal {
+    /**
+     * Sets the delay after which the {@link https://turbo.hotwired.dev/handbook/drive#displaying-progress progress bar} will appear during navigation, in milliseconds.
+     * The progress bar appears after 500ms by default.
+     *
+     * Note that this method has no effect when used with the iOS or Android adapters.
+     *
+     * @param delayInMilliseconds
+     */
+    setProgressBarDelay(delayInMilliseconds: number): void;
+
+    /**
+     * Sets the method that is called by links decorated with {@link https://turbo.hotwired.dev/handbook/drive#requiring-confirmation-for-a-visit data-turbo-confirm}.
+     **
+     * The default is the browser’s built in confirm.
+     *
+     * The method should return true if the visit can proceed.
+     *
+     * @param confirmMethod
+     */
+    setConfirmMethod(confirmMethod: () => boolean): void;
+
+    visit(
+        location: string,
+        options?: { action?: "advance" | "replace"; frame?: string },
+    ): void;
+
+    session: TurboSession;
+}
+
+declare global {
+    const Turbo: TurboGlobal;
+}

hotwired__turbo/package.json

@@ -0,0 +1,30 @@
+{
+    "name": "@types/hotwired__turbo",
+    "version": "8.0.0",
+    "description": "TypeScript definitions for @hotwired/turbo",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/hotwired__turbo",
+    "license": "MIT",
+    "contributors": [
+        {
+            "name": "Gareth Jones",
+            "githubUsername": "G-Rath",
+            "url": "https://github.com/G-Rath"
+        },
+        {
+            "name": "Luke Davia",
+            "githubUsername": "lukeify",
+            "url": "https://github.com/lukeify"
+        }
+    ],
+    "main": "",
+    "types": "index.d.ts",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
+        "directory": "types/hotwired__turbo"
+    },
+    "scripts": {},
+    "dependencies": {},
+    "typesPublisherContentHash": "9add7020f634e3f37398181fbfad8008e17daa39c05964888b0aec96ed2642a6",
+    "typeScriptVersion": "4.6"
+}