@fgv/ts-utils 5.0.0-22 → 5.0.0-23

package/lib/packlets/logging/logger.js

@@ -0,0 +1,237 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NoOpLogger = exports.ConsoleLogger = exports.InMemoryLogger = exports.LoggerBase = void 0;
+exports.shouldLog = shouldLog;
+/*
+ * Copyright (c) 2020 Erik Fortune
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
+const base_1 = require("../base");
+/**
+ * Compares two log levels.
+ * @param message - The first log level.
+ * @param reporter - The second log level.
+ * @returns `true` if the message should be logged, `false` if it should be suppressed.
+ * @public
+ */
+function shouldLog(message, reporter) {
+    if (reporter === 'all') {
+        return true; // 'all' logs everything, including 'quiet'
+    }
+    if (reporter === 'silent') {
+        return false; // 'silent' suppresses everything
+    }
+    if (message === 'quiet') {
+        return false; // 'quiet' messages only show when reporter is 'all'
+    }
+    switch (reporter) {
+        case 'error':
+            return message === 'error';
+        case 'warning':
+            return message === 'warning' || message === 'error';
+        case 'info':
+            return message !== 'detail';
+    }
+    return true;
+}
+/**
+ * Abstract base class which implements {@link Logging.ILogger | ILogger}.
+ * @public
+ */
+class LoggerBase {
+    constructor(logLevel) {
+        /**
+         * {@inheritDoc Logging.ILogger.logLevel}
+         */
+        this.logLevel = 'info';
+        this.logLevel = logLevel !== null && logLevel !== void 0 ? logLevel : 'info';
+    }
+    /**
+     * {@inheritDoc Logging.ILogger.detail}
+     */
+    detail(message, ...parameters) {
+        return this.log('detail', message, ...parameters);
+    }
+    /**
+     * {@inheritDoc Logging.ILogger.info}
+     */
+    info(message, ...parameters) {
+        return this.log('info', message, ...parameters);
+    }
+    /**
+     * {@inheritDoc Logging.ILogger.warn}
+     */
+    warn(message, ...parameters) {
+        return this.log('warning', message, ...parameters);
+    }
+    /**
+     * {@inheritDoc Logging.ILogger.error}
+     */
+    error(message, ...parameters) {
+        return this.log('error', message, ...parameters);
+    }
+    /**
+     * {@inheritDoc Logging.ILogger.log}
+     */
+    log(level, message, ...parameters) {
+        if (shouldLog(level, this.logLevel)) {
+            const formatted = this._format(message, ...parameters);
+            return this._log(formatted, level);
+        }
+        return this._suppressLog(level, message, ...parameters);
+    }
+    /**
+     * Formats a message and parameters into a string.
+     * @param message - The message to format.
+     * @param parameters - The parameters to format.
+     * @returns The formatted message.
+     * @public
+     */
+    _format(message, ...parameters) {
+        const raw = [message, ...parameters];
+        const filtered = raw.filter((m) => m !== undefined);
+        const strings = filtered.map((m) => m.toString());
+        const joined = strings.join('');
+        return joined;
+    }
+    /**
+     * Inner method called for suppressed log messages.
+     */
+    _suppressLog(__level, __message, ...__parameters) {
+        return (0, base_1.succeed)(undefined);
+    }
+}
+exports.LoggerBase = LoggerBase;
+/**
+ * An in-memory logger that stores logged and suppressed messages.
+ * @public
+ */
+class InMemoryLogger extends LoggerBase {
+    /**
+     * Creates a new in-memory logger.
+     * @param logLevel - The level of logging to be used.
+     */
+    constructor(logLevel) {
+        super(logLevel);
+        /**
+         * The messages that have been logged.
+         */
+        this._logged = [];
+        /**
+         * The messages that have been suppressed.
+         */
+        this._suppressed = [];
+    }
+    /**
+     * The messages that have been logged.
+     */
+    get logged() {
+        return this._logged;
+    }
+    /**
+     * The messages that have been suppressed.
+     */
+    get suppressed() {
+        return this._suppressed;
+    }
+    /**
+     * Clears the logged and suppressed messages.
+     */
+    clear() {
+        this._logged = [];
+        this._suppressed = [];
+    }
+    /**
+     * {@inheritDoc Logging.LoggerBase._log}
+     */
+    _log(message, __level) {
+        this._logged.push(message);
+        return (0, base_1.succeed)(message);
+    }
+    /**
+     * {@inheritDoc Logging.LoggerBase._suppressLog}
+     * @param level - The level of the message.
+     * @param message - The message to suppress.
+     * @param parameters - The parameters to suppress.
+     * @returns `Success` with `undefined` if the message is suppressed.
+     */
+    _suppressLog(level, message, ...parameters) {
+        const formatted = this._format(message, ...parameters);
+        this._suppressed.push(formatted);
+        return (0, base_1.succeed)(undefined);
+    }
+}
+exports.InMemoryLogger = InMemoryLogger;
+/**
+ * A console logger that outputs messages to the console.
+ * @public
+ */
+class ConsoleLogger extends LoggerBase {
+    /**
+     * Creates a new console logger.
+     * @param logLevel - The level of logging to be used.
+     */
+    constructor(logLevel) {
+        super(logLevel);
+    }
+    /**
+     * {@inheritDoc Logging.LoggerBase._log}
+     */
+    _log(message, level) {
+        switch (level) {
+            case 'error':
+                console.error(message);
+                break;
+            case 'warning':
+                console.warn(message);
+                break;
+            case 'info':
+                console.info(message);
+                break;
+            default:
+                console.log(message);
+                break;
+        }
+        return (0, base_1.succeed)(message);
+    }
+}
+exports.ConsoleLogger = ConsoleLogger;
+/**
+ * A no-op {@link Logging.LoggerBase | LoggerBase} that does not log anything.
+ * @public
+ */
+class NoOpLogger extends LoggerBase {
+    /**
+     * Creates a new no-op logger.
+     * @param logLevel - The level of logging to be used.
+     */
+    constructor(logLevel) {
+        super(logLevel);
+    }
+    /**
+     * {@inheritDoc Logging.LoggerBase._log}
+     */
+    _log(message, __level) {
+        // no-op
+        return (0, base_1.succeed)(message);
+    }
+}
+exports.NoOpLogger = NoOpLogger;
+//# sourceMappingURL=logger.js.map

package/lib/test/unit/consoleLogger.test.d.ts

@@ -0,0 +1,2 @@
+import '../helpers/jest';
+//# sourceMappingURL=consoleLogger.test.d.ts.map

package/lib/test/unit/hashingNormalizerCollisions.test.d.ts

@@ -0,0 +1,2 @@
+import '../helpers/jest';
+//# sourceMappingURL=hashingNormalizerCollisions.test.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-utils",
-  "version": "5.0.0-22",
+  "version": "5.0.0-23",
   "description": "Assorted Typescript Utilities",
   "main": "lib/index.js",
   "types": "dist/ts-utils.d.ts",

package/lib/packlets/base/logger.d.ts

@@ -1,52 +0,0 @@
-import { Failure, Success } from './result';
-/**
- * @public
- */
-export type LogLevel = 'detail' | 'info' | 'warning' | 'error' | 'silent';
-/**
- * @public
- */
-export interface Logger {
-    log(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
-    detail(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
-    info(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
-    warn(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
-    warnAndFail<T>(message?: unknown, ...parameters: unknown[]): Failure<T>;
-    error<T>(message?: unknown, ...parameters: unknown[]): Failure<T>;
-}
-/**
- * @public
- */
-export declare abstract class LoggerBase {
-    logLevel: LogLevel;
-    constructor(logLevel?: LogLevel);
-    detail(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
-    info(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
-    warn(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
-    warnAndFail<T>(message?: unknown, ...parameters: unknown[]): Failure<T>;
-    error<T>(message?: unknown, ...parameters: unknown[]): Failure<T>;
-    log(message?: unknown, ...parameters: unknown[]): Success<string | undefined>;
-    protected _format(message?: unknown, ...parameters: unknown[]): string;
-    protected _innerSilent(__message: string): Success<string | undefined>;
-    protected abstract _innerLog(message: string): Success<string | undefined>;
-}
-/**
- * @public
- */
-export declare class InMemoryLogger extends LoggerBase {
-    protected _messages: string[];
-    protected _silent: string[];
-    constructor(logLevel?: LogLevel);
-    get messages(): string[];
-    get silent(): string[];
-    clear(): void;
-    protected _innerLog(message: string): Success<string | undefined>;
-    protected _innerSilent(message: string): Success<string | undefined>;
-}
-/**
- * @public
- */
-export declare class NoOpLogger extends LoggerBase {
-    protected _innerLog(message: string): Success<string | undefined>;
-}
-//# sourceMappingURL=logger.d.ts.map

package/lib/packlets/base/logger.js

@@ -1,128 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NoOpLogger = exports.InMemoryLogger = exports.LoggerBase = void 0;
-/*
- * Copyright (c) 2020 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-const result_1 = require("./result");
-/**
- * @public
- */
-class LoggerBase {
-    constructor(logLevel) {
-        this.logLevel = 'info';
-        this.logLevel = logLevel !== null && logLevel !== void 0 ? logLevel : 'info';
-    }
-    detail(message, ...parameters) {
-        if (this.logLevel === 'detail') {
-            return this.log(message, parameters);
-        }
-        return (0, result_1.succeed)(undefined);
-    }
-    info(message, ...parameters) {
-        if (this.logLevel === 'detail' || this.logLevel === 'info') {
-            return this.log(message, parameters);
-        }
-        return (0, result_1.succeed)(undefined);
-    }
-    warn(message, ...parameters) {
-        if (this.logLevel !== 'error' && this.logLevel !== 'silent') {
-            return this.log(message, parameters);
-        }
-        return (0, result_1.succeed)(undefined);
-    }
-    warnAndFail(message, ...parameters) {
-        var _a;
-        const formatted = this._format(message, ...parameters);
-        if (this.logLevel !== 'error' && this.logLevel !== 'silent') {
-            const result = this.log(formatted);
-            return (0, result_1.fail)((_a = result.value) !== null && _a !== void 0 ? _a : formatted);
-        }
-        return (0, result_1.fail)(formatted);
-    }
-    error(message, ...parameters) {
-        var _a;
-        const formatted = this._format(message, ...parameters);
-        if (this.logLevel !== 'silent') {
-            const result = this.log(formatted);
-            return (0, result_1.fail)((_a = result.value) !== null && _a !== void 0 ? _a : formatted);
-        }
-        return (0, result_1.fail)(formatted);
-    }
-    log(message, ...parameters) {
-        const messageString = this._format(message, ...parameters);
-        if (this.logLevel === 'silent') {
-            return this._innerSilent(messageString);
-        }
-        return this._innerLog(messageString);
-    }
-    _format(message, ...parameters) {
-        const raw = [message, ...parameters];
-        const filtered = raw.filter((m) => m !== undefined);
-        const strings = filtered.map((m) => m.toString());
-        const joined = strings.join('');
-        return joined;
-    }
-    _innerSilent(__message) {
-        return (0, result_1.succeed)(undefined);
-    }
-}
-exports.LoggerBase = LoggerBase;
-/**
- * @public
- */
-class InMemoryLogger extends LoggerBase {
-    constructor(logLevel) {
-        super(logLevel);
-        this._messages = [];
-        this._silent = [];
-    }
-    get messages() {
-        return this._messages;
-    }
-    get silent() {
-        return this._silent;
-    }
-    clear() {
-        this._messages = [];
-        this._silent = [];
-    }
-    _innerLog(message) {
-        this._messages.push(message);
-        return (0, result_1.succeed)(message);
-    }
-    _innerSilent(message) {
-        this._silent.push(message);
-        return (0, result_1.succeed)(undefined);
-    }
-}
-exports.InMemoryLogger = InMemoryLogger;
-/**
- * @public
- */
-class NoOpLogger extends LoggerBase {
-    _innerLog(message) {
-        // no-op
-        return (0, result_1.succeed)(message);
-    }
-}
-exports.NoOpLogger = NoOpLogger;
-//# sourceMappingURL=logger.js.map

package/src/index.ts

@@ -1,63 +0,0 @@
-/*
- * Copyright (c) 2020 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import * as Collections from './packlets/collections';
-import * as Conversion from './packlets/conversion';
-import * as Hash from './packlets/hash';
-import * as FileTree from './packlets/file-tree';
-import * as Validation from './packlets/validation';
-
-import {
-  Collector,
-  ICollectible,
-  ConvertingCollector,
-  IReadOnlyResultMap,
-  ResultMap,
-  ValidatingCollector,
-  ValidatingConvertingCollector,
-  ValidatingResultMap
-} from './packlets/collections';
-import { Converter, Converters, ObjectConverter, StringConverter } from './packlets/conversion';
-import { Validator, Validators } from './packlets/validation';
-
-export * from './packlets/base';
-export {
-  Collections,
-  Collector,
-  ConvertingCollector,
-  Conversion,
-  Converter,
-  Converters,
-  FileTree,
-  Hash,
-  ICollectible,
-  IReadOnlyResultMap,
-  ObjectConverter,
-  ResultMap,
-  StringConverter,
-  ValidatingCollector,
-  ValidatingConvertingCollector,
-  ValidatingResultMap,
-  Validation,
-  Validator,
-  Validators
-};

package/src/packlets/base/brand.ts

@@ -1,28 +0,0 @@
-/*
- * Copyright (c) 2021 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-/**
- * Helper type to brand a simple type to prevent inappropriate use
- * @public
- */
-// eslint-disable-next-line @typescript-eslint/naming-convention
-export type Brand<T, B> = T & { __brand: B };

package/src/packlets/base/index.ts

@@ -1,31 +0,0 @@
-/*
- * Copyright (c) 2020 Erik Fortune
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import * as Logging from './logger';
-
-export * from './brand';
-export * from './mapResults';
-export * from './messageAggregator';
-export { Normalizer } from './normalize';
-export * from './result';
-export * from './utils';
-export { Logging };