@fgv/ts-utils 3.0.1-alpha.6 → 4.0.1

package/CHANGELOG.json

@@ -1,6 +1,54 @@
 {
   "name": "@fgv/ts-utils",
   "entries": [
+    {
+      "version": "4.0.1",
+      "tag": "@fgv/ts-utils_v4.0.1",
+      "date": "Tue, 14 May 2024 05:02:20 GMT",
+      "comments": {
+        "none": [
+          {
+            "comment": "publish"
+          },
+          {
+            "comment": "import TextEncoder to avoid globals race"
+          }
+        ]
+      }
+    },
+    {
+      "version": "4.0.0",
+      "tag": "@fgv/ts-utils_v4.0.0",
+      "date": "Tue, 14 May 2024 03:09:27 GMT",
+      "comments": {
+        "none": [
+          {
+            "comment": "rework validation/converter compatibility a bit"
+          },
+          {
+            "comment": "QoL improvement to simplify error aggregation"
+          },
+          {
+            "comment": "factor optional converters out to ts-extras package to eliminate large dependencies"
+          },
+          {
+            "comment": "update generated api docs"
+          },
+          {
+            "comment": "add convalidate helper"
+          },
+          {
+            "comment": "add defaulting converter"
+          },
+          {
+            "comment": "extend conversion to accept validators"
+          },
+          {
+            "comment": "export StringConverter at top level"
+          }
+        ]
+      }
+    },
     {
       "version": "3.0.0",
       "tag": "@fgv/ts-utils_v3.0.0",

package/CHANGELOG.md

@@ -1,6 +1,28 @@
 # Change Log - @fgv/ts-utils
 
-This log was last generated on Mon, 22 Jan 2024 07:00:18 GMT and should not be manually modified.
+This log was last generated on Tue, 14 May 2024 05:02:20 GMT and should not be manually modified.
+
+## 4.0.1
+Tue, 14 May 2024 05:02:20 GMT
+
+### Updates
+
+- publish
+- import TextEncoder to avoid globals race
+
+## 4.0.0
+Tue, 14 May 2024 03:09:27 GMT
+
+### Updates
+
+- rework validation/converter compatibility a bit
+- QoL improvement to simplify error aggregation
+- factor optional converters out to ts-extras package to eliminate large dependencies
+- update generated api docs
+- add convalidate helper
+- add defaulting converter
+- extend conversion to accept validators
+- export StringConverter at top level
 
 ## 3.0.0
 Mon, 22 Jan 2024 07:00:18 GMT

package/README.md

@@ -11,12 +11,6 @@ Assorted typescript utilities that I'm tired of copying from project to project.
 * Result\<T\> - Easily combine inline and exception-based error handling
 * Converter\<T\> - Conversion framework especially useful for type-safe processing of JSON
 
-Also includes a few other much less-developed odds-and-ends borrowed from one project or another - much less polished and more likely change or disappear:
-* ExtendedArray\<T\> - adds a few useful operations to the built-in Array
-* Formattable\<T\> - simple helpers to create mustache wrappers for objects and make them easily printable
-* Logger - A very basic logger suitable for hobby projects
-* RangeOf\<T\> - Generic open or closed ranges of orderable items (numbers, dates, etc)
-
 ---
 
 - [Summary](#summary)
@@ -28,11 +22,6 @@ Also includes a few other much less-developed odds-and-ends borrowed from one pr
 - [API](#api)
   - [Result\<T\>](#resultt)
   - [Converter\<T\>](#convertert)
-- [Additional APIs](#additional-apis)
-  - [ExtendedArray\<T\>](#extendedarrayt)
-  - [Formattable\<T\>](#formattablet)
-  - [Logger](#logger)
-  - [RangeOf\<T\>](#rangeoft)
 
 ## Installation
 
@@ -139,15 +128,5 @@ Other helpers and methods enable optional values or fields, chaining of results
 
 ### Result\<T\>
 
-
 ### Converter\<T\>
 
-## Additional APIs
-
-### ExtendedArray\<T\>
-
-### Formattable\<T\>
-
-### Logger
-
-### RangeOf\<T\>

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.42.1"
+      "packageVersion": "7.43.4"
     }
   ]
 }

package/lib/packlets/hash/crcNormalizer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"crcNormalizer.d.ts","sourceRoot":"","sources":["../../../src/packlets/hash/crcNormalizer.ts"],"names":[],"mappings":"AAsBA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAyCxD;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,iBAAiB;;WAKtC,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM;CAGjD"}
+{"version":3,"file":"crcNormalizer.d.ts","sourceRoot":"","sources":["../../../src/packlets/hash/crcNormalizer.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAyCxD;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,iBAAiB;;WAKtC,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM;CAGjD"}

package/lib/packlets/hash/crcNormalizer.js

@@ -22,6 +22,7 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Crc32Normalizer = void 0;
+const util_1 = require("util");
 const hashingNormalizer_1 = require("./hashingNormalizer");
 const POLYNOMIAL = 0xedb88320;
 const crc32Table = [];
@@ -68,7 +69,7 @@ class Crc32Normalizer extends hashingNormalizer_1.HashingNormalizer {
         super(Crc32Normalizer.crc32Hash);
     }
     static crc32Hash(parts) {
-        return String(crc32(new TextEncoder().encode(parts.join('|'))));
+        return String(crc32(new util_1.TextEncoder().encode(parts.join('|'))));
     }
 }
 exports.Crc32Normalizer = Crc32Normalizer;

package/lib/packlets/hash/crcNormalizer.js.map

@@ -1 +1 @@
-{"version":3,"file":"crcNormalizer.js","sourceRoot":"","sources":["../../../src/packlets/hash/crcNormalizer.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,2DAAwD;AAExD,MAAM,UAAU,GAAW,UAAU,CAAC;AAEtC,MAAM,UAAU,GAAa,EAAE,CAAC;AAEhC,SAAS,KAAK,CAAC,KAAiB,EAAE,MAAc,UAAU;IACxD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,eAAe,EAAE,CAAC;IACpB,CAAC;IACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACtC,sCAAsC;QACtC,GAAG,GAAG,UAAU,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAU,EAAE;IACrC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,CAAC;IACX,CAAC;IACD,OAAO,UAAU,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;AACjC,CAAC,CAAC;AAEF,SAAS,eAAe;IACtB,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7B,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC3B,sCAAsC;gBACtC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;oBACV,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,UAAU,CAAC;gBAC7B,CAAC;qBAAM,CAAC;oBACN,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACd,CAAC;YACH,CAAC;YACD,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAa,eAAgB,SAAQ,qCAAiB;IACpD;QACE,KAAK,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,KAAe;QACrC,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAClE,CAAC;CACF;AARD,0CAQC","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { HashingNormalizer } from './hashingNormalizer';\n\nconst POLYNOMIAL: number = 0xedb88320;\n\nconst crc32Table: number[] = [];\n\nfunction crc32(bytes: Uint8Array, crc: number = 0xffffffff): number {\n  if (crc32Table.length === 0) {\n    buildCrc32Table();\n  }\n  for (let i = 0; i < bytes.length; ++i) {\n    // eslint-disable-next-line no-bitwise\n    crc = crc32Table[(crc ^ bytes[i]) & 0xff] ^ (crc >>> 8);\n  }\n  return (crc ^ -1) >>> 0;\n}\n\nconst toUInt32 = (n: number): number => {\n  if (n >= 0) {\n    return n;\n  }\n  return 0xffffffff - n * -1 + 1;\n};\n\nfunction buildCrc32Table(): void {\n  if (crc32Table.length === 0) {\n    for (let n = 0; n < 256; n++) {\n      let r = n;\n      for (let i = 0; i < 8; i++) {\n        // eslint-disable-next-line no-bitwise\n        if (r & 1) {\n          r = (r >>> 1) ^ POLYNOMIAL;\n        } else {\n          r = r >>> 1;\n        }\n      }\n      crc32Table.push(toUInt32(r));\n    }\n  }\n}\n\n/**\n * A {@link Hash.HashingNormalizer | hashing normalizer} which computes object\n * hash using the CRC32 algorithm.\n * @public\n */\nexport class Crc32Normalizer extends HashingNormalizer {\n  public constructor() {\n    super(Crc32Normalizer.crc32Hash);\n  }\n\n  public static crc32Hash(parts: string[]): string {\n    return String(crc32(new TextEncoder().encode(parts.join('|'))));\n  }\n}\n"]}
+{"version":3,"file":"crcNormalizer.js","sourceRoot":"","sources":["../../../src/packlets/hash/crcNormalizer.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;;;AAEH,+BAAmC;AACnC,2DAAwD;AAExD,MAAM,UAAU,GAAW,UAAU,CAAC;AAEtC,MAAM,UAAU,GAAa,EAAE,CAAC;AAEhC,SAAS,KAAK,CAAC,KAAiB,EAAE,MAAc,UAAU;IACxD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,eAAe,EAAE,CAAC;IACpB,CAAC;IACD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE,CAAC;QACtC,sCAAsC;QACtC,GAAG,GAAG,UAAU,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;AAC1B,CAAC;AAED,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAU,EAAE;IACrC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACX,OAAO,CAAC,CAAC;IACX,CAAC;IACD,OAAO,UAAU,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC;AACjC,CAAC,CAAC;AAEF,SAAS,eAAe;IACtB,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7B,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC;gBAC3B,sCAAsC;gBACtC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;oBACV,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,UAAU,CAAC;gBAC7B,CAAC;qBAAM,CAAC;oBACN,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBACd,CAAC;YACH,CAAC;YACD,UAAU,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,MAAa,eAAgB,SAAQ,qCAAiB;IACpD;QACE,KAAK,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACnC,CAAC;IAEM,MAAM,CAAC,SAAS,CAAC,KAAe;QACrC,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,kBAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IAClE,CAAC;CACF;AARD,0CAQC","sourcesContent":["/*\n * Copyright (c) 2023 Erik Fortune\n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to deal\n * in the Software without restriction, including without limitation the rights\n * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n * copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in all\n * copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n * SOFTWARE.\n */\n\nimport { TextEncoder } from 'util';\nimport { HashingNormalizer } from './hashingNormalizer';\n\nconst POLYNOMIAL: number = 0xedb88320;\n\nconst crc32Table: number[] = [];\n\nfunction crc32(bytes: Uint8Array, crc: number = 0xffffffff): number {\n  if (crc32Table.length === 0) {\n    buildCrc32Table();\n  }\n  for (let i = 0; i < bytes.length; ++i) {\n    // eslint-disable-next-line no-bitwise\n    crc = crc32Table[(crc ^ bytes[i]) & 0xff] ^ (crc >>> 8);\n  }\n  return (crc ^ -1) >>> 0;\n}\n\nconst toUInt32 = (n: number): number => {\n  if (n >= 0) {\n    return n;\n  }\n  return 0xffffffff - n * -1 + 1;\n};\n\nfunction buildCrc32Table(): void {\n  if (crc32Table.length === 0) {\n    for (let n = 0; n < 256; n++) {\n      let r = n;\n      for (let i = 0; i < 8; i++) {\n        // eslint-disable-next-line no-bitwise\n        if (r & 1) {\n          r = (r >>> 1) ^ POLYNOMIAL;\n        } else {\n          r = r >>> 1;\n        }\n      }\n      crc32Table.push(toUInt32(r));\n    }\n  }\n}\n\n/**\n * A {@link Hash.HashingNormalizer | hashing normalizer} which computes object\n * hash using the CRC32 algorithm.\n * @public\n */\nexport class Crc32Normalizer extends HashingNormalizer {\n  public constructor() {\n    super(Crc32Normalizer.crc32Hash);\n  }\n\n  public static crc32Hash(parts: string[]): string {\n    return String(crc32(new TextEncoder().encode(parts.join('|'))));\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-utils",
-  "version": "3.0.1-alpha.6",
+  "version": "4.0.1",
   "description": "Assorted Typescript Utilities",
   "main": "lib/index.js",
   "types": "dist/ts-utils.d.ts",
@@ -29,14 +29,14 @@
   "homepage": "https://github.com/ErikFortune/fgv/tree/main/libraries/ts-utils#readme",
   "devDependencies": {
     "@jest/expect-utils": "^29.7.0",
-    "@microsoft/api-documenter": "^7.23.34",
-    "@microsoft/api-extractor": "^7.42.1",
+    "@microsoft/api-documenter": "^7.24.5",
+    "@microsoft/api-extractor": "^7.43.4",
     "@types/jest": "^29.5.12",
     "@types/luxon": "^3.4.2",
     "@types/mustache": "^4.2.5",
-    "@types/node": "^20.11.24",
-    "@typescript-eslint/eslint-plugin": "^7.1.0",
-    "@typescript-eslint/parser": "^7.1.0",
+    "@types/node": "^20.12.11",
+    "@typescript-eslint/eslint-plugin": "^7.9.0",
+    "@typescript-eslint/parser": "^7.9.0",
     "eslint": "^8.57.0",
     "eslint-config-standard": "^17.1.0",
     "eslint-plugin-import": "^2.29.1",
@@ -45,17 +45,17 @@
     "jest": "^29.7.0",
     "jest-extended": "^4.0.2",
     "jest-matcher-utils": "^29.7.0",
-    "rimraf": "^5.0.5",
+    "rimraf": "^5.0.7",
     "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
-    "typescript": "^5.3.3",
+    "typescript": "^5.4.5",
     "eslint-plugin-n": "^16.6.2",
     "jest-snapshot": "~29.7.0",
-    "@rushstack/heft": "~0.65.8",
-    "@rushstack/heft-node-rig": "~2.4.21",
-    "@rushstack/eslint-config": "~3.6.4",
+    "@rushstack/heft": "~0.66.6",
+    "@rushstack/heft-node-rig": "~2.6.3",
+    "@rushstack/eslint-config": "~3.6.9",
     "@types/heft-jest": "1.0.6",
-    "@rushstack/heft-jest-plugin": "~0.11.18",
+    "@rushstack/heft-jest-plugin": "~0.11.27",
     "eslint-plugin-tsdoc": "~0.2.17"
   }
 }