@vector-im/matrix-wysiwyg 2.37.13 → 2.38.0

package/node_modules/@vector-im/matrix-wysiwyg-wasm/pkg/wysiwyg.d.ts

@@ -0,0 +1,512 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+*/
+export function start(): void;
+/**
+* @returns {ComposerModel}
+*/
+export function new_composer_model(): ComposerModel;
+/**
+* @param {string} html
+* @param {number} start_utf16_codeunit
+* @param {number} end_utf16_codeunit
+* @returns {ComposerModel}
+*/
+export function new_composer_model_from_html(html: string, start_utf16_codeunit: number, end_utf16_codeunit: number): ComposerModel;
+/**
+*/
+export enum PatternKeyType {
+  At = 0,
+  Hash = 1,
+  Slash = 2,
+  Custom = 3,
+}
+/**
+*/
+export enum DomCreationError {
+  HtmlParseError = 0,
+  MarkdownParseError = 1,
+}
+/**
+*/
+export enum ComposerAction {
+  Bold = 0,
+  Italic = 1,
+  StrikeThrough = 2,
+  Underline = 3,
+  InlineCode = 4,
+  Link = 5,
+  Undo = 6,
+  Redo = 7,
+  OrderedList = 8,
+  UnorderedList = 9,
+  Indent = 10,
+  Unindent = 11,
+  CodeBlock = 12,
+  Quote = 13,
+}
+/**
+*/
+export enum ActionState {
+/**
+* The button can be clicked, and will perform its normal action
+* e.g. make something bold
+*/
+  Enabled = 0,
+/**
+* The button can be clicked, and will perform the reverse of its
+* normal action e.g. stop something being bold
+*/
+  Reversed = 1,
+/**
+* The button cannot be clicked
+*/
+  Disabled = 2,
+}
+/**
+*/
+export class ComposerModel {
+  free(): void;
+/**
+* @returns {ComposerModel}
+*/
+  static new(): ComposerModel;
+/**
+* @param {string} text
+* @returns {ComposerModel}
+*/
+  static from_example_format(text: string): ComposerModel;
+/**
+* @returns {string}
+*/
+  to_example_format(): string;
+/**
+* @returns {string}
+*/
+  get_content_as_html(): string;
+/**
+* @returns {string}
+*/
+  get_content_as_message_html(): string;
+/**
+* @returns {string}
+*/
+  get_content_as_markdown(): string;
+/**
+* @returns {string}
+*/
+  get_content_as_message_markdown(): string;
+/**
+* @returns {string}
+*/
+  get_content_as_plain_text(): string;
+/**
+* @returns {DomHandle}
+*/
+  document(): DomHandle;
+/**
+* @returns {Map<any, any>}
+*/
+  action_states(): Map<any, any>;
+/**
+* @param {number} start_utf16_codeunit
+* @param {number} end_utf16_codeunit
+* @returns {ComposerUpdate}
+*/
+  select(start_utf16_codeunit: number, end_utf16_codeunit: number): ComposerUpdate;
+/**
+* @returns {number}
+*/
+  selection_start(): number;
+/**
+* @returns {number}
+*/
+  selection_end(): number;
+/**
+* @param {string} new_text
+* @returns {ComposerUpdate}
+*/
+  replace_text(new_text: string): ComposerUpdate;
+/**
+* @param {string} new_text
+* @param {SuggestionPattern} suggestion
+* @param {boolean} append_space
+* @returns {ComposerUpdate}
+*/
+  replace_text_suggestion(new_text: string, suggestion: SuggestionPattern, append_space: boolean): ComposerUpdate;
+/**
+* @param {string} text
+* @returns {ComposerUpdate}
+*/
+  set_content_from_html(text: string): ComposerUpdate;
+/**
+* @param {string} text
+* @returns {ComposerUpdate}
+*/
+  set_content_from_markdown(text: string): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  clear(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  enter(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  backspace(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  backspace_word(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  delete(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  delete_word(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  bold(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  italic(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  strike_through(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  underline(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  quote(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  inline_code(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  code_block(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  undo(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  redo(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  ordered_list(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  unordered_list(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  indent(): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  unindent(): ComposerUpdate;
+/**
+* @returns {LinkAction}
+*/
+  get_link_action(): LinkAction;
+/**
+* @param {string} url
+* @param {Map<any, any>} attributes
+* @returns {ComposerUpdate}
+*/
+  set_link(url: string, attributes: Map<any, any>): ComposerUpdate;
+/**
+* @param {string} url
+* @param {string} text
+* @param {Map<any, any>} attributes
+* @returns {ComposerUpdate}
+*/
+  set_link_with_text(url: string, text: string, attributes: Map<any, any>): ComposerUpdate;
+/**
+* @param {Array<any>} custom_suggestion_patterns
+*/
+  set_custom_suggestion_patterns(custom_suggestion_patterns: Array<any>): void;
+/**
+* Creates an at-room mention node and inserts it into the composer at the current selection
+* @param {Map<any, any>} attributes
+* @returns {ComposerUpdate}
+*/
+  insert_at_room_mention(attributes: Map<any, any>): ComposerUpdate;
+/**
+* Creates a mention node and inserts it into the composer at the current selection
+* @param {string} url
+* @param {string} text
+* @param {Map<any, any>} attributes
+* @returns {ComposerUpdate}
+*/
+  insert_mention(url: string, text: string, attributes: Map<any, any>): ComposerUpdate;
+/**
+* Creates an at-room mention node and inserts it into the composer, replacing the
+* text content defined by the suggestion
+* @param {SuggestionPattern} suggestion
+* @param {Map<any, any>} attributes
+* @returns {ComposerUpdate}
+*/
+  insert_at_room_mention_at_suggestion(suggestion: SuggestionPattern, attributes: Map<any, any>): ComposerUpdate;
+/**
+* Creates a mention node and inserts it into the composer, replacing the
+* text content defined by the suggestion
+* @param {string} url
+* @param {string} text
+* @param {SuggestionPattern} suggestion
+* @param {Map<any, any>} attributes
+* @returns {ComposerUpdate}
+*/
+  insert_mention_at_suggestion(url: string, text: string, suggestion: SuggestionPattern, attributes: Map<any, any>): ComposerUpdate;
+/**
+* @returns {ComposerUpdate}
+*/
+  remove_links(): ComposerUpdate;
+}
+/**
+*/
+export class ComposerUpdate {
+  free(): void;
+/**
+* @returns {TextUpdate}
+*/
+  text_update(): TextUpdate;
+/**
+* @returns {MenuState}
+*/
+  menu_state(): MenuState;
+/**
+* @returns {MenuAction}
+*/
+  menu_action(): MenuAction;
+}
+/**
+*/
+export class Create {
+  free(): void;
+}
+/**
+*/
+export class CreateWithText {
+  free(): void;
+}
+/**
+*/
+export class Disabled {
+  free(): void;
+}
+/**
+* An iterator-like view of a DomHandle's children, written to work around
+* the lack of support for returning Vec<T> in wasm_bindgen.
+*/
+export class DomChildren {
+  free(): void;
+/**
+* @returns {DomHandle | undefined}
+*/
+  next_child(): DomHandle | undefined;
+}
+/**
+* Refers to a node in the composer model.
+*/
+export class DomHandle {
+  free(): void;
+/**
+* Returns "container", "line_break", "text" or "zwsp" depending on the type of
+* node we refer to.
+* Panics if we are not a valid reference (because the model has changed
+* since we were created, or because you passed in a different model
+* from the one that created us.)
+* @param {ComposerModel} model
+* @returns {string}
+*/
+  node_type(model: ComposerModel): string;
+/**
+* Returns a list of our children nodes, or an empty list if we refer
+* to a text or line break node.
+* Panics if we are not a valid reference (because the model has changed
+* since we were created, or because you passed in a different model
+* from the one that created us.)
+* @param {ComposerModel} model
+* @returns {DomChildren}
+*/
+  children(model: ComposerModel): DomChildren;
+/**
+* Returns the text of this node, or an empty string if this is a
+* container or line break.
+* Panics if we are not a valid reference (because the model has changed
+* since we were created, or because you passed in a different model
+* from the one that created us.)
+* @param {ComposerModel} model
+* @returns {string}
+*/
+  text(model: ComposerModel): string;
+/**
+* Returns our tagname, or "-text-"/"-zwsp-" if we are a text/zwsp node.
+* Panics if we are not a valid reference (because the model has changed
+* since we were created, or because you passed in a different model
+* from the one that created us.)
+* @param {ComposerModel} model
+* @returns {string}
+*/
+  tag(model: ComposerModel): string;
+}
+/**
+*/
+export class Edit {
+  free(): void;
+/**
+*/
+  url: string;
+}
+/**
+*/
+export class Keep {
+  free(): void;
+}
+/**
+*/
+export class LinkAction {
+  free(): void;
+/**
+*/
+  create?: Create;
+/**
+*/
+  create_with_text?: CreateWithText;
+/**
+*/
+  disabled?: Disabled;
+/**
+*/
+  edit_link?: Edit;
+}
+/**
+*/
+export class MenuAction {
+  free(): void;
+/**
+* @returns {boolean}
+*/
+  keep(): boolean;
+/**
+* @returns {boolean}
+*/
+  none(): boolean;
+/**
+* @returns {MenuActionSuggestion | undefined}
+*/
+  suggestion(): MenuActionSuggestion | undefined;
+}
+/**
+*/
+export class MenuActionSuggestion {
+  free(): void;
+/**
+*/
+  suggestion_pattern: SuggestionPattern;
+}
+/**
+*/
+export class MenuState {
+  free(): void;
+/**
+* @returns {boolean}
+*/
+  keep(): boolean;
+/**
+* @returns {MenuStateUpdate | undefined}
+*/
+  update(): MenuStateUpdate | undefined;
+}
+/**
+*/
+export class MenuStateUpdate {
+  free(): void;
+/**
+*/
+  action_states: Map<any, any>;
+}
+/**
+*/
+export class PatternKey {
+  free(): void;
+/**
+*/
+  custom_key_value?: string;
+/**
+*/
+  key_type: PatternKeyType;
+}
+/**
+*/
+export class ReplaceAll {
+  free(): void;
+/**
+*/
+  end_utf16_codeunit: number;
+/**
+*/
+  replacement_html: string;
+/**
+*/
+  start_utf16_codeunit: number;
+}
+/**
+*/
+export class Selection {
+  free(): void;
+/**
+*/
+  end_utf16_codeunit: number;
+/**
+*/
+  start_utf16_codeunit: number;
+}
+/**
+*/
+export class SuggestionPattern {
+  free(): void;
+/**
+*/
+  end: number;
+/**
+*/
+  key: PatternKey;
+/**
+*/
+  start: number;
+/**
+*/
+  text: string;
+}
+/**
+*/
+export class TextUpdate {
+  free(): void;
+/**
+*/
+  keep?: Keep;
+/**
+*/
+  replace_all?: ReplaceAll;
+/**
+*/
+  select?: Selection;
+}