lucid-extension-sdk 0.0.410 → 0.0.412

package/core/cardintegration/cardintegrationparams.d.ts

@@ -20,6 +20,8 @@ export interface GetSearchFieldsParam {
 /** @ignore */
 export interface SearchParam {
     's': [string, SerializedFieldType][];
+    'o': number;
+    'l': number;
 }
 /** @ignore */
 export interface ImportParam {

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -163,12 +163,15 @@ class LucidCardIntegrationRegistry {
     }
     static serializeSearchResult(searchResult) {
         return {
-            'd': (0, collectiondefinition_1.serializeCollectionDefinition)(searchResult.data),
-            'f': (0, cardintegrationdefinitions_1.serializeCardFieldArrayDefinition)(searchResult.fields),
-            'm': searchResult.partialImportMetadata && {
-                'cid': searchResult.partialImportMetadata.collectionId,
-                'sid': searchResult.partialImportMetadata.syncDataSourceId,
-            },
+            '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,
         };
     }
     static registerImportCardFromPastedLinkHandler(client, cardIntegration, serialized) {
@@ -281,16 +284,21 @@ class LucidCardIntegrationRegistry {
                     const result = await importModal.getSearchFields(new Map(searchSoFar));
                     return (0, cardintegrationdefinitions_1.serializeCardFieldArrayDefinition)(result);
                 });
-                client.registerAction(serialized['im']['s'], async ({ 's': param }) => {
-                    const result = await importModal.search(new Map(param));
-                    if ((0, checks_1.isArray)(result)) {
-                        return result.map((searchResult) => {
-                            return this.serializeSearchResult(searchResult);
-                        });
-                    }
-                    else {
-                        return this.serializeSearchResult(result);
+                client.registerAction(serialized['im']['s'], async ({ 's': param, 'o': offset, 'l': limit }) => {
+                    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({
+                                searchResults: result,
+                            });
+                        }
+                        else {
+                            return this.serializeSearchResult({
+                                searchResults: [result],
+                            });
+                        }
                     }
+                    return this.serializeSearchResult(result);
                 });
                 client.registerAction(serialized['im']['i'], async ({ 'pks': primaryKeys, 's': searchFields }) => {
                     const result = await importModal.import(primaryKeys, new Map(searchFields));

package/core/cardintegration/lucidcardintegrationstandardimportmodal.d.ts

@@ -1,5 +1,5 @@
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
-import { ExtensionCardFieldDefinition, ImportResult, SearchResult } from '../sharedcardintegration/cardintegrationdefinitions';
+import { DeprecatedSearchResult, ExtensionCardFieldDefinition, ImportResult, SearchResult } from '../sharedcardintegration/cardintegrationdefinitions';
 import { ExtensionImportModalWidthBreakpoint } from './extensionimportmodalwidthbreakpoint';
 /**
  * You can use the standard import modal can be used by providing the following data:
@@ -18,6 +18,14 @@ import { ExtensionImportModalWidthBreakpoint } from './extensionimportmodalwidth
  * 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.
+ * Offset and limit are used for pagination. The offset is the number of items to skip and the limit
+ * is the maximum number of items to return. To use pagination, you have to return `totalNumberOfItems` field in
+ * the `SearchResult`.
+ * Note: When using pagination and returning a `SearchResult` array:
+ *          - The `totalNumberOfItems` in each `SearchResult` represents the total number of items
+ *            for the specific workspace associated with that `SearchResult`.
+ *          - The length of the `SearchResult` array must remain consistent across all pages of the search.
+ *
  *
  * import:
  * The user checked the boxes beside the given list of items in the collection returned from search().
@@ -39,7 +47,7 @@ export interface LucidCardIntegrationStandardImportModal {
     useIsolatedSearchBarUI?: boolean;
     maxModalWidth?: ExtensionImportModalWidthBreakpoint;
     getSearchFields: (searchSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
-    search: (fields: Map<string, SerializedFieldType>) => Promise<SearchResult | SearchResult[]>;
+    search: (fields: Map<string, SerializedFieldType>, offset?: number, limit?: number) => Promise<SearchResult | DeprecatedSearchResult | DeprecatedSearchResult[]>;
     import: (primaryKeys: string[], searchFields: Map<string, SerializedFieldType>) => Promise<ImportResult | ImportResult[]>;
     onSetup?: () => Promise<void>;
 }

package/core/data/datasource/semanticrelationships.d.ts

@@ -17,7 +17,8 @@ export declare enum SemanticRelationships {
     Clones = "Clones",
     IsClonedBy = "Is Cloned By",
     IsParentOf = "Is Parent Of",
-    IsChildOf = "Is Child Of"
+    IsChildOf = "Is Child Of",
+    Unknown = "Unknown"
 }
 export declare function getInverseSemanticRelationship(relationship: SemanticRelationships): SemanticRelationships;
 export declare const isSemanticRelationship: (x: unknown) => x is SemanticRelationships;

package/core/data/datasource/semanticrelationships.js

@@ -23,6 +23,7 @@ var SemanticRelationships;
     SemanticRelationships["IsClonedBy"] = "Is Cloned By";
     SemanticRelationships["IsParentOf"] = "Is Parent Of";
     SemanticRelationships["IsChildOf"] = "Is Child Of";
+    SemanticRelationships["Unknown"] = "Unknown";
 })(SemanticRelationships || (exports.SemanticRelationships = SemanticRelationships = {}));
 function getInverseSemanticRelationship(relationship) {
     switch (relationship) {

package/core/sharedcardintegration/cardintegrationdefinitions.d.ts

@@ -4,7 +4,7 @@ import { DataItemProxy } from '../../data/dataitemproxy';
 import { DataSourceProxy } from '../../data/datasourceproxy';
 import { FieldDefinition } from '../../data/schemadefinition';
 import { FieldDescriptor } from '../cardintegration/lucidcardintegration';
-import { isString } from '../checks';
+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';
@@ -105,7 +105,6 @@ export declare const isSerializedExtensionCardFieldDefinition: (subject: unknown
     Type: typeof isSerializedFieldTypeDefinition;
     Constraints: (x: unknown) => x is import("../guards").DestructureGuardedTypeObj<{
         Type: (x: unknown) => x is import("../data/serializedfield/serializedfielddefinition").FieldConstraintType;
-        /** If defined, the default value for this field */
         Details: (x: unknown) => x is any;
         Reason: (x: unknown) => x is string | null | undefined;
     }>[] | undefined;
@@ -124,14 +123,39 @@ export declare const isSerializedExtensionCardFieldDefinition: (subject: unknown
 export declare function deserializeCardFieldDefinition(field: SerializedExtensionCardFieldDefinition): ExtensionCardFieldDefinition;
 /** @ignore */
 export declare function deserializeCardFieldArrayDefinition(fields: SerializedExtensionCardFieldDefinition[]): ExtensionCardFieldDefinition[];
+export interface SearchResultPerCollection {
+    partialImportMetadata?: {
+        collectionId: string;
+        syncDataSourceId?: string;
+    };
+    data: CollectionDefinition;
+    fields: ExtensionCardFieldDefinition[];
+}
 /**
  * Result of searching for data in the import modal
  *
  * If you change this interface, check if your changes need to be synced with
  * editorextensioncardintegrationregistry.ts.
  *
+ * By specifying the itemsPerSearchResult, you can enable pagination for results in the import modal. The offset and limit
+ * parameters in the search function will tell you which page of results to return.
+ *
  */
 export interface SearchResult {
+    searchResults: SearchResultPerCollection[];
+    itemsPerSearchResult?: number | undefined;
+}
+export declare const isSearchResult: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
+    searchResults: typeof isArray;
+    itemsPerSearchResult: (x: unknown) => x is number | undefined;
+}>;
+/**
+ * @deprecated
+ * Deprecated version of SearchResult for backwards compatibility. Please use
+ * SearchResult instead.
+ * This will be removed in a future update.
+ */
+export interface DeprecatedSearchResult {
     partialImportMetadata?: {
         collectionId: string;
         syncDataSourceId?: string;

package/core/sharedcardintegration/cardintegrationdefinitions.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSerializedExtensionCardFieldLabelIcons = exports.deserializePlaceholderImportMetadata = exports.serializePlaceholderImportMetadata = exports.isSerializedPlaceholderImportMetadata = 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.isSerializedExtensionCardFieldLabelIcons = 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");
@@ -83,6 +83,10 @@ function deserializeCardFieldArrayDefinition(fields) {
     return fields.map(deserializeCardFieldDefinition);
 }
 exports.deserializeCardFieldArrayDefinition = deserializeCardFieldArrayDefinition;
+exports.isSearchResult = (0, validators_1.objectValidator)({
+    searchResults: checks_1.isArray,
+    itemsPerSearchResult: (0, validators_1.option)(checks_1.isNumber),
+});
 /** @ignore */
 exports.isSerializedPlaceholderImportMetadata = (0, validators_1.objectValidator)({
     'cid': checks_1.isString,

package/package.json

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