componentsjs 5.0.0-beta.1 → 5.0.0-beta.5

package/lib/util/ErrorResourcesContext.d.ts

@@ -1,19 +1,16 @@
-import type { Resource } from 'rdf-object';
+import { Resource } from 'rdf-object';
+import type { IParamValueConflict } from '../preprocess/parameterproperty/ParameterPropertyHandlerRange';
 /**
  * An error that can include a context containing resources for display.
  */
 export declare class ErrorResourcesContext extends Error {
-    readonly context: Record<string, Resource | Resource[] | string>;
-    constructor(message: string, context: Record<string, Resource | Resource[] | string>);
-    static contextToString(context: Record<string, Resource | Resource[] | string>): string;
-    /**
-     * Convert the given resource to a compact string.
-     * Mainly used for error reporting.
-     *
-     * Note that this will remove certain fields from the resource,
-     * so only use this when throwing an error that will stop the process.
-     *
-     * @param resource A resource.
-     */
-    static resourceToString(resource: Resource): string;
+    readonly context: IErrorContext;
+    constructor(message: string, context: IErrorContext);
+    exportContext(): any;
+    static contextToJson(context: IErrorContext): any;
+    static resourceToJson(resource: Resource | undefined): any;
+    static conflictToJson(conflict: IParamValueConflict): any;
+}
+export interface IErrorContext {
+    [key: string]: Resource | Resource[] | string | undefined | IErrorContext | IParamValueConflict;
 }

package/lib/util/ErrorResourcesContext.js

@@ -1,37 +1,59 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ErrorResourcesContext = void 0;
-const NodeUtil = require("util");
+const rdf_object_1 = require("rdf-object");
 /**
  * An error that can include a context containing resources for display.
  */
 class ErrorResourcesContext extends Error {
     constructor(message, context) {
-        super(`${message}\n${ErrorResourcesContext.contextToString(context)}`);
+        super(message);
         this.name = 'ErrorResourcesContext';
         this.context = context;
     }
-    static contextToString(context) {
-        return Object.entries(context)
-            .map(([key, value]) => `${key}: ${typeof value === 'string' ?
-            value :
-            // eslint-disable-next-line @typescript-eslint/no-extra-parens
-            (Array.isArray(value) ?
-                value.map(valueSub => ErrorResourcesContext.resourceToString(valueSub)) :
-                ErrorResourcesContext.resourceToString(value))}`)
-            .join('\n');
+    exportContext() {
+        return ErrorResourcesContext.contextToJson(this.context);
     }
-    /**
-     * Convert the given resource to a compact string.
-     * Mainly used for error reporting.
-     *
-     * Note that this will remove certain fields from the resource,
-     * so only use this when throwing an error that will stop the process.
-     *
-     * @param resource A resource.
-     */
-    static resourceToString(resource) {
-        return NodeUtil.inspect(Object.assign({ term: resource.term, properties: resource.properties }, resource.list ? { list: resource.list } : {}), { colors: true, depth: 2 });
+    static contextToJson(context) {
+        return Object.fromEntries(Object.entries(context)
+            .map(([key, value]) => {
+            let mapped;
+            if (typeof value === 'string') {
+                mapped = value;
+            }
+            else if (Array.isArray(value)) {
+                mapped = value.map(valueSub => ErrorResourcesContext.resourceToJson(valueSub));
+            }
+            else if (value instanceof rdf_object_1.Resource || value === undefined) {
+                mapped = ErrorResourcesContext.resourceToJson(value);
+            }
+            else if ('description' in value) {
+                mapped = ErrorResourcesContext.conflictToJson(value);
+            }
+            else {
+                mapped = ErrorResourcesContext.contextToJson(value);
+            }
+            return [key, mapped];
+        }));
+    }
+    static resourceToJson(resource) {
+        if (resource) {
+            return resource.toJSON(1);
+        }
+    }
+    static conflictToJson(conflict) {
+        const data = { description: conflict.description };
+        if (conflict.causes) {
+            data.causes = [];
+            // Only pick the first 2 conflicts for visualization
+            for (const subConflict of conflict.causes.slice(0, 1)) {
+                data.causes.push(ErrorResourcesContext.conflictToJson(subConflict));
+            }
+        }
+        else {
+            data.context = ErrorResourcesContext.contextToJson(conflict.context);
+        }
+        return data;
     }
 }
 exports.ErrorResourcesContext = ErrorResourcesContext;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "componentsjs",
-  "version": "5.0.0-beta.1",
+  "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"
@@ -40,7 +40,7 @@
     "jsonld-context-parser": "^2.1.1",
     "minimist": "^1.2.0",
     "rdf-data-factory": "^1.1.0",
-    "rdf-object": "^1.12.0",
+    "rdf-object": "^1.13.0",
     "rdf-parse": "^1.9.1",
     "rdf-quad": "^1.5.0",
     "rdf-terms": "^1.7.0",