lucid-package 0.0.48 → 0.0.50

package/package.json

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

package/src/editorextension.d.ts

@@ -12,4 +12,4 @@ export declare function watchEditorExtension(name: string, isInternalTesting: bo
  * @param extensionNames The names of the editor extensions
  * @param quiet If true, will only show errors in output
  */
-export declare function debugEditorExtension(extensionNames: string[], quiet?: boolean): Promise<void>;
+export declare function debugEditorExtension(extensionNames: string[], quiet?: boolean, pickAnyPort?: boolean): Promise<void>;

package/src/editorextension.js

@@ -88,7 +88,8 @@ exports.watchEditorExtension = watchEditorExtension;
  * @param extensionNames The names of the editor extensions
  * @param quiet If true, will only show errors in output
  */
-async function debugEditorExtension(extensionNames, quiet = false) {
+async function debugEditorExtension(extensionNames, quiet = false, pickAnyPort = false) {
+    let port = 9900;
     await Promise.all(extensionNames.map(async (name) => {
         const child = child_process.spawn(`${process.argv[0]} ${process.argv[1]} watch-editor-extension ${name} ${quiet ? '--quiet ' : ''}`, {
             stdio: 'inherit',
@@ -127,11 +128,11 @@ async function debugEditorExtension(extensionNames, quiet = false) {
     app.get(['/editorextension', '/editorextension/:name'], async (req, res) => {
         var _a;
         const name = (_a = req.params['name']) !== null && _a !== void 0 ? _a : extensionNames[0];
-        const rawExtension = await getRawEditorExtension(name);
+        const rawExtension = await getRawEditorExtension(name, port);
         res.send(rawExtension);
     });
     app.get('/editorextensions', async (req, res) => {
-        res.send(await Promise.all(extensionNames.map((name) => getRawEditorExtension(name))));
+        res.send(await Promise.all(extensionNames.map((name) => getRawEditorExtension(name, port))));
     });
     app.get('/settings', async (req, res) => {
         var _a;
@@ -167,10 +168,25 @@ async function debugEditorExtension(extensionNames, quiet = false) {
             res.sendStatus(404);
         }
     });
-    app.listen(9900, 'localhost', () => {
-        console.log('Listening at http://localhost:9900/extension.js');
-    });
-    (0, shapelibrary_1.debugShapeLibraries)();
+    const listen = () => {
+        app.listen(port, 'localhost', () => {
+            console.log('Listening at http://localhost:' + port + '/extension.js');
+            (0, shapelibrary_1.debugShapeLibraries)(undefined, pickAnyPort);
+        }).on('error', (err) => {
+            if (err.code === 'EADDRINUSE') {
+                if (pickAnyPort && port < 15000) {
+                    port++;
+                    listen();
+                }
+                else {
+                    console.error('Failed to listen for extension');
+                    console.error(err);
+                    process.exit(1);
+                }
+            }
+        });
+    };
+    listen();
 }
 exports.debugEditorExtension = debugEditorExtension;
 async function getExtensionManifest(name) {
@@ -202,7 +218,7 @@ async function getExtensionCodeDirectoryNameFromCodePath(codePath) {
     }
     return undefined;
 }
-async function getRawEditorExtension(name) {
+async function getRawEditorExtension(name, port) {
     var _a, _b, _c;
     const { manifest, extensionManifest } = await getExtensionManifest(name);
     const codePath = extensionManifest === null || extensionManifest === void 0 ? void 0 : extensionManifest['codePath'];
@@ -219,7 +235,7 @@ async function getRawEditorExtension(name) {
         title: (_c = extensionManifest === null || extensionManifest === void 0 ? void 0 : extensionManifest['title']) !== null && _c !== void 0 ? _c : 'Local dev extension',
         products: products,
         scopes: extensionManifest === null || extensionManifest === void 0 ? void 0 : extensionManifest['scopes'],
-        codeUrl: `http://localhost:9900/editorextension/${directory}/extension.js`,
+        codeUrl: `http://localhost:${port}/editorextension/${directory}/extension.js`,
     };
 }
 function getExtensionProducts(product, products) {

package/src/index.js

@@ -62,6 +62,11 @@ class LucidSuiteExtensionCLI {
             action: 'store_true',
             help: argparse_1.SUPPRESS,
         });
+        testExtensionParser.add_argument('--anyport', {
+            default: false,
+            action: 'store_true',
+            help: argparse_1.SUPPRESS,
+        });
         const watchExtensionParser = subparsers.add_parser('watch-editor-extension', {
             help: 'Compile an editor extension in debug mode',
         });
@@ -151,7 +156,7 @@ class LucidSuiteExtensionCLI {
                 break;
             case 'test-editor-extension':
                 if ((0, package_1.currentlyInPackage)()) {
-                    await (0, editorextension_1.debugEditorExtension)(parsed['name'], parsed['quiet']);
+                    await (0, editorextension_1.debugEditorExtension)(parsed['name'], parsed['quiet'], parsed['anyport']);
                 }
                 else {
                     console.error('Not currently in a Lucid extension package folder');

package/src/package.js

@@ -4,6 +4,7 @@ exports.writePackage = exports.updateAllExtensionSDK = exports.modifyManifest =
 const fsOld = require("fs");
 const fs = require("fs/promises");
 const JSZip = require("jszip");
+const lucid_extension_sdk_1 = require("lucid-extension-sdk");
 const editorextension_1 = require("./editorextension");
 const filesystemutil_1 = require("./filesystemutil");
 const packagemanifest_1 = require("./packagemanifest");
@@ -19,6 +20,7 @@ function currentlyInPackage() {
 }
 exports.currentlyInPackage = currentlyInPackage;
 const allScopes = new Set(['DOWNLOAD', 'NETWORK', 'READ', 'SHOW_MODAL', 'CUSTOM_UI', 'WRITE']);
+const uuidRegex = /^[a-f\d]{8}-[a-f\d]{4}-[a-f\d]{4}-[a-f\d]{4}-[a-f\d]{12}$/i;
 async function modifyManifest(callback, manifestOverrideEnv) {
     const manifest = await (0, packagemanifest_1.readManifest)(manifestOverrideEnv);
     await callback(manifest);
@@ -43,6 +45,9 @@ async function writePackage(quiet = false, manifestOverrideEnv) {
     const zip = new JSZip();
     //Increment the patch number automatically on each build
     await modifyManifest(async (manifest) => {
+        if (manifest['id'] !== undefined && (!(0, lucid_extension_sdk_1.isString)(manifest['id']) || !uuidRegex.test(manifest['id']))) {
+            throw new Error('manifest.json: If "id" is specified, must be a UUID matching the package ID from the Lucid developer portal');
+        }
         const parts = manifest['version'].split('.');
         parts[parts.length - 1] = String(parseInt(parts[parts.length - 1], 10) + 1);
         manifest['version'] = parts.join('.');

package/src/packagemanifest.js

@@ -10,14 +10,10 @@ var SettingType;
     SettingType["STRING"] = "string";
 })(SettingType = exports.SettingType || (exports.SettingType = {}));
 const versionRegex = /^\d+\.\d+\.\d+$/;
-const uuidRegex = /^[a-f\d]{8}-[a-f\d]{4}-[a-f\d]{4}-[a-f\d]{4}-[a-f\d]{12}$/i;
 function validateManifestOrThrow(manifest) {
     if (!(0, lucid_extension_sdk_1.isObject)(manifest)) {
         throw new Error('manifest.json must be a valid JSON object');
     }
-    if (manifest['id'] !== undefined && (!(0, lucid_extension_sdk_1.isString)(manifest['id']) || !uuidRegex.test(manifest['id']))) {
-        throw new Error('manifest.json: If "id" is specified, must be a UUID matching the package ID from the Lucid developer portal');
-    }
     if (!(0, lucid_extension_sdk_1.isString)(manifest['version']) || !versionRegex.test(manifest['version'])) {
         throw new Error('manifest.json: "version" must be a string in the format <major>.<minor>.<patch>');
     }

package/src/shapelibrary.d.ts

@@ -1,4 +1,4 @@
 export declare function createEmptyShapeLibrary(name: string): Promise<void>;
-export declare function getShapeListJson(name: string, packagePath: string): Promise<string>;
+export declare function getShapeListJson(name: string, packagePath: string, port?: number): Promise<string>;
 export declare function buildShapeLibrary(name: string): Promise<void>;
-export declare function debugShapeLibraries(packagePath?: string): Promise<void>;
+export declare function debugShapeLibraries(packagePath?: string, pickAnyPort?: boolean): Promise<void>;

package/src/shapelibrary.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.debugShapeLibraries = exports.buildShapeLibrary = exports.getShapeListJson = exports.createEmptyShapeLibrary = void 0;
 const express = require("express");
 const fs = require("fs/promises");
-const http = require("http");
 const JSZip = require("jszip");
 const path = require("path");
 const filesystemutil_1 = require("./filesystemutil");
@@ -37,7 +36,7 @@ const defaultNameMap = new Map([
 ]);
 //Produce JSON equivalent to the document service's
 // /shapeLibraries/:name/shapes endpoint
-async function getShapeListJson(name, packagePath) {
+async function getShapeListJson(name, packagePath, port = 9901) {
     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());
@@ -101,7 +100,7 @@ async function getShapeListJson(name, packagePath) {
                 }
                 else if (imageMap[key]['type'] == 'file') {
                     finalImageMap[key] =
-                        'http://localhost:9901/shapeLibraries/' +
+                        `http://localhost:${port}/shapeLibraries/` +
                             encodeURIComponent(name) +
                             '/images/' +
                             encodeURIComponent(imageMap[key]['path']);
@@ -121,8 +120,8 @@ async function getShapeListJson(name, packagePath) {
             'name': shapeManifest['name'],
             'order': index,
             'properties': JSON.stringify(properties),
-            'shapeLibrary': 'http://localhost:9901/shapeLibraries/' + encodeURIComponent(name),
-            'uri': `http://localhost:9901/shapeLibraries/${encodeURIComponent(name)}/shapes/${encodeURIComponent(shapeName)}`,
+            'shapeLibrary': `http://localhost:${port}/shapeLibraries/` + encodeURIComponent(name),
+            'uri': `http://localhost:${port}/shapeLibraries/${encodeURIComponent(name)}/shapes/${encodeURIComponent(shapeName)}`,
         };
     })));
 }
@@ -139,7 +138,12 @@ async function buildShapeLibrary(name) {
             }
         }
         else {
-            zip.file(source.replace(`shapelibraries/${name}/`, ''), await fs.readFile(source));
+            /**
+             * On Windows machines '\' is used as the file separator. To ensure that we correctly zip files on Windows
+             * machines we replace '\' with '/'.
+             */
+            const normalizedSource = path.sep === '\\' ? source.replace(/\\/g, '/') : source;
+            zip.file(normalizedSource.replace(`shapelibraries/${name}/`, ''), await fs.readFile(source));
         }
     };
     await addToZip(`shapelibraries/${name}`);
@@ -148,7 +152,8 @@ async function buildShapeLibrary(name) {
     await fs.writeFile(`shapelibraries/${name}.lcsz`, zipBytes);
 }
 exports.buildShapeLibrary = buildShapeLibrary;
-async function debugShapeLibraries(packagePath = '.') {
+async function debugShapeLibraries(packagePath = '.', pickAnyPort = false) {
+    let port = 9901;
     const app = express();
     app.use((req, res, next) => {
         res.header('Access-Control-Allow-Origin', '*');
@@ -167,7 +172,7 @@ async function debugShapeLibraries(packagePath = '.') {
             const libraryDefinitionContent = await fs.readFile(packagePath + '/shapelibraries/' + libraryManifest['name'] + '/library.manifest');
             const libraryDefinition = JSON.parse(libraryDefinitionContent.toString());
             return {
-                'uri': 'http://localhost:9901/shapeLibraries/' +
+                'uri': `http://localhost:${port}/shapeLibraries/` +
                     encodeURIComponent(libraryManifest['name']) +
                     '?version=' +
                     shapeLibraryVersion,
@@ -176,7 +181,7 @@ async function debugShapeLibraries(packagePath = '.') {
                 'name': libraryDefinition['name'],
                 'size': 0,
                 'accountId': 0,
-                'shapes': 'http://localhost:9901/shapeLibraries/' +
+                'shapes': `http://localhost:${port}/shapeLibraries/` +
                     encodeURIComponent(libraryManifest['name']) +
                     '/shapes',
                 'shared': false,
@@ -188,7 +193,7 @@ async function debugShapeLibraries(packagePath = '.') {
     });
     app.get('/shapeLibraries/:libraryName/shapes', async (req, res) => {
         //Find all the shapes in the given shape library, and produce JSON for the client
-        res.send(await getShapeListJson(req.params.libraryName, packagePath));
+        res.send(await getShapeListJson(req.params.libraryName, packagePath, port));
     });
     app.get('/shapeLibraries/:libraryName/images/:image', async (req, res) => {
         const oldcwd = process.cwd();
@@ -200,21 +205,36 @@ async function debugShapeLibraries(packagePath = '.') {
         process.chdir(oldcwd);
     });
     app.get('/shapeLibraries/');
-    const server = http.createServer(app);
-    //Watch for any shape library changes, and inform watchers that they need to refresh them.
-    const wss = new ws.Server({ server, path: '/shapeLibraries/changes' });
-    const sockets = [];
-    wss.on('connection', (ws) => {
-        sockets.push(ws);
-    });
-    chokidar.watch(packagePath + '/shapelibraries').on('all', () => {
-        shapeLibraryVersion = Date.now();
-        for (const socket of sockets) {
-            socket.send('refresh');
-        }
-    });
-    server.listen(9901, 'localhost', () => {
-        console.log('Listening at http://localhost:9901/shapeLibraries');
-    });
+    const listen = () => {
+        const server = app.listen(port, 'localhost', () => {
+            console.log('Listening at http://localhost:' + port + '/shapeLibraries');
+            //Watch for any shape library changes, and inform watchers that they need to refresh them.
+            const wss = new ws.Server({ server, path: '/shapeLibraries/changes' });
+            const sockets = [];
+            wss.on('connection', (ws) => {
+                sockets.push(ws);
+            });
+            chokidar.watch(packagePath + '/shapelibraries').on('all', () => {
+                shapeLibraryVersion = Date.now();
+                for (const socket of sockets) {
+                    socket.send('refresh');
+                }
+            });
+        });
+        server.on('error', (err) => {
+            if (err.code === 'EADDRINUSE') {
+                if (pickAnyPort && port < 15000) {
+                    port++;
+                    listen();
+                }
+                else {
+                    console.error('Failed to listen for shapes');
+                    console.error(err);
+                    process.exit(1);
+                }
+            }
+        });
+    };
+    listen();
 }
 exports.debugShapeLibraries = debugShapeLibraries;