npm - lucid-package - Versions diffs - 0.0.36 → 0.0.38 - Mend

lucid-package 0.0.36 → 0.0.38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (3) hide show

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
     "name": "lucid-package",
-    "version": "0.0.36",
+    "version": "0.0.38",
     "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/packagemanifest.d.ts CHANGED Viewed

@@ -1,3 +1,6 @@
+export declare enum SettingType {
+    STRING = "string"
+}
 export declare type PackageManifest = {
     'id'?: string;
     'version': string;
@@ -6,7 +9,7 @@ export declare type PackageManifest = {
         'title': string;
         'codePath': string;
         'scopes': string[];
-        'product': 'chart' | 'spark';
+        'product': 'chart' | 'spark' | 'teamspaces';
     }[];
     'shapeLibraries'?: {
         'name': string;
@@ -33,6 +36,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 CHANGED Viewed

@@ -1,9 +1,14 @@
 "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");
+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 +17,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,8 +60,10 @@ 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') {
-                throw new Error('manifest.json: extension "product" must be "chart" or "spark"');
+            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"`);
             }
         }
     }
@@ -38,6 +71,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');
@@ -54,6 +88,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');
@@ -91,6 +126,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');
@@ -110,6 +146,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');