@vector-im/matrix-wysiwyg 2.37.13 → 2.38.0

package/README.md

@@ -40,6 +40,13 @@ Requirements:
 yarn install
 ```
 
+If your environment supports the experimental [ES Module Integration Proposal for WebAssembly](https://github.com/WebAssembly/esm-integration),
+you can instead use that, by setting the `matrix-org:wasm-esm` custom [export condition](https://nodejs.org/api/packages.html#conditional-exports).
+This is only supported when the library is imported as an ES Module. For example:
+- In Webpack, set [`experiments.asyncWebAssembly`](https://webpack.js.org/configuration/experiments/#experiments)
+  to `true` and [`resolve.conditionNames`](https://webpack.js.org/configuration/resolve/#resolveconditionnames)
+  to `["matrix-org:wasm-esm", "..."]` (the `"..."` preserves default condition names).
+
 ### Dev
 
 #### Folder structure

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+import { ComposerUpdate } from '@vector-im/matrix-wysiwyg-wasm';
 import { RefObject } from 'react';
 
 export declare const ACTION_TYPES: readonly ["bold", "italic", "strikeThrough", "underline", "undo", "redo", "orderedList", "unorderedList", "inlineCode", "clear", "link", "codeBlock", "quote", "indent", "unindent"];
@@ -12,24 +13,6 @@ export declare type AllowedMentionAttributes = Map<'style' | 'data-mention-type'
 
 export declare type BlockType = InputEvent['inputType'] | 'formatInlineCode' | 'clear';
 
-/**
- */
-export declare class ComposerUpdate {
-    free(): void;
-    /**
-     * @returns {TextUpdate}
-     */
-    text_update(): TextUpdate;
-    /**
-     * @returns {MenuState}
-     */
-    menu_state(): MenuState;
-    /**
-     * @returns {MenuAction}
-     */
-    menu_action(): MenuAction;
-}
-
 export declare type FormattingFunctions = Record<Exclude<ActionTypes, 'link'>, () => void> & {
     insertText: (text: string) => void;
     link: (url: string, text?: string) => void;
@@ -40,13 +23,12 @@ export declare type FormattingFunctions = Record<Exclude<ActionTypes, 'link'>, (
     getLink: () => string;
 };
 
-export declare type InputEventProcessor = (event: WysiwygEvent, wysiwyg: Wysiwyg, editor: HTMLElement) => WysiwygEvent | null;
-
 /**
+ * Initialise the WASM module, or do nothing if it is already initialised.
  */
-export declare class Keep {
-    free(): void;
-}
+export declare function initOnce(): Promise<void>;
+
+export declare type InputEventProcessor = (event: WysiwygEvent, wysiwyg: Wysiwyg, editor: HTMLElement) => WysiwygEvent | null;
 
 export declare type LinkEvent = Omit<InputEvent, 'data'> & {
     inputType: 'insertLink';
@@ -62,147 +44,16 @@ export declare type MappedSuggestion = {
     type: SuggestionType;
 };
 
-/**
- */
-export declare class MenuAction {
-    free(): void;
-    /**
-     * @returns {boolean}
-     */
-    keep(): boolean;
-    /**
-     * @returns {boolean}
-     */
-    none(): boolean;
-    /**
-     * @returns {MenuActionSuggestion | undefined}
-     */
-    suggestion(): MenuActionSuggestion | undefined;
-}
-
-/**
- */
-export declare class MenuActionSuggestion {
-    free(): void;
-    /**
-     */
-    suggestion_pattern: SuggestionPattern;
-}
-
-/**
- */
-export declare class MenuState {
-    free(): void;
-    /**
-     * @returns {boolean}
-     */
-    keep(): boolean;
-    /**
-     * @returns {MenuStateUpdate | undefined}
-     */
-    update(): MenuStateUpdate | undefined;
-}
-
-/**
- */
-export declare class MenuStateUpdate {
-    free(): void;
-    /**
-     */
-    action_states: Map<any, any>;
-}
-
-/**
- */
-export declare class PatternKey {
-    free(): void;
-    /**
-     */
-    custom_key_value?: string;
-    /**
-     */
-    key_type: PatternKeyType;
-}
-
-/**
- */
-export declare enum PatternKeyType {
-    At = 0,
-    Hash = 1,
-    Slash = 2,
-    Custom = 3,
-}
-
 export declare function plainToRich(plainText: string, inMessageFormat: boolean): Promise<string>;
 
-/**
- */
-export declare class ReplaceAll {
-    free(): void;
-    /**
-     */
-    end_utf16_codeunit: number;
-    /**
-     */
-    replacement_html: string;
-    /**
-     */
-    start_utf16_codeunit: number;
-}
-
 export declare function richToPlain(richText: string, inMessageFormat: boolean): Promise<string>;
 
-/**
- */
-export declare class Selection_2 {
-    free(): void;
-    /**
-     */
-    end_utf16_codeunit: number;
-    /**
-     */
-    start_utf16_codeunit: number;
-}
-
 export declare type SuggestionChar = (typeof SUGGESTIONS)[number] | '';
 
-/**
- */
-export declare class SuggestionPattern {
-    free(): void;
-    /**
-     */
-    end: number;
-    /**
-     */
-    key: PatternKey;
-    /**
-     */
-    start: number;
-    /**
-     */
-    text: string;
-}
-
 export declare const SUGGESTIONS: readonly ["@", "#", "/", ""];
 
 export declare type SuggestionType = 'mention' | 'command' | 'custom' | 'unknown';
 
-/**
- */
-export declare class TextUpdate {
-    free(): void;
-    /**
-     */
-    keep?: Keep;
-    /**
-     */
-    replace_all?: ReplaceAll;
-    /**
-     */
-    select?: Selection_2;
-}
-
 export declare type TraceAction = (update: ComposerUpdate | null, name: string, value1?: string | number, value2?: string | number) => ComposerUpdate | null;
 
 export declare type UseWysiwyg = {