componentsjs 5.0.0-beta.4 → 5.0.0-beta.5

package/CHANGELOG.md

@@ -1,6 +1,18 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+<a name="v5.0.0-beta.5"></a>
+## [v5.0.0-beta.5](https://github.com/LinkedSoftwareDependencies/Components.js/compare/v5.0.0-beta.4...v5.0.0-beta.5) - 2022-02-08
+
+### Added
+* [Allow type-checking to be disabled via typeChecking](https://github.com/LinkedSoftwareDependencies/Components.js/commit/a55331085e4c5621832e6b23bc52b00068e8256a)
+
+### Changed
+* [Throw error on circular dependencies, Closes #53](https://github.com/LinkedSoftwareDependencies/Components.js/commit/e7a28d1cf87d96d5b58bb6d1f19ce41d6e55aab6)
+
+### Fixed
+* [Fix seeAlso links not handling encoded URI components, Closes #43](https://github.com/LinkedSoftwareDependencies/Components.js/commit/2b72914d2720b2982d4570af55f9b5d7dc196c27)
+
 <a name="v5.0.0-beta.4"></a>
 ## [v5.0.0-beta.4](https://github.com/LinkedSoftwareDependencies/Components.js/compare/v5.0.0-beta.3...v5.0.0-beta.4) - 2022-01-29
 

package/README.md

@@ -202,6 +202,41 @@ const myInstance = await manager.instantiate('http://example.org/myInstance');
 [RDF]: https://www.w3.org/RDF/
 [JSON-LD]: https://json-ld.org/
 
+## Advanced usage
+
+The `ComponentsManager` can be customized with the following options:
+
+```javascript
+const manager = await ComponentsManager.build({
+    // Absolute path to the package root from which module resolution should start.
+    mainModulePath: __dirname,
+    // Callback for registering components and modules
+    // Defaults to an invocation of {@link ComponentRegistry.registerAvailableModules}.
+    moduleLoader: (registry) => {},
+    // Callback for registering configurations.
+    // Defaults to no config registrations.
+    configLoader: (registry) => {},
+    // A strategy for constructing instances.
+    // Defaults to {@link ConstructionStrategyCommonJs}.
+    constructionStrategy: new ConstructionStrategyCommonJs(),
+    // If the error state should be dumped into `componentsjs-error-state.json` after failed instantiations.
+    // Defaults to `true`.
+    dumpErrorState: true,
+    // The logging level.
+    // Defaults to `'warn'`.
+    logLevel: 'warn',
+    // The module state.
+    // Defaults to a newly created instance on the {@link mainModulePath}.
+    moduleState: {},
+    // If JSON-LD context validation should be skipped.
+    // Defaults to `true`.
+    skipContextValidation: true,
+    // If values for parameters should be type-checked.
+    // Defaults to `true`.
+    typeChecking: true,
+});
+```
+
 ## Cite
 
 If you are using or extending Components.js as part of a scientific publication,

package/lib/construction/ConfigConstructorPool.js

@@ -28,7 +28,7 @@ class ConfigConstructorPool {
         // if so, return a dummy value, to avoid infinite recursion.
         const resourceBlacklist = settings.resourceBlacklist || {};
         if (resourceBlacklist[configResource.value]) {
-            return Promise.resolve(this.constructionStrategy.createUndefined());
+            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
         if (configResource.isA('Variable')) {

package/lib/loading/ComponentsManagerBuilder.d.ts

@@ -18,6 +18,7 @@ export declare class ComponentsManagerBuilder<Instance = any> {
     private readonly logger;
     private readonly moduleState?;
     private readonly skipContextValidation;
+    private readonly typeChecking;
     constructor(options: IComponentsManagerBuilderOptions<Instance>);
     static createLogger(logLevel?: LogLevel): Logger;
     static createObjectLoader(): RdfObjectLoader;
@@ -69,4 +70,9 @@ export interface IComponentsManagerBuilderOptions<Instance> {
      * Defaults to `true`.
      */
     skipContextValidation?: boolean;
+    /**
+     * If values for parameters should be type-checked.
+     * Defaults to `true`.
+     */
+    typeChecking?: boolean;
 }

package/lib/loading/ComponentsManagerBuilder.js

@@ -31,6 +31,9 @@ class ComponentsManagerBuilder {
         this.skipContextValidation = options.skipContextValidation === undefined ?
             true :
             Boolean(options.skipContextValidation);
+        this.typeChecking = options.typeChecking === undefined ?
+            true :
+            Boolean(options.typeChecking);
     }
     static createLogger(logLevel = 'warn') {
         return (0, winston_1.createLogger)({
@@ -92,7 +95,7 @@ class ComponentsManagerBuilder {
         this.logger.info(`Loaded configs`);
         // Build constructor pool
         const runTypeConfigs = {};
-        const parameterHandler = new ParameterHandler_1.ParameterHandler({ objectLoader });
+        const parameterHandler = new ParameterHandler_1.ParameterHandler({ objectLoader, typeChecking: this.typeChecking });
         const configConstructorPool = new ConfigConstructorPool_1.ConfigConstructorPool({
             objectLoader,
             configPreprocessors: [

package/lib/preprocess/ParameterHandler.d.ts

@@ -21,4 +21,5 @@ export declare class ParameterHandler {
 }
 export interface IParameterHandlerOptions {
     objectLoader: RdfObjectLoader;
+    typeChecking: boolean;
 }

package/lib/preprocess/ParameterHandler.js

@@ -17,7 +17,7 @@ class ParameterHandler {
             new ParameterPropertyHandlerDefaultScoped_1.ParameterPropertyHandlerDefaultScoped(this.objectLoader),
             new ParameterPropertyHandlerDefault_1.ParameterPropertyHandlerDefault(this.objectLoader),
             new ParameterPropertyHandlerFixed_1.ParameterPropertyHandlerFixed(this.objectLoader),
-            this.parameterPropertyHandlerRange = new ParameterPropertyHandlerRange_1.ParameterPropertyHandlerRange(this.objectLoader),
+            this.parameterPropertyHandlerRange = new ParameterPropertyHandlerRange_1.ParameterPropertyHandlerRange(this.objectLoader, options.typeChecking),
             new ParameterPropertyHandlerLazy_1.ParameterPropertyHandlerLazy(),
         ];
     }

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

@@ -7,7 +7,8 @@ import type { IParameterPropertyHandler } from './IParameterPropertyHandler';
  */
 export declare class ParameterPropertyHandlerRange implements IParameterPropertyHandler {
     private readonly objectLoader;
-    constructor(objectLoader: RdfObjectLoader);
+    private readonly typeChecking;
+    constructor(objectLoader: RdfObjectLoader, typeChecking: boolean);
     canHandle(value: Resource | undefined, configRoot: Resource, parameter: Resource): boolean;
     handle(value: Resource | undefined, configRoot: Resource, parameter: Resource, configElement: Resource, genericsContext: GenericsContext): Resource | undefined;
     /**

package/lib/preprocess/parameterproperty/ParameterPropertyHandlerRange.js

@@ -8,8 +8,9 @@ const GenericsContext_1 = require("../GenericsContext");
  * If a param range is defined, apply the type and validate the range.
  */
 class ParameterPropertyHandlerRange {
-    constructor(objectLoader) {
+    constructor(objectLoader, typeChecking) {
         this.objectLoader = objectLoader;
+        this.typeChecking = typeChecking;
     }
     canHandle(value, configRoot, parameter) {
         return Boolean(parameter.property.range);
@@ -30,7 +31,7 @@ class ParameterPropertyHandlerRange {
     captureType(value, param, genericsContext) {
         const errorContext = { param };
         const conflict = this.hasValueType(value, param.property.range, errorContext, genericsContext);
-        if (!conflict) {
+        if (!conflict || !this.typeChecking) {
             return value;
         }
         ParameterPropertyHandlerRange.throwIncorrectTypeError(value, param, genericsContext, conflict);

package/lib/rdf/Iris.d.ts

@@ -18,7 +18,7 @@ export declare const IRIS_RDF: {
 };
 export declare const PREFIX_RDFS: (suffix: string) => string;
 export declare const IRIS_RDFS: {
-    imports: string;
+    seeAlso: string;
 };
 export declare const PREFIX_XSD: (suffix: string) => string;
 export declare const IRIS_XSD: {

package/lib/rdf/Iris.js

@@ -22,7 +22,7 @@ exports.IRIS_RDF = {
 };
 exports.PREFIX_RDFS = definePrefix('http://www.w3.org/2000/01/rdf-schema#');
 exports.IRIS_RDFS = {
-    imports: (0, exports.PREFIX_RDFS)('seeAlso'),
+    seeAlso: (0, exports.PREFIX_RDFS)('seeAlso'),
 };
 exports.PREFIX_XSD = definePrefix('http://www.w3.org/2001/XMLSchema#');
 exports.IRIS_XSD = {

package/lib/rdf/RdfStreamIncluder.js

@@ -36,9 +36,9 @@ class RdfStreamIncluder extends stream_1.Transform {
      * @param quad A quad.
      */
     handleImports(quad) {
-        if (!this.parserOptions.ignoreImports && quad.predicate.value === Iris_1.IRIS_RDFS.imports) {
+        if (!this.parserOptions.ignoreImports && quad.predicate.value === Iris_1.IRIS_RDFS.seeAlso) {
             this.runningImporters++;
-            let relativeFilePath = quad.object.value;
+            let relativeFilePath = decodeURI(quad.object.value);
             // Try overriding path using defined import paths
             if (this.parserOptions.importPaths) {
                 for (const prefix of Object.keys(this.parserOptions.importPaths)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "componentsjs",
-  "version": "5.0.0-beta.4",
+  "version": "5.0.0-beta.5",
   "description": "A semantic dependency injection framework",
   "lsd:contexts": {
     "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^3.0.0/components/context.jsonld": "components/context.jsonld"