lucid-package 0.0.1 → 0.0.5

package/README.md

@@ -2,7 +2,76 @@
 
 ## Description
 
-CLI for creating and managing extensibility packages for the products of Lucid Software.
+CLI for creating and managing extension packages for the products of Lucid Software.
+
+## 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).
 
 ## License
 

package/package.json

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

package/src/editorextension.d.ts

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

package/src/editorextension.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.debugEditorExtension = exports.buildEditorExtension = exports.createEditorExtension = void 0;
+exports.debugEditorExtension = exports.updateExtensionSDK = exports.buildEditorExtension = exports.createEditorExtension = void 0;
 const fs = require("fs/promises");
 const filesystemutil_1 = require("./filesystemutil");
 const package_1 = require("./package");
@@ -39,6 +39,12 @@ async function buildEditorExtension(name) {
     await cli.run(['node', 'webpack', '--mode', 'production']);
 }
 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());
+}
+exports.updateExtensionSDK = updateExtensionSDK;
 async function debugEditorExtension(name) {
     process.chdir('editorextensions/' + name);
     const cli = new WebPackCLI();

package/src/index.js

@@ -13,7 +13,7 @@ class LucidSuiteExtensionCLI {
         //When running with bazel, specifies a project name inside the chdir. Otherwise, directly specifies a directory to chdir to.
         parser.add_argument('--project', '-p', {
             type: 'str',
-            help: 'Specify a project directory to run this command inside',
+            help: argparse_1.SUPPRESS,
         });
         const subparsers = parser.add_subparsers({ dest: 'command' });
         const createParser = subparsers.add_parser('create', {
@@ -23,6 +23,9 @@ class LucidSuiteExtensionCLI {
         const packageParser = subparsers.add_parser('package', {
             help: 'Prepare the current package for upload to the developer dashboard',
         });
+        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',
+        });
         const createExtensionParser = subparsers.add_parser('create-editor-extension', {
             help: 'Create a new editor extension as part of the current package',
         });
@@ -61,6 +64,14 @@ class LucidSuiteExtensionCLI {
                     console.error('Not currently in a Lucid extensibility package folder');
                 }
                 break;
+            case 'update-sdk':
+                if ((0, package_1.currentlyInPackage)()) {
+                    (0, package_1.updateAllExtensionSDK)();
+                }
+                else {
+                    console.error('Not currently in a Lucid extensibility package folder');
+                }
+                break;
             case 'create-editor-extension':
                 if ((0, package_1.currentlyInPackage)()) {
                     (0, editorextension_1.createEditorExtension)(parsed['name'], isInternalTesting);

package/src/package.d.ts

@@ -9,6 +9,8 @@ declare type PackageManifest = {
         scopes: string[];
     }[];
 };
+export declare function readManifest(): Promise<PackageManifest>;
 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 {};

package/src/package.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writePackage = exports.modifyManifest = exports.currentlyInPackage = exports.createEmptyPackage = void 0;
+exports.writePackage = exports.updateAllExtensionSDK = exports.modifyManifest = exports.readManifest = exports.currentlyInPackage = exports.createEmptyPackage = void 0;
 const fs = require("fs/promises");
 const fsOld = require("fs");
 const filesystemutil_1 = require("./filesystemutil");
+const editorextension_1 = require("./editorextension");
 const child_process = require("child_process");
 const JSZip = require("jszip");
 async function createEmptyPackage(root) {
@@ -16,12 +17,25 @@ function currentlyInPackage() {
 }
 exports.currentlyInPackage = currentlyInPackage;
 const allScopes = new Set(['DOWNLOAD', 'NETWORK', 'READ', 'SHOW_MODAL', 'WRITE']);
+async function readManifest() {
+    return JSON.parse((await fs.readFile('manifest.json')).toString());
+}
+exports.readManifest = readManifest;
 async function modifyManifest(callback) {
-    const manifest = JSON.parse((await fs.readFile('manifest.json')).toString());
+    const manifest = await readManifest();
     await callback(manifest);
     await fs.writeFile('manifest.json', JSON.stringify(manifest, undefined, 2));
 }
 exports.modifyManifest = modifyManifest;
+async function updateAllExtensionSDK() {
+    for (const extension of (await readManifest()).extensions) {
+        const parts = extension.codePath.split('/');
+        if (parts[0] === 'editorextensions') {
+            await (0, editorextension_1.updateExtensionSDK)(parts[1]);
+        }
+    }
+}
+exports.updateAllExtensionSDK = updateAllExtensionSDK;
 async function writePackage() {
     const zip = new JSZip();
     //Increment the patch number automatically on each build
@@ -42,9 +56,9 @@ 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]}`);
-                console.log(child_process
-                    .execSync(process.argv[0] + ' ' + process.argv[1] + ' build-editor-extension ' + parts[1])
-                    .toString());
+                const cmd = process.argv[0] + ' ' + process.argv[1] + ' build-editor-extension ' + parts[1];
+                console.log(cmd);
+                console.log(child_process.execSync(cmd).toString());
             }
             zip.file(extension.codePath, await fs.readFile(extension.codePath));
         }