Add support for lsd:module true in package.json

Author: rubensworks

README.md

@@ -27,20 +27,12 @@ yarn add -D componentsjs-generator
 
 _If you are already using Components.js, you already have this._
 
-Add the following entries to `package.json`:
+Add the following entry to `package.json`:
 
 ```text
 {
   ...
-  "lsd:module": "https://linkedsoftwaredependencies.org/bundles/npm/my-package",
-  "lsd:components": "components/components.jsonld",
-  "lsd:contexts": {
-    "https://linkedsoftwaredependencies.org/bundles/npm/my-package/^1.0.0/components/context.jsonld": "components/context.jsonld"
-  },
-  "lsd:importPaths": {
-    "https://linkedsoftwaredependencies.org/bundles/npm/my-package/^1.0.0/components/": "components/",
-    "https://linkedsoftwaredependencies.org/bundles/npm/my-package/^1.0.0/config/": "config/"
-  },
+  "lsd:module": true,
   ...
 }
 ```

lib/parse/PackageMetadataLoader.ts

@@ -1,4 +1,5 @@
 import * as Path from 'path';
+import { ModuleStateBuilder } from 'componentsjs/lib/loading/ModuleStateBuilder';
 import type { ResolutionContext } from '../resolution/ResolutionContext';
 
 /**
@@ -26,6 +27,15 @@ export class PackageMetadataLoader {
       throw new Error(`Invalid package: Syntax error in ${packageJsonPath}: ${(<Error> error).message}`);
     }
 
+    // Preprocess to expand things like `"lsd:module": true`
+    if (await ModuleStateBuilder.preprocessPackageJson(packageRootDirectory, packageJson)) {
+      // Add default imports paths, which will not be autogenerated, as they do not exist yet
+      const baseUrl = Object.keys(packageJson['lsd:contexts'])[0].replace('components/context.jsonld', '');
+      const basePath = packageJson['lsd:basePath'] || '';
+      packageJson['lsd:importPaths'][`${baseUrl}components/`] = `${basePath}components/`;
+      packageJson['lsd:importPaths'][`${baseUrl}config/`] = `${basePath}config/`;
+    }
+
     // Extract required fields from package.json
     const name = packageJson.name;
     const version = packageJson.version;

test/parse/PackageMetadataLoader.test.ts

@@ -119,6 +119,61 @@ describe('PackageMetadataLoader', () => {
       });
     });
 
+    it('should return with all required entries with lsd:module true', async() => {
+      resolutionContext.contentsOverrides = {
+        [Path.normalize('/package.json')]: `{
+  "name": "@solid/community-server",
+  "version": "1.2.3",
+  "lsd:module": true,
+  "types": "./index.d.ts"
+}`,
+      };
+      expect(await loader.load('/')).toEqual({
+        componentsPath: Path.normalize('/components/components.jsonld'),
+        contexts: {
+          'https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^1.0.0/components/context.jsonld':
+            'components/context.jsonld',
+        },
+        importPaths: {
+          'https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^1.0.0/components/':
+            'components/',
+          'https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^1.0.0/config/': 'config/',
+        },
+        moduleIri: 'https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server',
+        name: '@solid/community-server',
+        version: '1.2.3',
+        typesPath: Path.normalize('/index'),
+      });
+    });
+
+    it('should return with all required entries with lsd:module true and lsd:basePath', async() => {
+      resolutionContext.contentsOverrides = {
+        [Path.normalize('/package.json')]: `{
+  "name": "@solid/community-server",
+  "version": "1.2.3",
+  "lsd:module": true,
+  "lsd:basePath": "dist/",
+  "types": "./index.d.ts"
+}`,
+      };
+      expect(await loader.load('/')).toEqual({
+        componentsPath: Path.normalize('/dist/components/components.jsonld'),
+        contexts: {
+          'https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^1.0.0/components/context.jsonld':
+            'dist/components/context.jsonld',
+        },
+        importPaths: {
+          'https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^1.0.0/components/':
+            'dist/components/',
+          'https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server/^1.0.0/config/': 'dist/config/',
+        },
+        moduleIri: 'https://linkedsoftwaredependencies.org/bundles/npm/@solid/community-server',
+        name: '@solid/community-server',
+        version: '1.2.3',
+        typesPath: Path.normalize('/index'),
+      });
+    });
+
     it('should error on invalid JSON', async() => {
       resolutionContext.contentsOverrides = {
         [Path.normalize('/package.json')]: `{`,