lucid-extension-sdk 0.0.448 → 0.0.449

package/commandtypes.d.ts

@@ -252,8 +252,8 @@ export type CommandArgs = {
         result: CancelDragBlockToCanvasResult;
     };
     [CommandName.CheckUserFlagAssignment]: {
-        query: CheckUserFlagAssignmentQuery;
-        result: CheckUserFlagAssignmentResult;
+        query: CheckUserFeatureFlagAssignmentQuery;
+        result: CheckUserFeatureFlagAssignmentResult;
     };
     [CommandName.Confirm]: {
         query: ConfirmQuery;
@@ -765,6 +765,13 @@ export type AutoSyncSettings = {
     'gsf': string;
     'sqs'?: string | undefined;
     'syqs'?: string | undefined;
+    /** If specified, setup fields that allow user to create query template that auto applies to dynamic tables when created*/
+    'dpf'?: {
+        /** Get search fields action */
+        'gsf': string;
+        /** Generate preset value action */
+        'gpv': string;
+    } | undefined;
 };
 export type SerializedFieldConfiguration = {
     /** Callback to get field definitions for all fields supported by the card integration */
@@ -773,6 +780,8 @@ export type SerializedFieldConfiguration = {
     'osfc'?: string | undefined;
     /** Field name -> callback name tuples for searching for legal field values in an enum */
     'fvsc'?: [string, string][] | undefined;
+    /** Field name -> callback name tuples for some function that should be called before the field value is updated */
+    'fttic'?: [string, string][] | undefined;
     /** Field type -> callback name tuples for searching for legal field values in an enum */
     'ftvsc'?: [string, string][] | undefined;
     /** Default search callback for searching for legal field values in an enum */
@@ -823,6 +832,8 @@ export type AddCardIntegrationQuery = {
         'mmw'?: number | undefined;
         /** Use Isolated Search Bar */
         'uisbui'?: boolean;
+        /** Use Updated Filter UI */
+        'uufui'?: boolean;
         /** Get search fields action */
         'gsf': string;
         /** Search action */
@@ -942,6 +953,15 @@ export type AddCardIntegrationQuery = {
     'cei'?: string | undefined;
     /** getAdditionalPanelTabsForCard -- Cards' additional details via tabs in panel */
     'gaptfc'?: string | undefined;
+    /** Instance switching configuration */
+    'is'?: {
+        /** Get instances action */
+        'gi': string;
+        /** On instance change action */
+        'oic': string;
+        /** Get selected instance ID action */
+        'gsii': string;
+    } | undefined;
 };
 export type AddCardIntegrationResult = undefined;
 export type AddLineTextAreaQuery = {
@@ -2071,9 +2091,9 @@ export type ZOrderQuery = {
     'o': ZOrderOperation;
 };
 export type ZOrderResult = undefined;
-export type CheckUserFlagAssignmentQuery = {
+export type CheckUserFeatureFlagAssignmentQuery = {
     /** The name of the flag that will be checked */
     'f': string;
 };
-export type CheckUserFlagAssignmentResult = boolean;
+export type CheckUserFeatureFlagAssignmentResult = boolean;
 export {};

package/core/cardintegration/cardintegrationautosyncconfig.d.ts

@@ -1,5 +1,6 @@
 import type { SerializedFieldType } from '../data/serializedfield/serializedfields';
 import type { ExtensionCardFieldDefinition, ImportResult, SearchResult } from '../sharedcardintegration/cardintegrationdefinitions';
+import type { DocumentPresetSetupFields } from './lucidcardintegrationpresetsetupmodal';
 /**
  * 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
@@ -39,6 +40,15 @@ export interface CardIntegrationAutoSyncConfig {
      * @returns the ImportResult for the query string.
      */
     syncQueryString?: (queryString: string, otherFields: Map<string, SerializedFieldType>) => Promise<ImportResult | ImportResult[]>;
+    /**
+     * @experimental
+     * Document preset setup configuration for this card integration's auto sync.
+     *
+     * When specified, this enables your card integration to participate in Lucid's document preset
+     * system, which allows users to configure dynamic matrix templates that automatically populate new
+     * documents with cards from your integration.
+     */
+    documentPresetSetupFields?: DocumentPresetSetupFields | undefined;
 }
 export interface AutoSyncConfigPhrasesType {
     /**

package/core/cardintegration/cardintegrationparams.d.ts

@@ -110,4 +110,14 @@ export interface DataItemCallbackParam {
 export interface ImportFromSerializedFieldsCallbackParam {
     'sf': SerializedFields[];
 }
+/** @ignore */
+export interface FieldTypeValueToItemsCallbackParams {
+    'd'?: string | undefined;
+    'v': SerializedFieldType;
+    'f': string;
+}
+/** @ignore */
+export interface GeneratePresetValueParam {
+    'f': [string, SerializedFieldType][];
+}
 export {};

package/core/cardintegration/lucidcardintegration.d.ts

@@ -9,7 +9,7 @@ import { isString } from '../checks';
 import type { SerializedFieldType, SerializedFields } from '../data/serializedfield/serializedfields';
 import type { ImportCardFromDetails } from '../importcardfromdetails/importcardfromdetails';
 import type { ImportCardFromPastedLinkCallback } from '../importcardfrompastedlink/importcardfrompastedlinkcallback';
-import type { DependenciesForItems, ExtensionCardFieldDefinition, ExtensionFieldConfiguration, ImportResult } from '../sharedcardintegration/cardintegrationdefinitions';
+import { DependenciesForItems, ExtensionCardFieldDefinition, ExtensionFieldConfiguration, ImportResult, Instance } from '../sharedcardintegration/cardintegrationdefinitions';
 import type { CardIntegrationAutoSyncConfig } from './cardintegrationautosyncconfig';
 import type { CardIntegrationConfig } from './cardintegrationconfig';
 import type { AdditionalPanelTabsCallback } from './cardpaneltabs/tabs';
@@ -192,4 +192,23 @@ export declare abstract class LucidCardIntegration {
      * via tabs that are configured by the extension and displayed in the card details panel.
      */
     getAdditionalPanelTabsForCard?: AdditionalPanelTabsCallback;
+    /**
+     * Configuration for instance switching. An instance is a singular context for which a user can perform search actions
+     * or import actions in. Switching between instances will reset the state for searching and creating.
+     */
+    instanceSwitching?: {
+        /**
+         * Returns available instances the user can switch between.
+         */
+        getInstances: () => Promise<Instance[]>;
+        /**
+         * Called when the user selects a different instance.
+         * The extension should update its state for subsequent operations.
+         */
+        onInstanceChange: (instance: Instance) => Promise<void>;
+        /**
+         * Returns the currently selected instance ID.
+         */
+        getSelectedInstanceId: () => string | undefined;
+    };
 }

package/core/cardintegration/lucidcardintegrationpresetsetupmodal.d.ts

@@ -0,0 +1,29 @@
+import { SerializedFieldType } from '../data/serializedfield/serializedfields';
+import { type FormatToSerializedType } from '../format/format';
+import { ExtensionCardFieldDefinition } from '../sharedcardintegration/cardintegrationdefinitions';
+declare const ExtensionGeneratorDocumentPresetInputSourceFormatter: import("../format/format").Format<import("../format/objectformat").ObjectFormatSerializedType<{
+    readonly dataConnectorName: readonly ["dcn", import("../format/format").Format<string, string>];
+    readonly instanceId: readonly ["iid", import("../format/format").Format<string, string>];
+    readonly query: readonly ["q", import("../format/format").Format<string, string>];
+}>, {
+    readonly dataConnectorName: string;
+    readonly instanceId: string;
+    readonly query: string;
+}>;
+export interface ExtensionGeneratorDocumentPresetInputSource {
+    dataConnectorName: string;
+    instanceId: string;
+    query: string;
+}
+/** @ignore */
+export type SerializedExtensionGeneratorDocumentPresetInputSource = FormatToSerializedType<typeof ExtensionGeneratorDocumentPresetInputSourceFormatter>;
+export declare const isSerializedExtensionGeneratorDocumentPresetInputSource: typeof ExtensionGeneratorDocumentPresetInputSourceFormatter.validator;
+/** @ignore */
+export declare const serializeExtensionGeneratorDocumentPresetInputSource: typeof ExtensionGeneratorDocumentPresetInputSourceFormatter.toJson;
+/** @ignore */
+export declare const deserializeExtensionGeneratorDocumentPresetInputSource: typeof ExtensionGeneratorDocumentPresetInputSourceFormatter.fromJson;
+export interface DocumentPresetSetupFields {
+    getSearchFields: (searchSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
+    generatePresetValue: (fields: Map<string, SerializedFieldType>) => Promise<ExtensionGeneratorDocumentPresetInputSource>;
+}
+export {};

package/core/cardintegration/lucidcardintegrationpresetsetupmodal.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeExtensionGeneratorDocumentPresetInputSource = exports.serializeExtensionGeneratorDocumentPresetInputSource = exports.isSerializedExtensionGeneratorDocumentPresetInputSource = void 0;
+const objectformat_1 = require("../format/objectformat");
+const primitiveformat_1 = require("../format/primitiveformat");
+const ExtensionGeneratorDocumentPresetInputSourceFormatter = (0, objectformat_1.ObjectFormat)({
+    dataConnectorName: ['dcn', primitiveformat_1.StringFormat],
+    instanceId: ['iid', primitiveformat_1.StringFormat],
+    query: ['q', primitiveformat_1.StringFormat],
+});
+exports.isSerializedExtensionGeneratorDocumentPresetInputSource = ExtensionGeneratorDocumentPresetInputSourceFormatter.validator;
+/** @ignore */
+exports.serializeExtensionGeneratorDocumentPresetInputSource = ExtensionGeneratorDocumentPresetInputSourceFormatter.toJson;
+/** @ignore */
+exports.deserializeExtensionGeneratorDocumentPresetInputSource = ExtensionGeneratorDocumentPresetInputSourceFormatter.fromJson;

package/core/cardintegration/lucidcardintegrationregistry.d.ts

@@ -1,7 +1,7 @@
 import { DataItemProxy } from '../../data/dataitemproxy';
 import { DataSourceProxy } from '../../data/datasourceproxy';
 import { EditorClient } from '../../editorclient';
-import { SerializedFieldType } from '../data/serializedfield/serializedfields';
+import { SerializedFieldType, SerializedFields } from '../data/serializedfield/serializedfields';
 import { ExtensionCardFieldLabelIcons, ExtensionCardFieldOption, ExtensionCardUserData, TagCallback } from '../sharedcardintegration/cardintegrationdefinitions';
 import { LucidCardIntegration } from './lucidcardintegration';
 export declare class LucidCardIntegrationRegistry {
@@ -13,6 +13,7 @@ export declare class LucidCardIntegrationRegistry {
         dataSourceId?: string | undefined;
     }) => Promise<ExtensionCardFieldOption[]>): string;
     static registerUserSearchCallback(client: EditorClient, callback: (searchText: string, inputSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardUserData[]>): string;
+    static registerFieldTypeToCollectionItemsCallback(client: EditorClient, callback: (fieldName: string, value: SerializedFieldType, dataSourceProxy?: DataSourceProxy | undefined) => Promise<[string, SerializedFields][]>): string;
     static registerFieldLabelIconsCallback(client: EditorClient, callback: (dataSourceProxy: DataSourceProxy, dataItemProxy: DataItemProxy) => Promise<ExtensionCardFieldLabelIcons>): string;
     static registerTagCallback(client: EditorClient, callback: TagCallback): string;
     static registerBannerActionCallback(client: EditorClient, callback: (actionId: string) => void): string;

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -46,6 +46,14 @@ class LucidCardIntegrationRegistry {
         });
         return name;
     }
+    static registerFieldTypeToCollectionItemsCallback(client, callback) {
+        const name = LucidCardIntegrationRegistry.nextHookName();
+        client.registerAction(name, async ({ 'd': dataSourceId, 'v': value, 'f': fieldName }) => {
+            const dataSourceProxy = dataSourceId ? new datasourceproxy_1.DataSourceProxy(dataSourceId, client) : undefined;
+            return await callback(fieldName, value, dataSourceProxy);
+        });
+        return name;
+    }
     static registerFieldLabelIconsCallback(client, callback) {
         const name = LucidCardIntegrationRegistry.nextHookName();
         client.registerAction(name, async ({ 'd': dataSourceId, 'c': collectionId, 'p': primaryKey }) => {
@@ -312,6 +320,9 @@ class LucidCardIntegrationRegistry {
                 'fvsc': cardIntegration.fieldConfiguration.fieldValueSearchCallbacks
                     ? [...cardIntegration.fieldConfiguration.fieldValueSearchCallbacks.entries()]
                     : undefined,
+                'fttic': cardIntegration.fieldConfiguration.fieldTypeToItemsCallback
+                    ? [...cardIntegration.fieldConfiguration.fieldTypeToItemsCallback.entries()]
+                    : undefined,
                 'dsc': cardIntegration.fieldConfiguration.defaultSearchCallback,
                 'gfte': getFieldsToEditActionName,
             },
@@ -354,6 +365,9 @@ class LucidCardIntegrationRegistry {
                 if (importModal.useIsolatedSearchBarUI) {
                     serialized['im']['uisbui'] = importModal.useIsolatedSearchBarUI;
                 }
+                if (importModal.useUpdatedFilterUI) {
+                    serialized['im']['uufui'] = importModal.useUpdatedFilterUI;
+                }
                 if (importModal.maxModalWidth !== undefined) {
                     serialized['im']['mmw'] = importModal.maxModalWidth;
                 }
@@ -480,6 +494,25 @@ class LucidCardIntegrationRegistry {
                     return LucidCardIntegrationRegistry.serializeImportResults(result);
                 });
             }
+            if (autoSync.documentPresetSetupFields) {
+                const documentPresetSetupFields = autoSync.documentPresetSetupFields;
+                serialized['as']['dpf'] = {
+                    'gsf': LucidCardIntegrationRegistry.nextHookName(),
+                    'gpv': LucidCardIntegrationRegistry.nextHookName(),
+                };
+                client.registerAction(serialized['as']['dpf']['gsf'], async ({ 's': searchSoFar }) => {
+                    const result = await documentPresetSetupFields.getSearchFields(new Map(searchSoFar));
+                    return (0, cardintegrationdefinitions_1.serializeCardFieldArrayDefinition)(result);
+                });
+                client.registerAction(serialized['as']['dpf']['gpv'], async ({ 'f': fields }) => {
+                    const result = await documentPresetSetupFields.generatePresetValue(new Map(fields));
+                    return {
+                        'dcn': result.dataConnectorName,
+                        'iid': result.instanceId,
+                        'q': result.query,
+                    };
+                });
+            }
         }
         if (cardIntegration.fieldConfiguration.customFieldDisplaySettings) {
             serialized['fc']['cfds'] = {
@@ -527,6 +560,27 @@ class LucidCardIntegrationRegistry {
                 return (0, useritemeditpermissions_1.serializeUserItemEditPermissionsMap)(result);
             });
         }
+        if (cardIntegration.instanceSwitching) {
+            const instanceSwitching = cardIntegration.instanceSwitching;
+            const getInstancesActionName = LucidCardIntegrationRegistry.nextHookName();
+            const onInstanceChangeActionName = LucidCardIntegrationRegistry.nextHookName();
+            const getSelectedInstanceIdActionName = LucidCardIntegrationRegistry.nextHookName();
+            serialized['is'] = {
+                'gi': getInstancesActionName,
+                'oic': onInstanceChangeActionName,
+                'gsii': getSelectedInstanceIdActionName,
+            };
+            client.registerAction(getInstancesActionName, async () => {
+                return (await instanceSwitching.getInstances()).map((instance) => (0, cardintegrationdefinitions_1.serializeInstance)(instance));
+            });
+            client.registerAction(onInstanceChangeActionName, async (params) => {
+                const instance = (0, cardintegrationdefinitions_1.deserializeInstance)(params);
+                await instanceSwitching.onInstanceChange(instance);
+            });
+            client.registerAction(getSelectedInstanceIdActionName, () => {
+                return instanceSwitching.getSelectedInstanceId();
+            });
+        }
         client.sendCommand("aci" /* CommandName.AddCardIntegration */, serialized);
     }
 }

package/core/cardintegration/lucidcardintegrationstandardimportmodal.d.ts

@@ -45,6 +45,7 @@ export interface LucidCardIntegrationStandardImportModal {
      */
     importModalHeading?: string;
     useIsolatedSearchBarUI?: boolean;
+    useUpdatedFilterUI?: boolean;
     maxModalWidth?: ExtensionImportModalWidthBreakpoint;
     getSearchFields: (searchSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
     search: (fields: Map<string, SerializedFieldType>, offset?: number, limit?: number) => Promise<SearchResult | DeprecatedSearchResult | DeprecatedSearchResult[]>;

package/core/checks.d.ts

@@ -81,7 +81,7 @@ export declare function isObject(val: unknown): val is object;
  * @return Whether variable is an object.
  */
 export declare function isObjectUnsafe(val: any): val is {
-    [key: string]: unknown;
+    [key: string | symbol]: unknown;
 };
 /**
  * Returns true for objects, includings arrays and functions.

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

@@ -10,7 +10,8 @@ export declare enum CollectionEnumFieldNames {
     Id = "id",
     Description = "description",
     Color = "color",
-    IconUrl = "iconUrl"
+    IconUrl = "iconUrl",
+    Category = "category"
 }
 export declare const isCollectionEnumFieldNames: (x: unknown) => x is {} extends typeof CollectionEnumFieldNames ? never : CollectionEnumFieldNames;
 export declare class CollectionEnumFieldType {

package/core/data/fieldtypedefinition/collectionenumfieldtype.js

@@ -18,6 +18,7 @@ var CollectionEnumFieldNames;
     CollectionEnumFieldNames["Description"] = "description";
     CollectionEnumFieldNames["Color"] = "color";
     CollectionEnumFieldNames["IconUrl"] = "iconUrl";
+    CollectionEnumFieldNames["Category"] = "category";
 })(CollectionEnumFieldNames || (exports.CollectionEnumFieldNames = CollectionEnumFieldNames = {}));
 exports.isCollectionEnumFieldNames = (0, validators_1.enumValidator)(CollectionEnumFieldNames);
 class CollectionEnumFieldType {

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

@@ -1,6 +1,12 @@
 export declare class DeserializedMapEnumFieldType {
     readonly validEntries: ReadonlyMap<EnumKeyType, DeserializedMapEnumFieldTypeEntry>;
     constructor(validEntries: ReadonlyMap<EnumKeyType, DeserializedMapEnumFieldTypeEntry>);
+    hasId(id: EnumKeyType): boolean;
+    ids(): IterableIterator<EnumKeyType>;
+    getName(id: EnumKeyType): string | undefined;
+    getDescription(id: EnumKeyType): string | undefined;
+    getColor(id: EnumKeyType): string | undefined;
+    getIconUrl(id: EnumKeyType): string | undefined;
     toJSON(): SerializedMapEnumFieldType;
     static fromJSON(val: SerializedMapEnumFieldType): DeserializedMapEnumFieldType;
 }
@@ -14,6 +20,7 @@ export interface DeserializedMapEnumFieldTypeEntry {
     description?: string | null;
     color?: string | null;
     iconUrl?: string | null;
+    category?: string | null;
 }
 export interface SerializedEnumEntry {
     'Id': EnumKeyType;
@@ -21,6 +28,7 @@ export interface SerializedEnumEntry {
     'Description'?: string | undefined | null;
     'Color'?: string | undefined | null;
     'IconUrl'?: string | undefined | null;
+    'Category'?: string | undefined | null;
 }
 export declare function isSerializedEnumEntry(entry: any): entry is SerializedEnumEntry;
 export declare function serializeEnumEntry(id: EnumKeyType, entry: DeserializedMapEnumFieldTypeEntry): SerializedEnumEntry;

package/core/data/fieldtypedefinition/deserializedmapenumfieldtype.js

@@ -12,6 +12,28 @@ class DeserializedMapEnumFieldType {
     constructor(validEntries) {
         this.validEntries = validEntries;
     }
+    hasId(id) {
+        return this.validEntries.has(id);
+    }
+    ids() {
+        return this.validEntries.keys();
+    }
+    getName(id) {
+        var _a, _b;
+        return (_b = (_a = this.validEntries.get(id)) === null || _a === void 0 ? void 0 : _a.name) !== null && _b !== void 0 ? _b : undefined;
+    }
+    getDescription(id) {
+        var _a, _b;
+        return (_b = (_a = this.validEntries.get(id)) === null || _a === void 0 ? void 0 : _a.description) !== null && _b !== void 0 ? _b : undefined;
+    }
+    getColor(id) {
+        var _a, _b;
+        return (_b = (_a = this.validEntries.get(id)) === null || _a === void 0 ? void 0 : _a.color) !== null && _b !== void 0 ? _b : undefined;
+    }
+    getIconUrl(id) {
+        var _a, _b;
+        return (_b = (_a = this.validEntries.get(id)) === null || _a === void 0 ? void 0 : _a.iconUrl) !== null && _b !== void 0 ? _b : undefined;
+    }
     toJSON() {
         return {
             'ValidItems': [...this.validEntries.entries()].map(([key, value]) => serializeEnumEntry(key, value)),
@@ -36,7 +58,8 @@ function isSerializedEnumEntry(entry) {
         (0, validators_1.nullableOption)(checks_1.isString)(entry['Name']) &&
         (0, validators_1.nullableOption)(checks_1.isString)(entry['Description']) &&
         (0, validators_1.nullableOption)(checks_1.isString)(entry['Color']) &&
-        (0, validators_1.nullableOption)(checks_1.isString)(entry['IconUrl']));
+        (0, validators_1.nullableOption)(checks_1.isString)(entry['IconUrl']) &&
+        (0, validators_1.nullableOption)(checks_1.isString)(entry['Category']));
 }
 function serializeEnumEntry(id, entry) {
     return {
@@ -45,6 +68,7 @@ function serializeEnumEntry(id, entry) {
         'Description': entry.description,
         'Color': entry.color,
         'IconUrl': entry.iconUrl,
+        'Category': entry.category,
     };
 }
 function deserializeEnumEntry(entry) {
@@ -55,6 +79,7 @@ function deserializeEnumEntry(entry) {
             description: entry['Description'],
             color: entry['Color'],
             iconUrl: entry['IconUrl'],
+            category: entry['Category'],
         },
     ];
 }

package/core/defer.d.ts

@@ -1,5 +1,5 @@
 export interface DeferredPromise<T> extends Promise<T> {
-    resolve: (p1: T) => any;
+    resolve: (p1: T | PromiseLike<T>) => any;
     reject: (p1?: any) => any;
     promise: Promise<T>;
 }

package/core/format/enumformat.d.ts

@@ -1,3 +1,4 @@
+import { Validator } from '../guards';
 import { Format } from './format';
 /**
  * Generates a Formatter for your enum. Underneath the hood it is just an IdentityFormat.
@@ -13,4 +14,4 @@ export { EnumFormat as enumFormatter };
  * Enum formatter that will map any unknown values to the enum's fallback value.
  * Allows new enum entries to be safely written (but not consumed) to the frontend in one release
  */
-export declare function EnumFormatWithFallback<T extends object>(enumMap: T, fallbackValue: T[keyof T]): Format<T[keyof T], T[keyof T]>;
+export declare function EnumFormatWithFallback<Primitive extends string | number, T extends Record<string, Primitive>>(enumMap: T, fallbackValue: T[keyof T], primitiveValidator: Validator<Primitive>): Format<Primitive, T[keyof T]>;

package/core/format/enumformat.js

@@ -33,8 +33,7 @@ function EnumFormat(enumMap) {
  * Enum formatter that will map any unknown values to the enum's fallback value.
  * Allows new enum entries to be safely written (but not consumed) to the frontend in one release
  */
-function EnumFormatWithFallback(enumMap, fallbackValue) {
-    const validator = ((x) => true);
+function EnumFormatWithFallback(enumMap, fallbackValue, primitiveValidator) {
     const trueValidator = (0, validators_1.enumValidator)(enumMap);
-    return new format_1.Format((x) => (trueValidator(x) ? x : fallbackValue), identity_1.identity, validator, getEnumGenerator(enumMap));
+    return new format_1.Format((x) => (trueValidator(x) ? x : fallbackValue), identity_1.identity, primitiveValidator, getEnumGenerator(enumMap));
 }

package/core/sharedcardintegration/cardintegrationdefinitions.d.ts

@@ -11,6 +11,15 @@ import { isArray, isString } from '../checks';
 import { isSerializedFieldTypeDefinition } from '../data/fieldtypedefinition/fieldtypedefinition';
 import { type SerializedFieldDefinition } from '../data/serializedfield/serializedfielddefinition';
 import { isSerializedFieldType, type SerializedFieldType, type SerializedLucidIconData } from '../data/serializedfield/serializedfields';
+/**
+ * The type of a field option, used to create non-selectable items like section headers or dividers.
+ */
+export declare enum FieldOptionType {
+    /** A section header that groups related options */
+    SectionHeader = "section-header",
+    /** A horizontal rule divider between sections */
+    HorizontalRule = "hr"
+}
 /** For fields with Option or ApiOption type, the label and value for each available option */
 export interface ExtensionCardFieldOption {
     label: string;
@@ -25,6 +34,12 @@ export interface ExtensionCardFieldOption {
      * decoding).
      */
     iconUrlForCollection?: string | undefined;
+    /**
+     * The type of this option. If not specified, the option is a normal selectable item.
+     * Use FieldOptionType.SectionHeader to create a non-selectable section header.
+     * Use FieldOptionType.HorizontalRule to create a divider between sections.
+     */
+    type?: FieldOptionType | undefined;
 }
 export interface ExtensionCardFieldDefinition extends FieldDefinition {
     /** The label to display in the UI */
@@ -115,6 +130,7 @@ export type SerializedCardFieldOption = {
     'v'?: SerializedFieldType;
     'i'?: string | undefined;
     'ic'?: string | undefined;
+    'ty'?: FieldOptionType | undefined;
 };
 /** @ignore */
 export declare function serializeCardFieldOption(option: ExtensionCardFieldOption): SerializedCardFieldOption;
@@ -138,11 +154,13 @@ export declare const isSerializedFieldOption: (subject: unknown) => subject is i
     l: typeof isString;
     v: typeof isSerializedFieldType;
     i: (x: unknown) => x is string | undefined;
+    ty: (x: unknown) => x is FieldOptionType | undefined;
 }>;
 export declare const isSerializedFieldOptions: (p1: unknown) => p1 is import("../guards").DestructureGuardedTypeObj<{
     l: typeof isString;
     v: typeof isSerializedFieldType;
     i: (x: unknown) => x is string | undefined;
+    ty: (x: unknown) => x is FieldOptionType | undefined;
 }>[];
 /** @ignore */
 export declare const isSerializedExtensionCardFieldDefinition: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
@@ -160,6 +178,7 @@ export declare const isSerializedExtensionCardFieldDefinition: (subject: unknown
         l: typeof isString;
         v: typeof isSerializedFieldType;
         i: (x: unknown) => x is string | undefined;
+        ty: (x: unknown) => x is FieldOptionType | undefined;
     }>[]) | undefined;
     s: (x: unknown) => x is string | undefined;
     u: (x: unknown) => x is string[] | undefined;
@@ -196,6 +215,7 @@ export declare const isSerializedExtensionCardFieldsGroup: (subject: unknown) =>
             l: typeof isString;
             v: typeof isSerializedFieldType;
             i: (x: unknown) => x is string | undefined;
+            ty: (x: unknown) => x is FieldOptionType | undefined;
         }>[]) | undefined;
         s: (x: unknown) => x is string | undefined;
         u: (x: unknown) => x is string[] | undefined;
@@ -220,6 +240,7 @@ export declare const isSerializedExtensionCardFieldsGroupArray: (val: unknown) =
             l: typeof isString;
             v: typeof isSerializedFieldType;
             i: (x: unknown) => x is string | undefined;
+            ty: (x: unknown) => x is FieldOptionType | undefined;
         }>[]) | undefined;
         s: (x: unknown) => x is string | undefined;
         u: (x: unknown) => x is string[] | undefined;
@@ -412,6 +433,16 @@ export type ExtensionFieldConfiguration = {
      * be all the current field values on the item being edited.
      */
     fieldValueSearchCallbacks?: Map<string, string>;
+    /**
+     * Specify callbacks that should be called before a field type has a new value set by the user.
+     *
+     * For example, some fields do not contain all of their possible options stored in the collection on the document
+     * (i.e, you have a fieldValueSearchCallback or fieldTypeValueSearchCallback defined for a field). When a user edits
+     * those fields, you might want to add that item to the collection before it actually gets set on the field. If so,
+     * specifiy a callback for that field type here and have it return the items that should be added to the field's
+     * collection
+     */
+    fieldTypeToItemsCallback?: Map<string, string>;
     /**
      * Specify callbacks for searching for legal values for the given field type. It is similar to fieldValueSearchCallbacks.
      *
@@ -493,3 +524,29 @@ export declare function serializeTagCallbackResult(tag: TagCallbackResult): Seri
  * @returns A promise that maps items' primary key to their edit permissions.
  */
 export type AsyncCanEditItemCallback = (items: DataItemCallbackParam[]) => Promise<Map<string, UserItemEditPermissions>>;
+export interface Instance {
+    id: string;
+    name: string;
+}
+export declare const isInstance: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
+    id: typeof isString;
+    name: typeof isString;
+}>;
+export declare const isInstances: (p1: unknown) => p1 is import("../guards").DestructureGuardedTypeObj<{
+    id: typeof isString;
+    name: typeof isString;
+}>[];
+export interface SerializedInstance {
+    'insid': string;
+    'n': string;
+}
+export declare const isSerializedInstance: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
+    insid: typeof isString;
+    n: typeof isString;
+}>;
+export declare const isSerializedInstances: (p1: unknown) => p1 is import("../guards").DestructureGuardedTypeObj<{
+    insid: typeof isString;
+    n: typeof isString;
+}>[];
+export declare function serializeInstance(instance: Instance): SerializedInstance;
+export declare function deserializeInstance(ins: SerializedInstance): Instance;

package/core/sharedcardintegration/cardintegrationdefinitions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSerializedTagCallbackResult = exports.isSerializedPlaceholderImportMetadata = exports.isSearchResult = exports.isImportErrorBanner = exports.isActionButton = exports.ErrorBannerType = exports.BannerType = exports.isSerializedExtensionCardFieldsGroupArray = exports.isSerializedExtensionCardFieldsGroup = exports.isSerializedExtensionCardFieldDefinition = exports.isSerializedFieldOptions = exports.isSerializedFieldOption = exports.isSerializedCardUserDataArray = exports.isSerializedCardUserData = exports.isExtensionCardUserData = void 0;
+exports.isSerializedInstances = exports.isSerializedInstance = exports.isInstances = exports.isInstance = exports.isSerializedTagCallbackResult = exports.isSerializedPlaceholderImportMetadata = exports.isSearchResult = exports.isImportErrorBanner = exports.isActionButton = exports.ErrorBannerType = exports.BannerType = exports.isSerializedExtensionCardFieldsGroupArray = exports.isSerializedExtensionCardFieldsGroup = exports.isSerializedExtensionCardFieldDefinition = exports.isSerializedFieldOptions = exports.isSerializedFieldOption = exports.isSerializedCardUserDataArray = exports.isSerializedCardUserData = exports.isExtensionCardUserData = exports.FieldOptionType = void 0;
 exports.serializeCardUserData = serializeCardUserData;
 exports.deserializeCardUserData = deserializeCardUserData;
 exports.serializeCardFieldOption = serializeCardFieldOption;
@@ -15,6 +15,8 @@ exports.deserializeExtensionCardFieldsGroupArray = deserializeExtensionCardField
 exports.serializePlaceholderImportMetadata = serializePlaceholderImportMetadata;
 exports.deserializePlaceholderImportMetadata = deserializePlaceholderImportMetadata;
 exports.serializeTagCallbackResult = serializeTagCallbackResult;
+exports.serializeInstance = serializeInstance;
+exports.deserializeInstance = deserializeInstance;
 const collectiondefinition_1 = require("../../data/collectiondefinition");
 const schemadefinition_1 = require("../../data/schemadefinition");
 const checks_1 = require("../checks");
@@ -22,6 +24,16 @@ const fieldtypedefinition_1 = require("../data/fieldtypedefinition/fieldtypedefi
 const serializedfielddefinition_1 = require("../data/serializedfield/serializedfielddefinition");
 const serializedfields_1 = require("../data/serializedfield/serializedfields");
 const validators_1 = require("../validators/validators");
+/**
+ * The type of a field option, used to create non-selectable items like section headers or dividers.
+ */
+var FieldOptionType;
+(function (FieldOptionType) {
+    /** A section header that groups related options */
+    FieldOptionType["SectionHeader"] = "section-header";
+    /** A horizontal rule divider between sections */
+    FieldOptionType["HorizontalRule"] = "hr";
+})(FieldOptionType || (exports.FieldOptionType = FieldOptionType = {}));
 exports.isExtensionCardUserData = (0, validators_1.objectValidator)({
     label: checks_1.isString,
     value: serializedfields_1.isSerializedFieldType,
@@ -46,7 +58,7 @@ exports.isSerializedCardUserData = (0, validators_1.objectValidator)({
 exports.isSerializedCardUserDataArray = (0, validators_1.arrayValidator)(exports.isSerializedCardUserData);
 /** @ignore */
 function serializeCardFieldOption(option) {
-    return Object.assign({ 'l': option.label, 'v': option.value, 'i': option.iconUrl }, ((0, checks_1.isDefAndNotNull)(option.iconUrlForCollection) && { 'ic': option.iconUrlForCollection }));
+    return Object.assign(Object.assign({ 'l': option.label, 'v': option.value, 'i': option.iconUrl }, ((0, checks_1.isDefAndNotNull)(option.iconUrlForCollection) && { 'ic': option.iconUrlForCollection })), ((0, checks_1.isDefAndNotNull)(option.type) && { 'ty': option.type }));
 }
 /** @ignore */
 function serializeCardFieldDefinition(field) {
@@ -59,12 +71,13 @@ function serializeCardFieldArrayDefinition(fields) {
 }
 /** @ignore */
 function deserializeFieldOption(option) {
-    return Object.assign({ label: option['l'], value: option['v'], iconUrl: option['i'] }, ((0, checks_1.isDefAndNotNull)(option['ic']) && { iconUrlForCollection: option['ic'] }));
+    return Object.assign(Object.assign({ label: option['l'], value: option['v'], iconUrl: option['i'] }, ((0, checks_1.isDefAndNotNull)(option['ic']) && { iconUrlForCollection: option['ic'] })), ((0, checks_1.isDefAndNotNull)(option['ty']) && { type: option['ty'] }));
 }
 exports.isSerializedFieldOption = (0, validators_1.objectValidator)({
     'l': checks_1.isString,
     'v': serializedfields_1.isSerializedFieldType,
     'i': (0, validators_1.option)(checks_1.isString),
+    'ty': (0, validators_1.option)((0, validators_1.someValue)(FieldOptionType.SectionHeader, FieldOptionType.HorizontalRule)),
 });
 exports.isSerializedFieldOptions = (0, validators_1.arrayValidator)(exports.isSerializedFieldOption);
 /** @ignore */
@@ -181,3 +194,22 @@ function serializeTagCallbackResult(tag) {
         'i': tag === null || tag === void 0 ? void 0 : tag.icon,
     };
 }
+exports.isInstance = (0, validators_1.objectValidator)({
+    id: checks_1.isString,
+    name: checks_1.isString,
+});
+exports.isInstances = (0, validators_1.arrayValidator)(exports.isInstance);
+exports.isSerializedInstance = (0, validators_1.objectValidator)({
+    'insid': checks_1.isString,
+    'n': checks_1.isString,
+});
+exports.isSerializedInstances = (0, validators_1.arrayValidator)(exports.isSerializedInstance);
+function serializeInstance(instance) {
+    return { 'insid': instance.id, 'n': instance.name };
+}
+function deserializeInstance(ins) {
+    return {
+        id: ins['insid'],
+        name: ins['n'],
+    };
+}

package/core/spreadsheetintegration/lucidspreadsheetintegrationregistry.d.ts

@@ -1,5 +1,6 @@
+import { DataSourceProxy } from '../../data/datasourceproxy';
 import { EditorClient } from '../../editorclient';
-import { SerializedFieldType } from '../data/serializedfield/serializedfields';
+import { SerializedFieldType, SerializedFields } from '../data/serializedfield/serializedfields';
 import { ExtensionCardUserData } from '../sharedcardintegration/cardintegrationdefinitions';
 import { LucidSpreadsheetIntegration } from './lucidspreadsheetintegration';
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
@@ -10,6 +11,7 @@ export declare class LucidSpreadsheetIntegrationRegistry {
         name?: string | undefined;
         dataSourceId?: string | undefined;
     }) => Promise<ExtensionCardUserData[]>): string;
+    static registerFieldTypeToCollectionItemsCallback(client: EditorClient, callback: (fieldName: string, value: SerializedFieldType, dataSourceProxy?: DataSourceProxy | undefined) => Promise<[string, SerializedFields][]>): string;
     /**
      * Register a spreadsheet integration.
      */

package/core/spreadsheetintegration/lucidspreadsheetintegrationregistry.js

@@ -21,11 +21,19 @@ class LucidSpreadsheetIntegrationRegistry {
         });
         return name;
     }
+    static registerFieldTypeToCollectionItemsCallback(client, callback) {
+        const name = LucidSpreadsheetIntegrationRegistry.nextHookName();
+        client.registerAction(name, async ({ 'd': dataSourceId, 'v': value, 'f': fieldName }) => {
+            const dataSourceProxy = dataSourceId ? new datasourceproxy_1.DataSourceProxy(dataSourceId, client) : undefined;
+            return await callback(fieldName, value, dataSourceProxy);
+        });
+        return name;
+    }
     /**
      * Register a spreadsheet integration.
      */
     static addSpreadsheetIntegration(client, spreadsheetIntegration) {
-        var _a, _b, _c, _d, _e, _f, _g, _h;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         let configChooserActions;
         const configChooser = spreadsheetIntegration.configChooser;
         if (configChooser instanceof lucidspreadsheetintegration_1.CustomDetailsChooser) {
@@ -93,13 +101,16 @@ class LucidSpreadsheetIntegrationRegistry {
             'gm': getMultipleSheetsForSpreadsheetDetailsActionName,
             'fc': {
                 'gf': getFieldsActionName,
-                'ftvsc': ((_b = spreadsheetIntegration.fieldConfiguration) === null || _b === void 0 ? void 0 : _b.fieldTypeValueSearchCallbacks)
+                'fttic': ((_b = spreadsheetIntegration.fieldConfiguration) === null || _b === void 0 ? void 0 : _b.fieldTypeToItemsCallback)
+                    ? [...spreadsheetIntegration.fieldConfiguration.fieldTypeToItemsCallback.entries()]
+                    : undefined,
+                'ftvsc': ((_c = spreadsheetIntegration.fieldConfiguration) === null || _c === void 0 ? void 0 : _c.fieldTypeValueSearchCallbacks)
                     ? [...spreadsheetIntegration.fieldConfiguration.fieldTypeValueSearchCallbacks.entries()]
                     : undefined,
                 'cfds': {
-                    'd': (_d = (_c = spreadsheetIntegration.fieldConfiguration) === null || _c === void 0 ? void 0 : _c.customFieldDisplaySettings) === null || _d === void 0 ? void 0 : _d.defaultToMultilineText,
-                    'uri': (_f = (_e = spreadsheetIntegration.fieldConfiguration) === null || _e === void 0 ? void 0 : _e.customFieldDisplaySettings) === null || _f === void 0 ? void 0 : _f.useRoundIcons,
-                    'dadr': (_h = (_g = spreadsheetIntegration.fieldConfiguration) === null || _g === void 0 ? void 0 : _g.customFieldDisplaySettings) === null || _h === void 0 ? void 0 : _h.displayMappedDatesAsDateRange,
+                    'd': (_e = (_d = spreadsheetIntegration.fieldConfiguration) === null || _d === void 0 ? void 0 : _d.customFieldDisplaySettings) === null || _e === void 0 ? void 0 : _e.defaultToMultilineText,
+                    'uri': (_g = (_f = spreadsheetIntegration.fieldConfiguration) === null || _f === void 0 ? void 0 : _f.customFieldDisplaySettings) === null || _g === void 0 ? void 0 : _g.useRoundIcons,
+                    'dadr': (_j = (_h = spreadsheetIntegration.fieldConfiguration) === null || _h === void 0 ? void 0 : _h.customFieldDisplaySettings) === null || _j === void 0 ? void 0 : _j.displayMappedDatesAsDateRange,
                 },
             },
         };

package/core/validators/validators.d.ts

@@ -72,7 +72,7 @@ export declare function mapValidator<T>(subValidator: (p1: unknown) => p1 is T):
  * in validation structure.
  */
 export declare function objectValidator<T extends {
-    [key: string]: (p1: unknown) => p1 is unknown;
+    [key: string | symbol]: (p1: unknown) => p1 is unknown;
 }>(validatorStructure: T): (subject: unknown) => subject is DestructureGuardedTypeObj<T>;
 /**
  * This validator functions the same as {@link objectValidator}, with the option of passing in a map

package/core/validators/validators.js

@@ -192,7 +192,12 @@ function objectValidator(validatorStructure) {
             return false;
         }
         else {
-            return Object.entries(validatorStructure).every(([key, validator]) => {
+            const keys = [
+                ...Object.getOwnPropertyNames(validatorStructure),
+                ...Object.getOwnPropertySymbols(validatorStructure),
+            ];
+            return keys.every((key) => {
+                const validator = validatorStructure[key];
                 return validator(subject[key]);
             });
         }

package/data/collectionproxy.js

@@ -59,8 +59,8 @@ class CollectionProxy extends propertystoreproxy_1.PropertyStoreProxy {
      * via this mechanism.
      */
     isHiddenFromDataPanel() {
-        var _a;
-        const isHiddenFromDataPanel = (_a = this.getBranchedFrom()) === null || _a === void 0 ? void 0 : _a.properties.get('IsHiddenFromDataPanel');
+        var _a, _b;
+        const isHiddenFromDataPanel = (_b = (_a = this.getBranchedFrom()) === null || _a === void 0 ? void 0 : _a.properties.get('IsHiddenFromDataPanel')) !== null && _b !== void 0 ? _b : this.properties.get('IsHiddenFromDataPanel');
         return !!isHiddenFromDataPanel;
     }
     /**

package/dataconnector/actions/serializedpatchtypes.d.ts

@@ -4,9 +4,11 @@ import type { GuardToType } from '../../core/guards';
 export declare const patchItemValidator: (subject: unknown) => subject is import("../../core/guards").DestructureGuardedTypeObj<{
     itemsAdded: (x: unknown) => x is Record<string, {
         [key: string]: unknown;
+        [key: symbol]: unknown;
     }>;
     itemsChanged: (x: unknown) => x is Record<string, {
         [key: string]: unknown;
+        [key: symbol]: unknown;
     }>;
     itemsDeleted: (p1: unknown) => p1 is string[];
     itemOrderChanged: (x: unknown) => x is [string, string | null][] | null | undefined;
@@ -45,9 +47,11 @@ export type SerializedSchemaPatch = GuardToType<typeof patchSchemaValidator>;
 export declare const patchValidator: (x: unknown) => x is import("../../core/guards").DestructureGuardedTypeObj<{
     itemsAdded: (x: unknown) => x is Record<string, {
         [key: string]: unknown;
+        [key: symbol]: unknown;
     }>;
     itemsChanged: (x: unknown) => x is Record<string, {
         [key: string]: unknown;
+        [key: symbol]: unknown;
     }>;
     itemsDeleted: (p1: unknown) => p1 is string[];
     itemOrderChanged: (x: unknown) => x is [string, string | null][] | null | undefined;

package/document/blockclasses/customblockproxy.d.ts

@@ -18,9 +18,9 @@ export declare class CustomBlockProxy extends BlockProxy {
     static getCustomBlockClass(client: EditorClient, id: string): CustomBlockProxyConstructor | typeof CustomBlockProxy;
     isFromStencil(library: string, shape: string): boolean;
     getCustomShapeType(): {
-        packageId: import("../..").UnsafeJsonSerializableOrUndefined;
-        library: import("../..").UnsafeJsonSerializableOrUndefined;
-        shape: import("../..").UnsafeJsonSerializableOrUndefined;
+        packageId: unknown;
+        library: unknown;
+        shape: unknown;
     };
     getStencilTextAreaName(stencilTextAreaName: string): string | undefined;
 }

package/editorclient.d.ts

@@ -451,6 +451,6 @@ export declare class EditorClient {
      * Checks the current value of the given feature flag for the current user. This takes into
      * account any local overrides, and can only be used for feature flags (not other forms of AB test).
      */
-    checkUserFlagAssignment(flagName: string): boolean;
+    checkUserFeatureFlagAssignment(flagName: string): boolean;
     constructor();
 }

package/editorclient.js

@@ -739,7 +739,7 @@ class EditorClient {
      * Checks the current value of the given feature flag for the current user. This takes into
      * account any local overrides, and can only be used for feature flags (not other forms of AB test).
      */
-    checkUserFlagAssignment(flagName) {
+    checkUserFeatureFlagAssignment(flagName) {
         return this.sendCommand("cufa" /* CommandName.CheckUserFlagAssignment */, { 'f': flagName });
     }
     constructor() {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-extension-sdk",
-    "version": "0.0.448",
+    "version": "0.0.449",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "index.js",
     "types": "index.d.ts",
@@ -9,8 +9,8 @@
     "declaration": true,
     "devDependencies": {
         "@types/jasmine": "4.0.3",
-        "typedoc": "^0.23.28",
-        "typedoc-plugin-markdown": "^3.17.1",
+        "typedoc": "^0.25.13",
+        "typedoc-plugin-markdown": "^4.0.2",
         "typescript": "5.1.6",
         "prettier": "3.4.1",
         "prettier-plugin-organize-imports": "4.1.0"