svedit 0.1.0

package/dist/Document.svelte.d.ts

@@ -0,0 +1,191 @@
+/**
+ * @import {
+ *   NodeId,
+ *   DocumentPath,
+ *   Selection,
+ *   Annotation,
+ *   PrimitiveType,
+ *   DocumentSchemaPrimitive,
+ *   NodeProperty,
+ *   NodeArrayProperty,
+ *   DocumentSchema,
+ *   SerializedDocument
+ * } from './types.d.ts';
+ */
+/**
+ * Identity function — keeps schema at runtime & makes IDE infer types.
+ * Similar to your define_schema pattern but for document schemas.
+ *
+ * @template {Record<string, Record<string, {type: DocumentSchemaPrimitive}>>} S
+ * @param {S} schema - The document schema to validate
+ * @returns {S} The same schema, but with type information preserved
+ */
+export function define_document_schema<S extends Record<string, Record<string, {
+    type: DocumentSchemaPrimitive;
+}>>>(schema: S): S;
+/**
+ * Check if a string represents a valid primitive type.
+ * @param {string} type - The type string to check
+ * @returns {type is PrimitiveType} True if it's a valid primitive type
+ */
+export function is_primitive_type(type: string): type is PrimitiveType;
+/**
+ * Get the default node type for a property that references nodes.
+ * @param {NodeProperty | NodeArrayProperty} property_definition - The property definition
+ * @returns {string | null} The default node type, or null if none specified
+ */
+export function get_default_node_type(property_definition: NodeProperty | NodeArrayProperty): string | null;
+/**
+ * Validate a document schema to ensure all referenced node types exist.
+ * @param {DocumentSchema} document_schema - The document schema to validate
+ * @throws {Error} Throws if the document schema is invalid
+ */
+export function validate_document_schema(document_schema: DocumentSchema): void;
+export default class Document {
+    /**
+     * @param {DocumentSchema} schema - The document schema
+     * @param {SerializedDocument} serialized_doc - The serialized document array
+     * @param {object} [options] - Optional configuration
+     * @param {Selection} [options.selection] - Initial selection state
+     * @param {any} [options.config] - Document configuration
+     */
+    constructor(schema: DocumentSchema, serialized_doc: SerializedDocument, { selection, config }?: {
+        selection?: Selection;
+        config?: any;
+    });
+    /** @type {Selection | undefined} */
+    selection: Selection | undefined;
+    config: any;
+    document_id: any;
+    nodes: any;
+    history: any[];
+    history_index: number;
+    can_undo: boolean;
+    can_redo: boolean;
+    selected_node: any;
+    schema: DocumentSchema;
+    generate_id(): any;
+    get_selected_node(): any;
+    _apply_op(op: any): void;
+    /**
+     * Validate a node against the document schema.
+     * @param {any} node - The node to validate
+     * @throws {Error} Throws if the node is invalid
+     */
+    validate_node(node: any): void;
+    /**
+     * Creates a new transaction for making atomic changes to the document.
+     *
+     * @returns {Transaction} A new transaction instance
+     */
+    get tr(): Transaction;
+    /**
+     * Applies a transaction to the document.
+     *
+     * @param {Transaction} transaction - The transaction to apply
+     */
+    apply(transaction: Transaction): this;
+    undo(): this;
+    redo(): this;
+    /**
+     * Gets a node instance or property value at the specified path.
+     * @param {DocumentPath|string} path - Path to the node or property
+     * @returns {any} Either a node instance object or the value of a property
+     * @example
+     * // Get a node by ID
+     * doc.get('list_1') // => { type: 'list', id: 'list_1', ... }
+     *
+     * @example
+     * // Get a node array property
+     * doc.get(['list_1', 'list_items']) // => [ 'list_item_1', 'list_item_2' ]
+     *
+     * @example
+     * // Get a specific node from an array
+     * doc.get(['page_1', 'body', 3, 'list_items', 0]) // => { type: 'list_item', id: 'list_item_1', ... }
+     *
+     * @example
+     * // Get an annotated string property
+     * doc.get(['page_1', 'cover', 'title']) // => ['Hello world', []]
+     */
+    get(path: DocumentPath | string): any;
+    /**
+     * While .get gives you the value of a path, inspect gives you
+     * the type info of that value.
+     *
+     * @todo The layout of these should be improved and more explictly typed
+     *
+     * @example
+     * doc.inspect(['page_1', 'body']) => {
+     *   kind: 'property',
+     *   name: 'body',
+     *   type: 'node_array',
+     *   node_types: ['text', 'story', 'list'],
+     *   default_node_type: 'text'
+     * }
+     *
+     * @example
+     * doc.inspect(['page_1', 'body', 1]) => {
+     *   kind: 'node',
+     *   id: 'paragraph_234',
+     *   type: 'paragraph',
+     *   properties: {...}
+     * }
+     *
+     * @param {DocumentPath} path
+     * @returns {{kind: 'property'|'node', [key: string]: any}}
+     */
+    inspect(path: DocumentPath): {
+        kind: "property" | "node";
+        [key: string]: any;
+    };
+    /**
+     * Determines the kind of a node ('text' for pure text nodes or 'node' for anything else)
+     * NOTE: currently we assume a 'content' property for pure text nodes
+     * @param {any} node
+     * @returns {'text'|'node'}
+     */
+    kind(node: any): "text" | "node";
+    /**
+     * Returns the annotation object that is currently "under the cursor".
+     * NOTE: Annotations in Svedit are exclusive, so there can only be one active_annotation
+     *
+     * @param {string} annotation_type
+     * @returns {Annotation|null}
+     */
+    active_annotation(annotation_type: string): Annotation | null;
+    get_selected_plain_text(): any;
+    get_selected_nodes(): any;
+    move_node_cursor(direction: any): void;
+    expand_node_selection(direction: any): void;
+    select_parent(): void;
+    get_selection_range(): {
+        start: number;
+        end: number;
+        length: number;
+    };
+    traverse(node_id: any): any[];
+    /**
+     * Convert the document to serialized format.
+     * @returns {SerializedDocument} The serialized document array
+     */
+    to_json(): SerializedDocument;
+    property_type(type: any, property: any): "string" | "number" | "boolean" | "node" | "node_array" | "integer" | "datetime" | "string_array" | "number_array" | "boolean_array" | "integer_array" | "annotated_string";
+    count_references(node_id: any): number;
+    /**
+     * @param {NodeId} node_id
+     * @returns {NodeId[]}
+     */
+    get_referenced_nodes(node_id: NodeId): NodeId[];
+}
+import type { DocumentSchemaPrimitive } from './types.d.ts';
+import type { PrimitiveType } from './types.d.ts';
+import type { NodeProperty } from './types.d.ts';
+import type { NodeArrayProperty } from './types.d.ts';
+import type { DocumentSchema } from './types.d.ts';
+import type { Selection } from './types.d.ts';
+import Transaction from './Transaction.svelte.js';
+import type { DocumentPath } from './types.d.ts';
+import type { Annotation } from './types.d.ts';
+import type { SerializedDocument } from './types.d.ts';
+import type { NodeId } from './types.d.ts';
+//# sourceMappingURL=Document.svelte.d.ts.map

package/dist/Document.svelte.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Document.svelte.d.ts","sourceRoot":"","sources":["../src/lib/Document.svelte.js"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AAEH;;;;;;;GAOG;AACH,uCAJ+E,CAAC,SAAlE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;IAAC,IAAI,EAAE,uBAAuB,CAAA;CAAC,CAAC,CAAE,UACnE,CAAC,GACC,CAAC,CAIb;AAED;;;;GAIG;AACH,wCAHW,MAAM,GACJ,IAAI,IAAI,aAAa,CAQjC;AAED;;;;GAIG;AACH,2DAHW,YAAY,GAAG,iBAAiB,GAC9B,MAAM,GAAG,IAAI,CASzB;AAED;;;;GAIG;AACH,0DAHW,cAAc,QAexB;AAuGD;IAgBE;;;;;;OAMG;IACH,oBANW,cAAc,kBACd,kBAAkB,0BAE1B;QAA4B,SAAS,GAA7B,SAAS;QACK,MAAM,GAApB,GAAG;KACb,EAmBA;IAxCD,oCAAoC;IACpC,WADW,SAAS,GAAG,SAAS,CACX;IACrB,YAAkB;IAClB,iBAAuB;IACvB,WAAiB;IACjB,eAAqB;IACrB,sBAA2B;IAG3B,kBAA6C;IAC7C,kBAAkE;IAGnE,mBAAmD;IAahD,uBAAoB;IAgBtB,mBAMC;IAGF,yBAgBC;IAGA,yBAWC;IAED;;;;OAIG;IACH,oBAHW,GAAG,QAKb;IAED;;;;OAIG;IACH,UAFa,WAAW,CASvB;IAED;;;;OAIG;IACH,mBAFW,WAAW,QAkBrB;IAED,aAWC;IAED,aAaC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,UAlBW,YAAY,GAAC,MAAM,GACjB,GAAG,CAuDf;IAED;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,cAHW,YAAY,GACV;QAAC,IAAI,EAAE,UAAU,GAAC,MAAM,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAC,CAuBzD;IAED;;;;;OAKG;IACH,WAHW,GAAG,GACD,MAAM,GAAC,MAAM,CAQzB;IAED;;;;;;OAMG;IACH,mCAHW,MAAM,GACJ,UAAU,GAAC,IAAI,CAoB3B;IAGD,+BAOC;IAED,0BAOC;IAED,uCAsBC;IAED,4CASC;IAED,sBAmCC;IAED;;;;MAaC;IAKD,8BA4BC;IAED;;;OAGG;IACH,WAFa,kBAAkB,CAI9B;IAID,qNAWC;IAGD,uCAkBC;IAGD;;;OAGG;IACH,8BAHW,MAAM,GACJ,MAAM,EAAE,CASpB;CACF;6CA1pBS,cAAc;mCAAd,cAAc;kCAAd,cAAc;uCAAd,cAAc;oCAAd,cAAc;+BAAd,cAAc;wBAdA,yBAAyB;kCAcvC,cAAc;gCAAd,cAAc;wCAAd,cAAc;4BAAd,cAAc"}