lucid-extension-sdk 0.0.9 → 0.0.16

package/interop.d.ts

@@ -2,6 +2,8 @@
 declare namespace lucid {
     export function executeCommand(name: string, params: any): any;
     export function listen(msg: any): void;
+    export function getPackageId(): string;
+    export function getVersion(): string;
 }
 
 /** @ignore */

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -5,6 +5,7 @@ import { JsonObject, JsonSerializable } from './core/jsonserializable';
 import { LinearOffsetType } from './core/offsettype';
 import { SerializedDataError } from './core/serializeddataerror';
 import { ShapeDataInheritance } from './core/shapedatainheritance';
+import { SerializedLineTextAreaPositioning } from './document/linetextareapositioning';
 import { Box, Point } from './math';
 import { MenuLocation, MenuType } from './ui/menu';
 import { PanelLocation } from './ui/panel';
@@ -16,15 +17,19 @@ import { PanelLocation } from './ui/panel';
  * To use these directly, use [EditorClient.sendCommand](#classes_editorclient-EditorClient_sendcommand).
  */
 export declare const enum CommandName {
+    AddLineTextArea = "alta",
     AddMenuItem = "ami",
     AddShapeData = "asd",
+    Alert = "a",
     AnimateViewport = "av",
     Bootstrap = "b",
+    Confirm = "c",
     CreateBlock = "cb",
     CreateCollection = "cc",
     CreateDataSource = "cds",
     CreateLine = "cl",
     CreatePage = "cp",
+    DataAction = "da",
     DeleteItem = "di",
     DeletePage = "dp",
     DeleteShapeData = "dsd",
@@ -44,6 +49,9 @@ export declare const enum CommandName {
     GetShapeData = "gsd",
     HideModal = "hm",
     HidePanel = "hp",
+    HookCreateItems = "hci",
+    HookSelection = "hs",
+    HookTextEdit = "hte",
     KillExtension = "k",
     ListBlocks = "lb",
     ListCollectionFields = "lcf",
@@ -72,7 +80,10 @@ export declare const enum CommandName {
     SetShapeData = "ssd",
     ShowModal = "sm",
     ShowPanel = "spn",
-    SleepForTestCase = "sleep"
+    SleepForTestCase = "sleep",
+    UnhookCreateItems = "uci",
+    UnhookSelection = "us",
+    UnhookTextEdit = "ute"
 }
 /**
  * This is a type declaration whose purpose is to allow TypeScript to enforce the correct parameter and
@@ -80,9 +91,9 @@ export declare const enum CommandName {
  * which command name you pass in as the first parameter.
  */
 export declare type CommandArgs = {
-    [CommandName.AnimateViewport]: {
-        query: AnimateViewportQuery;
-        result: AnimateViewportResult;
+    [CommandName.AddLineTextArea]: {
+        query: AddLineTextAreaQuery;
+        result: AddLineTextAreaResult;
     };
     [CommandName.AddMenuItem]: {
         query: AddMenuItemQuery;
@@ -92,10 +103,22 @@ export declare type CommandArgs = {
         query: AddShapeDataQuery;
         result: AddShapeDataResult;
     };
+    [CommandName.Alert]: {
+        query: AlertQuery;
+        result: AlertResult;
+    };
+    [CommandName.AnimateViewport]: {
+        query: AnimateViewportQuery;
+        result: AnimateViewportResult;
+    };
     [CommandName.Bootstrap]: {
         query: BootstrapQuery;
         result: BootstrapResult;
     };
+    [CommandName.Confirm]: {
+        query: ConfirmQuery;
+        result: ConfirmResult;
+    };
     [CommandName.CreateBlock]: {
         query: CreateBlockQuery;
         result: CreateBlockResult;
@@ -116,6 +139,10 @@ export declare type CommandArgs = {
         query: CreatePageQuery;
         result: CreatePageResult;
     };
+    [CommandName.DataAction]: {
+        query: DataActionQuery;
+        result: DataActionResult;
+    };
     [CommandName.DeleteItem]: {
         query: DeleteItemQuery;
         result: DeleteItemResult;
@@ -192,6 +219,18 @@ export declare type CommandArgs = {
         query: HidePanelQuery;
         result: HidePanelResult;
     };
+    [CommandName.HookCreateItems]: {
+        query: HookCreateItemsQuery;
+        result: HookCreateItemsResult;
+    };
+    [CommandName.HookSelection]: {
+        query: HookSelectionQuery;
+        result: HookSelectionResult;
+    };
+    [CommandName.HookTextEdit]: {
+        query: HookTextEditQuery;
+        result: HookTextEditResult;
+    };
     [CommandName.KillExtension]: {
         query: KillExtensionQuery;
         result: KillExtensionResult;
@@ -308,14 +347,36 @@ export declare type CommandArgs = {
         query: SleepForTestCaseQuery;
         result: SleepForTestCaseResult;
     };
+    [CommandName.UnhookCreateItems]: {
+        query: UnhookCreateItemsQuery;
+        result: UnhookCreateItemsResult;
+    };
+    [CommandName.UnhookSelection]: {
+        query: UnhookSelectionQuery;
+        result: UnhookSelectionResult;
+    };
+    [CommandName.UnhookTextEdit]: {
+        query: UnhookTextEditQuery;
+        result: UnhookTextEditResult;
+    };
+};
+export declare type AddLineTextAreaQuery = {
+    /** Which line */
+    'id': string;
+    /** Where to place the text along the line */
+    'p': SerializedLineTextAreaPositioning;
+    /** Plain text to put at this location (will be styled with document theme) */
+    't': string;
 };
+/** The name of the created text area */
+export declare type AddLineTextAreaResult = string;
 /** @ignore */
 export declare type UnionToIntersection<T> = (T extends any ? (x: T) => unknown : never) extends (x: infer R) => unknown ? R : never;
 export declare type AddMenuItemQuery = {
     /** Label to display on the menu item */
     'l': string;
     /** Named action to run when the menu item is clicked */
-    'a': string;
+    'a'?: string;
     /** Named action that returns whether the menu item should be visible */
     'v'?: string;
     /** Named action that returns whether the menu item should be disabled */
@@ -324,6 +385,17 @@ export declare type AddMenuItemQuery = {
     't': MenuType;
     /** If specified, where to place the menu item; defaults to MenuLocation.Extension */
     'loc'?: MenuLocation;
+    /** If specified, this menu item should launch a file picker */
+    'f'?: {
+        /** Action to call when files are selected */
+        'a': string;
+        /** File types to accept */
+        'ac': string;
+        /** Single file only */
+        's'?: boolean;
+        /** Return content in a binary ArrayBuffer instead of as text */
+        'b'?: boolean;
+    };
 };
 export declare type AddMenuItemResult = undefined;
 export declare type AddShapeDataQuery = {
@@ -337,6 +409,16 @@ export declare type AddShapeDataQuery = {
     'v'?: SerializedFieldType;
 };
 export declare type AddShapeDataResult = undefined;
+export declare type AlertQuery = {
+    /** Title; defaults to extension title */
+    't'?: string;
+    /** Body text */
+    'b': string;
+    /** Button text; defaults to i18n'ed "OK" */
+    'bt'?: string;
+};
+/** True if they click OK, false otherwise */
+export declare type AlertResult = Promise<boolean>;
 export declare type BootstrapQuery = {
     /**
      * Named action that accepts the bootstrap data, and which may return a Promise or void. After awaiting\
@@ -345,6 +427,18 @@ export declare type BootstrapQuery = {
     'c': string;
 };
 export declare type BootstrapResult = Promise<void>;
+export declare type ConfirmQuery = {
+    /** Title; defaults to extension title */
+    't'?: string;
+    /** Body text */
+    'b': string;
+    /** OK button text; defaults to i18n'ed "OK" */
+    'o'?: string;
+    /** Cancel button text; defaults to i18n'ed "Cancel" */
+    'c'?: string;
+};
+/** True if they click OK, false otherwise */
+export declare type ConfirmResult = Promise<boolean>;
 export declare type CreateBlockQuery = {
     /**
      * By default, we add the block to the current page & currently active group. If specified, the
@@ -393,6 +487,29 @@ export declare type CreateLineQuery = {
 export declare type CreateLineResult = string;
 export declare type CreatePageQuery = void;
 export declare type CreatePageResult = string;
+export declare type DataActionQuery = {
+    /** Flow Name */
+    'fn': string;
+    /** Is Async */
+    'a': boolean;
+    /** Flow Data */
+    'fd'?: unknown;
+    /** Sync data source ID */
+    's': string;
+    /** Data Connector Name */
+    'n': string;
+};
+export declare type RawDataActionResult = {
+    /** The external service responded with this code */
+    'c': number;
+} & ({
+    /** And this text */
+    't': string;
+} | {
+    /** Or this JSON */
+    'j': unknown;
+});
+export declare type DataActionResult = Promise<RawDataActionResult>;
 export declare type DeleteItemQuery = string;
 export declare type DeleteItemResult = boolean;
 export declare type DeletePageQuery = string;
@@ -509,6 +626,21 @@ export declare type HidePanelQuery = {
     'n': string;
 };
 export declare type HidePanelResult = undefined;
+export declare type HookCreateItemsQuery = {
+    /** Name of the action for receiving events. Will be called with an array of strings of all recently created item IDs. */
+    'n': string;
+};
+export declare type HookCreateItemsResult = undefined;
+export declare type HookSelectionQuery = {
+    /** Name of the action for receiving events. Will be called with an array of strings of all selected item IDs. */
+    'n': string;
+};
+export declare type HookSelectionResult = undefined;
+export declare type HookTextEditQuery = {
+    /** Name of the action for receiving these events */
+    'n': string;
+};
+export declare type HookTextEditResult = undefined;
 export declare type KillExtensionQuery = void;
 export declare type KillExtensionResult = undefined;
 export declare type ListChildrenQuery = {
@@ -641,6 +773,7 @@ export declare type RawSendXHRResponse = {
     'to'?: boolean;
 };
 export declare type SendXHRResponse = Promise<RawSendXHRResponse>;
+export declare function isRawSendXHRResponse(val: any): val is RawSendXHRResponse;
 export declare type SetCurrentPageQuery = string;
 export declare type SetCurrentPageResult = Promise<void>;
 export declare type SetPropertyQuery = {
@@ -690,3 +823,18 @@ export declare type ShowPanelQuery = {
 export declare type ShowPanelResult = undefined;
 export declare type SleepForTestCaseQuery = number;
 export declare type SleepForTestCaseResult = Promise<void>;
+export declare type UnhookCreateItemsQuery = {
+    /** Name of the action passed to HookCreateItems */
+    'n': string;
+};
+export declare type UnhookCreateItemsResult = undefined;
+export declare type UnhookSelectionQuery = {
+    /** Name of the action for receiving these events */
+    'n': string;
+};
+export declare type UnhookSelectionResult = undefined;
+export declare type UnhookTextEditQuery = {
+    /** Name of the action for receiving these events */
+    'n': string;
+};
+export declare type UnhookTextEditResult = undefined;

package/sdk/commandtypes.js

@@ -1,2 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isRawSendXHRResponse = void 0;
+const checks_1 = require("./core/checks");
+function isRawSendXHRResponse(val) {
+    return (0, checks_1.isString)(val['url']) && (0, checks_1.isString)(val['t']) && (0, checks_1.isNumber)(val['s']) && (0, checks_1.isObject)(val['h']);
+}
+exports.isRawSendXHRResponse = isRawSendXHRResponse;

package/sdk/core/base64.d.ts

@@ -0,0 +1 @@
+export declare function decodeBase64(base64String: string): Uint8Array;

package/sdk/core/base64.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decodeBase64 = void 0;
+const alphabet = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/=';
+//This gives a ~8x speedup vs. using alphabet.indexOf() in the main decode loop.
+const charCodeToEncodedInt = [];
+for (let i = 0; i < alphabet.length; i++) {
+    charCodeToEncodedInt[alphabet.charCodeAt(i)] = i;
+}
+function decodeBase64(base64String) {
+    //Filter out whitespace, etc
+    base64String = base64String.replace(/[^A-Za-z0-9\+\/\=]/g, '');
+    if (base64String.length % 4 !== 0) {
+        throw new Error('Invalid base64 input; length must be a multiple of 4');
+    }
+    //4 characters of input turns into 3 bytes of output
+    let bytes = (base64String.length / 4) * 3;
+    //But each trailing = (up to 2) is one fewer byte of output
+    if (base64String.endsWith('==')) {
+        bytes -= 2;
+    }
+    else if (base64String.endsWith('=')) {
+        bytes -= 1;
+    }
+    const output = new Uint8Array(bytes);
+    let inputIndex = 0;
+    for (let outputIndex = 0; outputIndex < bytes; outputIndex += 3) {
+        //Get the 4 numbers 0-63 encoded in the next 4 characters
+        const enc1 = charCodeToEncodedInt[base64String.charCodeAt(inputIndex++)];
+        const enc2 = charCodeToEncodedInt[base64String.charCodeAt(inputIndex++)];
+        const enc3 = charCodeToEncodedInt[base64String.charCodeAt(inputIndex++)];
+        const enc4 = charCodeToEncodedInt[base64String.charCodeAt(inputIndex++)];
+        //Read 8 total bits into each of the output values. Skip one byte
+        //for each padding = at the end of the string
+        output[outputIndex] = (enc1 << 2) | (enc2 >> 4);
+        if (enc3 != 64) {
+            output[outputIndex + 1] = ((enc2 & 15) << 4) | (enc3 >> 2);
+        }
+        if (enc4 != 64) {
+            output[outputIndex + 2] = ((enc3 & 3) << 6) | enc4;
+        }
+    }
+    return output;
+}
+exports.decodeBase64 = decodeBase64;

package/sdk/core/data/referencekeys/serializedreferencekey.d.ts

@@ -22,3 +22,9 @@ export declare type UnTypedSerializedFlattenedReference = {
 };
 export declare type SerializedFlattenedReference = TypedSerializedFlattenedReference | UnTypedSerializedFlattenedReference;
 export declare type SerializedReferenceKeyType = SerializedReferenceKey | SerializedFlattenedReference;
+/** @ignore */
+export declare function isTypedSerializedFlattenedReference(data: unknown): data is TypedSerializedFlattenedReference;
+/** @ignore */
+export declare function isUnTypedSerializedFlattenedReference(data: unknown): data is UnTypedSerializedFlattenedReference;
+/** @ignore */
+export declare function isSerializedFlattenedReference(data: unknown): data is SerializedFlattenedReference;

package/sdk/core/data/referencekeys/serializedreferencekey.js

@@ -1,5 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FlattenedReferenceKeyName = exports.FlattenedReferenceKeyId = void 0;
+exports.isSerializedFlattenedReference = exports.isUnTypedSerializedFlattenedReference = exports.isTypedSerializedFlattenedReference = exports.FlattenedReferenceKeyName = exports.FlattenedReferenceKeyId = void 0;
+const checks_1 = require("../../checks");
 exports.FlattenedReferenceKeyId = '192d0e9f-2f5a-4032-9f03-59bbf1ea5891';
 exports.FlattenedReferenceKeyName = '192d0e9f-2f5a-4032-9f03-59bbf1ea5891_n';
+/** @ignore */
+function isTypedSerializedFlattenedReference(data) {
+    return (0, checks_1.isObject)(data) && (0, checks_1.isObject)(data['sc']) && (0, checks_1.isObject)(data['d']);
+}
+exports.isTypedSerializedFlattenedReference = isTypedSerializedFlattenedReference;
+/** @ignore */
+function isUnTypedSerializedFlattenedReference(data) {
+    return (0, checks_1.isObject)(data) && data[exports.FlattenedReferenceKeyId] === true;
+}
+exports.isUnTypedSerializedFlattenedReference = isUnTypedSerializedFlattenedReference;
+/** @ignore */
+function isSerializedFlattenedReference(data) {
+    return isUnTypedSerializedFlattenedReference(data) || isTypedSerializedFlattenedReference(data);
+}
+exports.isSerializedFlattenedReference = isSerializedFlattenedReference;

package/sdk/data/datasourceproxy.js

@@ -35,7 +35,9 @@ class DataSourceProxy extends propertystoreproxy_1.PropertyStoreProxy {
         return new collectionproxy_1.CollectionProxy(this.client.sendCommand("cc" /* CreateCollection */, {
             's': this.id,
             'n': name,
-            'f': schema.fields.map((field) => ({ 'n': field.name, 't': (0, fieldtypedefinition_1.serializeFieldTypeDefinition)(field.type) })),
+            'f': schema.fields.map((field) => {
+                return { 'n': field.name, 't': (0, fieldtypedefinition_1.serializeFieldTypeDefinition)(field.type) };
+            }),
             'p': schema.primaryKey,
         }), this.client);
     }

package/sdk/data/referencekeydefinition.d.ts

@@ -30,7 +30,7 @@ export interface CollectionReferenceKeyDefinition {
  */
 export interface FlattenedReferenceDefinition {
     /** Name to display to the user for the reference key (what would normally be the collection name) */
-    name: string;
+    name?: string;
     /** Schema of the data stored at this key */
     schema: SchemaDefinition;
     /** Field values available at this reference key */
@@ -41,3 +41,5 @@ export declare type ReferenceKeyDefinition = CollectionReferenceKeyDefinition |
 export declare function isCollectionReferenceKeyDefinition(def: ReferenceKeyDefinition): def is CollectionReferenceKeyDefinition;
 /** @ignore */
 export declare function serializeReferenceKeyDefinition(def: ReferenceKeyDefinition): SerializedReferenceKeyType;
+/** @ignore */
+export declare function parseReferenceKeyDefinition(def: SerializedReferenceKeyType): ReferenceKeyDefinition;

package/sdk/data/referencekeydefinition.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeReferenceKeyDefinition = exports.isCollectionReferenceKeyDefinition = void 0;
+exports.parseReferenceKeyDefinition = exports.serializeReferenceKeyDefinition = exports.isCollectionReferenceKeyDefinition = void 0;
 const checks_1 = require("../core/checks");
+const serializedreferencekey_1 = require("../core/data/referencekeys/serializedreferencekey");
 const schemadefinition_1 = require("./schemadefinition");
 /** @ignore */
 function isCollectionReferenceKeyDefinition(def) {
@@ -27,3 +28,25 @@ function serializeReferenceKeyDefinition(def) {
     }
 }
 exports.serializeReferenceKeyDefinition = serializeReferenceKeyDefinition;
+/** @ignore */
+function parseReferenceKeyDefinition(def) {
+    if ((0, serializedreferencekey_1.isTypedSerializedFlattenedReference)(def)) {
+        return {
+            schema: (0, schemadefinition_1.parseSchemaDefinition)(def['sc']),
+            name: def['n'],
+            data: def['d'],
+        };
+    }
+    else if ((0, serializedreferencekey_1.isUnTypedSerializedFlattenedReference)(def)) {
+        throw new Error('Untyped serialized flattened references not implemented');
+    }
+    else {
+        return {
+            collectionId: def['cid'],
+            primaryKey: def['pk'],
+            fieldWhitelist: def['wl'],
+            readonly: def['ro'],
+        };
+    }
+}
+exports.parseReferenceKeyDefinition = parseReferenceKeyDefinition;

package/sdk/data/referencekeyproxy.d.ts

@@ -6,4 +6,8 @@ export declare class ReferenceKeyProxy {
     private readonly client;
     private readonly settings;
     constructor(elementId: string | undefined, key: string | number, client: EditorClient, settings: SerializedReferenceKeyType);
+    get collectionId(): string | undefined;
+    get primaryKey(): string | undefined;
+    get definition(): import("./referencekeydefinition").ReferenceKeyDefinition;
+    getItem(): import("./dataitemproxy").DataItemProxy;
 }

package/sdk/data/referencekeyproxy.js

@@ -1,6 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReferenceKeyProxy = void 0;
+const serializedreferencekey_1 = require("../core/data/referencekeys/serializedreferencekey");
+const collectionproxy_1 = require("./collectionproxy");
+const referencekeydefinition_1 = require("./referencekeydefinition");
 class ReferenceKeyProxy {
     constructor(elementId, key, client, settings) {
         this.elementId = elementId;
@@ -8,5 +11,27 @@ class ReferenceKeyProxy {
         this.client = client;
         this.settings = settings;
     }
+    get collectionId() {
+        if ((0, serializedreferencekey_1.isSerializedFlattenedReference)(this.settings)) {
+            return undefined;
+        }
+        return this.settings['cid'];
+    }
+    get primaryKey() {
+        if ((0, serializedreferencekey_1.isSerializedFlattenedReference)(this.settings)) {
+            return undefined;
+        }
+        return this.settings['pk'];
+    }
+    get definition() {
+        return (0, referencekeydefinition_1.parseReferenceKeyDefinition)(this.settings);
+    }
+    getItem() {
+        const collectionId = this.collectionId;
+        if ((0, serializedreferencekey_1.isSerializedFlattenedReference)(this.settings) || !collectionId) {
+            throw new Error('Not implemented for flattened references');
+        }
+        return new collectionproxy_1.CollectionProxy(collectionId, this.client).items.get(this.settings['pk']);
+    }
 }
 exports.ReferenceKeyProxy = ReferenceKeyProxy;

package/sdk/data/schemadefinition.d.ts

@@ -20,3 +20,5 @@ export interface SchemaDefinition {
 }
 /** @ignore */
 export declare function serializeSchemaDefinition(def: SchemaDefinition): SerializedSchema;
+/** @ignore */
+export declare function parseSchemaDefinition(def: SerializedSchema): SchemaDefinition;

package/sdk/data/schemadefinition.js

@@ -1,15 +1,30 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeSchemaDefinition = void 0;
+exports.parseSchemaDefinition = exports.serializeSchemaDefinition = void 0;
 const fieldtypedefinition_1 = require("../core/data/fieldtypedefinition/fieldtypedefinition");
 /** @ignore */
 function serializeSchemaDefinition(def) {
     return {
-        'Fields': def.fields.map((field) => ({
-            'Name': field.name,
-            'Type': (0, fieldtypedefinition_1.serializeFieldTypeDefinition)(field.type),
-        })),
+        'Fields': def.fields.map((field) => {
+            return {
+                'Name': field.name,
+                'Type': (0, fieldtypedefinition_1.serializeFieldTypeDefinition)(field.type),
+            };
+        }),
         'PrimaryKey': def.primaryKey,
     };
 }
 exports.serializeSchemaDefinition = serializeSchemaDefinition;
+/** @ignore */
+function parseSchemaDefinition(def) {
+    return {
+        fields: def['Fields'].map((field) => {
+            return {
+                name: field['Name'],
+                type: (0, fieldtypedefinition_1.deserializeFieldTypeDefinition)(field['Type']),
+            };
+        }),
+        primaryKey: def['PrimaryKey'],
+    };
+}
+exports.parseSchemaDefinition = parseSchemaDefinition;

package/sdk/document/blockclasses/blockproxyregistry.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.findProxyClass = void 0;
+const customblockproxy_1 = require("./customblockproxy");
 const erdblockproxy_1 = require("./erdblockproxy");
-const allProxyClasses = [erdblockproxy_1.ERDBlockProxy];
+const allProxyClasses = [erdblockproxy_1.ERDBlockProxy, customblockproxy_1.CustomBlockProxy];
 function findProxyClass(className) {
     return allProxyClasses.find((proxy) => proxy.classNameRegex.test(className));
 }

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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,24 @@
+"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" /* 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$/;

package/sdk/document/blockproxy.d.ts

@@ -19,4 +19,16 @@ export declare class BlockProxy extends ItemProxy {
      * @returns An array of lines that have one or both endpoints connected to this block.
      */
     getConnectedLines(): import("./lineproxy").LineProxy[];
+    /**
+     * Link a text area to a data field, so that editing the text area will also update the
+     * associated data, and vice versa.
+     *
+     * To use this, first establish a reference key on this block with
+     * [setReferenceKey](/extension-sdk/#classes_document_blockproxy-BlockProxy_setreferencekey).
+     *
+     * @param textAreaKey
+     * @param referenceKey
+     * @param field
+     */
+    linkText(textAreaKey: string, referenceKey: string | number, field: string): void;
 }

package/sdk/document/blockproxy.js

@@ -29,5 +29,28 @@ class BlockProxy extends itemproxy_1.ItemProxy {
         const ids = this.client.sendCommand("gcl" /* GetConnectedLines */, this.id);
         return ids.map((id) => this.client.getLineProxy(id));
     }
+    /**
+     * Link a text area to a data field, so that editing the text area will also update the
+     * associated data, and vice versa.
+     *
+     * To use this, first establish a reference key on this block with
+     * [setReferenceKey](/extension-sdk/#classes_document_blockproxy-BlockProxy_setreferencekey).
+     *
+     * @param textAreaKey
+     * @param referenceKey
+     * @param field
+     */
+    linkText(textAreaKey, referenceKey, field) {
+        if (!this.textAreas.keys().includes(textAreaKey)) {
+            throw new Error('Invalid text area key');
+        }
+        if (!this.referenceKeys.keys().includes(referenceKey)) {
+            throw new Error('Invalid reference key');
+        }
+        this.properties.set(textAreaKey + '_Link', {
+            'ref': referenceKey,
+            'f': field,
+        });
+    }
 }
 exports.BlockProxy = BlockProxy;