lucid-extension-sdk 0.0.426 → 0.0.428

package/commandtypes.d.ts

@@ -764,6 +764,8 @@ export type AddCardIntegrationQuery = {
     'ts'?: Partial<TextStyle> | undefined;
     /** Field configuration */
     'fc': SerializedFieldConfiguration;
+    /** Import from serialized fields callback */
+    'ifs'?: string | undefined;
     /** If we can only search for user by their name (and not email) in the card integration. */
     'subn'?: boolean | undefined;
     /** Callback to search for a user in the card integration */

package/core/cardintegration/cardintegrationparams.d.ts

@@ -1,4 +1,4 @@
-import { SerializedFieldType } from '../data/serializedfield/serializedfields';
+import { SerializedFieldType, SerializedFields } from '../data/serializedfield/serializedfields';
 import { UnsafeJsonSerializableOrUndefined } from '../jsonserializable';
 /** @ignore */
 export interface GetFieldsParam {
@@ -86,4 +86,8 @@ export interface FieldLabelIconsCallbackParam {
     'c': string;
     'p': string;
 }
+/** @ignore */
+export interface ImportFromSerializedFieldsCallbackParam {
+    'sf': SerializedFields[];
+}
 export {};

package/core/cardintegration/lucidcardintegration.d.ts

@@ -3,7 +3,8 @@ import { DataSourceProxy } from '../../data/datasourceproxy';
 import { TextStyle } from '../../document/text/textstyle';
 import { EditorClient } from '../../editorclient';
 import { isString } from '../checks';
-import { SerializedFieldType } from '../data/serializedfield/serializedfields';
+import { SerializedFieldType, SerializedFields } from '../data/serializedfield/serializedfields';
+import { ImportCardFromDetails } from '../importcardfromdetails/importcardfromdetails';
 import { ImportCardFromPastedLinkCallback } from '../importcardfrompastedlink/importcardfrompastedlinkcallback';
 import { DependenciesForItems, ExtensionCardFieldDefinition, ExtensionFieldConfiguration, ImportResult } from '../sharedcardintegration/cardintegrationdefinitions';
 import { CardIntegrationConfig } from './cardintegrationconfig';
@@ -136,4 +137,10 @@ export declare abstract class LucidCardIntegration {
         domain: string;
         callback: ImportCardFromPastedLinkCallback;
     };
+    /**
+     * If specified, allows users to import cards by copying a card on one board and pasting it to another board.
+     * This function should interface with `SerializedFields` to get the data from the copied card necessary to trigger
+     * the import.
+     */
+    importFromSerializedFields?: (data: SerializedFields[]) => Promise<ImportCardFromDetails>;
 }

package/core/cardintegration/lucidcardintegrationregistry.js

@@ -7,7 +7,7 @@ const dataitemproxy_1 = require("../../data/dataitemproxy");
 const datasourceproxy_1 = require("../../data/datasourceproxy");
 const importcardfrompastedlinkeventmessage_1 = require("../../message/importcardfrompastedlinkeventmessage");
 const checks_1 = require("../checks");
-const importcardfrompastedlinkdetails_1 = require("../importcardfrompastedlink/importcardfrompastedlinkdetails");
+const importcardfromdetails_1 = require("../importcardfromdetails/importcardfromdetails");
 const cardintegrationdefinitions_1 = require("../sharedcardintegration/cardintegrationdefinitions");
 const cardintegrationconfig_1 = require("./cardintegrationconfig");
 const lucidcardintegrationcustomimportmodal_1 = require("./lucidcardintegrationcustomimportmodal");
@@ -189,7 +189,7 @@ class LucidCardIntegrationRegistry {
                 const msg = (0, importcardfrompastedlinkeventmessage_1.deserializeImportCardFromPastedLinkEventMessage)(rawMsg);
                 const result = await callback(msg.url);
                 if (result) {
-                    return (0, importcardfrompastedlinkdetails_1.serializeImportCardFromPastedLinkDetails)(result);
+                    return (0, importcardfromdetails_1.serializeImportCardFromDetails)(result);
                 }
                 return undefined;
             }
@@ -350,6 +350,14 @@ class LucidCardIntegrationRegistry {
         }
         this.registerDependencyMapping(client, cardIntegration, serialized);
         this.registerImportCardFromPastedLinkHandler(client, cardIntegration, serialized);
+        if (cardIntegration.importFromSerializedFields) {
+            const importFromSerializedFields = cardIntegration.importFromSerializedFields;
+            serialized['ifs'] = LucidCardIntegrationRegistry.nextHookName();
+            client.registerAction(serialized['ifs'], async ({ 'sf': serializedFields }) => {
+                const result = await importFromSerializedFields(serializedFields);
+                return (0, importcardfromdetails_1.serializeImportCardFromDetails)(result);
+            });
+        }
         client.sendCommand("aci" /* CommandName.AddCardIntegration */, serialized);
     }
 }

package/core/importcardfromdetails/importcardfromdetails.d.ts

@@ -0,0 +1,50 @@
+import { isString } from '../checks';
+import { SerializedFieldType } from '../data/serializedfield/serializedfields';
+import { PlaceholderImportMetadata, SerializedPlaceholderImportMetadata } from '../sharedcardintegration/cardintegrationdefinitions';
+/**
+ * A definition of the details required to import a card into the editor from a pasted url or pasted card clipboard data.
+ */
+export interface ImportCardFromDetails {
+    /**
+     * A list of primary keys to import onto the canvas via your extension's import action.
+     *
+     * These should be formatted the same as primary keys on the document's collection. For example, numeric keys would
+     * be formatted as `['123']`, and string keys would be formatted inside double quotes `['"my-item"']`
+     */
+    primaryKeys: string[];
+    /**
+     * If `placeholderImportMetadataList` is provided, it is used to quickly splat a card on the canvas while waiting
+     * for the import action to finish, identical to how modal-based imports use search results to splat cards. Ensure
+     * that the schema of the `collectionDefinition` field in each placeholder import metadata is a subset of the
+     * collection that the imported cards will be added to.
+     */
+    placeholderImportMetadataList?: PlaceholderImportMetadata[] | undefined;
+    /**
+     * `importActionData` can be used to pass key-value pairs to your action. This data will be sent to your import
+     * modal's `import` method as the `searchFields: Map<string, SerializedFieldType>` parameter.
+     */
+    importActionData?: Map<string, SerializedFieldType> | undefined;
+}
+/** @ignore */
+export interface SerializedImportCardFromDetails {
+    'pk': string[];
+    'piml'?: SerializedPlaceholderImportMetadata[] | undefined;
+    'iad'?: [string, SerializedFieldType][] | undefined;
+}
+/** @ignore */
+export declare const isValidImportCardFromDetails: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
+    pk: (val: unknown) => val is string[];
+    piml: (x: unknown) => x is import("../guards").DestructureGuardedTypeObj<{
+        cid: typeof isString;
+        sid: (x: unknown) => x is string | undefined;
+        cd: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
+            Schema: typeof import("../..").isSerializedSchema;
+            Items: (val: unknown) => val is [string, Record<string | number, SerializedFieldType>][];
+        }>;
+    }>[] | undefined;
+    iad: (x: unknown) => x is [string, SerializedFieldType][] | undefined;
+}>;
+/** @ignore */
+export declare function serializeImportCardFromDetails(concrete: ImportCardFromDetails): SerializedImportCardFromDetails;
+/** @ignore */
+export declare function deserializeImportCardFromDetails(serialized: SerializedImportCardFromDetails): ImportCardFromDetails;

package/core/importcardfromdetails/importcardfromdetails.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deserializeImportCardFromDetails = exports.serializeImportCardFromDetails = exports.isValidImportCardFromDetails = void 0;
+const checks_1 = require("../checks");
+const serializedfields_1 = require("../data/serializedfield/serializedfields");
+const cardintegrationdefinitions_1 = require("../sharedcardintegration/cardintegrationdefinitions");
+const validators_1 = require("../validators/validators");
+/** @ignore */
+exports.isValidImportCardFromDetails = (0, validators_1.objectValidator)({
+    'pk': (0, checks_1.isTypedArray)(checks_1.isString),
+    'piml': (0, validators_1.option)((0, checks_1.isTypedArray)(cardintegrationdefinitions_1.isSerializedPlaceholderImportMetadata)),
+    'iad': (0, validators_1.option)((0, checks_1.isTypedArray)((0, checks_1.isPair)(checks_1.isString, serializedfields_1.isSerializedFieldType))),
+});
+/** @ignore */
+function serializeImportCardFromDetails(concrete) {
+    var _a, _b;
+    return {
+        'pk': concrete.primaryKeys,
+        'piml': (_a = concrete.placeholderImportMetadataList) === null || _a === void 0 ? void 0 : _a.map((data) => (0, cardintegrationdefinitions_1.serializePlaceholderImportMetadata)(data)),
+        'iad': concrete.importActionData ? [...(_b = concrete.importActionData) === null || _b === void 0 ? void 0 : _b.entries()] : undefined,
+    };
+}
+exports.serializeImportCardFromDetails = serializeImportCardFromDetails;
+/** @ignore */
+function deserializeImportCardFromDetails(serialized) {
+    var _a;
+    const placeholderImportMetadataList = serialized['piml']
+        ? {
+            placeholderImportMetadataList: (_a = serialized['piml']) === null || _a === void 0 ? void 0 : _a.map((data) => (0, cardintegrationdefinitions_1.deserializePlaceholderImportMetadata)(data)),
+        }
+        : {};
+    const importActionData = serialized['iad'] ? { importActionData: new Map(serialized['iad']) } : {};
+    return Object.assign(Object.assign({ primaryKeys: serialized['pk'] }, placeholderImportMetadataList), importActionData);
+}
+exports.deserializeImportCardFromDetails = deserializeImportCardFromDetails;

package/core/importcardfrompastedlink/importcardfrompastedlinkcallback.d.ts

@@ -1,8 +1,8 @@
-import { ImportCardFromPastedLinkDetails } from './importcardfrompastedlinkdetails';
+import { ImportCardFromDetails } from '../importcardfromdetails/importcardfromdetails';
 /**
  * Callback to attempt to extract primary keys from a pasted url to be imported as cards onto the canvas.
  *
  * @param url The url to be interpreted into primary keys for the extension to import.
  * @return The details of the cards, or `undefined` if the url couldn't be interpreted.
  */
-export type ImportCardFromPastedLinkCallback = (url: string) => Promise<ImportCardFromPastedLinkDetails | undefined>;
+export type ImportCardFromPastedLinkCallback = (url: string) => Promise<ImportCardFromDetails | undefined>;

package/core/importcardfrompastedlink/importcardfrompastedlinkdetails.d.ts

@@ -1,50 +1,32 @@
-import { isString } from '../checks';
-import { SerializedFieldType } from '../data/serializedfield/serializedfields';
-import { PlaceholderImportMetadata, SerializedPlaceholderImportMetadata } from '../sharedcardintegration/cardintegrationdefinitions';
+import { ImportCardFromDetails, SerializedImportCardFromDetails, deserializeImportCardFromDetails, serializeImportCardFromDetails } from '../importcardfromdetails/importcardfromdetails';
 /**
- * A definition of the details required to import a card into the editor from a pasted url.
+ * @deprecated Use {@link ImportCardFromDetails} instead.
+ */
+export type ImportCardFromPastedLinkDetails = ImportCardFromDetails;
+/**
+ * @deprecated Use {@link SerializedImportCardFromDetails} instead.
+ */
+export type SerializedImportCardFromPastedLinkDetails = SerializedImportCardFromDetails;
+/**
+ * @deprecated Use {@link isValidImportCardFromDetails} instead.
  */
-export interface ImportCardFromPastedLinkDetails {
-    /**
-     * A list of primary keys to import onto the canvas via your extension's import action.
-     *
-     * These should be formatted the same as primary keys on the document's collection. For example, numeric keys would
-     * be formatted as `['123']`, and string keys would be formatted inside double quotes `['"my-item"']`
-     */
-    primaryKeys: string[];
-    /**
-     * If `placeholderImportMetadataList` is provided, it is used to quickly splat a card on the canvas while waiting
-     * for the import action to finish, identical to how modal-based imports use search results to splat cards. Ensure
-     * that the schema of the `collectionDefinition` field in each placeholder import metadata is a subset of the
-     * collection that the imported cards will be added to.
-     */
-    placeholderImportMetadataList?: PlaceholderImportMetadata[] | undefined;
-    /**
-     * `importActionData` can be used to pass key-value pairs to your action. This data will be sent to your import
-     * modal's `import` method as the `searchFields: Map<string, SerializedFieldType>` parameter.
-     */
-    importActionData?: Map<string, SerializedFieldType> | undefined;
-}
-/** @ignore */
-export interface SerializedImportCardFromPastedLinkDetails {
-    'pk': string[];
-    'piml'?: SerializedPlaceholderImportMetadata[] | undefined;
-    'iad'?: [string, SerializedFieldType][] | undefined;
-}
-/** @ignore */
 export declare const isValidImportCardFromPastedLinkDetails: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
     pk: (val: unknown) => val is string[];
     piml: (x: unknown) => x is import("../guards").DestructureGuardedTypeObj<{
-        cid: typeof isString;
+        cid: typeof import("../checks").isString;
         sid: (x: unknown) => x is string | undefined;
         cd: (subject: unknown) => subject is import("../guards").DestructureGuardedTypeObj<{
             Schema: typeof import("../..").isSerializedSchema;
-            Items: (val: unknown) => val is [string, Record<string | number, SerializedFieldType>][];
+            Items: (val: unknown) => val is [string, Record<string | number, import("../..").SerializedFieldType>][];
         }>;
     }>[] | undefined;
-    iad: (x: unknown) => x is [string, SerializedFieldType][] | undefined;
+    iad: (x: unknown) => x is [string, import("../..").SerializedFieldType][] | undefined;
 }>;
-/** @ignore */
-export declare function serializeImportCardFromPastedLinkDetails(concrete: ImportCardFromPastedLinkDetails): SerializedImportCardFromPastedLinkDetails;
-/** @ignore */
-export declare function deserializeImportCardFromPastedLinkDetails(serialized: SerializedImportCardFromPastedLinkDetails): ImportCardFromPastedLinkDetails;
+/**
+ * @deprecated Use {@link serializeImportCardFromDetails} instead.
+ */
+export declare const serializeImportCardFromPastedLinkDetails: typeof serializeImportCardFromDetails;
+/**
+ * @deprecated Use {@link deserializeImportCardFromDetails} instead.
+ */
+export declare const deserializeImportCardFromPastedLinkDetails: typeof deserializeImportCardFromDetails;

package/core/importcardfrompastedlink/importcardfrompastedlinkdetails.js

@@ -1,35 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.deserializeImportCardFromPastedLinkDetails = exports.serializeImportCardFromPastedLinkDetails = exports.isValidImportCardFromPastedLinkDetails = void 0;
-const checks_1 = require("../checks");
-const serializedfields_1 = require("../data/serializedfield/serializedfields");
-const cardintegrationdefinitions_1 = require("../sharedcardintegration/cardintegrationdefinitions");
-const validators_1 = require("../validators/validators");
-/** @ignore */
-exports.isValidImportCardFromPastedLinkDetails = (0, validators_1.objectValidator)({
-    'pk': (0, checks_1.isTypedArray)(checks_1.isString),
-    'piml': (0, validators_1.option)((0, checks_1.isTypedArray)(cardintegrationdefinitions_1.isSerializedPlaceholderImportMetadata)),
-    'iad': (0, validators_1.option)((0, checks_1.isTypedArray)((0, checks_1.isPair)(checks_1.isString, serializedfields_1.isSerializedFieldType))),
-});
-/** @ignore */
-function serializeImportCardFromPastedLinkDetails(concrete) {
-    var _a, _b;
-    return {
-        'pk': concrete.primaryKeys,
-        'piml': (_a = concrete.placeholderImportMetadataList) === null || _a === void 0 ? void 0 : _a.map((data) => (0, cardintegrationdefinitions_1.serializePlaceholderImportMetadata)(data)),
-        'iad': concrete.importActionData ? [...(_b = concrete.importActionData) === null || _b === void 0 ? void 0 : _b.entries()] : undefined,
-    };
-}
-exports.serializeImportCardFromPastedLinkDetails = serializeImportCardFromPastedLinkDetails;
-/** @ignore */
-function deserializeImportCardFromPastedLinkDetails(serialized) {
-    var _a;
-    const placeholderImportMetadataList = serialized['piml']
-        ? {
-            placeholderImportMetadataList: (_a = serialized['piml']) === null || _a === void 0 ? void 0 : _a.map((data) => (0, cardintegrationdefinitions_1.deserializePlaceholderImportMetadata)(data)),
-        }
-        : {};
-    const importActionData = serialized['iad'] ? { importActionData: new Map(serialized['iad']) } : {};
-    return Object.assign(Object.assign({ primaryKeys: serialized['pk'] }, placeholderImportMetadataList), importActionData);
-}
-exports.deserializeImportCardFromPastedLinkDetails = deserializeImportCardFromPastedLinkDetails;
+const importcardfromdetails_1 = require("../importcardfromdetails/importcardfromdetails");
+/**
+ * @deprecated Use {@link isValidImportCardFromDetails} instead.
+ */
+exports.isValidImportCardFromPastedLinkDetails = importcardfromdetails_1.isValidImportCardFromDetails;
+/**
+ * @deprecated Use {@link serializeImportCardFromDetails} instead.
+ */
+exports.serializeImportCardFromPastedLinkDetails = importcardfromdetails_1.serializeImportCardFromDetails;
+/**
+ * @deprecated Use {@link deserializeImportCardFromDetails} instead.
+ */
+exports.deserializeImportCardFromPastedLinkDetails = importcardfromdetails_1.deserializeImportCardFromDetails;

package/core/spreadsheetintegration/lucidspreadsheetintegrationregistry.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LucidSpreadsheetIntegrationRegistry = void 0;
+const datasourceproxy_1 = require("../../data/datasourceproxy");
 const checks_1 = require("../checks");
 const cardintegrationdefinitions_1 = require("../sharedcardintegration/cardintegrationdefinitions");
 const lucidspreadsheetintegration_1 = require("./lucidspreadsheetintegration");
@@ -13,7 +14,7 @@ class LucidSpreadsheetIntegrationRegistry {
      * Register a spreadsheet integration.
      */
     static addSpreadsheetIntegration(client, spreadsheetIntegration) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g;
         let configChooserActions;
         const configChooser = spreadsheetIntegration.configChooser;
         if (configChooser instanceof lucidspreadsheetintegration_1.CustomDetailsChooser) {
@@ -60,6 +61,16 @@ class LucidSpreadsheetIntegrationRegistry {
             catch (error) { }
             return lucidspreadsheetintegration_1.LucidSpreadsheetIntegrationFailureType.GenericFailure;
         });
+        let getFieldsActionName = undefined;
+        const getAllFields = (_a = spreadsheetIntegration.fieldConfiguration) === null || _a === void 0 ? void 0 : _a.getAllFields;
+        if (getAllFields) {
+            getFieldsActionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
+            client.registerAction(getFieldsActionName, async (param) => {
+                const dataSource = new datasourceproxy_1.DataSourceProxy(param['d'], client);
+                const fields = await getAllFields(dataSource);
+                return fields;
+            });
+        }
         const serialized = {
             'ld': spreadsheetIntegration.labelDescription,
             'li': spreadsheetIntegration.labelIconUrl,
@@ -68,10 +79,11 @@ class LucidSpreadsheetIntegrationRegistry {
             'gs': configChooserActions,
             'gm': getMultipleSheetsForSpreadsheetDetailsActionName,
             'fc': {
+                'gf': getFieldsActionName,
                 'cfds': {
-                    'd': (_b = (_a = spreadsheetIntegration.fieldConfiguration) === null || _a === void 0 ? void 0 : _a.customFieldDisplaySettings) === null || _b === void 0 ? void 0 : _b.defaultToMultilineText,
-                    'uri': (_d = (_c = spreadsheetIntegration.fieldConfiguration) === null || _c === void 0 ? void 0 : _c.customFieldDisplaySettings) === null || _d === void 0 ? void 0 : _d.useRoundIcons,
-                    'dadr': (_f = (_e = spreadsheetIntegration.fieldConfiguration) === null || _e === void 0 ? void 0 : _e.customFieldDisplaySettings) === null || _f === void 0 ? void 0 : _f.displayMappedDatesAsDateRange,
+                    'd': (_c = (_b = spreadsheetIntegration.fieldConfiguration) === null || _b === void 0 ? void 0 : _b.customFieldDisplaySettings) === null || _c === void 0 ? void 0 : _c.defaultToMultilineText,
+                    'uri': (_e = (_d = spreadsheetIntegration.fieldConfiguration) === null || _d === void 0 ? void 0 : _d.customFieldDisplaySettings) === null || _e === void 0 ? void 0 : _e.useRoundIcons,
+                    'dadr': (_g = (_f = spreadsheetIntegration.fieldConfiguration) === null || _f === void 0 ? void 0 : _f.customFieldDisplaySettings) === null || _g === void 0 ? void 0 : _g.displayMappedDatesAsDateRange,
                 },
             },
         };

package/package.json

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