lucid-extension-sdk 0.0.163 → 0.0.165

package/commandtypes.d.ts

@@ -75,6 +75,7 @@ export declare const enum CommandName {
     HookSelection = "hs",
     HookTextEdit = "hte",
     ImportCards = "ic",
+    ImportPage = "imp",
     KillExtension = "k",
     ListBlocks = "lb",
     ListCollectionFields = "lcf",
@@ -357,6 +358,10 @@ export declare type CommandArgs = {
         query: ImportCardsQuery;
         result: ImportCardsResult;
     };
+    [CommandName.ImportPage]: {
+        query: ImportPageQuery;
+        result: ImportPageResult;
+    };
     [CommandName.ListBlocks]: {
         query: ListChildrenQuery;
         result: ListChildrenResult;
@@ -1001,6 +1006,14 @@ export declare type HookTextEditResult = undefined;
 export declare type ImportCardsQuery = string;
 /** Resolves when the import dialog is closed */
 export declare type ImportCardsResult = Promise<void>;
+export declare type ImportPageQuery = {
+    /** The ID of the document or template to import */
+    'id': string;
+    /** Page numbers of specified document or template to import (zero-indexed) */
+    'n': number[];
+};
+/** Resolves when the import succeeds or fails */
+export declare type ImportPageResult = Promise<void>;
 export declare type KillExtensionQuery = void;
 export declare type KillExtensionResult = undefined;
 export declare type ListChildrenQuery = {

package/commandtypes.js

@@ -57,6 +57,7 @@ exports.commandTitles = new Map([
     ["hs" /* CommandName.HookSelection */, 'HookSelection'],
     ["hte" /* CommandName.HookTextEdit */, 'HookTextEdit'],
     ["ic" /* CommandName.ImportCards */, 'ImportCards'],
+    ["imp" /* CommandName.ImportPage */, 'ImportPage'],
     ["k" /* CommandName.KillExtension */, 'KillExtension'],
     ["lb" /* CommandName.ListBlocks */, 'ListBlocks'],
     ["lcf" /* CommandName.ListCollectionFields */, 'ListCollectionFields'],

package/document/blockclasses/linkunfurlblockproxy.d.ts

@@ -19,6 +19,14 @@ export declare class LinkUnfurlBlockProxy extends BlockProxy {
      * the block.
      */
     getProviderName(): string;
+    /**
+     * Gets the URL the user will be redirected to when the user clicks the "Pop Out" action on the block.
+     */
+    getUrl(): string | undefined;
+    /**
+     * Sets the URL the user will be redirected to when the user clicks the "Pop Out" action on the block.
+     */
+    setUrl(url: string): void;
     /**
      * Sets the URL to be loaded in an iframe when the user clicks the "Expand" action on the block.
      */
@@ -35,6 +43,14 @@ export declare class LinkUnfurlBlockProxy extends BlockProxy {
      * Sets additional thumbnails on the block
      */
     setThumbnailUrls(thumbnails: string[]): void;
+    /**
+     * Gets the url for the favicon on the block
+     */
+    getFaviconUrl(): string;
+    /**
+     * Sets the favicon on the block
+     */
+    setFaviconUrl(faviconUrl: string): void;
     /**
      * @ignore
      * Initiates the PDF upload for this block. The result includes an uploadUrl which you can use to upload the PDF.

package/document/blockclasses/linkunfurlblockproxy.js

@@ -27,6 +27,18 @@ class LinkUnfurlBlockProxy extends blockproxy_1.BlockProxy {
     getProviderName() {
         return this.textAreas.get('t_LinkUnfurlProviderName');
     }
+    /**
+     * Gets the URL the user will be redirected to when the user clicks the "Pop Out" action on the block.
+     */
+    getUrl() {
+        return this.properties.get('LinkUnfurlUrl');
+    }
+    /**
+     * Sets the URL the user will be redirected to when the user clicks the "Pop Out" action on the block.
+     */
+    setUrl(url) {
+        this.properties.set('LinkUnfurlUrl', url);
+    }
     /**
      * Sets the URL to be loaded in an iframe when the user clicks the "Expand" action on the block.
      */
@@ -54,6 +66,18 @@ class LinkUnfurlBlockProxy extends blockproxy_1.BlockProxy {
     setThumbnailUrls(thumbnails) {
         this.properties.set('LinkUnfurlThumbnailUrls', thumbnails);
     }
+    /**
+     * Gets the url for the favicon on the block
+     */
+    getFaviconUrl() {
+        return this.properties.get('LinkUnfurlFaviconUrl');
+    }
+    /**
+     * Sets the favicon on the block
+     */
+    setFaviconUrl(faviconUrl) {
+        this.properties.set('LinkUnfurlFaviconUrl', faviconUrl);
+    }
     /**
      * @ignore
      * Initiates the PDF upload for this block. The result includes an uploadUrl which you can use to upload the PDF.

package/editorclient.d.ts

@@ -221,6 +221,18 @@ export declare class EditorClient {
      * @returns a promise that resolves when the block classes can be used to create new blocks on the document
      */
     loadBlockClasses(classNames: string[]): Promise<undefined>;
+    /**
+     * Import one or pages of the specified document or template into the current document
+     * as new pages.
+     * NOTE: The indices of the pages to import will change if the pages are rearranged
+     * on the source document or template.
+     *
+     * @param documentId The ID of the document or template to import
+     * @param pageNums An array of zero-indexed page indices to import from the document or template
+     * @returns a promise that resolves to void when the pages have been imported or the
+     * the import failed
+     */
+    importPage(documentId: string, 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

@@ -373,6 +373,20 @@ class EditorClient {
     loadBlockClasses(classNames) {
         return this.sendCommand("lbc" /* CommandName.LoadBlockClasses */, classNames);
     }
+    /**
+     * Import one or pages of the specified document or template into the current document
+     * as new pages.
+     * NOTE: The indices of the pages to import will change if the pages are rearranged
+     * on the source document or template.
+     *
+     * @param documentId The ID of the document or template to import
+     * @param pageNums An array of zero-indexed page indices to import from the document or template
+     * @returns a promise that resolves to void when the pages have been imported or the
+     * the import failed
+     */
+    async importPage(documentId, pageNums) {
+        return await this.sendCommand("imp" /* CommandName.ImportPage */, { 'id': documentId, '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.163",
+    "version": "0.0.165",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "index.js",
     "types": "index.d.ts",