ts-data-forge 6.13.1 → 7.0.0

package/src/number/branded-types/non-positive-safe-int.test.mts

@@ -0,0 +1,223 @@
+import { expectType } from '../../expect-type.mjs';
+import { range } from '../../iterator/index.mjs';
+import {
+  asNonPositiveSafeInt,
+  isNonPositiveSafeInt,
+  NonPositiveSafeInt,
+} from './non-positive-safe-int.mjs';
+
+describe('NonPositiveSafeInt test', () => {
+  describe(asNonPositiveSafeInt, () => {
+    test('accepts valid non-positive safe integer values', () => {
+      expect(() => asNonPositiveSafeInt(0)).not.toThrow();
+
+      expect(() => asNonPositiveSafeInt(-1)).not.toThrow();
+
+      expect(() => asNonPositiveSafeInt(-1000)).not.toThrow();
+
+      expect(() => asNonPositiveSafeInt(Number.MIN_SAFE_INTEGER)).not.toThrow();
+    });
+
+    test('rejects positive integers', () => {
+      expect(() => asNonPositiveSafeInt(1)).toThrow(TypeError);
+
+      expect(() => asNonPositiveSafeInt(42)).toThrow(TypeError);
+
+      expect(() => asNonPositiveSafeInt(Number.MAX_SAFE_INTEGER)).toThrow(
+        TypeError,
+      );
+    });
+
+    test('rejects values outside safe integer range', () => {
+      expect(() => asNonPositiveSafeInt(Number.MIN_SAFE_INTEGER - 1)).toThrow(
+        TypeError,
+      );
+
+      expect(() => asNonPositiveSafeInt(Number.MAX_SAFE_INTEGER + 1)).toThrow(
+        TypeError,
+      );
+    });
+
+    test('rejects non-integers', () => {
+      expect(() => asNonPositiveSafeInt(Number.NaN)).toThrow(TypeError);
+
+      expect(() => asNonPositiveSafeInt(Number.POSITIVE_INFINITY)).toThrow(
+        TypeError,
+      );
+
+      expect(() => asNonPositiveSafeInt(Number.NEGATIVE_INFINITY)).toThrow(
+        TypeError,
+      );
+
+      expect(() => asNonPositiveSafeInt(-1.2)).toThrow(TypeError);
+
+      expect(() => asNonPositiveSafeInt(3.4)).toThrow(TypeError);
+    });
+
+    test('returns the same value for valid inputs', () => {
+      expect(asNonPositiveSafeInt(0)).toBe(0);
+
+      expect(asNonPositiveSafeInt(-5)).toBe(-5);
+
+      expect(asNonPositiveSafeInt(Number.MIN_SAFE_INTEGER)).toBe(
+        Number.MIN_SAFE_INTEGER,
+      );
+    });
+
+    test('throws TypeError for invalid values', () => {
+      expect(() => asNonPositiveSafeInt(1)).toThrow(TypeError);
+
+      expect(() => asNonPositiveSafeInt(Number.MIN_SAFE_INTEGER - 1)).toThrow(
+        TypeError,
+      );
+
+      expect(() => asNonPositiveSafeInt(Number.NaN)).toThrow(TypeError);
+    });
+  });
+
+  describe(isNonPositiveSafeInt, () => {
+    test('correctly identifies non-positive safe integers', () => {
+      assert.isTrue(isNonPositiveSafeInt(0));
+
+      assert.isTrue(isNonPositiveSafeInt(-1));
+
+      assert.isTrue(isNonPositiveSafeInt(-1000));
+
+      assert.isTrue(isNonPositiveSafeInt(Number.MIN_SAFE_INTEGER));
+    });
+
+    test('correctly identifies positive integers', () => {
+      assert.isFalse(isNonPositiveSafeInt(1));
+
+      assert.isFalse(isNonPositiveSafeInt(42));
+
+      assert.isFalse(isNonPositiveSafeInt(Number.MAX_SAFE_INTEGER));
+    });
+
+    test('correctly identifies values outside safe integer range', () => {
+      assert.isFalse(isNonPositiveSafeInt(Number.MIN_SAFE_INTEGER - 1));
+
+      assert.isFalse(isNonPositiveSafeInt(Number.MAX_SAFE_INTEGER + 1));
+    });
+
+    test('correctly identifies non-integers', () => {
+      assert.isFalse(isNonPositiveSafeInt(Number.NaN));
+
+      assert.isFalse(isNonPositiveSafeInt(Number.POSITIVE_INFINITY));
+
+      assert.isFalse(isNonPositiveSafeInt(Number.NEGATIVE_INFINITY));
+
+      assert.isFalse(isNonPositiveSafeInt(-1.2));
+
+      assert.isFalse(isNonPositiveSafeInt(3.4));
+    });
+  });
+
+  describe('NonPositiveSafeInt.is', () => {
+    test('works as a type guard', () => {
+      const value: number = -42;
+
+      if (NonPositiveSafeInt.is(value)) {
+        expectType<typeof value, typeof value & NonPositiveSafeInt>('=');
+      }
+    });
+  });
+
+  describe('NonPositiveSafeInt.MIN_VALUE', () => {
+    test('is Number.MIN_SAFE_INTEGER', () => {
+      expect(NonPositiveSafeInt.MIN_VALUE).toBe(Number.MIN_SAFE_INTEGER);
+    });
+  });
+
+  describe('NonPositiveSafeInt.MAX_VALUE', () => {
+    test('is 0', () => {
+      expect(NonPositiveSafeInt.MAX_VALUE).toBe(0);
+    });
+  });
+
+  describe('NonPositiveSafeInt.min', () => {
+    test('returns the smaller value', () => {
+      expect(NonPositiveSafeInt.min(-5, -10)).toBe(-10);
+
+      expect(NonPositiveSafeInt.min(0, -1)).toBe(-1);
+    });
+
+    test('clamps to range when necessary', () => {
+      expect(NonPositiveSafeInt.min(-5, 10)).toBe(-5);
+
+      expect(NonPositiveSafeInt.min(5, 10)).toBe(0);
+    });
+  });
+
+  describe('NonPositiveSafeInt.max', () => {
+    test('returns the larger value', () => {
+      expect(NonPositiveSafeInt.max(-5, -10)).toBe(-5);
+
+      expect(NonPositiveSafeInt.max(-1, 0)).toBe(0);
+    });
+
+    test('clamps to range when necessary', () => {
+      expect(NonPositiveSafeInt.max(-5, -10)).toBe(-5);
+
+      expect(NonPositiveSafeInt.max(-5, 10)).toBe(0);
+    });
+  });
+
+  describe('NonPositiveSafeInt.clamp', () => {
+    test('returns the same value if within range', () => {
+      expect(NonPositiveSafeInt.clamp(-5)).toBe(-5);
+
+      expect(NonPositiveSafeInt.clamp(0)).toBe(0);
+
+      expect(NonPositiveSafeInt.clamp(-1000)).toBe(-1000);
+    });
+
+    test('clamps positive values to MAX_VALUE (0)', () => {
+      expect(NonPositiveSafeInt.clamp(5)).toBe(0);
+
+      expect(NonPositiveSafeInt.clamp(1000)).toBe(0);
+    });
+
+    test('clamps out-of-range negative values to MIN_VALUE', () => {
+      expect(NonPositiveSafeInt.clamp(Number.MIN_SAFE_INTEGER - 1)).toBe(
+        Number.MIN_SAFE_INTEGER,
+      );
+    });
+  });
+
+  describe('NonPositiveSafeInt.add', () => {
+    test('adds two non-positive integers', () => {
+      expect(NonPositiveSafeInt.add(-5, -3)).toBe(-8);
+
+      expect(NonPositiveSafeInt.add(0, -10)).toBe(-10);
+    });
+
+    test('clamps result to MAX_VALUE (0) when sum is positive', () => {
+      expect(NonPositiveSafeInt.add(-5, 10)).toBe(0);
+
+      expect(NonPositiveSafeInt.add(0, 0)).toBe(0);
+    });
+  });
+
+  describe('NonPositiveSafeInt.sub', () => {
+    test('subtracts two non-positive integers', () => {
+      expect(NonPositiveSafeInt.sub(-10, -3)).toBe(-7);
+
+      expect(NonPositiveSafeInt.sub(0, -5)).toBe(0);
+    });
+
+    test('clamps result to MAX_VALUE (0) when result is positive', () => {
+      expect(NonPositiveSafeInt.sub(-5, -10)).toBe(0);
+    });
+  });
+
+  describe('NonPositiveSafeInt.random', () => {
+    test('generates values within range', () => {
+      for (const _ of range(100)) {
+        const value = NonPositiveSafeInt.random();
+
+        assert.isTrue(isNonPositiveSafeInt(value));
+      }
+    });
+  });
+});

package/src/number/branded-types/non-zero-finite-number.mts

@@ -15,7 +15,6 @@ const typeNameInMessage = 'a non-zero finite number';
 
 const {
   abs,
-  add,
   castType,
   div,
   is,
@@ -24,7 +23,6 @@ const {
   mul,
   pow,
   randomNonZero: random,
-  sub,
 } = TsDataForgeInternals.RefinedNumberUtils.operatorsForFloat<
   ElementType,
   number,
@@ -169,24 +167,6 @@ export const NonZeroFiniteNumber = {
    */
   pow,
 
-  /**
-   * Adds two NonZeroFiniteNumber values.
-   *
-   * @param a The first NonZeroFiniteNumber.
-   * @param b The second NonZeroFiniteNumber.
-   * @returns `a + b` as a NonZeroFiniteNumber.
-   */
-  add,
-
-  /**
-   * Subtracts one NonZeroFiniteNumber from another.
-   *
-   * @param a The minuend NonZeroFiniteNumber.
-   * @param b The subtrahend NonZeroFiniteNumber.
-   * @returns `a - b` as a NonZeroFiniteNumber.
-   */
-  sub,
-
   /**
    * Multiplies two NonZeroFiniteNumber values.
    *
@@ -199,6 +179,10 @@ export const NonZeroFiniteNumber = {
   /**
    * Divides one NonZeroFiniteNumber by another.
    *
+   * Exact (non-flooring) division of two non-zero finite numbers is always
+   * non-zero, so this stays closed. For the non-closed operations (`add`/`sub`,
+   * whose result may be `0`) use {@link Num.add}/{@link Num.sub}.
+   *
    * @param a The dividend NonZeroFiniteNumber.
    * @param b The divisor NonZeroFiniteNumber.
    * @returns `a / b` as a NonZeroFiniteNumber.
@@ -213,10 +197,18 @@ expectType<
 
 expectType<
   keyof typeof NonZeroFiniteNumber,
-  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, never>
+  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<
+    ElementType,
+    never,
+    'div' | 'mul'
+  >
 >('=');
 
 expectType<
   typeof NonZeroFiniteNumber,
-  TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, never>
+  TsDataForgeInternals.RefinedNumberUtils.NumberClass<
+    ElementType,
+    never,
+    'div' | 'mul'
+  >
 >('<=');

package/src/number/branded-types/non-zero-finite-number.test.mts

@@ -146,18 +146,6 @@ describe('NonZeroFiniteNumber test', () => {
       expect(NonZeroFiniteNumber.round(c)).toBe(-3);
     });
 
-    test('add', () => {
-      expect(NonZeroFiniteNumber.add(a, b)).toBe(8);
-
-      expect(NonZeroFiniteNumber.add(a, c)).toBe(2);
-    });
-
-    test('sub', () => {
-      expect(NonZeroFiniteNumber.sub(a, b)).toBe(3);
-
-      expect(NonZeroFiniteNumber.sub(a, c)).toBe(9);
-    });
-
     test('mul', () => {
       expect(NonZeroFiniteNumber.mul(a, b)).toBe(13.75);
 

package/src/number/branded-types/non-zero-int.mts

@@ -10,16 +10,13 @@ const typeNameInMessage = 'a non-zero integer';
 
 const {
   abs,
-  add,
   castType,
-  div,
   is,
   max: max_,
   min: min_,
   mul,
   pow,
   randomNonZero: random,
-  sub,
 } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<
   ElementType,
   number,
@@ -107,49 +104,30 @@ export const NonZeroInt = {
    */
   pow,
 
-  /**
-   * Adds two non-zero integers.
-   *
-   * @param a The first non-zero integer.
-   * @param b The second non-zero integer.
-   * @returns `a + b` as a NonZeroInt.
-   */
-  add,
-
-  /**
-   * Subtracts one non-zero integer from another.
-   *
-   * @param a The minuend non-zero integer.
-   * @param b The subtrahend non-zero integer.
-   * @returns `a - b` as a NonZeroInt.
-   */
-  sub,
-
   /**
    * Multiplies two non-zero integers.
    *
+   * The product of two non-zero integers is always non-zero, so this stays
+   * closed; for the non-closed operations (`add`/`sub`/`div`, whose result may
+   * be `0`) use {@link Num.add}/{@link Num.sub}/{@link Num.divInt}.
+   *
    * @param a The first non-zero integer.
    * @param b The second non-zero integer.
    * @returns `a * b` as a NonZeroInt.
    */
   mul,
-
-  /**
-   * Divides one non-zero integer by another using floor division.
-   *
-   * @param a The dividend non-zero integer.
-   * @param b The divisor non-zero integer.
-   * @returns `⌊a / b⌋` as a NonZeroInt.
-   */
-  div,
 } as const;
 
 expectType<
   keyof typeof NonZeroInt,
-  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'int'>
+  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<
+    ElementType,
+    'int',
+    'mul'
+  >
 >('=');
 
 expectType<
   typeof NonZeroInt,
-  TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'int'>
+  TsDataForgeInternals.RefinedNumberUtils.NumberClass<ElementType, 'int', 'mul'>
 >('<=');

package/src/number/branded-types/non-zero-int.test.mts

@@ -127,32 +127,12 @@ describe('NonZeroInt test', () => {
       expect(NonZeroInt.max(a, c)).toBe(5);
     });
 
-    test('add', () => {
-      expect(NonZeroInt.add(a, b)).toBe(7);
-
-      expect(NonZeroInt.add(a, c)).toBe(2);
-    });
-
-    test('sub', () => {
-      expect(NonZeroInt.sub(a, b)).toBe(3);
-
-      expect(NonZeroInt.sub(a, c)).toBe(8);
-    });
-
     test('mul', () => {
       expect(NonZeroInt.mul(a, b)).toBe(10);
 
       expect(NonZeroInt.mul(a, c)).toBe(-15);
     });
 
-    test('div (floor division)', () => {
-      expect(NonZeroInt.div(a, b)).toBe(2);
-
-      expect(NonZeroInt.div(asNonZeroInt(7), asNonZeroInt(3))).toBe(2);
-
-      expect(NonZeroInt.div(asNonZeroInt(-7), asNonZeroInt(3))).toBe(-3);
-    });
-
     test('pow', () => {
       expect(NonZeroInt.pow(asNonZeroInt(2), asNonZeroInt(3))).toBe(8);
 

package/src/number/branded-types/non-zero-int16.mts

@@ -12,17 +12,14 @@ const {
   MAX_VALUE,
   MIN_VALUE,
   abs,
-  add,
   castType,
   clamp,
-  div,
   is,
   max: max_,
   min: min_,
   mul,
   pow,
   randomNonZero: random,
-  sub,
 } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<
   ElementType,
   number,
@@ -137,48 +134,26 @@ export const NonZeroInt16 = {
    */
   pow,
 
-  /**
-   * Adds two NonZeroInt16 values.
-   *
-   * @param a The first NonZeroInt16.
-   * @param b The second NonZeroInt16.
-   * @returns `a + b` clamped to [-32768, 32767] as a NonZeroInt16.
-   */
-  add,
-
-  /**
-   * Subtracts one NonZeroInt16 from another.
-   *
-   * @param a The minuend NonZeroInt16.
-   * @param b The subtrahend NonZeroInt16.
-   * @returns `a - b` clamped to [-32768, 32767] as a NonZeroInt16.
-   */
-  sub,
-
   /**
    * Multiplies two NonZeroInt16 values.
    *
+   * The product of two non-zero integers is always non-zero, so this stays
+   * closed; for the non-closed operations (`add`/`sub`/`div`, whose result may
+   * be `0`) use {@link Num.add}/{@link Num.sub}/{@link Num.divInt}.
+   *
    * @param a The first NonZeroInt16.
    * @param b The second NonZeroInt16.
    * @returns `a * b` clamped to [-32768, 32767] as a NonZeroInt16.
    */
   mul,
-
-  /**
-   * Divides one NonZeroInt16 by another using floor division.
-   *
-   * @param a The dividend NonZeroInt16.
-   * @param b The divisor NonZeroInt16.
-   * @returns `⌊a / b⌋` clamped to [-32768, 32767] as a NonZeroInt16.
-   */
-  div,
 } as const;
 
 expectType<
   keyof typeof NonZeroInt16,
   keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<
     ElementType,
-    'int' | 'range'
+    'int' | 'range',
+    'mul'
   >
 >('=');
 
@@ -186,6 +161,7 @@ expectType<
   typeof NonZeroInt16,
   TsDataForgeInternals.RefinedNumberUtils.NumberClass<
     ElementType,
-    'int' | 'range'
+    'int' | 'range',
+    'mul'
   >
 >('<=');

package/src/number/branded-types/non-zero-int16.test.mts

@@ -154,28 +154,6 @@ describe('NonZeroInt16 test', () => {
       expect(NonZeroInt16.max(a, c)).toBe(100);
     });
 
-    test('add (with clamping)', () => {
-      const result = NonZeroInt16.add(
-        asNonZeroInt16(32_000),
-        asNonZeroInt16(1000),
-      );
-
-      expect(result).toBe(32_767); // clamped to max
-
-      expect(NonZeroInt16.add(a, b)).toBe(150);
-    });
-
-    test('sub (with clamping)', () => {
-      const result = NonZeroInt16.sub(
-        asNonZeroInt16(-32_000),
-        asNonZeroInt16(1000),
-      );
-
-      expect(result).toBe(-32_768); // clamped to min
-
-      expect(NonZeroInt16.sub(a, b)).toBe(50);
-    });
-
     test('mul (with clamping)', () => {
       const result = NonZeroInt16.mul(
         asNonZeroInt16(1000),
@@ -187,14 +165,6 @@ describe('NonZeroInt16 test', () => {
       expect(NonZeroInt16.mul(asNonZeroInt16(10), asNonZeroInt16(5))).toBe(50);
     });
 
-    test('div (floor division with clamping)', () => {
-      expect(NonZeroInt16.div(a, asNonZeroInt16(50))).toBe(2);
-
-      expect(NonZeroInt16.div(asNonZeroInt16(7), asNonZeroInt16(3))).toBe(2);
-
-      expect(NonZeroInt16.div(asNonZeroInt16(-7), asNonZeroInt16(3))).toBe(-3);
-    });
-
     test('pow (with clamping)', () => {
       const result = NonZeroInt16.pow(asNonZeroInt16(200), asNonZeroInt16(3));
 

package/src/number/branded-types/non-zero-int32.mts

@@ -12,17 +12,14 @@ const {
   MAX_VALUE,
   MIN_VALUE,
   abs,
-  add,
   castType,
   clamp,
-  div,
   is,
   max: max_,
   min: min_,
   mul,
   pow,
   randomNonZero: random,
-  sub,
 } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<
   ElementType,
   number,
@@ -138,48 +135,26 @@ export const NonZeroInt32 = {
    */
   pow,
 
-  /**
-   * Adds two NonZeroInt32 values.
-   *
-   * @param a The first NonZeroInt32.
-   * @param b The second NonZeroInt32.
-   * @returns `a + b` clamped to [-2147483648, 2147483647] as a NonZeroInt32.
-   */
-  add,
-
-  /**
-   * Subtracts one NonZeroInt32 from another.
-   *
-   * @param a The minuend NonZeroInt32.
-   * @param b The subtrahend NonZeroInt32.
-   * @returns `a - b` clamped to [-2147483648, 2147483647] as a NonZeroInt32.
-   */
-  sub,
-
   /**
    * Multiplies two NonZeroInt32 values.
    *
+   * The product of two non-zero integers is always non-zero, so this stays
+   * closed; for the non-closed operations (`add`/`sub`/`div`, whose result may
+   * be `0`) use {@link Num.add}/{@link Num.sub}/{@link Num.divInt}.
+   *
    * @param a The first NonZeroInt32.
    * @param b The second NonZeroInt32.
    * @returns `a * b` clamped to [-2147483648, 2147483647] as a NonZeroInt32.
    */
   mul,
-
-  /**
-   * Divides one NonZeroInt32 by another using floor division.
-   *
-   * @param a The dividend NonZeroInt32.
-   * @param b The divisor NonZeroInt32.
-   * @returns `⌊a / b⌋` clamped to [-2147483648, 2147483647] as a NonZeroInt32.
-   */
-  div,
 } as const;
 
 expectType<
   keyof typeof NonZeroInt32,
   keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<
     ElementType,
-    'int' | 'range'
+    'int' | 'range',
+    'mul'
   >
 >('=');
 
@@ -187,6 +162,7 @@ expectType<
   typeof NonZeroInt32,
   TsDataForgeInternals.RefinedNumberUtils.NumberClass<
     ElementType,
-    'int' | 'range'
+    'int' | 'range',
+    'mul'
   >
 >('<=');

package/src/number/branded-types/non-zero-int32.test.mts

@@ -154,28 +154,6 @@ describe('NonZeroInt32 test', () => {
       expect(NonZeroInt32.max(a, c)).toBe(1_000_000);
     });
 
-    test('add (with clamping)', () => {
-      const result = NonZeroInt32.add(
-        asNonZeroInt32(2_147_483_000),
-        asNonZeroInt32(1000),
-      );
-
-      expect(result).toBe(2_147_483_647); // clamped to max
-
-      expect(NonZeroInt32.add(a, b)).toBe(1_500_000);
-    });
-
-    test('sub (with clamping)', () => {
-      const result = NonZeroInt32.sub(
-        asNonZeroInt32(-2_147_483_000),
-        asNonZeroInt32(1000),
-      );
-
-      expect(result).toBe(-2_147_483_648); // clamped to min
-
-      expect(NonZeroInt32.sub(a, b)).toBe(500_000);
-    });
-
     test('mul (with clamping)', () => {
       const result = NonZeroInt32.mul(
         asNonZeroInt32(100_000),
@@ -189,14 +167,6 @@ describe('NonZeroInt32 test', () => {
       );
     });
 
-    test('div (floor division with clamping)', () => {
-      expect(NonZeroInt32.div(a, asNonZeroInt32(500_000))).toBe(2);
-
-      expect(NonZeroInt32.div(asNonZeroInt32(7), asNonZeroInt32(3))).toBe(2);
-
-      expect(NonZeroInt32.div(asNonZeroInt32(-7), asNonZeroInt32(3))).toBe(-3);
-    });
-
     test('pow (with clamping)', () => {
       const result = NonZeroInt32.pow(
         asNonZeroInt32(10_000),