@superdoc-dev/sdk 1.19.2 → 1.20.1

package/dist/action-primitives/tools/structure-insert.d.ts

@@ -0,0 +1,183 @@
+import type { BoundDocApi } from '../../generated/client.js';
+import type { InvokeOptions } from '../../runtime/process.js';
+import { type WorkflowEngineRunResult } from '../engine.js';
+import { type WorkflowResolvedTarget, type WorkflowTargetRequest } from '../resolve.js';
+declare const STRUCTURE_INSERT_ACTIONS: readonly ["insert_toc", "insert_section_break", "insert_paragraph", "insert_paragraphs", "move_range"];
+declare const DOCUMENT_PLACEMENTS: readonly ["document_start", "document_end"];
+declare const RELATIVE_POSITIONS: readonly ["before", "after"];
+declare const SECTION_BREAK_TYPES: readonly ["continuous", "nextPage", "evenPage", "oddPage"];
+declare const CHANGE_MODES: readonly ["direct", "tracked"];
+type SuperdocStructureInsertAction = (typeof STRUCTURE_INSERT_ACTIONS)[number];
+type SuperdocStructureInsertDocumentPlacement = (typeof DOCUMENT_PLACEMENTS)[number];
+type SuperdocStructureInsertRelativePosition = (typeof RELATIVE_POSITIONS)[number];
+type SuperdocStructureInsertSectionBreakType = (typeof SECTION_BREAK_TYPES)[number];
+type SuperdocStructureInsertChangeMode = (typeof CHANGE_MODES)[number];
+type StructureInsertTocParams = NonNullable<Parameters<BoundDocApi['create']['tableOfContents']>[0]>;
+type StructureInsertParagraphParams = NonNullable<Parameters<BoundDocApi['create']['paragraph']>[0]>;
+type StructureInsertHeadingParams = NonNullable<Parameters<BoundDocApi['create']['heading']>[0]>;
+type StructureInsertSectionBreakParams = NonNullable<Parameters<BoundDocApi['create']['sectionBreak']>[0]>;
+type SuperdocStructureInsertPlacement = {
+    mode: 'document';
+    at: SuperdocStructureInsertDocumentPlacement;
+    source: 'default' | 'provided';
+} | {
+    mode: 'relative';
+    position: SuperdocStructureInsertRelativePosition;
+    source: 'provided';
+    request: WorkflowTargetRequest;
+    target: WorkflowResolvedTarget;
+};
+type SuperdocStructureInsertResolvedToc = {
+    action: 'insert_toc';
+    placement: SuperdocStructureInsertPlacement;
+    title?: string;
+};
+type SuperdocStructureInsertResolvedSectionBreak = {
+    action: 'insert_section_break';
+    placement: SuperdocStructureInsertPlacement;
+    breakType: SuperdocStructureInsertSectionBreakType;
+};
+type SuperdocStructureInsertResolvedParagraph = {
+    action: 'insert_paragraph';
+    placement: SuperdocStructureInsertPlacement;
+    text: string;
+    changeMode: SuperdocStructureInsertChangeMode;
+};
+type SuperdocStructureInsertResolvedParagraphs = {
+    action: 'insert_paragraphs';
+    placement: SuperdocStructureInsertPlacement;
+    texts: string[];
+    headingLevel?: number;
+    changeMode: SuperdocStructureInsertChangeMode;
+};
+type SuperdocStructureInsertResolvedMoveRange = {
+    action: 'move_range';
+    /** First block of the contiguous range to move (already resolved to a nodeId by the caller). */
+    startNodeId: string;
+    /** Last block of the range. When omitted, the range auto-extends to the visual section end. */
+    endNodeId?: string;
+    /** Destination anchor block; the range lands before/after this block. */
+    destinationNodeId: string;
+    position: SuperdocStructureInsertRelativePosition;
+    changeMode: SuperdocStructureInsertChangeMode;
+};
+type SuperdocStructureInsertResolved = SuperdocStructureInsertResolvedToc | SuperdocStructureInsertResolvedSectionBreak | SuperdocStructureInsertResolvedParagraph | SuperdocStructureInsertResolvedParagraphs | SuperdocStructureInsertResolvedMoveRange;
+type SuperdocStructureInsertPlanToc = {
+    action: 'insert_toc';
+    placement: SuperdocStructureInsertPlacement;
+    title?: string;
+    titleParagraphParams?: StructureInsertParagraphParams;
+    tocParams: StructureInsertTocParams;
+};
+type SuperdocStructureInsertPlanSectionBreak = {
+    action: 'insert_section_break';
+    placement: SuperdocStructureInsertPlacement;
+    breakType: SuperdocStructureInsertSectionBreakType;
+    sectionBreakParams: StructureInsertSectionBreakParams;
+};
+type SuperdocStructureInsertPlanParagraph = {
+    action: 'insert_paragraph';
+    placement: SuperdocStructureInsertPlacement;
+    text: string;
+    changeMode: SuperdocStructureInsertChangeMode;
+    paragraphParams: StructureInsertParagraphParams;
+};
+type SuperdocStructureInsertPlanParagraphs = {
+    action: 'insert_paragraphs';
+    placement: SuperdocStructureInsertPlacement;
+    texts: string[];
+    headingLevel?: number;
+    changeMode: SuperdocStructureInsertChangeMode;
+    firstParagraphParams: StructureInsertParagraphParams;
+    firstHeadingParams?: StructureInsertHeadingParams;
+};
+type SuperdocStructureInsertPlanMoveRange = SuperdocStructureInsertResolvedMoveRange;
+type SuperdocStructureInsertPlan = SuperdocStructureInsertPlanToc | SuperdocStructureInsertPlanSectionBreak | SuperdocStructureInsertPlanParagraph | SuperdocStructureInsertPlanParagraphs | SuperdocStructureInsertPlanMoveRange;
+type WorkflowRevision = {
+    before: string;
+    after: string;
+    unchanged: boolean;
+};
+type SuperdocStructureInsertExecutionToc = {
+    action: 'insert_toc';
+    placement: ReturnType<typeof summarizePlacement>;
+    revision: WorkflowRevision;
+    tocNodeId: string;
+    title?: string;
+    titleNodeId?: string;
+};
+type SuperdocStructureInsertExecutionSectionBreak = {
+    action: 'insert_section_break';
+    placement: ReturnType<typeof summarizePlacement>;
+    revision: WorkflowRevision;
+    breakType: SuperdocStructureInsertSectionBreakType;
+    sectionId: string;
+    breakParagraphNodeId?: string;
+};
+type SuperdocStructureInsertExecutionParagraph = {
+    action: 'insert_paragraph';
+    placement: ReturnType<typeof summarizePlacement>;
+    revision: WorkflowRevision;
+    text: string;
+    changeMode: SuperdocStructureInsertChangeMode;
+    paragraphNodeId: string;
+};
+type SuperdocStructureInsertExecutionParagraphs = {
+    action: 'insert_paragraphs';
+    placement: ReturnType<typeof summarizePlacement>;
+    revision: WorkflowRevision;
+    texts: string[];
+    headingLevel?: number;
+    changeMode: SuperdocStructureInsertChangeMode;
+    paragraphNodeIds: string[];
+};
+type SuperdocStructureInsertExecutionMoveRange = {
+    action: 'move_range';
+    revision: WorkflowRevision;
+    position: SuperdocStructureInsertRelativePosition;
+    changeMode: SuperdocStructureInsertChangeMode;
+    /** First block of the moved range (original nodeId). */
+    startNodeId: string;
+    /** Last block of the moved range (original nodeId — the resolved end, whether explicit or auto-extended). */
+    endNodeId: string;
+    /** Destination anchor the caller pointed at. */
+    destinationNodeId: string;
+    /** Block the recreated range was actually placed relative to (may be the destination's section-end). */
+    anchorNodeId: string;
+    /** True when the destination was heading-like and `after` extended past its whole visual section. */
+    destinationExtendedToSectionEnd: boolean;
+    movedBlockCount: number;
+    movedTexts: string[];
+    insertedBlockNodeIds: string[];
+    deletedCount: number;
+};
+type SuperdocStructureInsertExecution = SuperdocStructureInsertExecutionToc | SuperdocStructureInsertExecutionSectionBreak | SuperdocStructureInsertExecutionParagraph | SuperdocStructureInsertExecutionParagraphs | SuperdocStructureInsertExecutionMoveRange;
+type SuperdocStructureInsertVerification = {
+    action: SuperdocStructureInsertAction;
+    passed: boolean;
+    summary: string;
+    checks: Record<string, unknown>;
+};
+export type RunSuperdocStructureInsertInput = {
+    documentHandle: BoundDocApi;
+    args: Record<string, unknown>;
+    invokeOptions?: InvokeOptions;
+};
+declare function summarizePlacement(placement: SuperdocStructureInsertPlacement): {
+    mode: "document";
+    at: "document_end" | "document_start";
+    source: "default" | "provided";
+    position?: undefined;
+    targetNodeId?: undefined;
+    targetKind?: undefined;
+} | {
+    mode: "relative";
+    position: "before" | "after";
+    source: "provided";
+    targetNodeId: string;
+    targetKind: "table" | "block" | "listItem";
+    at?: undefined;
+};
+export declare function runSuperdocStructureInsertWorkflow(input: RunSuperdocStructureInsertInput): Promise<WorkflowEngineRunResult<SuperdocStructureInsertResolved, SuperdocStructureInsertPlan, SuperdocStructureInsertExecution, SuperdocStructureInsertVerification>>;
+export {};
+//# sourceMappingURL=structure-insert.d.ts.map

package/dist/action-primitives/tools/structure-insert.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"structure-insert.d.ts","sourceRoot":"","sources":["../../../src/action-primitives/tools/structure-insert.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAuB,MAAM,2BAA2B,CAAC;AAClF,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAC;AAE9D,OAAO,EAKL,KAAK,uBAAuB,EAE7B,MAAM,cAAc,CAAC;AACtB,OAAO,EAEL,KAAK,sBAAsB,EAC3B,KAAK,qBAAqB,EAC3B,MAAM,eAAe,CAAC;AAEvB,QAAA,MAAM,wBAAwB,wGAMpB,CAAC;AACX,QAAA,MAAM,mBAAmB,6CAA8C,CAAC;AACxE,QAAA,MAAM,kBAAkB,8BAA+B,CAAC;AACxD,QAAA,MAAM,mBAAmB,4DAA6D,CAAC;AACvF,QAAA,MAAM,YAAY,gCAAiC,CAAC;AASpD,KAAK,6BAA6B,GAAG,CAAC,OAAO,wBAAwB,CAAC,CAAC,MAAM,CAAC,CAAC;AAC/E,KAAK,wCAAwC,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AACrF,KAAK,uCAAuC,GAAG,CAAC,OAAO,kBAAkB,CAAC,CAAC,MAAM,CAAC,CAAC;AACnF,KAAK,uCAAuC,GAAG,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;AACpF,KAAK,iCAAiC,GAAG,CAAC,OAAO,YAAY,CAAC,CAAC,MAAM,CAAC,CAAC;AAIvE,KAAK,wBAAwB,GAAG,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACrG,KAAK,8BAA8B,GAAG,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACrG,KAAK,4BAA4B,GAAG,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACjG,KAAK,iCAAiC,GAAG,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAQ3G,KAAK,gCAAgC,GACjC;IACE,IAAI,EAAE,UAAU,CAAC;IACjB,EAAE,EAAE,wCAAwC,CAAC;IAC7C,MAAM,EAAE,SAAS,GAAG,UAAU,CAAC;CAChC,GACD;IACE,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,uCAAuC,CAAC;IAClD,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,qBAAqB,CAAC;IAC/B,MAAM,EAAE,sBAAsB,CAAC;CAChC,CAAC;AAEN,KAAK,kCAAkC,GAAG;IACxC,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,EAAE,gCAAgC,CAAC;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,KAAK,2CAA2C,GAAG;IACjD,MAAM,EAAE,sBAAsB,CAAC;IAC/B,SAAS,EAAE,gCAAgC,CAAC;IAC5C,SAAS,EAAE,uCAAuC,CAAC;CACpD,CAAC;AAEF,KAAK,wCAAwC,GAAG;IAC9C,MAAM,EAAE,kBAAkB,CAAC;IAC3B,SAAS,EAAE,gCAAgC,CAAC;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,iCAAiC,CAAC;CAC/C,CAAC;AAEF,KAAK,yCAAyC,GAAG;IAC/C,MAAM,EAAE,mBAAmB,CAAC;IAC5B,SAAS,EAAE,gCAAgC,CAAC;IAC5C,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,iCAAiC,CAAC;CAC/C,CAAC;AAEF,KAAK,wCAAwC,GAAG;IAC9C,MAAM,EAAE,YAAY,CAAC;IACrB,gGAAgG;IAChG,WAAW,EAAE,MAAM,CAAC;IACpB,+FAA+F;IAC/F,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yEAAyE;IACzE,iBAAiB,EAAE,MAAM,CAAC;IAC1B,QAAQ,EAAE,uCAAuC,CAAC;IAClD,UAAU,EAAE,iCAAiC,CAAC;CAC/C,CAAC;AAEF,KAAK,+BAA+B,GAChC,kCAAkC,GAClC,2CAA2C,GAC3C,wCAAwC,GACxC,yCAAyC,GACzC,wCAAwC,CAAC;AAE7C,KAAK,8BAA8B,GAAG;IACpC,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,EAAE,gCAAgC,CAAC;IAC5C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,oBAAoB,CAAC,EAAE,8BAA8B,CAAC;IACtD,SAAS,EAAE,wBAAwB,CAAC;CACrC,CAAC;AAEF,KAAK,uCAAuC,GAAG;IAC7C,MAAM,EAAE,sBAAsB,CAAC;IAC/B,SAAS,EAAE,gCAAgC,CAAC;IAC5C,SAAS,EAAE,uCAAuC,CAAC;IACnD,kBAAkB,EAAE,iCAAiC,CAAC;CACvD,CAAC;AAEF,KAAK,oCAAoC,GAAG;IAC1C,MAAM,EAAE,kBAAkB,CAAC;IAC3B,SAAS,EAAE,gCAAgC,CAAC;IAC5C,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,iCAAiC,CAAC;IAC9C,eAAe,EAAE,8BAA8B,CAAC;CACjD,CAAC;AAEF,KAAK,qCAAqC,GAAG;IAC3C,MAAM,EAAE,mBAAmB,CAAC;IAC5B,SAAS,EAAE,gCAAgC,CAAC;IAC5C,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,iCAAiC,CAAC;IAC9C,oBAAoB,EAAE,8BAA8B,CAAC;IACrD,kBAAkB,CAAC,EAAE,4BAA4B,CAAC;CACnD,CAAC;AAEF,KAAK,oCAAoC,GAAG,wCAAwC,CAAC;AAErF,KAAK,2BAA2B,GAC5B,8BAA8B,GAC9B,uCAAuC,GACvC,oCAAoC,GACpC,qCAAqC,GACrC,oCAAoC,CAAC;AAEzC,KAAK,gBAAgB,GAAG;IACtB,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,KAAK,mCAAmC,GAAG;IACzC,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC;IACjD,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,KAAK,4CAA4C,GAAG;IAClD,MAAM,EAAE,sBAAsB,CAAC;IAC/B,SAAS,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC;IACjD,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,SAAS,EAAE,uCAAuC,CAAC;IACnD,SAAS,EAAE,MAAM,CAAC;IAClB,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF,KAAK,yCAAyC,GAAG;IAC/C,MAAM,EAAE,kBAAkB,CAAC;IAC3B,SAAS,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC;IACjD,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,iCAAiC,CAAC;IAC9C,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF,KAAK,0CAA0C,GAAG;IAChD,MAAM,EAAE,mBAAmB,CAAC;IAC5B,SAAS,EAAE,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC;IACjD,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,iCAAiC,CAAC;IAC9C,gBAAgB,EAAE,MAAM,EAAE,CAAC;CAC5B,CAAC;AAEF,KAAK,yCAAyC,GAAG;IAC/C,MAAM,EAAE,YAAY,CAAC;IACrB,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,QAAQ,EAAE,uCAAuC,CAAC;IAClD,UAAU,EAAE,iCAAiC,CAAC;IAC9C,wDAAwD;IACxD,WAAW,EAAE,MAAM,CAAC;IACpB,6GAA6G;IAC7G,SAAS,EAAE,MAAM,CAAC;IAClB,gDAAgD;IAChD,iBAAiB,EAAE,MAAM,CAAC;IAC1B,wGAAwG;IACxG,YAAY,EAAE,MAAM,CAAC;IACrB,qGAAqG;IACrG,+BAA+B,EAAE,OAAO,CAAC;IACzC,eAAe,EAAE,MAAM,CAAC;IACxB,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,oBAAoB,EAAE,MAAM,EAAE,CAAC;IAC/B,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,KAAK,gCAAgC,GACjC,mCAAmC,GACnC,4CAA4C,GAC5C,yCAAyC,GACzC,0CAA0C,GAC1C,yCAAyC,CAAC;AAE9C,KAAK,mCAAmC,GAAG;IACzC,MAAM,EAAE,6BAA6B,CAAC;IACtC,MAAM,EAAE,OAAO,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC,CAAC;AAEF,MAAM,MAAM,+BAA+B,GAAG;IAC5C,cAAc,EAAE,WAAW,CAAC;IAC5B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,aAAa,CAAC,EAAE,aAAa,CAAC;CAC/B,CAAC;AAqHF,iBAAS,kBAAkB,CAAC,SAAS,EAAE,gCAAgC;;;;;;;;;;;;;;EAgBtE;AA64CD,wBAAsB,kCAAkC,CACtD,KAAK,EAAE,+BAA+B,GACrC,OAAO,CACR,uBAAuB,CACrB,+BAA+B,EAC/B,2BAA2B,EAC3B,gCAAgC,EAChC,mCAAmC,CACpC,CACF,CAaA"}