lucid-extension-sdk 0.0.242 → 0.0.244

package/commandtypes.d.ts

@@ -20,7 +20,9 @@ import { PanelLocation } from './ui/panel';
  *
  * To use these directly, use [EditorClient.sendCommand](#classes_editorclient-EditorClient_sendcommand).
  *
- * IMPORTANT - Before you add a new command bring it up in #api-committee to get feedback
+ * FOR DEVELOPERS AT LUCID:
+ * Follow this guide to add new commands: https://lucidatlassian.atlassian.net/wiki/x/3AA3Xww
+ * Before you add a new command bring it up in #api-committee to get feedback.
  */
 export declare const enum CommandName {
     AddCardIntegration = "aci",
@@ -697,6 +699,13 @@ export type AddCardIntegrationQuery = {
         /** OnSetup action */
         'os'?: string | undefined;
     } | undefined;
+    /** If specified, custom import modal via iframe url */
+    'cim'?: {
+        'su': string;
+        'w': number;
+        'h': number;
+        'i': string;
+    };
     /** If specified, add-card settings */
     'ac'?: {
         /** Get input fields action */

package/core/cardintegration/lucidcardintegration.d.ts

@@ -4,6 +4,7 @@ import { DataSourceProxy } from '../../data/datasourceproxy';
 import { TextStyle } from '../../document/text/textstyle';
 import { EditorClient } from '../../editorclient';
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
+import { JsonSerializable } from '../jsonserializable';
 import { CardIntegrationConfig } from './cardintegrationconfig';
 import { ExtensionCardFieldDefinition } from './cardintegrationdefinitions';
 /**
@@ -122,6 +123,31 @@ export declare abstract class LucidCardIntegration {
         import: (primaryKeys: string[], searchFields: Map<string, SerializedFieldType>) => Promise<ImportResult>;
         onSetup?: () => Promise<void>;
     };
+    /**
+     * If specified, allow the user to import cards using a custom card-import modal.
+     *
+     * srcUrl:
+     * The url to be displayed in an iframe. This can either be a public url, or a local
+     * file located in the public folder of your packages root directory.
+     *
+     * width:
+     * The width of the iframe. The maximum width is 1344px.
+     *
+     * height:
+     * The height of the iframe. The maximum height is 1000px.
+     *
+     * import:
+     * Imports the items selected from you custom iframe. You can pass in whatever data is needed to import the items
+     * through you data-connector. The data must be of type JsonSerializable. Return the collection created and the
+     * primary keys of the items that were imported.
+     *
+     */
+    customImportModal?: {
+        srcUrl: string;
+        width: number;
+        height: number;
+        import: (data: JsonSerializable) => Promise<ImportResult>;
+    };
     /**
      * If specified, allow the user to create new cards and convert other shapes to cards
      */

package/core/cardintegration/lucidcardintegrationdefinitions.d.ts

@@ -1,4 +1,5 @@
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
+import { JsonSerializable } from '../jsonserializable';
 /** @ignore */
 export interface GetFieldsParam {
     'd': string;
@@ -26,6 +27,10 @@ export interface ImportParam {
     's': [string, SerializedFieldType][];
 }
 /** @ignore */
+export interface CustomImportParam {
+    'd': JsonSerializable;
+}
+/** @ignore */
 export interface GetInputFieldsParam {
     'i': [string, SerializedFieldType][];
 }

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -108,6 +108,22 @@ class LucidCardIntegrationRegistry {
                 });
             }
         }
+        if (cardIntegration.customImportModal) {
+            const customImportModal = cardIntegration.customImportModal;
+            serialized['cim'] = {
+                'su': customImportModal.srcUrl,
+                'w': customImportModal.width,
+                'h': customImportModal.height,
+                'i': LucidCardIntegrationRegistry.nextHookName(),
+            };
+            client.registerAction(serialized['cim']['i'], async ({ 'd': data }) => {
+                const result = await customImportModal.import(data);
+                return {
+                    'c': result.collection.id,
+                    'pks': result.primaryKeys,
+                };
+            });
+        }
         if (cardIntegration.addCard) {
             const addCard = cardIntegration.addCard;
             serialized['ac'] = {

package/package.json

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