lucid-package 0.0.78 → 0.0.80

package/package.json

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

package/src/dataconnector.js

@@ -4,9 +4,12 @@ exports.createDataConnector = void 0;
 const filesystemutil_1 = require("./filesystemutil");
 const installationutil_1 = require("./installationutil");
 const package_1 = require("./package");
+const path = require("path");
 async function createDataConnector(name, isInternalTesting, skipSDKDependency) {
     console.log('Creating data connector in dataconnectors/' + name);
-    (0, filesystemutil_1.copyFolderRecursiveSync)(__dirname + '/../templates/dataconnector', 'dataconnectors/' + name);
+    const source = path.join(__dirname, '..', 'templates', 'dataconnector');
+    const targetFolder = path.join('dataconnectors', name);
+    (0, filesystemutil_1.copyFolderRecursiveSync)(source, targetFolder);
     await (0, package_1.modifyManifest)((manifest) => {
         if (!manifest['dataConnectors']) {
             manifest['dataConnectors'] = [];
@@ -19,7 +22,7 @@ async function createDataConnector(name, isInternalTesting, skipSDKDependency) {
         });
     });
     console.log(`Installing dependencies`);
-    process.chdir('dataconnectors/' + name);
+    process.chdir(targetFolder);
     (0, installationutil_1.installDependenciesIfNeeded)(isInternalTesting, skipSDKDependency);
 }
 exports.createDataConnector = createDataConnector;

package/src/editorextension.js

@@ -5,6 +5,7 @@ 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");
@@ -15,9 +16,14 @@ const shellutil_1 = require("./shellutil");
 const supportedproduct_1 = require("./supportedproduct");
 const WebPackCLI = require('webpack-cli');
 async function createEditorExtension(name, isInternalTesting, skipSDKDependency) {
-    console.log('Creating empty editor extension in editorextensions/' + name);
-    (0, filesystemutil_1.copyFolderRecursiveSync)(__dirname + '/../templates/editorextension', 'editorextensions/' + name);
-    (0, filesystemutil_1.copyFolderRecursiveSync)(__dirname + '/../templates/public', 'public/');
+    const editorExtensionSource = path.join(__dirname, '..', 'templates', 'editorextension');
+    const editorExtensionTargetFolder = path.join('editorextensions', name);
+    const publicSource = path.join(__dirname, '..', 'templates', 'public');
+    const publicTargetFolder = 'public';
+    const codePath = path.join('editorextensions', name, 'bin', 'extension.js');
+    console.log('Creating empty editor extension in ' + editorExtensionTargetFolder);
+    (0, filesystemutil_1.copyFolderRecursiveSync)(editorExtensionSource, editorExtensionTargetFolder);
+    (0, filesystemutil_1.copyFolderRecursiveSync)(publicSource, publicTargetFolder);
     await (0, package_1.modifyManifest)((manifest) => {
         if (!manifest['extensions']) {
             manifest['extensions'] = [];
@@ -26,24 +32,26 @@ async function createEditorExtension(name, isInternalTesting, skipSDKDependency)
             'name': name,
             'title': name,
             'products': [supportedproduct_1.SupportedProduct.Chart, supportedproduct_1.SupportedProduct.Spark],
-            'codePath': `editorextensions/${name}/bin/extension.js`,
+            'codePath': codePath,
             'scopes': ['READ', 'WRITE', 'DOWNLOAD', 'SHOW_MODAL', 'CUSTOM_UI', 'NETWORK'],
         });
     });
     console.log(`Installing dependencies`);
-    process.chdir('editorextensions/' + name);
+    process.chdir(editorExtensionTargetFolder);
     (0, installationutil_1.installDependenciesIfNeeded)(isInternalTesting, skipSDKDependency);
 }
 exports.createEditorExtension = createEditorExtension;
 async function buildEditorExtension(name, isInternalTesting, quiet = false) {
-    process.chdir('editorextensions/' + (await getExtensionCodeDirectoryName(name)));
+    const extensionCodePath = path.join('editorextensions', (await getExtensionCodeDirectoryName(name)));
+    process.chdir(extensionCodePath);
     (0, installationutil_1.installDependenciesIfNeeded)(isInternalTesting);
     const cli = new WebPackCLI();
     await cli.run(['node', 'webpack', '--mode', 'production', ...(quiet ? ['--stats', 'errors-only'] : [])]);
 }
 exports.buildEditorExtension = buildEditorExtension;
 async function updateExtensionSDK(name) {
-    process.chdir('editorextensions/' + (await getExtensionCodeDirectoryName(name)));
+    const extensionCodePath = path.join('editorextensions', (await getExtensionCodeDirectoryName(name)));
+    process.chdir(extensionCodePath);
     console.log('Installing latest SDK in extension ' + name);
     console.log((0, shellutil_1.execSyncLoggingOutputOnError)('npm install lucid-extension-sdk@latest').toString());
 }
@@ -54,7 +62,8 @@ exports.updateExtensionSDK = updateExtensionSDK;
  * @param quiet If true, will only show errors in output
  */
 async function watchEditorExtension(name, isInternalTesting, quiet = false) {
-    process.chdir('editorextensions/' + (await getExtensionCodeDirectoryName(name)));
+    const extensionCodePath = path.join('editorextensions', (await getExtensionCodeDirectoryName(name)));
+    process.chdir(extensionCodePath);
     (0, installationutil_1.installDependenciesIfNeeded)(isInternalTesting);
     const cli = new WebPackCLI();
     cli.run(['node', 'webpack', '--watch', ...(quiet ? ['--stats', 'errors-only'] : [])]);
@@ -68,7 +77,7 @@ exports.watchEditorExtension = watchEditorExtension;
 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 ' : ''}`, {
+        const child = child_process.spawn(`"${process.argv[0]}" "${process.argv[1]}" watch-editor-extension ${name} ${quiet ? '--quiet ' : ''}`, {
             stdio: 'inherit',
             shell: true,
         });
@@ -81,10 +90,11 @@ async function debugEditorExtension(extensionNames, quiet = false, pickAnyPort =
         const directory = await getExtensionCodeDirectoryName(name);
         //Give it several seconds for the extension to finish generating before failing.
         const before = Date.now();
-        while (!oldFs.existsSync(`editorextensions/${directory}/bin/extension.js`) && Date.now() - before < 5000) {
+        const bundlePath = path.join('editorextensions', directory, 'bin', 'extension.js');
+        while (!oldFs.existsSync(bundlePath) && Date.now() - before < 5000) {
             await new Promise((resolve) => setTimeout(resolve, 50));
         }
-        res.send((await fs.readFile(`editorextensions/${directory}/bin/extension.js`)).toString());
+        res.send((await fs.readFile(bundlePath)).toString());
     });
     app.get(['/scopes', '/editorextension/:name/scopes'], async (req, res) => {
         const name = req.params['name'] ?? extensionNames[0];
@@ -115,6 +125,7 @@ async function debugEditorExtension(extensionNames, quiet = false, pickAnyPort =
                 'Label': setting.label,
                 'Description': setting.description,
                 'DataType': setting.type,
+                'DefaultValue': setting.default,
             };
         })));
     });
@@ -213,7 +224,7 @@ async function getExtensionCodeDirectoryName(name) {
  * extensionName.
  */
 async function getExtensionCodeDirectoryNameFromCodePath(codePath) {
-    const parts = codePath.split('/') ?? [];
+    const parts = codePath.split(path.sep) ?? [];
     if (parts[0] === 'editorextensions' && parts[1]) {
         return `${parts[1]}`;
     }

package/src/filesystemutil.d.ts

@@ -1,2 +1,7 @@
 export declare function copyFileSync(source: string, target: string): void;
 export declare function copyFolderRecursiveSync(source: string, targetFolder: string): void;
+/**
+ * On Windows machines '\' is used as the file separator. To ensure that we correctly zip files on Windows
+ * machines we replace '\' with '/'.
+ */
+export declare function getNormalizedZipPath(rawPath: string): string;

package/src/filesystemutil.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.copyFolderRecursiveSync = exports.copyFileSync = void 0;
+exports.getNormalizedZipPath = exports.copyFolderRecursiveSync = exports.copyFileSync = void 0;
 const fs = require("fs");
 const path = require("path");
 function copyFileSync(source, target) {
@@ -35,3 +35,11 @@ function copyFolderRecursiveSync(source, targetFolder) {
     }
 }
 exports.copyFolderRecursiveSync = copyFolderRecursiveSync;
+/**
+ * On Windows machines '\' is used as the file separator. To ensure that we correctly zip files on Windows
+ * machines we replace '\' with '/'.
+ */
+function getNormalizedZipPath(rawPath) {
+    return path.sep === '\\' ? rawPath.replace(/\\/g, '/') : rawPath;
+}
+exports.getNormalizedZipPath = getNormalizedZipPath;

package/src/index.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const path = require("path");
 const argparse_1 = require("argparse");
 const dataconnector_1 = require("./dataconnector");
 const editorextension_1 = require("./editorextension");
@@ -116,7 +117,7 @@ class LucidSuiteExtensionCLI {
         let isInternalTesting = !!parsed['chdir'];
         if (isInternalTesting) {
             if (parsed['project']) {
-                process.chdir(parsed['chdir'] + '/' + parsed['project']);
+                process.chdir(path.join(parsed['chdir'], parsed['project']));
             }
             else {
                 process.chdir(parsed['chdir']);

package/src/installationutil.js

@@ -8,7 +8,7 @@ function installDependenciesIfNeeded(isInternalTesting, skipSDKDependency = fals
     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 (!oldFs.existsSync(path.join('node_modules', 'lucid-extension-sdk')) && !skipSDKDependency) {
         if (isInternalTesting) {
             linkInternalTestingSDK();
         }
@@ -20,7 +20,7 @@ function installDependenciesIfNeeded(isInternalTesting, skipSDKDependency = fals
 }
 exports.installDependenciesIfNeeded = installDependenciesIfNeeded;
 function linkInternalTestingSDK() {
-    if (!oldFs.existsSync('node_modules/lucid-extension-sdk')) {
+    if (!oldFs.existsSync(path.join('node_modules', 'lucid-extension-sdk'))) {
         const cwd = process.cwd();
         const rootSearch = 'lucid/main/extensibility/';
         const pos = cwd.indexOf(rootSearch);

package/src/package.js

@@ -13,7 +13,8 @@ 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);
+    const source = path.join(__dirname, '..', 'templates', 'package');
+    (0, filesystemutil_1.copyFolderRecursiveSync)(source, root);
 }
 exports.createEmptyPackage = createEmptyPackage;
 function currentlyInPackage() {
@@ -41,7 +42,7 @@ exports.modifyManifest = modifyManifest;
 async function updateAllExtensionSDK() {
     const manifest = await (0, packagemanifest_1.readManifest)();
     for (const extension of manifest['extensions'] || []) {
-        const parts = extension['codePath'].split('/');
+        const parts = extension['codePath'].split(path.sep);
         if (parts[0] === 'editorextensions') {
             await (0, editorextension_1.updateExtensionSDK)(parts[1]);
         }
@@ -71,7 +72,7 @@ async function writePackage(quiet = false, manifestOverrideEnv) {
                     .join(', ')}`);
                 process.exit(1);
             }
-            const parts = extension['codePath'].split('/');
+            const parts = extension['codePath'].split(path.sep);
             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]}`);
@@ -92,7 +93,7 @@ async function writePackage(quiet = false, manifestOverrideEnv) {
         }
         //Do the same for each shape library
         for (const library of manifest['shapeLibraries'] || []) {
-            const parts = library['lcszPath'].split('/');
+            const parts = library['lcszPath'].split(path.sep);
             if (parts[0] === 'shapelibraries') {
                 console.log(`Building shape library ${parts[1]}`);
                 await (0, shapelibrary_1.buildShapeLibrary)(parts[1].replace('.lcsz', ''));
@@ -112,8 +113,9 @@ async function writePackage(quiet = false, manifestOverrideEnv) {
                     if (zipDirectory != null) {
                         zipPath = zipDirectory + filePath.substring(directory.length);
                     }
-                    console.log('Adding resource file: ' + filePath + ' -> ' + zipPath);
-                    zip.file(zipPath, await fs.readFile(filePath));
+                    const normalizedZipPath = (0, filesystemutil_1.getNormalizedZipPath)(zipPath);
+                    console.log('Adding resource file: ' + filePath + ' -> ' + normalizedZipPath);
+                    zip.file(normalizedZipPath, await fs.readFile(filePath));
                 }
                 else if (stat.isDirectory()) {
                     await checkDirForResources(filePath, zipDirectory ? path.join(zipDirectory, fileName) : undefined);

package/src/packagemanifest.d.ts

@@ -1,3 +1,4 @@
+import { JsonSerializable } from 'lucid-extension-sdk';
 import { SupportedProduct } from './supportedproduct';
 export declare enum SettingType {
     STRING = "string"
@@ -45,11 +46,12 @@ export type PackageManifest = {
         'label': string;
         'description': string;
         'type': SettingType;
+        'default'?: JsonSerializable;
     }[];
     'public'?: Record<string, string>;
 };
 /**
  * @param manifestOverrideEnv The environment to override the manifest with
- * @param path The path to read the manifest from
+ * @param basePath The path to read the manifest from
  */
-export declare function readManifest(manifestOverrideEnv?: string, path?: string): Promise<PackageManifest>;
+export declare function readManifest(manifestOverrideEnv?: string, basePath?: string): Promise<PackageManifest>;

package/src/packagemanifest.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.readManifest = exports.SettingType = void 0;
 const fs = require("fs");
 const fsPromises = require("fs/promises");
+const path = require("path");
 const lucid_extension_sdk_1 = require("lucid-extension-sdk");
 const supportedproduct_1 = require("./supportedproduct");
 var SettingType;
@@ -40,6 +41,16 @@ function validateManifestOrThrow(manifest) {
             if (!(0, lucid_extension_sdk_1.enumValidator)(SettingType)(setting['type'])) {
                 throw new Error('manifest.json: setting "type" must be "string"');
             }
+            if ((0, lucid_extension_sdk_1.isDef)(setting['default'])) {
+                if (setting['type'] === SettingType.STRING) {
+                    if (!(0, lucid_extension_sdk_1.isString)(setting['default'])) {
+                        throw new Error('manifest.json: setting "default" must be of the type specified for the setting');
+                    }
+                }
+                else {
+                    throw new Error('manifest.json: unsupported setting type');
+                }
+            }
         }
     }
     if (manifest['extensions']) {
@@ -222,12 +233,12 @@ function deepMixin(target, mixin) {
 }
 /**
  * @param manifestOverrideEnv The environment to override the manifest with
- * @param path The path to read the manifest from
+ * @param basePath The path to read the manifest from
  */
-async function readManifest(manifestOverrideEnv, path = './') {
-    const raw = JSON.parse((await fsPromises.readFile(path + 'manifest.json')).toString());
+async function readManifest(manifestOverrideEnv, basePath = '.') {
+    const raw = JSON.parse((await fsPromises.readFile(path.join(basePath, 'manifest.json'))).toString());
     if (manifestOverrideEnv) {
-        const manifestOverridePath = path + `manifest.${manifestOverrideEnv}.json`;
+        const manifestOverridePath = path.join(basePath, `manifest.${manifestOverrideEnv}.json`);
         try {
             const overrides = JSON.parse((await fsPromises.readFile(manifestOverridePath)).toString());
             deepMixin(raw, overrides);

package/src/shapelibrary.js

@@ -15,8 +15,10 @@ const ws = require('ws');
 const chokidar = require('chokidar');
 const sizeOf = require('image-size');
 async function createEmptyShapeLibrary(name) {
-    console.log('Creating shape library in shapelibraries/' + name);
-    (0, filesystemutil_1.copyFolderRecursiveSync)(__dirname + '/../templates/shapelibrary', 'shapelibraries/' + name);
+    const source = path.join(__dirname, '..', 'templates', 'shapelibrary');
+    const targetFolder = path.join('shapelibraries', name);
+    console.log('Creating shape library in ' + targetFolder);
+    (0, filesystemutil_1.copyFolderRecursiveSync)(source, targetFolder);
     await (0, package_1.modifyManifest)((manifest) => {
         if (!manifest['shapeLibraries']) {
             manifest['shapeLibraries'] = [];
@@ -24,13 +26,13 @@ async function createEmptyShapeLibrary(name) {
         manifest['shapeLibraries'].push({
             'name': name,
             'product': 'chart',
-            'lcszPath': `shapelibraries/${name}.lcsz`,
+            'lcszPath': path.join('shapelibraries', `${name}.lcsz`),
         });
     });
 }
 exports.createEmptyShapeLibrary = createEmptyShapeLibrary;
 async function createImageShapeLibrary(name, imagePath, config) {
-    console.log('Creating image shape library in shapelibraries/' + name);
+    console.log('Creating image shape library in ' + path.join('shapelibraries', name));
     if (!fsSync.lstatSync(imagePath).isDirectory()) {
         console.error('The provided path `' + imagePath + '` is not a folder');
         return;
@@ -115,7 +117,7 @@ async function createImageShapeLibrary(name, imagePath, config) {
             manifest['shapeLibraries'].push({
                 'name': name,
                 'product': 'chart',
-                'lcszPath': `shapelibraries/${name}.lcsz`,
+                'lcszPath': path.join('shapelibraries', `${name}.lcsz`),
             });
         }
     });
@@ -134,12 +136,14 @@ const defaultNameMap = new Map([
 //Produce JSON equivalent to the document service's
 // /shapeLibraries/:name/shapes endpoint
 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 packageManifest = await (0, packagemanifest_1.readManifest)('local', packagePath);
+    const manifestPath = path.join(packagePath, 'shapelibraries', name, 'library.manifest');
+    const rawManifest = await fs.readFile(manifestPath);
     const manifest = hjson.parse(rawManifest.toString());
     const usedNames = new Set(manifest['shapes'].map((shape) => shape['key']).filter((key) => key !== undefined));
     return JSON.stringify(await Promise.all(manifest['shapes'].map(async (shapeManifest, index) => {
-        const rawShapeData = await fs.readFile(packagePath + `/shapelibraries/${name}/shapes/${shapeManifest['shape']}.shape`);
+        const shapeDataPath = path.join(packagePath, 'shapelibraries', name, 'shapes', `${shapeManifest['shape']}.shape`);
+        const rawShapeData = await fs.readFile(shapeDataPath);
         const shapeData = hjson.parse(rawShapeData.toString());
         let shapeName = shapeManifest['key'];
         if (shapeName === undefined) {
@@ -239,11 +243,7 @@ async function buildShapeLibrary(name) {
             }
         }
         else {
-            /**
-             * 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;
+            const normalizedSource = (0, filesystemutil_1.getNormalizedZipPath)(source);
             zip.file(normalizedSource.replace(`shapelibraries/${name}/`, ''), await fs.readFile(source));
         }
     };
@@ -262,10 +262,10 @@ async function debugShapeLibraries(packagePath = '.', pickAnyPort = false) {
     //shape library, the toolbox doesn't update.
     let shapeLibraryVersion = Date.now();
     app.get('/shapeLibraries', async (req, res) => {
-        const manifest = await (0, packagemanifest_1.readManifest)('local', packagePath + '/');
+        const manifest = await (0, packagemanifest_1.readManifest)('local', packagePath);
         const libraries = manifest['shapeLibraries'] ?? [];
         const output = await Promise.all(libraries.map(async (libraryManifest) => {
-            const libraryDefinitionContent = await fs.readFile(packagePath + '/shapelibraries/' + libraryManifest['name'] + '/library.manifest');
+            const libraryDefinitionContent = await fs.readFile(path.join(packagePath, 'shapelibraries', libraryManifest['name'], 'library.manifest'));
             const libraryDefinition = JSON.parse(libraryDefinitionContent.toString());
             return {
                 'uri': `http://localhost:${port}/shapeLibraries/` +
@@ -295,14 +295,14 @@ async function debugShapeLibraries(packagePath = '.', pickAnyPort = false) {
         const oldcwd = process.cwd();
         process.chdir(packagePath);
         //Find all the shapes in the given shape library, and produce JSON for the client
-        res.sendFile('shapelibraries/' + req.params.libraryName + '/images/' + req.params.image, {
+        res.sendFile(path.join('shapelibraries', req.params.libraryName, 'images', req.params.image), {
             root: process.cwd(),
         });
         process.chdir(oldcwd);
     });
     app.get('/shapeLibraries/');
     app.get('/manifest', async (req, res) => {
-        const packageManifest = await (0, packagemanifest_1.readManifest)('local', packagePath + '/');
+        const packageManifest = await (0, packagemanifest_1.readManifest)('local', packagePath);
         res.send(JSON.stringify(packageManifest));
     });
     const listen = () => {
@@ -314,7 +314,7 @@ async function debugShapeLibraries(packagePath = '.', pickAnyPort = false) {
             wss.on('connection', (ws) => {
                 sockets.push(ws);
             });
-            chokidar.watch(packagePath + '/shapelibraries').on('all', () => {
+            chokidar.watch(path.join(packagePath, 'shapelibraries')).on('all', () => {
                 shapeLibraryVersion = Date.now();
                 for (const socket of sockets) {
                     socket.send('refresh');