lucid-extension-sdk 0.0.435 → 0.0.437

package/commandtypes.d.ts

@@ -46,6 +46,7 @@ export declare const enum CommandName {
     CalculateHash = "hsh",
     CanEditPackageSettings = "ceps",
     CancelDragBlockToCanvas = "cdc",
+    CheckUserFlagAssignment = "cufa",
     Confirm = "c",
     CreateBlock = "cb",
     CreateCards = "ca",
@@ -77,6 +78,7 @@ export declare const enum CommandName {
     GetCurrentPage = "gcp",
     GetCustomShape = "gcs",
     GetDataItemField = "gdif",
+    GetDeveloperModeStatus = "gdms",
     GetDocumentAccessPermission = "gdap",
     GetDocumentChunks = "gdc",
     GetDocumentId = "gdid",
@@ -252,6 +254,10 @@ export type CommandArgs = {
         query: CancelDragBlockToCanvasQuery;
         result: CancelDragBlockToCanvasResult;
     };
+    [CommandName.CheckUserFlagAssignment]: {
+        query: CheckUserFlagAssignmentQuery;
+        result: CheckUserFlagAssignmentResult;
+    };
     [CommandName.Confirm]: {
         query: ConfirmQuery;
         result: ConfirmResult;
@@ -376,6 +382,10 @@ export type CommandArgs = {
         query: GetDataItemFieldQuery;
         result: GetDataItemFieldResult;
     };
+    [CommandName.GetDeveloperModeStatus]: {
+        query: GetDeveloperModeStatusQuery;
+        result: GetDeveloperModeStatusResult;
+    };
     [CommandName.GetDocumentAccessPermission]: {
         query: GetDocumentAccessPermissionQuery;
         result: GetDocumentAccessPermissionResult;
@@ -735,6 +745,12 @@ export type AddCardsActions = {
     /** Create card action */
     'cc': string;
 };
+export type AutoSyncSettings = {
+    'h': string;
+    'gsf': string;
+    'sqs'?: string | undefined;
+    'syqs'?: string | undefined;
+};
 export type SerializedFieldConfiguration = {
     /** Callback to get field definitions for all fields supported by the card integration */
     'gf': string;
@@ -799,6 +815,8 @@ export type AddCardIntegrationQuery = {
     } | undefined;
     /** If specified, add-card settings */
     'ac'?: AddCardsActions | undefined;
+    /** If specified, auto sync settings */
+    'as'?: AutoSyncSettings | undefined;
     /** Whether to enable dependency mapping for this integration */
     'sdm'?: boolean;
     /**
@@ -815,6 +833,11 @@ export type AddCardIntegrationQuery = {
         /** Callback to fetch icons that show next to the field labels in the card details panel */
         'flic'?: string | undefined;
     } | undefined;
+    /**
+     * @experimental
+     * Tag callback, to display tag information for any card
+     */
+    'tc'?: string | undefined;
     /**
      * If specified, the text phrases to show in the dependency mapping UI.
      * If not specified, dependency mapping for this integration uses the default fallback phrases.
@@ -884,6 +907,10 @@ export type AddCardIntegrationQuery = {
         'd': string;
         'cb': string;
     } | undefined;
+    /**
+     * whether the user has access to items
+     */
+    'hait'?: string | undefined;
 };
 export type AddCardIntegrationResult = undefined;
 /** @ignore */
@@ -1375,6 +1402,8 @@ export type GetDataItemFieldQuery = {
     'f': string;
 };
 export type GetDataItemFieldResult = SerializedFieldType;
+export type GetDeveloperModeStatusQuery = void;
+export type GetDeveloperModeStatusResult = boolean;
 export type GetDocumentAccessPermissionQuery = void;
 export type GetDocumentAccessPermissionResult = DocumentAccessPermission;
 export declare enum GetDocumentChunksType {
@@ -1990,4 +2019,9 @@ export type ZOrderQuery = {
     'o': ZOrderOperation;
 };
 export type ZOrderResult = undefined;
+export type CheckUserFlagAssignmentQuery = {
+    /** The name of the flag that will be checked */
+    'f': string;
+};
+export type CheckUserFlagAssignmentResult = boolean;
 export {};

package/commandtypes.js

@@ -23,6 +23,7 @@ exports.commandTitles = new Map([
     ["b" /* CommandName.Bootstrap */, 'Bootstrap'],
     ["ceps" /* CommandName.CanEditPackageSettings */, 'CanEditPackageSettings'],
     ["cdc" /* CommandName.CancelDragBlockToCanvas */, 'CancelDragBlockToCanvas'],
+    ["cufa" /* CommandName.CheckUserFlagAssignment */, 'CheckUserFlagAssignment'],
     ["c" /* CommandName.Confirm */, 'Confirm'],
     ["cb" /* CommandName.CreateBlock */, 'CreateBlock'],
     ["cc" /* CommandName.CreateCollection */, 'CreateCollection'],
@@ -50,6 +51,7 @@ exports.commandTitles = new Map([
     ["gcp" /* CommandName.GetCurrentPage */, 'GetCurrentPage'],
     ["gcs" /* CommandName.GetCustomShape */, 'GetCustomShape'],
     ["gdif" /* CommandName.GetDataItemField */, 'GetDataItemField'],
+    ["gdms" /* CommandName.GetDeveloperModeStatus */, 'GetDeveloperModeStatus'],
     ["gdap" /* CommandName.GetDocumentAccessPermission */, 'GetDocumentAccessPermission'],
     ["gdc" /* CommandName.GetDocumentChunks */, 'GetDocumentChunks'],
     ["gdid" /* CommandName.GetDocumentId */, 'GetDocumentId'],

package/core/cardintegration/cardintegrationautosyncconfig.d.ts

@@ -0,0 +1,27 @@
+import { SerializedFieldType } from '../data/serializedfield/serializedfields';
+import { ExtensionCardFieldDefinition, ImportResult, SearchResult } from '../sharedcardintegration/cardintegrationdefinitions';
+export interface CardIntegrationAutoSyncConfig {
+    /**
+     * The header to display for the integration. For example, the Jira integration displays "JQL query sync"
+     */
+    header: string;
+    /**
+     * 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
+     *
+     * The value is the syncDataSourceIdNonce. If this is the same no matter what, return a single ExtensionCardField
+     * with a single ExtensionCardFieldOption in ExtensionCardField.options
+     */
+    getSyncDataSourceIdField: (searchSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
+    /**
+     * Perform a search on the query string. This should support pagination.
+     *
+     * The syncDataSourceIdNonce is provided in otherFields
+     * @returns either an error AutoSyncError or an array of issues / tasks / cards represented as an AutoSyncRow
+     */
+    searchQueryString?: (queryString: string, otherFields: Map<string, SerializedFieldType>, pageNumber: number, nextPageToken: string | undefined) => Promise<SearchResult>;
+    /**
+     * @returns the ImportResult for the query string.
+     */
+    syncQueryString?: (queryString: string, otherFields: Map<string, SerializedFieldType>) => Promise<ImportResult | ImportResult[]>;
+}

package/core/cardintegration/cardintegrationautosyncconfig.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/core/cardintegration/cardintegrationparams.d.ts

@@ -23,6 +23,16 @@ export interface SearchParam {
     'o': number;
     'l': number;
 }
+export interface QuerySearchParam {
+    'qs': string;
+    'of': [string, SerializedFieldType][];
+    'pn': number;
+    'npt': string | undefined;
+}
+export interface QuerySyncParam {
+    'qs': string;
+    'of': [string, SerializedFieldType][];
+}
 /** @ignore */
 export interface ImportParam {
     'pks': string[];
@@ -81,7 +91,7 @@ export interface DependencyMappingSelectedIssueHeadingParam {
     'k': string;
 }
 /** @ignore */
-export interface FieldLabelIconsCallbackParam {
+export interface DataItemCallbackParam {
     'd': string;
     'c': string;
     'p': string;
@@ -90,4 +100,9 @@ export interface FieldLabelIconsCallbackParam {
 export interface ImportFromSerializedFieldsCallbackParam {
     'sf': SerializedFields[];
 }
+/** @ignore */
+export interface HasAccessToItemsParam {
+    'ek': string;
+    'dk'?: string;
+}
 export {};

package/core/cardintegration/carduseraccessresult.d.ts

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

package/core/cardintegration/carduseraccessresult.js

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

package/core/cardintegration/lucidcardintegration.d.ts

@@ -7,7 +7,9 @@ import { SerializedFieldType, SerializedFields } from '../data/serializedfield/s
 import { ImportCardFromDetails } from '../importcardfromdetails/importcardfromdetails';
 import { ImportCardFromPastedLinkCallback } from '../importcardfrompastedlink/importcardfrompastedlinkcallback';
 import { DependenciesForItems, ExtensionCardFieldDefinition, ExtensionFieldConfiguration, ImportResult } from '../sharedcardintegration/cardintegrationdefinitions';
+import { CardIntegrationAutoSyncConfig } from './cardintegrationautosyncconfig';
 import { CardIntegrationConfig } from './cardintegrationconfig';
+import { CardUserAccessResult } from './carduseraccessresult';
 import { DependencyMappingPhrasesType } from './dependencymappingphrases';
 import { LucidCardIntegrationCustomImportModal } from './lucidcardintegrationcustomimportmodal';
 import { LucidCardIntegrationStandardImportModal } from './lucidcardintegrationstandardimportmodal';
@@ -79,6 +81,12 @@ export declare abstract class LucidCardIntegration {
          */
         fieldLabelIconsCallback?: string;
     };
+    /**
+     * @experimental Optional. Callback function to derive a tag for any given card.
+     * A tag is a combination of a text label (preferably short, less than two words) and an icon,
+     * which can provide extra user-facing information in the card details panel.
+     */
+    tagCallback?: string;
     /** If we are only able to search by name and not email in the card integration (ex: for JDC) */
     searchUserByName?: boolean;
     /** This is used to search for users in the card integration. It returns an additional email field of the user if available.*/
@@ -115,6 +123,10 @@ export declare abstract class LucidCardIntegration {
             primaryKey: string;
         }>;
     };
+    /**
+     * If specified, allows the user to use query to sync with timelines.
+     */
+    autoSync?: CardIntegrationAutoSyncConfig;
     showCardImport(name: string): import("../../commandtypes").ImportCardsResult;
     showDependencyMapping?: boolean;
     /**
@@ -143,4 +155,8 @@ export declare abstract class LucidCardIntegration {
      * the import.
      */
     importFromSerializedFields?: (data: SerializedFields[]) => Promise<ImportCardFromDetails>;
+    /**
+     * @experimental When defined, allows the extension to make cards that the user doesn't have access to view-only.
+     */
+    hasAccessToItems?: (editedKey: string, dependencyKey: string | undefined) => Promise<CardUserAccessResult>;
 }

package/core/cardintegration/lucidcardintegrationregistry.d.ts

@@ -2,7 +2,7 @@ import { DataItemProxy } from '../../data/dataitemproxy';
 import { DataSourceProxy } from '../../data/datasourceproxy';
 import { EditorClient } from '../../editorclient';
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
-import { ExtensionCardFieldLabelIcons, ExtensionCardFieldOption, ExtensionCardUserData } from '../sharedcardintegration/cardintegrationdefinitions';
+import { ExtensionCardFieldLabelIcons, ExtensionCardFieldOption, ExtensionCardUserData, TagCallback } from '../sharedcardintegration/cardintegrationdefinitions';
 import { LucidCardIntegration } from './lucidcardintegration';
 export declare class LucidCardIntegrationRegistry {
     private static nextHookId;
@@ -14,8 +14,13 @@ export declare class LucidCardIntegrationRegistry {
     }) => Promise<ExtensionCardFieldOption[]>): string;
     static registerUserSearchCallback(client: EditorClient, callback: (searchText: string, inputSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardUserData[]>): string;
     static registerFieldLabelIconsCallback(client: EditorClient, callback: (dataSourceProxy: DataSourceProxy, dataItemProxy: DataItemProxy) => Promise<ExtensionCardFieldLabelIcons>): string;
+    static registerTagCallback(client: EditorClient, callback: TagCallback): 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

@@ -10,6 +10,7 @@ const checks_1 = require("../checks");
 const importcardfromdetails_1 = require("../importcardfromdetails/importcardfromdetails");
 const cardintegrationdefinitions_1 = require("../sharedcardintegration/cardintegrationdefinitions");
 const cardintegrationconfig_1 = require("./cardintegrationconfig");
+const carduseraccessresult_1 = require("./carduseraccessresult");
 const lucidcardintegrationcustomimportmodal_1 = require("./lucidcardintegrationcustomimportmodal");
 class LucidCardIntegrationRegistry {
     static nextHookName() {
@@ -59,6 +60,21 @@ class LucidCardIntegrationRegistry {
         });
         return name;
     }
+    static registerTagCallback(client, callback) {
+        const name = LucidCardIntegrationRegistry.nextHookName();
+        client.registerAction(name, async ({ 'd': dataSourceId, 'c': collectionId, 'p': primaryKey, }) => {
+            const dataSourceProxy = new datasourceproxy_1.DataSourceProxy(dataSourceId, client);
+            const collectionProxy = new collectionproxy_1.CollectionProxy(collectionId, client);
+            const dataItemProxy = new dataitemproxy_1.DataItemProxy(primaryKey, collectionProxy, client);
+            const result = await callback(dataSourceProxy, collectionProxy, dataItemProxy);
+            if (result === undefined) {
+                return undefined;
+            }
+            const serializedResult = (0, cardintegrationdefinitions_1.serializeTagCallbackResult)(result);
+            return serializedResult;
+        });
+        return name;
+    }
     static registerDependencyMapping(client, cardIntegration, serialized) {
         if (cardIntegration.showDependencyMapping) {
             serialized['sdm'] = true;
@@ -172,6 +188,24 @@ class LucidCardIntegrationRegistry {
                 },
             })),
             'ipsr': searchResult.itemsPerSearchResult,
+            'e': searchResult.error,
+        };
+    }
+    /**
+     * 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) {
@@ -256,6 +290,9 @@ class LucidCardIntegrationRegistry {
                 'flic': cardIntegration.iconConfiguration.fieldLabelIconsCallback,
             };
         }
+        if (cardIntegration.tagCallback) {
+            serialized['tc'] = cardIntegration.tagCallback;
+        }
         if (cardIntegration.importModal) {
             const importModal = cardIntegration.importModal;
             if (importModal instanceof lucidcardintegrationcustomimportmodal_1.LucidCardIntegrationCustomImportModal) {
@@ -341,6 +378,41 @@ class LucidCardIntegrationRegistry {
                 };
             });
         }
+        if (cardIntegration.autoSync) {
+            const autoSync = cardIntegration.autoSync;
+            serialized['as'] = {
+                'h': autoSync.header,
+                'gsf': LucidCardIntegrationRegistry.nextHookName(),
+            };
+            client.registerAction(serialized['as']['gsf'], async ({ 'i': inputSoFar }) => {
+                const result = await autoSync.getSyncDataSourceIdField(new Map(inputSoFar));
+                return (0, cardintegrationdefinitions_1.serializeCardFieldArrayDefinition)(result);
+            });
+            if (autoSync.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 = autoSync.searchQueryString) === null || _a === void 0 ? void 0 : _a.call(autoSync, queryString, new Map(otherFields), pageNumber, nextPageToken));
+                    if (result) {
+                        return this.serializeSearchResult(result);
+                    }
+                    else {
+                        return this.serializeSearchResult({
+                            searchResults: [],
+                            error: 'Unknown Error Occurred',
+                        });
+                    }
+                });
+            }
+            if (autoSync.syncQueryString) {
+                serialized['as']['syqs'] = LucidCardIntegrationRegistry.nextHookName();
+                client.registerAction(serialized['as']['syqs'], async ({ 'qs': queryString, 'of': otherFields }) => {
+                    var _a, _b;
+                    const result = (_b = (await ((_a = autoSync.syncQueryString) === null || _a === void 0 ? void 0 : _a.call(autoSync, queryString, new Map(otherFields))))) !== null && _b !== void 0 ? _b : [];
+                    return LucidCardIntegrationRegistry.serializeImportResults(result);
+                });
+            }
+        }
         if (cardIntegration.fieldConfiguration.customFieldDisplaySettings) {
             serialized['fc']['cfds'] = {
                 'd': cardIntegration.fieldConfiguration.customFieldDisplaySettings.defaultToMultilineText,
@@ -358,6 +430,14 @@ class LucidCardIntegrationRegistry {
                 return (0, importcardfromdetails_1.serializeImportCardFromDetails)(result);
             });
         }
+        if (cardIntegration.hasAccessToItems) {
+            const hasAccessToItemsActionName = LucidCardIntegrationRegistry.nextHookName();
+            serialized['hait'] = hasAccessToItemsActionName;
+            client.registerAction(hasAccessToItemsActionName, async ({ 'ek': editedKey, 'dk': dependencyKey }) => {
+                const result = await cardIntegration.hasAccessToItems(editedKey, dependencyKey);
+                return (0, carduseraccessresult_1.serializeCardUserAccessResult)(result);
+            });
+        }
         client.sendCommand("aci" /* CommandName.AddCardIntegration */, serialized);
     }
 }

package/core/data/lucidicon.d.ts

@@ -1,10 +1,10 @@
-import { SerializedLucidDictionary } from './serializedfield/serializedfields';
+import { SerializedLucidIconData } from './serializedfield/serializedfields';
 /**
- * Creates icon data as a SerializedLucidDictionary.
+ * Creates icon data as a SerializedLucidIconData.
  * Useful for creating icons in extensions built on the Lucid Extension SDK that need to be parsed by Lucid's products.
  * @param icon - The URL or SVG data for the icon
  * @param ariaLabel - The accessible label for the icon
  * @param tooltipLabel - Optional tooltip text
- * @returns A SerializedLucidDictionary with the keys: icon, ariaLabel, and tooltipLabel (if provided)
+ * @returns A SerializedLucidIconData with the keys: icon, ariaLabel, and tooltipLabel (if provided)
  */
-export declare function createLucidIconData(icon: string, ariaLabel: string, tooltipLabel?: string): SerializedLucidDictionary;
+export declare function createLucidIconData(icon: string, ariaLabel: string, tooltipLabel?: string): SerializedLucidIconData;

package/core/data/lucidicon.js

@@ -2,12 +2,12 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createLucidIconData = void 0;
 /**
- * Creates icon data as a SerializedLucidDictionary.
+ * Creates icon data as a SerializedLucidIconData.
  * Useful for creating icons in extensions built on the Lucid Extension SDK that need to be parsed by Lucid's products.
  * @param icon - The URL or SVG data for the icon
  * @param ariaLabel - The accessible label for the icon
  * @param tooltipLabel - Optional tooltip text
- * @returns A SerializedLucidDictionary with the keys: icon, ariaLabel, and tooltipLabel (if provided)
+ * @returns A SerializedLucidIconData with the keys: icon, ariaLabel, and tooltipLabel (if provided)
  */
 function createLucidIconData(icon, ariaLabel, tooltipLabel) {
     return {

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

@@ -139,7 +139,15 @@ export declare const isSerializedTimeObject: (subject: unknown) => subject is im
     minutes: (x: unknown) => x is number | undefined;
     seconds: (x: unknown) => x is number | undefined;
 }>;
-export declare const isSerializedLucidIconDataDictionary: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
+export type SerializedLucidIconData = {
+    'dict': {
+        'icon': string;
+        'ariaLabel': string;
+        'tooltipLabel'?: string | undefined;
+        'roundedIcon'?: boolean | undefined;
+    };
+};
+export declare const isSerializedLucidIconData: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
     dict: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
         icon: typeof isString;
         ariaLabel: typeof isString;

package/core/data/serializedfield/serializedfields.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSerializedFields = exports.isSerializedJsonFieldType = exports.isSerializedFieldType = exports.isSerializedLucidIconDataDictionary = exports.isSerializedTimeObject = exports.isSerializedLucidDateRangeObject = exports.isSerializedLucidDateObject = exports.isSerializedIsoDateObject = exports.isSerializedMillisecondsDateObject = exports.isSerializedLucidAvatarDataDictionary = exports.isSerializedLucidCurrency = exports.isSerializedLucidDictionary = exports.isJsonSerializedLucidDictionary = exports.isNestedSerializedLucidDictionary = exports.isSerializedColorObjectFieldType = void 0;
+exports.isSerializedFields = exports.isSerializedJsonFieldType = exports.isSerializedFieldType = exports.isSerializedLucidIconData = exports.isSerializedTimeObject = exports.isSerializedLucidDateRangeObject = exports.isSerializedLucidDateObject = exports.isSerializedIsoDateObject = exports.isSerializedMillisecondsDateObject = exports.isSerializedLucidAvatarDataDictionary = exports.isSerializedLucidCurrency = exports.isSerializedLucidDictionary = exports.isJsonSerializedLucidDictionary = exports.isNestedSerializedLucidDictionary = exports.isSerializedColorObjectFieldType = void 0;
 const checks_1 = require("../../checks");
 const validators_1 = require("../../validators/validators");
 function isSerializedColorObjectFieldType(value) {
@@ -44,7 +44,7 @@ exports.isSerializedTimeObject = (0, validators_1.objectValidator)({
     'minutes': (0, validators_1.option)(checks_1.isNumber),
     'seconds': (0, validators_1.option)(checks_1.isNumber),
 });
-exports.isSerializedLucidIconDataDictionary = (0, validators_1.objectValidator)({
+exports.isSerializedLucidIconData = (0, validators_1.objectValidator)({
     'dict': (0, validators_1.objectValidator)({
         'icon': checks_1.isString,
         'ariaLabel': checks_1.isString,
@@ -64,7 +64,7 @@ function isSerializedFieldType(value) {
         (0, exports.isSerializedLucidDateRangeObject)(value) ||
         (0, exports.isSerializedTimeObject)(value) ||
         isSerializedColorObjectFieldType(value) ||
-        (0, exports.isSerializedLucidIconDataDictionary)(value) ||
+        (0, exports.isSerializedLucidIconData)(value) ||
         (0, exports.isSerializedLucidAvatarDataDictionary)(value));
 }
 exports.isSerializedFieldType = isSerializedFieldType;

package/core/sharedcardintegration/cardintegrationdefinitions.d.ts

@@ -7,7 +7,7 @@ import { FieldDescriptor } from '../cardintegration/lucidcardintegration';
 import { isArray, isString } from '../checks';
 import { isSerializedFieldTypeDefinition } from '../data/fieldtypedefinition/fieldtypedefinition';
 import { SerializedFieldDefinition } from '../data/serializedfield/serializedfielddefinition';
-import { SerializedFieldType, SerializedLucidDictionary, isSerializedFieldType } from '../data/serializedfield/serializedfields';
+import { SerializedFieldType, SerializedLucidIconData, isSerializedFieldType } from '../data/serializedfield/serializedfields';
 /** For fields with Option or ApiOption type, the label and value for each available option */
 export interface ExtensionCardFieldOption {
     label: string;
@@ -161,6 +161,7 @@ export interface SearchResultPerCollection {
 export interface SearchResult {
     searchResults: SearchResultPerCollection[];
     itemsPerSearchResult?: number | undefined;
+    error?: string | undefined;
 }
 export declare const isSearchResult: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
     searchResults: typeof isArray;
@@ -275,4 +276,34 @@ export type ExtensionFieldConfiguration = {
  * Maps item field names to icons that show next to the field labels in the card details panel.
  * Use the `createLucidIconData()` helper to format the icon data in this map.
  */
-export type ExtensionCardFieldLabelIcons = Map<string, SerializedLucidDictionary>;
+export type ExtensionCardFieldLabelIcons = Map<string, SerializedLucidIconData>;
+/**
+ * @experimental Callback function to derive a tag for any given card's data item.
+ * A tag is a combination of a text label (preferably short, less than two words) and an icon,
+ * which can provide extra user-facing information in the card details panel.
+ */
+export type TagCallback = (dataSourceProxy: DataSourceProxy, collectionProxy: CollectionProxy, dataItemProxy: DataItemProxy) => Promise<TagCallbackResult | undefined>;
+/** @ignore */
+export type TagCallbackResult = {
+    label: string;
+    icon?: SerializedLucidIconData | undefined;
+};
+/** @ignore */
+export interface SerializedTagCallbackResult {
+    'l': string;
+    'i'?: SerializedLucidIconData | undefined;
+}
+/** @ignore */
+export declare const isSerializedTagCallbackResult: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
+    l: typeof isString;
+    i: (x: unknown) => x is import("../guards").DestructureGuardedTypeObj<{
+        dict: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
+            icon: typeof isString;
+            ariaLabel: typeof isString;
+            tooltipLabel: (x: unknown) => x is string | undefined;
+            roundedIcon: (x: unknown) => x is boolean | undefined;
+        }>;
+    }> | undefined;
+}>;
+/** @ignore */
+export declare function serializeTagCallbackResult(tag: TagCallbackResult): SerializedTagCallbackResult;

package/core/sharedcardintegration/cardintegrationdefinitions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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 = void 0;
 const collectiondefinition_1 = require("../../data/collectiondefinition");
 const schemadefinition_1 = require("../../data/schemadefinition");
 const checks_1 = require("../checks");
@@ -104,3 +104,16 @@ function deserializePlaceholderImportMetadata(serializedPlaceholderImportMetadat
     };
 }
 exports.deserializePlaceholderImportMetadata = deserializePlaceholderImportMetadata;
+/** @ignore */
+exports.isSerializedTagCallbackResult = (0, validators_1.objectValidator)({
+    'l': checks_1.isString,
+    'i': (0, validators_1.option)(serializedfields_1.isSerializedLucidIconData),
+});
+/** @ignore */
+function serializeTagCallbackResult(tag) {
+    return {
+        'l': tag.label,
+        'i': tag === null || tag === void 0 ? void 0 : tag.icon,
+    };
+}
+exports.serializeTagCallbackResult = serializeTagCallbackResult;

package/data/branchedcollectionid.js

@@ -1,13 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.patchCollectionIdFromPossibleBranchedCollectionId = exports.branchedCollectionId = void 0;
-// LAL-1631: make sure references to this method are correct
 /** @ignore */
 function branchedCollectionId(upstreamId) {
     return upstreamId + '_b';
 }
 exports.branchedCollectionId = branchedCollectionId;
-// LAL-1631: make sure references to this method are correct
 /** @ignore */
 function patchCollectionIdFromPossibleBranchedCollectionId(branchId) {
     if (branchId && branchId.endsWith('_b')) {

package/dataconnector/datasourceclient.d.ts

@@ -35,6 +35,13 @@ export declare class DataSourceClient {
     getMetadata(keys: string[], prefixes?: string[]): Promise<MetadataRecord[]>;
     /** @ignore until metadata endpoints are made part of the public API */
     patchMetadata(patches: MetadataPatch[]): Promise<MetadataPatchResponse>;
+    /**
+     * @ignore as this is primarily an internal-use method.
+     * Checks the current value of the given feature flag. This cannot take into account any local overrides, and can
+     * only be used for feature flags (not other forms of AB test). This method reads feature flag values from our
+     * "frontend" selection of feature flags.
+     */
+    getFeatureFlagValue(flagName: string): Promise<boolean>;
 }
 /**
  * A version of the DataSourceClient that you can use for any automated tests of your data connector.

package/dataconnector/datasourceclient.js

@@ -204,6 +204,32 @@ class DataSourceClient {
         await (0, throwunsuccessful_1.throwUnsuccessful)(response, 'patching data source`s metadata');
         return { status: 'NoContent' };
     }
+    /**
+     * @ignore as this is primarily an internal-use method.
+     * Checks the current value of the given feature flag. This cannot take into account any local overrides, and can
+     * only be used for feature flags (not other forms of AB test). This method reads feature flag values from our
+     * "frontend" selection of feature flags.
+     */
+    async getFeatureFlagValue(flagName) {
+        const flagRequest = await this.fetchMethod(`${this.urls.main}features/frontend`, {
+            'method': 'GET',
+            'headers': {
+                'Content-Type': 'application/json',
+            },
+        });
+        if (!flagRequest.ok) {
+            return false;
+        }
+        const response = await flagRequest.json();
+        const featureFlagResponseObjectValidator = (0, validators_1.objectValidator)({
+            featureFlags: (0, validators_1.objectOfValidator)(checks_1.isBoolean, checks_1.isString),
+        });
+        if (!featureFlagResponseObjectValidator(response)) {
+            return false;
+        }
+        const flagValue = response.featureFlags[flagName];
+        return !!flagValue;
+    }
 }
 exports.DataSourceClient = DataSourceClient;
 /**

package/editorclient.d.ts

@@ -361,6 +361,12 @@ export declare class EditorClient {
      * @hidden
      */
     protected listenToEditor(): void;
+    /**
+     * @ignore Until releasing developer mode
+     * Check to know if the editor is currently in developer mode
+     * @returns true if the editor is in developer mode, false otherwise
+     */
+    getDeveloperModeStatus(): boolean;
     /**
      * Display an alert modal to the user
      * @param text Body text to display in the alert modal
@@ -431,5 +437,12 @@ export declare class EditorClient {
      */
     /** @ignore because our documentation gets generated incorrectly for an as-yet unknown reason. It seems to refer to the HashAlgorithmEnum with an incorrect link. */
     hash(algorithm: HashAlgorithmEnum, string: string): string;
+    /**
+     * @ignore as this is primarily an internal-use method.
+     *
+     * 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;
     constructor();
 }

package/editorclient.js

@@ -615,6 +615,14 @@ class EditorClient {
             return (_a = this.callbacks.get(msg['id'])) === null || _a === void 0 ? void 0 : _a(msg);
         });
     }
+    /**
+     * @ignore Until releasing developer mode
+     * Check to know if the editor is currently in developer mode
+     * @returns true if the editor is in developer mode, false otherwise
+     */
+    getDeveloperModeStatus() {
+        return this.sendCommand("gdms" /* CommandName.GetDeveloperModeStatus */, undefined);
+    }
     /**
      * Display an alert modal to the user
      * @param text Body text to display in the alert modal
@@ -723,6 +731,15 @@ class EditorClient {
     hash(algorithm, string) {
         return this.sendCommand("hsh" /* CommandName.CalculateHash */, { 'a': algorithm, 's': string });
     }
+    /**
+     * @ignore as this is primarily an internal-use method.
+     *
+     * 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) {
+        return this.sendCommand("cufa" /* CommandName.CheckUserFlagAssignment */, { 'f': flagName });
+    }
     constructor() {
         this.nextId = 0;
         this.callbacks = new Map();

package/package.json

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