ts-data-forge 6.9.2 → 6.9.3

package/src/number/num.mts

@@ -1,4 +1,22 @@
+import {
+  type Decrement,
+  type Increment,
+  type Index,
+  type Int,
+  type Min,
+  type NaNType,
+  type NegativeIndex,
+  type NonNegativeNumber,
+  type NonZeroNumber,
+  type PositiveNumber,
+  type PositiveSafeIntWithSmallInt,
+  type RelaxedExclude,
+  type SmallInt,
+  type SmallUint,
+  type UnknownBrand,
+} from 'ts-type-forge';
 import { expectType } from '../expect-type.mjs';
+import { type SmallPositiveInt } from '../types.mjs';
 
 /**
  * Namespace providing utility functions for number manipulation and validation.

package/src/number/num.test.mts

@@ -1,3 +1,4 @@
+import { type NonZeroNumber } from 'ts-type-forge';
 import { expectType } from '../expect-type.mjs';
 import { pipe } from '../functional/index.mjs';
 import { asNonZeroFiniteNumber } from './branded-types/index.mjs';

package/src/number/refined-number-utils.mts

@@ -1,3 +1,18 @@
+import {
+  type Brand,
+  type ChangeBaseBrand,
+  type GetBrandValuePart,
+  type Int,
+  type IntersectBrand,
+  type NonNegativeNumber,
+  type NonZeroNumber,
+  type RelaxedExclude,
+  type TypeEq,
+  type UnknownBrand,
+  type UnwrapBrandFalseKeys,
+  type UnwrapBrandTrueKeys,
+  type WithSmallInt,
+} from 'ts-type-forge';
 import { expectType } from '../expect-type.mjs';
 import { pipe } from '../functional/index.mjs';
 import { Num } from './num.mjs';

package/src/object/object.mts

@@ -1,3 +1,16 @@
+import {
+  type ArrayElement,
+  type Decrement,
+  type DeepOmit,
+  type DeepPick,
+  type IsFixedLengthList,
+  type IsUnion,
+  type List,
+  type ReadonlyRecord,
+  type RelaxedPick,
+  type TypeEq,
+  type UnknownRecord,
+} from 'ts-type-forge';
 import { Arr } from '../array/index.mjs';
 import { hasKey, isRecord } from '../guard/index.mjs';
 

package/src/object/object.test.mts

@@ -1,3 +1,8 @@
+import {
+  type ArrayOfLength,
+  type DeepReadonly,
+  type UnknownRecord,
+} from 'ts-type-forge';
 import { expectType } from '../expect-type.mjs';
 import { pipe } from '../functional/index.mjs';
 import { Obj } from './object.mjs';

package/src/others/cast-mutable.mts

@@ -1,3 +1,5 @@
+import { type DeepMutable, type Mutable } from 'ts-type-forge';
+
 /**
  * Casts a readonly type `T` to its `Mutable<T>` equivalent.
  *
@@ -13,6 +15,7 @@
  * @see castReadonly - For the opposite operation
  */
 export const castMutable = <T,>(readonlyValue: T): Mutable<T> =>
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
   readonlyValue as Mutable<T>;
 
 /**

package/src/others/cast-readonly.mts

@@ -1,3 +1,5 @@
+import { type DeepReadonly } from 'ts-type-forge';
+
 /**
  * Casts a mutable type `T` to its `Readonly<T>` equivalent.
  *
@@ -13,6 +15,7 @@
  * @see castMutable - For the opposite operation (use with caution)
  */
 export const castReadonly = <T,>(mutable: T): Readonly<T> =>
+  // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
   mutable as Readonly<T>;
 
 /**

package/src/others/debounce-function.test.mts

@@ -16,7 +16,6 @@ describe(debounce, () => {
   test('should delay the execution of the function', () => {
     const func = vi.fn();
 
-    // eslint-disable-next-line @typescript-eslint/strict-void-return
     const debouncedFunc = debounce(func, 100);
 
     debouncedFunc();
@@ -35,7 +34,6 @@ describe(debounce, () => {
   test('should only execute the function once after multiple rapid calls', () => {
     const func = vi.fn();
 
-    // eslint-disable-next-line @typescript-eslint/strict-void-return
     const debouncedFunc = debounce(func, 100);
 
     debouncedFunc();

package/src/others/fast-deep-equal.test.mts

@@ -3,8 +3,8 @@
 /* eslint-disable require-unicode-regexp */
 /* eslint-disable no-restricted-globals */
 /* eslint-disable functional/no-class-inheritance */
-
 import * as React from 'react';
+import { type ReadonlyRecord } from 'ts-type-forge';
 import { fastDeepEqual } from './fast-deep-equal.mjs';
 
 const fastDeepEqualUntyped = (a: any, b: any): boolean => fastDeepEqual(a, b);

package/src/others/map-nullable.test.mts

@@ -1,3 +1,4 @@
+import { type DeepReadonly } from 'ts-type-forge';
 import { expectType } from '../expect-type.mjs';
 import { pipe } from '../functional/index.mjs';
 import { mapNullable } from './map-nullable.mjs';

package/src/others/memoize-function.mts

@@ -1,3 +1,5 @@
+import { type Primitive } from 'ts-type-forge';
+
 /**
  * Creates a memoized version of a function that caches results based on input
  * arguments.

package/src/types.mts

@@ -0,0 +1,131 @@
+import {
+  type IndexOfTuple,
+  type IntersectBrand,
+  type IsFixedLengthList,
+  type NegativeIndexOfTuple,
+  type NegativeInt32,
+  type NormalizeBrandUnion,
+  type PositiveInt,
+  type PositiveNumber,
+  type Primitive,
+  type SafeInt,
+  type SafeUint,
+  type Uint32,
+  type WithSmallInt,
+} from 'ts-type-forge';
+
+export type SmallPositiveInt = WithSmallInt<PositiveInt>;
+
+/** Represents the type of keys that can be used in a standard JavaScript Map. */
+export type MapSetKeyType = Primitive;
+
+export type ArrayIndex<Ar extends readonly unknown[]> =
+  IsFixedLengthList<Ar> extends true ? IndexOfTuple<Ar> : SizeType.Arr;
+
+export type ArgArrayIndex<Ar extends readonly unknown[]> =
+  IsFixedLengthList<Ar> extends true ? IndexOfTuple<Ar> : SizeType.ArgArr;
+
+export type ArgArrayIndexWithNegative<Ar extends readonly unknown[]> =
+  IsFixedLengthList<Ar> extends true
+    ? IndexOfTuple<readonly [...Ar, 0]> | NegativeIndexOfTuple<Ar>
+    : SizeType.ArgArrWithNegative;
+
+// https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Array/length
+// https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/String/length
+// Max array length : 2^32 - 1
+// Max string length : 2^53 - 1
+
+export namespace SizeType {
+  export type Arr = Uint32;
+
+  export type TypedArray = SafeUint;
+
+  export type Str = SafeUint;
+
+  export type ArrSearchResult = Arr | -1;
+
+  export type TypedArraySearchResult = TypedArray | -1;
+
+  export type StrSearchResult = Str | -1;
+
+  export type ArgArr = WithSmallInt<Arr>;
+
+  export type ArgTypedArray = WithSmallInt<TypedArray>;
+
+  export type ArgStr = WithSmallInt<Str>;
+
+  export type ArgArrWithNegative = WithSmallInt<
+    NormalizeBrandUnion<NegativeInt32 | Arr>
+  >;
+
+  export type ArgTypedArrayWithNegative = WithSmallInt<SafeInt>;
+
+  export type ArgStrWithNegative = WithSmallInt<SafeInt>;
+
+  export type ArgArrPositive = WithSmallInt<
+    IntersectBrand<PositiveNumber, Arr>
+  >;
+
+  export type ArgTypedArrayPositive = WithSmallInt<
+    IntersectBrand<PositiveNumber, TypedArray>
+  >;
+
+  export type ArgStrPositive = WithSmallInt<
+    IntersectBrand<PositiveNumber, Str>
+  >;
+}
+
+// #region Optional
+/**
+ * Represents the 'Some' variant of an Optional, containing a value.
+ *
+ * @template S The type of the contained value.
+ */
+export type Some<S> = Readonly<{
+  /** @internal Discriminant property for the 'Some' type. */
+  $$tag: 'ts-data-forge::Optional.some';
+
+  /** The contained value. */
+  value: S;
+}>;
+
+/**
+ * Represents the 'None' variant of an Optional, indicating the absence
+ * of a value.
+ */
+export type None = Readonly<{
+  /** @internal Discriminant property for the 'None' type. */
+  $$tag: 'ts-data-forge::Optional.none';
+}>;
+
+// #endregion Optional
+
+// #region Result
+
+/**
+ * Represents a `Result` that is a success, containing a value.
+ *
+ * @template S The type of the success value.
+ */
+export type Ok<S> = Readonly<{
+  /** @internal Discriminant property for the 'Ok' type. */
+  $$tag: 'ts-data-forge::Result.ok';
+
+  /** The success value. */
+  value: S;
+}>;
+
+/**
+ * Represents a `Result` that is an error, containing an error value.
+ *
+ * @template E The type of the error value.
+ */
+export type Err<E> = Readonly<{
+  /** @internal Discriminant property for the 'Err' type. */
+  $$tag: 'ts-data-forge::Result.err';
+
+  /** The error value. */
+  value: E;
+}>;
+
+// #endregion Result

package/dist/globals.d.mts

@@ -1,194 +0,0 @@
-/// <reference types="ts-type-forge" />
-
-type SmallPositiveInt = WithSmallInt<PositiveInt>;
-
-/** Represents the type of keys that can be used in a standard JavaScript Map. */
-type MapSetKeyType = Primitive;
-
-type ArrayIndex<Ar extends readonly unknown[]> =
-  IsFixedLengthList<Ar> extends true ? IndexOfTuple<Ar> : SizeType.Arr;
-
-type ArgArrayIndex<Ar extends readonly unknown[]> =
-  IsFixedLengthList<Ar> extends true ? IndexOfTuple<Ar> : SizeType.ArgArr;
-
-type ArgArrayIndexWithNegative<Ar extends readonly unknown[]> =
-  IsFixedLengthList<Ar> extends true
-    ? IndexOfTuple<readonly [...Ar, 0]> | NegativeIndexOfTuple<Ar>
-    : SizeType.ArgArrWithNegative;
-
-// https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Array/length
-// https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/String/length
-// Max array length : 2^32 - 1
-// Max string length : 2^53 - 1
-
-declare namespace SizeType {
-  type Arr = Uint32;
-
-  type TypedArray = SafeUint;
-
-  type Str = SafeUint;
-
-  type ArrSearchResult = Arr | -1;
-
-  type TypedArraySearchResult = TypedArray | -1;
-
-  type StrSearchResult = Str | -1;
-
-  type ArgArr = WithSmallInt<Arr>;
-
-  type ArgTypedArray = WithSmallInt<TypedArray>;
-
-  type ArgStr = WithSmallInt<Str>;
-
-  type ArgArrWithNegative = WithSmallInt<
-    NormalizeBrandUnion<NegativeInt32 | Arr>
-  >;
-
-  type ArgTypedArrayWithNegative = WithSmallInt<SafeInt>;
-
-  type ArgStrWithNegative = WithSmallInt<SafeInt>;
-
-  type ArgArrPositive = WithSmallInt<IntersectBrand<PositiveNumber, Arr>>;
-
-  type ArgTypedArrayPositive = WithSmallInt<
-    IntersectBrand<PositiveNumber, TypedArray>
-  >;
-
-  type ArgStrPositive = WithSmallInt<IntersectBrand<PositiveNumber, Str>>;
-}
-
-// #region Optional
-/**
- * Represents the 'Some' variant of an {@link Optional}, containing a value.
- *
- * @template S The type of the contained value.
- */
-type Some<S> = Readonly<{
-  /** @internal Discriminant property for the 'Some' type. */
-  $$tag: 'ts-data-forge::Optional.some';
-
-  /** The contained value. */
-  value: S;
-}>;
-
-/**
- * Represents the 'None' variant of an {@link Optional}, indicating the absence
- * of a value.
- */
-type None = Readonly<{
-  /** @internal Discriminant property for the 'None' type. */
-  $$tag: 'ts-data-forge::Optional.none';
-}>;
-
-/**
- * Represents an optional value that can either be `Some` (containing a value)
- * or `None` (empty).
- *
- * @template S The type of the value that might be present.
- */
-type Optional<S> = None | Some<S>;
-
-/**
- * Base type for any {@link Optional}, used for generic constraints. Represents
- * an {@link Optional} with an unknown value type.
- */
-type UnknownOptional = Optional<unknown>;
-
-// #endregion Optional
-
-// #region Result
-
-/**
- * Represents a `Result` that is a success, containing a value.
- *
- * @template S The type of the success value.
- */
-type Ok<S> = Readonly<{
-  /** @internal Discriminant property for the 'Ok' type. */
-  $$tag: 'ts-data-forge::Result.ok';
-
-  /** The success value. */
-  value: S;
-}>;
-
-/**
- * Represents a `Result` that is an error, containing an error value.
- *
- * @template E The type of the error value.
- */
-type Err<E> = Readonly<{
-  /** @internal Discriminant property for the 'Err' type. */
-  $$tag: 'ts-data-forge::Result.err';
-
-  /** The error value. */
-  value: E;
-}>;
-
-/**
- * Represents a value that can either be a success (`Ok`) or an error (`Err`).
- *
- * @template S The type of the success value.
- * @template E The type of the error value.
- */
-type Result<S, E> = Ok<S> | Err<E>;
-
-/**
- * Base type for any `Result`, used for generic constraints. Represents a
- * `Result` with unknown success and error types.
- */
-type UnknownResult = Result<unknown, unknown>;
-
-// #endregion Result
-
-// #region TernaryResult
-/**
- * Represents a `TernaryResult` that is a success, containing a value.
- */
-type TernaryOk<S> = Readonly<{
-  /** @internal Discriminant property for the 'Ok' type. */
-  $$tag: 'ts-data-forge::Result.ok';
-
-  /** The success value. */
-  value: S;
-}>;
-
-/**
- * Represents a `TernaryResult` that contains a success value and an attached
- * warning.
- */
-type TernaryWarn<S, W> = Readonly<{
-  /** @internal Discriminant property for the 'Warn' type. */
-  $$tag: 'ts-data-forge::Result.warn';
-
-  /** The success value. */
-  value: S;
-
-  /** The warning value. */
-  warning: W;
-}>;
-
-/**
- * Represents a `TernaryResult` that is an error, containing an error value.
- */
-type TernaryErr<E> = Readonly<{
-  /** @internal Discriminant property for the 'Err' type. */
-  $$tag: 'ts-data-forge::Result.err';
-
-  /** The error value. */
-  value: E;
-}>;
-
-/**
- * Represents a value that can be `Ok`, `Warn`, or `Err`.
- */
-type TernaryResult<S, E, W = E> =
-  | TernaryOk<S>
-  | TernaryWarn<S, W>
-  | TernaryErr<E>;
-
-/**
- * Base type for any `TernaryResult`, used for generic constraints.
- */
-type UnknownTernaryResult = TernaryResult<unknown, unknown, unknown>;
-
-// #endregion TernaryResult

package/src/globals.d.mts

@@ -1,194 +0,0 @@
-/// <reference types="ts-type-forge" />
-
-type SmallPositiveInt = WithSmallInt<PositiveInt>;
-
-/** Represents the type of keys that can be used in a standard JavaScript Map. */
-type MapSetKeyType = Primitive;
-
-type ArrayIndex<Ar extends readonly unknown[]> =
-  IsFixedLengthList<Ar> extends true ? IndexOfTuple<Ar> : SizeType.Arr;
-
-type ArgArrayIndex<Ar extends readonly unknown[]> =
-  IsFixedLengthList<Ar> extends true ? IndexOfTuple<Ar> : SizeType.ArgArr;
-
-type ArgArrayIndexWithNegative<Ar extends readonly unknown[]> =
-  IsFixedLengthList<Ar> extends true
-    ? IndexOfTuple<readonly [...Ar, 0]> | NegativeIndexOfTuple<Ar>
-    : SizeType.ArgArrWithNegative;
-
-// https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/Array/length
-// https://developer.mozilla.org/ja/docs/Web/JavaScript/Reference/Global_Objects/String/length
-// Max array length : 2^32 - 1
-// Max string length : 2^53 - 1
-
-declare namespace SizeType {
-  type Arr = Uint32;
-
-  type TypedArray = SafeUint;
-
-  type Str = SafeUint;
-
-  type ArrSearchResult = Arr | -1;
-
-  type TypedArraySearchResult = TypedArray | -1;
-
-  type StrSearchResult = Str | -1;
-
-  type ArgArr = WithSmallInt<Arr>;
-
-  type ArgTypedArray = WithSmallInt<TypedArray>;
-
-  type ArgStr = WithSmallInt<Str>;
-
-  type ArgArrWithNegative = WithSmallInt<
-    NormalizeBrandUnion<NegativeInt32 | Arr>
-  >;
-
-  type ArgTypedArrayWithNegative = WithSmallInt<SafeInt>;
-
-  type ArgStrWithNegative = WithSmallInt<SafeInt>;
-
-  type ArgArrPositive = WithSmallInt<IntersectBrand<PositiveNumber, Arr>>;
-
-  type ArgTypedArrayPositive = WithSmallInt<
-    IntersectBrand<PositiveNumber, TypedArray>
-  >;
-
-  type ArgStrPositive = WithSmallInt<IntersectBrand<PositiveNumber, Str>>;
-}
-
-// #region Optional
-/**
- * Represents the 'Some' variant of an {@link Optional}, containing a value.
- *
- * @template S The type of the contained value.
- */
-type Some<S> = Readonly<{
-  /** @internal Discriminant property for the 'Some' type. */
-  $$tag: 'ts-data-forge::Optional.some';
-
-  /** The contained value. */
-  value: S;
-}>;
-
-/**
- * Represents the 'None' variant of an {@link Optional}, indicating the absence
- * of a value.
- */
-type None = Readonly<{
-  /** @internal Discriminant property for the 'None' type. */
-  $$tag: 'ts-data-forge::Optional.none';
-}>;
-
-/**
- * Represents an optional value that can either be `Some` (containing a value)
- * or `None` (empty).
- *
- * @template S The type of the value that might be present.
- */
-type Optional<S> = None | Some<S>;
-
-/**
- * Base type for any {@link Optional}, used for generic constraints. Represents
- * an {@link Optional} with an unknown value type.
- */
-type UnknownOptional = Optional<unknown>;
-
-// #endregion Optional
-
-// #region Result
-
-/**
- * Represents a `Result` that is a success, containing a value.
- *
- * @template S The type of the success value.
- */
-type Ok<S> = Readonly<{
-  /** @internal Discriminant property for the 'Ok' type. */
-  $$tag: 'ts-data-forge::Result.ok';
-
-  /** The success value. */
-  value: S;
-}>;
-
-/**
- * Represents a `Result` that is an error, containing an error value.
- *
- * @template E The type of the error value.
- */
-type Err<E> = Readonly<{
-  /** @internal Discriminant property for the 'Err' type. */
-  $$tag: 'ts-data-forge::Result.err';
-
-  /** The error value. */
-  value: E;
-}>;
-
-/**
- * Represents a value that can either be a success (`Ok`) or an error (`Err`).
- *
- * @template S The type of the success value.
- * @template E The type of the error value.
- */
-type Result<S, E> = Ok<S> | Err<E>;
-
-/**
- * Base type for any `Result`, used for generic constraints. Represents a
- * `Result` with unknown success and error types.
- */
-type UnknownResult = Result<unknown, unknown>;
-
-// #endregion Result
-
-// #region TernaryResult
-/**
- * Represents a `TernaryResult` that is a success, containing a value.
- */
-type TernaryOk<S> = Readonly<{
-  /** @internal Discriminant property for the 'Ok' type. */
-  $$tag: 'ts-data-forge::Result.ok';
-
-  /** The success value. */
-  value: S;
-}>;
-
-/**
- * Represents a `TernaryResult` that contains a success value and an attached
- * warning.
- */
-type TernaryWarn<S, W> = Readonly<{
-  /** @internal Discriminant property for the 'Warn' type. */
-  $$tag: 'ts-data-forge::Result.warn';
-
-  /** The success value. */
-  value: S;
-
-  /** The warning value. */
-  warning: W;
-}>;
-
-/**
- * Represents a `TernaryResult` that is an error, containing an error value.
- */
-type TernaryErr<E> = Readonly<{
-  /** @internal Discriminant property for the 'Err' type. */
-  $$tag: 'ts-data-forge::Result.err';
-
-  /** The error value. */
-  value: E;
-}>;
-
-/**
- * Represents a value that can be `Ok`, `Warn`, or `Err`.
- */
-type TernaryResult<S, E, W = E> =
-  | TernaryOk<S>
-  | TernaryWarn<S, W>
-  | TernaryErr<E>;
-
-/**
- * Base type for any `TernaryResult`, used for generic constraints.
- */
-type UnknownTernaryResult = TernaryResult<unknown, unknown, unknown>;
-
-// #endregion TernaryResult