@superdoc-dev/sdk 1.0.0-alpha.28 → 1.0.0-alpha.29

package/dist/generated/client.cjs

@@ -108,6 +108,7 @@ function createDocApi(runtime) {
             sectionBreak: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.create.sectionBreak"], params, options),
             table: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.create.table"], params, options),
             tableOfContents: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.create.tableOfContents"], params, options),
+            image: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.create.image"], params, options),
         },
         sections: {
             list: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.sections.list"], params, options),
@@ -231,6 +232,21 @@ function createDocApi(runtime) {
             undo: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.history.undo"], params, options),
             redo: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.history.redo"], params, options),
         },
+        images: {
+            list: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.images.list"], params, options),
+            get: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.images.get"], params, options),
+            delete: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.images.delete"], params, options),
+            move: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.images.move"], params, options),
+            convertToInline: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.images.convertToInline"], params, options),
+            convertToFloating: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.images.convertToFloating"], params, options),
+            setSize: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.images.setSize"], params, options),
+            setWrapType: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.images.setWrapType"], params, options),
+            setWrapSide: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.images.setWrapSide"], params, options),
+            setWrapDistances: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.images.setWrapDistances"], params, options),
+            setPosition: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.images.setPosition"], params, options),
+            setAnchorOptions: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.images.setAnchorOptions"], params, options),
+            setZOrder: (params, options) => runtime.invoke(contract.CONTRACT.operations["doc.images.setZOrder"], params, options),
+        },
         open: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.open"], params, options),
         save: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.save"], params, options),
         close: (params = {}, options) => runtime.invoke(contract.CONTRACT.operations["doc.close"], params, options),

package/dist/generated/client.d.ts

@@ -3474,6 +3474,230 @@ export interface DocHistoryRedoParams {
     expectedRevision?: number;
     changeMode?: string;
 }
+export interface DocCreateImageParams {
+    doc?: string;
+    sessionId?: string;
+    out?: string;
+    force?: boolean;
+    expectedRevision?: number;
+    changeMode?: string;
+    dryRun?: boolean;
+    src: string;
+    alt?: string;
+    title?: string;
+    size?: {
+        width?: number;
+        height?: number;
+    };
+    at?: ({
+        kind: "documentStart";
+    }) | ({
+        kind: "documentEnd";
+    }) | ({
+        kind: "before";
+        target: {
+            kind: "block";
+            nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
+            nodeId: string;
+        };
+    }) | ({
+        kind: "after";
+        target: {
+            kind: "block";
+            nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
+            nodeId: string;
+        };
+    }) | ({
+        kind: "inParagraph";
+        target: {
+            kind: "block";
+            nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
+            nodeId: string;
+        };
+        offset?: number;
+    });
+}
+export interface DocImagesListParams {
+    doc?: string;
+    sessionId?: string;
+    offset?: number;
+    limit?: number;
+}
+export interface DocImagesGetParams {
+    doc?: string;
+    sessionId?: string;
+    imageId: string;
+}
+export interface DocImagesDeleteParams {
+    doc?: string;
+    sessionId?: string;
+    out?: string;
+    force?: boolean;
+    expectedRevision?: number;
+    changeMode?: string;
+    dryRun?: boolean;
+    imageId: string;
+}
+export interface DocImagesMoveParams {
+    doc?: string;
+    sessionId?: string;
+    out?: string;
+    force?: boolean;
+    expectedRevision?: number;
+    changeMode?: string;
+    dryRun?: boolean;
+    imageId: string;
+    to: ({
+        kind: "documentStart";
+    }) | ({
+        kind: "documentEnd";
+    }) | ({
+        kind: "before";
+        target: {
+            kind: "block";
+            nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
+            nodeId: string;
+        };
+    }) | ({
+        kind: "after";
+        target: {
+            kind: "block";
+            nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
+            nodeId: string;
+        };
+    }) | ({
+        kind: "inParagraph";
+        target: {
+            kind: "block";
+            nodeType: "paragraph" | "heading" | "listItem" | "table" | "tableRow" | "tableCell" | "tableOfContents" | "image" | "sdt";
+            nodeId: string;
+        };
+        offset?: number;
+    });
+}
+export interface DocImagesConvertToInlineParams {
+    doc?: string;
+    sessionId?: string;
+    out?: string;
+    force?: boolean;
+    expectedRevision?: number;
+    changeMode?: string;
+    dryRun?: boolean;
+    imageId: string;
+}
+export interface DocImagesConvertToFloatingParams {
+    doc?: string;
+    sessionId?: string;
+    out?: string;
+    force?: boolean;
+    expectedRevision?: number;
+    changeMode?: string;
+    dryRun?: boolean;
+    imageId: string;
+}
+export interface DocImagesSetSizeParams {
+    doc?: string;
+    sessionId?: string;
+    out?: string;
+    force?: boolean;
+    expectedRevision?: number;
+    changeMode?: string;
+    dryRun?: boolean;
+    imageId: string;
+    size: {
+        width: number;
+        height: number;
+        unit?: "px" | "pt" | "twip";
+    };
+}
+export interface DocImagesSetWrapTypeParams {
+    doc?: string;
+    sessionId?: string;
+    out?: string;
+    force?: boolean;
+    expectedRevision?: number;
+    changeMode?: string;
+    dryRun?: boolean;
+    imageId: string;
+    type: string;
+}
+export interface DocImagesSetWrapSideParams {
+    doc?: string;
+    sessionId?: string;
+    out?: string;
+    force?: boolean;
+    expectedRevision?: number;
+    changeMode?: string;
+    dryRun?: boolean;
+    imageId: string;
+    side: string;
+}
+export interface DocImagesSetWrapDistancesParams {
+    doc?: string;
+    sessionId?: string;
+    out?: string;
+    force?: boolean;
+    expectedRevision?: number;
+    changeMode?: string;
+    dryRun?: boolean;
+    imageId: string;
+    distances: {
+        distTop?: number;
+        distBottom?: number;
+        distLeft?: number;
+        distRight?: number;
+    };
+}
+export interface DocImagesSetPositionParams {
+    doc?: string;
+    sessionId?: string;
+    out?: string;
+    force?: boolean;
+    expectedRevision?: number;
+    changeMode?: string;
+    dryRun?: boolean;
+    imageId: string;
+    position: {
+        hRelativeFrom?: string;
+        vRelativeFrom?: string;
+        alignH?: string;
+        alignV?: string;
+        marginOffset?: {
+            horizontal?: number;
+            top?: number;
+        };
+    };
+}
+export interface DocImagesSetAnchorOptionsParams {
+    doc?: string;
+    sessionId?: string;
+    out?: string;
+    force?: boolean;
+    expectedRevision?: number;
+    changeMode?: string;
+    dryRun?: boolean;
+    imageId: string;
+    options: {
+        behindDoc?: boolean;
+        allowOverlap?: boolean;
+        layoutInCell?: boolean;
+        lockAnchor?: boolean;
+        simplePos?: boolean;
+    };
+}
+export interface DocImagesSetZOrderParams {
+    doc?: string;
+    sessionId?: string;
+    out?: string;
+    force?: boolean;
+    expectedRevision?: number;
+    changeMode?: string;
+    dryRun?: boolean;
+    imageId: string;
+    zOrder: {
+        relativeHeight: number;
+    };
+}
 export interface DocOpenParams {
     doc?: string;
     sessionId?: string;
@@ -4662,6 +4886,12 @@ export type DocCapabilitiesGetResult = {
             reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
             tracked: boolean;
         };
+        "create.image": {
+            available: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+            tracked: boolean;
+        };
         "create.paragraph": {
             available: boolean;
             dryRun: boolean;
@@ -5112,6 +5342,84 @@ export type DocCapabilitiesGetResult = {
             reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
             tracked: boolean;
         };
+        "images.convertToFloating": {
+            available: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+            tracked: boolean;
+        };
+        "images.convertToInline": {
+            available: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+            tracked: boolean;
+        };
+        "images.delete": {
+            available: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+            tracked: boolean;
+        };
+        "images.get": {
+            available: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+            tracked: boolean;
+        };
+        "images.list": {
+            available: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+            tracked: boolean;
+        };
+        "images.move": {
+            available: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+            tracked: boolean;
+        };
+        "images.setAnchorOptions": {
+            available: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+            tracked: boolean;
+        };
+        "images.setPosition": {
+            available: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+            tracked: boolean;
+        };
+        "images.setSize": {
+            available: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+            tracked: boolean;
+        };
+        "images.setWrapDistances": {
+            available: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+            tracked: boolean;
+        };
+        "images.setWrapSide": {
+            available: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+            tracked: boolean;
+        };
+        "images.setWrapType": {
+            available: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+            tracked: boolean;
+        };
+        "images.setZOrder": {
+            available: boolean;
+            dryRun: boolean;
+            reasons?: Array<"COMMAND_UNAVAILABLE" | "HELPER_UNAVAILABLE" | "OPERATION_UNAVAILABLE" | "TRACKED_MODE_UNAVAILABLE" | "DRY_RUN_UNAVAILABLE" | "NAMESPACE_UNAVAILABLE" | "STYLES_PART_MISSING" | "COLLABORATION_ACTIVE">;
+            tracked: boolean;
+        };
         info: {
             available: boolean;
             dryRun: boolean;
@@ -6092,6 +6400,59 @@ export type DocHistoryRedoResult = {
         before: string;
     };
 };
+export type DocCreateImageResult = {
+    image: Record<string, unknown>;
+    success: true;
+};
+export type DocImagesListResult = {
+    items: Array<Record<string, unknown>>;
+    total: number;
+};
+export type DocImagesGetResult = Record<string, unknown>;
+export type DocImagesDeleteResult = {
+    image: Record<string, unknown>;
+    success: true;
+};
+export type DocImagesMoveResult = {
+    image: Record<string, unknown>;
+    success: true;
+};
+export type DocImagesConvertToInlineResult = {
+    image: Record<string, unknown>;
+    success: true;
+};
+export type DocImagesConvertToFloatingResult = {
+    image: Record<string, unknown>;
+    success: true;
+};
+export type DocImagesSetSizeResult = {
+    image: Record<string, unknown>;
+    success: true;
+};
+export type DocImagesSetWrapTypeResult = {
+    image: Record<string, unknown>;
+    success: true;
+};
+export type DocImagesSetWrapSideResult = {
+    image: Record<string, unknown>;
+    success: true;
+};
+export type DocImagesSetWrapDistancesResult = {
+    image: Record<string, unknown>;
+    success: true;
+};
+export type DocImagesSetPositionResult = {
+    image: Record<string, unknown>;
+    success: true;
+};
+export type DocImagesSetAnchorOptionsResult = {
+    image: Record<string, unknown>;
+    success: true;
+};
+export type DocImagesSetZOrderResult = {
+    image: Record<string, unknown>;
+    success: true;
+};
 export type DocOpenResult = {
     contextId: string;
     sessionType: string;
@@ -6305,6 +6666,7 @@ export declare function createDocApi(runtime: SuperDocRuntime): {
         sectionBreak: (params?: DocCreateSectionBreakParams, options?: InvokeOptions) => Promise<DocCreateSectionBreakResult>;
         table: (params: DocCreateTableParams, options?: InvokeOptions) => Promise<DocCreateTableResult>;
         tableOfContents: (params?: DocCreateTableOfContentsParams, options?: InvokeOptions) => Promise<DocCreateTableOfContentsResult>;
+        image: (params: DocCreateImageParams, options?: InvokeOptions) => Promise<DocCreateImageResult>;
     };
     sections: {
         list: (params?: DocSectionsListParams, options?: InvokeOptions) => Promise<DocSectionsListResult>;
@@ -6428,6 +6790,21 @@ export declare function createDocApi(runtime: SuperDocRuntime): {
         undo: (params?: DocHistoryUndoParams, options?: InvokeOptions) => Promise<DocHistoryUndoResult>;
         redo: (params?: DocHistoryRedoParams, options?: InvokeOptions) => Promise<DocHistoryRedoResult>;
     };
+    images: {
+        list: (params?: DocImagesListParams, options?: InvokeOptions) => Promise<DocImagesListResult>;
+        get: (params: DocImagesGetParams, options?: InvokeOptions) => Promise<DocImagesGetResult>;
+        delete: (params: DocImagesDeleteParams, options?: InvokeOptions) => Promise<DocImagesDeleteResult>;
+        move: (params: DocImagesMoveParams, options?: InvokeOptions) => Promise<DocImagesMoveResult>;
+        convertToInline: (params: DocImagesConvertToInlineParams, options?: InvokeOptions) => Promise<DocImagesConvertToInlineResult>;
+        convertToFloating: (params: DocImagesConvertToFloatingParams, options?: InvokeOptions) => Promise<DocImagesConvertToFloatingResult>;
+        setSize: (params: DocImagesSetSizeParams, options?: InvokeOptions) => Promise<DocImagesSetSizeResult>;
+        setWrapType: (params: DocImagesSetWrapTypeParams, options?: InvokeOptions) => Promise<DocImagesSetWrapTypeResult>;
+        setWrapSide: (params: DocImagesSetWrapSideParams, options?: InvokeOptions) => Promise<DocImagesSetWrapSideResult>;
+        setWrapDistances: (params: DocImagesSetWrapDistancesParams, options?: InvokeOptions) => Promise<DocImagesSetWrapDistancesResult>;
+        setPosition: (params: DocImagesSetPositionParams, options?: InvokeOptions) => Promise<DocImagesSetPositionResult>;
+        setAnchorOptions: (params: DocImagesSetAnchorOptionsParams, options?: InvokeOptions) => Promise<DocImagesSetAnchorOptionsResult>;
+        setZOrder: (params: DocImagesSetZOrderParams, options?: InvokeOptions) => Promise<DocImagesSetZOrderResult>;
+    };
     open: (params?: DocOpenParams, options?: InvokeOptions) => Promise<DocOpenResult>;
     save: (params?: DocSaveParams, options?: InvokeOptions) => Promise<DocSaveResult>;
     close: (params?: DocCloseParams, options?: InvokeOptions) => Promise<DocCloseResult>;