lucid-extension-sdk 0.0.177 → 0.0.180

package/commandtypes.d.ts

@@ -6,6 +6,7 @@ import { LucidProduct } from './core/lucidproduct';
 import { LinearOffsetType } from './core/offsettype';
 import { SerializedDataError } from './core/serializeddataerror';
 import { ShapeDataInheritance } from './core/shapedatainheritance';
+import { DocumentAccessPermission } from './document/documentaccesspermission';
 import { DocumentElementType } from './document/documentelement/documentelementtype';
 import { SerializedLineTextAreaPositioning } from './document/linetextareapositioning';
 import { TextStyle } from './document/text/textstyle';
@@ -52,10 +53,12 @@ export declare const enum CommandName {
     DragPointerUp = "dpu",
     ElementExists = "ee",
     ExecuteFormula = "ef",
+    FindAvailableSpace = "fas",
     GetConnectedLines = "gcl",
     GetCurrentPage = "gcp",
     GetCustomShape = "gcs",
     GetDataItemField = "gdif",
+    GetDocumentAccessPermission = "gdap",
     GetDocumentId = "gdid",
     GetElementType = "get",
     GetItemPageId = "gip",
@@ -267,6 +270,10 @@ export type CommandArgs = {
         query: ExecuteFormulaQuery;
         result: ExecuteFormulaResult;
     };
+    [CommandName.FindAvailableSpace]: {
+        query: FindAvailableSpaceQuery;
+        result: FindAvailableSpaceResult;
+    };
     [CommandName.GetConnectedLines]: {
         query: GetConnectedLinesQuery;
         result: GetConnectedLinesResult;
@@ -283,6 +290,10 @@ export type CommandArgs = {
         query: GetDataItemFieldQuery;
         result: GetDataItemFieldResult;
     };
+    [CommandName.GetDocumentAccessPermission]: {
+        query: GetDocumentAccessPermissionQuery;
+        result: GetDocumentAccessPermissionResult;
+    };
     [CommandName.GetDocumentId]: {
         query: GetDocumentIdQuery;
         result: GetDocumentIdResult;
@@ -905,6 +916,20 @@ export type ExecuteFormulaQuery = {
     'f': string;
 };
 export type ExecuteFormulaResult = SerializedFieldType | SerializedDataError;
+export type FindAvailableSpaceQuery = {
+    /** Width */
+    'w': number;
+    /** Height */
+    'h': number;
+};
+export type FindAvailableSpaceResult = {
+    /** ID of the page you should add content to */
+    'p': string;
+    /** Origin of the rectangle of empty space */
+    'x': number;
+    /** Origin of the rectangle of empty space */
+    'y': number;
+};
 export type AnimateViewportQuery = {
     /** ID of the page to view */
     'p': string;
@@ -943,6 +968,8 @@ export type GetDataItemFieldQuery = {
     'f': string;
 };
 export type GetDataItemFieldResult = SerializedFieldType;
+export type GetDocumentAccessPermissionQuery = void;
+export type GetDocumentAccessPermissionResult = DocumentAccessPermission;
 export type GetDocumentIdQuery = void;
 export type GetDocumentIdResult = string;
 export type GetItemPageIdQuery = string;

package/commandtypes.js

@@ -33,10 +33,12 @@ exports.commandTitles = new Map([
     ["dpu" /* CommandName.DragPointerUp */, 'DragPointerUp'],
     ["ee" /* CommandName.ElementExists */, 'ElementExists'],
     ["ef" /* CommandName.ExecuteFormula */, 'ExecuteFormula'],
+    ["fas" /* CommandName.FindAvailableSpace */, 'FindAvailableSpace'],
     ["gcl" /* CommandName.GetConnectedLines */, 'GetConnectedLines'],
     ["gcp" /* CommandName.GetCurrentPage */, 'GetCurrentPage'],
     ["gcs" /* CommandName.GetCustomShape */, 'GetCustomShape'],
     ["gdif" /* CommandName.GetDataItemField */, 'GetDataItemField'],
+    ["gdap" /* CommandName.GetDocumentAccessPermission */, 'GetDocumentAccessPermission'],
     ["gdid" /* CommandName.GetDocumentId */, 'GetDocumentId'],
     ["get" /* CommandName.GetElementType */, 'GetElementType'],
     ["gip" /* CommandName.GetItemPageId */, 'GetItemPageId'],

package/document/documentaccesspermission.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This enumeration represents the access permission a user can have on a document.
+ * Note: Additional values may be added to this enumeration.
+ */
+export declare enum DocumentAccessPermission {
+    /**
+     * Can edit, share, and change access permissions.
+     */
+    EditAndShare = "editAndShare",
+    /**
+     * Can edit but can't share, or change access permissions.
+     */
+    Edit = "edit",
+    /**
+     * Can comment but can't share, edit, or change access permissions.
+     */
+    Comment = "comment",
+    /**
+     * Can view but can't share, edit, comment, or change access permissions.
+     */
+    View = "view"
+}

package/document/documentaccesspermission.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentAccessPermission = void 0;
+/**
+ * This enumeration represents the access permission a user can have on a document.
+ * Note: Additional values may be added to this enumeration.
+ */
+var DocumentAccessPermission;
+(function (DocumentAccessPermission) {
+    /**
+     * Can edit, share, and change access permissions.
+     */
+    DocumentAccessPermission["EditAndShare"] = "editAndShare";
+    /**
+     * Can edit but can't share, or change access permissions.
+     */
+    DocumentAccessPermission["Edit"] = "edit";
+    /**
+     * Can comment but can't share, edit, or change access permissions.
+     */
+    DocumentAccessPermission["Comment"] = "comment";
+    /**
+     * Can view but can't share, edit, comment, or change access permissions.
+     */
+    DocumentAccessPermission["View"] = "view";
+})(DocumentAccessPermission = exports.DocumentAccessPermission || (exports.DocumentAccessPermission = {}));

package/document/documentproxy.d.ts

@@ -22,6 +22,10 @@ export declare class DocumentProxy extends ElementProxy {
      * An iterator over all blocks on all pages of the document
      */
     allBlocks(): Generator<import("./blockproxy").BlockProxy, void, unknown>;
+    /**
+     * An iterator over all lines on all pages of the document
+     */
+    allLines(): Generator<import("./lineproxy").LineProxy, void, unknown>;
     /**
      * Add a new page to the current document
      * @param def Definition of the page to add

package/document/documentproxy.js

@@ -36,6 +36,16 @@ class DocumentProxy extends elementproxy_1.ElementProxy {
             }
         }
     }
+    /**
+     * An iterator over all lines on all pages of the document
+     */
+    *allLines() {
+        for (const page of this.pages.values()) {
+            for (const line of page.lines.values()) {
+                yield line;
+            }
+        }
+    }
     /**
      * Add a new page to the current document
      * @param def Definition of the page to add

package/document/lineproxy.d.ts

@@ -6,7 +6,7 @@ import { LineTextAreaPositioning } from './linetextareapositioning';
 export declare enum LineShape {
     Curve = "curve",
     Elbow = "elbow",
-    Straight = "straight"
+    Diagonal = "diagonal"
 }
 /**
  * A line on the current Lucid document

package/document/lineproxy.js

@@ -9,7 +9,7 @@ var LineShape;
 (function (LineShape) {
     LineShape["Curve"] = "curve";
     LineShape["Elbow"] = "elbow";
-    LineShape["Straight"] = "straight";
+    LineShape["Diagonal"] = "diagonal";
 })(LineShape = exports.LineShape || (exports.LineShape = {}));
 /**
  * A line on the current Lucid document

package/package.json

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

package/ui/modal.js

@@ -19,6 +19,7 @@ class Modal extends iframeui_1.IframeUI {
         this.visible = false;
     }
     frameClosed() {
+        this.visible = false;
         this.unhookMessages();
     }
     show() {

package/ui/viewport.d.ts

@@ -21,6 +21,18 @@ export declare class Viewport {
      * @returns An array of currently-selected items on the currently-visible page
      */
     getSelectedItems(deep?: boolean): ItemProxy[];
+    /**
+     * Find available space on the current page for adding new content.
+     * @param width
+     * @param height
+     * @returns a reference to the page and origin (upper-left point) of the space you can add new
+     * content of the given size to.
+     */
+    findAvailableSpace(width: number, height: number): {
+        page: PageProxy;
+        x: number;
+        y: number;
+    };
     /**
      * @returns the page currently being viewed
      */

package/ui/viewport.js

@@ -23,6 +23,21 @@ class Viewport {
             .map((id) => this.client.getElementProxy(id))
             .filter((proxy) => proxy instanceof itemproxy_1.ItemProxy);
     }
+    /**
+     * Find available space on the current page for adding new content.
+     * @param width
+     * @param height
+     * @returns a reference to the page and origin (upper-left point) of the space you can add new
+     * content of the given size to.
+     */
+    findAvailableSpace(width, height) {
+        const result = this.client.sendCommand("fas" /* CommandName.FindAvailableSpace */, { 'w': width, 'h': height });
+        return {
+            page: new pageproxy_1.PageProxy(result['p'], this.client),
+            x: result['x'],
+            y: result['y'],
+        };
+    }
     /**
      * @returns the page currently being viewed
      */

package/user/userproxy.d.ts

@@ -1,3 +1,4 @@
+import { DocumentAccessPermission } from '../document/documentaccesspermission';
 import { EditorClient } from '../editorclient';
 /**
  * The UserProxy class gives access to the current user on the current Lucid document.
@@ -6,4 +7,8 @@ export declare class UserProxy {
     private readonly client;
     readonly id: string;
     constructor(client: EditorClient);
+    /**
+     * @returns the permission the user has on the current document.
+     */
+    getAccessPermssionOnDocument(): DocumentAccessPermission;
 }

package/user/userproxy.js

@@ -9,5 +9,11 @@ class UserProxy {
         this.client = client;
         this.id = this.client.sendCommand("guid" /* CommandName.GetUserId */, undefined);
     }
+    /**
+     * @returns the permission the user has on the current document.
+     */
+    getAccessPermssionOnDocument() {
+        return this.client.sendCommand("gdap" /* CommandName.GetDocumentAccessPermission */, undefined);
+    }
 }
 exports.UserProxy = UserProxy;