lucid-extension-sdk 0.0.136 → 0.0.138

package/package.json

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

package/sdk/commandtypes.d.ts

@@ -602,20 +602,20 @@ export declare type AddShapeDataQuery = {
 export declare type AddShapeDataResult = undefined;
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export declare type AddSpreadsheetIntegrationQuery = {
-    /** name */
-    'n': string;
-    /** label */
-    'l': string;
-    /** iconUrl */
-    'iu': string;
-    /** getSpreadsheetToImportDetails */
-    'gd': string;
-    /** getSpreadsheetSheetIdsAndNames */
+    /** labelDescription */
+    'ld': string;
+    /** labelIconUrl */
+    'li': string;
+    /** dataConnectorName */
+    'dc': string;
+    /** getSpreadsheetDetailsToImport */
     'gs': string;
-    /** getPreviewData */
-    'gp': string;
-    /** importSheets */
-    'i': string;
+    /** getMultipleSheetsForSpreadsheetDetails */
+    'gm': string;
+    /** getSpreadsheetData */
+    'gd': string;
+    /** importIsComplete */
+    'ic': string;
 };
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export declare type AddSpreadsheetIntegrationResult = undefined;

package/sdk/core/data/serializedfield/serializedfielddefinition.d.ts

@@ -8,7 +8,8 @@ export declare enum FieldConstraintType {
     MIN_VALUE = "minValue",
     MAX_VALUE = "maxValue",
     SINGLE_LINE_ONLY = "singleLineOnly",
-    NO_WHITESPACE = "noWhitespace"
+    NO_WHITESPACE = "noWhitespace",
+    UNIQUE_EDIT = "uniqueEditType"
 }
 export declare const isFieldConstraintType: (x: unknown) => x is FieldConstraintType;
 export declare type SerializedFieldConstraint = {

package/sdk/core/data/serializedfield/serializedfielddefinition.js

@@ -14,6 +14,7 @@ var FieldConstraintType;
     FieldConstraintType["MAX_VALUE"] = "maxValue";
     FieldConstraintType["SINGLE_LINE_ONLY"] = "singleLineOnly";
     FieldConstraintType["NO_WHITESPACE"] = "noWhitespace";
+    FieldConstraintType["UNIQUE_EDIT"] = "uniqueEditType";
 })(FieldConstraintType = exports.FieldConstraintType || (exports.FieldConstraintType = {}));
 exports.isFieldConstraintType = (0, validators_1.enumValidator)(FieldConstraintType);
 exports.isSerializedFieldConstraint = (0, validators_1.objectValidator)({

package/sdk/core/spreadsheetintegration/lucidspreadsheetintegration.d.ts

@@ -1,4 +1,6 @@
 import { SerializedImportedDataSource } from '../data/datasource/serializedimporteddatasource';
+import { SerializedUpstreamConfig } from '../data/datasource/serializedupstreamconfig';
+import { SerializedSchema } from '../data/serializedfield/serializedschema';
 import { JsonSerializable } from '../jsonserializable';
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export declare enum LucidSpreadsheetIntegrationFailureType {
@@ -9,16 +11,24 @@ export declare enum LucidSpreadsheetIntegrationFailureType {
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export declare const lucidSpreadsheetIntegrationFailureTypeValidator: (x: unknown) => x is LucidSpreadsheetIntegrationFailureType;
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+export declare type ImportedResults = {
+    'dataSourceId': string;
+    'syncDataSourceId': string;
+    'upstreamConfig': SerializedUpstreamConfig;
+    'collections': {
+        'collectionId': string;
+        'headerRow': number;
+        'schema': SerializedSchema;
+        'upstreamConfig': JsonSerializable;
+    }[];
+};
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export declare abstract class LucidSpreadsheetIntegration<CONFIG extends JsonSerializable, SHEET extends JsonSerializable> {
-    abstract name: string;
-    abstract label: string;
-    abstract iconUrl: string;
-    abstract getSpreadsheetToImportDetails(): Promise<CONFIG | LucidSpreadsheetIntegrationFailureType>;
-    abstract getSpreadsheetSheetIdsAndNames(spreadsheetDetails: CONFIG): Promise<Map<SHEET, string> | LucidSpreadsheetIntegrationFailureType>;
-    abstract getPreviewData(spreadsheetDetails: CONFIG, sheetsToPreview: SHEET[]): Promise<SerializedImportedDataSource | LucidSpreadsheetIntegrationFailureType>;
-    abstract importSheets(spreadsheetDetails: CONFIG, sheetsConfig: {
-        'sheet': SHEET;
-        'headerRowIndex': number;
-        'primaryKeys': string[];
-    }[]): Promise<string | LucidSpreadsheetIntegrationFailureType>;
+    abstract labelDescription: string;
+    abstract labelIconUrl: string;
+    abstract dataConnectorName: string;
+    abstract getSpreadsheetDetailsToImport(): Promise<CONFIG | LucidSpreadsheetIntegrationFailureType>;
+    abstract getMultipleSheetsForSpreadsheetDetails(spreadsheetDetails: CONFIG): Promise<Map<SHEET, string> | LucidSpreadsheetIntegrationFailureType>;
+    abstract getSpreadsheetData(spreadsheetDetails: CONFIG, sheets: SHEET[]): Promise<SerializedImportedDataSource | LucidSpreadsheetIntegrationFailureType>;
+    abstract importIsComplete(importedResults: ImportedResults): void;
 }

package/sdk/core/spreadsheetintegration/lucidspreadsheetintegrationregistry.js

@@ -11,18 +11,18 @@ class LucidSpreadsheetIntegrationRegistry {
      * Register a spreadsheet integration.
      */
     static addSpreadsheetIntegration(client, spreadsheetIntegration) {
-        const getSpreadsheetToImportDetailsActionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
-        client.registerAction(getSpreadsheetToImportDetailsActionName, async () => {
+        const getSpreadsheetDetailsToImportActionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
+        client.registerAction(getSpreadsheetDetailsToImportActionName, async () => {
             try {
-                return await spreadsheetIntegration.getSpreadsheetToImportDetails();
+                return await spreadsheetIntegration.getSpreadsheetDetailsToImport();
             }
             catch (error) { }
             return lucidspreadsheetintegration_1.LucidSpreadsheetIntegrationFailureType.GenericFailure;
         });
-        const getSpreadsheetSheetIdsAndNamesActionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
-        client.registerAction(getSpreadsheetSheetIdsAndNamesActionName, async (message) => {
+        const getMultipleSheetsForSpreadsheetDetailsActionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
+        client.registerAction(getMultipleSheetsForSpreadsheetDetailsActionName, async (message) => {
             try {
-                const result = await spreadsheetIntegration.getSpreadsheetSheetIdsAndNames(message['dataDetails']);
+                const result = await spreadsheetIntegration.getMultipleSheetsForSpreadsheetDetails(message['spreadsheetDetails']);
                 if ((0, lucidspreadsheetintegration_1.lucidSpreadsheetIntegrationFailureTypeValidator)(result)) {
                     return result;
                 }
@@ -34,30 +34,26 @@ class LucidSpreadsheetIntegrationRegistry {
             catch (error) { }
             return lucidspreadsheetintegration_1.LucidSpreadsheetIntegrationFailureType.GenericFailure;
         });
-        const getPreviewDataActionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
-        client.registerAction(getPreviewDataActionName, async (message) => {
+        const getSpreadsheetDataActionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
+        client.registerAction(getSpreadsheetDataActionName, async (message) => {
             try {
-                return await spreadsheetIntegration.getPreviewData(message['dataDetails'], message['sheets']);
+                return await spreadsheetIntegration.getSpreadsheetData(message['spreadsheetDetails'], message['sheets']);
             }
             catch (error) { }
             return lucidspreadsheetintegration_1.LucidSpreadsheetIntegrationFailureType.GenericFailure;
         });
-        const importSheetsActionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
-        client.registerAction(importSheetsActionName, async (message) => {
-            try {
-                return await spreadsheetIntegration.importSheets(message['dataDetails'], message['sheetsConfig']);
-            }
-            catch (error) { }
-            return lucidspreadsheetintegration_1.LucidSpreadsheetIntegrationFailureType.GenericFailure;
+        const importIsCompleteActionName = LucidSpreadsheetIntegrationRegistry.nextHookName();
+        client.registerAction(importIsCompleteActionName, async (message) => {
+            spreadsheetIntegration.importIsComplete(message['ImportedResults']);
         });
         const serialized = {
-            'n': spreadsheetIntegration.name,
-            'l': spreadsheetIntegration.label,
-            'iu': spreadsheetIntegration.iconUrl,
-            'gd': getSpreadsheetToImportDetailsActionName,
-            'gs': getSpreadsheetSheetIdsAndNamesActionName,
-            'gp': getPreviewDataActionName,
-            'i': importSheetsActionName,
+            'ld': spreadsheetIntegration.labelDescription,
+            'li': spreadsheetIntegration.labelIconUrl,
+            'dc': spreadsheetIntegration.dataConnectorName,
+            'gs': getSpreadsheetDetailsToImportActionName,
+            'gm': getMultipleSheetsForSpreadsheetDetailsActionName,
+            'gd': getSpreadsheetDataActionName,
+            'ic': importIsCompleteActionName,
         };
         client.sendCommand("asi" /* CommandName.AddSpreadsheetIntegration */, serialized);
     }

package/sdk/data/schemadefinition.d.ts

@@ -27,7 +27,11 @@ export interface NoWhitespaceFieldConstraintDefinition {
     type: FieldConstraintType.NO_WHITESPACE;
     value?: undefined;
 }
-export declare type FieldConstraintDefinition = RequiredFieldConstraintDefinition | LockedFieldConstraintDefinition | MinValueFieldConstraintDefinition | MaxValueFieldConstraintDefinition | SingleLineFieldConstraintDefinition | NoWhitespaceFieldConstraintDefinition;
+export interface UniqueEditFieldConstraintDefinition {
+    type: FieldConstraintType.UNIQUE_EDIT;
+    value?: undefined;
+}
+export declare type FieldConstraintDefinition = RequiredFieldConstraintDefinition | LockedFieldConstraintDefinition | MinValueFieldConstraintDefinition | MaxValueFieldConstraintDefinition | SingleLineFieldConstraintDefinition | NoWhitespaceFieldConstraintDefinition | UniqueEditFieldConstraintDefinition;
 export declare function minMaxFieldConstraintValidator(val: unknown): val is FieldConstraintType.MIN_VALUE | FieldConstraintType.MAX_VALUE;
 export declare const isFieldConstraintDefinition: (x: unknown) => x is {
     type?: FieldConstraintType | undefined;
@@ -37,7 +41,7 @@ export declare const isFieldConstraintDefinition: (x: unknown) => x is {
     type: typeof minMaxFieldConstraintValidator;
     value: typeof isNumber;
 }> | import("..").DestructureGuardedTypeObj<{
-    type: (x: unknown) => x is FieldConstraintType.REQUIRED | FieldConstraintType.LOCKED | FieldConstraintType.SINGLE_LINE_ONLY | FieldConstraintType.NO_WHITESPACE;
+    type: (x: unknown) => x is FieldConstraintType.REQUIRED | FieldConstraintType.LOCKED | FieldConstraintType.SINGLE_LINE_ONLY | FieldConstraintType.NO_WHITESPACE | FieldConstraintType.UNIQUE_EDIT;
     value: typeof isUndefined;
 }>);
 /**

package/sdk/data/schemadefinition.js

@@ -62,6 +62,7 @@ function parseFieldDefinition(field) {
                 case serializedfielddefinition_1.FieldConstraintType.LOCKED:
                 case serializedfielddefinition_1.FieldConstraintType.SINGLE_LINE_ONLY:
                 case serializedfielddefinition_1.FieldConstraintType.NO_WHITESPACE:
+                case serializedfielddefinition_1.FieldConstraintType.UNIQUE_EDIT:
                     return { type: constraint['Type'] };
                 default:
                     throw new Error('Invalid constraint format');