lucid-extension-sdk 0.0.344 → 0.0.346

package/commandtypes.d.ts

@@ -778,6 +778,11 @@ export type AddCardIntegrationQuery = {
     } | undefined;
     /** Whether to enable dependency mapping for this integration */
     'sdm'?: boolean;
+    /**
+     * Import dependencies action
+     * Inconsistent naming convention, to avoid calling this "ID"
+     */
+    'idep'?: string | undefined;
     /** Icons to display throughout the card integration */
     'icu'?: {
         /** Primary Icon Url */

package/core/cardintegration/cardfielddisplaysettings.d.ts

@@ -35,6 +35,10 @@ export declare enum FieldDisplayType {
     DateBadge = "DateBadge",
     /** Given an object containing iconUrl (optional) and name (optional), determine whether
      * to display as an ImageBadge or InitializedString (or nothing, if neither is present).
+     *
+     * If FF LucidCardUIRefresh ON:
+     * Given or string of name or an object containing iconUrl and name, display as
+     * an as a full name or an ImageBadge with full name (if name is present).
      */
     UserProfile = "UserProfile"
 }

package/core/cardintegration/cardfielddisplaysettings.js

@@ -39,6 +39,10 @@ var FieldDisplayType;
     FieldDisplayType["DateBadge"] = "DateBadge";
     /** Given an object containing iconUrl (optional) and name (optional), determine whether
      * to display as an ImageBadge or InitializedString (or nothing, if neither is present).
+     *
+     * If FF LucidCardUIRefresh ON:
+     * Given or string of name or an object containing iconUrl and name, display as
+     * an as a full name or an ImageBadge with full name (if name is present).
      */
     FieldDisplayType["UserProfile"] = "UserProfile";
 })(FieldDisplayType || (exports.FieldDisplayType = FieldDisplayType = {}));

package/core/cardintegration/cardintegrationdefinitions.d.ts

@@ -1,3 +1,6 @@
+import { CollectionDefinition } from '../../data/collectiondefinition';
+import { CollectionProxy } from '../../data/collectionproxy';
+import { DataItemProxy } from '../../data/dataitemproxy';
 import { FieldDefinition } from '../../data/schemadefinition';
 import { isString } from '../checks';
 import { isSerializedFieldTypeDefinition } from '../data/fieldtypedefinition/fieldtypedefinition';
@@ -117,3 +120,26 @@ export declare const isSerializedExtensionCardFieldDefinition: (subject: unknown
 export declare function deserializeCardFieldDefinition(field: SerializedExtensionCardFieldDefinition): ExtensionCardFieldDefinition;
 /** @ignore */
 export declare function deserializeCardFieldArrayDefinition(fields: SerializedExtensionCardFieldDefinition[]): ExtensionCardFieldDefinition[];
+/**
+ * Result of searching for data in the import modal
+ */
+export interface SearchResult {
+    partialImportMetadata?: {
+        collectionId: string;
+        syncDataSourceId?: string;
+    };
+    data: CollectionDefinition;
+    fields: ExtensionCardFieldDefinition[];
+}
+/**
+ * Result of importing data from the import modal or dependency mapping
+ */
+export interface ImportResult {
+    collection: CollectionProxy;
+    primaryKeys: string[];
+}
+/**
+ * Maps a DataItemProxy of an item that was already imported
+ * to a list of primary keys for items that the original item has a relationship with.
+ */
+export type DependenciesForItems = Map<DataItemProxy, string[]>;

package/core/cardintegration/lucidcardintegration.d.ts

@@ -4,11 +4,11 @@ import { TextStyle } from '../../document/text/textstyle';
 import { EditorClient } from '../../editorclient';
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
 import { CardIntegrationConfig } from './cardintegrationconfig';
-import { ExtensionCardFieldDefinition } from './cardintegrationdefinitions';
+import { DependenciesForItems, ExtensionCardFieldDefinition, ImportResult } from './cardintegrationdefinitions';
 import { DependencyMappingPhrasesType } from './dependencymappingphrases';
 import { LucidCardIntegrationCustomImportModal } from './lucidcardintegrationcustomimportmodal';
 import { LucidCardIntegrationStandardImportModal } from './lucidcardintegrationstandardimportmodal';
-export { ImportResult, SearchResult } from './lucidcardintegrationstandardimportmodal';
+export { ImportResult, SearchResult } from './cardintegrationdefinitions';
 export declare abstract class LucidCardIntegration {
     protected readonly client: EditorClient;
     constructor(client: EditorClient);
@@ -114,6 +114,10 @@ export declare abstract class LucidCardIntegration {
     };
     showCardImport(name: string): import("../../commandtypes").ImportCardsResult;
     showDependencyMapping?: boolean;
+    /**
+     * This allows the user to import cards, by selecting dependencies of a linked item on the canvas.
+     */
+    importDependencies?: (dependenciesForItems: DependenciesForItems) => Promise<ImportResult[]>;
     /**
      * 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.

package/core/cardintegration/lucidcardintegrationdefinitions.d.ts

@@ -27,6 +27,16 @@ export interface ImportParam {
     's': [string, SerializedFieldType][];
 }
 /** @ignore */
+interface DependenciesForItemParam {
+    'oci': string;
+    'opk': string;
+    'pks': string[];
+}
+/** @ignore */
+export interface DependenciesForItemsParam {
+    'dfi': DependenciesForItemParam[];
+}
+/** @ignore */
 export interface CustomImportParam {
     'd': JsonSerializable;
 }
@@ -60,3 +70,4 @@ export interface DependencyMappingNoDependencyHeadingParam {
 export interface DependencyMappingSelectedIssueHeadingParam {
     'k': string;
 }
+export {};

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LucidCardIntegrationRegistry = void 0;
 const collectiondefinition_1 = require("../../data/collectiondefinition");
+const collectionproxy_1 = require("../../data/collectionproxy");
+const dataitemproxy_1 = require("../../data/dataitemproxy");
 const datasourceproxy_1 = require("../../data/datasourceproxy");
 const cardintegrationconfig_1 = require("./cardintegrationconfig");
 const cardintegrationdefinitions_1 = require("./cardintegrationdefinitions");
@@ -103,6 +105,26 @@ class LucidCardIntegrationRegistry {
                     : undefined,
             };
         }
+        if (cardIntegration.importDependencies) {
+            const importDependencies = cardIntegration.importDependencies;
+            const importDependenciesActionName = LucidCardIntegrationRegistry.nextHookName();
+            serialized['idep'] = importDependenciesActionName;
+            client.registerAction(importDependenciesActionName, async ({ 'dfi': serializedDependenciesForItems }) => {
+                const proxiedDependenciesForItems = new Map(serializedDependenciesForItems.map((_) => {
+                    const collectionProxy = new collectionproxy_1.CollectionProxy(_.oci, client);
+                    const originalItemProxy = new dataitemproxy_1.DataItemProxy(_.opk, collectionProxy, client);
+                    return [originalItemProxy, _.pks];
+                }));
+                const proxiedResults = await importDependencies(proxiedDependenciesForItems);
+                const results = proxiedResults.map((result) => {
+                    return {
+                        'c': result.collection.id,
+                        'pks': result.primaryKeys,
+                    };
+                });
+                return results;
+            });
+        }
         return serialized;
     }
     /**

package/core/cardintegration/lucidcardintegrationstandardimportmodal.d.ts

@@ -1,7 +1,5 @@
-import { CollectionDefinition } from '../../data/collectiondefinition';
-import { CollectionProxy } from '../../data/collectionproxy';
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
-import { ExtensionCardFieldDefinition } from './cardintegrationdefinitions';
+import { ExtensionCardFieldDefinition, ImportResult, SearchResult } from './cardintegrationdefinitions';
 /**
  * You can use the standard import modal can be used by providing the following data:
  *
@@ -43,21 +41,3 @@ export interface LucidCardIntegrationStandardImportModal {
     import: (primaryKeys: string[], searchFields: Map<string, SerializedFieldType>) => Promise<ImportResult>;
     onSetup?: () => Promise<void>;
 }
-/**
- * Result of searching for data in the import modal
- */
-export interface SearchResult {
-    partialImportMetadata?: {
-        collectionId: string;
-        syncDataSourceId?: string;
-    };
-    data: CollectionDefinition;
-    fields: ExtensionCardFieldDefinition[];
-}
-/**
- * Result of importing data from  the import modal
- */
-export interface ImportResult {
-    collection: CollectionProxy;
-    primaryKeys: string[];
-}

package/package.json

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