lucid-extension-sdk 0.0.437 → 0.0.439

package/commandtypes.d.ts

@@ -747,6 +747,21 @@ export type AddCardsActions = {
 };
 export type AutoSyncSettings = {
     'h': string;
+    /** Phrases */
+    'p'?: {
+        /** Header */
+        'h': string;
+        /** query placeholder */
+        'qph': string;
+        /**remove non matching label */
+        'rnml': string;
+        /**no matched label */
+        'nml': string;
+        /**syncing growl message*/
+        'sgm'?: string | undefined;
+        /**removing growl message */
+        'rgm'?: string | undefined;
+    };
     'gsf': string;
     'sqs'?: string | undefined;
     'syqs'?: string | undefined;
@@ -762,6 +777,8 @@ export type SerializedFieldConfiguration = {
     'dsc'?: string | undefined;
     /** Custom field display settings */
     'cfds'?: SerializedCustomFieldDisplaySettings;
+    /** Non-customizable fields */
+    'ncf'?: string[] | undefined;
 };
 export type AddCardIntegrationQuery = {
     /** Title/name */
@@ -908,9 +925,9 @@ export type AddCardIntegrationQuery = {
         'cb': string;
     } | undefined;
     /**
-     * whether the user has access to items
+     * Whether the user can edit an item in the data source.
      */
-    'hait'?: string | undefined;
+    'cei'?: string | undefined;
 };
 export type AddCardIntegrationResult = undefined;
 /** @ignore */
@@ -1398,8 +1415,13 @@ export type GetDataItemFieldQuery = {
     'c': string;
     /** Primary key of the data item to read */
     'pk': string;
-    /** Name of field to read */
+    /** Name of field (or field label, if 'l' is true) to read */
     'f': string;
+    /**
+     * "label" - If true, get the field by label, not name
+     * (Labels are specified by `FieldLabelOverrides` in `SerializedSchema`)
+     * */
+    'l'?: boolean | undefined;
 };
 export type GetDataItemFieldResult = SerializedFieldType;
 export type GetDeveloperModeStatusQuery = void;
@@ -1631,6 +1653,8 @@ export type ListDataItemsResult = string[];
 export type ListCollectionFieldsQuery = {
     /** Collection ID to query */
     'id': string;
+    /** "labels" - If true, list field labels. Otherwise, list field names (default) */
+    'l'?: boolean | undefined;
 };
 export type ListCollectionFieldsResult = string[];
 export type ListDataSourcesQuery = undefined;

package/core/cardintegration/cardfielddisplaysettings.d.ts

@@ -221,7 +221,6 @@ export declare function serializeLucidCardFieldDisplaySettings(settings: LucidCa
 export declare function deserializeLucidCardFieldDisplaySettings(settings: SerializedLucidCardFieldDisplaySettings): LucidCardFieldDisplaySettings;
 /**
  * These are the six possible values for the status of a basic card block.
- * Must be kept in sync with cake/app/webroot/ts/libraries/lucidcards/lucidcarddefaultstatus.ts
  */
 export declare enum StatusValues {
     New = "New",

package/core/cardintegration/cardfielddisplaysettings.js

@@ -189,10 +189,10 @@ function deserializeLucidCardFieldDisplaySettings(settings) {
 exports.deserializeLucidCardFieldDisplaySettings = deserializeLucidCardFieldDisplaySettings;
 /**
  * These are the six possible values for the status of a basic card block.
- * Must be kept in sync with cake/app/webroot/ts/libraries/lucidcards/lucidcarddefaultstatus.ts
  */
 var StatusValues;
 (function (StatusValues) {
+    // IMPORTANT: Must be kept in sync with cake/app/webroot/ts/libraries/lucidcards/lucidcarddefaultstatus.ts
     StatusValues["New"] = "New";
     StatusValues["Todo"] = "To Do";
     StatusValues["InProgress"] = "In Progress";

package/core/cardintegration/cardintegrationautosyncconfig.d.ts

@@ -1,10 +1,24 @@
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
 import { ExtensionCardFieldDefinition, ImportResult, SearchResult } from '../sharedcardintegration/cardintegrationdefinitions';
+/**
+ * The amount of results that will be displayed per page when using pagination. To enable pagination, define the
+ * {@link SearchResult.itemsPerSearchResult} field in your search results and return workitems equal to this variable's
+ * value.
+ */
+export declare const AutoSyncPaginationSize = 50;
+/**
+ * This config defines variables and methods required to implement query sync for various container objects in Lucid
+ * (e.g. timelines).
+ */
 export interface CardIntegrationAutoSyncConfig {
     /**
-     * The header to display for the integration. For example, the Jira integration displays "JQL query sync"
+     * @deprecated Use AutoSyncConfigPhrasesType instead.
      */
     header: string;
+    /**
+     * The phrases to use for the auto sync callout. This is used to display the correct strings in the UI.
+     */
+    phrases?: AutoSyncConfigPhrasesType | undefined;
     /**
      * Callback that should return a single field that users can use to determine which instance, workspace,
      * organization (or any equivalent field for an extension) so that the data source id can be caluclated
@@ -14,14 +28,45 @@ export interface CardIntegrationAutoSyncConfig {
      */
     getSyncDataSourceIdField: (searchSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
     /**
-     * Perform a search on the query string. This should support pagination.
+     * Perform a search on the query string. This should support pagination (See {@link AutoSyncPaginationSize}).
      *
      * The syncDataSourceIdNonce is provided in otherFields
-     * @returns either an error AutoSyncError or an array of issues / tasks / cards represented as an AutoSyncRow
+     * @param pageNumber If undefined, will return all results from the search
+     * @returns the search results after searching using the given query string.
      */
-    searchQueryString?: (queryString: string, otherFields: Map<string, SerializedFieldType>, pageNumber: number, nextPageToken: string | undefined) => Promise<SearchResult>;
+    searchQueryString?: (queryString: string, otherFields: Map<string, SerializedFieldType>, pageNumber: number | undefined, nextPageToken: string | undefined) => Promise<SearchResult>;
     /**
      * @returns the ImportResult for the query string.
      */
     syncQueryString?: (queryString: string, otherFields: Map<string, SerializedFieldType>) => Promise<ImportResult | ImportResult[]>;
 }
+export interface AutoSyncConfigPhrasesType {
+    /**
+     * The header to display for the integration in the autosync modal.
+     */
+    header: string;
+    /**
+     * The query placeholder string to display for the integration. For example, the Jira integration displays "Search with a JQL query..."
+     */
+    queryPlaceholder: string;
+    /**
+     * The string to display for the checkbox to set if non-matching items would be removed for syncing. For example, the Jira integration displays "Remove issues that don't match this query"
+     */
+    removeNonMatchingLabel: (generator: SupportedAutoSyncGeneratorType) => string;
+    /**
+     * The string to display when there are no matched items. For example, the Jira integration displays "No issues matched your search query"
+     */
+    noMatchedLabel: string;
+    /**
+     * If defined, A growl would show up with the string when the cards are syncing / importing into generators. For example, the Jira integration displays "Syncing 1 issue" or "Syncing 5 issues"
+     */
+    syncingGrowlMessage?: ((count: number) => string) | undefined;
+    /**
+     * If defined, A growl would show up with the string when cards gets removed because of they are not matched with the query . For example, the Jira integration displays "1 Jira issue removed" or "5 Jira issues removed"
+     */
+    removingGrowlMessage?: ((count: number) => string) | undefined;
+}
+export declare enum SupportedAutoSyncGeneratorType {
+    Timeline = "timeline"
+}
+export declare const isSupportedAutoSyncGeneratorType: (x: unknown) => x is SupportedAutoSyncGeneratorType.Timeline;

package/core/cardintegration/cardintegrationautosyncconfig.js

@@ -1,2 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isSupportedAutoSyncGeneratorType = exports.SupportedAutoSyncGeneratorType = exports.AutoSyncPaginationSize = void 0;
+const validators_1 = require("../validators/validators");
+/**
+ * The amount of results that will be displayed per page when using pagination. To enable pagination, define the
+ * {@link SearchResult.itemsPerSearchResult} field in your search results and return workitems equal to this variable's
+ * value.
+ */
+exports.AutoSyncPaginationSize = 50;
+var SupportedAutoSyncGeneratorType;
+(function (SupportedAutoSyncGeneratorType) {
+    SupportedAutoSyncGeneratorType["Timeline"] = "timeline";
+})(SupportedAutoSyncGeneratorType || (exports.SupportedAutoSyncGeneratorType = SupportedAutoSyncGeneratorType = {}));
+exports.isSupportedAutoSyncGeneratorType = (0, validators_1.stringEnumValidator)(SupportedAutoSyncGeneratorType);

package/core/cardintegration/cardintegrationparams.d.ts

@@ -23,17 +23,27 @@ export interface SearchParam {
     'o': number;
     'l': number;
 }
+/** @ignore */
 export interface QuerySearchParam {
     'qs': string;
     'of': [string, SerializedFieldType][];
-    'pn': number;
+    'pn': number | undefined;
     'npt': string | undefined;
 }
+/** @ignore */
 export interface QuerySyncParam {
     'qs': string;
     'of': [string, SerializedFieldType][];
 }
 /** @ignore */
+export interface QuerySyncRemoveNonMatchingLabelParam {
+    'g': string;
+}
+/** @ignore */
+export interface QuerySyncGrowlMessageParam {
+    'c': number;
+}
+/** @ignore */
 export interface ImportParam {
     'pks': string[];
     's': [string, SerializedFieldType][];
@@ -101,7 +111,7 @@ export interface ImportFromSerializedFieldsCallbackParam {
     'sf': SerializedFields[];
 }
 /** @ignore */
-export interface HasAccessToItemsParam {
+export interface CanEditItemsParam {
     'ek': string;
     'dk'?: string;
 }

package/core/cardintegration/lucidcardintegration.d.ts

@@ -9,10 +9,10 @@ import { ImportCardFromPastedLinkCallback } from '../importcardfrompastedlink/im
 import { DependenciesForItems, ExtensionCardFieldDefinition, ExtensionFieldConfiguration, ImportResult } from '../sharedcardintegration/cardintegrationdefinitions';
 import { CardIntegrationAutoSyncConfig } from './cardintegrationautosyncconfig';
 import { CardIntegrationConfig } from './cardintegrationconfig';
-import { CardUserAccessResult } from './carduseraccessresult';
 import { DependencyMappingPhrasesType } from './dependencymappingphrases';
 import { LucidCardIntegrationCustomImportModal } from './lucidcardintegrationcustomimportmodal';
 import { LucidCardIntegrationStandardImportModal } from './lucidcardintegrationstandardimportmodal';
+import { UserItemEditPermissions } from './useritemeditpermissions';
 export interface FieldDescriptor {
     name: string;
     label?: string | undefined;
@@ -156,7 +156,7 @@ export declare abstract class LucidCardIntegration {
      */
     importFromSerializedFields?: (data: SerializedFields[]) => Promise<ImportCardFromDetails>;
     /**
-     * @experimental When defined, allows the extension to make cards that the user doesn't have access to view-only.
+     * @experimental When defined, allows the extension to make cards that the user can't edit view-only.
      */
-    hasAccessToItems?: (editedKey: string, dependencyKey: string | undefined) => Promise<CardUserAccessResult>;
+    canEditItems?: (editedKey: string, dependencyKey: string | undefined) => Promise<UserItemEditPermissions>;
 }

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -9,9 +9,10 @@ const importcardfrompastedlinkeventmessage_1 = require("../../message/importcard
 const checks_1 = require("../checks");
 const importcardfromdetails_1 = require("../importcardfromdetails/importcardfromdetails");
 const cardintegrationdefinitions_1 = require("../sharedcardintegration/cardintegrationdefinitions");
+const cardintegrationautosyncconfig_1 = require("./cardintegrationautosyncconfig");
 const cardintegrationconfig_1 = require("./cardintegrationconfig");
-const carduseraccessresult_1 = require("./carduseraccessresult");
 const lucidcardintegrationcustomimportmodal_1 = require("./lucidcardintegrationcustomimportmodal");
+const useritemeditpermissions_1 = require("./useritemeditpermissions");
 class LucidCardIntegrationRegistry {
     static nextHookName() {
         return '__lucidcard__hook' + LucidCardIntegrationRegistry.nextHookId++;
@@ -236,7 +237,7 @@ class LucidCardIntegrationRegistry {
      * Register a card integration.
      */
     static addCardIntegration(client, cardIntegration) {
-        var _a, _b, _c, _d;
+        var _a, _b, _c, _d, _e, _f;
         const getFieldsActionName = LucidCardIntegrationRegistry.nextHookName();
         client.registerAction(getFieldsActionName, async (param) => {
             const dataSource = new datasourceproxy_1.DataSourceProxy(param['d'], client);
@@ -384,6 +385,35 @@ class LucidCardIntegrationRegistry {
                 'h': autoSync.header,
                 'gsf': LucidCardIntegrationRegistry.nextHookName(),
             };
+            if (autoSync.phrases) {
+                serialized['as']['p'] = {
+                    'h': autoSync.phrases.header,
+                    'qph': autoSync.phrases.queryPlaceholder,
+                    'rnml': LucidCardIntegrationRegistry.nextHookName(),
+                    'nml': autoSync.phrases.noMatchedLabel,
+                };
+                client.registerAction(serialized['as']['p']['rnml'], ({ 'g': inputSoFar }) => {
+                    var _a;
+                    if (!(0, cardintegrationautosyncconfig_1.isSupportedAutoSyncGeneratorType)(inputSoFar)) {
+                        return '';
+                    }
+                    return (_a = autoSync.phrases) === null || _a === void 0 ? void 0 : _a.removeNonMatchingLabel(inputSoFar);
+                });
+                if ((_a = autoSync.phrases) === null || _a === void 0 ? void 0 : _a.syncingGrowlMessage) {
+                    serialized['as']['p']['sgm'] = LucidCardIntegrationRegistry.nextHookName();
+                    client.registerAction(serialized['as']['p']['sgm'], ({ 'c': count }) => {
+                        var _a, _b;
+                        return (_b = (_a = autoSync.phrases) === null || _a === void 0 ? void 0 : _a.syncingGrowlMessage) === null || _b === void 0 ? void 0 : _b.call(_a, count);
+                    });
+                }
+                if ((_b = autoSync.phrases) === null || _b === void 0 ? void 0 : _b.removingGrowlMessage) {
+                    serialized['as']['p']['rgm'] = LucidCardIntegrationRegistry.nextHookName();
+                    client.registerAction(serialized['as']['p']['rgm'], ({ 'c': count }) => {
+                        var _a, _b;
+                        return (_b = (_a = autoSync.phrases) === null || _a === void 0 ? void 0 : _a.removingGrowlMessage) === null || _b === void 0 ? void 0 : _b.call(_a, count);
+                    });
+                }
+            }
             client.registerAction(serialized['as']['gsf'], async ({ 'i': inputSoFar }) => {
                 const result = await autoSync.getSyncDataSourceIdField(new Map(inputSoFar));
                 return (0, cardintegrationdefinitions_1.serializeCardFieldArrayDefinition)(result);
@@ -416,10 +446,13 @@ class LucidCardIntegrationRegistry {
         if (cardIntegration.fieldConfiguration.customFieldDisplaySettings) {
             serialized['fc']['cfds'] = {
                 'd': cardIntegration.fieldConfiguration.customFieldDisplaySettings.defaultToMultilineText,
-                'uri': (_b = (_a = cardIntegration.fieldConfiguration) === null || _a === void 0 ? void 0 : _a.customFieldDisplaySettings) === null || _b === void 0 ? void 0 : _b.useRoundIcons,
-                'dadr': (_d = (_c = cardIntegration.fieldConfiguration) === null || _c === void 0 ? void 0 : _c.customFieldDisplaySettings) === null || _d === void 0 ? void 0 : _d.displayMappedDatesAsDateRange,
+                'uri': (_d = (_c = cardIntegration.fieldConfiguration) === null || _c === void 0 ? void 0 : _c.customFieldDisplaySettings) === null || _d === void 0 ? void 0 : _d.useRoundIcons,
+                'dadr': (_f = (_e = cardIntegration.fieldConfiguration) === null || _e === void 0 ? void 0 : _e.customFieldDisplaySettings) === null || _f === void 0 ? void 0 : _f.displayMappedDatesAsDateRange,
             };
         }
+        if (cardIntegration.fieldConfiguration.nonCustomizableFields) {
+            serialized['fc']['ncf'] = cardIntegration.fieldConfiguration.nonCustomizableFields;
+        }
         this.registerDependencyMapping(client, cardIntegration, serialized);
         this.registerImportCardFromPastedLinkHandler(client, cardIntegration, serialized);
         if (cardIntegration.importFromSerializedFields) {
@@ -430,12 +463,12 @@ class LucidCardIntegrationRegistry {
                 return (0, importcardfromdetails_1.serializeImportCardFromDetails)(result);
             });
         }
-        if (cardIntegration.hasAccessToItems) {
-            const hasAccessToItemsActionName = LucidCardIntegrationRegistry.nextHookName();
-            serialized['hait'] = hasAccessToItemsActionName;
-            client.registerAction(hasAccessToItemsActionName, async ({ 'ek': editedKey, 'dk': dependencyKey }) => {
-                const result = await cardIntegration.hasAccessToItems(editedKey, dependencyKey);
-                return (0, carduseraccessresult_1.serializeCardUserAccessResult)(result);
+        if (cardIntegration.canEditItems) {
+            const canEditItemsActionName = LucidCardIntegrationRegistry.nextHookName();
+            serialized['cei'] = canEditItemsActionName;
+            client.registerAction(canEditItemsActionName, async ({ 'ek': editedKey, 'dk': dependencyKey }) => {
+                const result = await cardIntegration.canEditItems(editedKey, dependencyKey);
+                return (0, useritemeditpermissions_1.serializeUserItemEditPermissions)(result);
             });
         }
         client.sendCommand("aci" /* CommandName.AddCardIntegration */, serialized);

package/core/cardintegration/useritemeditpermissions.d.ts

@@ -0,0 +1,26 @@
+import { SerializedFieldConstraint } from '../data/serializedfield/serializedfielddefinition';
+/**
+ * Defines whether the current user can edit an item.
+ */
+export interface UserItemEditPermissions {
+    hasPermission: boolean;
+    constraints: {
+        fieldName: string;
+        constraints?: SerializedFieldConstraint[];
+    }[];
+}
+export declare class UserCanEditItem implements UserItemEditPermissions {
+    readonly hasPermission = true;
+    constraints: never[];
+}
+export declare class UserCannotEditItem implements UserItemEditPermissions {
+    readonly hasPermission = false;
+    constraints: never[];
+}
+export declare function serializeUserItemEditPermissions(result: UserItemEditPermissions): {
+    hp: boolean;
+    c: {
+        fn: string;
+        cs: SerializedFieldConstraint[] | undefined;
+    }[];
+};

package/core/cardintegration/useritemeditpermissions.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeUserItemEditPermissions = exports.UserCannotEditItem = exports.UserCanEditItem = void 0;
+class UserCanEditItem {
+    constructor() {
+        this.hasPermission = true;
+        this.constraints = [];
+    }
+}
+exports.UserCanEditItem = UserCanEditItem;
+class UserCannotEditItem {
+    constructor() {
+        this.hasPermission = false;
+        this.constraints = [];
+    }
+}
+exports.UserCannotEditItem = UserCannotEditItem;
+function serializeUserItemEditPermissions(result) {
+    return {
+        'hp': result.hasPermission,
+        'c': result.constraints.map((c) => ({
+            'fn': c.fieldName,
+            'cs': c.constraints,
+        })),
+    };
+}
+exports.serializeUserItemEditPermissions = serializeUserItemEditPermissions;

package/core/data/fieldtypedefinition/lucidfields.d.ts

@@ -14,8 +14,6 @@
  * Integration Simplicity: Simplifies the process of integrating new data sources into Lucid by mapping to an established set of Lucid Fields.
  * Feature Compatibility: Allows for seamless use of Lucid’s intelligent features across all data, regardless of its origin.
  * Data Organization: Provides a structured approach to organizing and grouping data within the Lucid ecosystem.
- *
- * Must be kept in sync with src/jvm/com/lucidchart/data/model/fielddefinition/LucidFields.scala
  */
 export declare enum LucidFields {
     /**

package/core/data/fieldtypedefinition/lucidfields.js

@@ -18,11 +18,10 @@ const validators_1 = require("../../validators/validators");
  * Integration Simplicity: Simplifies the process of integrating new data sources into Lucid by mapping to an established set of Lucid Fields.
  * Feature Compatibility: Allows for seamless use of Lucid’s intelligent features across all data, regardless of its origin.
  * Data Organization: Provides a structured approach to organizing and grouping data within the Lucid ecosystem.
- *
- * Must be kept in sync with src/jvm/com/lucidchart/data/model/fielddefinition/LucidFields.scala
  */
 var LucidFields;
 (function (LucidFields) {
+    // IMPORTANT: this enum must be kept in sync with src/jvm/com/lucidchart/data/model/fielddefinition/LucidFields.scala
     /**
      * Represents the title or main descriptor of an item.
      */

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

@@ -13,7 +13,8 @@ export declare enum FieldConstraintType {
     SINGLE_LINE_ONLY = "singleLineOnly",
     NO_WHITESPACE = "noWhitespace",
     UNIQUE_EDIT = "uniqueEditType",
-    MAX_LENGTH = "maxLength"
+    MAX_LENGTH = "maxLength",
+    MAX_DECIMAL_LENGTH = "maxDecimalLength"
 }
 export declare const isFieldConstraintType: (x: unknown) => x is FieldConstraintType;
 export type SerializedFieldConstraint = {

package/core/data/serializedfield/serializedfielddefinition.js

@@ -18,6 +18,7 @@ var FieldConstraintType;
     FieldConstraintType["NO_WHITESPACE"] = "noWhitespace";
     FieldConstraintType["UNIQUE_EDIT"] = "uniqueEditType";
     FieldConstraintType["MAX_LENGTH"] = "maxLength";
+    FieldConstraintType["MAX_DECIMAL_LENGTH"] = "maxDecimalLength";
 })(FieldConstraintType || (exports.FieldConstraintType = FieldConstraintType = {}));
 exports.isFieldConstraintType = (0, validators_1.enumValidator)(FieldConstraintType);
 exports.isSerializedFieldConstraint = (0, validators_1.objectValidator)({

package/core/properties/fillcolor.d.ts

@@ -23,6 +23,7 @@ export type SerializedImageFill = {
     'FlipX'?: boolean;
     'FlipY'?: boolean;
     'isSvg'?: boolean;
+    'ImageId'?: string;
 };
 /** @ignore */
 export type SimpleSerializedFillStyle = string | SerializedImageFill;

package/core/sharedcardintegration/cardintegrationdefinitions.d.ts

@@ -154,8 +154,10 @@ export interface SearchResultPerCollection {
  * If you change this interface, check if your changes need to be synced with
  * editorextensioncardintegrationregistry.ts.
  *
- * By specifying the itemsPerSearchResult, you can enable pagination for results in the import modal. The offset and limit
- * parameters in the search function will tell you which page of results to return.
+ * By specifying the itemsPerSearchResult, you can enable pagination for results in the import modal OR the
+ * query sync modal. The offset and limit parameters in the search function will tell you which page of results
+ * to return, whereas the {@link AutoSyncPaginationSize} variable and pageNumber parameter should be used to
+ * calculate which search reults to return for query sync.
  *
  */
 export interface SearchResult {
@@ -271,6 +273,10 @@ export type ExtensionFieldConfiguration = {
     defaultSearchCallback?: string;
     /** Optional properties to configure how fields are displayed */
     customFieldDisplaySettings?: CustomFieldDisplaySettings;
+    /** List of field names that will not be displayed in the settings panel or edit panel, so its badge position cannot be changed by user
+     *  Order matters here, as the order of the fields in this list will be used to determine the order of the badges in the card
+     */
+    nonCustomizableFields?: string[] | undefined;
 };
 /**
  * Maps item field names to icons that show next to the field labels in the card details panel.

package/data/dataitemproxy.d.ts

@@ -18,6 +18,10 @@ export declare class DataItemProxy {
      * The fields on this data item, organized by their name.
      */
     readonly fields: MapProxy<string, import("..").SerializedFieldType>;
+    /**
+     * The fields on this data item, organized by their label.
+     */
+    readonly fieldsByLabel: MapProxy<string, import("..").SerializedFieldType>;
     /**
      * @returns True if a data item exists in this collection at this primary key
      */

package/data/dataitemproxy.js

@@ -23,6 +23,15 @@ class DataItemProxy {
             'pk': this.primaryKey,
             'f': name,
         }));
+        /**
+         * The fields on this data item, organized by their label.
+         */
+        this.fieldsByLabel = new mapproxy_1.MapProxy(() => this.client.sendCommand("lcf" /* CommandName.ListCollectionFields */, { 'id': this.collection.id, 'l': true }), (name) => this.client.sendCommand("gdif" /* CommandName.GetDataItemField */, {
+            'c': this.collection.id,
+            'pk': this.primaryKey,
+            'f': name,
+            'l': true,
+        }));
     }
     /**
      * @returns True if a data item exists in this collection at this primary key

package/data/fieldconstraintdefinition.d.ts

@@ -40,15 +40,20 @@ export interface MaxLengthConstraintDefinition {
     value: number;
     reason?: string | undefined;
 }
-export type FieldConstraintDefinition = RequiredFieldConstraintDefinition | LockedFieldConstraintDefinition | MinValueFieldConstraintDefinition | MaxValueFieldConstraintDefinition | SingleLineFieldConstraintDefinition | NoWhitespaceFieldConstraintDefinition | UniqueEditFieldConstraintDefinition | MaxLengthConstraintDefinition;
+export interface MaxDecimalPlacesConstraintDefinition {
+    type: FieldConstraintType.MAX_DECIMAL_LENGTH;
+    value: number;
+    reason?: string | undefined;
+}
+export type FieldConstraintDefinition = RequiredFieldConstraintDefinition | LockedFieldConstraintDefinition | MinValueFieldConstraintDefinition | MaxValueFieldConstraintDefinition | SingleLineFieldConstraintDefinition | NoWhitespaceFieldConstraintDefinition | UniqueEditFieldConstraintDefinition | MaxLengthConstraintDefinition | MaxDecimalPlacesConstraintDefinition;
 export declare function createFieldConstraintDefinition(type: FieldConstraintType, value?: number, reason?: string): FieldConstraintDefinition;
-export declare function minMaxFieldConstraintValidator(val: unknown): val is FieldConstraintType.MIN_VALUE | FieldConstraintType.MAX_VALUE | FieldConstraintType.MAX_LENGTH;
+export declare function numericFieldConstraintValidator(val: unknown): val is FieldConstraintType.MIN_VALUE | FieldConstraintType.MAX_VALUE | FieldConstraintType.MAX_LENGTH | FieldConstraintType.MAX_DECIMAL_LENGTH;
 export declare const isFieldConstraintDefinition: (x: unknown) => x is {
     type?: FieldConstraintType | undefined;
 } & {
     type: FieldConstraintType;
 } & (import("..").DestructureGuardedTypeObj<{
-    type: typeof minMaxFieldConstraintValidator;
+    type: typeof numericFieldConstraintValidator;
     value: typeof isNumber;
 }> | import("..").DestructureGuardedTypeObj<{
     type: (x: unknown) => x is FieldConstraintType.REQUIRED | FieldConstraintType.LOCKED | FieldConstraintType.SINGLE_LINE_ONLY | FieldConstraintType.NO_WHITESPACE | FieldConstraintType.UNIQUE_EDIT;

package/data/fieldconstraintdefinition.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeFieldConstraintDefinition = exports.isFieldConstraintDefinition = exports.minMaxFieldConstraintValidator = exports.createFieldConstraintDefinition = void 0;
+exports.serializeFieldConstraintDefinition = exports.isFieldConstraintDefinition = exports.numericFieldConstraintValidator = exports.createFieldConstraintDefinition = void 0;
 const assertnever_1 = require("../core/assertnever");
 const checks_1 = require("../core/checks");
 const serializedfielddefinition_1 = require("../core/data/serializedfield/serializedfielddefinition");
@@ -13,6 +13,7 @@ function createFieldConstraintDefinition(type, value, reason) {
         case serializedfielddefinition_1.FieldConstraintType.MIN_VALUE:
         case serializedfielddefinition_1.FieldConstraintType.MAX_VALUE:
         case serializedfielddefinition_1.FieldConstraintType.MAX_LENGTH:
+        case serializedfielddefinition_1.FieldConstraintType.MAX_DECIMAL_LENGTH:
             if (value === undefined) {
                 throw new Error('Invalid constraint value');
             }
@@ -29,15 +30,19 @@ function createFieldConstraintDefinition(type, value, reason) {
     }
 }
 exports.createFieldConstraintDefinition = createFieldConstraintDefinition;
-function minMaxFieldConstraintValidator(val) {
+function numericFieldConstraintValidator(val) {
     return (val === serializedfielddefinition_1.FieldConstraintType.MIN_VALUE ||
         val === serializedfielddefinition_1.FieldConstraintType.MAX_VALUE ||
-        val === serializedfielddefinition_1.FieldConstraintType.MAX_LENGTH);
+        val === serializedfielddefinition_1.FieldConstraintType.MAX_LENGTH ||
+        val === serializedfielddefinition_1.FieldConstraintType.MAX_DECIMAL_LENGTH);
 }
-exports.minMaxFieldConstraintValidator = minMaxFieldConstraintValidator;
+exports.numericFieldConstraintValidator = numericFieldConstraintValidator;
 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 })));
+}), (0, validators_1.either)((0, validators_1.objectValidator)({ 'type': numericFieldConstraintValidator, 'value': checks_1.isNumber }), (0, validators_1.objectValidator)({
+    'type': (0, validators_1.exclude)(serializedfielddefinition_1.isFieldConstraintType, numericFieldConstraintValidator),
+    'value': checks_1.isUndefined,
+})));
 /** @ignore */
 function serializeFieldConstraintDefinition(constraint) {
     return {

package/document/documentelement/documentelementtype.d.ts

@@ -20,6 +20,6 @@ export declare enum DocumentElementType {
     TrackedFormulaLocation = "TrackedFormulaLocation",
     ElementAlias = "ElementAlias",
     GeneratorCardSyncConfig = "GeneratorCardSyncConfig",
-    ScenarioSet = "ScenarioSet",
+    Scenario = "Scenario",
     PropertyPrecedenceRegistry = "PropertyPrecedenceRegistry"
 }

package/document/documentelement/documentelementtype.js

@@ -32,6 +32,6 @@ var DocumentElementType;
     DocumentElementType["TrackedFormulaLocation"] = "TrackedFormulaLocation";
     DocumentElementType["ElementAlias"] = "ElementAlias";
     DocumentElementType["GeneratorCardSyncConfig"] = "GeneratorCardSyncConfig";
-    DocumentElementType["ScenarioSet"] = "ScenarioSet";
+    DocumentElementType["Scenario"] = "Scenario";
     DocumentElementType["PropertyPrecedenceRegistry"] = "PropertyPrecedenceRegistry";
 })(DocumentElementType || (exports.DocumentElementType = DocumentElementType = {}));

package/package.json

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

package/core/cardintegration/carduseraccessresult.d.ts

@@ -1,18 +0,0 @@
-import { SerializedFieldConstraint } from '../data/serializedfield/serializedfielddefinition';
-/**
- * Defines whether the current user has access to an item.
- */
-export interface CardUserAccessResult {
-    hasPermission: boolean;
-    constraints: {
-        fieldName: string;
-        constraints?: SerializedFieldConstraint[];
-    }[];
-}
-export declare function serializeCardUserAccessResult(result: CardUserAccessResult): {
-    hp: boolean;
-    c: {
-        fn: string;
-        cs: SerializedFieldConstraint[] | undefined;
-    }[];
-};

package/core/cardintegration/carduseraccessresult.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeCardUserAccessResult = void 0;
-function serializeCardUserAccessResult(result) {
-    return {
-        'hp': result.hasPermission,
-        'c': result.constraints.map((c) => ({
-            'fn': c.fieldName,
-            'cs': c.constraints,
-        })),
-    };
-}
-exports.serializeCardUserAccessResult = serializeCardUserAccessResult;