componentsjs 5.0.0 → 5.2.0

package/CHANGELOG.md

@@ -1,6 +1,24 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+<a name="v5.2.0"></a>
+## [v5.2.0](https://github.com/LinkedSoftwareDependencies/Components.js/compare/v5.1.0...v5.2.0) - 2022-05-20
+
+### Added
+* [Preserve literal values for params with type unknown](https://github.com/LinkedSoftwareDependencies/Components.js/commit/ad52da8afc2340ddc63e8a45c4d560e11ecb3ceb)
+
+<a name="v5.1.0"></a>
+## [v5.1.0](https://github.com/LinkedSoftwareDependencies/Components.js/compare/v5.0.0...v5.1.0) - 2022-05-10
+
+### Added
+* [Expose instantiated resources from ComponentsManager](https://github.com/LinkedSoftwareDependencies/Components.js/commit/19c8d669a081dc413091a413d1c42c71b691cfbc)
+
+<a name="v5.0.1"></a>
+## [v5.0.1](https://github.com/LinkedSoftwareDependencies/Components.js/compare/v5.0.0...v5.0.1) - 2022-03-02
+
+### Changed
+* [Bump to rdf-parse 2](https://github.com/LinkedSoftwareDependencies/Components.js/commit/5957c21d9ea0d8e6086be09d67ee99e64f8b2960)
+
 <a name="v5.0.0"></a>
 ## [v5.0.0](https://github.com/LinkedSoftwareDependencies/Components.js/compare/v5.0.0-beta.7...v5.0.0) - 2022-03-01
 

package/README.md

@@ -53,7 +53,7 @@ $ npm install -D componentsjs-generator
     ...
     "build": "npm run build:ts && npm run build:components",
     "build:ts": "tsc",
-    "build:components": "componentsjs-generator --typeScopedContexts",
+    "build:components": "componentsjs-generator",
     "prepare": "npm run build",
     ...
   }
@@ -80,7 +80,7 @@ export class MyClass {
 ```json
 {
   "@context": [
-    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^4.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
     "https://linkedsoftwaredependencies.org/bundles/npm/my-package/^2.0.0/components/context.jsonld"
   ],
   "@id": "urn:my-package:myInstance",
@@ -132,7 +132,7 @@ export class MyClass {
 ```json
 {
   "@context": [
-    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^4.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
     { "ex": "http://example.org/" }
   ],
   "@id": "ex:MyPackage",
@@ -164,7 +164,7 @@ The constructor of `MyClass` takes a single `name` argument.
 ```json
 {
   "@context": [
-    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^4.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld",
     {
       "ex": "http://example.org/",
       "name": "ex:MyPackage/MyClass#name"

package/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/lib/ComponentsManager.d.ts

@@ -33,6 +33,10 @@ export declare class ComponentsManager<Instance> {
      * @param settings Optional settings that may influence instantiation.
      */
     instantiate<T = Instance>(instanceIri: string, settings?: IConstructionSettings): Promise<T>;
+    /**
+     * Retrieve a list of all instantiated Resources.
+     */
+    getInstantiatedResources(): Resource[];
     /**
      * Create an `componentsjs-error-state.json` file to represent the application state in the current working directory.
      * @param error The error that causes this error state to be created.

package/lib/ComponentsManager.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ComponentsManager = void 0;
 const fs = require("fs");
+const rdf_string_1 = require("rdf-string");
 const ComponentsManagerBuilder_1 = require("./loading/ComponentsManagerBuilder");
 const ErrorResourcesContext_1 = require("./util/ErrorResourcesContext");
 /**
@@ -46,6 +47,15 @@ class ComponentsManager {
             throw this.generateErrorLog(error);
         }
     }
+    /**
+     * Retrieve a list of all instantiated Resources.
+     */
+    getInstantiatedResources() {
+        const instances = this.configConstructorPool.getInstanceRegistry();
+        return Object.keys(instances)
+            .map(key => (0, rdf_string_1.stringToTerm)(key))
+            .map(term => this.configRegistry.getInstantiatedResource(term));
+    }
     /**
      * Create an `componentsjs-error-state.json` file to represent the application state in the current working directory.
      * @param error The error that causes this error state to be created.

package/lib/construction/ConfigConstructorPool.d.ts

@@ -41,6 +41,10 @@ export declare class ConfigConstructorPool<Instance> implements IConfigConstruct
      * @param optional If the field is optional.
      */
     validateParam(config: Resource, field: string, type: string, optional?: boolean): void;
+    /**
+     * Returns the instance registry.
+     */
+    getInstanceRegistry(): Record<string, Promise<any>>;
 }
 export interface IInstancePoolOptions<Instance> {
     /**

package/lib/construction/ConfigConstructorPool.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigConstructorPool = void 0;
+const rdf_string_1 = require("rdf-string");
 const ErrorResourcesContext_1 = require("../util/ErrorResourcesContext");
 const ConfigConstructor_1 = require("./ConfigConstructor");
 /**
@@ -27,7 +28,8 @@ class ConfigConstructorPool {
         // Check if this resource is required as argument in its own chain,
         // if so, return a dummy value, to avoid infinite recursion.
         const resourceBlacklist = settings.resourceBlacklist || {};
-        if (resourceBlacklist[configResource.value]) {
+        const configResourceId = (0, rdf_string_1.termToString)(configResource.term);
+        if (resourceBlacklist[configResourceId]) {
             return Promise.reject(new ErrorResourcesContext_1.ErrorResourcesContext(`Circular dependency was detected on ${configResource.value}`, { config: configResource }));
         }
         // Before instantiating, first check if the resource is a variable
@@ -36,24 +38,24 @@ class ConfigConstructorPool {
                 .getVariableValue({ settings, variableName: configResource.value }));
         }
         // Instantiate only once
-        if (!(configResource.value in this.instances)) {
+        if (!(configResourceId in this.instances)) {
             // The blacklist avoids infinite recursion for self-referencing configs
             const subBlackList = Object.assign({}, resourceBlacklist);
-            subBlackList[configResource.value] = true;
+            subBlackList[configResourceId] = true;
             // Prepare instance parameters
             let rawConfig;
             try {
                 rawConfig = this.getRawConfig(configResource);
             }
             catch (syncError) {
-                this.instances[configResource.value] = Promise.reject(syncError);
-                return this.instances[configResource.value];
+                this.instances[configResourceId] = Promise.reject(syncError);
+                return this.instances[configResourceId];
             }
             const subSettings = Object.assign(Object.assign({}, settings), { resourceBlacklist: subBlackList });
             // Invoke instance creation
-            this.instances[configResource.value] = this.configConstructor.createInstance(rawConfig, subSettings);
+            this.instances[configResourceId] = this.configConstructor.createInstance(rawConfig, subSettings);
         }
-        return this.instances[configResource.value];
+        return this.instances[configResourceId];
     }
     /**
      * Determine the raw config of the given config.
@@ -106,6 +108,12 @@ class ConfigConstructorPool {
             throw new ErrorResourcesContext_1.ErrorResourcesContext(`Invalid config: ${field} "${config.property[field].value}" must be a ${type}, but got ${config.property[field].type}`, { config });
         }
     }
+    /**
+     * Returns the instance registry.
+     */
+    getInstanceRegistry() {
+        return this.instances;
+    }
 }
 exports.ConfigConstructorPool = ConfigConstructorPool;
 //# sourceMappingURL=ConfigConstructorPool.js.map

package/lib/construction/IConfigConstructorPool.d.ts

@@ -11,4 +11,9 @@ export interface IConfigConstructorPool<Instance> {
      * @returns {any} The run instance.
      */
     instantiate: (configResource: Resource, settings: IConstructionSettings) => Promise<Instance>;
+    /**
+     * Return the instance regsitry.
+     * This is a hash from registered id to a Promise of the Instance.
+     */
+    getInstanceRegistry: () => Record<string, Promise<Instance>>;
 }

package/lib/loading/ConfigRegistry.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="node" />
 import type { Readable } from 'stream';
 import type * as RDF from '@rdfjs/types';
-import type { RdfObjectLoader } from 'rdf-object';
+import type { RdfObjectLoader, Resource } from 'rdf-object';
 import type { Logger } from 'winston';
 import type { IModuleState } from './ModuleStateBuilder';
 /**
@@ -30,6 +30,11 @@ export declare class ConfigRegistry {
      * @param params A dictionary with named parameters.
      */
     registerCustom(configId: string, componentTypeIri: string, params: Record<string, string>): Promise<void>;
+    /**
+     * Get the instantiated Resource that was registered to the given term.
+     * @param term The term of the Resource that was instantiated
+     */
+    getInstantiatedResource(term: RDF.Term): Resource;
 }
 export interface IConfigLoaderRegistryOptions {
     moduleState: IModuleState;

package/lib/loading/ConfigRegistry.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigRegistry = void 0;
+const rdf_string_1 = require("rdf-string");
 const RdfParser_1 = require("../rdf/RdfParser");
 /**
  * Accepts registrations for configurations that contain instantiations of components.
@@ -50,6 +51,13 @@ class ConfigRegistry {
             configResource.property[key] = this.objectLoader.createCompactedResource(`"${params[key]}"`);
         }
     }
+    /**
+     * Get the instantiated Resource that was registered to the given term.
+     * @param term The term of the Resource that was instantiated
+     */
+    getInstantiatedResource(term) {
+        return this.objectLoader.resources[(0, rdf_string_1.termToString)(term)];
+    }
 }
 exports.ConfigRegistry = ConfigRegistry;
 //# sourceMappingURL=ConfigRegistry.js.map

package/lib/preprocess/parameterproperty/ParameterPropertyHandlerRange.d.ts

@@ -33,6 +33,11 @@ export declare class ParameterPropertyHandlerRange implements IParameterProperty
      * @return IParamValueConflict A conflict value if there was an error, or undefined if there was no error
      */
     hasValueType(value: Resource | undefined, type: Resource | undefined, errorContext: IErrorContext, genericsContext: GenericsContext): IParamValueConflict | undefined;
+    /**
+     * Utility function for handling Literals.
+     * If the provided value represents a valid Literal, the `valueRaw` field will be set.
+     */
+    private interpretValueAsType;
     static throwIncorrectTypeError(value: Resource | undefined, parameter: Resource, genericsContext: GenericsContext, conflict: IParamValueConflict): never;
     /**
      * Check if the given value is of the given type.
@@ -54,3 +59,13 @@ export interface IParamValueConflict {
     context: IErrorContext;
     causes?: IParamValueConflict[];
 }
+/**
+ * Represents the result of an interpretValuesAsType operation.
+ */
+export interface ILiteralAsTypeInterpretationResult {
+    /**
+     * Value is true if a matching literal type was found.
+     */
+    match: boolean;
+    value?: IParamValueConflict;
+}

package/lib/preprocess/parameterproperty/ParameterPropertyHandlerRange.js

@@ -53,6 +53,11 @@ class ParameterPropertyHandlerRange {
             return;
         }
         if (type.isA('ParameterRangeWildcard')) {
+            if (value && value.term.termType === 'Literal') {
+                // Get datatype of the configured value
+                const configuredDataType = value.term.datatype;
+                return this.interpretValueAsType(value, configuredDataType, errorContext, genericsContext).value;
+            }
             return;
         }
         if (!value && type.isA('ParameterRangeUndefined')) {
@@ -64,69 +69,10 @@ class ParameterPropertyHandlerRange {
         }
         // Handle literal values
         if (value && value.type === 'Literal') {
-            let parsed;
-            switch (type.value) {
-                case Iris_1.IRIS_XSD.string:
-                    return;
-                case Iris_1.IRIS_XSD.boolean:
-                    if (value.value === 'true') {
-                        value.term.valueRaw = true;
-                    }
-                    else if (value.value === 'false') {
-                        value.term.valueRaw = false;
-                    }
-                    else {
-                        return {
-                            description: 'value must either be "true" or "false"',
-                            context: errorContext,
-                        };
-                    }
-                    return;
-                case Iris_1.IRIS_XSD.integer:
-                case Iris_1.IRIS_XSD.number:
-                case Iris_1.IRIS_XSD.int:
-                case Iris_1.IRIS_XSD.byte:
-                case Iris_1.IRIS_XSD.long:
-                    parsed = Number.parseInt(value.value, 10);
-                    if (Number.isNaN(parsed)) {
-                        return {
-                            description: `value is not a number`,
-                            context: errorContext,
-                        };
-                    }
-                    // ParseInt also parses floats to ints!
-                    if (String(parsed) !== value.value) {
-                        return {
-                            description: `value can not be a float`,
-                            context: errorContext,
-                        };
-                    }
-                    value.term.valueRaw = parsed;
-                    return;
-                case Iris_1.IRIS_XSD.float:
-                case Iris_1.IRIS_XSD.decimal:
-                case Iris_1.IRIS_XSD.double:
-                    parsed = Number.parseFloat(value.value);
-                    if (Number.isNaN(parsed)) {
-                        return {
-                            description: `value is not a number`,
-                            context: errorContext,
-                        };
-                    }
-                    value.term.valueRaw = parsed;
-                    return;
-                case Iris_1.IRIS_RDF.JSON:
-                    try {
-                        parsed = JSON.parse(value.value);
-                        value.term.valueRaw = parsed;
-                    }
-                    catch (error) {
-                        return {
-                            description: `JSON parse exception: ${error.message}`,
-                            context: errorContext,
-                        };
-                    }
-                    return;
+            const result = this.interpretValueAsType(value, type, errorContext, genericsContext);
+            if (result.match) {
+                // Stop processing and return (with a possible IParamValueConflict) if a match was found.
+                return result.value;
             }
         }
         // Allow IRIs to be casted to strings
@@ -359,6 +305,93 @@ class ParameterPropertyHandlerRange {
         }
         return hasTypeConflict || { description: 'unknown parameter type', context: errorContext };
     }
+    /**
+     * Utility function for handling Literals.
+     * If the provided value represents a valid Literal, the `valueRaw` field will be set.
+     */
+    interpretValueAsType(value, type, errorContext, genericsContext) {
+        let parsed;
+        switch (type.value) {
+            case Iris_1.IRIS_XSD.string:
+                return { match: true };
+            case Iris_1.IRIS_XSD.boolean:
+                if (value.value === 'true') {
+                    value.term.valueRaw = true;
+                }
+                else if (value.value === 'false') {
+                    value.term.valueRaw = false;
+                }
+                else {
+                    return {
+                        match: true,
+                        value: {
+                            description: 'value must either be "true" or "false"',
+                            context: errorContext,
+                        },
+                    };
+                }
+                return { match: true };
+            case Iris_1.IRIS_XSD.integer:
+            case Iris_1.IRIS_XSD.number:
+            case Iris_1.IRIS_XSD.int:
+            case Iris_1.IRIS_XSD.byte:
+            case Iris_1.IRIS_XSD.long:
+                parsed = Number.parseInt(value.value, 10);
+                if (Number.isNaN(parsed)) {
+                    return {
+                        match: true,
+                        value: {
+                            description: `value is not a number`,
+                            context: errorContext,
+                        },
+                    };
+                }
+                // ParseInt also parses floats to ints!
+                if (String(parsed) !== value.value) {
+                    return {
+                        match: true,
+                        value: {
+                            description: `value can not be a float`,
+                            context: errorContext,
+                        },
+                    };
+                }
+                value.term.valueRaw = parsed;
+                return { match: true };
+            case Iris_1.IRIS_XSD.float:
+            case Iris_1.IRIS_XSD.decimal:
+            case Iris_1.IRIS_XSD.double:
+                parsed = Number.parseFloat(value.value);
+                if (Number.isNaN(parsed)) {
+                    return {
+                        match: true,
+                        value: {
+                            description: `value is not a number`,
+                            context: errorContext,
+                        },
+                    };
+                }
+                value.term.valueRaw = parsed;
+                return { match: true };
+            case Iris_1.IRIS_RDF.JSON:
+                try {
+                    parsed = JSON.parse(value.value);
+                    value.term.valueRaw = parsed;
+                }
+                catch (error) {
+                    return {
+                        match: true,
+                        value: {
+                            description: `JSON parse exception: ${error.message}`,
+                            context: errorContext,
+                        },
+                    };
+                }
+                return { match: true };
+            default:
+                return { match: false };
+        }
+    }
     static throwIncorrectTypeError(value, parameter, genericsContext, conflict) {
         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

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "componentsjs",
-  "version": "5.0.0",
+  "version": "5.2.0",
   "description": "A semantic dependency injection framework",
   "lsd:contexts": {
-    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^3.0.0/components/context.jsonld": "components/context.jsonld"
+    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld": "components/context.jsonld"
   },
   "main": "index.js",
   "bin": {
@@ -41,17 +41,18 @@
     "minimist": "^1.2.0",
     "rdf-data-factory": "^1.1.0",
     "rdf-object": "^1.13.1",
-    "rdf-parse": "^1.9.1",
+    "rdf-parse": "^2.0.0",
     "rdf-quad": "^1.5.0",
+    "rdf-string": "^1.6.0",
     "rdf-terms": "^1.7.0",
     "semver": "^7.3.2",
     "winston": "^3.3.3"
   },
   "devDependencies": {
     "@rubensworks/eslint-config": "^1.0.1",
+    "@types/jest": "^27.0.0",
     "@typescript-eslint/eslint-plugin": "^5.0.0",
     "@typescript-eslint/parser": "^5.0.0",
-    "@types/jest": "^27.0.0",
     "eslint": "^7.12.1",
     "eslint-config-es": "3.25.3",
     "eslint-import-resolver-typescript": "^2.3.0",