@fgv/ts-utils - npm Package Compare versions

Comparing version 2.1.1-alpha.3 to 3.0.0-alpha.1

CHANGELOG.json

@@ -5,2 +5,44 @@ {
     {
+      "version": "3.0.0",
+      "tag": "@fgv/ts-utils_v3.0.0",
+      "date": "Mon, 22 Jan 2024 07:00:18 GMT",
+      "comments": {
+        "none": [
+          {
+            "comment": "gitignore tweaks"
+          },
+          {
+            "comment": "refactor hash implementation"
+          },
+          {
+            "comment": "bump versions"
+          },
+          {
+            "comment": "refactor and cleanup"
+          },
+          {
+            "comment": "build changes"
+          },
+          {
+            "comment": "Factor out extras, enable shaking"
+          },
+          {
+            "comment": "bump dependencies"
+          },
+          {
+            "comment": "version upgrades"
+          },
+          {
+            "comment": "relax mapToRecord from Map to ReadonlyMap"
+          },
+          {
+            "comment": "bump version"
+          },
+          {
+            "comment": "add oneOf validator"
+          }
+        ]
+      }
+    },
+    {
       "version": "2.0.0",
@@ -7,0 +49,0 @@ "tag": "@fgv/ts-utils_v2.0.0",

CHANGELOG.md

 # Change Log - @fgv/ts-utils
 
-This log was last generated on Mon, 10 Apr 2023 03:33:11 GMT and should not be manually modified.
+This log was last generated on Mon, 22 Jan 2024 07:00:18 GMT and should not be manually modified.
 
+## 3.0.0
+Mon, 22 Jan 2024 07:00:18 GMT
+
+### Updates
+
+- gitignore tweaks
+- refactor hash implementation
+- bump versions
+- refactor and cleanup
+- build changes
+- Factor out extras, enable shaking
+- bump dependencies
+- version upgrades
+- relax mapToRecord from Map to ReadonlyMap
+- bump version
+- add oneOf validator
+
 ## 2.0.0
@@ -6,0 +23,0 @@ Mon, 10 Apr 2023 03:33:11 GMT

lib/packlets/base/result.d.ts

@@ -84,3 +84,3 @@ /**
      * the supplied default value or `undefined` if no default is supplied.
-     * @deprecated Use {@link IResult.orDefault | orDefault} instead.
+     * @deprecated Use {@link IResult.(orDefault:1) | orDefault(T)} or {@link IResult.(orDefault:2) | orDefault()} instead.
      */
@@ -103,2 +103,3 @@ getValueOrDefault(dflt?: T): T | undefined;
      * the supplied default if an error occurred.
+     * {@label SUPPLIED}
      */
@@ -111,2 +112,3 @@ orDefault(dflt: T): T;
      * `undefined` if an error occurs.
+     * {@label MISSING}
      */
@@ -196,5 +198,8 @@ orDefault(): T | undefined;
     /**
-     * {@inheritdoc IResult.orDefault}
+     * {@inheritdoc IResult.(orDefault:1)}
      */
     orDefault(dflt: T): T;
+    /**
+     * {@inheritdoc IResult.(orDefault:2)}
+     */
     orDefault(): T | undefined;
@@ -208,3 +213,3 @@ /**
      * {@inheritdoc IResult.getValueOrDefault}
-     * @deprecated Use {@link Success.orDefault | orDefault} instead.
+     * @deprecated Use {@link Success.(orDefault:1) | orDefault(T)} or {@link Success.(orDefault:2) | orDefault()} instead.
      */
@@ -264,5 +269,8 @@ getValueOrDefault(dflt?: T): T | undefined;
     /**
-     * {@inheritdoc IResult.orDefault}
+     * {@inheritdoc IResult.(orDefault:1)}
      */
     orDefault(dflt: T): T;
+    /**
+     * {@inheritdoc IResult.(orDefault:2)}
+     */
     orDefault(): T | undefined;
@@ -276,3 +284,3 @@ /**
      * {@inheritdoc IResult.getValueOrDefault}
-     * @deprecated Use {@link Failure.orDefault | orDefault} instead.
+     * @deprecated Use {@link Failure.(orDefault:1) | orDefault(T)} or {@link Failure.(orDefault:2) | orDefault()} instead.
      */
@@ -279,0 +287,0 @@ getValueOrDefault(dflt?: T): T | undefined;

lib/packlets/base/result.js

@@ -79,3 +79,3 @@ "use strict";
      * {@inheritdoc IResult.getValueOrDefault}
-     * @deprecated Use {@link Success.orDefault | orDefault} instead.
+     * @deprecated Use {@link Success.(orDefault:1) | orDefault(T)} or {@link Success.(orDefault:2) | orDefault()} instead.
      */
@@ -170,3 +170,3 @@ getValueOrDefault(dflt) {
      * {@inheritdoc IResult.getValueOrDefault}
-     * @deprecated Use {@link Failure.orDefault | orDefault} instead.
+     * @deprecated Use {@link Failure.(orDefault:1) | orDefault(T)} or {@link Failure.(orDefault:2) | orDefault()} instead.
      */
@@ -173,0 +173,0 @@ getValueOrDefault(dflt) {

lib/packlets/validation/classes.d.ts

@@ -5,4 +5,5 @@ export { ArrayValidator, ArrayValidatorConstructorParams } from './array';
 export { FieldValidators, ObjectValidator, ObjectValidatorConstructorParams, ObjectValidatorOptions } from './object';
+export { OneOfValidator, OneOfValidatorConstructorParams } from './oneOf';
 export { StringValidator, StringValidatorConstructorParams } from './string';
 export { TypeGuardValidator, TypeGuardValidatorConstructorParams } from './typeGuard';
 //# sourceMappingURL=classes.d.ts.map

lib/packlets/validation/classes.js

@@ -24,3 +24,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TypeGuardValidator = exports.StringValidator = exports.ObjectValidator = exports.NumberValidator = exports.BooleanValidator = exports.ArrayValidator = void 0;
+exports.TypeGuardValidator = exports.StringValidator = exports.OneOfValidator = exports.ObjectValidator = exports.NumberValidator = exports.BooleanValidator = exports.ArrayValidator = void 0;
 /* c8 ignore start */
@@ -35,2 +35,4 @@ var array_1 = require("./array");
 Object.defineProperty(exports, "ObjectValidator", { enumerable: true, get: function () { return object_1.ObjectValidator; } });
+var oneOf_1 = require("./oneOf");
+Object.defineProperty(exports, "OneOfValidator", { enumerable: true, get: function () { return oneOf_1.OneOfValidator; } });
 var string_1 = require("./string");
@@ -37,0 +39,0 @@ Object.defineProperty(exports, "StringValidator", { enumerable: true, get: function () { return string_1.StringValidator; } });

lib/packlets/validation/validators.d.ts

@@ -5,2 +5,3 @@ import { ArrayValidator, ArrayValidatorConstructorParams } from './array';
 import { TypeGuardWithContext } from './common';
+import { OneOfValidator, OneOfValidatorConstructorParams } from './oneOf';
 import { Validator } from './validator';
@@ -56,2 +57,12 @@ /**
 /**
+ * Helper function to create a {@link Validation.Validator | Validator} which validates one
+ * of several possible validated values.
+ * @param validators - the {@link Validation.Validator | validators} to be considered.
+ * @param params - Optional {@link Validation.Classes.OneOfValidatorConstructorParams | params} used to construct the validator.
+ * @returns A new {@link Validator | Validator} which validates values that match any of
+ * the supplied validators.
+ * @public
+ */
+export declare function oneOf<T, TC = unknown>(validators: Array<Validator<T, TC>>, params?: Omit<OneOfValidatorConstructorParams<T, TC>, 'validators'>): OneOfValidator<T, TC>;
+/**
  * Helper function to create a {@link Validation.Classes.TypeGuardValidator | TypeGuardValidator} which
@@ -58,0 +69,0 @@ * validates a value or object in place.

lib/packlets/validation/validators.js

@@ -24,3 +24,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isA = exports.literal = exports.enumeratedValue = exports.arrayOf = exports.object = exports.boolean = exports.number = exports.string = void 0;
+exports.isA = exports.oneOf = exports.literal = exports.enumeratedValue = exports.arrayOf = exports.object = exports.boolean = exports.number = exports.string = void 0;
 const base_1 = require("../base");
@@ -33,2 +33,3 @@ const array_1 = require("./array");
 const number_1 = require("./number");
+const oneOf_1 = require("./oneOf");
 const string_1 = require("./string");
@@ -111,2 +112,15 @@ /**
 /**
+ * Helper function to create a {@link Validation.Validator | Validator} which validates one
+ * of several possible validated values.
+ * @param validators - the {@link Validation.Validator | validators} to be considered.
+ * @param params - Optional {@link Validation.Classes.OneOfValidatorConstructorParams | params} used to construct the validator.
+ * @returns A new {@link Validator | Validator} which validates values that match any of
+ * the supplied validators.
+ * @public
+ */
+function oneOf(validators, params) {
+    return new oneOf_1.OneOfValidator(Object.assign(Object.assign({}, (params !== null && params !== void 0 ? params : {})), { validators }));
+}
+exports.oneOf = oneOf;
+/**
  * Helper function to create a {@link Validation.Classes.TypeGuardValidator | TypeGuardValidator} which
@@ -113,0 +127,0 @@ * validates a value or object in place.

package.json

 {
   "name": "@fgv/ts-utils",
-  "version": "2.1.1-alpha.3",
+  "version": "3.0.0-alpha.1",
   "description": "Assorted Typescript Utilities",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

No alert changes

Improved metrics

Total package byte prevSize

713239

increased by2.53%

Number of package files

131

increased by3.15%

Lines of code

8724

increased by2.73%

No dependency changes