@vector-im/matrix-wysiwyg 2.40.0 → 2.42.1

package/dist/lib/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const ACTION_TYPES: readonly ["bold", "italic", "strikeThrough", "underline", "undo", "redo", "orderedList", "unorderedList", "inlineCode", "clear", "link", "codeBlock", "quote", "indent", "unindent"];
+export declare const SUGGESTIONS: readonly ["@", "#", "/", "", ":"];

package/dist/lib/conversion.d.ts

@@ -0,0 +1,4 @@
+export declare const markdownToPlain: (markdown: string) => string;
+export declare function richToPlain(richText: string, inMessageFormat: boolean): Promise<string>;
+export declare function plainToRich(plainText: string, inMessageFormat: boolean): Promise<string>;
+export declare function plainTextInnerHtmlToMarkdown(innerHtml: string): string;

package/dist/lib/types.d.ts

@@ -0,0 +1,36 @@
+import { ComposerUpdate } from '@vector-im/matrix-wysiwyg-wasm';
+import { ACTION_TYPES, SUGGESTIONS } from './constants';
+import { AllowedMentionAttributes, LinkEvent } from './useListeners/types';
+export type BlockType = InputEvent['inputType'] | 'formatInlineCode' | 'clear';
+export type WysiwygInputEvent = ClipboardEvent | LinkEvent | (InputEvent & {
+    inputType: BlockType;
+    data?: string | null;
+});
+export type WysiwygEvent = WysiwygInputEvent | KeyboardEvent;
+export type ActionTypes = (typeof ACTION_TYPES)[number];
+export type ActionState = 'enabled' | 'reversed' | 'disabled';
+export type AllActionStates = Record<ActionTypes, ActionState>;
+export type FormattingFunctions = Record<Exclude<ActionTypes, 'link'>, () => void> & {
+    insertText: (text: string) => void;
+    link: (url: string, text?: string) => void;
+    mention: (url: string, text: string, attributes: AllowedMentionAttributes) => void;
+    mentionAtRoom: (attributes: AllowedMentionAttributes) => void;
+    command: (text: string) => void;
+    emoji: (text: string) => void;
+    removeLinks: () => void;
+    getLink: () => string;
+};
+export type Wysiwyg = {
+    actions: FormattingFunctions;
+    content: () => string;
+    messageContent: () => string;
+};
+export type InputEventProcessor = (event: WysiwygEvent, wysiwyg: Wysiwyg, editor: HTMLElement) => WysiwygEvent | null;
+export type SuggestionChar = (typeof SUGGESTIONS)[number] | '';
+export type SuggestionType = 'mention' | 'command' | 'custom' | 'emoji' | 'unknown';
+export type MappedSuggestion = {
+    keyChar: SuggestionChar;
+    text: string;
+    type: SuggestionType;
+};
+export type TraceAction = (update: ComposerUpdate | null, name: string, value1?: string | number, value2?: string | number) => ComposerUpdate | null;

package/dist/lib/useComposerModel.d.ts

@@ -0,0 +1,11 @@
+import { RefObject } from 'react';
+import { ComposerModel } from '@vector-im/matrix-wysiwyg-wasm';
+/**
+ * Initialise the WASM module, or do nothing if it is already initialised.
+ * Safe to call concurrently — all callers share the same underlying promise.
+ */
+export declare function initOnce(): Promise<void>;
+export declare function useComposerModel(editorRef: RefObject<HTMLElement | null>, initialContent?: string, customSuggestionPatterns?: Array<string>): {
+    composerModel: ComposerModel | null;
+    onError: (initialContent?: string) => Promise<void>;
+};

package/dist/lib/useListeners/types.d.ts

@@ -0,0 +1,27 @@
+import { BlockType } from '../types';
+export type FormatBlockEvent = CustomEvent<{
+    blockType: BlockType;
+    data?: string;
+}>;
+export type LinkEvent = Omit<InputEvent, 'data'> & {
+    inputType: 'insertLink';
+    data: {
+        url: string;
+        text?: string;
+    };
+};
+export type AllowedMentionAttributes = Map<'style' | 'data-mention-type', string>;
+export type SuggestionEvent = Omit<InputEvent, 'data'> & {
+    inputType: 'insertSuggestion';
+    data: {
+        url: string;
+        text: string;
+        attributes: AllowedMentionAttributes;
+    };
+};
+export type AtRoomSuggestionEvent = Omit<InputEvent, 'data'> & {
+    inputType: 'insertAtRoomSuggestion';
+    data: {
+        attributes: AllowedMentionAttributes;
+    };
+};

package/dist/lib/useTestCases/types.d.ts

@@ -0,0 +1,5 @@
+import { useTestCases } from './useTestCases';
+export type TestUtilities = ReturnType<typeof useTestCases>['utilities'];
+export type SelectTuple = ['select', number, number];
+export type Tuple = SelectTuple | [string, (string | number)?, (string | number)?];
+export type Actions = Array<Tuple>;

package/dist/lib/useWysiwyg.d.ts

@@ -0,0 +1,26 @@
+import { RefObject } from 'react';
+import { AllActionStates, FormattingFunctions, InputEventProcessor, MappedSuggestion, TraceAction } from './types.js';
+export { richToPlain, plainToRich } from './conversion';
+export type WysiwygProps = {
+    isAutoFocusEnabled?: boolean;
+    inputEventProcessor?: InputEventProcessor;
+    initialContent?: string;
+    emojiSuggestions?: Map<string, string>;
+};
+export type UseWysiwyg = {
+    ref: RefObject<HTMLDivElement | null>;
+    isWysiwygReady: boolean;
+    wysiwyg: FormattingFunctions;
+    content: string | null;
+    actionStates: AllActionStates;
+    debug: {
+        modelRef: RefObject<HTMLDivElement | null>;
+        testRef: RefObject<HTMLDivElement | null>;
+        resetTestCase: () => void | null;
+        traceAction: TraceAction;
+    };
+    suggestion: MappedSuggestion | null;
+    messageContent: string | null;
+};
+export declare function useWysiwyg(wysiwygProps?: WysiwygProps): UseWysiwyg;
+export { initOnce } from './useComposerModel.js';