lucid-package 0.0.29 → 0.0.31

package/package.json

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

package/src/editorextension.js

@@ -10,6 +10,7 @@ const child_process = require("child_process");
 const shapelibrary_1 = require("./shapelibrary");
 const packagemanifest_1 = require("./packagemanifest");
 const path = require("path");
+const shellutil_1 = require("./shellutil");
 const WebPackCLI = require('webpack-cli');
 function linkInternalTestingSDK() {
     if (!oldFs.existsSync('node_modules/lucid-extension-sdk')) {
@@ -19,12 +20,12 @@ function linkInternalTestingSDK() {
         const sdkPath = cwd.substr(0, pos + rootSearch.length) + 'lucid-extension-sdk';
         const relativePath = path.relative(cwd, sdkPath);
         console.log('Using symlink for dependency on SDK for internal testing');
-        console.log(child_process.execSync(`npm install --silent --save ${relativePath}`).toString());
+        console.log((0, shellutil_1.execSyncLoggingOutputOnError)(`npm install --silent --save ${relativePath}`).toString());
     }
 }
 function installDependenciesIfNeeded(isInternalTesting) {
     if (!oldFs.existsSync('node_modules')) {
-        console.log(child_process.execSync('npm install --silent').toString());
+        console.log((0, shellutil_1.execSyncLoggingOutputOnError)('npm install --silent').toString());
     }
     if (!oldFs.existsSync('node_modules/lucid-extension-sdk')) {
         if (isInternalTesting) {
@@ -32,7 +33,7 @@ function installDependenciesIfNeeded(isInternalTesting) {
         }
         else {
             console.log('Adding dependency on SDK');
-            console.log(child_process.execSync('npm install --save lucid-extension-sdk').toString());
+            console.log((0, shellutil_1.execSyncLoggingOutputOnError)('npm install --save lucid-extension-sdk').toString());
         }
     }
 }
@@ -66,7 +67,7 @@ exports.buildEditorExtension = buildEditorExtension;
 async function updateExtensionSDK(name) {
     process.chdir('editorextensions/' + name);
     console.log('Installing latest SDK in extension ' + name);
-    console.log(child_process.execSync('npm install lucid-extension-sdk@latest').toString());
+    console.log((0, shellutil_1.execSyncLoggingOutputOnError)('npm install lucid-extension-sdk@latest').toString());
 }
 exports.updateExtensionSDK = updateExtensionSDK;
 /**
@@ -113,12 +114,12 @@ async function debugEditorExtension(extensionNames, quiet = false) {
     app.get(['/scopes', '/editorextension/:name/scopes'], async (req, res) => {
         var _a, _b, _c;
         const name = (_a = req.params['name']) !== null && _a !== void 0 ? _a : extensionNames[0];
-        const manifest = await (0, packagemanifest_1.readManifest)(true);
+        const manifest = await (0, packagemanifest_1.readManifest)('local');
         res.send(JSON.stringify((_c = (_b = manifest['extensions']) === null || _b === void 0 ? void 0 : _b.find((extension) => extension['name'] === name)) === null || _c === void 0 ? void 0 : _c.scopes));
     });
     app.get('/packageId', async (req, res) => {
         var _a;
-        const manifest = await (0, packagemanifest_1.readManifest)(true);
+        const manifest = await (0, packagemanifest_1.readManifest)('local');
         res.send((_a = manifest['id']) !== null && _a !== void 0 ? _a : '__local__');
     });
     app.get(['/editorextension', '/editorextension/:name'], async (req, res) => {
@@ -134,7 +135,7 @@ async function debugEditorExtension(extensionNames, quiet = false) {
         var _a;
         const name = req.params['name'];
         if (name) {
-            const manifest = await (0, packagemanifest_1.readManifest)(true);
+            const manifest = await (0, packagemanifest_1.readManifest)('local');
             const provider = (_a = manifest['oauthProviders']) === null || _a === void 0 ? void 0 : _a.find((one) => one.name === name);
             if (provider && oldFs.existsSync(`${name}.credentials.local`)) {
                 const credentials = JSON.parse((await fs.readFile(`${name}.credentials.local`)).toString());
@@ -156,7 +157,7 @@ async function debugEditorExtension(extensionNames, quiet = false) {
 exports.debugEditorExtension = debugEditorExtension;
 async function getRawEditorExtension(name) {
     var _a, _b, _c, _d;
-    const manifest = await (0, packagemanifest_1.readManifest)(true);
+    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);
     return {
         id: '__local__',

package/src/index.js

@@ -29,6 +29,9 @@ class LucidSuiteExtensionCLI {
             action: 'store_true',
             help: argparse_1.SUPPRESS,
         });
+        packageParser.add_argument('--env', {
+            help: 'Provide the environment to define which manifest.<env>.json is combined with manifest.json when bundling. If not provided, uses manifest.json only.',
+        });
         const updateSDKParser = subparsers.add_parser('update-sdk', {
             help: 'Update the editor extension SDK to the latest published version for all editor extensions in this package',
         });
@@ -95,7 +98,7 @@ class LucidSuiteExtensionCLI {
                 break;
             case 'bundle':
                 if ((0, package_1.currentlyInPackage)()) {
-                    await (0, package_1.writePackage)(parsed['quiet']);
+                    await (0, package_1.writePackage)(parsed['quiet'], parsed['env']);
                 }
                 else {
                     console.error('Not currently in a Lucid extension package folder');

package/src/package.d.ts

@@ -1,6 +1,10 @@
 import { PackageManifest } from './packagemanifest';
 export declare function createEmptyPackage(root: string): Promise<void>;
 export declare function currentlyInPackage(): boolean;
-export declare function modifyManifest(callback: (manifest: PackageManifest) => void | Promise<void>): Promise<void>;
+export declare function modifyManifest(callback: (manifest: PackageManifest) => void | Promise<void>, manifestOverrideEnv?: string): Promise<void>;
 export declare function updateAllExtensionSDK(): Promise<void>;
-export declare function writePackage(quiet?: boolean): Promise<void>;
+/**
+ *
+ * @param manifestOverrideEnv The environment definine what manifest to read from. `manifest.env.json`
+ */
+export declare function writePackage(quiet?: boolean, manifestOverrideEnv?: string): Promise<void>;

package/src/package.js

@@ -1,7 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.writePackage = exports.updateAllExtensionSDK = exports.modifyManifest = exports.currentlyInPackage = exports.createEmptyPackage = void 0;
-const child_process = require("child_process");
 const fsOld = require("fs");
 const fs = require("fs/promises");
 const JSZip = require("jszip");
@@ -9,6 +8,7 @@ const editorextension_1 = require("./editorextension");
 const filesystemutil_1 = require("./filesystemutil");
 const packagemanifest_1 = require("./packagemanifest");
 const shapelibrary_1 = require("./shapelibrary");
+const shellutil_1 = require("./shellutil");
 async function createEmptyPackage(root) {
     console.log('Creating empty Lucid Suite package in ' + root);
     (0, filesystemutil_1.copyFolderRecursiveSync)(__dirname + '/../templates/package', root);
@@ -19,14 +19,14 @@ function currentlyInPackage() {
 }
 exports.currentlyInPackage = currentlyInPackage;
 const allScopes = new Set(['DOWNLOAD', 'NETWORK', 'READ', 'SHOW_MODAL', 'CUSTOM_UI', 'WRITE']);
-async function modifyManifest(callback) {
-    const manifest = await (0, packagemanifest_1.readManifest)(false);
+async function modifyManifest(callback, manifestOverrideEnv) {
+    const manifest = await (0, packagemanifest_1.readManifest)(manifestOverrideEnv);
     await callback(manifest);
     await fs.writeFile('manifest.json', JSON.stringify(manifest, undefined, 2));
 }
 exports.modifyManifest = modifyManifest;
 async function updateAllExtensionSDK() {
-    const manifest = await (0, packagemanifest_1.readManifest)(false);
+    const manifest = await (0, packagemanifest_1.readManifest)();
     for (const extension of manifest['extensions'] || []) {
         const parts = extension['codePath'].split('/');
         if (parts[0] === 'editorextensions') {
@@ -35,7 +35,11 @@ async function updateAllExtensionSDK() {
     }
 }
 exports.updateAllExtensionSDK = updateAllExtensionSDK;
-async function writePackage(quiet = false) {
+/**
+ *
+ * @param manifestOverrideEnv The environment definine what manifest to read from. `manifest.env.json`
+ */
+async function writePackage(quiet = false, manifestOverrideEnv) {
     const zip = new JSZip();
     //Increment the patch number automatically on each build
     await modifyManifest(async (manifest) => {
@@ -66,7 +70,7 @@ async function writePackage(quiet = false) {
                     parts[1] +
                     '"';
                 console.log(cmd);
-                console.log(child_process.execSync(cmd).toString());
+                console.log((0, shellutil_1.execSyncLoggingOutputOnError)(cmd).toString());
             }
             zip.file(extension['codePath'], await fs.readFile(extension['codePath']));
         }
@@ -84,7 +88,8 @@ async function writePackage(quiet = false) {
         //Write out the zip file
         const zipBytes = await zip.generateAsync({ type: 'uint8array' });
         console.log('Writing file package.zip');
-        await fs.writeFile('package.zip', zipBytes);
-    });
+        const fileName = `package${manifestOverrideEnv ? `-${manifestOverrideEnv}` : ''}.zip`;
+        await fs.writeFile(fileName, zipBytes);
+    }, manifestOverrideEnv);
 }
 exports.writePackage = writePackage;

package/src/packagemanifest.d.ts

@@ -28,4 +28,8 @@ export declare type PackageManifest = {
         'callbackEvents': string[];
     }[];
 };
-export declare function readManifest(includeLocalOverrides: boolean, path?: string): Promise<PackageManifest>;
+/**
+ * @param manifestOverrideEnv The environment to override the manifest with
+ * @param path The path to read the manifest from
+ */
+export declare function readManifest(manifestOverrideEnv?: string, path?: string): Promise<PackageManifest>;

package/src/packagemanifest.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.readManifest = void 0;
-const fs = require("fs/promises");
+const fs = require("fs");
+const fsPromises = require("fs/promises");
 const checks_1 = require("lucid-extension-sdk/sdk/core/checks");
 const versionRegex = /^\d+\.\d+\.\d+$/;
 function validateManifestOrThrow(manifest) {
@@ -133,16 +134,28 @@ function deepMixin(target, mixin) {
         }
     }
 }
-async function readManifest(includeLocalOverrides, path = './') {
-    const raw = JSON.parse((await fs.readFile(path + 'manifest.json')).toString());
-    if (includeLocalOverrides) {
+/**
+ * @param manifestOverrideEnv The environment to override the manifest with
+ * @param path The path to read the manifest from
+ */
+async function readManifest(manifestOverrideEnv, path = './') {
+    const raw = JSON.parse((await fsPromises.readFile(path + 'manifest.json')).toString());
+    if (manifestOverrideEnv) {
+        const manifestOverridePath = path + `manifest.${manifestOverrideEnv}.json`;
         try {
-            const overrides = JSON.parse((await fs.readFile(path + 'manifest.local.json')).toString());
+            const overrides = JSON.parse((await fsPromises.readFile(manifestOverridePath)).toString());
             deepMixin(raw, overrides);
         }
         catch (e) {
-            //No need to do anything; local overrides are just invalid
-            console.warn('Local manifest overrides could not be applied', e);
+            if (manifestOverrideEnv == 'local') {
+                // Warn if the file exists (this means it's invalid), otherwise fail silently
+                if (fs.existsSync(manifestOverridePath)) {
+                    console.warn('Local manifest overrides could not be applied', e);
+                }
+            }
+            else {
+                throw new Error(`Missing or malformated \"manifest.${manifestOverrideEnv}.json\". Please create and run the command again.`);
+            }
         }
     }
     validateManifestOrThrow(raw);

package/src/shapelibrary.js

@@ -38,7 +38,7 @@ const defaultNameMap = new Map([
 //Produce JSON equivalent to the document service's
 // /shapeLibraries/:name/shapes endpoint
 async function getShapeListJson(name, packagePath) {
-    const packageManifest = await (0, packagemanifest_1.readManifest)(true, packagePath + '/');
+    const packageManifest = await (0, packagemanifest_1.readManifest)('local', packagePath + '/');
     const rawManifest = await fs.readFile(packagePath + `/shapelibraries/${name}/library.manifest`);
     const manifest = hjson.parse(rawManifest.toString());
     const usedNames = new Set(manifest['shapes'].map((shape) => shape['key']).filter((key) => key !== undefined));
@@ -161,7 +161,7 @@ async function debugShapeLibraries(packagePath = '.') {
     let shapeLibraryVersion = Date.now();
     app.get('/shapeLibraries', async (req, res) => {
         var _a;
-        const manifest = await (0, packagemanifest_1.readManifest)(true, packagePath + '/');
+        const manifest = await (0, packagemanifest_1.readManifest)('local', packagePath + '/');
         const libraries = (_a = manifest['shapeLibraries']) !== null && _a !== void 0 ? _a : [];
         const output = await Promise.all(libraries.map(async (libraryManifest) => {
             const libraryDefinitionContent = await fs.readFile(packagePath + '/shapelibraries/' + libraryManifest['name'] + '/library.manifest');

package/src/shellutil.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="node" />
+export declare function execSyncLoggingOutputOnError(cmd: string): Buffer;

package/src/shellutil.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.execSyncLoggingOutputOnError = void 0;
+const child_process = require("child_process");
+function execSyncLoggingOutputOnError(cmd) {
+    try {
+        return child_process.execSync(cmd);
+    }
+    catch (e) {
+        console.log(String(e.stdout));
+        console.error(String(e.stderr));
+        throw e;
+    }
+}
+exports.execSyncLoggingOutputOnError = execSyncLoggingOutputOnError;