@shelamkoff/rector 1.0.0

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

@@ -0,0 +1,137 @@
+import type {} from './locale/keys.js'
+/**
+ * @typedef {import('../../shared/carouselData.js').CarouselData} CarouselData
+ * @typedef {import('../../shared/carouselData.js').CarouselSlide} CarouselSlide
+ * @typedef {Object} CarouselAction
+ * @property {string} label User-visible label for the application-owned source.
+ * @property {string} [icon] Trusted application-provided SVG or HTML markup.
+ * @property {(context: { signal: AbortSignal }) => Promise<CarouselSlide[] | null>} handler Loads slides and observes the supplied lifecycle signal.
+ * @typedef {Object} CarouselConfig
+ * @property {(file: File, context: { signal: AbortSignal }) => Promise<{ url: string, poster?: string }>} [uploadFile] Uploads an image or video selected in the browser. Without this callback images become data URLs, while videos use temporary object URLs retained until editor disposal.
+ * @property {CarouselAction[]} [actions] Additional application-owned slide sources such as a media library. Returned slides are normalized and unusable entries are ignored.
+ * @property {boolean} [injectStyles=true] Whether the editor should load the built-in carousel stylesheet.
+ * @property {string} [css] Additional stylesheet URL, or the replacement URL when `injectStyles` is `false`.
+ */
+/**
+ * Editable mixed-media carousel with extensible file sources and display controls.
+ * @extends {BlockPluginAbstract<CarouselConfig>}
+ */
+export class CarouselBlock extends BlockPluginAbstract<CarouselConfig> {
+    static isTextBlock: boolean;
+    static styles: string[];
+    constructor(config?: CarouselConfig);
+    type: string;
+    icon: string;
+    inlineTools: boolean;
+    pasteConfig: {
+        files: string[];
+    };
+    /**
+     * Return the localized toolbox label for this block.
+     * @returns {string}
+     */
+    get title(): string;
+    /**
+     * Create the editable DOM owned by this block instance.
+     * @param {Record<string, unknown>} data Serialized carousel data.
+     * @param {import('../../core/types.js').BlockMutationContext} context Editor mutation and lifecycle context.
+     * @returns {HTMLElement} Root element owned by this block render.
+     */
+    render(data: Record<string, unknown>, context: import("../../core/types.js").BlockMutationContext): HTMLElement;
+    /**
+     * Serialize the current block DOM into document data.
+     * @param {HTMLElement} element Root element returned by `render()`.
+     * @returns {CarouselData} Normalized serializable carousel data.
+     */
+    save(element: HTMLElement): CarouselData;
+    /**
+     * Check whether serialized data satisfies this block's schema.
+     * @param {Record<string, unknown>} data Candidate serialized block data.
+     * @returns {boolean} Whether the candidate satisfies the carousel schema.
+     */
+    validate(data: Record<string, unknown>): boolean;
+    /**
+     * Check whether the block has no meaningful user content.
+     * @param {HTMLElement} element Root element returned by `render()`.
+     * @returns {boolean} Whether the carousel contains no slides.
+     */
+    isEmpty(element: HTMLElement): boolean;
+    /**
+     * Extract neutral text that can initialize another block type.
+     * @param {HTMLElement} element Root element returned by `render()`.
+     * @returns {{ text: string }} Text assembled from slide captions and alternatives.
+     */
+    exportData(element: HTMLElement): {
+        text: string;
+    };
+    /**
+     * Report whether paste handling completes asynchronously.
+     * @param {HTMLElement} element Root element returned by `render()`.
+     * @returns {Promise<void>} Promise settled after a pending pasted file is handled.
+     */
+    waitForPaste(element: HTMLElement): Promise<void>;
+    /**
+     * Release listeners and resources owned by this block element.
+     * @param {HTMLElement} element Root element returned by `render()`.
+     * @returns {void}
+     */
+    destroy(element: HTMLElement): void;
+    /**
+     * Release temporary local video URLs after the owning editor has discarded
+     * its blocks and history snapshots.
+     * @returns {void}
+     */
+    dispose(): void;
+    /**
+     * Handle supported pasted content for this block.
+     * @param {import('../../types.js').PasteEvent} event Normalized editor paste event.
+     * @returns {{ _pendingFile: File } | null} Deferred file marker, or `null` for unsupported content.
+     */
+    onPaste(event: import("../../types.js").PasteEvent): {
+        _pendingFile: File;
+    } | null;
+    #private;
+}
+export { CarouselBlock as Carousel };
+export type CarouselData = import("../../shared/carouselData.js").CarouselData;
+export type CarouselSlide = import("../../shared/carouselData.js").CarouselSlide;
+export type CarouselAction = {
+    /**
+     * User-visible label for the application-owned source.
+     */
+    label: string;
+    /**
+     * Trusted application-provided SVG or HTML markup.
+     */
+    icon?: string;
+    /**
+     * Loads slides and observes the supplied lifecycle signal.
+     */
+    handler: (context: {
+        signal: AbortSignal;
+    }) => Promise<CarouselSlide[] | null>;
+};
+export type CarouselConfig = {
+    /**
+     * Uploads an image or video selected in the browser. Without this callback images become data URLs, while videos use temporary object URLs retained until editor disposal.
+     */
+    uploadFile?: (file: File, context: {
+        signal: AbortSignal;
+    }) => Promise<{
+        url: string;
+        poster?: string;
+    }>;
+    /**
+     * Additional application-owned slide sources such as a media library. Returned slides are normalized and unusable entries are ignored.
+     */
+    actions?: CarouselAction[];
+    /**
+     * Whether the editor should load the built-in carousel stylesheet.
+     */
+    injectStyles?: boolean;
+    /**
+     * Additional stylesheet URL, or the replacement URL when `injectStyles` is `false`.
+     */
+    css?: string;
+};
+import { BlockPluginAbstract } from '../BlockPluginAbstract.js';