lucid-package 0.0.8 → 0.0.11

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-package",
-    "version": "0.0.8",
+    "version": "0.0.11",
     "description": "",
     "main": "index.js",
     "bin": {
@@ -23,10 +23,14 @@
         "express": "^4.17.1",
         "hjson": "^3.2.2",
         "jszip": "^3.7.1",
+        "lucid-extension-sdk": "^0.0.8",
         "password-prompt": "^1.1.2",
         "ts-loader": "^9.2.6",
         "webpack": "^5.64.4",
         "webpack-cli": "^4.9.1",
         "ws": "^8.5.0"
+    },
+    "engines": {
+        "node": ">=14.0.0"
     }
 }

package/src/editorextension.js

@@ -13,11 +13,15 @@ async function createEditorExtension(name, isInternalTesting) {
     console.log('Creating empty editor extension in editorextensions/' + name);
     (0, filesystemutil_1.copyFolderRecursiveSync)(__dirname + '/../templates/editorextension', 'editorextensions/' + name);
     await (0, package_1.modifyManifest)((manifest) => {
+        if (!manifest['extensions']) {
+            manifest['extensions'] = [];
+        }
         manifest['extensions'].push({
             'name': name,
             'title': name,
+            'product': 'chart',
             'codePath': `editorextensions/${name}/bin/extension.js`,
-            'scopes': ['READ', 'WRITE', 'DOWNLOAD', 'SHOW_MODAL', 'NETWORK'],
+            'scopes': ['READ', 'WRITE', 'DOWNLOAD', 'SHOW_MODAL', 'CUSTOM_UI', 'NETWORK'],
         });
     });
     console.log(`Installing dependencies`);
@@ -61,9 +65,30 @@ async function debugEditorExtension(name) {
         res.send((await fs.readFile('bin/extension.js')).toString());
     });
     app.get('/scopes', async (req, res) => {
+        var _a, _b;
+        const manifest = await (0, packagemanifest_1.readManifest)('../../');
+        res.send(JSON.stringify((_b = (_a = manifest['extensions']) === null || _a === void 0 ? void 0 : _a.find((extension) => extension['name'] === name)) === null || _b === void 0 ? void 0 : _b.scopes));
+    });
+    app.get('/packageId', async (req, res) => {
         var _a;
         const manifest = await (0, packagemanifest_1.readManifest)('../../');
-        res.send(JSON.stringify((_a = manifest['extensions'].find((extension) => extension['name'] === name)) === null || _a === void 0 ? void 0 : _a.scopes));
+        res.send((_a = manifest['id']) !== null && _a !== void 0 ? _a : '__local__');
+    });
+    app.get('/editorextension', async (req, res) => {
+        var _a, _b, _c, _d;
+        const manifest = await (0, packagemanifest_1.readManifest)('../../');
+        const extensionManifest = (_a = manifest['extensions']) === null || _a === void 0 ? void 0 : _a.find((one) => one['name'] === name);
+        res.send({
+            id: '__local__',
+            packageId: (_b = manifest['id']) !== null && _b !== void 0 ? _b : '__local__',
+            packageVersionId: '__local__',
+            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',
+            scopes: extensionManifest === null || extensionManifest === void 0 ? void 0 : extensionManifest['scopes'],
+            codeUrl: 'http://localhost:9900/extension.js',
+        });
     });
     app.listen(9900, () => {
         console.log('Listening at http://localhost:9900/extension.js');

package/src/index.js

@@ -7,7 +7,7 @@ const shapelibrary_1 = require("./shapelibrary");
 class LucidSuiteExtensionCLI {
     run(args) {
         const parser = new argparse_1.ArgumentParser({
-            description: 'Create and manage Lucid extensibility packages',
+            description: 'Create and manage Lucid extension packages',
         });
         //When running with `bazel run //extensibility/lucid-package:dev`, this gives the root directory to create projects in.
         parser.add_argument('--chdir', { type: 'str', help: argparse_1.SUPPRESS });
@@ -18,10 +18,10 @@ class LucidSuiteExtensionCLI {
         });
         const subparsers = parser.add_subparsers({ dest: 'command' });
         const createParser = subparsers.add_parser('create', {
-            help: 'Create a new Lucid extensibility package in a new directory',
+            help: 'Create a new Lucid extension package in a new directory',
         });
         createParser.add_argument('name', { type: 'str' });
-        const packageParser = subparsers.add_parser('package', {
+        const packageParser = subparsers.add_parser('bundle', {
             help: 'Prepare the current package for upload to the developer dashboard',
         });
         const updateSDKParser = subparsers.add_parser('update-sdk', {
@@ -64,12 +64,12 @@ class LucidSuiteExtensionCLI {
             case 'create':
                 (0, package_1.createEmptyPackage)(parsed['name']);
                 break;
-            case 'package':
+            case 'bundle':
                 if ((0, package_1.currentlyInPackage)()) {
                     (0, package_1.writePackage)();
                 }
                 else {
-                    console.error('Not currently in a Lucid extensibility package folder');
+                    console.error('Not currently in a Lucid extension package folder');
                 }
                 break;
             case 'update-sdk':
@@ -77,7 +77,7 @@ class LucidSuiteExtensionCLI {
                     (0, package_1.updateAllExtensionSDK)();
                 }
                 else {
-                    console.error('Not currently in a Lucid extensibility package folder');
+                    console.error('Not currently in a Lucid extension package folder');
                 }
                 break;
             case 'create-editor-extension':
@@ -85,7 +85,7 @@ class LucidSuiteExtensionCLI {
                     (0, editorextension_1.createEditorExtension)(parsed['name'], isInternalTesting);
                 }
                 else {
-                    console.error('Not currently in a Lucid extensibility package folder');
+                    console.error('Not currently in a Lucid extension package folder');
                 }
                 break;
             case 'build-editor-extension':
@@ -93,7 +93,7 @@ class LucidSuiteExtensionCLI {
                     (0, editorextension_1.buildEditorExtension)(parsed['name']);
                 }
                 else {
-                    console.error('Not currently in a Lucid extensibility package folder');
+                    console.error('Not currently in a Lucid extension package folder');
                 }
                 break;
             case 'create-shape-library':
@@ -101,7 +101,7 @@ class LucidSuiteExtensionCLI {
                     (0, shapelibrary_1.createEmptyShapeLibrary)(parsed['name']);
                 }
                 else {
-                    console.error('Not currently in a Lucid extensibility package folder');
+                    console.error('Not currently in a Lucid extension package folder');
                 }
                 break;
             case 'test-shape-libraries':
@@ -109,7 +109,7 @@ class LucidSuiteExtensionCLI {
                     (0, shapelibrary_1.debugShapeLibraries)();
                 }
                 else {
-                    console.error('Not currently in a Lucid extensibility package folder');
+                    console.error('Not currently in a Lucid extension package folder');
                 }
                 break;
             case 'test-editor-extension':
@@ -117,7 +117,7 @@ class LucidSuiteExtensionCLI {
                     (0, editorextension_1.debugEditorExtension)(parsed['name']);
                 }
                 else {
-                    console.error('Not currently in a Lucid extensibility package folder');
+                    console.error('Not currently in a Lucid extension package folder');
                 }
                 break;
             default:

package/src/package.js

@@ -18,7 +18,7 @@ function currentlyInPackage() {
     return (fsOld.existsSync('editorextensions') && fsOld.existsSync('shapelibraries') && fsOld.existsSync('manifest.json'));
 }
 exports.currentlyInPackage = currentlyInPackage;
-const allScopes = new Set(['DOWNLOAD', 'NETWORK', 'READ', 'SHOW_MODAL', 'WRITE']);
+const allScopes = new Set(['DOWNLOAD', 'NETWORK', 'READ', 'SHOW_MODAL', 'CUSTOM_UI', 'WRITE']);
 async function modifyManifest(callback) {
     const manifest = await (0, packagemanifest_1.readManifest)();
     await callback(manifest);
@@ -26,7 +26,8 @@ async function modifyManifest(callback) {
 }
 exports.modifyManifest = modifyManifest;
 async function updateAllExtensionSDK() {
-    for (const extension of (await (0, packagemanifest_1.readManifest)()).extensions) {
+    const manifest = await (0, packagemanifest_1.readManifest)();
+    for (const extension of manifest['extensions'] || []) {
         const parts = extension['codePath'].split('/');
         if (parts[0] === 'editorextensions') {
             await (0, editorextension_1.updateExtensionSDK)(parts[1]);
@@ -42,7 +43,7 @@ async function writePackage() {
         parts[parts.length - 1] = String(parseInt(parts[parts.length - 1], 10) + 1);
         manifest['version'] = parts.join('.');
         //For each extension, compile it and add it to the archive
-        for (const extension of manifest['extensions']) {
+        for (const extension of manifest['extensions'] || []) {
             //Check that the scopes are valid
             if (!extension['scopes'].every((one) => allScopes.has(one))) {
                 console.error(`Invalid scope specified for extension ${extension['name']}: ${extension['scopes']
@@ -61,7 +62,7 @@ async function writePackage() {
             zip.file(extension['codePath'], await fs.readFile(extension['codePath']));
         }
         //Do the same for each shape library
-        for (const library of manifest['shapeLibraries']) {
+        for (const library of manifest['shapeLibraries'] || []) {
             const parts = library['lcszPath'].split('/');
             if (parts[0] === 'shapelibraries') {
                 console.log(`Building shape library ${parts[1]}`);

package/src/packagemanifest.d.ts

@@ -1,15 +1,31 @@
 export declare type PackageManifest = {
+    'id'?: string;
     'version': string;
-    'extensions': {
+    'extensions'?: {
         'name': string;
         'title': string;
         'codePath': string;
         'scopes': string[];
+        'product': 'chart' | 'spark';
     }[];
-    'shapeLibraries': {
+    'shapeLibraries'?: {
         'name': string;
         'product': 'chart' | 'spark';
         'lcszPath': string;
     }[];
+    'oauthProviders'?: {
+        'name': string;
+        'title': string;
+        'tokenUrl': string;
+        'authorizationUrl': string;
+        'scopes': string[];
+        'domainWhitelist': string[];
+    }[];
+    'dataConnectors'?: {
+        'name': string;
+        'oauthProviderName': string;
+        'callbackUrl': string;
+        'callbackEvents': string[];
+    }[];
 };
 export declare function readManifest(path?: string): Promise<PackageManifest>;

package/src/packagemanifest.js

@@ -2,7 +2,101 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.readManifest = void 0;
 const fs = require("fs/promises");
+const checks_1 = require("lucid-extension-sdk/sdk/core/checks");
+const versionRegex = /^\d+\.\d+\.\d+$/;
+function validateManifestOrThrow(manifest) {
+    if (!(0, checks_1.isObject)(manifest)) {
+        throw new Error('manifest.json must be a valid JSON object');
+    }
+    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>');
+    }
+    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');
+        }
+        for (const extension of manifest['extensions']) {
+            if (!(0, checks_1.isString)(extension['name'])) {
+                throw new Error('manifest.json: extension "name" must be a string');
+            }
+            if (!(0, checks_1.isString)(extension['title'])) {
+                throw new Error('manifest.json: extension "title" must be a string');
+            }
+            if (!(0, checks_1.isString)(extension['codePath'])) {
+                throw new Error('manifest.json: extension "codePath" must be a string');
+            }
+            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 (manifest['shapeLibraries']) {
+        if (!(0, checks_1.isTypedArray)(checks_1.isObject)(manifest['shapeLibraries'])) {
+            throw new Error('manifest.json: "shapeLibraries" must be an array of objects');
+        }
+        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');
+            }
+            if (!(0, checks_1.isString)(shapeLibrary['lcszPath'])) {
+                throw new Error('manifest.json: shape library "lcszPath" must be a string');
+            }
+            if (shapeLibrary['product'] !== 'chart' && shapeLibrary['product'] !== 'spark') {
+                throw new Error('manifest.json: shape library "product" must be "chart" or "spark"');
+            }
+        }
+    }
+    if (manifest['oauthProviders']) {
+        if (!(0, checks_1.isTypedArray)(checks_1.isObject)(manifest['oauthProviders'])) {
+            throw new Error('manifest.json: "oauthProviders" must be an array of objects');
+        }
+        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');
+            }
+            if (!(0, checks_1.isString)(provider['title'])) {
+                throw new Error('manifest.json: OAuth provider "title" must be a string');
+            }
+            if (!(0, checks_1.isString)(provider['tokenUrl'])) {
+                throw new Error('manifest.json: OAuth provider "tokenUrl" must be a string');
+            }
+            if (!(0, checks_1.isString)(provider['authorizationUrl'])) {
+                throw new Error('manifest.json: OAuth provider "authorizationUrl" must be a string');
+            }
+            if (!(0, checks_1.isTypedArray)(checks_1.isString)(provider['scopes'])) {
+                throw new Error('manifest.json: OAuth provider "scopes" must be a string array');
+            }
+            if (!(0, checks_1.isTypedArray)(checks_1.isString)(provider['domainWhitelist'])) {
+                throw new Error('manifest.json: OAuth provider "domainWhitelist" must be a string array');
+            }
+        }
+    }
+    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');
+        }
+        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');
+            }
+            if (!(0, checks_1.isString)(provider['oauthProviderName'])) {
+                throw new Error('manifest.json: Data connector "oauthProviderName" must be a string');
+            }
+            if (!(0, checks_1.isString)(provider['callbackUrl'])) {
+                throw new Error('manifest.json: Data connector "callbackUrl" must be a string');
+            }
+            if (!(0, checks_1.isTypedArray)(checks_1.isString)(provider['callbackEvents'])) {
+                throw new Error('manifest.json: Data connector "callbackEvents" must be a string array');
+            }
+        }
+    }
+}
 async function readManifest(path = './') {
-    return JSON.parse((await fs.readFile(path + 'manifest.json')).toString());
+    const raw = JSON.parse((await fs.readFile(path + 'manifest.json')).toString());
+    validateManifestOrThrow(raw);
+    return raw;
 }
 exports.readManifest = readManifest;

package/src/shapelibrary.js

@@ -16,6 +16,9 @@ async function createEmptyShapeLibrary(name) {
     console.log('Creating shape library in shapelibraries/' + name);
     (0, filesystemutil_1.copyFolderRecursiveSync)(__dirname + '/../templates/shapelibrary', 'shapelibraries/' + name);
     await (0, package_1.modifyManifest)((manifest) => {
+        if (!manifest['shapeLibraries']) {
+            manifest['shapeLibraries'] = [];
+        }
         manifest['shapeLibraries'].push({
             'name': name,
             'product': 'chart',

package/templates/package/manifest.json

@@ -1,5 +1,7 @@
 {
-  "version": "1.0.0",
-  "extensions": [],
-  "shapeLibraries":[]
+    "id": "",
+    "version": "1.0.0",
+    "extensions": [],
+    "shapeLibraries": [],
+    "oauthProviders": []
 }