@openreachtech/furo-vue 1.3.1

package/types/generated/components/organisms/FuroEditor/FuroEditorMentionMenu.vue.d.ts

@@ -0,0 +1,43 @@
+declare const _default: typeof __VLS_export;
+export default _default;
+declare const __VLS_export: import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    items: {
+        /** @type {import('vue').PropType<Array<{ id: string | number, label: string }>>} */
+        type: import("vue").PropType<Array<{
+            id: string | number;
+            label: string;
+        }>>;
+        default: () => any[];
+    };
+    command: {
+        type: import("vue").PropType<(mention: {
+            id: string | number;
+            label: string;
+        }) => void>;
+        required: true;
+    };
+}>, {
+    context: FuroEditorMentionMenuContext;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    items: {
+        /** @type {import('vue').PropType<Array<{ id: string | number, label: string }>>} */
+        type: import("vue").PropType<Array<{
+            id: string | number;
+            label: string;
+        }>>;
+        default: () => any[];
+    };
+    command: {
+        type: import("vue").PropType<(mention: {
+            id: string | number;
+            label: string;
+        }) => void>;
+        required: true;
+    };
+}>> & Readonly<{}>, {
+    items: {
+        id: string | number;
+        label: string;
+    }[];
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+import FuroEditorMentionMenuContext from './FuroEditorMentionMenuContext.js';

package/types/generated/components/organisms/FuroEditor/FuroEditorMentionMenuContext.d.ts

@@ -0,0 +1,159 @@
+/**
+ * Context for the mention suggestion list popup.
+ *
+ * Renders a domain-agnostic list of `{ id, label }` items and forwards the chosen
+ * item back to Tiptap through the injected `command` prop. Keyboard navigation
+ * (up / down / enter) is exposed for the suggestion renderer to drive.
+ *
+ * @extends {BaseFuroContext<null, FuroEditorMentionMenuContextParams['props'], null>}
+ */
+export default class FuroEditorMentionMenuContext extends BaseFuroContext<null, {
+    items: Array<{
+        id: string | number;
+        label: string;
+    }>;
+    command: (mention: {
+        id: string | number;
+        label: string;
+    }) => void;
+} & {
+    parcel?: any;
+}, null> {
+    /**
+     * Factory method.
+     *
+     * @template {X extends typeof FuroEditorMentionMenuContext ? X : never} T, X
+     * @override
+     * @param {FuroEditorMentionMenuContextFactoryParams} params - Parameters of this factory method.
+     * @returns {InstanceType<T>} An instance of this class.
+     * @this {T}
+     */
+    static override create<T extends X extends typeof FuroEditorMentionMenuContext ? X : never, X>(this: T, { props, componentContext, refHash, }: FuroEditorMentionMenuContextFactoryParams): InstanceType<T>;
+    /**
+     * Build ref hash.
+     *
+     * @override
+     * @returns {FuroEditorMentionMenuContextParams['refHash']}
+     */
+    static override buildRefHash(): FuroEditorMentionMenuContextParams["refHash"];
+    /**
+     * Constructor.
+     *
+     * @param {FuroEditorMentionMenuContextParams} params - Parameters of this constructor.
+     */
+    constructor({ props, componentContext, refHash, }: FuroEditorMentionMenuContextParams);
+    refHash: {
+        selectedIndexRef: import("vue").Ref<number>;
+    };
+    /**
+     * get: mention items.
+     *
+     * @returns {Array<{ id: string | number, label: string }>} - Items.
+     */
+    get items(): Array<{
+        id: string | number;
+        label: string;
+    }>;
+    /**
+     * get: currently highlighted index.
+     *
+     * @returns {number} - Selected index.
+     */
+    get selectedIndex(): number;
+    /**
+     * Whether there are any items to show.
+     *
+     * @returns {boolean} - true when non-empty.
+     */
+    hasItems(): boolean;
+    /**
+     * Whether the item at the index is highlighted.
+     *
+     * @param {{
+     *   index: number
+     * }} params - Parameters of this method.
+     * @returns {boolean} - true when highlighted.
+     */
+    isSelected({ index, }: {
+        index: number;
+    }): boolean;
+    /**
+     * Setup component context: expose keyboard handler for the suggestion renderer.
+     *
+     * @template {X extends FuroEditorMentionMenuContext ? X : never} T, X
+     * @override
+     * @returns {T} - For method chaining.
+     * @this {T}
+     */
+    override setupComponent<T extends X extends FuroEditorMentionMenuContext ? X : never, X>(this: T): T;
+    /** @override */
+    override generateExposeHash(): {
+        /**
+         * @param {{
+         *   targetEvent: KeyboardEvent
+         * }} params - Keyboard event from the suggestion renderer.
+         * @returns {boolean} - true when handled.
+         */
+        onKeyDown: ({ targetEvent, }: {
+            targetEvent: KeyboardEvent;
+        }) => boolean;
+    };
+    /**
+     * Move the highlight up, wrapping to the end.
+     *
+     * @returns {void}
+     */
+    moveUp(): void;
+    /**
+     * Move the highlight down, wrapping to the start.
+     *
+     * @returns {void}
+     */
+    moveDown(): void;
+    /**
+     * Select the mention at the given index, forwarding it to Tiptap.
+     *
+     * @param {{
+     *   index: number
+     * }} params - Parameters of this method.
+     * @returns {void}
+     */
+    selectMention({ index, }: {
+        index: number;
+    }): void;
+    /**
+     * Select the currently highlighted mention.
+     *
+     * @returns {void}
+     */
+    selectActive(): void;
+    /**
+     * Handle a keyboard event from the suggestion renderer.
+     *
+     * @param {{
+     *   targetEvent: KeyboardEvent
+     * }} params - Parameters of this method.
+     * @returns {boolean} - true when the key was handled.
+     */
+    onKeyDown({ targetEvent, }: {
+        targetEvent: KeyboardEvent;
+    }): boolean;
+}
+export type FuroEditorMentionMenuContextParams = import("../../../contexts/BaseFuroContext.js").BaseFuroContextParams<{
+    items: Array<{
+        id: string | number;
+        label: string;
+    }>;
+    command: (mention: {
+        id: string | number;
+        label: string;
+    }) => void;
+}> & {
+    refHash: {
+        selectedIndexRef: import("vue").Ref<number>;
+    };
+};
+export type FuroEditorMentionMenuContextFactoryParams = Omit<FuroEditorMentionMenuContextParams, "refHash"> & {
+    refHash?: FuroEditorMentionMenuContextParams["refHash"];
+};
+import BaseFuroContext from '../../../contexts/BaseFuroContext.js';

package/types/generated/components/organisms/FuroEditor/PreserveNewlinesPasteExtension.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Create paragraph nodes from pasted plain text while preserving newlines and marks.
+ *
+ * @param {{
+ *   schema: import('@tiptap/pm/model').Schema
+ *   lines: Array<string>
+ *   html?: string
+ * }} params - Parameters of this function.
+ * @returns {Array<import('@tiptap/pm/model').Node>} - Paragraph nodes, one per line.
+ */
+export function createParagraphNodesFromPaste({ schema, lines, html, }: {
+    schema: import("@tiptap/pm/model").Schema;
+    lines: Array<string>;
+    html?: string;
+}): Array<import("@tiptap/pm/model").Node>;
+/**
+ * Resolve pasted clipboard content into paragraph nodes, or null to defer to
+ * default handling.
+ *
+ * @param {{
+ *   schema: import('@tiptap/pm/model').Schema
+ *   text?: string | null
+ *   html?: string | null
+ * }} params - Parameters of this function.
+ * @returns {Array<import('@tiptap/pm/model').Node> | null} - Paragraph nodes, or null.
+ */
+export function resolvePastedParagraphs({ schema, text, html, }: {
+    schema: import("@tiptap/pm/model").Schema;
+    text?: string | null;
+    html?: string | null;
+}): Array<import("@tiptap/pm/model").Node> | null;
+/**
+ * Extension that preserves multiple consecutive newlines when pasting plain text.
+ *
+ * By default, Tiptap/ProseMirror collapses runs of newlines into single paragraph
+ * breaks because it splits on `/(?:\r\n?|\n)+/` (one or more). This extension splits
+ * on each individual newline so empty lines survive, normalizes Windows line endings,
+ * and reconstructs link marks from Markdown links and bare URLs.
+ *
+ * ref: https://unpkg.com/prosemirror-view@1.27.0/src/clipboard.ts, search for /(?:\r\n?|\n)+/
+ */
+export const PreserveNewlinesPasteExtension: Extension<any, any>;
+import { Extension } from '@tiptap/core';

package/types/generated/components/organisms/FuroEditor/build-editor-extensions.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Build the Tiptap extension list for FuroEditor from parcel flags.
+ *
+ * StarterKit supplies paragraph, headings, bold/italic/underline/strike, lists,
+ * blockquote, code, link, and history. Color comes from TextStyleKit, alignment
+ * from TextAlign, plus Highlight, Typography, Placeholder, and the newline-preserving
+ * paste plugin. An optional pre-configured mention extension is appended last.
+ *
+ * @param {{
+ *   placeholder?: string
+ *   enableImage?: boolean
+ *   mentionExtension?: import('@tiptap/core').AnyExtension | null
+ *   extraExtensions?: Array<import('@tiptap/core').AnyExtension>
+ * }} [params] - Parameters of this function.
+ * @returns {Array<import('@tiptap/core').AnyExtension>} - Ordered extension list.
+ */
+export function buildEditorExtensions({ placeholder, enableImage, mentionExtension, extraExtensions, }?: {
+    placeholder?: string;
+    enableImage?: boolean;
+    mentionExtension?: import("@tiptap/core").AnyExtension | null;
+    extraExtensions?: Array<import("@tiptap/core").AnyExtension>;
+}): Array<import("@tiptap/core").AnyExtension>;

package/types/generated/components/organisms/FuroEditor/mention-suggestion.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Create the mention extension.
+ *
+ * Without `searchMentions` it registers the mention node only — enough to parse and
+ * render saved `@`-mention chips (e.g. read-only / display editors), with no `@` popup.
+ * With `searchMentions` it additionally wires the live suggestion popup for composing.
+ *
+ * @param {{
+ *   searchMentions?: ((params: { query: string }) => Promise<Array<{ id: string | number, label: string }>>) | null
+ *   onMentionAdd?: ((mention: { id: string | number, label: string }) => void) | null
+ * }} [params] - Parameters of this function.
+ * @returns {import('@tiptap/core').AnyExtension} - Configured mention extension.
+ */
+export function createMentionExtension({ searchMentions, onMentionAdd, }?: {
+    searchMentions?: ((params: {
+        query: string;
+    }) => Promise<Array<{
+        id: string | number;
+        label: string;
+    }>>) | null;
+    onMentionAdd?: ((mention: {
+        id: string | number;
+        label: string;
+    }) => void) | null;
+}): import("@tiptap/core").AnyExtension;

package/types/generated/components/organisms/FuroEditor/paste-link-segments.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Extract plain text and link segments from a single line.
+ *
+ * @param {{
+ *   line: string
+ * }} params - Parameters of this function.
+ * @returns {Array<TextSegment>} - Ordered segments for the line.
+ */
+export function extractTextSegmentsFromLine({ line, }: {
+    line: string;
+}): Array<TextSegment>;
+/**
+ * Pure (Tiptap-free) parsing of pasted plain-text lines into text / link segments.
+ *
+ * Kept separate from PreserveNewlinesPasteExtension so this logic can be unit-tested
+ * without loading the ProseMirror / Tiptap runtime.
+ */
+/**
+ * Matches a Markdown link `[text](url)` or a bare `http(s)://` URL within a line.
+ */
+export const MARKDOWN_LINK_OR_BARE_URL_PATTERN: RegExp;
+export type PlainTextSegment = {
+    type: "text";
+    text: string;
+};
+export type LinkTextSegment = {
+    type: "link";
+    text: string;
+    href: string;
+};
+export type TextSegment = PlainTextSegment | LinkTextSegment;