componentsjs 5.0.0-beta.7 → 5.1.0

package/CHANGELOG.md

@@ -1,6 +1,25 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+<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
+
+### Changed
+* [Bump context URL to 5.0.0](https://github.com/LinkedSoftwareDependencies/Components.js/commit/495654fa70f559aaaa86a0960686fd1ca23f9546)
+* [Add incorrect version number as possible cause for remote lookup failure (#67)](https://github.com/LinkedSoftwareDependencies/Components.js/commit/adf1d7e092b95a2fc47c7d2da3dfe191fdb741aa)
+
 <a name="v5.0.0-beta.7"></a>
 ## [v5.0.0-beta.7](https://github.com/LinkedSoftwareDependencies/Components.js/compare/v5.0.0-beta.6...v5.0.0-beta.7) - 2022-02-21
 

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/rdf/PrefetchedDocumentLoader.js

@@ -17,8 +17,9 @@ class PrefetchedDocumentLoader extends jsonld_context_parser_1.FetchDocumentLoad
     async load(url) {
         // Warn on deprecated context usage
         if (this.logger &&
-            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 '^4.0.0' instead.`);
+            (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) {
@@ -26,19 +27,20 @@ class PrefetchedDocumentLoader extends jsonld_context_parser_1.FetchDocumentLoad
         }
         // Warn before doing a remote context lookup
         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, or an invalid context URL.`);
+            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.`);
         }
         return super.load(url);
     }
 }
 exports.PrefetchedDocumentLoader = PrefetchedDocumentLoader;
-PrefetchedDocumentLoader.CONTEXT_URL = 'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^4.0.0/components/context.jsonld';
+PrefetchedDocumentLoader.CONTEXT_URL = 'https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^5.0.0/components/context.jsonld';
 // eslint-disable-next-line no-sync
 PrefetchedDocumentLoader.DEFAULT_CONTEXT = JSON.parse(fs
     .readFileSync(`${__dirname}/../../components/context.jsonld`, 'utf8'));
 PrefetchedDocumentLoader.DEFAULT_CONTEXTS = {
     [PrefetchedDocumentLoader.CONTEXT_URL]: PrefetchedDocumentLoader.DEFAULT_CONTEXT,
-    // TODO: temporarily also set old context version for backwards-compatible.
+    // 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,
 };
 //# sourceMappingURL=PrefetchedDocumentLoader.js.map

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "componentsjs",
-  "version": "5.0.0-beta.7",
+  "version": "5.1.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,24 +41,25 @@
     "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",
-    "@typescript-eslint/eslint-plugin": "^4.6.1",
-    "@typescript-eslint/parser": "^4.6.1",
     "@types/jest": "^27.0.0",
+    "@typescript-eslint/eslint-plugin": "^5.0.0",
+    "@typescript-eslint/parser": "^5.0.0",
     "eslint": "^7.12.1",
     "eslint-config-es": "3.25.3",
     "eslint-import-resolver-typescript": "^2.3.0",
     "eslint-plugin-import": "^2.22.1",
-    "eslint-plugin-jest": "^24.1.0",
+    "eslint-plugin-jest": "^26.0.0",
     "eslint-plugin-tsdoc": "^0.2.7",
-    "eslint-plugin-unused-imports": "^1.0.0",
+    "eslint-plugin-unused-imports": "^2.0.0",
     "jest": "^27.0.1",
     "jest-rdf": "^1.7.0",
     "jshint": "^2.1.10",