@oliversalzburg/js-utils 0.0.22-dev.3 → 0.0.22-dev.5

package/{array.d.ts → data/array.d.ts}

@@ -1,4 +1,4 @@
-import { ConstructorOf } from "./core.js";
+import { ConstructorOf } from "../core.js";
 /**
  * Places the items in the array in random order.
  * @param array - The array to shuffle.

package/{array.js → data/array.js}

@@ -1,4 +1,4 @@
-import { is } from "./nil.js";
+import { is } from "../nil.js";
 /**
  * Places the items in the array in random order.
  * @param array - The array to shuffle.

package/data/array.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"array.js","sourceRoot":"","sources":["../../source/data/array.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,WAAW,CAAC;AAE/B;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAY,KAAuB,EAAE,EAAE;IACjE,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,EAAE,EAAE;QACrD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;QAC5D,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1B,KAAK,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;QAClC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;KAC3B;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAY,CAAmB,EAAE,CAAmB,EAAE,EAAE;IAC/E,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAY,CAAmB,EAAE,CAAmB,EAAE,EAAE;IAChF,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,KAAqB,EACrB,YAAsC,EACtC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC,CAAqB,CAAC"}

package/data/index.d.ts

@@ -1 +1,2 @@
+export * from "./array.js";
 export * from "./tree.js";

package/data/index.js

@@ -1,2 +1,3 @@
+export * from "./array.js";
 export * from "./tree.js";
 //# sourceMappingURL=index.js.map

package/data/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/data/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/data/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}

package/index.d.ts

@@ -1,4 +1,3 @@
-export * from "./array.js";
 export * from "./async.js";
 export * from "./core.js";
 export * from "./data/index.js";
@@ -6,6 +5,7 @@ export * from "./dom/index.js";
 export * from "./error-serializer.js";
 export * from "./errors/index.js";
 export * from "./graphics/index.js";
+export * from "./log/index.js";
 export * from "./math/index.js";
 export * from "./nil.js";
 export * from "./random.js";

package/index.js

@@ -1,4 +1,3 @@
-export * from "./array.js";
 export * from "./async.js";
 export * from "./core.js";
 export * from "./data/index.js";
@@ -6,6 +5,7 @@ export * from "./dom/index.js";
 export * from "./error-serializer.js";
 export * from "./errors/index.js";
 export * from "./graphics/index.js";
+export * from "./log/index.js";
 export * from "./math/index.js";
 export * from "./nil.js";
 export * from "./random.js";

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../source/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../source/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,uBAAuB,CAAC;AACtC,cAAc,aAAa,CAAC"}

package/log/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./log.js";
+export * from "./report.js";

package/log/index.js

@@ -0,0 +1,3 @@
+export * from "./log.js";
+export * from "./report.js";
+//# sourceMappingURL=index.js.map

package/log/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/log/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC"}

package/log/log.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Describes the most simple logger.
+ * @group Logging
+ */
+export interface BareLogger {
+    /**
+     * Logs a message.
+     * @param message - The message to log.
+     * @param args - Additional arguments to log.
+     */
+    log(message: string, ...args: Array<unknown>): void;
+}

package/log/log.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=log.js.map

package/log/log.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"log.js","sourceRoot":"","sources":["../../source/log/log.ts"],"names":[],"mappings":""}

package/log/report.d.ts

@@ -0,0 +1,53 @@
+import { TreeNode } from "../data/tree.js";
+import { BareLogger } from "./log.js";
+/**
+ * An entry of a {@linkcode Report}.
+ * @group Logging
+ */
+export interface ReportEntry {
+    /**
+     * The message in the entry.
+     */
+    message: string;
+    /**
+     * An optional key-value hash, that might have been
+     * provided with the entry.
+     */
+    context: Record<string, unknown> | undefined;
+}
+/**
+ * A hierarchical background report/log.
+ * @group Logging
+ */
+export declare class Report extends TreeNode<Report> {
+    #private;
+    /**
+     * The ID of this report.
+     */
+    readonly origin: string;
+    /**
+     * Retrieve the message store.
+     * @returns The message store.
+     */
+    get store(): Map<string, Array<ReportEntry>>;
+    /**
+     * Constructs a new report.
+     * @param origin - The ID of this report.
+     * @param parent - The paren report for this report.
+     * @throws {@linkcode InvalidOperationError} When the origin was already
+     * used by another report in this hierarchy.
+     */
+    constructor(origin: string, parent?: Report | undefined);
+    /**
+     * Put an entry into the report.
+     * @param message - The message to add.
+     * @param context - An arbitrary key-value object to store with the message.
+     */
+    log(message: string, context?: Record<string, unknown>): void;
+    /**
+     * Prints the contents of the report.
+     * @param logger - A logger to use to print the report.
+     * @param depth - How deep to indent this part of the report.
+     */
+    aggregate(logger: BareLogger, depth?: number): void;
+}

package/log/report.js

@@ -0,0 +1,84 @@
+import { TreeNode } from "../data/tree.js";
+import { InvalidOperationError } from "../errors/InvalidOperationError.js";
+import { indent } from "../string.js";
+/**
+ * A hierarchical background report/log.
+ * @group Logging
+ */
+// eslint-disable-next-line no-use-before-define
+export class Report extends TreeNode {
+    /**
+     * The ID of this report.
+     */
+    origin;
+    /**
+     * Our storage for all logged messages.
+     */
+    #store = new Map();
+    /**
+     * Retrieve the message store.
+     * @returns The message store.
+     */
+    get store() {
+        return this.parent?.store ?? this.#store;
+    }
+    /**
+     * Constructs a new report.
+     * @param origin - The ID of this report.
+     * @param parent - The paren report for this report.
+     * @throws {@linkcode InvalidOperationError} When the origin was already
+     * used by another report in this hierarchy.
+     */
+    constructor(origin, parent) {
+        super(parent);
+        if (this.store.has(origin)) {
+            throw new InvalidOperationError(`The origin '${origin}' was already used in this report.`);
+        }
+        this.origin = origin;
+    }
+    /**
+     * Retrieves an entry of the store for the given origin.
+     * @param origin - The origin of the entry.
+     * @returns The store entry with that origin.
+     */
+    #getStoreEntry(origin) {
+        if (!this.#store.has(origin)) {
+            this.#store.set(origin, new Array());
+        }
+        return this.#store.get(origin);
+    }
+    /**
+     * Put an entry into the report.
+     * @param message - The message to add.
+     * @param context - An arbitrary key-value object to store with the message.
+     */
+    log(message, context) {
+        this.#getStoreEntry(this.origin)?.push({ message, context });
+    }
+    /**
+     * Prints the contents of the report.
+     * @param logger - A logger to use to print the report.
+     * @param depth - How deep to indent this part of the report.
+     */
+    aggregate(logger, depth = 0) {
+        for (const [origin, records] of this.#store.entries()) {
+            if (origin !== this.origin) {
+                continue;
+            }
+            logger.log(indent(`${origin}`, depth));
+            for (const entry of records) {
+                logger.log(indent(` - ${entry.message}`, depth));
+                if (entry.context) {
+                    logger.log(indent(JSON.stringify(entry.context, undefined, depth + 4), depth));
+                }
+            }
+        }
+        if (this.children.size === 0) {
+            return;
+        }
+        for (const child of this.children) {
+            child.aggregate(logger, depth + 1);
+        }
+    }
+}
+//# sourceMappingURL=report.js.map

package/log/report.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"report.js","sourceRoot":"","sources":["../../source/log/report.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAC3E,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAoBtC;;;GAGG;AACH,gDAAgD;AAChD,MAAM,OAAO,MAAO,SAAQ,QAAgB;IAC1C;;OAEG;IACM,MAAM,CAAS;IACxB;;OAEG;IACH,MAAM,GAAG,IAAI,GAAG,EAA8B,CAAC;IAE/C;;;OAGG;IACH,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,EAAE,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC;IAC3C,CAAC;IAED;;;;;;OAMG;IACH,YAAY,MAAc,EAAE,MAA2B;QACrD,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC1B,MAAM,IAAI,qBAAqB,CAAC,eAAe,MAAM,oCAAoC,CAAC,CAAC;SAC5F;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,MAAc;QAC3B,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC5B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,KAAK,EAAe,CAAC,CAAC;SACnD;QACD,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAED;;;;OAIG;IACH,GAAG,CAAC,OAAe,EAAE,OAAiC;QACpD,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/D,CAAC;IAED;;;;OAIG;IACH,SAAS,CAAC,MAAkB,EAAE,KAAK,GAAG,CAAC;QACrC,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,EAAE;YACrD,IAAI,MAAM,KAAK,IAAI,CAAC,MAAM,EAAE;gBAC1B,SAAS;aACV;YAED,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,GAAG,MAAM,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;YACvC,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE;gBAC3B,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,OAAO,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;gBACjD,IAAI,KAAK,CAAC,OAAO,EAAE;oBACjB,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE,SAAS,EAAE,KAAK,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;iBAChF;aACF;SACF;QAED,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,KAAK,CAAC,EAAE;YAC5B,OAAO;SACR;QAED,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,EAAE;YACjC,KAAK,CAAC,SAAS,CAAC,MAAM,EAAE,KAAK,GAAG,CAAC,CAAC,CAAC;SACpC;IACH,CAAC;CACF"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "https://json.schemastore.org/package.json",
   "name": "@oliversalzburg/js-utils",
-  "version": "0.0.22-dev.3",
+  "version": "0.0.22-dev.5",
   "license": "MIT",
   "author": "Oliver Salzburg <oliver.salzburg@gmail.com>",
   "repository": {

package/array.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"array.js","sourceRoot":"","sources":["../source/array.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,EAAE,EAAE,MAAM,UAAU,CAAC;AAE9B;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAY,KAAuB,EAAE,EAAE;IACjE,KAAK,IAAI,KAAK,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,GAAG,CAAC,EAAE,KAAK,EAAE,EAAE;QACrD,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC;QAC5D,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;QAC1B,KAAK,CAAC,KAAK,CAAC,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC;QAClC,KAAK,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC;KAC3B;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF;;;;;;;;;GASG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CAAY,CAAmB,EAAE,CAAmB,EAAE,EAAE;IAC/E,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CAAY,CAAmB,EAAE,CAAmB,EAAE,EAAE;IAChF,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,KAAqB,EACrB,YAAsC,EACtC,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC,CAAqB,CAAC"}