lucid-extension-sdk 0.0.68 → 0.0.71

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.68",
+    "version": "0.0.71",
     "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 { DocumentElementType } from './document/documentelement/documentelementtype';
 import { SerializedLineTextAreaPositioning } from './document/linetextareapositioning';
 import { Box, Point } from './math';
 import { MenuLocation, MenuType } from './ui/menu';
@@ -64,6 +65,7 @@ export declare const enum CommandName {
     ListCollections = "lc",
     ListDataItems = "ldi",
     ListDataSources = "lds",
+    ListDocumentElements = "lde",
     ListGroups = "lg",
     ListLines = "ll",
     ListPages = "lp",
@@ -292,6 +294,10 @@ export declare type CommandArgs = {
         query: ListDataSourcesQuery;
         result: ListDataSourcesResult;
     };
+    [CommandName.ListDocumentElements]: {
+        query: ListDocumentElementsQuery;
+        result: ListDocumentElementsResult;
+    };
     [CommandName.ListGroups]: {
         query: ListChildrenQuery;
         result: ListChildrenResult;
@@ -806,6 +812,10 @@ export declare type ListCollectionFieldsQuery = {
 export declare type ListCollectionFieldsResult = string[];
 export declare type ListDataSourcesQuery = undefined;
 export declare type ListDataSourcesResult = string[];
+export declare type ListDocumentElementsQuery = {
+    't': DocumentElementType;
+};
+export declare type ListDocumentElementsResult = string[];
 export declare type ListPagesQuery = void;
 export declare type ListPagesResult = string[];
 export declare type ListReferenceKeysQuery = {

package/sdk/commandtypes.js

@@ -49,6 +49,7 @@ exports.commandTitles = new Map([
     ["lc" /* CommandName.ListCollections */, 'ListCollections'],
     ["ldi" /* CommandName.ListDataItems */, 'ListDataItems'],
     ["lds" /* CommandName.ListDataSources */, 'ListDataSources'],
+    ["lde" /* CommandName.ListDocumentElements */, 'ListDocumentElements'],
     ["lg" /* CommandName.ListGroups */, 'ListGroups'],
     ["ll" /* CommandName.ListLines */, 'ListLines'],
     ["lp" /* CommandName.ListPages */, 'ListPages'],

package/sdk/core/cardintegration/cardintegration.d.ts

@@ -111,17 +111,14 @@ export interface CardIntegration {
     dataConnectorName: string;
     fieldConfiguration: {
         /**
-         * Callback to provide a list of all supported field definitions for the card integration.
-         *
-         * Any fields on the schema of the collection that you don't provide a ExtensionCardFieldDefinition
-         * for will have a default definition generated based on the type specified in the schema.
+         * Callback to provide a list of all supported field names for the card integration.
          */
-        getAllFields: (collection: CollectionProxy) => Promise<ExtensionCardFieldDefinition[]>;
+        getAllFields: (collection: CollectionProxy) => Promise<string[]>;
         /**
          * Callback that handled changes in the fields the user wants to be displayed in the card integration.
          * If this callback is not provided then the user will not be shown the modal to configure fields.
          */
-        onSelectedFieldsChange?: (dataSource: DataSourceProxy, selectedFields: string[]) => void;
+        onSelectedFieldsChange?: (dataSource: DataSourceProxy, selectedFields: string[]) => Promise<void>;
     };
     /**
      * If specified, and the user hasn't yet authorized the data connector for this extension,

package/sdk/core/data/serializedfield/serializedfielddefinition.d.ts

@@ -16,6 +16,7 @@ export declare enum FieldConstraintType {
     SINGLE_LINE_ONLY = "singleLineOnly",
     NO_WHITESPACE = "noWhitespace"
 }
+export declare const isFieldConstraintType: (x: unknown) => x is FieldConstraintType;
 export declare type SerializedFieldConstraint = {
     'Type': FieldConstraintType;
     'Details'?: JsonSerializable;

package/sdk/core/data/serializedfield/serializedfielddefinition.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FieldConstraintType = void 0;
+exports.isFieldConstraintType = exports.FieldConstraintType = void 0;
+const validators_1 = require("../../validators/validators");
 // The options here must match com.lucidchart.data.model.fielddefinition.FieldConstraintType on the backend
 var FieldConstraintType;
 (function (FieldConstraintType) {
@@ -11,3 +12,4 @@ var FieldConstraintType;
     FieldConstraintType["SINGLE_LINE_ONLY"] = "singleLineOnly";
     FieldConstraintType["NO_WHITESPACE"] = "noWhitespace";
 })(FieldConstraintType = exports.FieldConstraintType || (exports.FieldConstraintType = {}));
+exports.isFieldConstraintType = (0, validators_1.enumValidator)(FieldConstraintType);

package/sdk/core/validators/validators.d.ts

@@ -116,6 +116,10 @@ export declare function either<A, B>(validatorA: Validator<A>, validatorB: Valid
  * This is useful for validating properties that have been composed of a generic and more specific values.
  */
 export declare function both<A, B>(validatorA: Validator<A>, validatorB: Validator<B>): (x: unknown) => x is A & B;
+/**
+ * Create a validator that allows types excluding those that satisfy an excludeValidator.
+ */
+export declare function exclude<T extends U, U>(validator: (x: unknown) => x is U, excludeValidator: (x: U) => x is T): (x: unknown) => x is Exclude<U, T>;
 /**
  * Get a validator which returns whether the property calculation structure is
  * correct.

package/sdk/core/validators/validators.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.asAssertion = exports.validatorWithMessage = exports.minLengthValidator = exports.maxLengthValidator = exports.isDate = exports.isPositiveNumber = exports.isSize = exports.isPanelSize = exports.isBoundingBox = exports.isPointLike = exports.isOpacity = exports.isTrue = exports.isFlag = exports.isRestrictions = exports.isStringOrNegativeOne = exports.isBooleanOrEmptyString = exports.isNumberOrEmptyString = exports.isSet = exports.propertyValidator = exports.both = exports.either = exports.isNullOption = exports.nullableOption = exports.option = exports.nullable = exports.objectOfValidator = exports.recordValidator = exports.strictObjectValidator = exports.objectValidator = exports.mapValidator = exports.someValidator = exports.someValue = exports.tupleValidator = exports.arrayValidator = exports.rangeValidator = exports.enumValidator = exports.stringEnumValidator = void 0;
+exports.asAssertion = exports.validatorWithMessage = exports.minLengthValidator = exports.maxLengthValidator = exports.isDate = exports.isPositiveNumber = exports.isSize = exports.isPanelSize = exports.isBoundingBox = exports.isPointLike = exports.isOpacity = exports.isTrue = exports.isFlag = exports.isRestrictions = exports.isStringOrNegativeOne = exports.isBooleanOrEmptyString = exports.isNumberOrEmptyString = exports.isSet = exports.propertyValidator = exports.exclude = exports.both = exports.either = exports.isNullOption = exports.nullableOption = exports.option = exports.nullable = exports.objectOfValidator = exports.recordValidator = exports.strictObjectValidator = exports.objectValidator = exports.mapValidator = exports.someValidator = exports.someValue = exports.tupleValidator = exports.arrayValidator = exports.rangeValidator = exports.enumValidator = exports.stringEnumValidator = void 0;
 const checks_1 = require("../checks");
 const object_1 = require("../object");
 /*********************************************************************************
@@ -243,6 +243,13 @@ function both(validatorA, validatorB) {
     };
 }
 exports.both = both;
+/**
+ * Create a validator that allows types excluding those that satisfy an excludeValidator.
+ */
+function exclude(validator, excludeValidator) {
+    return (x) => validator(x) && !excludeValidator(x);
+}
+exports.exclude = exclude;
 /**
  * Get a validator which returns whether the property calculation structure is
  * correct.

package/sdk/data/schemadefinition.d.ts

@@ -1,3 +1,4 @@
+import { isNumber, isUndefined } from '../core/checks';
 import { FieldTypeDefinition } from '../core/data/fieldtypedefinition/fieldtypedefinition';
 import { FieldConstraintType, SerializedFieldConstraint, SerializedFieldDefinition } from '../core/data/serializedfield/serializedfielddefinition';
 import { SerializedSchema } from '../core/data/serializedfield/serializedschema';
@@ -26,6 +27,18 @@ export interface NoWhitespaceFieldConstraintDefinition {
     value?: undefined;
 }
 export declare type FieldConstraintDefinition = RequiredFieldConstraintDefinition | LockedFieldConstraintDefinition | MinValueFieldConstraintDefinition | MaxValueFieldConstraintDefinition | SingleLineFieldConstraintDefinition | NoWhitespaceFieldConstraintDefinition;
+export declare function minMaxFieldConstraintValidator(val: unknown): val is FieldConstraintType.MIN_VALUE | FieldConstraintType.MAX_VALUE;
+export declare const isFieldConstraintDefinition: (x: unknown) => x is {
+    type?: FieldConstraintType | undefined;
+} & {
+    type: FieldConstraintType;
+} & (import("..").DestructureGuardedTypeObj<{
+    type: typeof minMaxFieldConstraintValidator;
+    value: typeof isNumber;
+}> | import("..").DestructureGuardedTypeObj<{
+    type: (x: unknown) => x is FieldConstraintType.REQUIRED | FieldConstraintType.LOCKED | FieldConstraintType.SINGLE_LINE_ONLY | FieldConstraintType.NO_WHITESPACE;
+    value: typeof isUndefined;
+}>);
 /**
  * The definition for a field to be included in a [SchemaDefinition](#interfaces_data_schemadefinition-SchemaDefinition)
  */

package/sdk/data/schemadefinition.js

@@ -1,9 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseSchemaDefinition = exports.parseFieldDefinition = exports.serializeSchemaDefinition = exports.serializeFieldDefinition = exports.serializeFieldConstraintDefinition = void 0;
+exports.parseSchemaDefinition = exports.parseFieldDefinition = exports.serializeSchemaDefinition = exports.serializeFieldDefinition = exports.serializeFieldConstraintDefinition = exports.isFieldConstraintDefinition = exports.minMaxFieldConstraintValidator = void 0;
 const checks_1 = require("../core/checks");
 const fieldtypedefinition_1 = require("../core/data/fieldtypedefinition/fieldtypedefinition");
 const serializedfielddefinition_1 = require("../core/data/serializedfield/serializedfielddefinition");
+const validators_1 = require("../core/validators/validators");
+function minMaxFieldConstraintValidator(val) {
+    return val === serializedfielddefinition_1.FieldConstraintType.MIN_VALUE || val === serializedfielddefinition_1.FieldConstraintType.MAX_VALUE;
+}
+exports.minMaxFieldConstraintValidator = minMaxFieldConstraintValidator;
+exports.isFieldConstraintDefinition = (0, validators_1.both)((0, validators_1.objectValidator)({
+    'type': serializedfielddefinition_1.isFieldConstraintType,
+}), (0, validators_1.either)((0, validators_1.objectValidator)({ 'type': minMaxFieldConstraintValidator, 'value': checks_1.isNumber }), (0, validators_1.objectValidator)({ 'type': (0, validators_1.exclude)(serializedfielddefinition_1.isFieldConstraintType, minMaxFieldConstraintValidator), 'value': checks_1.isUndefined })));
 /** @ignore */
 function serializeFieldConstraintDefinition(constraint) {
     return {

package/sdk/document/documentelement/cardconfigproxy.d.ts

@@ -0,0 +1,10 @@
+import { EditorClient } from '../../editorclient';
+import { DocumentElementProxy } from './documentelementproxy';
+export declare class CardConfigProxy extends DocumentElementProxy {
+    readonly id: string;
+    /**
+     * @param id The ID of this card config element
+     * @param client
+     */
+    constructor(id: string, client: EditorClient);
+}

package/sdk/document/documentelement/cardconfigproxy.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CardConfigProxy = void 0;
+const documentelementproxy_1 = require("./documentelementproxy");
+class CardConfigProxy extends documentelementproxy_1.DocumentElementProxy {
+    /**
+     * @param id The ID of this card config element
+     * @param client
+     */
+    constructor(id, client) {
+        super(id, client);
+        this.id = id;
+    }
+}
+exports.CardConfigProxy = CardConfigProxy;

package/sdk/document/documentelement/documentelementproxy.d.ts

@@ -0,0 +1,10 @@
+import { EditorClient } from '../../editorclient';
+import { PropertyStoreProxy } from '../propertystoreproxy';
+export declare class DocumentElementProxy extends PropertyStoreProxy {
+    readonly id: string;
+    /**
+     * @param id The ID of this document element
+     * @param client
+     */
+    constructor(id: string, client: EditorClient);
+}

package/sdk/document/documentelement/documentelementproxy.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentElementProxy = void 0;
+const propertystoreproxy_1 = require("../propertystoreproxy");
+class DocumentElementProxy extends propertystoreproxy_1.PropertyStoreProxy {
+    /**
+     * @param id The ID of this document element
+     * @param client
+     */
+    constructor(id, client) {
+        super(id, client);
+        this.id = id;
+    }
+}
+exports.DocumentElementProxy = DocumentElementProxy;

package/sdk/document/documentelement/documentelementtype.d.ts

@@ -0,0 +1,15 @@
+/**
+ * An enumeration of document element types. A Document element represents a collection of data that is stored on a document.
+ */
+export declare enum DocumentElementType {
+    DerivedStructure = "DerivedStructure",
+    Path = "Path",
+    Tag = "Tag",
+    CommentThreadMetadata = "ThreadMetadata",
+    FontStylePreset = "FontStylePreset",
+    IntraDocumentMutex = "Mutex",
+    Rule = "Rule",
+    RuleGroup = "RuleGroup",
+    DocumentFormula = "Formula",
+    TaskCardFieldsConfig = "TaskCardFieldsConfig"
+}

package/sdk/document/documentelement/documentelementtype.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentElementType = void 0;
+/**
+ * An enumeration of document element types. A Document element represents a collection of data that is stored on a document.
+ */
+var DocumentElementType;
+(function (DocumentElementType) {
+    DocumentElementType["DerivedStructure"] = "DerivedStructure";
+    DocumentElementType["Path"] = "Path";
+    DocumentElementType["Tag"] = "Tag";
+    DocumentElementType["CommentThreadMetadata"] = "ThreadMetadata";
+    DocumentElementType["FontStylePreset"] = "FontStylePreset";
+    DocumentElementType["IntraDocumentMutex"] = "Mutex";
+    DocumentElementType["Rule"] = "Rule";
+    DocumentElementType["RuleGroup"] = "RuleGroup";
+    DocumentElementType["DocumentFormula"] = "Formula";
+    DocumentElementType["TaskCardFieldsConfig"] = "TaskCardFieldsConfig";
+})(DocumentElementType = exports.DocumentElementType || (exports.DocumentElementType = {}));

package/sdk/document/documentproxy.d.ts

@@ -1,4 +1,5 @@
 import { EditorClient } from '../editorclient';
+import { CardConfigProxy } from './documentelement/cardconfigproxy';
 import { ElementProxy } from './elementproxy';
 import { ItemProxy } from './itemproxy';
 import { MapProxy } from './mapproxy';
@@ -51,4 +52,5 @@ export declare class DocumentProxy extends ElementProxy {
      * @param handle Return value from `hookCreateItems`
      */
     unhookCreateItems(handle: string): void;
+    readonly cardIntegrationConfigs: MapProxy<string, CardConfigProxy>;
 }

package/sdk/document/documentproxy.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DocumentProxy = void 0;
+const cardconfigproxy_1 = require("./documentelement/cardconfigproxy");
+const documentelementtype_1 = require("./documentelement/documentelementtype");
 const elementproxy_1 = require("./elementproxy");
 const mapproxy_1 = require("./mapproxy");
 const pageproxy_1 = require("./pageproxy");
@@ -14,6 +16,7 @@ class DocumentProxy extends elementproxy_1.ElementProxy {
          * The set of pages on this document, organized by ID
          */
         this.pages = new mapproxy_1.MapProxy(() => this.client.sendCommand("lp" /* CommandName.ListPages */, undefined), (pageId) => new pageproxy_1.PageProxy(pageId, this.client));
+        this.cardIntegrationConfigs = new mapproxy_1.MapProxy(() => this.client.sendCommand("lde" /* CommandName.ListDocumentElements */, { 't': documentelementtype_1.DocumentElementType.TaskCardFieldsConfig }), (id) => new cardconfigproxy_1.CardConfigProxy(id, this.client));
     }
     static getNextHookName() {
         return '__documentproxy__hook' + DocumentProxy.nextHookId++;

package/sdk/document/taskmanagementcardintegration.js

@@ -38,16 +38,15 @@ class TaskManagementCardIntegration {
         this.client.registerAction(getFieldsActionName, async (param) => {
             const collection = new collectionproxy_1.CollectionProxy(param['c'], this.client);
             const fields = await card.fieldConfiguration.getAllFields(collection);
-            const serializedFields = (0, cardintegration_1.serializeCardFieldArrayDefinition)(fields);
-            return serializedFields;
+            return fields;
         });
         let onSelectedFieldsChangeActionName = undefined;
         const onSelectedFieldsChange = card.fieldConfiguration.onSelectedFieldsChange;
         if (onSelectedFieldsChange) {
             onSelectedFieldsChangeActionName = TaskManagementCardIntegration.nextHookName();
-            this.client.registerAction(onSelectedFieldsChangeActionName, (param) => {
+            this.client.registerAction(onSelectedFieldsChangeActionName, async (param) => {
                 const dataSource = new datasourceproxy_1.DataSourceProxy(param['ds'], this.client);
-                onSelectedFieldsChange(dataSource, param['sf']);
+                await onSelectedFieldsChange(dataSource, param['sf']);
             });
         }
         const getDefaultConfigActionName = TaskManagementCardIntegration.nextHookName();