lucid-extension-sdk 0.0.138 → 0.0.140

package/{sdk/dataconnector → dataconnector}/dataconnector.d.ts

@@ -28,7 +28,9 @@ export declare class DataConnectorRunError extends Error {
 export declare class DataConnectorRequestError extends Error {
     status: number;
     response: string;
-    constructor(status: number, message: string, response: string);
+    statusText?: string | undefined;
+    constructor(status: number, message: string, response: string, statusText?: string | undefined);
+    toString(): string;
 }
 /** Thrown by any APIs the client didn't recognize when parsing */
 export declare class DataConnectorResponseError extends Error {

package/{sdk/dataconnector → dataconnector}/dataconnector.js

@@ -22,10 +22,14 @@ class DataConnectorRunError extends Error {
 exports.DataConnectorRunError = DataConnectorRunError;
 /** Thrown by any failable http APIs */
 class DataConnectorRequestError extends Error {
-    constructor(status, message, response) {
+    constructor(status, message, response, statusText) {
         super(message);
         this.status = status;
         this.response = response;
+        this.statusText = statusText;
+    }
+    toString() {
+        return `${this.message} ${this.statusText ? this.statusText + ' ' : ''}(${this.status}) ${this.response}`;
     }
 }
 exports.DataConnectorRequestError = DataConnectorRequestError;

package/{sdk/dataconnector → dataconnector}/dataconnectorclient.js

@@ -31,7 +31,7 @@ class DataConnectorClient {
         if (!this.cachedPublicKey) {
             const url = `${this.urls.main}.well-known/pem/TPCP`;
             const result = await this.fetchMethod(url);
-            await (0, throwunsuccessful_1.throwUnsuccessful)(result, 'Error getting public key');
+            await (0, throwunsuccessful_1.throwUnsuccessful)(result, 'getting public key');
             this.cachedPublicKey = await result.text();
         }
         return this.cachedPublicKey;
@@ -55,7 +55,7 @@ class DataConnectorClient {
                 'webhook-validation-secret': JSON.stringify(WebhookValidationSecret),
             },
         });
-        await (0, throwunsuccessful_1.throwUnsuccessful)(result, 'Error getting secret from webhook');
+        await (0, throwunsuccessful_1.throwUnsuccessful)(result, 'getting secret from webhook');
         const responseBody = await result.json();
         if ((0, checks_1.isString)(responseBody)) {
             return responseBody;
@@ -69,7 +69,7 @@ class DataConnectorClient {
         const result = await this.fetchMethod(`${this.urls.dataSync}customWebhookData`, {
             headers: { 'data-update-token': webhookUpdateToken },
         });
-        await (0, throwunsuccessful_1.throwUnsuccessful)(result, 'Error getting custom webhook data');
+        await (0, throwunsuccessful_1.throwUnsuccessful)(result, 'getting custom webhook data');
         return (await result.json());
     }
     /** @ignore */
@@ -84,7 +84,7 @@ class DataConnectorClient {
             },
             body: JSON.stringify(patch),
         });
-        await (0, throwunsuccessful_1.throwUnsuccessful)(result, 'Error patching custom webhook data');
+        await (0, throwunsuccessful_1.throwUnsuccessful)(result, 'patching custom webhook data');
         return (await result.json());
     }
 }

package/{sdk/dataconnector → dataconnector}/datasourceclient.js

@@ -50,7 +50,7 @@ class DataSourceClient {
             },
             'body': JSON.stringify(this.formatBody(request)),
         });
-        await (0, throwunsuccessful_1.throwUnsuccessful)(response, 'Error updating data source');
+        await (0, throwunsuccessful_1.throwUnsuccessful)(response, 'updating data source');
         // webhooks return 200 with an empty body
         // document updates return valid json
         // we can't use .json because that will fail for webhooks
@@ -76,7 +76,7 @@ class DataSourceClient {
                 'Lucid-Api-Version': '1',
             },
         });
-        await (0, throwunsuccessful_1.throwUnsuccessful)(response, 'Error getting data source`s metadata');
+        await (0, throwunsuccessful_1.throwUnsuccessful)(response, 'getting data source`s metadata');
         const responseBody = await response.json();
         if ((0, validators_1.arrayValidator)(datasourcemetadatatypes_1.isSerializedMetadataRecord)(responseBody)) {
             return responseBody.map((rawResponse) => {
@@ -126,7 +126,7 @@ class DataSourceClient {
             }
             throw new dataconnector_1.DataConnectorResponseError(`Invalid conflict response to query at '${this.metadataUrl}'! Expected an array of serialized metadata records`, JSON.stringify(responseBody));
         }
-        await (0, throwunsuccessful_1.throwUnsuccessful)(response, 'Error patching data source`s metadata');
+        await (0, throwunsuccessful_1.throwUnsuccessful)(response, 'patching data source`s metadata');
         return { status: 'NoContent' };
     }
 }

package/{sdk/dataconnector → dataconnector}/throwunsuccessful.js

@@ -5,7 +5,7 @@ const dataconnector_1 = require("./dataconnector");
 /** @ignore */
 async function throwUnsuccessful(result, message) {
     if (Math.floor(result.status / 100) !== 2) {
-        throw new dataconnector_1.DataConnectorRequestError(result.status, message, await result.text());
+        throw new dataconnector_1.DataConnectorRequestError(result.status, message, await result.text(), result.statusText);
     }
 }
 exports.throwUnsuccessful = throwUnsuccessful;

package/document/blockclasses/customblockproxy.d.ts

@@ -0,0 +1,21 @@
+import { EditorClient } from '../../editorclient';
+import { BlockProxy } from '../blockproxy';
+export declare type CustomBlockProxyConstructor = typeof BlockProxy & {
+    library: string;
+    shape: string;
+};
+/**
+ * Custom shapes defined in extension packages (or other stencil-providing means like Visio stencil imports)
+ * are represented by a CustomBlockProxy.
+ */
+export declare class CustomBlockProxy extends BlockProxy {
+    static classNameRegex: RegExp;
+    private static subclassRegistry;
+    static registerCustomBlockClass(klass: CustomBlockProxyConstructor): void;
+    /**
+     * @ignore
+     */
+    static getCustomBlockClass(client: EditorClient, id: string): CustomBlockProxyConstructor | typeof CustomBlockProxy;
+    isFromStencil(library: string, shape: string): boolean;
+    getStencilTextAreaName(stencilTextAreaName: string): string | undefined;
+}

package/document/blockclasses/customblockproxy.js

@@ -0,0 +1,58 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomBlockProxy = void 0;
+const checks_1 = require("../../core/checks");
+const blockproxy_1 = require("../blockproxy");
+/**
+ * Custom shapes defined in extension packages (or other stencil-providing means like Visio stencil imports)
+ * are represented by a CustomBlockProxy.
+ */
+class CustomBlockProxy extends blockproxy_1.BlockProxy {
+    static registerCustomBlockClass(klass) {
+        let byLibrary = CustomBlockProxy.subclassRegistry.get(klass.library);
+        if (!byLibrary) {
+            byLibrary = new Map();
+            CustomBlockProxy.subclassRegistry.set(klass.library, byLibrary);
+        }
+        byLibrary.set(klass.shape, klass);
+    }
+    /**
+     * @ignore
+     */
+    static getCustomBlockClass(client, id) {
+        if (this.subclassRegistry.size > 0) {
+            const stencil = client.sendCommand("gp" /* CommandName.GetProperty */, { 'id': id, 'p': 'Stencil' });
+            if ((0, checks_1.isObject)(stencil)) {
+                const sourceStencil = client.sendCommand("gp" /* CommandName.GetProperty */, { 'p': 'Stencil-' + stencil['id'] });
+                if ((0, checks_1.isObject)(sourceStencil) && (0, checks_1.isObject)(sourceStencil['sourcePackage'])) {
+                    if (sourceStencil['sourcePackage']['packageId'] === lucid.getPackageId()) {
+                        const byLibrary = CustomBlockProxy.subclassRegistry.get(String(sourceStencil['sourcePackage']['library']));
+                        const klass = byLibrary === null || byLibrary === void 0 ? void 0 : byLibrary.get(String(sourceStencil['sourcePackage']['shape']));
+                        if (klass) {
+                            return klass;
+                        }
+                    }
+                }
+            }
+        }
+        return CustomBlockProxy;
+    }
+    isFromStencil(library, shape) {
+        const stencil = this.properties.get('Stencil');
+        if ((0, checks_1.isObject)(stencil)) {
+            const sourceStencil = this.client.sendCommand("gp" /* CommandName.GetProperty */, { 'p': 'Stencil-' + stencil['id'] });
+            if ((0, checks_1.isObject)(sourceStencil) && (0, checks_1.isObject)(sourceStencil['sourcePackage'])) {
+                return (sourceStencil['sourcePackage']['packageId'] === lucid.getPackageId() &&
+                    sourceStencil['sourcePackage']['library'] === library &&
+                    sourceStencil['sourcePackage']['shape'] === shape);
+            }
+        }
+        return false;
+    }
+    getStencilTextAreaName(stencilTextAreaName) {
+        return this.textAreas.keys().find((name) => name.endsWith('_' + stencilTextAreaName));
+    }
+}
+exports.CustomBlockProxy = CustomBlockProxy;
+CustomBlockProxy.classNameRegex = /^CustomBlock$/;
+CustomBlockProxy.subclassRegistry = new Map();

package/{sdk/editorclient.js → editorclient.js}

@@ -9,6 +9,7 @@ const unfurldetails_1 = require("./core/unfurl/unfurldetails");
 const unfurlrefresherrortype_1 = require("./core/unfurl/unfurlrefresherrortype");
 const collectionproxy_1 = require("./data/collectionproxy");
 const blockproxyregistry_1 = require("./document/blockclasses/blockproxyregistry");
+const customblockproxy_1 = require("./document/blockclasses/customblockproxy");
 const linkunfurlblockproxy_1 = require("./document/blockclasses/linkunfurlblockproxy");
 const blockproxy_1 = require("./document/blockproxy");
 const documentproxy_1 = require("./document/documentproxy");
@@ -349,7 +350,10 @@ class EditorClient {
      */
     getBlockProxy(id) {
         const className = this.sendCommand("gp" /* CommandName.GetProperty */, { 'id': id, 'p': 'ClassName' });
-        const proxy = (0, blockproxyregistry_1.findProxyClass)(className);
+        let proxy = (0, blockproxyregistry_1.findProxyClass)(className);
+        if (proxy === customblockproxy_1.CustomBlockProxy) {
+            proxy = customblockproxy_1.CustomBlockProxy.getCustomBlockClass(this, id);
+        }
         if (proxy) {
             return new proxy(id, this);
         }

package/package.json

@@ -1,9 +1,9 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.138",
+    "version": "0.0.140",
     "description": "Utility classes for writing Lucid Software editor extensions",
-    "main": "sdk/index.js",
-    "types": "sdk/index.d.ts",
+    "main": "index.js",
+    "types": "index.d.ts",
     "author": "Lucid Software",
     "license": "Apache-2.0",
     "declaration": true,

package/sdk/document/blockclasses/customblockproxy.d.ts

@@ -1,6 +0,0 @@
-import { BlockProxy } from '../blockproxy';
-export declare class CustomBlockProxy extends BlockProxy {
-    static classNameRegex: RegExp;
-    isFromStencil(library: string, shape: string): boolean;
-    getStencilTextAreaName(stencilTextAreaName: string): string | undefined;
-}

package/sdk/document/blockclasses/customblockproxy.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomBlockProxy = void 0;
-const checks_1 = require("../../core/checks");
-const blockproxy_1 = require("../blockproxy");
-class CustomBlockProxy extends blockproxy_1.BlockProxy {
-    isFromStencil(library, shape) {
-        const stencil = this.properties.get('Stencil');
-        if ((0, checks_1.isObject)(stencil)) {
-            const sourceStencil = this.client.sendCommand("gp" /* CommandName.GetProperty */, { 'p': 'Stencil-' + stencil['id'] });
-            if ((0, checks_1.isObject)(sourceStencil) && (0, checks_1.isObject)(sourceStencil['sourcePackage'])) {
-                return (sourceStencil['sourcePackage']['packageId'] === lucid.getPackageId() &&
-                    sourceStencil['sourcePackage']['library'] === library &&
-                    sourceStencil['sourcePackage']['shape'] === shape);
-            }
-        }
-        return false;
-    }
-    getStencilTextAreaName(stencilTextAreaName) {
-        return this.textAreas.keys().find((name) => name.endsWith('_' + stencilTextAreaName));
-    }
-}
-exports.CustomBlockProxy = CustomBlockProxy;
-CustomBlockProxy.classNameRegex = /^CustomBlock$/;