@fgv/ts-utils 5.0.0-2 → 5.0.0-20

package/lib/test/unit/file-tree/fileItem.test.d.ts

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

package/lib/test/unit/file-tree/fileTree.test.d.ts

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

package/lib/test/unit/file-tree/fsTree.test.d.ts

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

package/lib/test/unit/file-tree/inMemoryTree.test.d.ts

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

package/lib/test/unit/file-tree/sample/rootFile.json

@@ -0,0 +1 @@
+{ "myNameIs": "root" }

package/lib/test/unit/file-tree/sample/some/other/path/file2.json

@@ -0,0 +1 @@
+{ "helloMyNameIs": "file2" }

package/lib/test/unit/file-tree/sample/some/path/below/file4.json

@@ -0,0 +1 @@
+{ "helloMyNameIs": "file4" }

package/lib/test/unit/file-tree/sample/some/path/file1.json

@@ -0,0 +1 @@
+{ "helloMyNameIs": "file1" }

package/lib/test/unit/file-tree/sample/some/path/file3.json

@@ -0,0 +1 @@
+{ "helloMyNameIs": "file3" }

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

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

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

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

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

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

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

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

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

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

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

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

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

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

package/lib/test/unit/validation/array.test.d.ts

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

package/lib/test/unit/validation/boolean.test.d.ts

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

package/lib/test/unit/validation/genericValidator.test.d.ts

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

package/lib/test/unit/validation/number.test.d.ts

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

package/lib/test/unit/validation/object.test.d.ts

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

package/lib/test/unit/validation/oneOf.test.d.ts

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

package/lib/test/unit/validation/recordOf.test.d.ts

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

package/lib/test/unit/validation/recursiveValidation.test.d.ts

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

package/lib/test/unit/validation/string.test.d.ts

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

package/lib/test/unit/validation/traits.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=traits.test.d.ts.map

package/lib/test/unit/validation/typeGuard.test.d.ts

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

package/lib/test/unit/validation/validators.test.d.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-utils",
-  "version": "5.0.0-2",
+  "version": "5.0.0-20",
   "description": "Assorted Typescript Utilities",
   "main": "lib/index.js",
   "types": "dist/ts-utils.d.ts",
@@ -17,10 +17,10 @@
   "homepage": "https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils#readme",
   "devDependencies": {
     "@jest/expect-utils": "^29.7.0",
-    "@microsoft/api-documenter": "^7.26.29",
-    "@microsoft/api-extractor": "^7.49.1",
+    "@microsoft/api-documenter": "^7.26.31",
+    "@microsoft/api-extractor": "^7.52.10",
     "@types/jest": "^29.5.14",
-    "@types/luxon": "^3.6.2",
+    "@types/luxon": "^3.7.1",
     "@types/mustache": "^4.2.5",
     "@types/node": "^20.14.9",
     "@typescript-eslint/eslint-plugin": "^7.14.1",
@@ -33,16 +33,16 @@
     "jest-extended": "^4.0.2",
     "jest-matcher-utils": "^29.7.0",
     "rimraf": "^5.0.7",
-    "ts-jest": "^29.4.0",
+    "ts-jest": "^29.4.1",
     "ts-node": "^10.9.2",
-    "typescript": "^5.7.3",
+    "typescript": "^5.8.3",
     "eslint-plugin-n": "^16.6.2",
     "jest-snapshot": "~29.7.0",
-    "@rushstack/heft": "~0.74.0",
-    "@rushstack/heft-node-rig": "~2.9.0",
+    "@rushstack/heft": "~0.74.2",
+    "@rushstack/heft-node-rig": "~2.9.3",
     "@rushstack/eslint-config": "~4.4.0",
     "@types/heft-jest": "1.0.6",
-    "@rushstack/heft-jest-plugin": "~0.16.9",
+    "@rushstack/heft-jest-plugin": "~0.16.11",
     "eslint-plugin-tsdoc": "~0.4.0"
   },
   "scripts": {

package/src/index.ts

@@ -0,0 +1,63 @@
+/*
+ * 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

@@ -0,0 +1,28 @@
+/*
+ * 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

@@ -0,0 +1,31 @@
+/*
+ * 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 };

package/src/packlets/base/logger.ts

@@ -0,0 +1,156 @@
+/*
+ * 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 { Failure, Success, fail, succeed } from './result';
+
+/**
+ * @public
+ */
+export type LogLevel = 'detail' | 'info' | 'warning' | 'error' | 'silent';
+
+/**
+ * @public
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+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 abstract class LoggerBase {
+  public logLevel: LogLevel = 'info';
+
+  public constructor(logLevel?: LogLevel) {
+    this.logLevel = logLevel ?? 'info';
+  }
+
+  public detail(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {
+    if (this.logLevel === 'detail') {
+      return this.log(message, parameters);
+    }
+    return succeed(undefined);
+  }
+
+  public info(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {
+    if (this.logLevel === 'detail' || this.logLevel === 'info') {
+      return this.log(message, parameters);
+    }
+    return succeed(undefined);
+  }
+
+  public warn(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {
+    if (this.logLevel !== 'error' && this.logLevel !== 'silent') {
+      return this.log(message, parameters);
+    }
+    return succeed(undefined);
+  }
+
+  public warnAndFail<T>(message?: unknown, ...parameters: unknown[]): Failure<T> {
+    const formatted = this._format(message, ...parameters);
+    if (this.logLevel !== 'error' && this.logLevel !== 'silent') {
+      const result = this.log(formatted);
+      return fail(result.value ?? formatted);
+    }
+    return fail(formatted);
+  }
+
+  public error<T>(message?: unknown, ...parameters: unknown[]): Failure<T> {
+    const formatted = this._format(message, ...parameters);
+    if (this.logLevel !== 'silent') {
+      const result = this.log(formatted);
+      return fail(result.value ?? formatted);
+    }
+    return fail(formatted);
+  }
+
+  public log(message?: unknown, ...parameters: unknown[]): Success<string | undefined> {
+    const messageString = this._format(message, ...parameters);
+    if (this.logLevel === 'silent') {
+      return this._innerSilent(messageString);
+    }
+    return this._innerLog(messageString);
+  }
+
+  protected _format(message?: unknown, ...parameters: unknown[]): string {
+    const raw = [message, ...parameters];
+    const filtered = raw.filter((m): m is string => m !== undefined);
+    const strings = filtered.map((m) => m.toString());
+    const joined = strings.join('');
+    return joined;
+  }
+
+  protected _innerSilent(__message: string): Success<string | undefined> {
+    return succeed(undefined);
+  }
+
+  protected abstract _innerLog(message: string): Success<string | undefined>;
+}
+
+/**
+ * @public
+ */
+export class InMemoryLogger extends LoggerBase {
+  protected _messages: string[] = [];
+  protected _silent: string[] = [];
+
+  public constructor(logLevel?: LogLevel) {
+    super(logLevel);
+  }
+
+  public get messages(): string[] {
+    return this._messages;
+  }
+  public get silent(): string[] {
+    return this._silent;
+  }
+
+  public clear(): void {
+    this._messages = [];
+    this._silent = [];
+  }
+
+  protected _innerLog(message: string): Success<string | undefined> {
+    this._messages.push(message);
+    return succeed(message);
+  }
+
+  protected _innerSilent(message: string): Success<string | undefined> {
+    this._silent.push(message);
+    return succeed(undefined);
+  }
+}
+
+/**
+ * @public
+ */
+export class NoOpLogger extends LoggerBase {
+  protected _innerLog(message: string): Success<string | undefined> {
+    // no-op
+    return succeed(message);
+  }
+}