lucid-package 0.0.38 → 0.0.40

package/package.json

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

package/src/editorextension.d.ts

@@ -1,4 +1,4 @@
-export declare function createEditorExtension(name: string, isInternalTesting: boolean): Promise<void>;
+export declare function createEditorExtension(name: string, isInternalTesting: boolean, skipSDKDependency: boolean): Promise<void>;
 export declare function buildEditorExtension(name: string, isInternalTesting: boolean, quiet?: boolean): Promise<void>;
 export declare function updateExtensionSDK(name: string): Promise<void>;
 /**

package/src/editorextension.js

@@ -11,6 +11,7 @@ const package_1 = require("./package");
 const packagemanifest_1 = require("./packagemanifest");
 const shapelibrary_1 = require("./shapelibrary");
 const shellutil_1 = require("./shellutil");
+const supportedproduct_1 = require("./supportedproduct");
 const WebPackCLI = require('webpack-cli');
 function linkInternalTestingSDK() {
     if (!oldFs.existsSync('node_modules/lucid-extension-sdk')) {
@@ -23,11 +24,11 @@ function linkInternalTestingSDK() {
         console.log((0, shellutil_1.execSyncLoggingOutputOnError)(`npm install --silent --save ${relativePath}`).toString());
     }
 }
-function installDependenciesIfNeeded(isInternalTesting) {
+function installDependenciesIfNeeded(isInternalTesting, skipSDKDependency = false) {
     if (!oldFs.existsSync('node_modules')) {
         console.log((0, shellutil_1.execSyncLoggingOutputOnError)('npm install --silent').toString());
     }
-    if (!oldFs.existsSync('node_modules/lucid-extension-sdk')) {
+    if (!oldFs.existsSync('node_modules/lucid-extension-sdk') && !skipSDKDependency) {
         if (isInternalTesting) {
             linkInternalTestingSDK();
         }
@@ -37,7 +38,7 @@ function installDependenciesIfNeeded(isInternalTesting) {
         }
     }
 }
-async function createEditorExtension(name, isInternalTesting) {
+async function createEditorExtension(name, isInternalTesting, skipSDKDependency) {
     console.log('Creating empty editor extension in editorextensions/' + name);
     (0, filesystemutil_1.copyFolderRecursiveSync)(__dirname + '/../templates/editorextension', 'editorextensions/' + name);
     await (0, package_1.modifyManifest)((manifest) => {
@@ -47,14 +48,14 @@ async function createEditorExtension(name, isInternalTesting) {
         manifest['extensions'].push({
             'name': name,
             'title': name,
-            'product': 'chart',
+            'products': [supportedproduct_1.SupportedProduct.Chart],
             'codePath': `editorextensions/${name}/bin/extension.js`,
             'scopes': ['READ', 'WRITE', 'DOWNLOAD', 'SHOW_MODAL', 'CUSTOM_UI', 'NETWORK'],
         });
     });
     console.log(`Installing dependencies`);
     process.chdir('editorextensions/' + name);
-    installDependenciesIfNeeded(isInternalTesting);
+    installDependenciesIfNeeded(isInternalTesting, skipSDKDependency);
 }
 exports.createEditorExtension = createEditorExtension;
 async function buildEditorExtension(name, isInternalTesting, quiet = false) {
@@ -186,10 +187,13 @@ async function getExtensionCodeDirectoryNameFromCodePath(codePath) {
     return undefined;
 }
 async function getRawEditorExtension(name) {
-    var _a, _b, _c, _d;
+    var _a, _b, _c;
     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;
+    const products = extensionManifest
+        ? getExtensionProducts(extensionManifest['product'], extensionManifest['products'])
+        : [supportedproduct_1.SupportedProduct.Chart];
     return {
         id: '__local__',
         packageId: (_b = manifest['id']) !== null && _b !== void 0 ? _b : '__local__',
@@ -197,8 +201,17 @@ async function getRawEditorExtension(name) {
         version: manifest['version'],
         name: 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',
+        products: products,
         scopes: extensionManifest === null || extensionManifest === void 0 ? void 0 : extensionManifest['scopes'],
         codeUrl: `http://localhost:9900/editorextension/${directory}/extension.js`,
     };
 }
+function getExtensionProducts(product, products) {
+    if (products && products.length !== 0) {
+        return products;
+    }
+    if (product) {
+        return [product];
+    }
+    throw new Error('Either "product" or "products" must be spcified for the editor extension in the package manifest');
+}

package/src/index.js

@@ -39,6 +39,11 @@ class LucidSuiteExtensionCLI {
             help: 'Create a new editor extension as part of the current package',
         });
         createExtensionParser.add_argument('name');
+        createExtensionParser.add_argument('--skip-sdk', {
+            default: false,
+            action: 'store_true',
+            help: argparse_1.SUPPRESS,
+        });
         const buildExtensionParser = subparsers.add_parser('build-editor-extension', {
             help: 'Compile an editor extension in production mode; use this to check types and validate final compiled output',
         });
@@ -114,7 +119,7 @@ class LucidSuiteExtensionCLI {
                 break;
             case 'create-editor-extension':
                 if ((0, package_1.currentlyInPackage)()) {
-                    await (0, editorextension_1.createEditorExtension)(parsed['name'], isInternalTesting);
+                    await (0, editorextension_1.createEditorExtension)(parsed['name'], isInternalTesting, parsed['skip_sdk']);
                 }
                 else {
                     console.error('Not currently in a Lucid extension package folder');

package/src/packagemanifest.d.ts

@@ -1,3 +1,4 @@
+import { SupportedProduct } from './supportedproduct';
 export declare enum SettingType {
     STRING = "string"
 }
@@ -9,7 +10,8 @@ export declare type PackageManifest = {
         'title': string;
         'codePath': string;
         'scopes': string[];
-        'product': 'chart' | 'spark' | 'teamspaces';
+        'product'?: SupportedProduct;
+        'products'?: SupportedProduct[];
     }[];
     'shapeLibraries'?: {
         'name': string;

package/src/packagemanifest.js

@@ -5,6 +5,7 @@ const fs = require("fs");
 const fsPromises = require("fs/promises");
 const checks_1 = require("lucid-extension-sdk/sdk/core/checks");
 const validators_1 = require("lucid-extension-sdk/sdk/core/validators/validators");
+const supportedproduct_1 = require("./supportedproduct");
 var SettingType;
 (function (SettingType) {
     SettingType["STRING"] = "string";
@@ -60,10 +61,21 @@ function validateManifestOrThrow(manifest) {
             if (!(0, checks_1.isTypedArray)(checks_1.isString)(extension['scopes'])) {
                 throw new Error('manifest.json: extension "scopes" must be a string array');
             }
-            if (extension['product'] !== 'chart' &&
-                extension['product'] !== 'spark' &&
-                extension['product'] !== 'teamspaces') {
-                throw new Error(`manifest.json: found ${extension['product']}. extension "product" must be "chart" or "spark" or "teamspaces"`);
+            if ((extension['product'] && extension['products']) ||
+                (!(0, checks_1.isDef)(extension['product']) && !(0, checks_1.isDef)(extension['products']))) {
+                throw new Error('either the "product" or "products" field must be specified and not both');
+            }
+            const supportedProducts = Object.values(supportedproduct_1.SupportedProduct);
+            if (extension['product']) {
+                if (!(0, validators_1.enumValidator)(supportedproduct_1.SupportedProduct)(extension['product'])) {
+                    throw new Error(`manifest.json: found ${extension['product']}. extension "product" must be one of ${supportedProducts}`);
+                }
+            }
+            if (extension['products']) {
+                if (!(0, checks_1.isTypedArray)((0, validators_1.enumValidator)(supportedproduct_1.SupportedProduct))(extension['products']) ||
+                    extension['products'].length === 0) {
+                    throw new Error(`manifest.json: found ${extension['products']}. extension "products" must be an array containing values from ${supportedProducts}`);
+                }
             }
         }
     }

package/src/supportedproduct.d.ts

@@ -0,0 +1,5 @@
+export declare enum SupportedProduct {
+    Chart = "chart",
+    Spark = "spark",
+    TeamSpaces = "teamspaces"
+}

package/src/supportedproduct.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SupportedProduct = void 0;
+var SupportedProduct;
+(function (SupportedProduct) {
+    SupportedProduct["Chart"] = "chart";
+    SupportedProduct["Spark"] = "spark";
+    SupportedProduct["TeamSpaces"] = "teamspaces";
+})(SupportedProduct = exports.SupportedProduct || (exports.SupportedProduct = {}));