lucid-extension-sdk 0.0.86 → 0.0.87

package/package.json

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

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

@@ -51,28 +51,39 @@ export declare abstract class TaskManagementCardIntegration {
     abstract getDefaultConfig: (collection: CollectionProxy) => Promise<CardIntegrationConfig>;
     /**
      * If specified, allow the user to import cards using the standard card-import modal.
+     *
+     * getSearchFields:
+     * Given the values entered by the user so far into search fields, return the list of all search fields
+     * to display in the search form.
+     *
+     * search:
+     * Given values entered by the user into the search fields so far, return a collection of data to
+     * display in the results table. If partialImportMetadata is also returned, it will be used to create the tasks cards before
+     * the import is completed—which allows users to interact with the cards while the
+     * data is fetched asynchronously. The collectionId needs to match the id that will be
+     * returned from the completed import. The syncDataSourceId needs to match the
+     * syncDataSourceId that is passed into performDataAction.
+     * The last requirement for the partial import to work is that the primary keys in the data also
+     * returned in this search need to match the primary keys that will be returned
+     * on import.
+     *
+     * import:
+     * The user checked the boxes beside the given list of items in the collection returned from search().
+     * Import them, and return the collection and primary keys in that final collection that were imported.
+     *
+     * The config provided here is only used on the first import from a given source; on subsequent imports,
+     * the existing config will remain unchanged to preserve any customizations by the user.
      */
     abstract importModal?: {
-        /**
-         * Given the values entered by the user so far into search fields, return the list of all search fields
-         * to display in the search form.
-         */
         getSearchFields: (searchSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
-        /**
-         * Given values entered by the user into the search fields so far, return a collection of data to
-         * display in the results table.
-         */
         search: (fields: Map<string, SerializedFieldType>) => Promise<{
+            partialImportMetadata?: {
+                collectionId: string;
+                syncDataSourceId?: string;
+            };
             data: CollectionDefinition;
             fields: ExtensionCardFieldDefinition[];
         }>;
-        /**
-         * The user checked the boxes beside the given list of items in the collection returned from search().
-         * Import them, and return the collection and primary keys in that final collection that were imported.
-         *
-         * The config provided here is only used on the first import from a given source; on subsequent imports,
-         * the existing config will remain unchanged to preserve any customizations by the user.
-         */
         import: (primaryKeys: string[], searchFields: Map<string, SerializedFieldType>) => Promise<{
             collection: CollectionProxy;
             primaryKeys: string[];

package/sdk/core/cardintegration/taskmangementcardregistry.js

@@ -79,11 +79,15 @@ class TaskManagementCardRegistry {
                 const result = await importModal.getSearchFields(new Map(searchSoFar));
                 return (0, cardintegrationdefinitions_1.serializeCardFieldArrayDefinition)(result);
             });
-            client.registerAction(serialized['im']['s'], async ({ 's': search }) => {
-                const result = await importModal.search(new Map(search));
+            client.registerAction(serialized['im']['s'], async ({ 's': param }) => {
+                const result = await importModal.search(new Map(param));
                 return {
                     'd': (0, collectiondefinition_1.serializeCollectionDefinition)(result.data),
                     'f': (0, cardintegrationdefinitions_1.serializeCardFieldArrayDefinition)(result.fields),
+                    'm': result.partialImportMetadata && {
+                        'cid': result.partialImportMetadata.collectionId,
+                        'sid': result.partialImportMetadata.syncDataSourceId,
+                    },
                 };
             });
             client.registerAction(serialized['im']['i'], async ({ 'pks': primaryKeys, 's': searchFields }) => {

package/sdk/core/data/referencekeys/serializedreferencekey.d.ts

@@ -1,4 +1,4 @@
-import { SerializedFieldType } from '../serializedfield/serializedfields';
+import { SerializedFields, SerializedFieldType } from '../serializedfield/serializedfields';
 import { SerializedSchema } from '../serializedfield/serializedschema';
 export declare const FlattenedReferenceKeyId = "192d0e9f-2f5a-4032-9f03-59bbf1ea5891";
 export declare const FlattenedReferenceKeyName = "192d0e9f-2f5a-4032-9f03-59bbf1ea5891_n";
@@ -7,6 +7,12 @@ export interface SerializedReferenceKey {
     'pk': string;
     'wl'?: string[];
     'ro'?: boolean;
+    'f'?: {
+        'ts': number;
+        'pd': TypedSerializedFlattenedReference;
+        'md'?: SerializedFields;
+        'e'?: string;
+    };
 }
 export declare type TypedSerializedFlattenedReference = {
     'sc': SerializedSchema;

package/sdk/core/data/serializedfield/serializedfielddefinition.d.ts

@@ -6,7 +6,7 @@ export declare type SerializedFieldDefinition = {
     'Type': SerializedFieldTypeDefinition;
     'Constraints'?: SerializedFieldConstraint[];
     'SyncSchema'?: string;
-    'Mapping'?: SemanticKind[];
+    'Mapping'?: readonly SemanticKind[];
 };
 export declare enum FieldConstraintType {
     REQUIRED = "required",

package/sdk/data/collectionproxy.js

@@ -65,6 +65,7 @@ class CollectionProxy extends propertystoreproxy_1.PropertyStoreProxy {
         return this.client.sendCommand("lcf" /* CommandName.ListCollectionFields */, { 'id': this.id });
     }
     getSchema() {
+        // we wave to cast as unknown because of readonly being used in the type
         return (0, schemadefinition_1.parseSchemaDefinition)(this.properties.get('Schema'));
     }
 }

package/sdk/data/schemadefinition.d.ts

@@ -1,5 +1,6 @@
 import { isNumber, isUndefined } from '../core/checks';
 import { FieldTypeDefinition } from '../core/data/fieldtypedefinition/fieldtypedefinition';
+import { SemanticKind } from '../core/data/fieldtypedefinition/semantickind';
 import { FieldConstraintType, SerializedFieldConstraint, SerializedFieldDefinition } from '../core/data/serializedfield/serializedfielddefinition';
 import { SerializedSchema } from '../core/data/serializedfield/serializedschema';
 export interface RequiredFieldConstraintDefinition {
@@ -46,6 +47,7 @@ export interface FieldDefinition {
     name: string;
     type: FieldTypeDefinition;
     constraints?: FieldConstraintDefinition[];
+    mapping?: readonly SemanticKind[];
 }
 /**
  * Definition of a schema for creating a [Collection](#classes_data_collectionproxy-CollectionProxy)

package/sdk/data/schemadefinition.js

@@ -29,6 +29,9 @@ function serializeFieldDefinition(field) {
     if (field.constraints) {
         serialized['Constraints'] = field.constraints.map(serializeFieldConstraintDefinition);
     }
+    if (field.mapping) {
+        serialized['Mapping'] = field.mapping;
+    }
     return serialized;
 }
 exports.serializeFieldDefinition = serializeFieldDefinition;
@@ -64,6 +67,7 @@ function parseFieldDefinition(field) {
                     throw new Error('Invalid constraint format');
             }
         }),
+        mapping: field['Mapping'],
     };
 }
 exports.parseFieldDefinition = parseFieldDefinition;