lucid-extension-sdk 0.0.438 → 0.0.440

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 */

package/core/cardintegration/cardfielddisplaysettings.d.ts

@@ -39,11 +39,12 @@ export declare enum FieldDisplayType {
      * as a string, e.g. "1/16/2025 - 2/16/2025"
      */
     DateRangeBadge = "DateRangeBadge",
-    /** Given an object containing iconUrl (optional) and name (optional), determine whether
-     * to display as an ImageBadge or InitializedString (or nothing, if neither is present).
+    /**
+     * Displays a user profile badge with avatar and name in the bottom-left of the card. Takes either a name or
+     * an object containing an iconUrl (optional) and name (optional).
      *
-     * Given or string of name or an object containing iconUrl and name, display as
-     * an as a full name or an ImageBadge with full name (if name is present).
+     * If an iconUrl is provided, displays it as an ImageBadge. If a name is provided, displays it as text.
+     * If no iconUrl is provided but a name is, generates an avatar with the name's initials.
      */
     UserProfile = "UserProfile",
     /**
@@ -74,7 +75,12 @@ export declare enum OnClickHandlerKeys {
     /**
      * Display a custom UI panel to edit non-standard fields on the data associated with the card
      */
-    CustomEditAction = "CustomEditAction"
+    CustomEditAction = "CustomEditAction",
+    /**
+     * Display a panel on the canvas when a stencil is clicked, showing editable input fields for the values that
+     * calculate what is shown on the stencil
+     */
+    EditFieldsStencilPanel = "EditFieldsStencilPanel"
 }
 export declare const isOnClickHandlerKey: (x: unknown) => x is OnClickHandlerKeys;
 export type ImageBadgeSettings = {
@@ -221,7 +227,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

@@ -44,11 +44,12 @@ var FieldDisplayType;
      * as a string, e.g. "1/16/2025 - 2/16/2025"
      */
     FieldDisplayType["DateRangeBadge"] = "DateRangeBadge";
-    /** Given an object containing iconUrl (optional) and name (optional), determine whether
-     * to display as an ImageBadge or InitializedString (or nothing, if neither is present).
+    /**
+     * Displays a user profile badge with avatar and name in the bottom-left of the card. Takes either a name or
+     * an object containing an iconUrl (optional) and name (optional).
      *
-     * Given or string of name or an object containing iconUrl and name, display as
-     * an as a full name or an ImageBadge with full name (if name is present).
+     * If an iconUrl is provided, displays it as an ImageBadge. If a name is provided, displays it as text.
+     * If no iconUrl is provided but a name is, generates an avatar with the name's initials.
      */
     FieldDisplayType["UserProfile"] = "UserProfile";
     /**
@@ -81,6 +82,11 @@ var OnClickHandlerKeys;
      * Display a custom UI panel to edit non-standard fields on the data associated with the card
      */
     OnClickHandlerKeys["CustomEditAction"] = "CustomEditAction";
+    /**
+     * Display a panel on the canvas when a stencil is clicked, showing editable input fields for the values that
+     * calculate what is shown on the stencil
+     */
+    OnClickHandlerKeys["EditFieldsStencilPanel"] = "EditFieldsStencilPanel";
 })(OnClickHandlerKeys || (exports.OnClickHandlerKeys = OnClickHandlerKeys = {}));
 exports.isOnClickHandlerKey = (0, validators_1.enumValidator)(OnClickHandlerKeys);
 const isImageBadgeSettings = (0, validators_1.objectValidator)({
@@ -189,10 +195,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

@@ -12,9 +12,13 @@ export declare const AutoSyncPaginationSize = 50;
  */
 export interface CardIntegrationAutoSyncConfig {
     /**
-     * The header to display for the integration in the autosync modal.
+     * @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
@@ -36,3 +40,33 @@ export interface CardIntegrationAutoSyncConfig {
      */
     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,9 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AutoSyncPaginationSize = void 0;
+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 | 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][];

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -9,6 +9,7 @@ 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 lucidcardintegrationcustomimportmodal_1 = require("./lucidcardintegrationcustomimportmodal");
 const useritemeditpermissions_1 = require("./useritemeditpermissions");
@@ -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) {

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/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

@@ -55,6 +55,27 @@ export interface ExtensionCardFieldDefinition extends FieldDefinition {
      */
     truncatedLabel?: string | undefined;
 }
+/**
+ * @experimental
+ *
+ * Pairs an array of field definitions with a label and potentially other supplementary data if needed.
+ *
+ * An example use case for this would be a chunk of related fields in an edit panel, with the label used as the chunk's
+ * heading.
+ */
+export interface ExtensionCardFieldsGroup {
+    label: string;
+    fieldDefinitions: ExtensionCardFieldDefinition[];
+}
+/** @ignore */
+export type SerializedExtensionCardFieldsGroup = {
+    'l': string | undefined;
+    'fd': SerializedExtensionCardFieldDefinition[];
+};
+/** @ignore */
+export declare function serializeExtensionCardFieldsGroup(group: ExtensionCardFieldsGroup): SerializedExtensionCardFieldsGroup;
+/** @ignore */
+export declare function serializeExtensionCardFieldsGroupArray(groups: ExtensionCardFieldsGroup[]): SerializedExtensionCardFieldsGroup[];
 export type ExtensionCardUserData = ExtensionCardFieldOption & {
     email: string | undefined;
 };
@@ -273,6 +294,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/core/sharedcardintegration/cardintegrationdefinitions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.serializeTagCallbackResult = exports.isSerializedTagCallbackResult = exports.deserializePlaceholderImportMetadata = exports.serializePlaceholderImportMetadata = exports.isSerializedPlaceholderImportMetadata = exports.isSearchResult = exports.deserializeCardFieldArrayDefinition = exports.deserializeCardFieldDefinition = exports.isSerializedExtensionCardFieldDefinition = exports.isSerializedFieldOptions = exports.isSerializedFieldOption = exports.deserializeFieldOption = exports.serializeCardFieldArrayDefinition = exports.serializeCardFieldDefinition = exports.serializeCardFieldOption = exports.isSerializedCardUserDataArray = exports.isSerializedCardUserData = exports.deserializeCardUserData = exports.serializeCardUserData = void 0;
+exports.serializeTagCallbackResult = exports.isSerializedTagCallbackResult = exports.deserializePlaceholderImportMetadata = exports.serializePlaceholderImportMetadata = exports.isSerializedPlaceholderImportMetadata = exports.isSearchResult = exports.deserializeCardFieldArrayDefinition = exports.deserializeCardFieldDefinition = exports.isSerializedExtensionCardFieldDefinition = exports.isSerializedFieldOptions = exports.isSerializedFieldOption = exports.deserializeFieldOption = exports.serializeCardFieldArrayDefinition = exports.serializeCardFieldDefinition = exports.serializeCardFieldOption = exports.isSerializedCardUserDataArray = exports.isSerializedCardUserData = exports.deserializeCardUserData = exports.serializeCardUserData = exports.serializeExtensionCardFieldsGroupArray = exports.serializeExtensionCardFieldsGroup = void 0;
 const collectiondefinition_1 = require("../../data/collectiondefinition");
 const schemadefinition_1 = require("../../data/schemadefinition");
 const checks_1 = require("../checks");
@@ -9,6 +9,19 @@ const serializedfielddefinition_1 = require("../data/serializedfield/serializedf
 const serializedfields_1 = require("../data/serializedfield/serializedfields");
 const validators_1 = require("../validators/validators");
 /** @ignore */
+function serializeExtensionCardFieldsGroup(group) {
+    return {
+        'l': group.label,
+        'fd': serializeCardFieldArrayDefinition(group.fieldDefinitions),
+    };
+}
+exports.serializeExtensionCardFieldsGroup = serializeExtensionCardFieldsGroup;
+/** @ignore */
+function serializeExtensionCardFieldsGroupArray(groups) {
+    return groups.map(serializeExtensionCardFieldsGroup);
+}
+exports.serializeExtensionCardFieldsGroupArray = serializeExtensionCardFieldsGroupArray;
+/** @ignore */
 function serializeCardUserData(userData) {
     return Object.assign({ 'e': userData.email }, serializeCardFieldOption(userData));
 }

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.438",
+    "version": "0.0.440",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "index.js",
     "types": "index.d.ts",