@richscripts/richtexteditor 2.4.0

package/integrations/shared.d.ts

@@ -0,0 +1,138 @@
+import type {
+  RichTextEditorAccessibilityIssue,
+  RichTextEditorAccessibilityRepairOptions,
+  RichTextEditorAccessibilityResult,
+  RichTextEditorConstructor,
+  RichTextEditorDocumentMetrics,
+  RichTextEditorDocumentOutlineItem,
+  RichTextEditorFootnoteItem,
+  RichTextEditorInstance,
+  RichTextEditorLinkAuditOptions,
+  RichTextEditorLinkAuditResult,
+  RichTextEditorStructuredDocument,
+  RichTextEditorStructuredNode,
+  RichTextEditorStructuredInput,
+  RichTextEditorTableOfContentsItem,
+  RichTextEditorTableOfContentsOptions,
+  RichTextEditorTextStatistics,
+  RichTextEditorValidationResult,
+  RichTextEditorValueFormat
+} from "../index";
+
+export function createEditor(
+  element: string | Element,
+  config?: Record<string, unknown>
+): RichTextEditorInstance;
+
+export function auditAccessibility(
+  value: RichTextEditorStructuredInput
+): RichTextEditorAccessibilityResult;
+
+export function auditLinks(
+  value: RichTextEditorStructuredInput,
+  options?: RichTextEditorLinkAuditOptions
+): RichTextEditorLinkAuditResult;
+
+export function repairAccessibilityIssue(
+  value: RichTextEditorStructuredInput,
+  issue: RichTextEditorAccessibilityIssue,
+  options?: RichTextEditorAccessibilityRepairOptions
+): RichTextEditorStructuredDocument;
+
+export function createStructuredDocument(
+  value: RichTextEditorStructuredInput | null | undefined
+): RichTextEditorStructuredDocument;
+
+export function createStructuredContent(
+  editorOrHtml: RichTextEditorInstance | string | null | undefined
+): RichTextEditorStructuredDocument;
+
+export function ensureRichTextEditorConstructor(): RichTextEditorConstructor;
+
+export function fromMarkdown(markdown: string): RichTextEditorStructuredDocument;
+
+export function getDocumentOutline(
+  value: RichTextEditorStructuredInput
+): RichTextEditorDocumentOutlineItem[];
+
+export function getFootnotes(
+  value: RichTextEditorStructuredInput
+): RichTextEditorFootnoteItem[];
+
+export function getDocumentMetrics(
+  value: RichTextEditorStructuredInput | string,
+  options?: {
+    selectionText?: string | null | undefined;
+    wordsPerMinute?: number | null | undefined;
+  }
+): RichTextEditorDocumentMetrics;
+
+export function getMarkdownShortcutAction(
+  value: string | null | undefined
+): {
+  kind: "heading" | "blockquote" | "bulletList" | "orderedList" | "taskList" | "horizontalRule" | "codeBlock";
+  checked?: boolean;
+  level?: number;
+  token: string;
+} | null;
+
+export function getInlineMarkdownShortcutAction(
+  value: string | null | undefined
+): {
+  kind: "bold" | "italic" | "code" | "strike" | "link";
+  command: "bold" | "italic" | "code" | "strike" | "link";
+  content: string;
+  marker: string;
+  token: string;
+  rangeStart: number;
+  rangeEnd: number;
+  textStart: number;
+  textEnd: number;
+  href?: string;
+} | null;
+
+export function getTableOfContents(
+  value: RichTextEditorStructuredInput,
+  options?: RichTextEditorTableOfContentsOptions
+): RichTextEditorTableOfContentsItem[];
+
+export function getEditorValue(
+  editor: RichTextEditorInstance,
+  format: RichTextEditorValueFormat
+): string | RichTextEditorStructuredDocument;
+
+export function getTextStatistics(
+  value: RichTextEditorStructuredInput | string,
+  options?: { selectionText?: string | null | undefined }
+): RichTextEditorTextStatistics;
+
+export function installStructuredContentBridge(): RichTextEditorConstructor;
+
+export function loadRichTextEditorAssets(options?: {
+  basePath?: string;
+}): Promise<RichTextEditorConstructor>;
+
+export function normalizeStructuredContent(value: RichTextEditorStructuredInput): string;
+
+export function parseStructuredContentHtml(html: string): RichTextEditorStructuredNode[];
+
+export function renderHTML(value: RichTextEditorStructuredInput): string;
+
+export function serializeStructuredContent(value: RichTextEditorStructuredInput): string;
+
+export function setEditorValue(
+  editor: RichTextEditorInstance,
+  value: RichTextEditorStructuredInput,
+  format: RichTextEditorValueFormat
+): void;
+
+export function syncTableOfContents(
+  value: RichTextEditorStructuredInput,
+  options?: RichTextEditorTableOfContentsOptions
+): RichTextEditorStructuredDocument;
+
+export function toMarkdown(value: RichTextEditorStructuredInput): string;
+
+export function validateStructuredContent(
+  value: RichTextEditorStructuredInput
+): RichTextEditorValidationResult;