lucid-extension-sdk 0.0.152 → 0.0.154

package/commandtypes.d.ts

@@ -53,6 +53,7 @@ export declare const enum CommandName {
     GetCurrentPage = "gcp",
     GetCustomShape = "gcs",
     GetDataItemField = "gdif",
+    GetDocumentId = "gdid",
     GetElementType = "get",
     GetItemPageId = "gip",
     GetItemsAt = "gia",
@@ -64,6 +65,7 @@ export declare const enum CommandName {
     GetSelection = "gs",
     GetShapeData = "gsd",
     GetTextStyle = "gts",
+    GetUserId = "guid",
     GetVisibleRect = "gvr",
     HideModal = "hm",
     HidePanel = "hp",
@@ -259,6 +261,10 @@ export declare type CommandArgs = {
         query: GetDataItemFieldQuery;
         result: GetDataItemFieldResult;
     };
+    [CommandName.GetDocumentId]: {
+        query: GetDocumentIdQuery;
+        result: GetDocumentIdResult;
+    };
     [CommandName.GetElementType]: {
         query: GetElementTypeQuery;
         result: GetElementTypeResult;
@@ -303,6 +309,10 @@ export declare type CommandArgs = {
         query: GetTextStyleQuery;
         result: GetTextStyleResult;
     };
+    [CommandName.GetUserId]: {
+        query: GetUserIdQuery;
+        result: GetUserIdResult;
+    };
     [CommandName.GetVisibleRect]: {
         query: GetVisibleRectQuery;
         result: GetVisibleRectResult;
@@ -865,6 +875,8 @@ export declare type GetDataItemFieldQuery = {
     'f': string;
 };
 export declare type GetDataItemFieldResult = SerializedFieldType;
+export declare type GetDocumentIdQuery = void;
+export declare type GetDocumentIdResult = string;
 export declare type GetItemPageIdQuery = string;
 export declare type GetItemPageIdResult = string;
 export declare enum GetItemsAtSearchType {
@@ -926,6 +938,8 @@ export declare type GetTextStyleQuery = {
     'n': string;
 };
 export declare type GetTextStyleResult = TextStyle;
+export declare type GetUserIdQuery = void;
+export declare type GetUserIdResult = string;
 export declare type GetVisibleRectQuery = void;
 export declare type GetVisibleRectResult = Box;
 export declare type HideModalQuery = {

package/commandtypes.js

@@ -35,6 +35,7 @@ exports.commandTitles = new Map([
     ["gcp" /* CommandName.GetCurrentPage */, 'GetCurrentPage'],
     ["gcs" /* CommandName.GetCustomShape */, 'GetCustomShape'],
     ["gdif" /* CommandName.GetDataItemField */, 'GetDataItemField'],
+    ["gdid" /* CommandName.GetDocumentId */, 'GetDocumentId'],
     ["get" /* CommandName.GetElementType */, 'GetElementType'],
     ["gip" /* CommandName.GetItemPageId */, 'GetItemPageId'],
     ["gia" /* CommandName.GetItemsAt */, 'GetItemsAt'],
@@ -46,6 +47,7 @@ exports.commandTitles = new Map([
     ["gs" /* CommandName.GetSelection */, 'GetSelection'],
     ["gsd" /* CommandName.GetShapeData */, 'GetShapeData'],
     ["gts" /* CommandName.GetTextStyle */, 'GetTextStyle'],
+    ["guid" /* CommandName.GetUserId */, 'GetUserId'],
     ["gvr" /* CommandName.GetVisibleRect */, 'GetVisibleRect'],
     ["hm" /* CommandName.HideModal */, 'HideModal'],
     ["hp" /* CommandName.HidePanel */, 'HidePanel'],

package/dataconnector/debugserver.js

@@ -22,7 +22,7 @@ function routeDebugServer(dataConnector, options) {
         next();
     });
     const prefix = (_b = options.prefix) !== null && _b !== void 0 ? _b : '/';
-    console.log(`Routing ${prefix}?kind=action (${Object.keys(dataConnector.actions).join(', ')})`);
+    console.log(`Routing ${prefix} (${Object.keys(dataConnector.actions).join(', ')})`);
     if (dataConnector.routes) {
         for (const routeName of Object.keys(dataConnector.routes)) {
             console.log(`Routing ${prefix}?kind=route&name=${routeName}`);
@@ -31,7 +31,7 @@ function routeDebugServer(dataConnector, options) {
     app.post(prefix, async (req, res) => {
         try {
             const routeKind = req.query['kind'];
-            if (routeKind === 'action') {
+            if (routeKind === 'action' || routeKind == undefined || routeKind === '') {
                 const { body, status } = await dataConnector.runAction(req.url, req.headers, JSON.parse(req.body.toString()));
                 res.status(status).json(body);
             }

package/document/documentproxy.js

@@ -11,7 +11,7 @@ const pageproxy_1 = require("./pageproxy");
  */
 class DocumentProxy extends elementproxy_1.ElementProxy {
     constructor(client) {
-        super(undefined, client);
+        super(client.sendCommand("gdid" /* CommandName.GetDocumentId */, undefined), client);
         /**
          * The set of pages on this document, organized by ID
          */

package/document/elementproxy.d.ts

@@ -42,10 +42,10 @@ export declare class ElementProxy extends PropertyStoreProxy {
     removeReferenceKey(key: number | string): void;
     /**
      *
-     * @param id ID of this element, or `undefined` for the document itself
+     * @param id ID of this element
      * @param client
      */
-    constructor(id: string | undefined, client: EditorClient);
+    constructor(id: string, client: EditorClient);
     /**
      * @returns `true` if this element still exists on the document, or `false` otherwise
      */

package/document/elementproxy.js

@@ -17,7 +17,7 @@ const shapedataproxy_1 = require("./shapedataproxy");
 class ElementProxy extends propertystoreproxy_1.PropertyStoreProxy {
     /**
      *
-     * @param id ID of this element, or `undefined` for the document itself
+     * @param id ID of this element
      * @param client
      */
     constructor(id, client) {

package/document/propertystoreproxy.d.ts

@@ -4,7 +4,7 @@ import { WriteableMapProxy } from './mapproxy';
  * Base class for anything on a Lucid document that has an ID and properties.
  */
 export declare class PropertyStoreProxy {
-    readonly id: string | undefined;
+    readonly id: string;
     protected readonly client: EditorClient;
     /**
      * All properties available on this element, organized by name.
@@ -14,8 +14,8 @@ export declare class PropertyStoreProxy {
     readonly properties: WriteableMapProxy<string, import("..").JsonSerializable, void, import("..").JsonSerializable>;
     /**
      *
-     * @param id ID of this element, or undefined for the document itself
+     * @param id ID of this element
      * @param client
      */
-    constructor(id: string | undefined, client: EditorClient);
+    constructor(id: string, client: EditorClient);
 }

package/document/propertystoreproxy.js

@@ -8,7 +8,7 @@ const mapproxy_1 = require("./mapproxy");
 class PropertyStoreProxy {
     /**
      *
-     * @param id ID of this element, or undefined for the document itself
+     * @param id ID of this element
      * @param client
      */
     constructor(id, client) {

package/index.d.ts

@@ -105,3 +105,4 @@ export * from './ui/menu';
 export * from './ui/modal';
 export * from './ui/panel';
 export * from './ui/viewport';
+export * from './user/userproxy';

package/index.js

@@ -121,3 +121,4 @@ __exportStar(require("./ui/menu"), exports);
 __exportStar(require("./ui/modal"), exports);
 __exportStar(require("./ui/panel"), exports);
 __exportStar(require("./ui/viewport"), exports);
+__exportStar(require("./user/userproxy"), exports);

package/package.json

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

package/user/userproxy.d.ts

@@ -0,0 +1,9 @@
+import { EditorClient } from '../editorclient';
+/**
+ * The UserProxy class gives access to the current user on the current Lucid document.
+ */
+export declare class UserProxy {
+    private readonly client;
+    readonly id: string;
+    constructor(client: EditorClient);
+}

package/user/userproxy.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UserProxy = void 0;
+/**
+ * The UserProxy class gives access to the current user on the current Lucid document.
+ */
+class UserProxy {
+    constructor(client) {
+        this.client = client;
+        this.id = this.client.sendCommand("guid" /* CommandName.GetUserId */, undefined);
+    }
+}
+exports.UserProxy = UserProxy;