lucid-extension-sdk 0.0.178 → 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';
@@ -57,6 +58,7 @@ export declare const enum CommandName {
     GetCurrentPage = "gcp",
     GetCustomShape = "gcs",
     GetDataItemField = "gdif",
+    GetDocumentAccessPermission = "gdap",
     GetDocumentId = "gdid",
     GetElementType = "get",
     GetItemPageId = "gip",
@@ -288,6 +290,10 @@ export type CommandArgs = {
         query: GetDataItemFieldQuery;
         result: GetDataItemFieldResult;
     };
+    [CommandName.GetDocumentAccessPermission]: {
+        query: GetDocumentAccessPermissionQuery;
+        result: GetDocumentAccessPermissionResult;
+    };
     [CommandName.GetDocumentId]: {
         query: GetDocumentIdQuery;
         result: GetDocumentIdResult;
@@ -962,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

@@ -38,6 +38,7 @@ exports.commandTitles = new Map([
     ["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/package.json

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

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;