lucid-package 0.0.28 → 0.0.30

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-package",
-    "version": "0.0.28",
+    "version": "0.0.30",
     "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)();
+        const manifest = await (0, packagemanifest_1.readManifest)(true);
         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)();
+        const manifest = await (0, packagemanifest_1.readManifest)(true);
         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)();
+            const manifest = await (0, packagemanifest_1.readManifest)(true);
             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)();
+    const manifest = await (0, packagemanifest_1.readManifest)(true);
     const extensionManifest = (_a = manifest['extensions']) === null || _a === void 0 ? void 0 : _a.find((one) => one['name'] === name);
     return {
         id: '__local__',

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);
@@ -20,13 +20,13 @@ 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)();
+    const manifest = await (0, packagemanifest_1.readManifest)(false);
     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)();
+    const manifest = await (0, packagemanifest_1.readManifest)(false);
     for (const extension of manifest['extensions'] || []) {
         const parts = extension['codePath'].split('/');
         if (parts[0] === 'editorextensions') {
@@ -66,7 +66,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']));
         }

package/src/packagemanifest.d.ts

@@ -28,4 +28,4 @@ export declare type PackageManifest = {
         'callbackEvents': string[];
     }[];
 };
-export declare function readManifest(path?: string): Promise<PackageManifest>;
+export declare function readManifest(includeLocalOverrides: boolean, path?: string): Promise<PackageManifest>;

package/src/packagemanifest.js

@@ -106,8 +106,45 @@ function validateManifestOrThrow(manifest) {
         }
     }
 }
-async function readManifest(path = './') {
+function deepMixin(target, mixin) {
+    if ((0, checks_1.isArray)(target) && (0, checks_1.isArray)(mixin)) {
+        for (let i = 0; i < mixin.length; i++) {
+            const value = mixin[i];
+            if (i >= target.length) {
+                target[i] = value;
+            }
+            else if ((0, checks_1.isObject)(value) || (0, checks_1.isArray)(value)) {
+                deepMixin(target[i], value);
+            }
+            else {
+                target[i] = value;
+            }
+        }
+    }
+    else if ((0, checks_1.isObject)(target) && (0, checks_1.isObject)(mixin)) {
+        for (var key in mixin) {
+            const value = mixin[key];
+            if ((0, checks_1.isObject)(value) || (0, checks_1.isArray)(value)) {
+                deepMixin(target[key], value);
+            }
+            else {
+                target[key] = value;
+            }
+        }
+    }
+}
+async function readManifest(includeLocalOverrides, path = './') {
     const raw = JSON.parse((await fs.readFile(path + 'manifest.json')).toString());
+    if (includeLocalOverrides) {
+        try {
+            const overrides = JSON.parse((await fs.readFile(path + 'manifest.local.json')).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);
+        }
+    }
     validateManifestOrThrow(raw);
     return 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)(packagePath + '/');
+    const packageManifest = await (0, packagemanifest_1.readManifest)(true, 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)(packagePath + '/');
+        const manifest = await (0, packagemanifest_1.readManifest)(true, 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;