lucid-extension-sdk 0.0.388 → 0.0.390

package/commandtypes.d.ts

@@ -735,6 +735,18 @@ export type AddCardsActions = {
     /** Create card action */
     'cc': string;
 };
+export type SerializedFieldConfiguration = {
+    /** Callback to get field definitions for all fields supported by the card integration */
+    'gf': string;
+    /** Callback to handle a change in the fields the user want to be displayed */
+    'osfc'?: string | undefined;
+    /** Field name -> callback name tuples for searching for legal field values in an enum */
+    'fvsc'?: [string, string][] | undefined;
+    /** Default search callback for searching for legal field values in an enum */
+    'dsc'?: string | undefined;
+    /** Custom field display settings */
+    'cfds'?: SerializedCustomFieldDisplaySettings;
+};
 export type AddCardIntegrationQuery = {
     /** Title/name */
     'n': string;
@@ -744,23 +756,14 @@ export type AddCardIntegrationQuery = {
     'il': string;
     /** Items label */
     'isl': string;
+    /** Item collection label */
+    'icl': string;
     /** Icon url. Replaced by iconConfiguration.primaryIconUrl */
     'u': string;
     /** Text style */
     'ts'?: Partial<TextStyle> | undefined;
     /** Field configuration */
-    'fc': {
-        /** Callback to get field definitions for all fields supported by the card integration */
-        'gf': string;
-        /** Callback to handle a change in the fields the user want to be displayed */
-        'osfc'?: string | undefined;
-        /** Field name -> callback name tuples for searching for legal field values in an enum */
-        'fvsc'?: [string, string][] | undefined;
-        /** Default search callback for searching for legal field values in an enum */
-        'dsc'?: string | undefined;
-        /** Custom field display settings */
-        'cfds'?: SerializedCustomFieldDisplaySettings;
-    };
+    'fc': SerializedFieldConfiguration;
     /** If we can only search for user by their name (and not email) in the card integration. */
     'subn'?: boolean | undefined;
     /** Callback to search for a user in the card integration */
@@ -1191,6 +1194,12 @@ export type CreateUserImageResult = Promise<RawCreateUserImageResult>;
 export type SerializedCustomFieldDisplaySettings = {
     /** Default to multiline text */
     'd'?: boolean | undefined;
+    /** allowMultiSelectEnums */
+    'amse'?: boolean | undefined;
+    /** useRoundIcons */
+    'uri'?: boolean | undefined;
+    /** displayMappedDatesAsDateRange */
+    'dadr'?: boolean | undefined;
 };
 export type DataActionQuery = {
     /** Flow Name */

package/core/cardintegration/lucidcardintegration.d.ts

@@ -4,7 +4,7 @@ import { TextStyle } from '../../document/text/textstyle';
 import { EditorClient } from '../../editorclient';
 import { isString } from '../checks';
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
-import { CustomFieldDisplaySettings, DependenciesForItems, ExtensionCardFieldDefinition, ImportResult } from '../sharedcardintegration/cardintegrationdefinitions';
+import { DependenciesForItems, ExtensionCardFieldDefinition, ExtensionFieldConfiguration, ImportResult } from '../sharedcardintegration/cardintegrationdefinitions';
 import { CardIntegrationConfig } from './cardintegrationconfig';
 import { DependencyMappingPhrasesType } from './dependencymappingphrases';
 import { LucidCardIntegrationCustomImportModal } from './lucidcardintegrationcustomimportmodal';
@@ -35,6 +35,11 @@ export declare abstract class LucidCardIntegration {
      * Label used to identify multiple cards worth of data, e.g. "Jira tasks"
      */
     abstract itemsLabel: string;
+    /**
+     * Label used to identify a collection of cards worth of data ("project" is the default if you don't
+     * override and provide a different label)
+     */
+    readonly itemCollectionLabel: string;
     /**
      * @deprecated Use iconConfiguration.primaryIconUrl.
      * URL for an icon to display in toolbars, etc. Should be at least 24x24.
@@ -50,37 +55,7 @@ export declare abstract class LucidCardIntegration {
      * individual fields that should have different styles.
      */
     textStyle?: Partial<TextStyle>;
-    abstract fieldConfiguration: {
-        /**
-         * Callback to provide a list of all supported field names for the card integration.
-         */
-        getAllFields: (dataSource: DataSourceProxy) => Promise<string[] | FieldDescriptor[]>;
-        /**
-         * 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[]) => Promise<void>;
-        /**
-         * Specify callbacks for searching for legal values for the given fields.
-         *
-         * For example, a Task collection may have an Assignee field that references a User collection,
-         * but you don't import all the users in the entire source data set. Here, you can provide a way
-         * to search for legal values for the Assignee field, similar to the `ExtensionCardFieldDefinition.search`
-         * functionality.
-         *
-         * Register a search callback using LucidCardIntegrationRegistry.registerFieldSearchCallback, then set
-         * the returned string as a value in this Map. The `inputSoFar` parameter passed to the callback will
-         * be all the current field values on the item being edited.
-         */
-        fieldValueSearchCallbacks?: Map<string, string>;
-        /**
-         * Optional callback that's used when a field name may not map to any field defined in fieldValueSearchCallbacks.
-         * Useful for when you don't know the field name ahead of time (e.g. a dynamically generated field name).
-         */
-        defaultSearchCallback?: string;
-        /** Optional properties to configure how fields are displayed */
-        customFieldDisplaySettings?: CustomFieldDisplaySettings;
-    };
+    abstract fieldConfiguration: ExtensionFieldConfiguration;
     iconConfiguration?: {
         /**
          * URL for the primary icon to display in most components, usually on a white background.

package/core/cardintegration/lucidcardintegration.js

@@ -11,6 +11,11 @@ exports.isFieldDescriptor = (0, validators_1.objectValidator)({
 class LucidCardIntegration {
     constructor(client) {
         this.client = client;
+        /**
+         * Label used to identify a collection of cards worth of data ("project" is the default if you don't
+         * override and provide a different label)
+         */
+        this.itemCollectionLabel = 'project';
     }
     showCardImport(name) {
         return this.client.sendCommand("ic" /* CommandName.ImportCards */, name);

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -156,6 +156,7 @@ class LucidCardIntegrationRegistry {
      * Register a card integration.
      */
     static addCardIntegration(client, cardIntegration) {
+        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);
@@ -186,6 +187,7 @@ class LucidCardIntegrationRegistry {
             'dcn': cardIntegration.dataConnectorName,
             'il': cardIntegration.itemLabel,
             'isl': cardIntegration.itemsLabel,
+            'icl': cardIntegration.itemCollectionLabel,
             'u': cardIntegration.iconUrl,
             'ts': cardIntegration.textStyle,
             'fc': {
@@ -290,6 +292,9 @@ class LucidCardIntegrationRegistry {
         if (cardIntegration.fieldConfiguration.customFieldDisplaySettings) {
             serialized['fc']['cfds'] = {
                 'd': cardIntegration.fieldConfiguration.customFieldDisplaySettings.defaultToMultilineText,
+                'amse': (_b = (_a = cardIntegration.fieldConfiguration) === null || _a === void 0 ? void 0 : _a.customFieldDisplaySettings) === null || _b === void 0 ? void 0 : _b.allowMultiSelectEnums,
+                '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,
             };
         }
         this.registerDependencyMapping(client, cardIntegration, serialized);

package/core/sharedcardintegration/cardintegrationdefinitions.d.ts

@@ -1,7 +1,9 @@
 import { CollectionDefinition } from '../../data/collectiondefinition';
 import { CollectionProxy } from '../../data/collectionproxy';
 import { DataItemProxy } from '../../data/dataitemproxy';
+import { DataSourceProxy } from '../../data/datasourceproxy';
 import { FieldDefinition } from '../../data/schemadefinition';
+import { FieldDescriptor } from '../cardintegration/lucidcardintegration';
 import { isString } from '../checks';
 import { isSerializedFieldTypeDefinition } from '../data/fieldtypedefinition/fieldtypedefinition';
 import { SerializedFieldDefinition } from '../data/serializedfield/serializedfielddefinition';
@@ -157,5 +159,47 @@ export interface CustomFieldDisplaySettings {
      * If you would like certain fields to be shown as single line text, you can add the
      * `FieldConstraintType.SINGLE_LINE_ONLY` constraint to the necessary fields.
      * */
-    defaultToMultilineText: boolean;
+    defaultToMultilineText?: boolean;
+    /** Whether multi-select dropdown fields are allowed.
+     * If false, all enum fields are coerced to single-select regardless of their type.
+     */
+    allowMultiSelectEnums?: boolean;
+    /** Whether to default to using round icons in dropdowns in both the edit details panel and basic edit panel */
+    useRoundIcons?: boolean;
+    /**
+     * When this is true and a user has setup their mappings for LucidFields.Time and LucidFields.EndTime, the dates
+     * will be combined into a single date field in the edit panel.
+     */
+    displayMappedDatesAsDateRange?: boolean;
 }
+export type ExtensionFieldConfiguration = {
+    /**
+     * Callback to provide a list of all supported field names for the card integration.
+     */
+    getAllFields: (dataSource: DataSourceProxy) => Promise<string[] | FieldDescriptor[]>;
+    /**
+     * 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[]) => Promise<void>;
+    /**
+     * Specify callbacks for searching for legal values for the given fields.
+     *
+     * For example, a Task collection may have an Assignee field that references a User collection,
+     * but you don't import all the users in the entire source data set. Here, you can provide a way
+     * to search for legal values for the Assignee field, similar to the `ExtensionCardFieldDefinition.search`
+     * functionality.
+     *
+     * Register a search callback using LucidCardIntegrationRegistry.registerFieldSearchCallback, then set
+     * the returned string as a value in this Map. The `inputSoFar` parameter passed to the callback will
+     * be all the current field values on the item being edited.
+     */
+    fieldValueSearchCallbacks?: Map<string, string>;
+    /**
+     * Optional callback that's used when a field name may not map to any field defined in fieldValueSearchCallbacks.
+     * Useful for when you don't know the field name ahead of time (e.g. a dynamically generated field name).
+     */
+    defaultSearchCallback?: string;
+    /** Optional properties to configure how fields are displayed */
+    customFieldDisplaySettings?: CustomFieldDisplaySettings;
+};

package/package.json

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