lucid-extension-sdk 1.1.2 → 1.1.3

package/commandtypes.d.ts

@@ -858,13 +858,11 @@ export type AutoSyncSettings = {
     'gsf': string;
     'sqs'?: string | undefined;
     'syqs'?: string | undefined;
-    /** getDefaultFilterFields action ID - field-only config */
-    'gdf'?: string | undefined;
     /** searchFields action ID - field-only config */
     'sf'?: string | undefined;
     /** syncFields action ID - field-only config */
     'syf'?: string | undefined;
-    /** If specified, setup fields that allow user to create query template that auto applies to dynamic tables when created*/
+    /** 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;
@@ -872,8 +870,10 @@ export type AutoSyncSettings = {
         'gpv': string;
     } | undefined;
     'cftqs'?: string | undefined;
-    /** Get default filter fields action */
+    /** Get default filter fields action. Used in both field-only and query-string configurations. */
     'gdff'?: string | undefined;
+    /** Get more filter fields action. Used in both field-only and query-string configurations. */
+    'gmff'?: string | undefined;
 };
 export type SerializedFieldConfiguration = {
     /** Callback to get field definitions for all fields supported by the card integration */
@@ -1137,6 +1137,8 @@ export type AddSpreadsheetIntegrationQuery = {
         [K in keyof SerializedFieldConfiguration]?: SerializedFieldConfiguration[K] | undefined;
     } | undefined;
     'dm'?: DependencyMappingSettings | undefined;
+    /** Auto-sync configuration (only honored when `c` / addCardsIntegration is true) */
+    'as'?: AutoSyncSettings | undefined;
 };
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export type AddSpreadsheetIntegrationResult = undefined;

package/core/cardintegration/cardintegrationautosyncconfig.d.ts

@@ -74,9 +74,17 @@ export interface QueryStringCardIntegrationAutoSyncConfig extends BaseCardIntegr
      * type a raw query string.
      *
      * @param searchSoFar The fields the user has populated so far (e.g. the selected data source id)
-     * @returns The filter fields to render
+     * @returns The filter fields to always render
      */
     getDefaultFilterFields?: (searchSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
+    /**
+     * Provides the additional filter fields a user can pin from the "More filters" picker.
+     * Implementations **MUST exclude** any field already returned by {@link getDefaultFilterFields}.
+     *
+     * @param searchSoFar The fields the user has populated so far (e.g. the selected data source id)
+     * @returns The additional filter fields, excluding default fields
+     */
+    getMoreFilterFields?: (searchSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
 }
 /**
  * @experimental
@@ -88,10 +96,20 @@ export interface FieldOnlyCardIntegrationAutoSyncConfig extends BaseCardIntegrat
      * Returns the filter field definitions available for the user to configure. Called whenever the
      * current field selections change, allowing fields to be dynamically updated based on prior selections.
      *
+     * Keep this callback fast — it is called eagerly whenever the filter form is shown.
+     *
      * @param searchSoFar The filter field values selected so far
-     * @returns the field definitions to display for filtering
+     * @returns the field definitions to display for filtering by default
      */
     getDefaultFilterFields: (searchSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
+    /**
+     * Provides the additional filter fields a user can pin from the "More filters" picker.
+     * Implementations **MUST exclude** any field already returned by {@link getDefaultFilterFields}.
+     *
+     * @param searchSoFar The filter field values selected so far
+     * @returns The additional filter fields, excluding default fields
+     */
+    getMoreFilterFields?: (searchSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
     /**
      * Perform a search using the selected filter field values. This should support pagination
      * (See {@link AutoSyncPaginationSize}).

package/core/cardintegration/cardintegrationparams.d.ts

@@ -56,6 +56,10 @@ export interface GetDefaultFilterFieldsParam {
     's': [string, SerializedFieldType][];
 }
 /** @ignore */
+export interface GetMoreFilterFieldsParam {
+    's': [string, SerializedFieldType][];
+}
+/** @ignore */
 export interface QuerySyncRemoveNonMatchingLabelParam {
     'g': string;
 }

package/core/cardintegration/lucidcardintegrationregistry.d.ts

@@ -18,11 +18,6 @@ export declare class LucidCardIntegrationRegistry {
     static registerTagCallback(client: EditorClient, callback: TagCallback): string;
     static registerBannerActionCallback(client: EditorClient, callback: (actionId: string) => void): string;
     private static registerDependencyMapping;
-    private static serializeSearchResult;
-    /**
-     * Helper to serialize import results (single or array) to the expected format.
-     */
-    private static serializeImportResults;
     private static registerImportCardFromPastedLinkHandler;
     /**
      * Register a card integration.

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -2,7 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LucidCardIntegrationRegistry = void 0;
 const commandtypes_1 = require("../../commandtypes");
-const collectiondefinition_1 = require("../../data/collectiondefinition");
 const collectionproxy_1 = require("../../data/collectionproxy");
 const dataitemproxy_1 = require("../../data/dataitemproxy");
 const datasourceproxy_1 = require("../../data/datasourceproxy");
@@ -11,7 +10,6 @@ const checks_1 = require("../checks");
 const importcardfromdetails_1 = require("../importcardfromdetails/importcardfromdetails");
 const cardintegrationdefinitions_1 = require("../sharedcardintegration/cardintegrationdefinitions");
 const sharedregistryutil_1 = require("../sharedcardintegration/sharedregistryutil");
-const cardintegrationautosyncconfig_1 = require("./cardintegrationautosyncconfig");
 const cardintegrationconfig_1 = require("./cardintegrationconfig");
 const tabs_1 = require("./cardpaneltabs/tabs");
 const extensiondatapanellistitem_1 = require("./extensiondatapanel/extensiondatapanellistitem");
@@ -99,50 +97,6 @@ class LucidCardIntegrationRegistry {
     static registerDependencyMapping(client, cardIntegration, serialized) {
         return (0, sharedregistryutil_1.registerDependencyMapping)(client, cardIntegration, serialized, () => LucidCardIntegrationRegistry.nextHookName());
     }
-    static serializeSearchResult(searchResult) {
-        var _a;
-        return {
-            'srs': searchResult.searchResults.map((resultPerCollection) => ({
-                'd': (0, collectiondefinition_1.serializeCollectionDefinition)(resultPerCollection.data),
-                'f': (0, cardintegrationdefinitions_1.serializeCardFieldArrayDefinition)(resultPerCollection.fields),
-                'm': resultPerCollection.partialImportMetadata && {
-                    'cid': resultPerCollection.partialImportMetadata.collectionId,
-                    'sid': resultPerCollection.partialImportMetadata.syncDataSourceId,
-                },
-            })),
-            'ipsr': searchResult.itemsPerSearchResult,
-            'e': searchResult.error,
-            'bs': (_a = searchResult.banners) === null || _a === void 0 ? void 0 : _a.map((banner) => ({
-                'ty': banner.type,
-                'msg': banner.message,
-                'btyp': banner.bannerType,
-                'actbtn': banner.actionButton
-                    ? {
-                        'lab': banner.actionButton.label,
-                        'aid': banner.actionButton.actionId,
-                        'href': banner.actionButton.href,
-                    }
-                    : undefined,
-            })),
-        };
-    }
-    /**
-     * Helper to serialize import results (single or array) to the expected format.
-     */
-    static serializeImportResults(result) {
-        if ((0, checks_1.isArray)(result)) {
-            return result.map((importResult) => {
-                return {
-                    'c': importResult.collection.id,
-                    'pks': importResult.primaryKeys,
-                };
-            });
-        }
-        return {
-            'c': result.collection.id,
-            'pks': result.primaryKeys,
-        };
-    }
     static registerImportCardFromPastedLinkHandler(client, cardIntegration, serialized) {
         if (!cardIntegration.importCardFromPastedLink) {
             return;
@@ -175,7 +129,7 @@ class LucidCardIntegrationRegistry {
      * Register a card integration.
      */
     static addCardIntegration(client, cardIntegration) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d;
         const getFieldsActionName = LucidCardIntegrationRegistry.nextHookName();
         client.registerAction(getFieldsActionName, async (param) => {
             const dataSource = new datasourceproxy_1.DataSourceProxy(param['d'], client);
@@ -282,32 +236,21 @@ class LucidCardIntegrationRegistry {
                     const result = await importModal.search(new Map(param), offset, limit);
                     if (!(0, cardintegrationdefinitions_1.isSearchResult)(result)) {
                         if ((0, checks_1.isArray)(result)) {
-                            return this.serializeSearchResult({
+                            return (0, sharedregistryutil_1.serializeSearchResult)({
                                 searchResults: result,
                             });
                         }
                         else {
-                            return this.serializeSearchResult({
+                            return (0, sharedregistryutil_1.serializeSearchResult)({
                                 searchResults: [result],
                             });
                         }
                     }
-                    return this.serializeSearchResult(result);
+                    return (0, sharedregistryutil_1.serializeSearchResult)(result);
                 });
                 client.registerAction(serialized['im']['i'], async ({ 'pks': primaryKeys, 's': searchFields }) => {
                     const result = await importModal.import(primaryKeys, new Map(searchFields));
-                    if ((0, checks_1.isArray)(result)) {
-                        return result.map((importResult) => {
-                            return {
-                                'c': importResult.collection.id,
-                                'pks': importResult.primaryKeys,
-                            };
-                        });
-                    }
-                    return {
-                        'c': result.collection.id,
-                        'pks': result.primaryKeys,
-                    };
+                    return (0, sharedregistryutil_1.serializeImportResults)(result);
                 });
                 if (serialized['im']['os']) {
                     client.registerAction(serialized['im']['os'], async () => {
@@ -336,146 +279,13 @@ class LucidCardIntegrationRegistry {
             });
         }
         if (cardIntegration.autoSync) {
-            const autoSync = cardIntegration.autoSync;
-            serialized['as'] = {
-                'gsf': LucidCardIntegrationRegistry.nextHookName(),
-            };
-            if (autoSync.phrases) {
-                serialized['as']['p'] = {
-                    'h': autoSync.phrases.header,
-                    'l': autoSync.phrases.label,
-                    'qph': autoSync.phrases.queryPlaceholder,
-                    'rnml': LucidCardIntegrationRegistry.nextHookName(),
-                    'nml': autoSync.phrases.noMatchedLabel,
-                    'esl': autoSync.phrases.emptyStateLabel,
-                };
-                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);
-            });
-            if ('searchFields' in autoSync) {
-                const fieldOnlyAutoSync = autoSync;
-                serialized['as']['gdf'] = LucidCardIntegrationRegistry.nextHookName();
-                client.registerAction(serialized['as']['gdf'], async ({ 'i': inputSoFar }) => {
-                    const result = await fieldOnlyAutoSync.getDefaultFilterFields(new Map(inputSoFar));
-                    return (0, cardintegrationdefinitions_1.serializeCardFieldArrayDefinition)(result);
-                });
-                serialized['as']['sf'] = LucidCardIntegrationRegistry.nextHookName();
-                client.registerAction(serialized['as']['sf'], async ({ 'f': fields, 'if': instanceFields, 'pn': pageNumber, 'npt': nextPageToken, }) => {
-                    const result = await fieldOnlyAutoSync.searchFields(new Map(fields), new Map(instanceFields), pageNumber, nextPageToken);
-                    if (result) {
-                        return this.serializeSearchResult(result);
-                    }
-                    else {
-                        return this.serializeSearchResult({
-                            searchResults: [],
-                            error: 'Unknown Error Occurred',
-                        });
-                    }
-                });
-                serialized['as']['syf'] = LucidCardIntegrationRegistry.nextHookName();
-                client.registerAction(serialized['as']['syf'], async ({ 'f': fields, 'if': instanceFields }) => {
-                    var _a;
-                    const result = (_a = (await fieldOnlyAutoSync.syncFields(new Map(fields), new Map(instanceFields)))) !== null && _a !== void 0 ? _a : [];
-                    return LucidCardIntegrationRegistry.serializeImportResults(result);
-                });
-            }
-            else {
-                const queryStringAutoSync = autoSync;
-                if (queryStringAutoSync.searchQueryString) {
-                    serialized['as']['sqs'] = LucidCardIntegrationRegistry.nextHookName();
-                    client.registerAction(serialized['as']['sqs'], async ({ 'qs': queryString, 'of': otherFields, 'pn': pageNumber, 'npt': nextPageToken, }) => {
-                        var _a;
-                        const result = await ((_a = queryStringAutoSync.searchQueryString) === null || _a === void 0 ? void 0 : _a.call(queryStringAutoSync, queryString, new Map(otherFields), pageNumber, nextPageToken));
-                        if (result) {
-                            return this.serializeSearchResult(result);
-                        }
-                        else {
-                            return this.serializeSearchResult({
-                                searchResults: [],
-                                error: 'Unknown Error Occurred',
-                            });
-                        }
-                    });
-                }
-                if (queryStringAutoSync.syncQueryString) {
-                    serialized['as']['syqs'] = LucidCardIntegrationRegistry.nextHookName();
-                    client.registerAction(serialized['as']['syqs'], async ({ 'qs': queryString, 'of': otherFields }) => {
-                        var _a, _b;
-                        const result = (_b = (await ((_a = queryStringAutoSync.syncQueryString) === null || _a === void 0 ? void 0 : _a.call(queryStringAutoSync, queryString, new Map(otherFields))))) !== null && _b !== void 0 ? _b : [];
-                        return LucidCardIntegrationRegistry.serializeImportResults(result);
-                    });
-                }
-                if (queryStringAutoSync.convertFiltersToQueryString) {
-                    serialized['as']['cftqs'] = LucidCardIntegrationRegistry.nextHookName();
-                    client.registerAction(serialized['as']['cftqs'], async ({ 'ff': filterFields }) => {
-                        var _a;
-                        const result = await ((_a = queryStringAutoSync.convertFiltersToQueryString) === null || _a === void 0 ? void 0 : _a.call(queryStringAutoSync, new Map(filterFields)));
-                        if ((0, cardintegrationautosyncconfig_1.isConvertFiltersToQueryStringResult)(result)) {
-                            return {
-                                'qs': result.queryString,
-                                'e': result.error,
-                            };
-                        }
-                        return result;
-                    });
-                }
-                if (queryStringAutoSync.getDefaultFilterFields) {
-                    serialized['as']['gdff'] = LucidCardIntegrationRegistry.nextHookName();
-                    client.registerAction(serialized['as']['gdff'], async ({ 's': searchSoFar }) => {
-                        var _a, _b;
-                        const result = (_b = (await ((_a = queryStringAutoSync.getDefaultFilterFields) === null || _a === void 0 ? void 0 : _a.call(queryStringAutoSync, new Map(searchSoFar))))) !== null && _b !== void 0 ? _b : [];
-                        return (0, cardintegrationdefinitions_1.serializeCardFieldArrayDefinition)(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,
-                    };
-                });
-            }
+            serialized['as'] = (0, sharedregistryutil_1.registerAutoSync)(client, cardIntegration.autoSync, () => LucidCardIntegrationRegistry.nextHookName());
         }
         if (cardIntegration.fieldConfiguration.customFieldDisplaySettings) {
             serialized['fc']['cfds'] = {
                 'd': cardIntegration.fieldConfiguration.customFieldDisplaySettings.defaultToMultilineText,
-                '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,
+                '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,
             };
         }
         if (cardIntegration.fieldConfiguration.nonCustomizableFields) {

package/core/checks.d.ts

@@ -138,6 +138,7 @@ export declare function isTypedTuple<const Tuple extends readonly unknown[]>(gua
  * @return Whether variable is a map.
  */
 export declare function isMap(val: unknown): val is Map<unknown, unknown>;
+export declare function isTypedMap<K, V>(kTest: (k: unknown) => k is K, vTest: (v: unknown) => v is V): (val: unknown) => val is Map<K, V>;
 export type Tuple<T, N extends number> = N extends N ? (number extends N ? T[] : TupleOfHelper<T, N, []>) : never;
 type TupleOfHelper<T, N extends number, R extends unknown[]> = R['length'] extends N ? R : TupleOfHelper<T, N, [T, ...R]>;
 export declare function isExactLength<T, N extends number>(arr: readonly T[], exactLength: N): arr is Tuple<T, N>;

package/core/checks.js

@@ -21,6 +21,7 @@ exports.isTypedArray = isTypedArray;
 exports.isDefinedArray = isDefinedArray;
 exports.isTypedTuple = isTypedTuple;
 exports.isMap = isMap;
+exports.isTypedMap = isTypedMap;
 exports.isExactLength = isExactLength;
 exports.isAtLeastLength = isAtLeastLength;
 exports.isPair = isPair;
@@ -215,6 +216,19 @@ function isTypedTuple(guards) {
 function isMap(val) {
     return val instanceof Map;
 }
+function isTypedMap(kTest, vTest) {
+    return function (val) {
+        if (!isMap(val)) {
+            return false;
+        }
+        for (const [k, v] of val) {
+            if (!kTest(k) || !vTest(v)) {
+                return false;
+            }
+        }
+        return true;
+    };
+}
 function isExactLength(arr, exactLength) {
     return arr.length === exactLength;
 }

package/core/sharedcardintegration/sharedregistryutil.d.ts

@@ -1,4 +1,50 @@
-import { DependencyMappingSettings } from '../../commandtypes';
+import { AutoSyncSettings, DependencyMappingSettings } from '../../commandtypes';
 import { EditorClient } from '../../editorclient';
+import { type CardIntegrationAutoSyncConfig } from '../cardintegration/cardintegrationautosyncconfig';
+import { ImportResult, SearchResult } from './cardintegrationdefinitions';
 import { CardIntegrationDependencyMappingConfig } from './dependencymappingconfig';
+/**
+ * Serializes a `SearchResult` into the wire-format object the editor expects. Shared between the
+ * import-modal `search` path and the auto-sync `searchQueryString` / `searchFields` paths.
+ */
+export declare function serializeSearchResult(searchResult: SearchResult): {
+    srs: {
+        d: import("../../data/collectiondefinition").SerializedCollectionDefinition;
+        f: import("./cardintegrationdefinitions").SerializedExtensionCardFieldDefinition[];
+        m: {
+            cid: string;
+            sid: string | undefined;
+        } | undefined;
+    }[];
+    ipsr: number | undefined;
+    e: string | undefined;
+    bs: {
+        ty: "error-banner";
+        msg: string;
+        btyp: import("./cardintegrationdefinitions").BannerType | undefined;
+        actbtn: {
+            lab: string;
+            aid: string | undefined;
+            href: string | undefined;
+        } | undefined;
+    }[] | undefined;
+};
+/**
+ * Serializes import results (single or array) to the wire-format the editor expects. Shared
+ * between the import-modal `import` path, the dependency-mapping path, and the auto-sync `sync*`
+ * paths.
+ */
+export declare function serializeImportResults(result: ImportResult | ImportResult[]): {
+    c: string;
+    pks: string[];
+}[] | {
+    c: string;
+    pks: string[];
+};
+/**
+ * Registers the editor-side actions for a `CardIntegrationAutoSyncConfig` on the given client and
+ * returns the corresponding `AutoSyncSettings` wire-format payload. Used by both
+ * `LucidCardIntegrationRegistry` and `LucidSpreadsheetIntegrationRegistry`.
+ */
+export declare function registerAutoSync(client: EditorClient, autoSync: CardIntegrationAutoSyncConfig, getNextHookName: () => string): AutoSyncSettings;
 export declare function registerDependencyMapping(client: EditorClient, dependencyMapping: CardIntegrationDependencyMappingConfig, serialized: DependencyMappingSettings, getNextHookName: () => string): void;