lucid-package 0.0.32 → 0.0.36

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-package",
-    "version": "0.0.32",
+    "version": "0.0.36",
     "description": "",
     "main": "index.js",
     "bin": {

package/src/editorextension.js

@@ -1,15 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.debugEditorExtension = exports.watchEditorExtension = exports.updateExtensionSDK = exports.buildEditorExtension = exports.createEditorExtension = void 0;
-const fs = require("fs/promises");
+const child_process = require("child_process");
+const express = require("express");
 const oldFs = require("fs");
+const fs = require("fs/promises");
+const path = require("path");
 const filesystemutil_1 = require("./filesystemutil");
 const package_1 = require("./package");
-const express = require("express");
-const child_process = require("child_process");
-const shapelibrary_1 = require("./shapelibrary");
 const packagemanifest_1 = require("./packagemanifest");
-const path = require("path");
+const shapelibrary_1 = require("./shapelibrary");
 const shellutil_1 = require("./shellutil");
 const WebPackCLI = require('webpack-cli');
 function linkInternalTestingSDK() {
@@ -58,14 +58,14 @@ async function createEditorExtension(name, isInternalTesting) {
 }
 exports.createEditorExtension = createEditorExtension;
 async function buildEditorExtension(name, isInternalTesting, quiet = false) {
-    process.chdir('editorextensions/' + name);
+    process.chdir('editorextensions/' + (await getExtensionCodeDirectoryName(name)));
     installDependenciesIfNeeded(isInternalTesting);
     const cli = new WebPackCLI();
     await cli.run(['node', 'webpack', '--mode', 'production', ...(quiet ? ['--stats', 'errors-only'] : [])]);
 }
 exports.buildEditorExtension = buildEditorExtension;
 async function updateExtensionSDK(name) {
-    process.chdir('editorextensions/' + name);
+    process.chdir('editorextensions/' + (await getExtensionCodeDirectoryName(name)));
     console.log('Installing latest SDK in extension ' + name);
     console.log((0, shellutil_1.execSyncLoggingOutputOnError)('npm install lucid-extension-sdk@latest').toString());
 }
@@ -76,7 +76,7 @@ exports.updateExtensionSDK = updateExtensionSDK;
  * @param quiet If true, will only show errors in output
  */
 async function watchEditorExtension(name, isInternalTesting, quiet = false) {
-    process.chdir(`editorextensions/${name}`);
+    process.chdir('editorextensions/' + (await getExtensionCodeDirectoryName(name)));
     installDependenciesIfNeeded(isInternalTesting);
     const cli = new WebPackCLI();
     cli.run(['node', 'webpack', '--watch', ...(quiet ? ['--stats', 'errors-only'] : [])]);
@@ -104,12 +104,13 @@ async function debugEditorExtension(extensionNames, quiet = false) {
     app.get(['/extension.js', '/editorextension/:name/extension.js'], async (req, res) => {
         var _a;
         const name = (_a = req.params['name']) !== null && _a !== void 0 ? _a : extensionNames[0];
+        const directory = await getExtensionCodeDirectoryName(name);
         //Give it several seconds for the extension to finish generating before failing.
         const before = Date.now();
-        while (!oldFs.existsSync(`editorextensions/${name}/bin/extension.js`) && Date.now() - before < 5000) {
+        while (!oldFs.existsSync(`editorextensions/${directory}/bin/extension.js`) && Date.now() - before < 5000) {
             await new Promise((resolve) => setTimeout(resolve, 50));
         }
-        res.send((await fs.readFile(`editorextensions/${name}/bin/extension.js`)).toString());
+        res.send((await fs.readFile(`editorextensions/${directory}/bin/extension.js`)).toString());
     });
     app.get(['/scopes', '/editorextension/:name/scopes'], async (req, res) => {
         var _a, _b, _c;
@@ -155,10 +156,40 @@ async function debugEditorExtension(extensionNames, quiet = false) {
     (0, shapelibrary_1.debugShapeLibraries)();
 }
 exports.debugEditorExtension = debugEditorExtension;
+async function getExtensionManifest(name) {
+    var _a;
+    const manifest = await (0, packagemanifest_1.readManifest)('local');
+    return { manifest, extensionManifest: (_a = manifest['extensions']) === null || _a === void 0 ? void 0 : _a.find((one) => one['name'] === name) };
+}
+/**
+ * We allow the creation of editor extensions that use the same code as a different editor extension in the same
+ * package. This is a workaround to have one extension work with multiple products. For example, one can build a
+ * "google-sheets-spark" extension and then add a "google-sheets-chart" extension to the manifest.json file and enter
+ * the same codePath for the chart extension as the spark extension.
+ */
+async function getExtensionCodeDirectoryName(name) {
+    var _a;
+    const extensionManifest = (await getExtensionManifest(name)).extensionManifest;
+    const codePath = extensionManifest === null || extensionManifest === void 0 ? void 0 : extensionManifest['codePath'];
+    return codePath ? (_a = (await getExtensionCodeDirectoryNameFromCodePath(codePath))) !== null && _a !== void 0 ? _a : name : name;
+}
+/**
+ * Our codePath has the form '/editorextensions/{extensionName}/bin/extension.js'. This function returns the
+ * extensionName.
+ */
+async function getExtensionCodeDirectoryNameFromCodePath(codePath) {
+    var _a;
+    const parts = (_a = codePath.split('/')) !== null && _a !== void 0 ? _a : [];
+    if (parts[0] === 'editorextensions' && parts[1]) {
+        return `${parts[1]}`;
+    }
+    return undefined;
+}
 async function getRawEditorExtension(name) {
     var _a, _b, _c, _d;
-    const manifest = await (0, packagemanifest_1.readManifest)('local');
-    const extensionManifest = (_a = manifest['extensions']) === null || _a === void 0 ? void 0 : _a.find((one) => one['name'] === name);
+    const { manifest, extensionManifest } = await getExtensionManifest(name);
+    const codePath = extensionManifest === null || extensionManifest === void 0 ? void 0 : extensionManifest['codePath'];
+    const directory = codePath ? (_a = (await getExtensionCodeDirectoryNameFromCodePath(codePath))) !== null && _a !== void 0 ? _a : name : name;
     return {
         id: '__local__',
         packageId: (_b = manifest['id']) !== null && _b !== void 0 ? _b : '__local__',
@@ -168,6 +199,6 @@ async function getRawEditorExtension(name) {
         title: (_c = extensionManifest === null || extensionManifest === void 0 ? void 0 : extensionManifest['title']) !== null && _c !== void 0 ? _c : 'Local dev extension',
         product: (_d = extensionManifest === null || extensionManifest === void 0 ? void 0 : extensionManifest['product']) !== null && _d !== void 0 ? _d : 'chart',
         scopes: extensionManifest === null || extensionManifest === void 0 ? void 0 : extensionManifest['scopes'],
-        codeUrl: `http://localhost:9900/editorextension/${name}/extension.js`,
+        codeUrl: `http://localhost:9900/editorextension/${directory}/extension.js`,
     };
 }

package/src/packagemanifest.d.ts

@@ -21,6 +21,12 @@ export declare type PackageManifest = {
         'scopes': string[];
         'domainWhitelist': string[];
     }[];
+    'mergeProviders'?: {
+        'name': string;
+        'title': string;
+        'categories': string[];
+        'integration'?: string;
+    }[];
     'dataConnectors'?: {
         'name': string;
         'oauthProviderName': string;

package/src/packagemanifest.js

@@ -87,6 +87,25 @@ function validateManifestOrThrow(manifest) {
             }
         }
     }
+    if (manifest['mergeProviders']) {
+        if (!(0, checks_1.isTypedArray)(checks_1.isObject)(manifest['mergeProviders'])) {
+            throw new Error('manifest.json: "mergeProviders" must be an array of objects');
+        }
+        for (const provider of manifest['mergeProviders']) {
+            if (!(0, checks_1.isString)(provider['name'])) {
+                throw new Error('manifest.json: Merge provider "name" must be a string');
+            }
+            if (!(0, checks_1.isString)(provider['title'])) {
+                throw new Error('manifest.json: Merge provider "title" must be a string');
+            }
+            if (!(0, checks_1.isTypedArray)(checks_1.isString)(provider['categories'])) {
+                throw new Error('manifest.json: Merge provider "categories" must be a string array');
+            }
+            if (provider['integration'] && !(0, checks_1.isString)(provider['integration'])) {
+                throw new Error('manifest.json: Merge provider "integration" must be a string');
+            }
+        }
+    }
     if (manifest['dataConnectors']) {
         if (!(0, checks_1.isTypedArray)(checks_1.isObject)(manifest['dataConnectors'])) {
             throw new Error('manifest.json: "dataConnectors" must be an array of objects');