lucid-extension-sdk 0.0.115 → 0.0.117

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -491,6 +491,8 @@ export declare type AddCardIntegrationQuery = {
         'gf': string;
         /** Callback to handle a change in the fields the user want to be displayed */
         'osfc'?: string | undefined;
+        /** Field name -> callback name tuples for searching for legal field values in an enum */
+        'fvsc'?: [string, string][] | undefined;
     };
     /** Show intro if user has not yet authorized this integration */
     'i'?: string | undefined;

package/sdk/core/cardintegration/cardintegrationdefinitions.d.ts

@@ -7,6 +7,7 @@ import { isSerializedFieldType, SerializedFieldType } from '../data/serializedfi
 export interface ExtensionCardFieldOption {
     label: string;
     value: SerializedFieldType;
+    iconUrl?: string;
 }
 export interface ExtensionCardFieldDefinition extends FieldDefinition {
     /** The label to display in the UI */
@@ -33,6 +34,7 @@ export interface ExtensionCardFieldDefinition extends FieldDefinition {
 export declare type SerializedCardFieldOption = {
     'l': string;
     'v'?: SerializedFieldType;
+    'i'?: string | undefined;
 };
 /** @ignore */
 export declare function serializeCardFieldOption(option: ExtensionCardFieldOption): SerializedCardFieldOption;
@@ -53,10 +55,12 @@ export declare function deserializeFieldOption(option: SerializedCardFieldOption
 export declare const isSerializedFieldOption: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
     l: typeof isString;
     v: typeof isSerializedFieldType;
+    i: (x: unknown) => x is string | 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;
 }>[];
 export declare const isSerializedFieldConstraint: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
     Type: (x: unknown) => x is FieldConstraintType;
@@ -76,6 +80,7 @@ export declare const isSerializedExtensionCardFieldDefinition: (subject: unknown
     op: (x: unknown) => x is string | import("../guards").DestructureGuardedTypeObj<{
         l: typeof isString;
         v: typeof isSerializedFieldType;
+        i: (x: unknown) => x is string | undefined;
     }>[] | undefined;
     s: (x: unknown) => x is string | undefined;
 }>;

package/sdk/core/cardintegration/cardintegrationdefinitions.js

@@ -12,6 +12,7 @@ function serializeCardFieldOption(option) {
     return {
         'l': option.label,
         'v': option.value,
+        'i': option.iconUrl,
     };
 }
 exports.serializeCardFieldOption = serializeCardFieldOption;
@@ -31,12 +32,14 @@ function deserializeFieldOption(option) {
     return {
         label: option['l'],
         value: option['v'],
+        iconUrl: option['i'],
     };
 }
 exports.deserializeFieldOption = deserializeFieldOption;
 exports.isSerializedFieldOption = (0, validators_1.objectValidator)({
     'l': checks_1.isString,
     'v': serializedfields_1.isSerializedFieldType,
+    'i': (0, validators_1.option)(checks_1.isString),
 });
 exports.isSerializedFieldOptions = (0, validators_1.arrayValidator)(exports.isSerializedFieldOption);
 exports.isSerializedFieldConstraint = (0, validators_1.objectValidator)({

package/sdk/core/cardintegration/lucidcardintegration.d.ts

@@ -39,6 +39,19 @@ export declare abstract class LucidCardIntegration {
          * If this callback is not provided then the user will not be shown the modal to configure fields.
          */
         onSelectedFieldsChange?: (dataSource: DataSourceProxy, selectedFields: string[]) => Promise<void>;
+        /**
+         * Specify callbacks for searching for legal values for the given fields.
+         *
+         * For example, a Task collection may have an Assignee field that references a User collection,
+         * but you don't import all the users in the entire source data set. Here, you can provide a way
+         * to search for legal values for the Assignee field, similar to the `ExtensionCardFieldDefinition.search`
+         * functionality.
+         *
+         * Register a search callback using LucidCardIntegrationRegistry.registerFieldSearchCallback, then set
+         * the returned string as a value in this Map. The `inputSoFar` parameter passed to the callback will
+         * be all the current field values on the item being edited.
+         */
+        fieldValueSearchCallbacks?: Map<string, string>;
     };
     /**
      * If specified, and the user hasn't yet authorized the data connector for this extension,

package/sdk/core/cardintegration/lucidcardintegrationregistry.js

@@ -63,6 +63,9 @@ class LucidCardIntegrationRegistry {
             'fc': {
                 'gf': getFieldsActionName,
                 'osfc': onSelectedFieldsChangeActionName,
+                'fvsc': cardIntegration.fieldConfiguration.fieldValueSearchCallbacks
+                    ? [...cardIntegration.fieldConfiguration.fieldValueSearchCallbacks.entries()]
+                    : undefined,
             },
             'gdc': getDefaultConfigActionName,
             'i': showIntroActionName,

package/sdk/core/data/datasource/serializedimporteddatasource.d.ts

@@ -0,0 +1,26 @@
+import { SerializedDataItems } from '../serializedfield/serializeddataitems';
+import { SerializedSchema } from '../serializedfield/serializedschema';
+import { SerializedDataSourceProperties } from './serializeddatasourceproperties';
+/** @ignore until spreadsheet integration is ready for launch */
+export interface SerializedImportedMetadataCollection {
+    'Name': string;
+    'Schema': SerializedSchema;
+    'Items': SerializedDataItems;
+}
+/** @ignore until spreadsheet integration is ready for launch */
+export interface SerializedImportedCollection {
+    'Name': string;
+    'Schema': SerializedSchema;
+    'Items': SerializedDataItems;
+    'UpstreamConfig': {
+        [key: string]: any;
+    };
+    'Metadata': {
+        [key: string]: SerializedImportedMetadataCollection;
+    };
+}
+/** @ignore until spreadsheet integration is ready for launch */
+export interface SerializedImportedDataSource {
+    'Properties': SerializedDataSourceProperties;
+    'Collections': SerializedImportedCollection[];
+}

package/sdk/index.d.ts

@@ -7,9 +7,9 @@ export * from './core/cardintegration/lucidcardintegration';
 export * from './core/cardintegration/lucidcardintegrationregistry';
 export * from './core/checks';
 export * from './core/data/datasource/datasourcetype';
-export * from './core/data/datasource/importedtempdatasource';
 export * from './core/data/datasource/metadatatypes';
 export * from './core/data/datasource/serializeddatasourceproperties';
+export * from './core/data/datasource/serializedimporteddatasource';
 export * from './core/data/datasource/serializedupstreamconfig';
 export * from './core/data/datasource/upstreampatchtype';
 export * from './core/data/datasource/upstreamupdatetype';

package/sdk/index.js

@@ -23,9 +23,9 @@ __exportStar(require("./core/cardintegration/lucidcardintegration"), exports);
 __exportStar(require("./core/cardintegration/lucidcardintegrationregistry"), exports);
 __exportStar(require("./core/checks"), exports);
 __exportStar(require("./core/data/datasource/datasourcetype"), exports);
-__exportStar(require("./core/data/datasource/importedtempdatasource"), exports);
 __exportStar(require("./core/data/datasource/metadatatypes"), exports);
 __exportStar(require("./core/data/datasource/serializeddatasourceproperties"), exports);
+__exportStar(require("./core/data/datasource/serializedimporteddatasource"), exports);
 __exportStar(require("./core/data/datasource/serializedupstreamconfig"), exports);
 __exportStar(require("./core/data/datasource/upstreampatchtype"), exports);
 __exportStar(require("./core/data/datasource/upstreamupdatetype"), exports);

package/sdk/core/data/datasource/importedtempdatasource.d.ts

@@ -1,24 +0,0 @@
-import { SerializedDataItems } from '../serializedfield/serializeddataitems';
-import { SerializedSchema } from '../serializedfield/serializedschema';
-import { SerializedDataSourceProperties } from './serializeddatasourceproperties';
-/** @ignore until spreadsheet integration is ready for launch */
-export interface ImportedTempMetadataCollection {
-    name: string;
-    schema: SerializedSchema;
-    items: SerializedDataItems;
-}
-/** @ignore until spreadsheet integration is ready for launch */
-export interface ImportedTempCollection {
-    name: string;
-    schema: SerializedSchema;
-    items: SerializedDataItems;
-    upstreamConfig: {
-        [key: string]: any;
-    };
-    metadata: Map<string, ImportedTempMetadataCollection>;
-}
-/** @ignore until spreadsheet integration is ready for launch */
-export interface ImportedTempDataSource {
-    properties: SerializedDataSourceProperties;
-    collections: Map<string, ImportedTempCollection>;
-}