lucid-extension-sdk 0.0.148 → 0.0.150

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

@@ -17,7 +17,6 @@ export declare const isSerializedImportedMetadataCollection: (subject: unknown)
 /** @ignore until spreadsheet integration is ready for launch (CHART-51946) */
 export interface SerializedImportedCollection {
     'Name': string;
-    'Id'?: string;
     'Schema': SerializedSchema;
     'Items': SerializedDataItems;
     'UpstreamConfig': {

package/dataconnector/cryptodependencies.d.ts

@@ -0,0 +1,11 @@
+export declare interface BufferSingleton {
+    from(str: string, encoding?: string): unknown;
+}
+export declare interface CryptoModule {
+    createPublicKey(key: string): unknown;
+    verify(algorithm: string, data: unknown, publicKey: unknown, signature: unknown): boolean;
+}
+export declare type CryptoDependencies = {
+    Buffer: BufferSingleton;
+    crypto: CryptoModule;
+};

package/dataconnector/cryptodependencies.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dataconnector/dataconnectorclient.d.ts

@@ -1,5 +1,6 @@
 import { JsonObject } from '../core/jsonserializable';
 import { DataConnectorAction } from './actions/action';
+import { CryptoDependencies } from './cryptodependencies';
 import { DataSourceClient, MockDataSourceClient } from './datasourceclient';
 import { SignatureValidator } from './signaturevalidator';
 /** @ignore */
@@ -13,13 +14,14 @@ export declare type WebhookValidationSecret = {
  * Client for requests to and from Lucid
  */
 export declare class DataConnectorClient {
+    private readonly cryptoDependencies;
     urls: {
         main: string;
         api: string;
     };
     private fetchMethod;
     private cachedPublicKey;
-    constructor(urls?: {
+    constructor(cryptoDependencies: CryptoDependencies, urls?: {
         main: string;
         api: string;
     }, fetchMethod?: import("./defaultfetchfunction").GlobalFetchType);
@@ -43,6 +45,7 @@ export declare class DataConnectorClient {
 export declare class MockDataConnectorClient extends DataConnectorClient {
     /** set properties on this to modify how data source updates are mocked */
     readonly dataSourceClient: MockDataSourceClient;
+    constructor();
     /** @ignore */
     getDataSourceClient(updateToken: string): DataSourceClient;
     /** Mocked version just always returns successful */

package/dataconnector/dataconnectorclient.js

@@ -12,7 +12,8 @@ const LUCID_URLS = { main: 'https://lucid.app/', api: 'https://api.lucid.co/' };
  * Client for requests to and from Lucid
  */
 class DataConnectorClient {
-    constructor(urls = LUCID_URLS, fetchMethod = defaultfetchfunction_1.globalFetch) {
+    constructor(cryptoDependencies, urls = LUCID_URLS, fetchMethod = defaultfetchfunction_1.globalFetch) {
+        this.cryptoDependencies = cryptoDependencies;
         this.urls = urls;
         this.fetchMethod = fetchMethod;
         this.cachedPublicKey = undefined;
@@ -23,7 +24,7 @@ class DataConnectorClient {
     }
     /** Get a validator to prove a given request came from Lucid */
     async getSignatureValidator() {
-        return new signaturevalidator_1.SignatureValidator(await this.getPublicKey());
+        return new signaturevalidator_1.SignatureValidator(this.cryptoDependencies, await this.getPublicKey());
     }
     /** Get Lucid's public key to verify requests came from Lucid if you don't want to use the SignatureValidator. Maybe
      * you're not running in a NodeJS environment */
@@ -92,7 +93,7 @@ exports.DataConnectorClient = DataConnectorClient;
 /** Use this for writing automated tests for your data connector */
 class MockDataConnectorClient extends DataConnectorClient {
     constructor() {
-        super(...arguments);
+        super(undefined);
         /** set properties on this to modify how data source updates are mocked */
         this.dataSourceClient = new datasourceclient_1.MockDataSourceClient();
     }

package/dataconnector/debugserver.js

@@ -10,6 +10,17 @@ function routeDebugServer(dataConnector, options) {
     // We can't use Express's JSON parsing because we need to send the string of the request body
     // directly for the route style flows. Some extensions compute a HMAC of from this data
     app.use(express.raw({ type: () => true }));
+    // 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$/)) {
+            res.header('Access-Control-Allow-Origin', req.headers.origin);
+            res.header('Vary', 'Origin');
+            res.header('Access-Control-Allow-Methods', 'GET, OPTIONS');
+            res.header('Access-Control-Allow-Headers', '*');
+        }
+        next();
+    });
     const prefix = (_b = options.prefix) !== null && _b !== void 0 ? _b : '/';
     console.log(`Routing ${prefix}?kind=action (${Object.keys(dataConnector.actions).join(', ')})`);
     if (dataConnector.routes) {

package/dataconnector/signaturevalidator.d.ts

@@ -1,16 +1,13 @@
-/** @ignore */
-export declare const signatureValidatorImportedNode: {
-    Buffer: any;
-    crypto: any;
-};
+import { CryptoDependencies } from './cryptodependencies';
 /**
  * Allows validation that requests originated from Lucid. This class can only be instanciated in a NodeJS environment.
  * Technically any environment that provides NodeJS compatible implementations of `globalThis.Buffer` and
  * `globalThis.require('crypto')` will work.
  */
 export declare class SignatureValidator {
+    private readonly dependencies;
     private readonly publicKey;
-    constructor(publicKey: string);
+    constructor(dependencies: CryptoDependencies, publicKey: string);
     /**
      * Validate a given request came from Lucid.
      * @param body The body of the request as a plain JavaScript object. This should be JSON.parse called on exactly the

package/dataconnector/signaturevalidator.js

@@ -1,35 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MockSignatureValidator = exports.SignatureValidator = exports.signatureValidatorImportedNode = void 0;
-// Don't import these normally, so they're resolved at runtime.
-// This is so the lucid-extension-sdk can be used from a browser.
-// This class only is implemented for NodeJS environments, so
-// it will fail at runtime if you try to instanciate it in a browser.
-// It's also exported and mutable because while this compiles and
-// works in the lambda environment, for some reason it doesn't work
-// in the debug server environment, so from there we import it and
-// patch it up with imports that do work.
-/** @ignore */
-exports.signatureValidatorImportedNode = (() => {
-    const Buffer = globalThis['Buffer'];
-    const require = globalThis['require'];
-    const crypto = require && require('crypto');
-    return { 'Buffer': Buffer, 'crypto': crypto };
-})();
+exports.MockSignatureValidator = exports.SignatureValidator = void 0;
 /**
  * Allows validation that requests originated from Lucid. This class can only be instanciated in a NodeJS environment.
  * Technically any environment that provides NodeJS compatible implementations of `globalThis.Buffer` and
  * `globalThis.require('crypto')` will work.
  */
 class SignatureValidator {
-    constructor(publicKey) {
-        if (!exports.signatureValidatorImportedNode['Buffer']) {
-            throw new Error('Expect `Buffer` class to be defined');
-        }
-        if (!exports.signatureValidatorImportedNode['crypto']) {
-            throw new Error("Expect `require('crypto')` to be defined");
-        }
-        this.publicKey = exports.signatureValidatorImportedNode['crypto']['createPublicKey'](publicKey);
+    constructor(dependencies, publicKey) {
+        this.dependencies = dependencies;
+        this.publicKey = dependencies.crypto.createPublicKey(publicKey);
     }
     /**
      * Validate a given request came from Lucid.
@@ -44,9 +24,9 @@ class SignatureValidator {
         const parts = url.split('?');
         const params = parts.length > 0 ? parts[1] : '';
         const nonce = headers['x-lucid-rsa-nonce'];
-        const signature = exports.signatureValidatorImportedNode['Buffer']['from'](headers['x-lucid-signature'], 'base64');
-        const data = exports.signatureValidatorImportedNode['Buffer']['from'](JSON.stringify(body) + nonce + params);
-        const verified = exports.signatureValidatorImportedNode['crypto']['verify']('SHA384', data, this.publicKey, signature);
+        const signature = this.dependencies.Buffer.from(headers['x-lucid-signature'], 'base64');
+        const data = this.dependencies.Buffer.from(JSON.stringify(body) + 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.148",
+    "version": "0.0.150",
     "description": "Utility classes for writing Lucid Software editor extensions",
     "main": "index.js",
     "types": "index.d.ts",