lucid-extension-sdk 0.0.274 → 0.0.277

package/core/data/datasource/datasourceutils.d.ts

@@ -1,8 +1,5 @@
-import { DataUpdateFilterType } from '../../../data/dataupdatefiltertype';
 import { SerializedFields } from '../serializedfield/serializedfields';
-import { DataSourceType } from './datasourcetype';
-import { SerializedImportedCollection } from './serializedimporteddatasource';
-import { UpstreamUpdateType } from './upstreamupdatetype';
+import { SerializedImportedCollection, SerializedImportedDataSource, SerializedPreviewData } from './serializedimporteddatasource';
 /** @ignore */
 export declare function alphabetize(n: number): string;
 /** @ignore */
@@ -21,17 +18,10 @@ export declare function makeSerializedImportedCollection(name: string, rawFieldN
     primaryKey: string[];
 }): SerializedImportedCollection;
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
-export declare function makeSerializedImportedDataSource(id: string, name: string, collections: SerializedImportedCollection[]): {
-    Properties: {
-        Name: string;
-        UpstreamConfig: {
-            SourceType: DataSourceType;
-            UpdateType: UpstreamUpdateType;
-            SourceConfig: {
-                spreadsheetId: string;
-                UpdateFilterType: DataUpdateFilterType;
-            };
-        };
-    };
-    Collections: SerializedImportedCollection[];
-};
+export declare function makeSerializedImportedDataSource(id: string, name: string, collections: SerializedImportedCollection[]): SerializedImportedDataSource;
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+export declare function makeSerializedPreviewData(id: string, name: string, collections: {
+    'Data': SerializedImportedCollection;
+    'HeaderRow'?: number | undefined;
+    'PrimaryKey'?: number[] | undefined;
+}[]): SerializedPreviewData;

package/core/data/datasource/datasourceutils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.makeSerializedImportedDataSource = exports.makeSerializedImportedCollection = exports.MetadataPK = exports.makeNameReadablyUnique = exports.normalizeName = exports.alphabetize = void 0;
+exports.makeSerializedPreviewData = exports.makeSerializedImportedDataSource = exports.makeSerializedImportedCollection = exports.MetadataPK = exports.makeNameReadablyUnique = exports.normalizeName = exports.alphabetize = void 0;
 const dataupdatefiltertype_1 = require("../../../data/dataupdatefiltertype");
 const checks_1 = require("../../checks");
 const scalarfieldtype_1 = require("../fieldtypedefinition/scalarfieldtype");
@@ -235,3 +235,21 @@ function makeSerializedImportedDataSource(id, name, collections) {
     };
 }
 exports.makeSerializedImportedDataSource = makeSerializedImportedDataSource;
+/** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+function makeSerializedPreviewData(id, name, collections) {
+    return {
+        'Properties': {
+            'Name': name,
+            'UpstreamConfig': {
+                'SourceType': datasourcetype_1.DataSourceType.DataService,
+                'UpdateType': upstreamupdatetype_1.UpstreamUpdateType.EVENTPULL,
+                'SourceConfig': {
+                    'spreadsheetId': id,
+                    'UpdateFilterType': dataupdatefiltertype_1.DataUpdateFilterType.CurrentCollectionUpdates,
+                },
+            },
+        },
+        'Collections': collections,
+    };
+}
+exports.makeSerializedPreviewData = makeSerializedPreviewData;

package/core/data/datasource/serializedimporteddatasource.d.ts

@@ -53,7 +53,7 @@ export declare const isSerializedImportedDataSource: (subject: unknown) => subje
             SourceType: (x: unknown) => x is import("./datasourcetype").DataSourceType;
             UpdateType: (x: unknown) => x is import("./upstreamupdatetype").UpstreamUpdateType;
             PatchType: (x: unknown) => x is import("./upstreampatchtype").UpstreamPatchType | null | undefined;
-            SourceConfig: typeof isObject; /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
+            SourceConfig: typeof isObject;
         }> | null | undefined;
         SourceForeignKeys: (x: unknown) => x is import("../../guards").DestructureGuardedTypeObj<{
             Id: typeof isString;
@@ -74,3 +74,43 @@ export declare const isSerializedImportedDataSource: (subject: unknown) => subje
         DataIsPartial: (x: unknown) => x is true | undefined;
     }>[];
 }>;
+export interface SerializedPreviewData {
+    'Properties': SerializedDataSourceProperties;
+    'Collections': {
+        'Data': SerializedImportedCollection;
+        'HeaderRow'?: number | undefined;
+        'PrimaryKey'?: number[] | undefined;
+    }[];
+}
+export declare const isSerializedPreviewData: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
+    Properties: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
+        Name: typeof isString;
+        UpstreamConfig: (x: unknown) => x is import("../../guards").DestructureGuardedTypeObj<{
+            SourceType: (x: unknown) => x is import("./datasourcetype").DataSourceType;
+            UpdateType: (x: unknown) => x is import("./upstreamupdatetype").UpstreamUpdateType;
+            PatchType: (x: unknown) => x is import("./upstreampatchtype").UpstreamPatchType | null | undefined;
+            SourceConfig: typeof isObject;
+        }> | null | undefined;
+        SourceForeignKeys: (x: unknown) => x is import("../../guards").DestructureGuardedTypeObj<{
+            Id: typeof isString;
+            SourceFields: (p1: unknown) => p1 is string[];
+            RelationshipType: typeof isString;
+        }>[] | null | undefined;
+    }>;
+    Collections: (val: unknown) => val is import("../../guards").DestructureGuardedTypeObj<{
+        Data: (subject: unknown) => subject is import("../../guards").DestructureGuardedTypeObj<{
+            Name: typeof isString;
+            Schema: typeof isSerializedSchema;
+            Items: (x: unknown) => x is Record<any, Record<any, import("../serializedfield/serializedfields").SerializedFieldType>>;
+            UpstreamConfig: typeof isObject;
+            Metadata: (val: unknown) => val is Record<string, import("../../guards").DestructureGuardedTypeObj<{
+                Name: typeof isString;
+                Schema: typeof isSerializedSchema;
+                Items: (x: unknown) => x is Record<any, Record<any, import("../serializedfield/serializedfields").SerializedFieldType>>;
+            }>>;
+            DataIsPartial: (x: unknown) => x is true | undefined;
+        }>;
+        HeaderRow: (x: unknown) => x is number | undefined;
+        PrimaryKey: (x: unknown) => x is number[] | undefined;
+    }>[];
+}>;

package/core/data/datasource/serializedimporteddatasource.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSerializedImportedDataSource = exports.isSerializedImportedCollection = exports.isSerializedImportedMetadataCollection = void 0;
+exports.isSerializedPreviewData = exports.isSerializedImportedDataSource = exports.isSerializedImportedCollection = exports.isSerializedImportedMetadataCollection = void 0;
 const checks_1 = require("../../checks");
 const validators_1 = require("../../validators/validators");
 const serializeddataitems_1 = require("../serializedfield/serializeddataitems");
@@ -26,3 +26,11 @@ exports.isSerializedImportedDataSource = (0, validators_1.strictObjectValidator)
     'Properties': serializeddatasourceproperties_1.isSerializedDataSourceProperties,
     'Collections': (0, checks_1.isTypedArray)(exports.isSerializedImportedCollection),
 });
+exports.isSerializedPreviewData = (0, validators_1.strictObjectValidator)({
+    'Properties': serializeddatasourceproperties_1.isSerializedDataSourceProperties,
+    'Collections': (0, checks_1.isTypedArray)((0, validators_1.strictObjectValidator)({
+        'Data': exports.isSerializedImportedCollection,
+        'HeaderRow': (0, validators_1.option)(checks_1.isNumber),
+        'PrimaryKey': (0, validators_1.option)((0, checks_1.isTypedArray)(checks_1.isNumber)),
+    })),
+});

package/dataconnector/actions/serializedactions.js

@@ -55,35 +55,36 @@ const serializedManageWebhookDataValidator = (0, validators_1.objectValidator)({
 });
 /** Function to convert the lucid action wire format into a clean list of actions */
 function deserializeActions(client, actions) {
-    if (!serializedActionsBaseValidator(actions)) {
+    const parsedActions = typeof actions === 'string' ? JSON.parse(actions) : actions;
+    if (!serializedActionsBaseValidator(parsedActions)) {
         return;
     }
-    const name = actions['action']['name'];
-    const data = actions['action']['data'];
+    const name = parsedActions['action']['name'];
+    const data = parsedActions['action']['data'];
     if (name === dataconnectoractionkeys_1.DataConnectorActionKeys.Patch) {
         if (!(0, validators_1.arrayValidator)(serializedPatchDataValidator)(data)) {
             console.log(`Failing validation step`);
             return;
         }
         return data.map((item) => {
-            const context = new action_1.DataConnectorActionContext(actions['packageId'], item['packageVersion'], item['userCredential'], actions['dataConnectorName'], actions['dataConnectorName'], actions['documentCollections'], actions['updateFilterType']);
+            const context = new action_1.DataConnectorActionContext(parsedActions['packageId'], item['packageVersion'], item['userCredential'], parsedActions['dataConnectorName'], parsedActions['dataConnectorName'], parsedActions['documentCollections'], parsedActions['updateFilterType']);
             const patches = parseSerializedPatches(item['patches']);
             return new action_1.DataConnectorPatchAction(context, patches, client.getDataSourceClient(item['documentUpdateToken']));
         });
     }
-    if (!actions['packageVersion'] || !actions['userCredential']) {
+    if (!parsedActions['packageVersion'] || !parsedActions['userCredential']) {
         return;
     }
     if (name === dataconnectoractionkeys_1.DataConnectorActionKeys.UnbatchedPatch) {
         if (!serializedPatchDataValidator(data)) {
             return;
         }
-        const context = new action_1.DataConnectorActionContext(actions['packageId'], actions['packageVersion'], actions['userCredential'], actions['dataConnectorName'], actions['dataConnectorName'], actions['documentCollections'], actions['updateFilterType']);
+        const context = new action_1.DataConnectorActionContext(parsedActions['packageId'], parsedActions['packageVersion'], parsedActions['userCredential'], parsedActions['dataConnectorName'], parsedActions['dataConnectorName'], parsedActions['documentCollections'], parsedActions['updateFilterType']);
         return [
             new action_1.DataConnectorPatchAction(context, parseSerializedPatches(data['patches']), client.getDataSourceClient(data['documentUpdateToken']), dataconnectoractionkeys_1.DataConnectorActionKeys.UnbatchedPatch),
         ];
     }
-    const context = new action_1.DataConnectorActionContext(actions['packageId'], actions['packageVersion'], actions['userCredential'], actions['dataConnectorName'], actions['dataConnectorName'], actions['documentCollections'], actions['updateFilterType']);
+    const context = new action_1.DataConnectorActionContext(parsedActions['packageId'], parsedActions['packageVersion'], parsedActions['userCredential'], parsedActions['dataConnectorName'], parsedActions['dataConnectorName'], parsedActions['documentCollections'], parsedActions['updateFilterType']);
     if (name == 'ManageWebhook') {
         if (!serializedManageWebhookDataValidator(data)) {
             return;
@@ -91,9 +92,9 @@ function deserializeActions(client, actions) {
         const webhooks = data['webhooks'].map((webhook) => new action_1.Webhook(webhook['documentCollections'], webhook['webhookData']));
         return [new action_1.DataConnectorManageWebhookAction(context, data['webhookToken'], webhooks)];
     }
-    if (actions['documentUpdateToken']) {
+    if (parsedActions['documentUpdateToken']) {
         return [
-            new action_1.DataConnectorAsynchronousAction(name, context, client.getDataSourceClient(actions['documentUpdateToken']), data),
+            new action_1.DataConnectorAsynchronousAction(name, context, client.getDataSourceClient(parsedActions['documentUpdateToken']), data),
         ];
     }
     return [new action_1.DataConnectorSynchronousAction(name, context, data)];

package/dataconnector/debugserver.js

@@ -13,7 +13,7 @@ function routeDebugServer(dataConnector, options) {
     // CORS
     app.use((req, res, next) => {
         var _a, _b;
-        if ((_b = (_a = req.headers) === null || _a === void 0 ? void 0 : _a.origin) === null || _b === void 0 ? void 0 : _b.match(/.lucid(dev|staging|preprod|).app$/)) {
+        if ((_b = (_a = req.headers) === null || _a === void 0 ? void 0 : _a.origin) === null || _b === void 0 ? void 0 : _b.match(/.lucid(dev|staging|preprod|gov|govpreprod|).app$/)) {
             res.header('Access-Control-Allow-Origin', req.headers.origin);
             res.header('Vary', 'Origin');
             res.header('Access-Control-Allow-Methods', 'GET, OPTIONS');
@@ -32,7 +32,7 @@ function routeDebugServer(dataConnector, options) {
         try {
             const routeKind = req.query['kind'];
             if (routeKind === 'action' || routeKind == undefined || routeKind === '') {
-                const { body, status } = await dataConnector.runAction(req.url, req.headers, JSON.parse(req.body.toString()));
+                const { body, status } = await dataConnector.runAction(req.url, req.headers, req.body.toString());
                 res.status(status).json(body);
             }
             if (routeKind === 'route') {

package/dataconnector/signaturevalidator.js

@@ -24,7 +24,8 @@ class SignatureValidator {
         const [, params = ''] = url.split('?');
         const nonce = headers['x-lucid-rsa-nonce'];
         const signature = this.dependencies.Buffer.from(headers['x-lucid-signature'], 'base64');
-        const data = this.dependencies.Buffer.from(JSON.stringify(body) + nonce + params);
+        const stringBody = typeof body === 'string' ? body : JSON.stringify(body);
+        const data = this.dependencies.Buffer.from(stringBody + nonce + params);
         const verified = this.dependencies.crypto.verify('SHA384', data, this.publicKey, signature);
         return verified;
     }

package/package.json

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