lucid-extension-sdk 0.0.292 → 0.0.294

package/commandtypes.d.ts

@@ -804,7 +804,9 @@ export type AddSpreadsheetIntegrationQuery = {
     /** dataConnectorName */
     'dc': string;
     /** getSpreadsheetDetailsToImport */
-    'gs': string;
+    'gs': string | {
+        'l': string;
+    };
     /** getMultipleSheetsForSpreadsheetDetails */
     'gm': string;
     /** addCardsIntegration */

package/core/data/serializedfield/serializedfields.d.ts

@@ -97,6 +97,10 @@ export declare const isSerializedMillisecondsDateObject: (subject: unknown) => s
     ms: typeof isNumber;
     isDateOnly: (x: unknown) => x is boolean | undefined;
 }>;
+export declare const isSerializedIsoDateObject: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
+    isoDate: typeof isString;
+    displayTimezone: (x: unknown) => x is string | null | undefined;
+}>;
 export declare const isSerializedLucidDateObject: (x: unknown) => x is import("../../guards").DestructureGuardedTypeObj<{
     ms: typeof isNumber;
     isDateOnly: (x: unknown) => x is boolean | undefined;

package/core/data/serializedfield/serializedfields.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSerializedFields = exports.isSerializedJsonFieldType = exports.isSerializedFieldType = exports.isSerializedTimeObject = exports.isSerializedLucidDateObject = exports.isSerializedMillisecondsDateObject = exports.isSerializedLucidCurrency = exports.isSerializedLucidDictionary = exports.isJsonSerializedLucidDictionary = exports.isNestedSerializedLucidDictionary = exports.isSerializedColorObjectFieldType = void 0;
+exports.isSerializedFields = exports.isSerializedJsonFieldType = exports.isSerializedFieldType = exports.isSerializedTimeObject = exports.isSerializedLucidDateObject = exports.isSerializedIsoDateObject = exports.isSerializedMillisecondsDateObject = exports.isSerializedLucidCurrency = exports.isSerializedLucidDictionary = exports.isJsonSerializedLucidDictionary = exports.isNestedSerializedLucidDictionary = exports.isSerializedColorObjectFieldType = void 0;
 const checks_1 = require("../../checks");
 const validators_1 = require("../../validators/validators");
 function isSerializedColorObjectFieldType(value) {
@@ -24,11 +24,11 @@ exports.isSerializedMillisecondsDateObject = (0, validators_1.objectValidator)({
     'ms': checks_1.isNumber,
     'isDateOnly': (0, validators_1.option)(checks_1.isBoolean),
 });
-const isSerializedIsoDateObject = (0, validators_1.objectValidator)({
+exports.isSerializedIsoDateObject = (0, validators_1.objectValidator)({
     'isoDate': checks_1.isString,
     'displayTimezone': (0, validators_1.nullableOption)(checks_1.isString),
 });
-exports.isSerializedLucidDateObject = (0, validators_1.either)(exports.isSerializedMillisecondsDateObject, isSerializedIsoDateObject);
+exports.isSerializedLucidDateObject = (0, validators_1.either)(exports.isSerializedMillisecondsDateObject, exports.isSerializedIsoDateObject);
 exports.isSerializedTimeObject = (0, validators_1.objectValidator)({
     'hours': checks_1.isNumber,
     'minutes': (0, validators_1.option)(checks_1.isNumber),

package/core/spreadsheetintegration/lucidspreadsheetintegration.d.ts

@@ -19,13 +19,38 @@ export type ImportedResults = {
         'upstreamConfig'?: JsonSerializable;
     }[];
 };
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export declare const isImportedResults: (x: unknown) => x is ImportedResults;
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
-export declare abstract class LucidSpreadsheetIntegration<CONFIG extends JsonSerializable, SHEET extends JsonSerializable> {
+export declare class ListChooser {
+    readonly getList: () => Promise<{
+        header: string[];
+        rows: {
+            id: string;
+            values: string[];
+            icon: string;
+        }[];
+    } | LucidSpreadsheetIntegrationFailureType>;
+    constructor(getList: () => Promise<{
+        header: string[];
+        rows: {
+            id: string;
+            values: string[];
+            icon: string;
+        }[];
+    } | LucidSpreadsheetIntegrationFailureType>);
+}
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+export declare class CustomDetailsChooser {
+    readonly getConfig: () => Promise<string | LucidSpreadsheetIntegrationFailureType>;
+    constructor(getConfig: () => Promise<string | LucidSpreadsheetIntegrationFailureType>);
+}
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+export declare abstract class LucidSpreadsheetIntegration {
     abstract labelDescription: string;
     abstract labelIconUrl: string;
     abstract dataConnectorName: string;
     addCardsIntegration: boolean;
-    abstract getSpreadsheetDetailsToImport(): Promise<CONFIG | LucidSpreadsheetIntegrationFailureType>;
-    abstract getMultipleSheetsForSpreadsheetDetails(spreadsheetDetails: CONFIG): Promise<Map<SHEET, string> | LucidSpreadsheetIntegrationFailureType>;
+    abstract configChooser: ListChooser | CustomDetailsChooser;
+    abstract getMultipleSheetsForSpreadsheetDetails(spreadsheetDetails: string): Promise<Map<string, string> | LucidSpreadsheetIntegrationFailureType>;
 }

package/core/spreadsheetintegration/lucidspreadsheetintegration.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LucidSpreadsheetIntegration = exports.isImportedResults = exports.lucidSpreadsheetIntegrationFailureTypeValidator = exports.LucidSpreadsheetIntegrationFailureType = void 0;
+exports.LucidSpreadsheetIntegration = exports.CustomDetailsChooser = exports.ListChooser = exports.isImportedResults = exports.lucidSpreadsheetIntegrationFailureTypeValidator = exports.LucidSpreadsheetIntegrationFailureType = void 0;
 const checks_1 = require("../checks");
 const serializedupstreamconfig_1 = require("../data/datasource/serializedupstreamconfig");
 const serializedschema_1 = require("../data/serializedfield/serializedschema");
@@ -15,6 +15,7 @@ var LucidSpreadsheetIntegrationFailureType;
 })(LucidSpreadsheetIntegrationFailureType || (exports.LucidSpreadsheetIntegrationFailureType = LucidSpreadsheetIntegrationFailureType = {}));
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 exports.lucidSpreadsheetIntegrationFailureTypeValidator = (0, validators_1.stringEnumValidator)(LucidSpreadsheetIntegrationFailureType);
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 exports.isImportedResults = (0, validators_1.strictObjectValidator)({
     'upstreamConfig': serializedupstreamconfig_1.isSerializedUpstreamConfig,
     'collections': (0, validators_1.arrayValidator)((0, validators_1.strictObjectValidator)({
@@ -25,6 +26,20 @@ exports.isImportedResults = (0, validators_1.strictObjectValidator)({
     })),
 });
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+class ListChooser {
+    constructor(getList) {
+        this.getList = getList;
+    }
+}
+exports.ListChooser = ListChooser;
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+class CustomDetailsChooser {
+    constructor(getConfig) {
+        this.getConfig = getConfig;
+    }
+}
+exports.CustomDetailsChooser = CustomDetailsChooser;
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 class LucidSpreadsheetIntegration {
     constructor() {
         this.addCardsIntegration = true;

package/core/spreadsheetintegration/lucidspreadsheetintegrationregistry.d.ts

@@ -1,5 +1,4 @@
 import { EditorClient } from '../../editorclient';
-import { JsonSerializable } from '../jsonserializable';
 import { LucidSpreadsheetIntegration } from './lucidspreadsheetintegration';
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export declare class LucidSpreadsheetIntegrationRegistry {
@@ -8,5 +7,5 @@ export declare class LucidSpreadsheetIntegrationRegistry {
     /**
      * Register a spreadsheet integration.
      */
-    static addSpreadsheetIntegration<CONFIG extends JsonSerializable, SHEET extends JsonSerializable>(client: EditorClient, spreadsheetIntegration: LucidSpreadsheetIntegration<CONFIG, SHEET>): void;
+    static addSpreadsheetIntegration(client: EditorClient, spreadsheetIntegration: LucidSpreadsheetIntegration): void;
 }

package/core/spreadsheetintegration/lucidspreadsheetintegrationregistry.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LucidSpreadsheetIntegrationRegistry = void 0;
+const checks_1 = require("../checks");
 const lucidspreadsheetintegration_1 = require("./lucidspreadsheetintegration");
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 class LucidSpreadsheetIntegrationRegistry {
@@ -11,14 +12,37 @@ class LucidSpreadsheetIntegrationRegistry {
      * Register a spreadsheet integration.
      */
     static addSpreadsheetIntegration(client, spreadsheetIntegration) {
-        const getSpreadsheetDetailsToImportActionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
-        client.registerAction(getSpreadsheetDetailsToImportActionName, async () => {
-            try {
-                return await spreadsheetIntegration.getSpreadsheetDetailsToImport();
-            }
-            catch (error) { }
-            return lucidspreadsheetintegration_1.LucidSpreadsheetIntegrationFailureType.GenericFailure;
-        });
+        let configChooserActions;
+        const configChooser = spreadsheetIntegration.configChooser;
+        if (configChooser instanceof lucidspreadsheetintegration_1.CustomDetailsChooser) {
+            const actionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
+            configChooserActions = actionName;
+            client.registerAction(actionName, async () => {
+                try {
+                    return await configChooser.getConfig();
+                }
+                catch (error) { }
+                return lucidspreadsheetintegration_1.LucidSpreadsheetIntegrationFailureType.GenericFailure;
+            });
+        }
+        else {
+            const actionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
+            configChooserActions = { 'l': actionName };
+            client.registerAction(actionName, async () => {
+                try {
+                    const result = await configChooser.getList();
+                    if ((0, checks_1.isString)(result)) {
+                        return result;
+                    }
+                    return {
+                        'h': result.header,
+                        'r': result.rows.map(({ icon, id, values }) => ({ 'i': icon, 'd': id, 'l': values })),
+                    };
+                }
+                catch (error) { }
+                return lucidspreadsheetintegration_1.LucidSpreadsheetIntegrationFailureType.GenericFailure;
+            });
+        }
         const getMultipleSheetsForSpreadsheetDetailsActionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
         client.registerAction(getMultipleSheetsForSpreadsheetDetailsActionName, async (message) => {
             try {
@@ -39,7 +63,7 @@ class LucidSpreadsheetIntegrationRegistry {
             'li': spreadsheetIntegration.labelIconUrl,
             'dc': spreadsheetIntegration.dataConnectorName,
             'c': spreadsheetIntegration.addCardsIntegration,
-            'gs': getSpreadsheetDetailsToImportActionName,
+            'gs': configChooserActions,
             'gm': getMultipleSheetsForSpreadsheetDetailsActionName,
         };
         client.sendCommand("asi" /* CommandName.AddSpreadsheetIntegration */, serialized);

package/package.json

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