lucid-extension-sdk 0.0.362 → 0.0.364

package/commandtypes.d.ts

@@ -718,6 +718,12 @@ export type AddAuthorizationFlowHandlerQuery = {
     's': AuthorizationFlowHandlerStage;
 };
 export type AddAuthorizationFlowHandlerResult = undefined;
+export type AddCardsActions = {
+    /** Get input fields action */
+    'gif': string;
+    /** Create card action */
+    'cc': string;
+};
 export type AddCardIntegrationQuery = {
     /** Title/name */
     'n': string;
@@ -770,12 +776,7 @@ export type AddCardIntegrationQuery = {
         'sh': string;
     } | undefined;
     /** If specified, add-card settings */
-    'ac'?: {
-        /** Get input fields action */
-        'gif': string;
-        /** Create card action */
-        'cc': string;
-    } | undefined;
+    'ac'?: AddCardsActions | undefined;
     /** Whether to enable dependency mapping for this integration */
     'sdm'?: boolean;
     /**
@@ -982,6 +983,8 @@ export type AddSpreadsheetIntegrationQuery = {
     'c'?: boolean;
     /** getUpstreamSourceUrl */
     'gu'?: string;
+    /** If specified, add-card settings */
+    'ac'?: AddCardsActions | undefined;
 };
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export type AddSpreadsheetIntegrationResult = undefined;

package/core/cardintegration/lucidcardintegration.d.ts

@@ -3,8 +3,8 @@ import { DataSourceProxy } from '../../data/datasourceproxy';
 import { TextStyle } from '../../document/text/textstyle';
 import { EditorClient } from '../../editorclient';
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
+import { DependenciesForItems, ExtensionCardFieldDefinition, ImportResult } from '../sharedcardintegration/cardintegrationdefinitions';
 import { CardIntegrationConfig } from './cardintegrationconfig';
-import { DependenciesForItems, ExtensionCardFieldDefinition, ImportResult } from './cardintegrationdefinitions';
 import { DependencyMappingPhrasesType } from './dependencymappingphrases';
 import { LucidCardIntegrationCustomImportModal } from './lucidcardintegrationcustomimportmodal';
 import { LucidCardIntegrationStandardImportModal } from './lucidcardintegrationstandardimportmodal';

package/core/cardintegration/lucidcardintegrationregistry.d.ts

@@ -1,6 +1,6 @@
 import { EditorClient } from '../../editorclient';
 import { SerializedFieldType } from '../data/serializedfield/serializedfields';
-import { ExtensionCardFieldOption, ExtensionCardUserData } from './cardintegrationdefinitions';
+import { ExtensionCardFieldOption, ExtensionCardUserData } from '../sharedcardintegration/cardintegrationdefinitions';
 import { LucidCardIntegration } from './lucidcardintegration';
 export declare class LucidCardIntegrationRegistry {
     private static nextHookId;
@@ -9,6 +9,7 @@ export declare class LucidCardIntegrationRegistry {
     static registerFieldSearchCallback(client: EditorClient, callback: (searchText: string, inputSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldOption[]>): string;
     static registerUserSearchCallback(client: EditorClient, callback: (searchText: string, inputSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardUserData[]>): string;
     private static registerDependencyMapping;
+    private static serializeSearchResult;
     /**
      * Register a card integration.
      */

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -6,8 +6,8 @@ const collectionproxy_1 = require("../../data/collectionproxy");
 const dataitemproxy_1 = require("../../data/dataitemproxy");
 const datasourceproxy_1 = require("../../data/datasourceproxy");
 const checks_1 = require("../checks");
+const cardintegrationdefinitions_1 = require("../sharedcardintegration/cardintegrationdefinitions");
 const cardintegrationconfig_1 = require("./cardintegrationconfig");
-const cardintegrationdefinitions_1 = require("./cardintegrationdefinitions");
 const lucidcardintegrationcustomimportmodal_1 = require("./lucidcardintegrationcustomimportmodal");
 class LucidCardIntegrationRegistry {
     static nextHookName() {
@@ -128,6 +128,16 @@ class LucidCardIntegrationRegistry {
         }
         return serialized;
     }
+    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,
+            },
+        };
+    }
     /**
      * Register a card integration.
      */
@@ -209,14 +219,14 @@ class LucidCardIntegrationRegistry {
                 });
                 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,
-                        },
-                    };
+                    if ((0, checks_1.isArray)(result)) {
+                        return result.map((searchResult) => {
+                            return this.serializeSearchResult(searchResult);
+                        });
+                    }
+                    else {
+                        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 './cardintegrationdefinitions';
+import { ExtensionCardFieldDefinition, ImportResult, SearchResult } from '../sharedcardintegration/cardintegrationdefinitions';
 /**
  * You can use the standard import modal can be used by providing the following data:
  *
@@ -37,7 +37,7 @@ export interface LucidCardIntegrationStandardImportModal {
     importModalHeading?: string;
     useIsolatedSearchBarUI?: boolean;
     getSearchFields: (searchSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
-    search: (fields: Map<string, SerializedFieldType>) => Promise<SearchResult>;
+    search: (fields: Map<string, SerializedFieldType>) => Promise<SearchResult | SearchResult[]>;
     import: (primaryKeys: string[], searchFields: Map<string, SerializedFieldType>) => Promise<ImportResult | ImportResult[]>;
     onSetup?: () => Promise<void>;
 }

package/core/{cardintegration → sharedcardintegration}/cardintegrationdefinitions.d.ts

@@ -122,6 +122,10 @@ export declare function deserializeCardFieldDefinition(field: SerializedExtensio
 export declare function deserializeCardFieldArrayDefinition(fields: SerializedExtensionCardFieldDefinition[]): 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.
+ *
  */
 export interface SearchResult {
     partialImportMetadata?: {

package/core/spreadsheetintegration/lucidspreadsheetintegration.d.ts

@@ -1,6 +1,9 @@
+import { CollectionProxy } from '../../data/collectionproxy';
 import { SerializedUpstreamConfig } from '../data/datasource/serializedupstreamconfig';
+import { SerializedFieldType } from '../data/serializedfield/serializedfields';
 import { SerializedSchema } from '../data/serializedfield/serializedschema';
 import { JsonSerializable } from '../jsonserializable';
+import { ExtensionCardFieldDefinition } from '../sharedcardintegration/cardintegrationdefinitions';
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export declare enum LucidSpreadsheetIntegrationFailureType {
     AuthorizationFailure = "AuthorizationFailure",
@@ -77,4 +80,22 @@ export declare abstract class LucidSpreadsheetIntegration {
     getUpstreamSourceUrl?(spreadsheetDetails: string, sheetId: string): Promise<{
         url: string;
     } | LucidSpreadsheetIntegrationFailureType>;
+    /**
+     * If specified, allow the user to create new cards and convert other shapes to cards
+     */
+    addCard?: {
+        /**
+         * Given the values entered by the user so far into input fields, return the list of all input fields
+         * to display in the create-card form.
+         */
+        getInputFields: (inputSoFar: Map<string, SerializedFieldType>) => Promise<ExtensionCardFieldDefinition[]>;
+        /**
+         * Given the values entered by the user into input fields, create a new data record to represent the
+         * created card, and return information about that record.
+         */
+        createCardData: (input: Map<string, SerializedFieldType>) => Promise<{
+            collection: CollectionProxy;
+            primaryKey: string;
+        }>;
+    };
 }

package/core/spreadsheetintegration/lucidspreadsheetintegrationregistry.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LucidSpreadsheetIntegrationRegistry = void 0;
 const checks_1 = require("../checks");
+const cardintegrationdefinitions_1 = require("../sharedcardintegration/cardintegrationdefinitions");
 const lucidspreadsheetintegration_1 = require("./lucidspreadsheetintegration");
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 class LucidSpreadsheetIntegrationRegistry {
@@ -73,6 +74,24 @@ class LucidSpreadsheetIntegrationRegistry {
                 'di': spreadsheetIntegration.iconConfiguration.darkIconUrl,
             };
         }
+        if (spreadsheetIntegration.addCard) {
+            const addCard = spreadsheetIntegration.addCard;
+            serialized['ac'] = {
+                'gif': LucidSpreadsheetIntegrationRegistry.nextHookName(),
+                'cc': LucidSpreadsheetIntegrationRegistry.nextHookName(),
+            };
+            client.registerAction(serialized['ac']['gif'], async ({ 'i': inputSoFar }) => {
+                const result = await addCard.getInputFields(new Map(inputSoFar));
+                return (0, cardintegrationdefinitions_1.serializeCardFieldArrayDefinition)(result);
+            });
+            client.registerAction(serialized['ac']['cc'], async ({ 'i': input }) => {
+                const result = await addCard.createCardData(new Map(input));
+                return {
+                    'c': result.collection.id,
+                    'pk': result.primaryKey,
+                };
+            });
+        }
         if (spreadsheetIntegration.getUpstreamSourceUrl) {
             const getUpstreamSourceUrl = LucidSpreadsheetIntegrationRegistry.nextHookName();
             client.registerAction(getUpstreamSourceUrl, async (message) => {

package/index.d.ts

@@ -2,7 +2,6 @@ export * from './commandtypes';
 export * from './core/base64';
 export * from './core/cardintegration/cardfielddisplaysettings';
 export * from './core/cardintegration/cardintegrationconfig';
-export * from './core/cardintegration/cardintegrationdefinitions';
 export * from './core/cardintegration/lucidcardintegration';
 export * from './core/cardintegration/lucidcardintegrationregistry';
 export * from './core/checks';
@@ -50,6 +49,7 @@ export * from './core/rules/conditiontype';
 export * from './core/rules/serializedeffect';
 export * from './core/serializeddataerror';
 export * from './core/shapedatainheritance';
+export * from './core/sharedcardintegration/cardintegrationdefinitions';
 export * from './core/spreadsheetintegration/lucidspreadsheetintegration';
 export * from './core/spreadsheetintegration/lucidspreadsheetintegrationregistry';
 export * from './core/unfurl/unfurlcallbacks';

package/index.js

@@ -18,7 +18,6 @@ __exportStar(require("./commandtypes"), exports);
 __exportStar(require("./core/base64"), exports);
 __exportStar(require("./core/cardintegration/cardfielddisplaysettings"), exports);
 __exportStar(require("./core/cardintegration/cardintegrationconfig"), exports);
-__exportStar(require("./core/cardintegration/cardintegrationdefinitions"), exports);
 __exportStar(require("./core/cardintegration/lucidcardintegration"), exports);
 __exportStar(require("./core/cardintegration/lucidcardintegrationregistry"), exports);
 __exportStar(require("./core/checks"), exports);
@@ -66,6 +65,7 @@ __exportStar(require("./core/rules/conditiontype"), exports);
 __exportStar(require("./core/rules/serializedeffect"), exports);
 __exportStar(require("./core/serializeddataerror"), exports);
 __exportStar(require("./core/shapedatainheritance"), exports);
+__exportStar(require("./core/sharedcardintegration/cardintegrationdefinitions"), exports);
 __exportStar(require("./core/spreadsheetintegration/lucidspreadsheetintegration"), exports);
 __exportStar(require("./core/spreadsheetintegration/lucidspreadsheetintegrationregistry"), exports);
 __exportStar(require("./core/unfurl/unfurlcallbacks"), exports);

package/package.json

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