componentsjs 5.3.2 → 5.4.0

package/README.md

@@ -48,6 +48,8 @@ $ npm install -D componentsjs-generator
   "name": "my-package",
   "version": "2.3.4",
   "lsd:module": true,
+  "main": "index.js",
+  "types": "index.d.ts",
   ...
   "scripts": {
     ...
@@ -64,6 +66,9 @@ $ npm install -D componentsjs-generator
 
 The `"scripts"` entry will make sure that all required component files will be generated when building your package.
 
+The `componentsjs-generator` will look for your compiled TypeScript files (`.d.ts`) in the `lib/` directory.
+If you use a different output directory for TypeScript (e.g. `dist/`), you must pass this to the generator using `-s` flag (e.g. `componentsjs-generator -s dist`).
+
 #### 3. Create a configuration file to instantiate our class
 
 Assuming a TypeScript class that is exported from the package:
@@ -107,6 +112,8 @@ const myInstance = await manager.instantiate('urn:my-package:myInstance');
 
 `myInstance` is an instance of type `MyClass`, as defined in the config file.
 
+After running `npm run build`, you can now execute your program.
+
 ## Quick Start (JavaScript)
 
 #### 1. Install dependencies

package/lib/construction/ConfigConstructor.js

@@ -88,7 +88,6 @@ class ConfigConstructor {
         });
     }
 }
-exports.ConfigConstructor = ConfigConstructor;
 ConfigConstructor.ARGS_HANDLERS = [
     new ArgumentConstructorHandlerUndefined_1.ArgumentConstructorHandlerUndefined(),
     new ArgumentConstructorHandlerHash_1.ArgumentConstructorHandlerHash(),
@@ -98,4 +97,5 @@ ConfigConstructor.ARGS_HANDLERS = [
     new ArgumentConstructorHandlerReference_1.ArgumentConstructorHandlerReference(),
     new ArgumentConstructorHandlerPrimitive_1.ArgumentConstructorHandlerPrimitive(),
 ];
+exports.ConfigConstructor = ConfigConstructor;
 //# sourceMappingURL=ConfigConstructor.js.map

package/lib/construction/argument/ArgumentConstructorHandlerHash.js

@@ -17,13 +17,14 @@ class ArgumentConstructorHandlerHash {
             if (!entry.property.key) {
                 throw new ErrorResourcesContext_1.ErrorResourcesContext(`Missing key in fields entry`, { entry, argument });
             }
-            if (entry.property.key.type !== 'Literal') {
-                throw new ErrorResourcesContext_1.ErrorResourcesContext(`Illegal non-literal key (${entry.property.key.value} as ${entry.property.key.type}) in fields entry`, { entry, argument });
+            const key = await argsCreator.getArgumentValues(entry.properties.key, settings);
+            if (typeof key !== 'string') {
+                throw new ErrorResourcesContext_1.ErrorResourcesContext(`Illegal non-string key (${entry.property.key.value} as ${entry.property.key.type}) in fields entry`, { entry, argument });
             }
             // Recursively get value arg value
             if (entry.property.value) {
                 const subValue = await argsCreator.getArgumentValues(entry.properties.value, settings);
-                return { key: entry.property.key.value, value: subValue };
+                return { key, value: subValue };
             }
             // Ignore cases where value may not be set, because params may be optional
         }));

package/lib/preprocess/ConfigPreprocessorOverride.d.ts

@@ -27,7 +27,7 @@ export declare class ConfigPreprocessorOverride implements IConfigPreprocessor<R
      */
     transform(config: Resource, handleResponse: Record<string, Resource>): IConfigPreprocessorTransform;
     /**
-     * Clear all cached overrides so they will be calculated again on the next call.
+     * Clear all cached overrides, so they will be calculated again on the next call.
      */
     reset(): void;
     /**
@@ -70,20 +70,16 @@ export declare class ConfigPreprocessorOverride implements IConfigPreprocessor<R
         values: Record<string, Resource>;
     };
     /**
-     * Finds the final target and its type in an override chain.
+     * Finds the final target and validates its type value.
      * @param chain - The chain to find the target of.
      */
-    protected getChainTarget(chain: Resource[]): {
-        target: Resource;
-        type: Resource;
-    };
+    protected getChainTarget(chain: Resource[]): Resource;
     /**
-     * Extracts all relevant parameters of an Override with their corresponding new value.
+     * Extracts all parameters of an Override with their corresponding value.
      * @param override - The Override to apply.
-     * @param target - The target resource to apply the Override to.
-     * @param parameters - The parameters that are relevant for the target.
+     * @param target - The target resource to apply the Override to. Only used for error messages.
      */
-    protected filterOverrideObject(override: Resource, target: Resource, parameters: Resource[]): Record<string, Resource>;
+    protected extractOverrideParameters(override: Resource, target: Resource): Record<string, Resource>;
 }
 export interface IComponentConfigPreprocessorOverrideOptions {
     objectLoader: RdfObjectLoader;

package/lib/preprocess/ConfigPreprocessorOverride.js

@@ -33,16 +33,23 @@ class ConfigPreprocessorOverride {
      * @param handleResponse - Override values that were found for this resource.
      */
     transform(config, handleResponse) {
-        for (const id of Object.keys(config.properties)) {
-            const overrideValue = handleResponse[id];
-            if (overrideValue) {
-                config.properties[id] = [overrideValue];
+        var _a;
+        // We know this has exactly 1 result due to the canHandle call
+        const configType = (0, ResourceUtil_1.uniqueTypes)(config, this.componentResources)[0];
+        const overrideType = (_a = handleResponse[Iris_1.IRIS_RDF.type]) === null || _a === void 0 ? void 0 : _a.value;
+        // In case the type changes we have to delete all the original properties as those correspond to the old type
+        if (overrideType && configType.value !== overrideType) {
+            for (const id of Object.keys(config.properties)) {
+                delete config.properties[id];
             }
         }
+        for (const property of Object.keys(handleResponse)) {
+            config.properties[property] = [handleResponse[property]];
+        }
         return { rawConfig: config, finishTransformation: false };
     }
     /**
-     * Clear all cached overrides so they will be calculated again on the next call.
+     * Clear all cached overrides, so they will be calculated again on the next call.
      */
     reset() {
         this.overrides = undefined;
@@ -147,19 +154,28 @@ class ConfigPreprocessorOverride {
      * @param chain - The chain of Overrides, with a normal resource as the last entry in the array.
      */
     chainToOverrideObject(chain) {
-        const { target, type } = this.getChainTarget(chain);
+        var _a, _b;
+        const target = this.getChainTarget(chain);
         // Apply all overrides sequentially, starting from the one closest to the target.
         // This ensures the most recent override has priority.
-        const parameters = this.componentResources[type.value].properties.parameters;
-        const mergedOverride = {};
+        let mergedOverride = {};
         for (let i = chain.length - 2; i >= 0; --i) {
-            const filteredObject = this.filterOverrideObject(chain[i], target, parameters);
-            Object.assign(mergedOverride, filteredObject);
+            const validatedObject = this.extractOverrideParameters(chain[i], target);
+            // In case an Override has a different type, the properties of the target don't matter any more,
+            // as the object is being replaced completely.
+            const mergedType = (_a = mergedOverride[Iris_1.IRIS_RDF.type]) === null || _a === void 0 ? void 0 : _a.value;
+            const overrideType = (_b = validatedObject[Iris_1.IRIS_RDF.type]) === null || _b === void 0 ? void 0 : _b.value;
+            if (overrideType && overrideType !== mergedType) {
+                mergedOverride = validatedObject;
+            }
+            else {
+                Object.assign(mergedOverride, validatedObject);
+            }
         }
         return { target: target.value, values: mergedOverride };
     }
     /**
-     * Finds the final target and its type in an override chain.
+     * Finds the final target and validates its type value.
      * @param chain - The chain to find the target of.
      */
     getChainTarget(chain) {
@@ -177,15 +193,14 @@ class ConfigPreprocessorOverride {
                 override: chain[chain.length - 2],
             });
         }
-        return { target, type: types[0] };
+        return target;
     }
     /**
-     * Extracts all relevant parameters of an Override with their corresponding new value.
+     * Extracts all parameters of an Override with their corresponding value.
      * @param override - The Override to apply.
-     * @param target - The target resource to apply the Override to.
-     * @param parameters - The parameters that are relevant for the target.
+     * @param target - The target resource to apply the Override to. Only used for error messages.
      */
-    filterOverrideObject(override, target, parameters) {
+    extractOverrideParameters(override, target) {
         const overrideObjects = override.properties[Iris_1.IRIS_OO.overrideParameters];
         if (!overrideObjects || overrideObjects.length === 0) {
             this.logger.warn(`No overrideParameters found for ${override.value}.`);
@@ -198,22 +213,19 @@ class ConfigPreprocessorOverride {
         }
         const overrideObject = overrideObjects[0];
         // Only keep the parameters that are known to the type of the target object
-        const filteredObject = {};
-        for (const parameter of parameters) {
-            const overrideValues = overrideObject.properties[parameter.value];
-            if (!overrideValues || overrideValues.length === 0) {
-                continue;
-            }
+        const validatedObject = {};
+        for (const parameter of Object.keys(overrideObject.properties)) {
+            const overrideValues = overrideObject.properties[parameter];
             if (overrideValues.length > 1) {
-                throw new ErrorResourcesContext_1.ErrorResourcesContext(`Detected multiple values for override parameter ${parameter.value} in Override ${override.value}. RDF lists should be used for defining multiple values.`, {
+                throw new ErrorResourcesContext_1.ErrorResourcesContext(`Detected multiple values for override parameter ${parameter} in Override ${override.value}. RDF lists should be used for defining multiple values.`, {
                     arguments: overrideValues,
                     target,
                     override,
                 });
             }
-            filteredObject[parameter.value] = overrideValues[0];
+            validatedObject[parameter] = overrideValues[0];
         }
-        return filteredObject;
+        return validatedObject;
     }
 }
 exports.ConfigPreprocessorOverride = ConfigPreprocessorOverride;

package/lib/preprocess/GenericsContext.js

@@ -292,7 +292,6 @@ class GenericsContext {
         }
     }
 }
-exports.GenericsContext = GenericsContext;
 GenericsContext.XSD_INHERITANCE_TABLE = {
     'http://www.w3.org/2001/XMLSchema#number': new Set([
         'http://www.w3.org/2001/XMLSchema#integer',
@@ -325,4 +324,5 @@ GenericsContext.XSD_INHERITANCE_TABLE = {
         'http://www.w3.org/2001/XMLSchema#langString',
     ]),
 };
+exports.GenericsContext = GenericsContext;
 //# sourceMappingURL=GenericsContext.js.map

package/lib/rdf/PrefetchedDocumentLoader.js

@@ -31,7 +31,6 @@ class PrefetchedDocumentLoader extends jsonld_context_parser_1.FetchDocumentLoad
         return super.load(url);
     }
 }
-exports.PrefetchedDocumentLoader = PrefetchedDocumentLoader;
 PrefetchedDocumentLoader.CONTEXT_URL = 'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld';
 PrefetchedDocumentLoader.DEFAULT_CONTEXT = require('../../components/context.json');
 PrefetchedDocumentLoader.DEFAULT_CONTEXTS = {
@@ -40,4 +39,5 @@ PrefetchedDocumentLoader.DEFAULT_CONTEXTS = {
     '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,
 };
+exports.PrefetchedDocumentLoader = PrefetchedDocumentLoader;
 //# sourceMappingURL=PrefetchedDocumentLoader.js.map

package/lib/rdf/RdfParser.d.ts

@@ -1,4 +1,5 @@
 /// <reference types="node" />
+/// <reference types="node" />
 import type { Readable } from 'stream';
 import type * as RDF from '@rdfjs/types';
 import type { ParseOptions } from 'rdf-parse';
@@ -27,7 +28,7 @@ export declare class RdfParser {
      */
     static addPathToError(error: Error, path: string): Error;
 }
-export declare type RdfParserOptions = ParseOptions & {
+export type RdfParserOptions = ParseOptions & {
     /**
      * If imports in the RDF document should be ignored.
      */

package/lib/util/LogLevel.d.ts

@@ -1,4 +1,4 @@
 /**
  * Different log levels, from most important to least important.
  */
-export declare type LogLevel = 'error' | 'warn' | 'info' | 'verbose' | 'debug' | 'silly';
+export type LogLevel = 'error' | 'warn' | 'info' | 'verbose' | 'debug' | 'silly';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "componentsjs",
-  "version": "5.3.2",
+  "version": "5.4.0",
   "description": "A semantic dependency injection framework",
   "lsd:contexts": {
     "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld": "components/context.jsonld"
@@ -39,7 +39,7 @@
   "dependencies": {
     "@rdfjs/types": "*",
     "@types/minimist": "^1.2.0",
-    "@types/node": "^14.14.7",
+    "@types/node": "^18.0.0",
     "@types/semver": "^7.3.4",
     "jsonld-context-parser": "^2.1.1",
     "minimist": "^1.2.0",
@@ -78,9 +78,9 @@
     "streamify-string": "^1.0.1",
     "ts-jest": "^27.0.1",
     "ts-loader": "^9.4.1",
-    "typescript": "^4.3.5",
+    "typescript": "^5.0.0",
     "webpack": "^5.75.0",
-    "webpack-cli": "^4.10.0"
+    "webpack-cli": "^5.0.0"
   },
   "files": [
     "components",