lucid-package 0.0.112 → 0.0.114

package/package.json

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

package/src/package.js

@@ -36,6 +36,7 @@ const allScopes = new Set([
     'WRITE',
     'USER_INFO',
     'OAUTH_TOKEN',
+    'PERSISTENT_SYNC'
 ]);
 const uuidRegex = /^[a-f\d]{8}-[a-f\d]{4}-[a-f\d]{4}-[a-f\d]{4}-[a-f\d]{12}$/i;
 async function modifyManifest(callback, manifestOverrideEnv) {

package/src/shapelibrary.d.ts

@@ -5,6 +5,6 @@ export interface ImageShapeConfig {
 }
 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 getShapeListJson(nameInPackageManifest: string, packagePath: string, port?: number): Promise<string>;
 export declare function buildShapeLibrary(name: string, quiet: boolean): Promise<void>;
 export declare function debugShapeLibraries(packagePath?: string, pickAnyPort?: boolean): Promise<void>;

package/src/shapelibrary.js

@@ -136,14 +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) {
+async function getShapeListJson(nameInPackageManifest, packagePath, port = 9901) {
     const packageManifest = await (0, packagemanifest_1.readManifest)('local', packagePath);
-    const manifestPath = path.join(packagePath, 'shapelibraries', name, 'library.manifest');
+    const manifestPath = path.join(packagePath, 'shapelibraries', nameInPackageManifest, '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 shapeDataPath = path.join(packagePath, 'shapelibraries', name, 'shapes', `${shapeManifest['shape']}.shape`);
+        const shapeDataPath = path.join(packagePath, 'shapelibraries', nameInPackageManifest, 'shapes', `${shapeManifest['shape']}.shape`);
         const rawShapeData = await fs.readFile(shapeDataPath);
         const shapeData = hjson.parse(rawShapeData.toString());
         let shapeName = shapeManifest['key'];
@@ -176,7 +176,7 @@ async function getShapeListJson(name, packagePath, port = 9901) {
                 'sourcePackage': {
                     'packageId': packageManifest['id'] ?? '__local__',
                     'version': packageManifest['version'],
-                    'library': name,
+                    'library': nameInPackageManifest,
                     'shape': shapeManifest['shape'],
                     'name': shapeName,
                 },
@@ -203,7 +203,7 @@ async function getShapeListJson(name, packagePath, port = 9901) {
                 else if (imageMap[key]['type'] == 'file') {
                     finalImageMap[key] =
                         `http://localhost:${port}/shapeLibraries/` +
-                            encodeURIComponent(name) +
+                            encodeURIComponent(nameInPackageManifest) +
                             '/images/' +
                             encodeURIComponent(imageMap[key]['path']);
                 }
@@ -226,8 +226,8 @@ async function getShapeListJson(name, packagePath, port = 9901) {
             'name': shapeManifest['name'],
             'order': index,
             'properties': JSON.stringify(properties),
-            'shapeLibrary': `http://localhost:${port}/shapeLibraries/` + encodeURIComponent(name),
-            'uri': `http://localhost:${port}/shapeLibraries/${encodeURIComponent(name)}/shapes/${encodeURIComponent(shapeName)}`,
+            'shapeLibrary': `http://localhost:${port}/shapeLibraries/` + encodeURIComponent(nameInPackageManifest),
+            'uri': `http://localhost:${port}/shapeLibraries/${encodeURIComponent(nameInPackageManifest)}/shapes/${encodeURIComponent(shapeName)}`,
         };
     })));
 }
@@ -267,32 +267,39 @@ 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 libraries = manifest['shapeLibraries'] ?? [];
-        const output = await Promise.all(libraries.map(async (libraryManifest) => {
-            const libraryDefinitionContent = await fs.readFile(path.join(packagePath, 'shapelibraries', libraryManifest['name'], 'library.manifest'));
+        const packageManifest = await (0, packagemanifest_1.readManifest)('local', packagePath);
+        const librariesInPackageManifest = packageManifest['shapeLibraries'] ?? [];
+        const output = await Promise.all(librariesInPackageManifest.map(async (libraryInPackageManifest) => {
+            // Unique for each shape library within a package
+            const libraryNameInPackageManifest = libraryInPackageManifest['name'];
+            const libraryDefinitionContent = await fs.readFile(path.join(packagePath, 'shapelibraries', libraryNameInPackageManifest, 'library.manifest'));
             const libraryDefinition = JSON.parse(libraryDefinitionContent.toString());
             return {
                 'uri': `http://localhost:${port}/shapeLibraries/` +
-                    encodeURIComponent(libraryManifest['name']) +
+                    encodeURIComponent(libraryNameInPackageManifest) +
                     '?version=' +
                     shapeLibraryVersion,
                 'user': '',
+                'userId': 0,
+                // 'id' field must be unique across an entire package (required by the Lucid frontend).
+                // The only field that satisfies this requirement is this one.
+                // (On the other hand, the 'name' in the `library.manfiest` file is not unique across the package.)
+                'id': libraryNameInPackageManifest,
                 'created': new Date().toISOString(),
                 'name': libraryDefinition['name'],
                 'size': 0,
                 'accountId': 0,
                 'shapes': `http://localhost:${port}/shapeLibraries/` +
-                    encodeURIComponent(libraryManifest['name']) +
+                    encodeURIComponent(libraryNameInPackageManifest) +
                     '/shapes',
                 'encryption': '',
             };
         }));
         res.send(JSON.stringify(output));
     });
-    app.get('/shapeLibraries/:libraryName/shapes', async (req, res) => {
+    app.get('/shapeLibraries/:libraryNameInPackageManifest/shapes', async (req, res) => {
         //Find all the shapes in the given shape library, and produce JSON for the client
-        res.send(await getShapeListJson(req.params.libraryName, packagePath, port));
+        res.send(await getShapeListJson(req.params.libraryNameInPackageManifest, packagePath, port));
     });
     app.get('/shapeLibraries/:libraryName/images/:image', async (req, res) => {
         const oldcwd = process.cwd();