@fluidframework/tree 2.91.0 → 2.93.0

package/dist/text/textDomainFormatted.d.ts

@@ -66,7 +66,7 @@ export declare namespace FormattedTextAsTree {
      * Tag with which a line in text can be formatted from HTML.
      * @internal
      */
-    export const LineTag: (<TValue extends "li" | "h1" | "h2" | "h3" | "h4" | "h5">(value: TValue) => TValue extends unknown ? TreeNode & {
+    export const LineTag: (<TValue extends "ol" | "li" | "h1" | "h2" | "h3" | "h4" | "h5" | "checked" | "unchecked" | "blockquote" | "codeBlock">(value: TValue) => TValue extends unknown ? TreeNode & {
         readonly value: TValue;
     } : never) & {
         h1: import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.h1" | "com.h1", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
@@ -75,22 +75,39 @@ export declare namespace FormattedTextAsTree {
         h3: import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.h3" | "com.h3", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
             readonly value: "h3";
         }, Record<string, never>, true, Record<string, never>, undefined>;
+        codeBlock: import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.codeBlock" | "com.codeBlock", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
+            readonly value: "codeBlock";
+        }, Record<string, never>, true, Record<string, never>, undefined>;
         h2: import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.h2" | "com.h2", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
             readonly value: "h2";
         }, Record<string, never>, true, Record<string, never>, undefined>;
         h4: import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.h4" | "com.h4", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
             readonly value: "h4";
         }, Record<string, never>, true, Record<string, never>, undefined>;
-        li: import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.li" | "com.li", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
-            readonly value: "li";
+        ol: import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.ol" | "com.ol", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
+            readonly value: "ol";
         }, Record<string, never>, true, Record<string, never>, undefined>;
         h5: import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.h5" | "com.h5", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
             readonly value: "h5";
         }, Record<string, never>, true, Record<string, never>, undefined>;
+        li: import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.li" | "com.li", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
+            readonly value: "li";
+        }, Record<string, never>, true, Record<string, never>, undefined>;
+        checked: import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.checked" | "com.checked", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
+            readonly value: "checked";
+        }, Record<string, never>, true, Record<string, never>, undefined>;
+        unchecked: import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.unchecked" | "com.unchecked", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
+            readonly value: "unchecked";
+        }, Record<string, never>, true, Record<string, never>, undefined>;
+        blockquote: import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.blockquote" | "com.blockquote", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
+            readonly value: "blockquote";
+        }, Record<string, never>, true, Record<string, never>, undefined>;
     } & {
-        readonly schema: [import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.li" | "com.li", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
+        readonly schema: [import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.ol" | "com.ol", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
+            readonly value: "ol";
+        }, Record<string, never>, true, Record<string, never>, undefined>, import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.li" | "com.li", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
             readonly value: "li";
-        }, Record<string, never>, true, Record<string, never>, undefined>, import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.h1" | "com.h1", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
+        }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.h1" | "com.h1", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
             readonly value: "h1";
         }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.h2" | "com.h2", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
             readonly value: "h2";
@@ -100,6 +117,14 @@ export declare namespace FormattedTextAsTree {
             readonly value: "h4";
         }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.h5" | "com.h5", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
             readonly value: "h5";
+        }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.checked" | "com.checked", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
+            readonly value: "checked";
+        }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.unchecked" | "com.unchecked", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
+            readonly value: "unchecked";
+        }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.blockquote" | "com.blockquote", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
+            readonly value: "blockquote";
+        }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.codeBlock" | "com.codeBlock", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
+            readonly value: "codeBlock";
         })];
     };
     /**
@@ -108,9 +133,11 @@ export declare namespace FormattedTextAsTree {
      */
     export type LineTag = TreeNodeFromImplicitAllowedTypes<typeof LineTag.schema>;
     const StringLineAtom_base: import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.StringLineAtom", import("../simple-tree/index.js").NodeKind.Object, import("../simple-tree/index.js").TreeObjectNode<{
-        readonly tag: [import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.li" | "com.li", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
+        readonly tag: [import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.ol" | "com.ol", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
+            readonly value: "ol";
+        }, Record<string, never>, true, Record<string, never>, undefined>, import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.li" | "com.li", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
             readonly value: "li";
-        }, Record<string, never>, true, Record<string, never>, undefined>, import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.h1" | "com.h1", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
+        }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.h1" | "com.h1", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
             readonly value: "h1";
         }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.h2" | "com.h2", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
             readonly value: "h2";
@@ -120,9 +147,20 @@ export declare namespace FormattedTextAsTree {
             readonly value: "h4";
         }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.h5" | "com.h5", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
             readonly value: "h5";
+        }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.checked" | "com.checked", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
+            readonly value: "checked";
+        }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.unchecked" | "com.unchecked", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
+            readonly value: "unchecked";
+        }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.blockquote" | "com.blockquote", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
+            readonly value: "blockquote";
+        }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.codeBlock" | "com.codeBlock", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
+            readonly value: "codeBlock";
         })];
+        readonly indent: import("../simple-tree/leafNodeSchema.js").LeafSchema<"number", number>;
     }, "com.fluidframework.text.formatted.StringLineAtom">, object & {
         readonly tag: Record<string, never> | (Record<string, never> & TreeNode & {
+            readonly value: "ol";
+        }) | (Record<string, never> & TreeNode & {
             readonly value: "li";
         }) | (Record<string, never> & TreeNode & {
             readonly value: "h1";
@@ -134,6 +172,18 @@ export declare namespace FormattedTextAsTree {
             readonly value: "h4";
         }) | (Record<string, never> & TreeNode & {
             readonly value: "h5";
+        }) | (Record<string, never> & TreeNode & {
+            readonly value: "checked";
+        }) | (Record<string, never> & TreeNode & {
+            readonly value: "unchecked";
+        }) | (Record<string, never> & TreeNode & {
+            readonly value: "blockquote";
+        }) | (Record<string, never> & TreeNode & {
+            readonly value: "codeBlock";
+        }) | (TreeNode & {
+            readonly value: "ol";
+        } & Record<string, never>) | (TreeNode & {
+            readonly value: "ol";
         }) | (TreeNode & {
             readonly value: "li";
         } & Record<string, never>) | (TreeNode & {
@@ -158,11 +208,30 @@ export declare namespace FormattedTextAsTree {
             readonly value: "h5";
         } & Record<string, never>) | (TreeNode & {
             readonly value: "h5";
+        }) | (TreeNode & {
+            readonly value: "checked";
+        } & Record<string, never>) | (TreeNode & {
+            readonly value: "checked";
+        }) | (TreeNode & {
+            readonly value: "unchecked";
+        } & Record<string, never>) | (TreeNode & {
+            readonly value: "unchecked";
+        }) | (TreeNode & {
+            readonly value: "blockquote";
+        } & Record<string, never>) | (TreeNode & {
+            readonly value: "blockquote";
+        }) | (TreeNode & {
+            readonly value: "codeBlock";
+        } & Record<string, never>) | (TreeNode & {
+            readonly value: "codeBlock";
         });
+        readonly indent: number;
     }, true, {
-        readonly tag: [import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.li" | "com.li", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
+        readonly tag: [import("../simple-tree/index.js").TreeNodeSchemaClass<"com.fluidframework.text.formatted.lineTag.ol" | "com.ol", import("../simple-tree/index.js").NodeKind.Object, TreeNode & {
+            readonly value: "ol";
+        }, Record<string, never>, true, Record<string, never>, undefined>, import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.li" | "com.li", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
             readonly value: "li";
-        }, Record<string, never>, true, Record<string, never>, undefined>, import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.h1" | "com.h1", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
+        }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.h1" | "com.h1", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
             readonly value: "h1";
         }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.h2" | "com.h2", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
             readonly value: "h2";
@@ -172,14 +241,26 @@ export declare namespace FormattedTextAsTree {
             readonly value: "h4";
         }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.h5" | "com.h5", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
             readonly value: "h5";
+        }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.checked" | "com.checked", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
+            readonly value: "checked";
+        }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.unchecked" | "com.unchecked", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
+            readonly value: "unchecked";
+        }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.blockquote" | "com.blockquote", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
+            readonly value: "blockquote";
+        }), import("../simple-tree/index.js").TreeNodeSchemaCore<"com.fluidframework.text.formatted.lineTag.codeBlock" | "com.codeBlock", import("../simple-tree/index.js").NodeKind.Object, true, Record<string, never>, Record<string, never>, unknown> & (new (data?: Record<string, never> | import("../simple-tree/index.js").InternalTreeNode | undefined) => TreeNode & {
+            readonly value: "codeBlock";
         })];
+        readonly indent: import("../simple-tree/leafNodeSchema.js").LeafSchema<"number", number>;
     }, never, unknown>;
     /**
      * Unit in the string representing a new line character with line formatting.
      * @remarks
      * This aligns with how Quill represents line formatting.
-     * Note that not all new lines will use this,
-     * but only ones using this can have line specific formatting.
+     * Quill formats line attributes (headers, list, blockquote, etc... ) on the newline character
+     * and only lines using this atom can have line-specific formatting.
+     * The optional indent level mirrors Quill's indent attribute,
+     * which is applies to the line before the line break.
+     * Any tagged line can be indented independently.
      * @internal
      */
     export class StringLineAtom extends StringLineAtom_base {
@@ -203,6 +284,8 @@ export declare namespace FormattedTextAsTree {
             readonly content: string;
         }) | StringLineAtom | (object & {
             readonly tag: Record<string, never> | (Record<string, never> & TreeNode & {
+                readonly value: "ol";
+            }) | (Record<string, never> & TreeNode & {
                 readonly value: "li";
             }) | (Record<string, never> & TreeNode & {
                 readonly value: "h1";
@@ -214,6 +297,18 @@ export declare namespace FormattedTextAsTree {
                 readonly value: "h4";
             }) | (Record<string, never> & TreeNode & {
                 readonly value: "h5";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "checked";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "unchecked";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "blockquote";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "codeBlock";
+            }) | (TreeNode & {
+                readonly value: "ol";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "ol";
             }) | (TreeNode & {
                 readonly value: "li";
             } & Record<string, never>) | (TreeNode & {
@@ -238,11 +333,30 @@ export declare namespace FormattedTextAsTree {
                 readonly value: "h5";
             } & Record<string, never>) | (TreeNode & {
                 readonly value: "h5";
+            }) | (TreeNode & {
+                readonly value: "checked";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "checked";
+            }) | (TreeNode & {
+                readonly value: "unchecked";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "unchecked";
+            }) | (TreeNode & {
+                readonly value: "blockquote";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "blockquote";
+            }) | (TreeNode & {
+                readonly value: "codeBlock";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "codeBlock";
             });
+            readonly indent: number;
         }) | (StringTextAtom & object & {
             readonly content: string;
         }) | (StringTextAtom & object & {
             readonly tag: Record<string, never> | (Record<string, never> & TreeNode & {
+                readonly value: "ol";
+            }) | (Record<string, never> & TreeNode & {
                 readonly value: "li";
             }) | (Record<string, never> & TreeNode & {
                 readonly value: "h1";
@@ -254,6 +368,18 @@ export declare namespace FormattedTextAsTree {
                 readonly value: "h4";
             }) | (Record<string, never> & TreeNode & {
                 readonly value: "h5";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "checked";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "unchecked";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "blockquote";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "codeBlock";
+            }) | (TreeNode & {
+                readonly value: "ol";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "ol";
             }) | (TreeNode & {
                 readonly value: "li";
             } & Record<string, never>) | (TreeNode & {
@@ -278,7 +404,24 @@ export declare namespace FormattedTextAsTree {
                 readonly value: "h5";
             } & Record<string, never>) | (TreeNode & {
                 readonly value: "h5";
+            }) | (TreeNode & {
+                readonly value: "checked";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "checked";
+            }) | (TreeNode & {
+                readonly value: "unchecked";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "unchecked";
+            }) | (TreeNode & {
+                readonly value: "blockquote";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "blockquote";
+            }) | (TreeNode & {
+                readonly value: "codeBlock";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "codeBlock";
             });
+            readonly indent: number;
         }) | (object & {
             readonly content: string;
         } & StringTextAtom) | (object & {
@@ -287,6 +430,8 @@ export declare namespace FormattedTextAsTree {
             readonly content: string;
         } & {
             readonly tag: Record<string, never> | (Record<string, never> & TreeNode & {
+                readonly value: "ol";
+            }) | (Record<string, never> & TreeNode & {
                 readonly value: "li";
             }) | (Record<string, never> & TreeNode & {
                 readonly value: "h1";
@@ -298,6 +443,18 @@ export declare namespace FormattedTextAsTree {
                 readonly value: "h4";
             }) | (Record<string, never> & TreeNode & {
                 readonly value: "h5";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "checked";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "unchecked";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "blockquote";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "codeBlock";
+            }) | (TreeNode & {
+                readonly value: "ol";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "ol";
             }) | (TreeNode & {
                 readonly value: "li";
             } & Record<string, never>) | (TreeNode & {
@@ -322,11 +479,30 @@ export declare namespace FormattedTextAsTree {
                 readonly value: "h5";
             } & Record<string, never>) | (TreeNode & {
                 readonly value: "h5";
+            }) | (TreeNode & {
+                readonly value: "checked";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "checked";
+            }) | (TreeNode & {
+                readonly value: "unchecked";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "unchecked";
+            }) | (TreeNode & {
+                readonly value: "blockquote";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "blockquote";
+            }) | (TreeNode & {
+                readonly value: "codeBlock";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "codeBlock";
             });
+            readonly indent: number;
         }) | (StringLineAtom & object & {
             readonly content: string;
         }) | (StringLineAtom & object & {
             readonly tag: Record<string, never> | (Record<string, never> & TreeNode & {
+                readonly value: "ol";
+            }) | (Record<string, never> & TreeNode & {
                 readonly value: "li";
             }) | (Record<string, never> & TreeNode & {
                 readonly value: "h1";
@@ -338,6 +514,18 @@ export declare namespace FormattedTextAsTree {
                 readonly value: "h4";
             }) | (Record<string, never> & TreeNode & {
                 readonly value: "h5";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "checked";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "unchecked";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "blockquote";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "codeBlock";
+            }) | (TreeNode & {
+                readonly value: "ol";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "ol";
             }) | (TreeNode & {
                 readonly value: "li";
             } & Record<string, never>) | (TreeNode & {
@@ -362,9 +550,28 @@ export declare namespace FormattedTextAsTree {
                 readonly value: "h5";
             } & Record<string, never>) | (TreeNode & {
                 readonly value: "h5";
+            }) | (TreeNode & {
+                readonly value: "checked";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "checked";
+            }) | (TreeNode & {
+                readonly value: "unchecked";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "unchecked";
+            }) | (TreeNode & {
+                readonly value: "blockquote";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "blockquote";
+            }) | (TreeNode & {
+                readonly value: "codeBlock";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "codeBlock";
             });
+            readonly indent: number;
         }) | (object & {
             readonly tag: Record<string, never> | (Record<string, never> & TreeNode & {
+                readonly value: "ol";
+            }) | (Record<string, never> & TreeNode & {
                 readonly value: "li";
             }) | (Record<string, never> & TreeNode & {
                 readonly value: "h1";
@@ -376,6 +583,18 @@ export declare namespace FormattedTextAsTree {
                 readonly value: "h4";
             }) | (Record<string, never> & TreeNode & {
                 readonly value: "h5";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "checked";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "unchecked";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "blockquote";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "codeBlock";
+            }) | (TreeNode & {
+                readonly value: "ol";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "ol";
             }) | (TreeNode & {
                 readonly value: "li";
             } & Record<string, never>) | (TreeNode & {
@@ -400,9 +619,28 @@ export declare namespace FormattedTextAsTree {
                 readonly value: "h5";
             } & Record<string, never>) | (TreeNode & {
                 readonly value: "h5";
+            }) | (TreeNode & {
+                readonly value: "checked";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "checked";
+            }) | (TreeNode & {
+                readonly value: "unchecked";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "unchecked";
+            }) | (TreeNode & {
+                readonly value: "blockquote";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "blockquote";
+            }) | (TreeNode & {
+                readonly value: "codeBlock";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "codeBlock";
             });
+            readonly indent: number;
         } & StringTextAtom) | (object & {
             readonly tag: Record<string, never> | (Record<string, never> & TreeNode & {
+                readonly value: "ol";
+            }) | (Record<string, never> & TreeNode & {
                 readonly value: "li";
             }) | (Record<string, never> & TreeNode & {
                 readonly value: "h1";
@@ -414,6 +652,18 @@ export declare namespace FormattedTextAsTree {
                 readonly value: "h4";
             }) | (Record<string, never> & TreeNode & {
                 readonly value: "h5";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "checked";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "unchecked";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "blockquote";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "codeBlock";
+            }) | (TreeNode & {
+                readonly value: "ol";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "ol";
             }) | (TreeNode & {
                 readonly value: "li";
             } & Record<string, never>) | (TreeNode & {
@@ -438,11 +688,30 @@ export declare namespace FormattedTextAsTree {
                 readonly value: "h5";
             } & Record<string, never>) | (TreeNode & {
                 readonly value: "h5";
+            }) | (TreeNode & {
+                readonly value: "checked";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "checked";
+            }) | (TreeNode & {
+                readonly value: "unchecked";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "unchecked";
+            }) | (TreeNode & {
+                readonly value: "blockquote";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "blockquote";
+            }) | (TreeNode & {
+                readonly value: "codeBlock";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "codeBlock";
             });
+            readonly indent: number;
         } & {
             readonly content: string;
         }) | (object & {
             readonly tag: Record<string, never> | (Record<string, never> & TreeNode & {
+                readonly value: "ol";
+            }) | (Record<string, never> & TreeNode & {
                 readonly value: "li";
             }) | (Record<string, never> & TreeNode & {
                 readonly value: "h1";
@@ -454,6 +723,18 @@ export declare namespace FormattedTextAsTree {
                 readonly value: "h4";
             }) | (Record<string, never> & TreeNode & {
                 readonly value: "h5";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "checked";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "unchecked";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "blockquote";
+            }) | (Record<string, never> & TreeNode & {
+                readonly value: "codeBlock";
+            }) | (TreeNode & {
+                readonly value: "ol";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "ol";
             }) | (TreeNode & {
                 readonly value: "li";
             } & Record<string, never>) | (TreeNode & {
@@ -478,7 +759,24 @@ export declare namespace FormattedTextAsTree {
                 readonly value: "h5";
             } & Record<string, never>) | (TreeNode & {
                 readonly value: "h5";
+            }) | (TreeNode & {
+                readonly value: "checked";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "checked";
+            }) | (TreeNode & {
+                readonly value: "unchecked";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "unchecked";
+            }) | (TreeNode & {
+                readonly value: "blockquote";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "blockquote";
+            }) | (TreeNode & {
+                readonly value: "codeBlock";
+            } & Record<string, never>) | (TreeNode & {
+                readonly value: "codeBlock";
             });
+            readonly indent: number;
         } & StringLineAtom);
         readonly format: (InsertableTypedNode<typeof CharacterFormat> | undefined) & InsertableTypedNode<typeof CharacterFormat>;
     }, true, {
@@ -561,6 +859,18 @@ export declare namespace FormattedTextAsTree {
          * The start and end behave the same as in {@link (TreeArrayNode:interface).removeRange}.
          */
         formatRange(startIndex: number | undefined, endIndex: number | undefined, format: Partial<CharacterFormat>): void;
+        /**
+         * Returns the length of the run of characters starting at `startIndex` which have the same formatting and atom type, up to `endIndex`.
+         * @param startIndex - The starting index of the run.
+         * @param endIndex - The ending index (exclusive) of the run. Defaults to the end of the text.
+         */
+        getUniformRun(startIndex: number, endIndex?: number): number;
+        /**
+         * Returns a substring of the text from `startIndex` to `endIndex`
+         * @param startIndex - starting index (inclusive)
+         * @param endIndex - Optional ending index (exclusive). Defaults to the end of the text.
+         */
+        getString(startIndex: number, endIndex?: number): string;
     }
     /**
      * Schema for a text node.

package/dist/text/textDomainFormatted.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"textDomainFormatted.d.ts","sourceRoot":"","sources":["../../src/text/textDomainFormatted.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAiBH,OAAO,KAAK,EACX,mBAAmB,EACnB,QAAQ,EACR,gCAAgC,EAChC,QAAQ,EACR,MAAM,yBAAyB,CAAC;AAGjC,OAAO,EAAwB,KAAK,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAmOxE;;;;;;;;GAQG;AACH,yBAAiB,mBAAmB,CAAC;;;;;;;;IACpC;;;OAGG;IACH,MAAM,OAAO,eAAgB,SAAQ,oBAMnC;KAAG;;QAOJ;;;;;;;;;;WAUG;;;;;QAVH;;;;;;;;;;WAUG;;;IAfJ;;;OAGG;IACH,MAAM,OAAO,cAAe,SAAQ,mBAalC;KAAG;IAEL;;;OAGG;IACH,MAAM,CAAC,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAOlB,CAAC;IACH;;;OAGG;IACH,MAAM,MAAM,OAAO,GAAG,gCAAgC,CAAC,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAE9E;;;;;;;OAOG;IACH,MAAM,OAAO,cAAe,SAAQ,mBAElC;QACD,SAAgB,OAAO,QAAQ;KAC/B;IAED;;;OAGG;IACH,MAAM,CAAC,MAAM,iBAAiB,yDAA4C,CAAC;IAC3E;;;OAGG;IACH,MAAM,MAAM,iBAAiB,GAAG,gCAAgC,CAAC,OAAO,iBAAiB,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAE3F;;;OAGG;IACH,MAAM,OAAO,UAAW,SAAQ,eAG9B;KAAG;IAEL;;;OAGG;IACH,MAAM,WAAW,OAAO;QACvB;;;WAGG;QACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KAChC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,WAAW,OAAQ,SAAQ,UAAU,CAAC,OAAO;QAClD;;;;;;WAMG;QACH,aAAa,EAAE,eAAe,CAAC;QAE/B;;;;;;;;WAQG;QACH,wBAAwB,IAAI,SAAS,UAAU,EAAE,CAAC;QAElD;;;;;;;;;;;;WAYG;QACH,sBAAsB,CACrB,KAAK,EAAE,MAAM,EACb,oBAAoB,EAAE,QAAQ,CAAC,mBAAmB,CAAC,OAAO,UAAU,CAAC,CAAC,GACpE,IAAI,CAAC;QAER;;;;;;;WAOG;QACH,WAAW,CACV,UAAU,EAAE,MAAM,GAAG,SAAS,EAC9B,QAAQ,EAAE,MAAM,GAAG,SAAS,EAC5B,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,GAC9B,IAAI,CAAC;KACR;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,IAAI,8RAAmD,CAAC;IACrE,MAAM,MAAM,IAAI,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC,wCAAwC,CAAC,CAAC;;CAC3F"}
+{"version":3,"file":"textDomainFormatted.d.ts","sourceRoot":"","sources":["../../src/text/textDomainFormatted.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAsBH,OAAO,KAAK,EACX,mBAAmB,EACnB,QAAQ,EACR,gCAAgC,EAChC,QAAQ,EACR,MAAM,yBAAyB,CAAC;AAGjC,OAAO,EAAwB,KAAK,UAAU,EAAE,MAAM,iBAAiB,CAAC;AA8SxE;;;;;;;;GAQG;AACH,yBAAiB,mBAAmB,CAAC;;;;;;;;IACpC;;;OAGG;IACH,MAAM,OAAO,eAAgB,SAAQ,oBAMnC;KAAG;;QAOJ;;;;;;;;;;WAUG;;;;;QAVH;;;;;;;;;;WAUG;;;IAfJ;;;OAGG;IACH,MAAM,OAAO,cAAe,SAAQ,mBAalC;KAAG;IAEL;;;OAGG;IACH,MAAM,CAAC,MAAM,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAYlB,CAAC;IACH;;;OAGG;IACH,MAAM,MAAM,OAAO,GAAG,gCAAgC,CAAC,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAE9E;;;;;;;;;;OAUG;IACH,MAAM,OAAO,cAAe,SAAQ,mBAGlC;QACD,SAAgB,OAAO,QAAQ;KAC/B;IAED;;;OAGG;IACH,MAAM,CAAC,MAAM,iBAAiB,yDAA4C,CAAC;IAC3E;;;OAGG;IACH,MAAM,MAAM,iBAAiB,GAAG,gCAAgC,CAAC,OAAO,iBAAiB,CAAC,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAE3F;;;OAGG;IACH,MAAM,OAAO,UAAW,SAAQ,eAG9B;KAAG;IAEL;;;OAGG;IACH,MAAM,WAAW,OAAO;QACvB;;;WAGG;QACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KAChC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,WAAW,OAAQ,SAAQ,UAAU,CAAC,OAAO;QAClD;;;;;;WAMG;QACH,aAAa,EAAE,eAAe,CAAC;QAE/B;;;;;;;;WAQG;QACH,wBAAwB,IAAI,SAAS,UAAU,EAAE,CAAC;QAElD;;;;;;;;;;;;WAYG;QACH,sBAAsB,CACrB,KAAK,EAAE,MAAM,EACb,oBAAoB,EAAE,QAAQ,CAAC,mBAAmB,CAAC,OAAO,UAAU,CAAC,CAAC,GACpE,IAAI,CAAC;QAER;;;;;;;WAOG;QACH,WAAW,CACV,UAAU,EAAE,MAAM,GAAG,SAAS,EAC9B,QAAQ,EAAE,MAAM,GAAG,SAAS,EAC5B,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,GAC9B,IAAI,CAAC;QAER;;;;WAIG;QACH,aAAa,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;QAC7D;;;;WAIG;QACH,SAAS,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;KACzD;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAM,IAAI,8RAAmD,CAAC;IACrE,MAAM,MAAM,IAAI,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC,wCAAwC,CAAC,CAAC;;CAC3F"}