lucid-package 0.0.12 → 0.0.17

package/README.md

@@ -6,72 +6,7 @@ CLI for creating and managing extension packages for the products of Lucid Softw
 
 ## Getting started
 
-### Step 1: Install `lucid-package` and create a new package
-
-An extension package is a set of Lucid product extensions that is installable by a Lucid
-account admin for use by all of their users. In order to start building an extension, you
-need to create a package to contain it.
-
-In a directory that will contain your extension packages:
-
-```
-npm install lucid-package
-npx lucid-package create my-new-package-name
-```
-
-### Step 2: Add an editor extension to your new package
-
-An editor extension is a piece of custom code that executes inside a Lucid product such
-as Lucidchart or Lucidspark. The `lucid-package` CLI provides a quick-start template to
-help you get up and running immediately.
-
-To add a new extension to your package:
-
-```
-cd my-new-package-name
-npx lucid-package create-editor-extension my-extension-name
-```
-
-### Step 3: Serve your extension code in debug mode to test it
-
-You don't need to package, upload, and install your extension in order to run it and
-make sure it works. The following command will start `webpack` on your code in `--watch`
-mode, and start up a local HTTP server that Lucid products can connect to, to load your
-latest code.
-
-To start the debug server:
-
-```
-npx lucid-package test-editor-extension my-extension-name
-```
-
-You can then enable loading of your local plugin in the Developer menu in Lucidchart
-by clicking `Load local extension`. The page will refresh and your extension code will run.
-
-The main entry point to your new editor extension is in `editorextensions/my-extension-name/src/extension.ts`.
-Experiment by changing code in that file and refreshing your browser tab to reload it.
-
-For all published extensions, and by default for this debug server as well, your code
-runs in a sandboxed JavaScript VM for security. However, this makes debugging difficult.
-If you turn on the `Debug local extensions (no sandbox)` option in the Developer menu,
-your code will be run via a scoped `eval`, allowing you to use the standard browser
-debugging tools to examine and step through your code.
-
-We recommend that you do all final validation of your extension with the normal
-sandbox enabled, however, as you may have inadvertently used features not allowed in
-the sandbox that won't work once you release your extension.
-
-### Step 4: Prepare your package for upload
-
-Once your editor extension works the way you want, you can package it for upload to the
-Lucid developer dashboard:
-
-```
-npx lucid-package package
-```
-
-This will create the file `package.zip` which is ready for upload to the [Lucid developer
-dashboard](https://lucid.app/developer).
+Please see our [Extension API Developer Docs](https://developer.lucid.co/extension-api/#lucid-extension-api).
 
 ## License
 

package/package.json

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

package/src/editorextension.d.ts

@@ -1,4 +1,4 @@
 export declare function createEditorExtension(name: string, isInternalTesting: boolean): Promise<void>;
-export declare function buildEditorExtension(name: string): Promise<void>;
+export declare function buildEditorExtension(name: string, quiet?: boolean): Promise<void>;
 export declare function updateExtensionSDK(name: string): Promise<void>;
-export declare function debugEditorExtension(name: string): Promise<void>;
+export declare function debugEditorExtension(name: string, quiet?: boolean): Promise<void>;

package/src/editorextension.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.debugEditorExtension = exports.updateExtensionSDK = exports.buildEditorExtension = exports.createEditorExtension = void 0;
 const fs = require("fs/promises");
+const oldFs = require("fs");
 const filesystemutil_1 = require("./filesystemutil");
 const package_1 = require("./package");
 const express = require("express");
@@ -26,7 +27,7 @@ async function createEditorExtension(name, isInternalTesting) {
     });
     console.log(`Installing dependencies`);
     process.chdir('editorextensions/' + name);
-    console.log(child_process.execSync('npm install').toString());
+    console.log(child_process.execSync('npm install --silent').toString());
     if (isInternalTesting) {
         console.log('Using symlink for dependency on SDK for internal testing');
         console.log(child_process
@@ -39,10 +40,10 @@ async function createEditorExtension(name, isInternalTesting) {
     }
 }
 exports.createEditorExtension = createEditorExtension;
-async function buildEditorExtension(name) {
+async function buildEditorExtension(name, quiet = false) {
     process.chdir('editorextensions/' + name);
     const cli = new WebPackCLI();
-    await cli.run(['node', 'webpack', '--mode', 'production']);
+    await cli.run(['node', 'webpack', '--mode', 'production', ...(quiet ? ['--stats', 'errors-only'] : [])]);
 }
 exports.buildEditorExtension = buildEditorExtension;
 async function updateExtensionSDK(name) {
@@ -51,10 +52,10 @@ async function updateExtensionSDK(name) {
     console.log(child_process.execSync('npm install lucid-extension-sdk@latest').toString());
 }
 exports.updateExtensionSDK = updateExtensionSDK;
-async function debugEditorExtension(name) {
+async function debugEditorExtension(name, quiet = false) {
     process.chdir('editorextensions/' + name);
     const cli = new WebPackCLI();
-    cli.run(['node', 'webpack', '--watch']);
+    cli.run(['node', 'webpack', '--watch', ...(quiet ? ['--stats', 'errors-only'] : [])]);
     const app = express();
     app.use((req, res, next) => {
         res.header('Access-Control-Allow-Origin', '*');
@@ -62,6 +63,11 @@ async function debugEditorExtension(name) {
         next();
     });
     app.get('/extension.js', async (req, res) => {
+        //Give it several seconds for the extension to finish generating before failing.
+        const before = Date.now();
+        while (!oldFs.existsSync('bin/extension.js') && Date.now() - before < 5000) {
+            await new Promise((resolve) => setTimeout(resolve, 50));
+        }
         res.send((await fs.readFile('bin/extension.js')).toString());
     });
     app.get('/scopes', async (req, res) => {

package/src/index.js

@@ -1,11 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const argparse_1 = require("argparse");
 const editorextension_1 = require("./editorextension");
 const package_1 = require("./package");
-const argparse_1 = require("argparse");
 const shapelibrary_1 = require("./shapelibrary");
 class LucidSuiteExtensionCLI {
-    run(args) {
+    async run(args) {
         const parser = new argparse_1.ArgumentParser({
             description: 'Create and manage Lucid extension packages',
         });
@@ -24,6 +24,11 @@ class LucidSuiteExtensionCLI {
         const packageParser = subparsers.add_parser('bundle', {
             help: 'Prepare the current package for upload to the developer dashboard',
         });
+        packageParser.add_argument('--quiet', {
+            default: false,
+            action: 'store_true',
+            help: argparse_1.SUPPRESS,
+        });
         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',
         });
@@ -35,10 +40,20 @@ class LucidSuiteExtensionCLI {
             help: 'Compile an editor extension in production mode; use this to check types and validate final compiled output',
         });
         buildExtensionParser.add_argument('name');
+        buildExtensionParser.add_argument('--quiet', {
+            default: false,
+            action: 'store_true',
+            help: argparse_1.SUPPRESS,
+        });
         const testExtensionParser = subparsers.add_parser('test-editor-extension', {
             help: 'Compile an editor extension in debug mode, and serve it at localhost:9900, along with any shape libraries in this package at localhost:9901. Watch for changes to the code and recompile as needed',
         });
         testExtensionParser.add_argument('name');
+        testExtensionParser.add_argument('--quiet', {
+            default: false,
+            action: 'store_true',
+            help: argparse_1.SUPPRESS,
+        });
         const testShapeLibraries = subparsers.add_parser('test-shape-libraries', {
             help: 'Serve any shape libraries in this package at localhost:9901. Watch for changes to the code and live-update as needed',
         });
@@ -66,7 +81,7 @@ class LucidSuiteExtensionCLI {
                 break;
             case 'bundle':
                 if ((0, package_1.currentlyInPackage)()) {
-                    (0, package_1.writePackage)();
+                    await (0, package_1.writePackage)(parsed['quiet']);
                 }
                 else {
                     console.error('Not currently in a Lucid extension package folder');
@@ -74,7 +89,7 @@ class LucidSuiteExtensionCLI {
                 break;
             case 'update-sdk':
                 if ((0, package_1.currentlyInPackage)()) {
-                    (0, package_1.updateAllExtensionSDK)();
+                    await (0, package_1.updateAllExtensionSDK)();
                 }
                 else {
                     console.error('Not currently in a Lucid extension package folder');
@@ -82,7 +97,7 @@ class LucidSuiteExtensionCLI {
                 break;
             case 'create-editor-extension':
                 if ((0, package_1.currentlyInPackage)()) {
-                    (0, editorextension_1.createEditorExtension)(parsed['name'], isInternalTesting);
+                    await (0, editorextension_1.createEditorExtension)(parsed['name'], isInternalTesting);
                 }
                 else {
                     console.error('Not currently in a Lucid extension package folder');
@@ -90,7 +105,7 @@ class LucidSuiteExtensionCLI {
                 break;
             case 'build-editor-extension':
                 if ((0, package_1.currentlyInPackage)()) {
-                    (0, editorextension_1.buildEditorExtension)(parsed['name']);
+                    await (0, editorextension_1.buildEditorExtension)(parsed['name'], parsed['quiet']);
                 }
                 else {
                     console.error('Not currently in a Lucid extension package folder');
@@ -98,7 +113,7 @@ class LucidSuiteExtensionCLI {
                 break;
             case 'create-shape-library':
                 if ((0, package_1.currentlyInPackage)()) {
-                    (0, shapelibrary_1.createEmptyShapeLibrary)(parsed['name']);
+                    await (0, shapelibrary_1.createEmptyShapeLibrary)(parsed['name']);
                 }
                 else {
                     console.error('Not currently in a Lucid extension package folder');
@@ -106,7 +121,7 @@ class LucidSuiteExtensionCLI {
                 break;
             case 'test-shape-libraries':
                 if ((0, package_1.currentlyInPackage)()) {
-                    (0, shapelibrary_1.debugShapeLibraries)();
+                    await (0, shapelibrary_1.debugShapeLibraries)();
                 }
                 else {
                     console.error('Not currently in a Lucid extension package folder');
@@ -114,7 +129,7 @@ class LucidSuiteExtensionCLI {
                 break;
             case 'test-editor-extension':
                 if ((0, package_1.currentlyInPackage)()) {
-                    (0, editorextension_1.debugEditorExtension)(parsed['name']);
+                    await (0, editorextension_1.debugEditorExtension)(parsed['name'], parsed['quiet']);
                 }
                 else {
                     console.error('Not currently in a Lucid extension package folder');
@@ -125,4 +140,6 @@ class LucidSuiteExtensionCLI {
         }
     }
 }
-new LucidSuiteExtensionCLI().run(process.argv.slice(2));
+new LucidSuiteExtensionCLI()
+    .run(process.argv.slice(2))
+    .catch((reason) => console.error('Error running Lucid Suite Extension CLI', reason));

package/src/package.d.ts

@@ -3,4 +3,4 @@ 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 updateAllExtensionSDK(): Promise<void>;
-export declare function writePackage(): Promise<void>;
+export declare function writePackage(quiet?: boolean): Promise<void>;

package/src/package.js

@@ -35,7 +35,7 @@ async function updateAllExtensionSDK() {
     }
 }
 exports.updateAllExtensionSDK = updateAllExtensionSDK;
-async function writePackage() {
+async function writePackage(quiet = false) {
     const zip = new JSZip();
     //Increment the patch number automatically on each build
     await modifyManifest(async (manifest) => {
@@ -55,7 +55,12 @@ async function writePackage() {
             if (parts[0] === 'editorextensions') {
                 //Can't just call the method, as the WebpackCLI class does process.exit(2) :facepalm:
                 console.log(`Compiling editor extension ${parts[1]}`);
-                const cmd = process.argv[0] + ' ' + process.argv[1] + ' build-editor-extension ' + parts[1];
+                const cmd = process.argv[0] +
+                    ' ' +
+                    process.argv[1] +
+                    ' build-editor-extension ' +
+                    (quiet ? '--quiet ' : '') +
+                    parts[1];
                 console.log(cmd);
                 console.log(child_process.execSync(cmd).toString());
             }

package/src/packagemanifest.js

@@ -85,11 +85,11 @@ function validateManifestOrThrow(manifest) {
             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.isString)(provider['callbackBaseUrl'])) {
+                throw new Error('manifest.json: Data connector "callbackBaseUrl" 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');
+            if (!(0, checks_1.isRecord)(checks_1.isString)(provider['callbackEvents'])) {
+                throw new Error('manifest.json: Data connector "callbackEvents" must be a record from strings to strings');
             }
         }
     }

package/src/shapelibrary.js

@@ -38,10 +38,11 @@ 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 rawManifest = await fs.readFile(packagePath + `/shapelibraries/${name}/library.manifest`);
     const manifest = hjson.parse(rawManifest.toString());
     return JSON.stringify(await Promise.all(manifest['shapes'].map(async (shapeManifest, index) => {
-        var _a;
+        var _a, _b;
         const rawShapeData = await fs.readFile(packagePath + `/shapelibraries/${name}/shapes/${shapeManifest['shape']}.shape`);
         const shapeData = hjson.parse(rawShapeData.toString());
         const properties = {
@@ -61,8 +62,8 @@ async function getShapeListJson(name, packagePath) {
                 'name': shapeManifest['name'],
                 'i18n': {},
                 'sourcePackage': {
-                    'packageId': '__local__',
-                    'version': '0.0.0',
+                    'packageId': (_a = packageManifest['id']) !== null && _a !== void 0 ? _a : '__local__',
+                    'version': packageManifest['version'],
                     'library': name,
                     'shape': shapeManifest['shape'],
                 },
@@ -98,7 +99,7 @@ async function getShapeListJson(name, packagePath) {
         }
         for (var key in shapeManifest['defaults']) {
             if (key !== 'width' && key !== 'height') {
-                const outName = (_a = defaultNameMap.get(key)) !== null && _a !== void 0 ? _a : key;
+                const outName = (_b = defaultNameMap.get(key)) !== null && _b !== void 0 ? _b : key;
                 properties[outName] = shapeManifest['defaults'][key];
             }
         }

package/templates/editorextension/src/interop.d.ts

@@ -1,8 +1,12 @@
+/** @ignore */
 declare namespace lucid {
     export function executeCommand(name: string, params: any): any;
     export function listen(msg: any): void;
+    export function getPackageId(): string;
+    export function getVersion(): string;
 }
 
+/** @ignore */
 declare namespace console {
     export function log(...args: any[]): void;
 }