ts-data-forge 9.0.1 → 10.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ts-data-forge",
-  "version": "9.0.1",
+  "version": "10.0.0",
   "private": false,
   "keywords": [
     "typescript",
@@ -86,12 +86,12 @@
   },
   "dependencies": {
     "@sindresorhus/is": "^8.1.0",
-    "ts-type-forge": "^5.0.0"
+    "ts-type-forge": "^6.0.0"
   },
   "devDependencies": {
     "@emotion/react": "11.14.0",
     "@emotion/styled": "11.14.1",
-    "@mui/material": "9.1.2",
+    "@mui/material": "9.2.0",
     "@rollup/plugin-replace": "6.0.3",
     "@rollup/plugin-strip": "3.0.4",
     "@semantic-release/changelog": "6.0.3",
@@ -104,7 +104,7 @@
     "@types/node": "26.1.0",
     "@types/react": "19.2.17",
     "@vitest/browser-playwright": "4.1.9",
-    "@vitest/coverage-v8": "4.1.9",
+    "@vitest/coverage-v8": "4.1.10",
     "@vitest/ui": "4.1.9",
     "conventional-changelog-conventionalcommits": "10.2.0",
     "cspell": "10.0.1",
@@ -113,7 +113,7 @@
     "eslint": "9.39.4",
     "eslint-config-typed": "5.3.0",
     "github-settings-as-code": "1.2.9",
-    "immer": "11.1.9",
+    "immer": "11.1.11",
     "jiti": "2.7.0",
     "markdownlint": "0.41.0",
     "markdownlint-cli2": "0.23.0",
@@ -134,12 +134,12 @@
     "typescript": "6.0.3",
     "typescript-native": "npm:typescript@7.0.1-rc",
     "vite": "8.1.3",
-    "vitest": "4.1.9"
+    "vitest": "4.1.10"
   },
   "peerDependencies": {
     "typescript": ">=4.8"
   },
-  "packageManager": "pnpm@11.10.0",
+  "packageManager": "pnpm@11.10.0+sha512.0b7f8b98060031904c017e3a41eb187a16d40eeb829b95c4f8cb03681761fc4ab53dd219115b9b447f4dce1a05a214764461e7d3703392a9f32f9511ce8c86c8",
   "engines": {
     "node": ">=22.22.2",
     "pnpm": ">=9.0.0"

package/src/array/impl/array-utils-creation.mts

@@ -1,6 +1,6 @@
 import {
-  type ArrayOfLength,
   type BoolOr,
+  type FixedLengthTuple,
   type Index,
   type IsUnion,
   type List,
@@ -38,7 +38,7 @@ import { type SizeType } from '../../types.mjs';
 export const zeros = <N extends SizeType.ArgArr>(
   len: N,
 ): N extends SmallUint
-  ? ArrayOfLength<N, 0>
+  ? FixedLengthTuple<N, 0>
   : N extends SizeType.ArgArrPositive
     ? NonEmptyArray<0>
     : readonly 0[] =>
@@ -89,7 +89,7 @@ export const create = <N extends SizeType.ArgArr, const V>(
   len: N,
   init: V,
 ): N extends SmallUint
-  ? ArrayOfLength<N, V>
+  ? FixedLengthTuple<N, V>
   : N extends SizeType.ArgArrPositive
     ? NonEmptyArray<V>
     : readonly V[] =>

package/src/array/impl/array-utils-modification.mts

@@ -1,5 +1,5 @@
 import {
-  type ArrayOfLength,
+  type FixedLengthTuple,
   type Increment,
   type IsFixedLengthList,
   type NonEmptyArray,
@@ -163,7 +163,7 @@ export function toInserted<
   index: ArgArrayIndexWithNegative<Ar>,
   newValue: V,
 ): IsFixedLengthList<Ar> extends true
-  ? ArrayOfLength<CastToNumber<Increment<Ar['length']>>, Ar[number] | V>
+  ? FixedLengthTuple<CastToNumber<Increment<Ar['length']>>, Ar[number] | V>
   : NonEmptyArray<Ar[number] | V>;
 
 // curried version
@@ -173,7 +173,7 @@ export function toInserted<const V>(
 ): <const Ar extends readonly unknown[]>(
   array: Ar,
 ) => IsFixedLengthList<Ar> extends true
-  ? ArrayOfLength<CastToNumber<Increment<Ar['length']>>, Ar[number] | V>
+  ? FixedLengthTuple<CastToNumber<Increment<Ar['length']>>, Ar[number] | V>
   : NonEmptyArray<Ar[number] | V>;
 
 export function toInserted<E, const V = E>(
@@ -367,7 +367,7 @@ export function toFilled<const Ar extends readonly unknown[], const V>(
   array: Ar,
   value: V,
 ): IsFixedLengthList<Ar> extends true
-  ? ArrayOfLength<Ar['length'], V>
+  ? FixedLengthTuple<Ar['length'], V>
   : Ar extends NonEmptyArray<unknown>
     ? NonEmptyArray<V>
     : readonly V[];
@@ -378,7 +378,7 @@ export function toFilled<const V>(
 ): <const Ar extends readonly unknown[]>(
   array: Ar,
 ) => IsFixedLengthList<Ar> extends true
-  ? ArrayOfLength<Ar['length'], V>
+  ? FixedLengthTuple<Ar['length'], V>
   : Ar extends NonEmptyArray<unknown>
     ? NonEmptyArray<V>
     : readonly V[];
@@ -426,7 +426,7 @@ export function toRangeFilled<const Ar extends readonly unknown[], const V>(
     end: ArgArrayIndexWithNegative<Ar>,
   ],
 ): IsFixedLengthList<Ar> extends true
-  ? ArrayOfLength<Ar['length'], V | Ar[number]>
+  ? FixedLengthTuple<Ar['length'], V | Ar[number]>
   : Ar extends NonEmptyArray<unknown>
     ? NonEmptyArray<V | Ar[number]>
     : readonly (V | Ar[number])[];
@@ -441,7 +441,7 @@ export function toRangeFilled<const V>(
 ): <const Ar extends readonly unknown[]>(
   array: Ar,
 ) => IsFixedLengthList<Ar> extends true
-  ? ArrayOfLength<Ar['length'], V | Ar[number]>
+  ? FixedLengthTuple<Ar['length'], V | Ar[number]>
   : Ar extends NonEmptyArray<unknown>
     ? NonEmptyArray<V | Ar[number]>
     : readonly (V | Ar[number])[];

package/src/array/impl/array-utils-modification.test.mts

@@ -1,4 +1,4 @@
-import { type ArrayOfLength, type NonEmptyArray } from 'ts-type-forge';
+import { type FixedLengthTuple, type NonEmptyArray } from 'ts-type-forge';
 import { expectType } from '../../expect-type.mjs';
 import { asUint32 } from '../../number/index.mjs';
 import {
@@ -18,7 +18,7 @@ describe('Arr modifications', () => {
 
     const result = toUpdated(xs, 1, (x) => x + 2);
 
-    expectType<typeof result, ArrayOfLength<3, number>>('=');
+    expectType<typeof result, FixedLengthTuple<3, number>>('=');
 
     test('case 1', () => {
       assert.deepStrictEqual(result, [1, 4, 3]);
@@ -39,7 +39,7 @@ describe('Arr modifications', () => {
     test('case 1', () => {
       const result = toInserted(xs, 1, 5);
 
-      expectType<typeof result, ArrayOfLength<4, 1 | 2 | 3 | 5>>('=');
+      expectType<typeof result, FixedLengthTuple<4, 1 | 2 | 3 | 5>>('=');
 
       assert.deepStrictEqual(result, [1, 5, 2, 3]);
     });
@@ -47,7 +47,7 @@ describe('Arr modifications', () => {
     test('case 2 (insert head)', () => {
       const result = toInserted(xs, 0, 5);
 
-      expectType<typeof result, ArrayOfLength<4, 1 | 2 | 3 | 5>>('=');
+      expectType<typeof result, FixedLengthTuple<4, 1 | 2 | 3 | 5>>('=');
 
       assert.deepStrictEqual(result, [5, 1, 2, 3]);
     });

package/src/array/impl/array-utils-transformation.mts

@@ -1,5 +1,5 @@
 import {
-  type ArrayOfLength,
+  type FixedLengthTuple,
   type IsFixedLengthList,
   type List,
   type MutableNonEmptyArray,
@@ -220,7 +220,7 @@ export const toSorted = <const Ar extends readonly unknown[]>(
       ]
     : readonly [array: Ar, comparator: (x: Ar[number], y: Ar[number]) => number]
 ): IsFixedLengthList<Ar> extends true
-  ? ArrayOfLength<Ar['length'], Ar[number]>
+  ? FixedLengthTuple<Ar['length'], Ar[number]>
   : Ar extends NonEmptyArray<unknown>
     ? NonEmptyArray<Ar[number]>
     : readonly Ar[number][] =>
@@ -278,7 +278,7 @@ export function toSortedBy<const Ar extends readonly unknown[]>(
   // If the array elements are mapped to numbers, comparator is optional.
   comparator?: (x: number, y: number) => number,
 ): IsFixedLengthList<Ar> extends true
-  ? ArrayOfLength<Ar['length'], Ar[number]>
+  ? FixedLengthTuple<Ar['length'], Ar[number]>
   : Ar extends NonEmptyArray<unknown>
     ? NonEmptyArray<Ar[number]>
     : readonly Ar[number][];
@@ -288,7 +288,7 @@ export function toSortedBy<const Ar extends readonly unknown[], const V>(
   comparatorValueMapper: (value: Ar[number]) => V,
   comparator: (x: V, y: V) => number,
 ): IsFixedLengthList<Ar> extends true
-  ? ArrayOfLength<Ar['length'], Ar[number]>
+  ? FixedLengthTuple<Ar['length'], Ar[number]>
   : Ar extends NonEmptyArray<unknown>
     ? NonEmptyArray<Ar[number]>
     : readonly Ar[number][];

package/src/array/impl/array-utils-transformation.test.mts

@@ -1,4 +1,4 @@
-import { type ArrayOfLength } from 'ts-type-forge';
+import { type FixedLengthTuple } from 'ts-type-forge';
 import { IMap } from '../../collections/index.mjs';
 import { expectType } from '../../expect-type.mjs';
 import { Optional } from '../../functional/index.mjs';
@@ -26,7 +26,7 @@ describe('Arr transformations', () => {
   describe(map, () => {
     const mapped = map([1, 2, 3], (x, i): number => x ** 2 * i);
 
-    expectType<typeof mapped, ArrayOfLength<3, number>>('=');
+    expectType<typeof mapped, FixedLengthTuple<3, number>>('=');
 
     test('case 1', () => {
       assert.deepStrictEqual(mapped, [0, 4, 18]);
@@ -215,7 +215,7 @@ describe('Arr transformations', () => {
 
       const result = toSorted(xs);
 
-      expectType<typeof result, ArrayOfLength<3, 1 | 2 | 3>>('=');
+      expectType<typeof result, FixedLengthTuple<3, 1 | 2 | 3>>('=');
 
       test('case 1', () => {
         assert.deepStrictEqual(result, [1, 2, 3]);
@@ -227,7 +227,7 @@ describe('Arr transformations', () => {
 
       const result = toSorted(xs, (a, b) => a - b);
 
-      expectType<typeof result, ArrayOfLength<3, 1 | 2 | 3>>('=');
+      expectType<typeof result, FixedLengthTuple<3, 1 | 2 | 3>>('=');
 
       test('case 2', () => {
         assert.deepStrictEqual(result, [1, 2, 3]);
@@ -239,7 +239,7 @@ describe('Arr transformations', () => {
 
       const result = toSorted(xs, (a, b) => b - a);
 
-      expectType<typeof result, ArrayOfLength<3, 1 | 2 | 3>>('=');
+      expectType<typeof result, FixedLengthTuple<3, 1 | 2 | 3>>('=');
 
       test('case 3', () => {
         assert.deepStrictEqual(result, [3, 2, 1]);
@@ -255,7 +255,7 @@ describe('Arr transformations', () => {
 
       expectType<
         typeof sorted,
-        ArrayOfLength<3, Readonly<{ v: 1 } | { v: 2 } | { v: 3 }>>
+        FixedLengthTuple<3, Readonly<{ v: 1 } | { v: 2 } | { v: 3 }>>
       >('=');
 
       test('case 1', () => {
@@ -274,7 +274,7 @@ describe('Arr transformations', () => {
 
       expectType<
         typeof sorted,
-        ArrayOfLength<3, Readonly<{ v: 1 } | { v: 2 } | { v: 3 }>>
+        FixedLengthTuple<3, Readonly<{ v: 1 } | { v: 2 } | { v: 3 }>>
       >('=');
 
       test('case 2', () => {

package/src/array/impl/array-utils-validation.mts

@@ -1,9 +1,9 @@
 import {
-  type ArrayAtLeastLen,
-  type ArrayAtMostLen,
-  type ArrayBoundedLen,
-  type ArrayOfLength,
   type BoolOr,
+  type BoundedLengthTuple,
+  type FixedLengthTuple,
+  type MaxLengthTuple,
+  type MinLengthTuple,
   type NonEmptyArray,
   type TypeEq,
 } from 'ts-type-forge';
@@ -100,19 +100,19 @@ export const isNonEmpty = <E,>(
  *
  * const triple: readonly number[] = [1, 2, 3] as const;
  *
- * assert.isTrue(Arr.isArrayOfLength(pair, 2));
+ * assert.isTrue(Arr.isFixedLengthTuple(pair, 2));
  *
- * assert.isFalse(Arr.isArrayOfLength(triple, 2));
+ * assert.isFalse(Arr.isFixedLengthTuple(triple, 2));
  *
- * if (Arr.isArrayOfLength(pair, 2)) {
+ * if (Arr.isFixedLengthTuple(pair, 2)) {
  *   assert.deepStrictEqual(pair, [1, 2]);
  * }
  * ```
  */
-export const isArrayOfLength = <E, N extends SizeType.ArgArr>(
+export const isFixedLengthTuple = <E, N extends SizeType.ArgArr>(
   array: readonly E[],
   len: N,
-): array is ArrayOfLength<N, E> => array.length === len;
+): array is FixedLengthTuple<N, E> => array.length === len;
 
 /**
  * Checks if an array has at least a specific length.
@@ -124,19 +124,19 @@ export const isArrayOfLength = <E, N extends SizeType.ArgArr>(
  *
  * const emptyQueue: readonly string[] = [] as const;
  *
- * assert.isTrue(Arr.isArrayAtLeastLength(queue, 1));
+ * assert.isTrue(Arr.isMinLengthTuple(queue, 1));
  *
- * assert.isFalse(Arr.isArrayAtLeastLength(emptyQueue, 1));
+ * assert.isFalse(Arr.isMinLengthTuple(emptyQueue, 1));
  *
- * if (Arr.isArrayAtLeastLength(queue, 1)) {
+ * if (Arr.isMinLengthTuple(queue, 1)) {
  *   assert.isTrue(queue[0] === 'task-1');
  * }
  * ```
  */
-export const isArrayAtLeastLength = <E, N extends SizeType.ArgArr>(
+export const isMinLengthTuple = <E, N extends SizeType.ArgArr>(
   array: readonly E[],
   len: N,
-): array is ArrayAtLeastLen<N, E> => array.length >= len;
+): array is MinLengthTuple<N, E> => array.length >= len;
 
 /**
  * Checks if an array has at most a specific length.
@@ -148,19 +148,19 @@ export const isArrayAtLeastLength = <E, N extends SizeType.ArgArr>(
  *
  * const triple: readonly number[] = [1, 2, 3] as const;
  *
- * assert.isTrue(Arr.isArrayAtMostLength(pair, 2));
+ * assert.isTrue(Arr.isMaxLengthTuple(pair, 2));
  *
- * assert.isFalse(Arr.isArrayAtMostLength(triple, 2));
+ * assert.isFalse(Arr.isMaxLengthTuple(triple, 2));
  *
- * if (Arr.isArrayAtMostLength(pair, 2)) {
+ * if (Arr.isMaxLengthTuple(pair, 2)) {
  *   assert.isTrue(pair.length <= 2);
  * }
  * ```
  */
-export const isArrayAtMostLength = <E, N extends SizeType.ArgArr>(
+export const isMaxLengthTuple = <E, N extends SizeType.ArgArr>(
   array: readonly E[],
   len: N,
-): array is ArrayAtMostLen<N, E> => array.length <= len;
+): array is MaxLengthTuple<N, E> => array.length <= len;
 
 /**
  * Checks if an array's length is within a specific inclusive range.
@@ -172,16 +172,16 @@ export const isArrayAtMostLength = <E, N extends SizeType.ArgArr>(
  *
  * const quad: readonly number[] = [1, 2, 3, 4] as const;
  *
- * assert.isTrue(Arr.isArrayBoundedLength(pair, 1, 3));
+ * assert.isTrue(Arr.isBoundedLengthTuple(pair, 1, 3));
  *
- * assert.isFalse(Arr.isArrayBoundedLength(quad, 1, 3));
+ * assert.isFalse(Arr.isBoundedLengthTuple(quad, 1, 3));
  *
- * if (Arr.isArrayBoundedLength(pair, 1, 3)) {
+ * if (Arr.isBoundedLengthTuple(pair, 1, 3)) {
  *   assert.isTrue(pair.length >= 1 && pair.length <= 3);
  * }
  * ```
  */
-export const isArrayBoundedLength = <
+export const isBoundedLengthTuple = <
   E,
   Min extends SizeType.ArgArr,
   Max extends SizeType.ArgArr,
@@ -189,7 +189,7 @@ export const isArrayBoundedLength = <
   array: readonly E[],
   min: Min,
   max: Max,
-): array is ArrayBoundedLen<Min, Max, E> =>
+): array is BoundedLengthTuple<Min, Max, E> =>
   array.length >= min && array.length <= max;
 
 /**