lucid-package 0.0.37 → 0.0.39

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-package",
-    "version": "0.0.37",
+    "version": "0.0.39",
     "description": "",
     "main": "index.js",
     "bin": {
@@ -23,7 +23,7 @@
         "express": "^4.17.1",
         "hjson": "^3.2.2",
         "jszip": "^3.7.1",
-        "lucid-extension-sdk": "^0.0.8",
+        "lucid-extension-sdk": "^0.0.73",
         "password-prompt": "^1.1.2",
         "ts-loader": "^9.2.6",
         "webpack": "^5.64.4",

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')) {
@@ -47,7 +48,7 @@ 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'],
         });
@@ -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/packagemanifest.d.ts

@@ -1,3 +1,7 @@
+import { SupportedProduct } from './supportedproduct';
+export declare enum SettingType {
+    STRING = "string"
+}
 export declare type PackageManifest = {
     'id'?: string;
     'version': string;
@@ -6,7 +10,8 @@ export declare type PackageManifest = {
         'title': string;
         'codePath': string;
         'scopes': string[];
-        'product': 'chart' | 'spark' | 'teamspaces';
+        'product'?: SupportedProduct;
+        'products'?: SupportedProduct[];
     }[];
     'shapeLibraries'?: {
         'name': string;
@@ -33,6 +38,12 @@ export declare type PackageManifest = {
         'callbackUrl': string;
         'callbackEvents': string[];
     }[];
+    'settings'?: {
+        'name': string;
+        'label': string;
+        'description': string;
+        'type': SettingType;
+    }[];
 };
 /**
  * @param manifestOverrideEnv The environment to override the manifest with

package/src/packagemanifest.js

@@ -1,9 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.readManifest = void 0;
+exports.readManifest = exports.SettingType = void 0;
 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";
+})(SettingType = exports.SettingType || (exports.SettingType = {}));
 const versionRegex = /^\d+\.\d+\.\d+$/;
 function validateManifestOrThrow(manifest) {
     if (!(0, checks_1.isObject)(manifest)) {
@@ -12,10 +18,36 @@ function validateManifestOrThrow(manifest) {
     if (!(0, checks_1.isString)(manifest['version']) || !versionRegex.test(manifest['version'])) {
         throw new Error('manifest.json: "version" must be a string in the format <major>.<minor>.<patch>');
     }
+    function validateUniqueNames(kindOfThings, things) {
+        if (new Set(things.map((one) => one['name'])).size !== things.length) {
+            throw new Error(kindOfThings + ' must have unique named');
+        }
+    }
+    if (manifest['settings']) {
+        if (!(0, checks_1.isTypedArray)(checks_1.isObject)(manifest['settings'])) {
+            throw new Error('manifest.json: "settings" must be an array of objects');
+        }
+        validateUniqueNames('settings', manifest['settings']);
+        for (const setting of manifest['settings']) {
+            if (!(0, checks_1.isString)(setting['name'])) {
+                throw new Error('manifest.json: setting "name" must be a string');
+            }
+            if (!(0, checks_1.isString)(setting['label'])) {
+                throw new Error('manifest.json: setting "label" must be a string');
+            }
+            if (!(0, checks_1.isString)(setting['description'])) {
+                throw new Error('manifest.json: setting "description" must be a string');
+            }
+            if (!(0, validators_1.enumValidator)(SettingType)(setting['type'])) {
+                throw new Error('manifest.json: setting "type" must be "string"');
+            }
+        }
+    }
     if (manifest['extensions']) {
         if (!(0, checks_1.isTypedArray)(checks_1.isObject)(manifest['extensions'])) {
             throw new Error('manifest.json: "extensions" must be an array of objects');
         }
+        validateUniqueNames('extensions', manifest['extensions']);
         for (const extension of manifest['extensions']) {
             if (!(0, checks_1.isString)(extension['name'])) {
                 throw new Error('manifest.json: extension "name" must be a string');
@@ -29,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}`);
+                }
             }
         }
     }
@@ -40,6 +83,7 @@ function validateManifestOrThrow(manifest) {
         if (!(0, checks_1.isTypedArray)(checks_1.isObject)(manifest['shapeLibraries'])) {
             throw new Error('manifest.json: "shapeLibraries" must be an array of objects');
         }
+        validateUniqueNames('shapeLibraries', manifest['shapeLibraries']);
         for (const shapeLibrary of manifest['shapeLibraries']) {
             if (!(0, checks_1.isString)(shapeLibrary['name'])) {
                 throw new Error('manifest.json: shape library "name" must be a string');
@@ -56,6 +100,7 @@ function validateManifestOrThrow(manifest) {
         if (!(0, checks_1.isTypedArray)(checks_1.isObject)(manifest['oauthProviders'])) {
             throw new Error('manifest.json: "oauthProviders" must be an array of objects');
         }
+        validateUniqueNames('oauthProviders', manifest['oauthProviders']);
         for (const provider of manifest['oauthProviders']) {
             if (!(0, checks_1.isString)(provider['name'])) {
                 throw new Error('manifest.json: OAuth provider "name" must be a string');
@@ -93,6 +138,7 @@ function validateManifestOrThrow(manifest) {
         if (!(0, checks_1.isTypedArray)(checks_1.isObject)(manifest['mergeProviders'])) {
             throw new Error('manifest.json: "mergeProviders" must be an array of objects');
         }
+        validateUniqueNames('mergeProviders', manifest['mergeProviders']);
         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');
@@ -112,6 +158,7 @@ function validateManifestOrThrow(manifest) {
         if (!(0, checks_1.isTypedArray)(checks_1.isObject)(manifest['dataConnectors'])) {
             throw new Error('manifest.json: "dataConnectors" must be an array of objects');
         }
+        validateUniqueNames('dataConnectors', manifest['dataConnectors']);
         for (const provider of manifest['dataConnectors']) {
             if (!(0, checks_1.isString)(provider['name'])) {
                 throw new Error('manifest.json: Data connector "name" must be a string');

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 = {}));