lucid-extension-sdk 0.0.254 → 0.0.256

package/commandtypes.d.ts

@@ -60,6 +60,7 @@ export declare const enum CommandName {
     Download = "d",
     DragPointerMove = "dpm",
     DragPointerUp = "dpu",
+    DuplicateItems = "dis",
     ElementExists = "ee",
     ExecuteFormula = "ef",
     FindAvailableSpace = "fas",
@@ -303,6 +304,10 @@ export type CommandArgs = {
         query: DragPointerUpQuery;
         result: DragPointerUpResult;
     };
+    [CommandName.DuplicateItems]: {
+        query: DuplicateItemsQuery;
+        result: DuplicateItemsResult;
+    };
     [CommandName.ElementExists]: {
         query: ElementExistsQuery;
         result: ElementExistsResult;
@@ -1039,6 +1044,10 @@ export type DragPointerUpQuery = {
     'y': number;
 };
 export type DragPointerUpResult = undefined;
+export type DuplicateItemsQuery = {
+    'ids': string[];
+};
+export type DuplicateItemsResult = Promise<string[]>;
 export type ElementExistsQuery = {
     'id'?: string | undefined;
 };

package/commandtypes.js

@@ -36,6 +36,7 @@ exports.commandTitles = new Map([
     ["d" /* CommandName.Download */, 'Download'],
     ["dpm" /* CommandName.DragPointerMove */, 'DragPointerMove'],
     ["dpu" /* CommandName.DragPointerUp */, 'DragPointerUp'],
+    ["dis" /* CommandName.DuplicateItems */, 'DuplicateItems'],
     ["ee" /* CommandName.ElementExists */, 'ElementExists'],
     ["ef" /* CommandName.ExecuteFormula */, 'ExecuteFormula'],
     ["fas" /* CommandName.FindAvailableSpace */, 'FindAvailableSpace'],

package/document/documentproxy.d.ts

@@ -1,4 +1,4 @@
-import { GetDocumentChunksType } from '../commandtypes';
+import { DuplicateItemsResult, GetDocumentChunksType } from '../commandtypes';
 import { EditorClient } from '../editorclient';
 import { DocumentChunk } from './documentchunk';
 import { CardConfigProxy } from './documentelement/cardconfigproxy';
@@ -96,4 +96,5 @@ export declare class DocumentProxy extends ElementProxy {
      * @param handle Return value from `hookDeleteItems`
      */
     unhookDeleteItems(handle: string): void;
+    duplicateItems(ids: string[]): DuplicateItemsResult;
 }

package/document/documentproxy.js

@@ -177,6 +177,9 @@ class DocumentProxy extends elementproxy_1.ElementProxy {
         this.client.deleteAction(handle);
         this.client.sendCommand("udi" /* CommandName.UnhookDeleteItems */, { 'n': handle });
     }
+    async duplicateItems(ids) {
+        return await this.client.sendCommand("dis" /* CommandName.DuplicateItems */, { 'ids': ids });
+    }
 }
 exports.DocumentProxy = DocumentProxy;
 DocumentProxy.nextHookId = 0;

package/document/pageproxy.d.ts

@@ -166,4 +166,12 @@ export declare class PageProxy extends ElementProxy {
      * @returns A promise resolving to an SVG string
      */
     getSvg(items?: ItemProxy[], includeBackground?: boolean, viewBox?: Box): import("../commandtypes").GetSvgResult;
+    /**
+     * @returns the page number of this page
+     */
+    getPageNumber(): number;
+    /**
+     * Duplicates the page represented by the page proxy
+     */
+    duplicate(): Promise<void>;
 }

package/document/pageproxy.js

@@ -260,5 +260,17 @@ class PageProxy extends elementproxy_1.ElementProxy {
             'i': items === null || items === void 0 ? void 0 : items.map((item) => item.id),
         });
     }
+    /**
+     * @returns the page number of this page
+     */
+    getPageNumber() {
+        return this.properties.get('Order');
+    }
+    /**
+     * Duplicates the page represented by the page proxy
+     */
+    async duplicate() {
+        await this.client.duplicatePages([this.getPageNumber()]);
+    }
 }
 exports.PageProxy = PageProxy;

package/editorclient.d.ts

@@ -256,6 +256,14 @@ export declare class EditorClient {
      * the import failed
      */
     importPage(documentId: string, pageNums: number[]): Promise<void>;
+    /**
+     * Duplicates one or more pages of the current document as new pages.
+     *
+     * @param pageNums An array of zero-indexed page indices to duplicate from the current document
+     * @returns a promise that resolves to void when the pages have been duplicated or the
+     * the duplication failed
+     */
+    duplicatePages(pageNums: number[]): Promise<void>;
     /**
      * Load the requested shape library's content, and if it was found, return a block definition ready to be
      * created.

package/editorclient.js

@@ -449,6 +449,19 @@ class EditorClient {
     async importPage(documentId, pageNums) {
         return await this.sendCommand("imp" /* CommandName.ImportPage */, { 'id': documentId, 'n': pageNums });
     }
+    /**
+     * Duplicates one or more pages of the current document as new pages.
+     *
+     * @param pageNums An array of zero-indexed page indices to duplicate from the current document
+     * @returns a promise that resolves to void when the pages have been duplicated or the
+     * the duplication failed
+     */
+    async duplicatePages(pageNums) {
+        return await this.sendCommand("imp" /* CommandName.ImportPage */, {
+            'id': this.sendCommand("gdid" /* CommandName.GetDocumentId */, undefined),
+            'n': pageNums,
+        });
+    }
     /**
      * Load the requested shape library's content, and if it was found, return a block definition ready to be
      * created.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.254",
+    "version": "0.0.256",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "index.js",
     "types": "index.d.ts",