lucid-package 0.0.53 → 0.0.57

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "lucid-package",
-    "version": "0.0.53",
+    "version": "0.0.57",
     "description": "",
     "main": "index.js",
     "bin": {
@@ -22,6 +22,7 @@
         "chokidar": "^3.5.3",
         "express": "^4.17.1",
         "hjson": "^3.2.2",
+        "image-size": "^1.0.2",
         "jszip": "^3.7.1",
         "lucid-extension-sdk": "^0.0.112",
         "password-prompt": "^1.1.2",

package/src/index.js

@@ -6,6 +6,7 @@ const package_1 = require("./package");
 const shapelibrary_1 = require("./shapelibrary");
 class LucidSuiteExtensionCLI {
     async run(args) {
+        var _a, _b;
         const parser = new argparse_1.ArgumentParser({
             description: 'Create and manage Lucid extension packages',
         });
@@ -83,6 +84,24 @@ class LucidSuiteExtensionCLI {
             help: 'Create a new shape library as part of the current package',
         });
         createShapeLibrary.add_argument('name');
+        const generateImageShapeLibrary = subparsers.add_parser('create-image-shape-library', {
+            help: 'Create a new shape library as part of the current package',
+        });
+        generateImageShapeLibrary.add_argument('name');
+        generateImageShapeLibrary.add_argument('path');
+        generateImageShapeLibrary.add_argument('--width', {
+            type: 'str',
+            help: argparse_1.SUPPRESS,
+        });
+        generateImageShapeLibrary.add_argument('--height', {
+            type: 'str',
+            help: argparse_1.SUPPRESS,
+        });
+        generateImageShapeLibrary.add_argument('--aspectRatio', {
+            default: false,
+            action: 'store_true',
+            help: 'Lock the aspect ratio of all images',
+        });
         const parsed = parser.parse_args(args);
         //For internal development, creating and operating on a "test" package via bazel
         let isInternalTesting = !!parsed['chdir'];
@@ -146,6 +165,21 @@ class LucidSuiteExtensionCLI {
                     console.error('Not currently in a Lucid extension package folder');
                 }
                 break;
+            case 'create-image-shape-library':
+                if ((0, package_1.currentlyInPackage)()) {
+                    const width = (_a = Number(parsed['width'])) !== null && _a !== void 0 ? _a : undefined;
+                    const height = (_b = Number(parsed['height'])) !== null && _b !== void 0 ? _b : 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)();

package/src/shapelibrary.d.ts

@@ -1,4 +1,10 @@
+export interface ImageShapeConfig {
+    width?: Number;
+    height?: Number;
+    lockAspect?: Boolean;
+}
 export declare function createEmptyShapeLibrary(name: string): Promise<void>;
+export declare function createImageShapeLibrary(name: string, imagePath: string, config: ImageShapeConfig): Promise<void>;
 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, pickAnyPort?: boolean): Promise<void>;

package/src/shapelibrary.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.debugShapeLibraries = exports.buildShapeLibrary = exports.getShapeListJson = exports.createEmptyShapeLibrary = void 0;
+exports.debugShapeLibraries = exports.buildShapeLibrary = exports.getShapeListJson = exports.createImageShapeLibrary = exports.createEmptyShapeLibrary = void 0;
 const express = require("express");
+const fsSync = require("fs");
 const fs = require("fs/promises");
 const JSZip = require("jszip");
 const path = require("path");
@@ -11,6 +12,7 @@ const packagemanifest_1 = require("./packagemanifest");
 const hjson = require('hjson');
 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);
@@ -26,6 +28,96 @@ async function createEmptyShapeLibrary(name) {
     });
 }
 exports.createEmptyShapeLibrary = createEmptyShapeLibrary;
+async function createImageShapeLibrary(name, imagePath, config) {
+    console.log('Creating image shape library in shapelibraries/' + name);
+    if (!fsSync.lstatSync(imagePath).isDirectory()) {
+        console.error('The provided path `' + imagePath + '` is not a folder');
+        return;
+    }
+    const imageFolder = path.join('shapelibraries', name, 'images');
+    const shapeFolder = path.join('shapelibraries', name, 'shapes');
+    const shapes = [];
+    if (!fsSync.existsSync(imageFolder)) {
+        fsSync.mkdirSync(imageFolder, { recursive: true });
+    }
+    if (!fsSync.existsSync(shapeFolder)) {
+        fsSync.mkdirSync(shapeFolder, { recursive: true });
+    }
+    const files = fsSync.readdirSync(imagePath);
+    files.forEach((file) => {
+        var curSource = path.join(imagePath, file);
+        const fileName = file.replace(/\.[^/.]+$/, '');
+        // read image
+        var dimen = { width: 160, height: 160 };
+        if (!config.width || !config.height) {
+            try {
+                dimen = sizeOf(curSource);
+                console.log('dimen of ' + file + ': ' + dimen + ' - ' + JSON.stringify(dimen));
+            }
+            catch (e) {
+                console.log('No dimensions found for ' + file);
+            }
+        }
+        const lockedArray = [];
+        if (config.lockAspect) {
+            lockedArray.push('aspectRatio');
+        }
+        const manifestShape = {
+            shape: fileName,
+            name: fileName,
+            defaults: {
+                width: dimen.width,
+                height: dimen.height,
+            },
+            locked: lockedArray,
+        };
+        shapes.push(manifestShape);
+        // create shape file
+        const shapeFile = {
+            images: {
+                imageReference: {
+                    path: file,
+                    type: 'file',
+                },
+            },
+            geometry: [
+                {
+                    type: 'rect',
+                },
+            ],
+            style: {
+                fill: {
+                    type: 'image',
+                    ref: 'imageReference',
+                    mode: 'stretch',
+                },
+            },
+        };
+        fsSync.writeFileSync(path.join(shapeFolder, fileName) + '.shape', JSON.stringify(shapeFile, undefined, 2));
+        // copy image
+        console.log(`Copying ${curSource} to ${path.join(imageFolder, file)}`);
+        (0, filesystemutil_1.copyFileSync)(curSource, path.join(imageFolder, file));
+    });
+    const manifest = {
+        'name': name,
+        'shapes': shapes,
+    };
+    fsSync.writeFileSync(path.join('shapelibraries', name, 'library.manifest'), JSON.stringify(manifest, undefined, 2));
+    // update extension manifest
+    await (0, package_1.modifyManifest)((manifest) => {
+        if (!manifest['shapeLibraries']) {
+            manifest['shapeLibraries'] = [];
+        }
+        if (!manifest['shapeLibraries'].some((x) => x.name == name)) {
+            manifest['shapeLibraries'].push({
+                'name': name,
+                'product': 'chart',
+                'lcszPath': `shapelibraries/${name}.lcsz`,
+            });
+        }
+    });
+}
+exports.createImageShapeLibrary = createImageShapeLibrary;
 const defaultNameMap = new Map([
     ['rounding', 'Rounding'],
     ['fillColor', 'FillColor'],
@@ -33,6 +125,7 @@ const defaultNameMap = new Map([
     ['strokeWidth', 'LineWidth'],
     ['opacity', 'Opacity'],
     ['rotation', 'Rotation'],
+    ['aspectRatio', 'AspectRatio'],
 ]);
 //Produce JSON equivalent to the document service's
 // /shapeLibraries/:name/shapes endpoint
@@ -42,7 +135,7 @@ async function getShapeListJson(name, packagePath, port = 9901) {
     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) => {
-        var _a, _b;
+        var _a, _b, _c, _d;
         const rawShapeData = await fs.readFile(packagePath + `/shapelibraries/${name}/shapes/${shapeManifest['shape']}.shape`);
         const shapeData = hjson.parse(rawShapeData.toString());
         let shapeName = shapeManifest['key'];
@@ -71,6 +164,7 @@ async function getShapeListJson(name, packagePath, port = 9901) {
                 'lcszVersion': '1',
                 'name': shapeName,
                 'i18n': {},
+                'locked': shapeManifest['locked'],
                 'sourcePackage': {
                     'packageId': (_a = packageManifest['id']) !== null && _a !== void 0 ? _a : '__local__',
                     'version': packageManifest['version'],
@@ -114,6 +208,10 @@ async function getShapeListJson(name, packagePath, port = 9901) {
                 properties[outName] = shapeManifest['defaults'][key];
             }
         }
+        if (((_c = shapeManifest['locked']) === null || _c === void 0 ? void 0 : _c.includes('aspectRatio')) && !properties['AspectRatio']) {
+            properties['AspectRatio'] =
+                (_d = shapeManifest['defaults']['width'] / shapeManifest['defaults']['height']) !== null && _d !== void 0 ? _d : 1;
+        }
         return {
             'class': 'CustomBlock',
             'created': new Date().toISOString(),