lucid-package 0.0.69 → 0.0.72

package/package.json

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

package/src/dataconnector.d.ts

@@ -0,0 +1 @@
+export declare function createDataConnector(name: string, isInternalTesting: boolean, skipSDKDependency: boolean): Promise<void>;

package/src/dataconnector.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createDataConnector = void 0;
+const filesystemutil_1 = require("./filesystemutil");
+const installationutil_1 = require("./installationutil");
+const package_1 = require("./package");
+async function createDataConnector(name, isInternalTesting, skipSDKDependency) {
+    console.log('Creating data connector in dataconnectors/' + name);
+    (0, filesystemutil_1.copyFolderRecursiveSync)(__dirname + '/../templates/dataconnector', 'dataconnectors/' + name);
+    await (0, package_1.modifyManifest)((manifest) => {
+        if (!manifest['dataConnectors']) {
+            manifest['dataConnectors'] = [];
+        }
+        manifest['dataConnectors'].push({
+            'name': name,
+            'oauthProviderName': '',
+            'callbackBaseUrl': '',
+            'dataActions': {},
+        });
+    });
+    console.log(`Installing dependencies`);
+    process.chdir('dataconnectors/' + name);
+    (0, installationutil_1.installDependenciesIfNeeded)(isInternalTesting, skipSDKDependency);
+}
+exports.createDataConnector = createDataConnector;

package/src/editorextension.js

@@ -5,40 +5,15 @@ const child_process = require("child_process");
 const express = require("express");
 const oldFs = require("fs");
 const fs = require("fs/promises");
-const path = require("path");
 const cors_1 = require("./cors");
 const filesystemutil_1 = require("./filesystemutil");
+const installationutil_1 = require("./installationutil");
 const package_1 = require("./package");
 const packagemanifest_1 = require("./packagemanifest");
 const shapelibrary_1 = require("./shapelibrary");
 const shellutil_1 = require("./shellutil");
 const supportedproduct_1 = require("./supportedproduct");
 const WebPackCLI = require('webpack-cli');
-function linkInternalTestingSDK() {
-    if (!oldFs.existsSync('node_modules/lucid-extension-sdk')) {
-        const cwd = process.cwd();
-        const rootSearch = 'lucid/main/extensibility/';
-        const pos = cwd.indexOf(rootSearch);
-        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((0, shellutil_1.execSyncLoggingOutputOnError)(`npm install --silent --save ${relativePath}`).toString());
-    }
-}
-function installDependenciesIfNeeded(isInternalTesting, skipSDKDependency = false) {
-    if (!oldFs.existsSync('node_modules')) {
-        console.log((0, shellutil_1.execSyncLoggingOutputOnError)('npm install --silent').toString());
-    }
-    if (!oldFs.existsSync('node_modules/lucid-extension-sdk') && !skipSDKDependency) {
-        if (isInternalTesting) {
-            linkInternalTestingSDK();
-        }
-        else {
-            console.log('Adding dependency on SDK');
-            console.log((0, shellutil_1.execSyncLoggingOutputOnError)('npm install --save lucid-extension-sdk').toString());
-        }
-    }
-}
 async function createEditorExtension(name, isInternalTesting, skipSDKDependency) {
     console.log('Creating empty editor extension in editorextensions/' + name);
     (0, filesystemutil_1.copyFolderRecursiveSync)(__dirname + '/../templates/editorextension', 'editorextensions/' + name);
@@ -56,12 +31,12 @@ async function createEditorExtension(name, isInternalTesting, skipSDKDependency)
     });
     console.log(`Installing dependencies`);
     process.chdir('editorextensions/' + name);
-    installDependenciesIfNeeded(isInternalTesting, skipSDKDependency);
+    (0, installationutil_1.installDependenciesIfNeeded)(isInternalTesting, skipSDKDependency);
 }
 exports.createEditorExtension = createEditorExtension;
 async function buildEditorExtension(name, isInternalTesting, quiet = false) {
     process.chdir('editorextensions/' + (await getExtensionCodeDirectoryName(name)));
-    installDependenciesIfNeeded(isInternalTesting);
+    (0, installationutil_1.installDependenciesIfNeeded)(isInternalTesting);
     const cli = new WebPackCLI();
     await cli.run(['node', 'webpack', '--mode', 'production', ...(quiet ? ['--stats', 'errors-only'] : [])]);
 }
@@ -79,7 +54,7 @@ exports.updateExtensionSDK = updateExtensionSDK;
  */
 async function watchEditorExtension(name, isInternalTesting, quiet = false) {
     process.chdir('editorextensions/' + (await getExtensionCodeDirectoryName(name)));
-    installDependenciesIfNeeded(isInternalTesting);
+    (0, installationutil_1.installDependenciesIfNeeded)(isInternalTesting);
     const cli = new WebPackCLI();
     cli.run(['node', 'webpack', '--watch', ...(quiet ? ['--stats', 'errors-only'] : [])]);
 }
@@ -179,6 +154,16 @@ async function debugEditorExtension(extensionNames, quiet = false, pickAnyPort =
         const manifest = await (0, packagemanifest_1.readManifest)('local');
         res.send(JSON.stringify(manifest));
     });
+    // iframes (modals and panels) loaded in dev mode from a string (legacy style) will redirect here to get the
+    // iframe bootstrap code, so that any requests for static assets from localhost won't fail due to mixed
+    // HTTPS and HTTP. But to avoid duplicating the modal-frame.html source here, we just send it in the query
+    // string as part of the redirect.
+    app.get('/resources/modal-frame.html', async (req, res) => {
+        res.set({ 'Content-Type': 'text/html' });
+        res.send(req.query['source']);
+    });
+    // Static resources in the "public" directory of the package
+    app.use('/resources', express.static('public'));
     const listen = () => {
         app.listen(port, 'localhost', () => {
             console.log('Listening at http://localhost:' + port + '/extension.js');

package/src/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const argparse_1 = require("argparse");
+const dataconnector_1 = require("./dataconnector");
 const editorextension_1 = require("./editorextension");
 const package_1 = require("./package");
 const shapelibrary_1 = require("./shapelibrary");
@@ -101,6 +102,15 @@ class LucidSuiteExtensionCLI {
             action: 'store_true',
             help: 'Lock the aspect ratio of all images',
         });
+        const createDataConnectorParser = subparsers.add_parser('create-data-connector', {
+            help: 'Create a new data-connector as part of the current package',
+        });
+        createDataConnectorParser.add_argument('name');
+        createDataConnectorParser.add_argument('--skip-sdk', {
+            default: false,
+            action: 'store_true',
+            help: argparse_1.SUPPRESS,
+        });
         const parsed = parser.parse_args(args);
         //For internal development, creating and operating on a "test" package via bazel
         let isInternalTesting = !!parsed['chdir'];
@@ -124,87 +134,53 @@ class LucidSuiteExtensionCLI {
             case 'create':
                 (0, package_1.createEmptyPackage)(parsed['name']);
                 break;
-            case 'bundle':
-                if ((0, package_1.currentlyInPackage)()) {
-                    await (0, package_1.writePackage)(parsed['quiet'], parsed['env']);
-                }
-                else {
-                    console.error('Not currently in a Lucid extension package folder');
-                }
-                break;
-            case 'update-sdk':
-                if ((0, package_1.currentlyInPackage)()) {
-                    await (0, package_1.updateAllExtensionSDK)();
-                }
-                else {
-                    console.error('Not currently in a Lucid extension package folder');
-                }
-                break;
-            case 'create-editor-extension':
-                if ((0, package_1.currentlyInPackage)()) {
-                    await (0, editorextension_1.createEditorExtension)(parsed['name'], isInternalTesting, parsed['skip_sdk']);
-                }
-                else {
-                    console.error('Not currently in a Lucid extension package folder');
-                }
-                break;
-            case 'build-editor-extension':
-                if ((0, package_1.currentlyInPackage)()) {
-                    await (0, editorextension_1.buildEditorExtension)(parsed['name'], isInternalTesting, parsed['quiet']);
-                }
-                else {
-                    console.error('Not currently in a Lucid extension package folder');
-                }
-                break;
-            case 'create-shape-library':
-                if ((0, package_1.currentlyInPackage)()) {
-                    await (0, shapelibrary_1.createEmptyShapeLibrary)(parsed['name']);
-                }
-                else {
-                    console.error('Not currently in a Lucid extension package folder');
-                }
-                break;
-            case 'create-image-shape-library':
-                if ((0, package_1.currentlyInPackage)()) {
-                    const width = Number(parsed['width']) ?? undefined;
-                    const height = Number(parsed['height']) ?? undefined;
-                    const config = {
-                        width: width,
-                        height: height,
-                        lockAspect: parsed['aspectRatio'],
-                    };
-                    await (0, shapelibrary_1.createImageShapeLibrary)(parsed['name'], parsed['path'], config);
-                }
-                else {
-                    console.error('Not currently in a Lucid extension package folder');
-                }
-                break;
-            case 'test-shape-libraries':
-                if ((0, package_1.currentlyInPackage)()) {
-                    await (0, shapelibrary_1.debugShapeLibraries)();
-                }
-                else {
-                    console.error('Not currently in a Lucid extension package folder');
-                }
-                break;
-            case 'test-editor-extension':
-                if ((0, package_1.currentlyInPackage)()) {
-                    await (0, editorextension_1.debugEditorExtension)(parsed['name'], parsed['quiet'], parsed['anyport']);
-                }
-                else {
+            default:
+                // All the following commands can only be executed inside a Lucid extension package folder
+                if (!(0, package_1.currentlyInPackage)()) {
                     console.error('Not currently in a Lucid extension package folder');
                 }
-                break;
-            case 'watch-editor-extension':
-                if ((0, package_1.currentlyInPackage)()) {
-                    await (0, editorextension_1.watchEditorExtension)(parsed['name'], isInternalTesting, parsed['quiet']);
-                }
                 else {
-                    console.error('Not currently in a Lucid extension package folder');
+                    switch (parsed['command']) {
+                        case 'bundle':
+                            await (0, package_1.writePackage)(parsed['quiet'], parsed['env']);
+                        case 'update-sdk':
+                            await (0, package_1.updateAllExtensionSDK)();
+                            break;
+                        case 'create-editor-extension':
+                            await (0, editorextension_1.createEditorExtension)(parsed['name'], isInternalTesting, parsed['skip_sdk']);
+                            break;
+                        case 'build-editor-extension':
+                            await (0, editorextension_1.buildEditorExtension)(parsed['name'], isInternalTesting, parsed['quiet']);
+                            break;
+                        case 'create-shape-library':
+                            await (0, shapelibrary_1.createEmptyShapeLibrary)(parsed['name']);
+                            break;
+                        case 'create-image-shape-library':
+                            const width = Number(parsed['width']) ?? undefined;
+                            const height = Number(parsed['height']) ?? undefined;
+                            const config = {
+                                width: width,
+                                height: height,
+                                lockAspect: parsed['aspectRatio'],
+                            };
+                            await (0, shapelibrary_1.createImageShapeLibrary)(parsed['name'], parsed['path'], config);
+                            break;
+                        case 'create-data-connector':
+                            await (0, dataconnector_1.createDataConnector)(parsed['name'], isInternalTesting, parsed['skip_sdk']);
+                            break;
+                        case 'test-shape-libraries':
+                            await (0, shapelibrary_1.debugShapeLibraries)();
+                            break;
+                        case 'test-editor-extension':
+                            await (0, editorextension_1.debugEditorExtension)(parsed['name'], parsed['quiet'], parsed['anyport']);
+                            break;
+                        case 'watch-editor-extension':
+                            await (0, editorextension_1.watchEditorExtension)(parsed['name'], isInternalTesting, parsed['quiet']);
+                            break;
+                        default:
+                            parser.print_help();
+                    }
                 }
-                break;
-            default:
-                parser.print_help();
         }
     }
 }

package/src/installationutil.d.ts

@@ -0,0 +1 @@
+export declare function installDependenciesIfNeeded(isInternalTesting: boolean, skipSDKDependency?: boolean): void;

package/src/installationutil.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.installDependenciesIfNeeded = void 0;
+const oldFs = require("fs");
+const path = require("path");
+const shellutil_1 = require("./shellutil");
+function installDependenciesIfNeeded(isInternalTesting, skipSDKDependency = false) {
+    if (!oldFs.existsSync('node_modules')) {
+        console.log((0, shellutil_1.execSyncLoggingOutputOnError)('npm install --silent').toString());
+    }
+    if (!oldFs.existsSync('node_modules/lucid-extension-sdk') && !skipSDKDependency) {
+        if (isInternalTesting) {
+            linkInternalTestingSDK();
+        }
+        else {
+            console.log('Adding dependency on SDK');
+            console.log((0, shellutil_1.execSyncLoggingOutputOnError)('npm install --save lucid-extension-sdk').toString());
+        }
+    }
+}
+exports.installDependenciesIfNeeded = installDependenciesIfNeeded;
+function linkInternalTestingSDK() {
+    if (!oldFs.existsSync('node_modules/lucid-extension-sdk')) {
+        const cwd = process.cwd();
+        const rootSearch = 'lucid/main/extensibility/';
+        const pos = cwd.indexOf(rootSearch);
+        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((0, shellutil_1.execSyncLoggingOutputOnError)(`npm install --silent --save ${relativePath}`).toString());
+    }
+}

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 path = require("path");
 const lucid_extension_sdk_1 = require("lucid-extension-sdk");
 const editorextension_1 = require("./editorextension");
 const filesystemutil_1 = require("./filesystemutil");
@@ -88,10 +89,32 @@ async function writePackage(quiet = false, manifestOverrideEnv) {
             }
             zip.file(library['lcszPath'], await fs.readFile(library['lcszPath']));
         }
+        //Add any static resources
+        const checkDirForResources = async (directory) => {
+            if (!fsOld.existsSync(directory)) {
+                return;
+            }
+            for (const fileName of await fs.readdir(directory)) {
+                const filePath = path.join(directory, fileName);
+                const stat = await fs.stat(filePath);
+                if (stat.isFile()) {
+                    console.log('Adding resource file: ', filePath);
+                    zip.file(filePath, await fs.readFile(filePath));
+                }
+                else if (stat.isDirectory()) {
+                    await checkDirForResources(filePath);
+                }
+            }
+        };
+        await checkDirForResources('public');
         //Add the manifest itself
         zip.file('manifest.json', JSON.stringify(manifest, undefined, 2));
         //Write out the zip file
-        const zipBytes = await zip.generateAsync({ type: 'uint8array' });
+        const zipBytes = await zip.generateAsync({
+            type: 'uint8array',
+            compression: 'DEFLATE',
+            compressionOptions: { level: 9 },
+        });
         console.log('Writing file package.zip');
         const fileName = `package${manifestOverrideEnv ? `-${manifestOverrideEnv}` : ''}.zip`;
         await fs.writeFile(fileName, zipBytes);

package/src/packagemanifest.d.ts

@@ -36,8 +36,8 @@ export declare type PackageManifest = {
     'dataConnectors'?: {
         'name': string;
         'oauthProviderName': string;
-        'callbackUrl': string;
-        'dataActions': string[];
+        'callbackBaseUrl': string;
+        'dataActions': Record<string, string>;
     }[];
     'settings'?: {
         'name': string;

package/templates/dataconnector/actions/README.md

@@ -0,0 +1 @@
+This directory will contain actions performed by the data-connector

package/templates/dataconnector/debug-server.ts

@@ -0,0 +1,7 @@
+import * as crypto from 'crypto';
+import * as express from 'express';
+import {DataConnectorClient} from 'lucid-extension-sdk';
+import {makeDataConnector} from './index';
+
+const dataConnector = makeDataConnector(new DataConnectorClient({crypto, Buffer}));
+dataConnector.runDebugServer({express});

package/templates/dataconnector/index.ts

@@ -0,0 +1,3 @@
+import {DataConnector, DataConnectorClient} from 'lucid-extension-sdk';
+
+export const makeDataConnector = (client: DataConnectorClient) => new DataConnector(client);

package/templates/dataconnector/package.json

@@ -0,0 +1,16 @@
+{
+    "devDependencies": {
+        "@types/express": "^4.17.13",
+        "@types/node": "^16.11.11",
+        "nodemon": "^2.0.19",
+        "ts-node": "^10.9.1",
+        "typescript": "^4.9.5"
+    },
+    "dependencies": {
+        "axios": "^0.27.2",
+        "express": "^4.18.1"
+    },
+    "engines": {
+        "node": ">=14.0.0"
+    }
+}

package/templates/dataconnector/tsconfig.json

@@ -0,0 +1,36 @@
+{
+    "compilerOptions": {
+        "declaration": true,
+        "emitDecoratorMetadata": true,
+        "experimentalDecorators": true,
+        "forceConsistentCasingInFileNames": true,
+        "module": "commonjs",
+        "moduleResolution": "node",
+        "newLine": "lf",
+        "noEmitOnError": false,
+        "noImplicitAny": true,
+        "noImplicitReturns": true,
+        "noImplicitThis": true,
+        "noUnusedLocals": false,
+        "pretty": true,
+        "removeComments": false,
+        "skipLibCheck": true,
+        "sourceMap": false,
+        "strictBindCallApply": true,
+        "strictFunctionTypes": true,
+        "strictNullChecks": true,
+        "strictPropertyInitialization": true,
+        "target": "ES2017",
+        "types": ["node"],
+        "lib": [
+            "es5",
+            "es6",
+            "ES2016.Array.Include",
+            "ES2017.String",
+            "ES2018.Promise",
+            "ES2017.Object",
+            "esnext.asynciterable"
+        ],
+        "outDir": "bin"
+    }
+}