componentsjs 5.5.1 → 6.0.1

package/README.md

@@ -85,7 +85,7 @@ export class MyClass {
 ```json
 {
   "@context": [
-    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld",
     "https://linkedsoftwaredependencies.org/bundles/npm/my-package/^2.0.0/components/context.jsonld"
   ],
   "@id": "urn:my-package:myInstance",
@@ -139,7 +139,7 @@ export class MyClass {
 ```json
 {
   "@context": [
-    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld",
     { "ex": "http://example.org/" }
   ],
   "@id": "ex:MyPackage",
@@ -171,7 +171,7 @@ The constructor of `MyClass` takes a single `name` argument.
 ```json
 {
   "@context": [
-    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^6.0.0/components/context.jsonld",
     {
       "ex": "http://example.org/",
       "name": "ex:MyPackage/MyClass#name"

package/lib/loading/ComponentRegistry.d.ts

@@ -18,6 +18,7 @@ export declare class ComponentRegistry {
     private readonly logger;
     private readonly componentResources;
     private readonly skipContextValidation;
+    private readonly remoteContextLookups;
     constructor(options: IComponentLoaderRegistryOptions);
     /**
      * Register all modules and their components that are available in the {@link IModuleState}.
@@ -65,4 +66,5 @@ export interface IComponentLoaderRegistryOptions {
     logger: Logger;
     componentResources: Record<string, Resource>;
     skipContextValidation: boolean;
+    remoteContextLookups: boolean;
 }

package/lib/loading/ComponentRegistry.js

@@ -17,6 +17,7 @@ class ComponentRegistry {
         this.logger = options.logger;
         this.componentResources = options.componentResources;
         this.skipContextValidation = options.skipContextValidation;
+        this.remoteContextLookups = options.remoteContextLookups;
     }
     /**
      * Register all modules and their components that are available in the {@link IModuleState}.
@@ -25,6 +26,7 @@ class ComponentRegistry {
      */
     async registerAvailableModules() {
         await Promise.all(Object.values(this.moduleState.componentModules)
+            .flatMap(Object.values)
             .map((moduleResourceUrl) => this.registerModule(moduleResourceUrl)));
     }
     /**
@@ -39,6 +41,7 @@ class ComponentRegistry {
             importPaths: this.moduleState.importPaths,
             logger: this.logger,
             skipContextValidation: this.skipContextValidation,
+            remoteContextLookups: this.remoteContextLookups,
         }));
     }
     /**

package/lib/loading/ComponentsManagerBuilder.d.ts

@@ -19,6 +19,7 @@ export declare class ComponentsManagerBuilder<Instance = any> {
     private readonly moduleState?;
     private readonly skipContextValidation;
     private readonly typeChecking;
+    private readonly remoteContextLookups;
     constructor(options: IComponentsManagerBuilderOptions<Instance>);
     static createLogger(logLevel?: LogLevel): Logger;
     static createObjectLoader(): RdfObjectLoader;
@@ -75,4 +76,11 @@ export interface IComponentsManagerBuilderOptions<Instance> {
      * Defaults to `true`.
      */
     typeChecking?: boolean;
+    /**
+     * If remote context lookups are allowed.
+     * If not allowed, an error is thrown if a remote lookup occurs.
+     * If allowed, only a warning is emitted.
+     * Defaults to `false`.
+     */
+    remoteContextLookups?: boolean;
 }

package/lib/loading/ComponentsManagerBuilder.js

@@ -34,6 +34,9 @@ class ComponentsManagerBuilder {
         this.typeChecking = options.typeChecking === undefined ?
             true :
             Boolean(options.typeChecking);
+        this.remoteContextLookups = options.remoteContextLookups === undefined ?
+            false :
+            Boolean(options.typeChecking);
     }
     static createLogger(logLevel = 'warn') {
         return (0, winston_1.createLogger)({
@@ -76,6 +79,7 @@ class ComponentsManagerBuilder {
             logger: this.logger,
             componentResources,
             skipContextValidation: this.skipContextValidation,
+            remoteContextLookups: this.remoteContextLookups,
         });
         await this.componentLoader(componentRegistry);
         const componentFinalizer = new ComponentRegistryFinalizer_1.ComponentRegistryFinalizer({
@@ -91,6 +95,7 @@ class ComponentsManagerBuilder {
             objectLoader,
             logger: this.logger,
             skipContextValidation: this.skipContextValidation,
+            remoteContextLookups: this.remoteContextLookups,
         });
         await this.configLoader(configRegistry);
         this.logger.info(`Loaded configs`);

package/lib/loading/ConfigRegistry.d.ts

@@ -12,6 +12,7 @@ export declare class ConfigRegistry {
     private readonly objectLoader;
     private readonly logger;
     private readonly skipContextValidation;
+    private readonly remoteContextLookups;
     constructor(options: IConfigLoaderRegistryOptions);
     /**
      * Register a config based on a config URL or local file path.
@@ -41,4 +42,5 @@ export interface IConfigLoaderRegistryOptions {
     objectLoader: RdfObjectLoader;
     logger: Logger;
     skipContextValidation: boolean;
+    remoteContextLookups: boolean;
 }

package/lib/loading/ConfigRegistry.js

@@ -12,6 +12,7 @@ class ConfigRegistry {
         this.objectLoader = options.objectLoader;
         this.logger = options.logger;
         this.skipContextValidation = options.skipContextValidation;
+        this.remoteContextLookups = options.remoteContextLookups;
     }
     /**
      * Register a config based on a config URL or local file path.
@@ -26,6 +27,7 @@ class ConfigRegistry {
             ignoreImports: false,
             logger: this.logger,
             skipContextValidation: this.skipContextValidation,
+            remoteContextLookups: this.remoteContextLookups,
         }));
     }
     /**

package/lib/loading/ModuleStateBuilder.d.ts

@@ -51,13 +51,13 @@ export declare class ModuleStateBuilder {
      * @returns If the package has been preprocessed.
      */
     static preprocessPackageJson(packagePath: string, packageJson: Record<string, any>): Promise<boolean>;
-    protected shouldOverrideVersion(version: string, key: string, componentVersions: Record<string, string>, warningSuffix: string): boolean;
+    protected shouldOverrideVersion(version: string, key: string, componentVersion: string | undefined, warningSuffix?: () => string): boolean;
     /**
      * Get all Components.js modules from the given package.json files.
      * @param packageJsons A hash of Node module path to package.json contents.
      * @return A hash of module id (`lsd:module`) to absolute component paths (`lsd:components`).
      */
-    buildComponentModules(packageJsons: Record<string, any>): Promise<Record<string, string>>;
+    buildComponentModules(packageJsons: Record<string, any>): Promise<Record<string, Record<number, string>>>;
     /**
      * Get all Components.js contexts from the given package.json files.
      * @param packageJsons A hash of Node module path to package.json contents.
@@ -96,10 +96,10 @@ export interface IModuleState {
     packageJsons: Record<string, any>;
     /**
      * All Components.js modules.
-     * This hash maps module IRIs (`lsd:module`)
+     * This hash maps module IRIs (`lsd:module`) to major version
      * to absolute component paths (`lsd:components`).
      */
-    componentModules: Record<string, string>;
+    componentModules: Record<string, Record<number, string>>;
     /**
      * All Components.js contexts.
      * This hash maps context IRIs (key of `lsd:contexts`)

package/lib/loading/ModuleStateBuilder.js

@@ -205,12 +205,12 @@ class ModuleStateBuilder {
         }
         return false;
     }
-    shouldOverrideVersion(version, key, componentVersions, warningSuffix) {
-        if (key in componentVersions) {
-            if (semverMajor(version) !== semverMajor(componentVersions[key])) {
-                this.warn(`Detected multiple incompatible occurrences of '${key}'${warningSuffix}`);
+    shouldOverrideVersion(version, key, componentVersion, warningSuffix) {
+        if (componentVersion !== undefined) {
+            if (warningSuffix && semverMajor(version) !== semverMajor(componentVersion)) {
+                this.warn(`Detected multiple incompatible occurrences of '${key}'${warningSuffix()}`);
             }
-            if (semverGt(version, componentVersions[key])) {
+            if (semverGt(version, componentVersion)) {
                 return true;
             }
             return false;
@@ -230,10 +230,15 @@ class ModuleStateBuilder {
             const relativePath = pckg['lsd:components'];
             const version = pckg.version;
             if (version && currentModuleUri && relativePath && semverValid(version)) {
+                if (!componentModules[currentModuleUri]) {
+                    componentModules[currentModuleUri] = {};
+                    componentVersions[currentModuleUri] = {};
+                }
+                const versionMajor = semverMajor(version);
                 const absolutePath = Path.posix.join(modulePath, relativePath);
-                if (this.shouldOverrideVersion(version, currentModuleUri, componentVersions, `, in '${componentModules[currentModuleUri]}'@${componentVersions[currentModuleUri]} and '${absolutePath}'@${version}`)) {
-                    componentModules[currentModuleUri] = absolutePath;
-                    componentVersions[currentModuleUri] = version;
+                if (this.shouldOverrideVersion(version, currentModuleUri, componentVersions[currentModuleUri][versionMajor])) {
+                    componentModules[currentModuleUri][versionMajor] = absolutePath;
+                    componentVersions[currentModuleUri][versionMajor] = version;
                 }
             }
         }
@@ -254,7 +259,7 @@ class ModuleStateBuilder {
                 for (const [key, value] of Object.entries(contexts)) {
                     const filePath = Path.posix.join(modulePath, value);
                     const fileContents = JSON.parse(await fs.readFile(filePath, 'utf8'));
-                    if (this.shouldOverrideVersion(version, key, componentVersions, ` for version ${componentVersions[key]} and '${filePath}'@${version}`)) {
+                    if (this.shouldOverrideVersion(version, key, componentVersions[key], () => ` for version ${componentVersions[key]} and '${filePath}'@${version}`)) {
                         componentContexts[key] = fileContents;
                         componentVersions[key] = version;
                     }
@@ -277,7 +282,7 @@ class ModuleStateBuilder {
             if (version && importPaths && semverValid(version)) {
                 for (const [key, value] of Object.entries(importPaths)) {
                     const filePath = Path.posix.join(modulePath, value);
-                    if (this.shouldOverrideVersion(version, key, componentVersions, ` for version ${componentVersions[key]} and '${filePath}'@${version}`)) {
+                    if (this.shouldOverrideVersion(version, key, componentVersions[key], () => ` for version ${componentVersions[key]} and '${filePath}'@${version}`)) {
                         componentImportPaths[key] = filePath;
                         componentVersions[key] = version;
                         // Crash when the context prefix target does not exist

package/lib/preprocess/parameterproperty/ParameterPropertyHandlerRange.js

@@ -396,7 +396,8 @@ class ParameterPropertyHandlerRange {
         const withTypes = value && value.properties.types.length > 0 ? ` with types "${value.properties.types.map(resource => resource.value)}"` : '';
         // eslint-disable-next-line @typescript-eslint/no-extra-parens
         const valueString = value ? (value.list ? `[${value.list.map(subValue => subValue.value).join(', ')}]` : value.value) : 'undefined';
-        throw new ErrorResourcesContext_1.ErrorResourcesContext(`The value "${valueString}"${withTypes} for parameter "${parameter.value}" is not of required range type "${ParameterPropertyHandlerRange.rangeToDisplayString(parameter.property.range, genericsContext)}"`, Object.assign(Object.assign({ cause: conflict, value: value || 'undefined' }, Object.keys(genericsContext.bindings).length > 0 ?
+        const undefinedComponent = value && value.term.termType === 'NamedNode' && value.properties.types.length === 0 ? `. "${valueString}" seems to refer to a component instance that is not defined yet. Did you forget an import?` : '';
+        throw new ErrorResourcesContext_1.ErrorResourcesContext(`The value "${valueString}"${withTypes} for parameter "${parameter.value}" is not of required range type "${ParameterPropertyHandlerRange.rangeToDisplayString(parameter.property.range, genericsContext)}"${undefinedComponent}`, Object.assign(Object.assign({ cause: conflict, value: value || 'undefined' }, Object.keys(genericsContext.bindings).length > 0 ?
             { generics: `[\n  ${Object.entries(genericsContext.bindings)
                     .map(([id, subValue]) => `<${id}> => ${ParameterPropertyHandlerRange.rangeToDisplayString(subValue, genericsContext)}`)
                     .join(',\n  ')}\n]` } :

package/lib/rdf/PrefetchedDocumentLoader.d.ts

@@ -6,12 +6,15 @@ import type { Logger } from 'winston';
  * and only then does an HTTP(S) lookup for the context.
  */
 export declare class PrefetchedDocumentLoader extends FetchDocumentLoader {
+    static readonly CJS_MAJOR_VERSION: number;
     static readonly CONTEXT_URL: string;
+    static readonly CONTEXT_PATTERN: RegExp;
     private static readonly DEFAULT_CONTEXT;
     private static readonly DEFAULT_CONTEXTS;
     private readonly contexts;
     private readonly path?;
     private readonly logger?;
+    private readonly remoteContextLookups?;
     constructor(options: IPrefetchedDocumentLoaderOptions);
     load(url: string): Promise<IJsonLdContext>;
 }
@@ -19,4 +22,5 @@ export interface IPrefetchedDocumentLoaderOptions {
     contexts: Record<string, any>;
     logger?: Logger;
     path?: string;
+    remoteContextLookups?: boolean;
 }

package/lib/rdf/PrefetchedDocumentLoader.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.PrefetchedDocumentLoader = void 0;
 const jsonld_context_parser_1 = require("jsonld-context-parser");
+const semverMajor = require("semver/functions/major");
 /**
  * A document loader that first loads from a precomputed set of contexts,
  * and only then does an HTTP(S) lookup for the context.
@@ -12,32 +13,36 @@ class PrefetchedDocumentLoader extends jsonld_context_parser_1.FetchDocumentLoad
         this.contexts = Object.assign(Object.assign({}, options.contexts), PrefetchedDocumentLoader.DEFAULT_CONTEXTS);
         this.logger = options.logger;
         this.path = options.path;
+        this.remoteContextLookups = options.remoteContextLookups;
     }
     async load(url) {
-        // Warn on deprecated context usage
-        if (this.logger &&
-            (url === 'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^4.0.0/components/context.jsonld' ||
-                url === 'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^3.0.0/components/context.jsonld')) {
-            this.logger.warn(`Detected deprecated context URL '${url}'${this.path ? ` in ${this.path}` : ''}. Prefer using version '^5.0.0' instead.`);
-        }
         // Load prefetched contexts
         if (url in this.contexts) {
             return this.contexts[url];
         }
         // Warn before doing a remote context lookup
+        const errorMessage = `Detected remote context lookup for '${url}'${this.path ? ` in ${this.path}` : ''}. This may indicate a missing or invalid dependency, incorrect version number, or an invalid context URL.`;
+        if (!this.remoteContextLookups) {
+            throw new Error(errorMessage);
+        }
         if (this.logger) {
-            this.logger.warn(`Detected remote context lookup for '${url}'${this.path ? ` in ${this.path}` : ''}. This may indicate a missing or invalid dependency, incorrect version number, or an invalid context URL.`);
+            this.logger.warn(errorMessage);
         }
         return super.load(url);
     }
 }
-PrefetchedDocumentLoader.CONTEXT_URL = 'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld';
+PrefetchedDocumentLoader.CJS_MAJOR_VERSION = semverMajor(require('../../package.json').version);
+PrefetchedDocumentLoader.CONTEXT_URL = `https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^${PrefetchedDocumentLoader.CJS_MAJOR_VERSION}.0.0/components/context.jsonld`;
+PrefetchedDocumentLoader.CONTEXT_PATTERN = /https:\/\/linkedsoftwaredependencies.org\/bundles\/npm\/componentsjs\/\^([0-9]+).0.0\/components\/context.jsonld/u;
 PrefetchedDocumentLoader.DEFAULT_CONTEXT = require('../../components/context.json');
 PrefetchedDocumentLoader.DEFAULT_CONTEXTS = {
     [PrefetchedDocumentLoader.CONTEXT_URL]: PrefetchedDocumentLoader.DEFAULT_CONTEXT,
-    // TODO: temporarily also set old context versions for backwards-compatible.
-    'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^4.0.0/components/context.jsonld': PrefetchedDocumentLoader.DEFAULT_CONTEXT,
-    'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^3.0.0/components/context.jsonld': PrefetchedDocumentLoader.DEFAULT_CONTEXT,
 };
+(() => {
+    // TODO: temporarily also set old context versions for backwards-compatible.
+    for (let i = 3; i < PrefetchedDocumentLoader.CJS_MAJOR_VERSION; i++) {
+        PrefetchedDocumentLoader.DEFAULT_CONTEXTS[`https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^${i}.0.0/components/context.jsonld`] = PrefetchedDocumentLoader.DEFAULT_CONTEXT;
+    }
+})();
 exports.PrefetchedDocumentLoader = PrefetchedDocumentLoader;
 //# sourceMappingURL=PrefetchedDocumentLoader.js.map

package/lib/rdf/RdfParser.d.ts

@@ -58,4 +58,10 @@ export type RdfParserOptions = ParseOptions & {
      * If JSON-LD context validation should be skipped.
      */
     skipContextValidation?: boolean;
+    /**
+     * If remote context lookups are allowed.
+     * If not allowed, an error is thrown if a remote lookup occurs.
+     * If allowed, only a warning is emitted.
+     */
+    remoteContextLookups?: boolean;
 };

package/lib/rdf/RdfParser.js

@@ -45,6 +45,7 @@ class RdfParser {
                 contexts: options.contexts || {},
                 logger: options.logger,
                 path: options.path,
+                remoteContextLookups: options.remoteContextLookups,
             }),
             // Enable strict parsing of JSON-LD to error on potential user config errors
             strictValues: true,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "componentsjs",
-  "version": "5.5.1",
+  "version": "6.0.1",
   "description": "A semantic dependency injection framework",
   "lsd:contexts": {
     "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld": "components/context.jsonld"
@@ -21,7 +21,7 @@
   "license": "MIT",
   "packageManager": "yarn@4.0.1",
   "scripts": {
-    "test": "yarn test:jest && yarn test:webpack",
+    "test": "yarn test:jest",
     "test:jest": "jest",
     "test:webpack": "yarn test:webpack:node && yarn test:webpack:web",
     "test:webpack:node": "webpack -c test/webpack/webpack.config.js && node test/webpack/build/test.min.js",