lucid-extension-sdk 0.0.370 → 0.0.372

package/commandtypes.d.ts

@@ -756,6 +756,8 @@ export type AddCardIntegrationQuery = {
         'osfc'?: string | undefined;
         /** Field name -> callback name tuples for searching for legal field values in an enum */
         'fvsc'?: [string, string][] | undefined;
+        /** Default search callback for searching for legal field values in an enum */
+        'dsc'?: string | undefined;
     };
     /** If we can only search for user by their name (and not email) in the card integration. */
     'subn'?: boolean | undefined;

package/core/cardintegration/cardintegrationparams.d.ts

@@ -56,6 +56,9 @@ export interface GetOptionsParam {
 export interface SearchOptionsParam {
     's': string;
     'i': [string, SerializedFieldType][];
+    'fd'?: {
+        'n'?: string;
+    };
 }
 /** @ignore */
 export interface DependencyMappingCardLabelParam {

package/core/cardintegration/lucidcardintegration.d.ts

@@ -73,6 +73,11 @@ export declare abstract class LucidCardIntegration {
          * be all the current field values on the item being edited.
          */
         fieldValueSearchCallbacks?: Map<string, string>;
+        /**
+         * Optional callback that's used when a field name may not map to any field defined in fieldValueSearchCallbacks.
+         * Useful for when you don't know the field name ahead of time (e.g. a dynamically generated field name).
+         */
+        defaultSearchCallback?: string;
     };
     iconConfiguration?: {
         /**

package/core/cardintegration/lucidcardintegrationregistry.d.ts

@@ -6,7 +6,9 @@ export declare class LucidCardIntegrationRegistry {
     private static nextHookId;
     private static nextHookName;
     static registerFieldOptionsCallback(client: EditorClient, callback: (inputSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldOption[]>): string;
-    static registerFieldSearchCallback(client: EditorClient, callback: (searchText: string, inputSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldOption[]>): string;
+    static registerFieldSearchCallback(client: EditorClient, callback: (searchText: string, inputSoFar: Map<string, SerializedFieldType>, fieldData?: {
+        name?: string;
+    }) => Promise<ExtensionCardFieldOption[]>): string;
     static registerUserSearchCallback(client: EditorClient, callback: (searchText: string, inputSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardUserData[]>): string;
     private static registerDependencyMapping;
     private static serializeSearchResult;

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -23,8 +23,9 @@ class LucidCardIntegrationRegistry {
     }
     static registerFieldSearchCallback(client, callback) {
         const name = LucidCardIntegrationRegistry.nextHookName();
-        client.registerAction(name, async ({ 'i': inputSoFar, 's': searchText }) => {
-            const result = await callback(searchText, new Map(inputSoFar));
+        client.registerAction(name, async ({ 'i': inputSoFar, 's': searchText, 'fd': serializedFieldData }) => {
+            const fieldData = serializedFieldData ? { name: serializedFieldData.n } : undefined;
+            const result = await callback(searchText, new Map(inputSoFar), fieldData);
             return result.map((option) => (0, cardintegrationdefinitions_1.serializeCardFieldOption)(option));
         });
         return name;
@@ -180,6 +181,7 @@ class LucidCardIntegrationRegistry {
                 'fvsc': cardIntegration.fieldConfiguration.fieldValueSearchCallbacks
                     ? [...cardIntegration.fieldConfiguration.fieldValueSearchCallbacks.entries()]
                     : undefined,
+                'dsc': cardIntegration.fieldConfiguration.defaultSearchCallback,
             },
             'subn': cardIntegration.searchUserByName,
             'usc': cardIntegration.userSearchCallback,

package/core/checks.d.ts

@@ -117,6 +117,13 @@ export declare function isArray(val: unknown): val is unknown[];
  * @return Whether variable is an array of the given type.
  */
 export declare function isTypedArray<T>(typeGuard: (a: unknown) => a is T): (val: unknown) => val is T[];
+/**
+ * Returns true if the specified value is an array and every element is defined and not null.
+ *
+ * @param val Variable to test.
+ * @returns Whether variable is an array of defined and not null elements.
+ */
+export declare function isDefinedArray<T>(val: (T | undefined | null)[]): val is T[];
 /**
  * Returns true if the specified value is a map.
  *

package/core/checks.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isInstanceOf = exports.isLiteral = exports.isPromise = exports.isUnknown = exports.isAny = exports.isEmptyOrNullishObject = exports.isPair = exports.isAtLeastLength = exports.isExactLength = exports.isMap = exports.isTypedArray = exports.isArray = exports.isRecord = exports.isObjectUnsafer = exports.isObjectUnsafe = exports.isObject = exports.isFunction = exports.isInfinite = exports.isInt = exports.isNumber = exports.isBoolean = exports.isString = exports.isNullish = exports.isDefAndNotNull = exports.isVoid = exports.isUndefined = exports.isNull = exports.isDef = void 0;
+exports.isInstanceOf = exports.isLiteral = exports.isPromise = exports.isUnknown = exports.isAny = exports.isEmptyOrNullishObject = exports.isPair = exports.isAtLeastLength = exports.isExactLength = exports.isMap = exports.isDefinedArray = exports.isTypedArray = exports.isArray = exports.isRecord = exports.isObjectUnsafer = exports.isObjectUnsafe = exports.isObject = exports.isFunction = exports.isInfinite = exports.isInt = exports.isNumber = exports.isBoolean = exports.isString = exports.isNullish = exports.isDefAndNotNull = exports.isVoid = exports.isUndefined = exports.isNull = exports.isDef = void 0;
 /**
  * Returns true if the specified value is not undefined.
  *
@@ -177,6 +177,16 @@ function isTypedArray(typeGuard) {
     };
 }
 exports.isTypedArray = isTypedArray;
+/**
+ * Returns true if the specified value is an array and every element is defined and not null.
+ *
+ * @param val Variable to test.
+ * @returns Whether variable is an array of defined and not null elements.
+ */
+function isDefinedArray(val) {
+    return isArray(val) && val.every(isDefAndNotNull);
+}
+exports.isDefinedArray = isDefinedArray;
 /**
  * Returns true if the specified value is a map.
  *

package/core/sharedcardintegration/cardintegrationdefinitions.d.ts

@@ -10,7 +10,7 @@ import { SerializedFieldType, isSerializedFieldType } from '../data/serializedfi
 export interface ExtensionCardFieldOption {
     label: string;
     value: SerializedFieldType;
-    iconUrl?: string;
+    iconUrl?: string | undefined;
 }
 export interface ExtensionCardFieldDefinition extends FieldDefinition {
     /** The label to display in the UI */

package/package.json

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