@shelamkoff/rector 1.0.0

package/dist/plugins/embed/index.d.ts

@@ -0,0 +1,271 @@
+import type {} from './locale/keys.js'
+/**
+ * @typedef {Object} EmbedPreview
+ * @property {string} thumbnailUrl Sanitized preview-image URL returned by the resolver.
+ * @property {string} [title] Optional plain-text alternative for the preview image.
+ */
+/**
+ * @typedef {Object} EmbedData
+ * @property {'youtube' | 'vimeo' | ''} service Provider selected from the parsed video URL; an empty value represents an unconfigured block.
+ * @property {string} videoId Provider-specific video identifier without the surrounding URL.
+ * @property {string} caption Sanitized rich-text caption displayed below the player.
+ * @property {string} cover Sanitized media URL for a consumer-selected cover image.
+ * @property {string} title Plain-text presentation title shown by the editor controls.
+ * @property {string} duration Plain-text presentation duration supplied by the author.
+ */
+/**
+ * @typedef {Object} EmbedConfig
+ * @property {(file: File, context: { signal: AbortSignal }) => Promise<{ url: string }>} [uploadFile] Uploads a custom cover image. Without it the selected cover uses a temporary object URL that is valid until editor disposal.
+ * @property {Array<{
+ *   icon?: string,
+ *   label: string,
+ *   handler: (context: { signal: AbortSignal }) => Promise<{ url: string } | null>
+ * }>} [actions]
+ *   Additional application-owned cover selectors such as a media library. `icon` is trusted application-owned SVG/HTML.
+ * @property {false | ((request: {
+ *   service: 'vimeo', videoId: string, url: string, signal: AbortSignal
+ * }) => Promise<EmbedPreview | null>)} [resolvePreview]
+ *   `false` disables remote preview resolution; omitted uses Vimeo oEmbed.
+ * @property {number} [previewTimeoutMs]
+ *   Maximum Vimeo preview-resolution time in milliseconds. Non-finite values
+ *   use the 5000 ms default; finite values are clamped to zero.
+ * @property {boolean} [injectStyles=true] Whether the editor should load the built-in embed stylesheet.
+ * @property {string} [css] Additional stylesheet URL, or the replacement URL when `injectStyles` is `false`.
+ */
+/**
+ * Editable video embed block for supported media services and presentation metadata.
+ * @extends {BlockPluginAbstract<EmbedConfig>}
+ */
+export class Embed extends BlockPluginAbstract<EmbedConfig> {
+    static isTextBlock: boolean;
+    static styles: string[];
+    /**
+     * Create an Embed instance with the supplied consumer configuration.
+     * @param {EmbedConfig} [config]
+     */
+    constructor(config?: EmbedConfig);
+    type: string;
+    icon: string;
+    inlineTools: boolean;
+    pasteConfig: {
+        patterns: RegExp[];
+    };
+    /**
+     * Return the localized toolbox label for this block.
+     * @returns {string} Localized toolbox title.
+     */
+    get title(): string;
+    /** Create an empty, serializable embed value. @returns {EmbedData} */
+    _defaultData(): EmbedData;
+    /**
+     * Create the editable DOM owned by this block instance.
+     * @param {Record<string, unknown>} data
+     * @param {import('../../core/types.js').BlockMutationContext} context
+     * @returns {HTMLElement}
+     */
+    render(data: Record<string, unknown>, context: import("../../core/types.js").BlockMutationContext): HTMLElement;
+    /**
+     * Serialize the current block DOM into document data.
+     * @param {HTMLElement} element @returns {EmbedData}
+     */
+    save(element: HTMLElement): EmbedData;
+    /**
+     * Check whether serialized data satisfies this block's schema.
+     * @param {Record<string, unknown>} data @returns {boolean}
+     */
+    validate(data: Record<string, unknown>): boolean;
+    /**
+     * Check whether the block has no meaningful user content.
+     * @param {HTMLElement} element @returns {boolean}
+     */
+    isEmpty(element: HTMLElement): boolean;
+    /**
+     * Extract neutral text that can initialize another block type.
+     * @param {HTMLElement} element @returns {{ text: string }}
+     */
+    exportData(element: HTMLElement): {
+        text: string;
+    };
+    /**
+     * Handle supported pasted content for this block.
+     * @param {import('../../types.js').PasteEvent} event
+     * @returns {EmbedData | null}
+     */
+    onPaste(event: import("../../types.js").PasteEvent): EmbedData | null;
+    /**
+     * Release listeners and resources owned by this block element.
+     * @param {HTMLElement} element @returns {void}
+     */
+    destroy(element: HTMLElement): void;
+    /**
+     * Release temporary local covers after the editor has discarded its blocks
+     * and undo history.
+     * @returns {void}
+     */
+    dispose(): void;
+    /**
+     * Start a fresh lifetime for the current player, caption, actions, and
+     * provider-preview request.
+     * @param {HTMLElement} wrapper
+     * @returns {void}
+     */
+    _beginView(wrapper: HTMLElement): void;
+    /** @param {HTMLElement} wrapper @returns {void} */
+    _renderUrlBar(wrapper: HTMLElement): void;
+    /**
+     * @param {HTMLElement} wrapper
+     * @param {string} url
+     * @returns {void}
+     */
+    _processUrl(wrapper: HTMLElement, url: string): void;
+    /** @param {HTMLElement} wrapper @returns {void} */
+    _removePlayerElements(wrapper: HTMLElement): void;
+    /** @param {HTMLElement} wrapper @returns {void} */
+    _renderPlayer(wrapper: HTMLElement): void;
+    /** @param {HTMLElement} wrapper @returns {void} */
+    _renderCaption(wrapper: HTMLElement): void;
+    /** @param {HTMLElement} wrapper @returns {void} */
+    _renderActions(wrapper: HTMLElement): void;
+    /**
+     * Show the cover drill-down sub-view: Back, Upload, custom sources, URL, Remove.
+     * @param {HTMLElement} wrapper
+     * @param {HTMLElement} actions
+     * @param {HTMLElement} mainView
+     * @param {AbortSignal} signal
+     * @returns {void}
+     */
+    _showCoverView(wrapper: HTMLElement, actions: HTMLElement, mainView: HTMLElement, signal: AbortSignal): void;
+    /**
+     * @param {HTMLElement} wrapper
+     * @returns {HTMLElement}
+     */
+    _buildSettingsPanel(wrapper: HTMLElement): HTMLElement;
+    /**
+     * @param {string} label
+     * @param {string} value
+     * @param {(v: string) => void} onChange
+     * @returns {HTMLElement}
+     */
+    _makeInputRow(label: string, value: string, onChange: (v: string) => void): HTMLElement;
+    /**
+     * @param {HTMLElement} wrapper
+     * @param {string} cls
+     * @param {string} text
+     * @returns {void}
+     */
+    _updateOverlay(wrapper: HTMLElement, cls: string, text: string): void;
+    /** @param {HTMLElement} wrapper @returns {void} */
+    _rebuildPlayer(wrapper: HTMLElement): void;
+    /** @param {HTMLElement} wrapper @returns {void} */
+    _play(wrapper: HTMLElement): void;
+    /** @param {HTMLElement} wrapper @returns {void} */
+    _triggerCoverUpload(wrapper: HTMLElement): void;
+    /**
+     * @param {HTMLElement} wrapper
+     * @param {File} file
+     * @returns {Promise<void>}
+     */
+    _uploadCover(wrapper: HTMLElement, file: File): Promise<void>;
+    /**
+     * @param {HTMLElement} wrapper
+     * @returns {Promise<void>}
+     */
+    _fetchVimeoPreview(wrapper: HTMLElement): Promise<void>;
+    /**
+     * @param {string} html
+     * @param {() => void | Promise<void>} handler
+     * @param {AbortSignal} [signal]
+     * @returns {HTMLButtonElement}
+     */
+    _makeBtn(html: string, handler: () => void | Promise<void>, signal?: AbortSignal): HTMLButtonElement;
+    /** @returns {HTMLDivElement} */
+    _makeSep(): HTMLDivElement;
+    /**
+     * @param {HTMLElement} anchor
+     * @param {HTMLElement} panel
+     * @returns {void}
+     */
+    _positionPanel(anchor: HTMLElement, panel: HTMLElement): void;
+    #private;
+}
+export type EmbedPreview = {
+    /**
+     * Sanitized preview-image URL returned by the resolver.
+     */
+    thumbnailUrl: string;
+    /**
+     * Optional plain-text alternative for the preview image.
+     */
+    title?: string;
+};
+export type EmbedData = {
+    /**
+     * Provider selected from the parsed video URL; an empty value represents an unconfigured block.
+     */
+    service: "youtube" | "vimeo" | "";
+    /**
+     * Provider-specific video identifier without the surrounding URL.
+     */
+    videoId: string;
+    /**
+     * Sanitized rich-text caption displayed below the player.
+     */
+    caption: string;
+    /**
+     * Sanitized media URL for a consumer-selected cover image.
+     */
+    cover: string;
+    /**
+     * Plain-text presentation title shown by the editor controls.
+     */
+    title: string;
+    /**
+     * Plain-text presentation duration supplied by the author.
+     */
+    duration: string;
+};
+export type EmbedConfig = {
+    /**
+     * Uploads a custom cover image. Without it the selected cover uses a temporary object URL that is valid until editor disposal.
+     */
+    uploadFile?: (file: File, context: {
+        signal: AbortSignal;
+    }) => Promise<{
+        url: string;
+    }>;
+    /**
+     * Additional application-owned cover selectors such as a media library. `icon` is trusted application-owned SVG/HTML.
+     */
+    actions?: Array<{
+        icon?: string;
+        label: string;
+        handler: (context: {
+            signal: AbortSignal;
+        }) => Promise<{
+            url: string;
+        } | null>;
+    }>;
+    /**
+     * `false` disables remote preview resolution; omitted uses Vimeo oEmbed.
+     */
+    resolvePreview?: false | ((request: {
+        service: "vimeo";
+        videoId: string;
+        url: string;
+        signal: AbortSignal;
+    }) => Promise<EmbedPreview | null>);
+    /**
+     * Maximum Vimeo preview-resolution time in milliseconds. Non-finite values
+     * use the 5000 ms default; finite values are clamped to zero.
+     */
+    previewTimeoutMs?: number;
+    /**
+     * Whether the editor should load the built-in embed stylesheet.
+     */
+    injectStyles?: boolean;
+    /**
+     * Additional stylesheet URL, or the replacement URL when `injectStyles` is `false`.
+     */
+    css?: string;
+};
+import { BlockPluginAbstract } from '../BlockPluginAbstract.js';