ts-data-forge 1.0.0

package/src/number/branded-types/positive-int16.mts

@@ -0,0 +1,188 @@
+import { expectType } from '../../expect-type.mjs';
+import { TsVerifiedInternals } from '../refined-number-utils.mjs';
+
+type ElementType = PositiveInt16;
+
+const typeNameInMessage = 'a positive integer in [1, 2^15)';
+
+const {
+  MIN_VALUE,
+  MAX_VALUE,
+  min: min_,
+  max: max_,
+  pow,
+  add,
+  sub,
+  mul,
+  div,
+  random,
+  is,
+  castType,
+  clamp,
+} = TsVerifiedInternals.RefinedNumberUtils.operatorsForInteger<
+  ElementType,
+  1,
+  number
+>({
+  integerOrSafeInteger: 'SafeInteger',
+  MIN_VALUE: 1,
+  MAX_VALUE: 2 ** 15 - 1,
+  typeNameInMessage,
+} as const);
+
+/**
+ * Checks if a number is a PositiveInt16 (16-bit positive signed integer in the range [1, 2^15)).
+ * @param value The value to check.
+ * @returns `true` if the value is a PositiveInt16, `false` otherwise.
+ */
+export const isPositiveInt16 = is;
+
+/**
+ * Casts a number to a PositiveInt16 type.
+ * @param value The value to cast.
+ * @returns The value as a PositiveInt16 type.
+ * @throws {TypeError} If the value is not a positive integer in [1, 2^15).
+ * @example
+ * ```typescript
+ * const x = asPositiveInt16(1000); // PositiveInt16
+ * const y = asPositiveInt16(32767); // PositiveInt16
+ * // asPositiveInt16(0); // throws TypeError
+ * // asPositiveInt16(-1); // throws TypeError
+ * // asPositiveInt16(32768); // throws TypeError
+ * ```
+ */
+export const asPositiveInt16 = castType;
+
+/**
+ * Namespace providing type-safe arithmetic operations for 16-bit positive integers.
+ *
+ * All operations automatically clamp results to the valid PositiveInt16 range [1, 32767].
+ * This ensures that all arithmetic maintains the 16-bit positive integer constraint,
+ * with results below 1 clamped to MIN_VALUE and overflow results clamped to MAX_VALUE.
+ *
+ * @example
+ * ```typescript
+ * const a = asPositiveInt16(30000);
+ * const b = asPositiveInt16(5000);
+ *
+ * // Arithmetic operations with automatic clamping
+ * const sum = PositiveInt16.add(a, b);       // PositiveInt16 (32767 - clamped to MAX_VALUE)
+ * const diff = PositiveInt16.sub(a, b);      // PositiveInt16 (25000)
+ * const reverseDiff = PositiveInt16.sub(b, a); // PositiveInt16 (1 - clamped to MIN_VALUE)
+ * const product = PositiveInt16.mul(a, b);   // PositiveInt16 (32767 - clamped due to overflow)
+ *
+ * // Range operations
+ * const clamped = PositiveInt16.clamp(0);        // PositiveInt16 (1)
+ * const minimum = PositiveInt16.min(a, b);       // PositiveInt16 (5000)
+ * const maximum = PositiveInt16.max(a, b);       // PositiveInt16 (30000)
+ *
+ * // Utility operations
+ * const random = PositiveInt16.random();         // PositiveInt16 (random value in [1, 32767])
+ * const power = PositiveInt16.pow(asPositiveInt16(2), asPositiveInt16(10)); // PositiveInt16 (1024)
+ * ```
+ */
+export const PositiveInt16 = {
+  /**
+   * Type guard to check if a value is a PositiveInt16.
+   * @param value The value to check.
+   * @returns `true` if the value is a 16-bit positive integer, `false` otherwise.
+   */
+  is,
+
+  /**
+   * The minimum value for a 16-bit positive integer.
+   * @readonly
+   */
+  MIN_VALUE,
+
+  /**
+   * The maximum value for a 16-bit positive integer.
+   * @readonly
+   */
+  MAX_VALUE,
+
+  /**
+   * Returns the smaller of two PositiveInt16 values.
+   * @param a The first PositiveInt16.
+   * @param b The second PositiveInt16.
+   * @returns The minimum value as a PositiveInt16.
+   */
+  min: min_,
+
+  /**
+   * Returns the larger of two PositiveInt16 values.
+   * @param a The first PositiveInt16.
+   * @param b The second PositiveInt16.
+   * @returns The maximum value as a PositiveInt16.
+   */
+  max: max_,
+
+  /**
+   * Clamps a number to the PositiveInt16 range.
+   * @param value The number to clamp.
+   * @returns The value clamped to [1, 32767] as a PositiveInt16.
+   */
+  clamp,
+
+  /**
+   * Generates a random PositiveInt16 value within the valid range.
+   * @returns A random PositiveInt16 between 1 and 32767.
+   */
+  random,
+
+  /**
+   * Raises a PositiveInt16 to the power of another PositiveInt16.
+   * @param a The base PositiveInt16.
+   * @param b The exponent PositiveInt16.
+   * @returns `a ** b` clamped to [1, 32767] as a PositiveInt16.
+   */
+  pow,
+
+  /**
+   * Adds two PositiveInt16 values.
+   * @param a The first PositiveInt16.
+   * @param b The second PositiveInt16.
+   * @returns `a + b` clamped to [1, 32767] as a PositiveInt16.
+   */
+  add,
+
+  /**
+   * Subtracts one PositiveInt16 from another.
+   * @param a The minuend PositiveInt16.
+   * @param b The subtrahend PositiveInt16.
+   * @returns `a - b` clamped to [1, 32767] as a PositiveInt16 (minimum 1).
+   */
+  sub,
+
+  /**
+   * Multiplies two PositiveInt16 values.
+   * @param a The first PositiveInt16.
+   * @param b The second PositiveInt16.
+   * @returns `a * b` clamped to [1, 32767] as a PositiveInt16.
+   */
+  mul,
+
+  /**
+   * Divides one PositiveInt16 by another using floor division.
+   * @param a The dividend PositiveInt16.
+   * @param b The divisor PositiveInt16.
+   * @returns `⌊a / b⌋` clamped to [1, 32767] as a PositiveInt16.
+   */
+  div,
+} as const;
+
+expectType<
+  keyof typeof PositiveInt16,
+  keyof TsVerifiedInternals.RefinedNumberUtils.NumberClass<
+    ElementType,
+    'int' | 'positive' | 'range'
+  >
+>('=');
+
+expectType<
+  typeof PositiveInt16,
+  TsVerifiedInternals.RefinedNumberUtils.NumberClass<
+    ElementType,
+    'int' | 'positive' | 'range'
+  >
+>('<=');

package/src/number/branded-types/positive-int16.test.mts

@@ -0,0 +1,197 @@
+import { expectType } from '../../expect-type.mjs';
+import {
+  asPositiveInt16,
+  isPositiveInt16,
+  PositiveInt16,
+} from './positive-int16.mjs';
+
+describe('PositiveInt16', () => {
+  describe('asPositiveInt16', () => {
+    test('accepts valid positive int16 values', () => {
+      expect(() => asPositiveInt16(1)).not.toThrow();
+      expect(() => asPositiveInt16(1000)).not.toThrow();
+      expect(() => asPositiveInt16(32767)).not.toThrow(); // 2^15 - 1
+    });
+
+    test('rejects zero', () => {
+      expect(() => asPositiveInt16(0)).toThrow(TypeError);
+    });
+
+    test('rejects values outside int16 range', () => {
+      expect(() => asPositiveInt16(32768)).toThrow(TypeError); // 2^15
+      expect(() => asPositiveInt16(65536)).toThrow(TypeError);
+    });
+
+    test('rejects negative integers', () => {
+      expect(() => asPositiveInt16(-1)).toThrow(TypeError);
+      expect(() => asPositiveInt16(-42)).toThrow(TypeError);
+    });
+
+    test('rejects non-integers', () => {
+      expect(() => asPositiveInt16(Number.NaN)).toThrow(TypeError);
+      expect(() => asPositiveInt16(Number.POSITIVE_INFINITY)).toThrow(
+        TypeError,
+      );
+      expect(() => asPositiveInt16(Number.NEGATIVE_INFINITY)).toThrow(
+        TypeError,
+      );
+      expect(() => asPositiveInt16(1.2)).toThrow(TypeError);
+      expect(() => asPositiveInt16(-3.4)).toThrow(TypeError);
+    });
+
+    test('returns the same value for valid inputs', () => {
+      expect(asPositiveInt16(5)).toBe(5);
+      expect(asPositiveInt16(1)).toBe(1);
+      expect(asPositiveInt16(32767)).toBe(32767);
+    });
+
+    test.each([
+      { name: 'Number.NaN', value: Number.NaN },
+      { name: 'Number.POSITIVE_INFINITY', value: Number.POSITIVE_INFINITY },
+      { name: 'Number.NEGATIVE_INFINITY', value: Number.NEGATIVE_INFINITY },
+      { name: '1.2', value: 1.2 },
+      { name: '-3.4', value: -3.4 },
+      { name: '0', value: 0 },
+      { name: '-1', value: -1 },
+      { name: '32768', value: 32768 },
+    ] as const)(
+      `asPositiveInt16($name) should throw a TypeError`,
+      ({ value }) => {
+        expect(() => asPositiveInt16(value)).toThrow(
+          new TypeError(
+            `Expected a positive integer in [1, 2^15), got: ${value}`,
+          ),
+        );
+      },
+    );
+  });
+
+  describe('isPositiveInt16', () => {
+    test('correctly identifies positive int16 values', () => {
+      expect(isPositiveInt16(1)).toBe(true);
+      expect(isPositiveInt16(1000)).toBe(true);
+      expect(isPositiveInt16(32767)).toBe(true);
+    });
+
+    test('correctly identifies zero', () => {
+      expect(isPositiveInt16(0)).toBe(false);
+    });
+
+    test('correctly identifies values outside int16 range', () => {
+      expect(isPositiveInt16(32768)).toBe(false);
+      expect(isPositiveInt16(65536)).toBe(false);
+    });
+
+    test('correctly identifies negative integers', () => {
+      expect(isPositiveInt16(-1)).toBe(false);
+      expect(isPositiveInt16(-42)).toBe(false);
+    });
+
+    test('correctly identifies non-integers', () => {
+      expect(isPositiveInt16(Number.NaN)).toBe(false);
+      expect(isPositiveInt16(Number.POSITIVE_INFINITY)).toBe(false);
+      expect(isPositiveInt16(Number.NEGATIVE_INFINITY)).toBe(false);
+      expect(isPositiveInt16(1.2)).toBe(false);
+      expect(isPositiveInt16(-3.4)).toBe(false);
+    });
+  });
+
+  describe('PositiveInt16.is', () => {
+    test('same as isPositiveInt16 function', () => {
+      expect(PositiveInt16.is(5)).toBe(isPositiveInt16(5));
+      expect(PositiveInt16.is(0)).toBe(isPositiveInt16(0));
+      expect(PositiveInt16.is(-1)).toBe(isPositiveInt16(-1));
+    });
+  });
+
+  describe('constants', () => {
+    test('MIN_VALUE and MAX_VALUE', () => {
+      expect(PositiveInt16.MIN_VALUE).toBe(1);
+      expect(PositiveInt16.MAX_VALUE).toBe(32767);
+    });
+  });
+
+  describe('mathematical operations', () => {
+    const a = asPositiveInt16(100);
+    const b = asPositiveInt16(50);
+
+    test('min and max', () => {
+      expect(PositiveInt16.min(a, b)).toBe(50);
+      expect(PositiveInt16.max(a, b)).toBe(100);
+    });
+
+    test('add (with clamping to positive int16 range)', () => {
+      const result = PositiveInt16.add(
+        asPositiveInt16(32000),
+        asPositiveInt16(1000),
+      );
+      expect(result).toBe(32767); // clamped to max
+      expect(PositiveInt16.add(a, b)).toBe(150);
+    });
+
+    test('sub (never goes below 1)', () => {
+      expect(PositiveInt16.sub(a, b)).toBe(50);
+      expect(PositiveInt16.sub(b, a)).toBe(1); // clamped to 1
+    });
+
+    test('mul (with clamping to positive int16 range)', () => {
+      const result = PositiveInt16.mul(
+        asPositiveInt16(1000),
+        asPositiveInt16(100),
+      );
+      expect(result).toBe(32767); // clamped to max
+      expect(PositiveInt16.mul(asPositiveInt16(10), asPositiveInt16(5))).toBe(
+        50,
+      );
+    });
+
+    test('div (floor division, never goes below 1)', () => {
+      expect(PositiveInt16.div(a, asPositiveInt16(50))).toBe(2);
+      expect(PositiveInt16.div(asPositiveInt16(7), asPositiveInt16(3))).toBe(2);
+      expect(PositiveInt16.div(asPositiveInt16(50), asPositiveInt16(100))).toBe(
+        1,
+      ); // floor(50/100) = 0, clamped to 1
+    });
+
+    test('pow (with clamping to positive int16 range)', () => {
+      const result = PositiveInt16.pow(
+        asPositiveInt16(200),
+        asPositiveInt16(3),
+      );
+      expect(result).toBe(32767); // clamped to max
+      expect(PositiveInt16.pow(asPositiveInt16(2), asPositiveInt16(3))).toBe(8);
+    });
+  });
+
+  describe('random', () => {
+    test('generates positive int16 values within specified range', () => {
+      const min = 1;
+      const max = 20;
+
+      for (let i = 0; i < 10; i++) {
+        const result = PositiveInt16.random(min, max);
+        expect(result).toBeGreaterThanOrEqual(min);
+        expect(result).toBeLessThanOrEqual(max);
+        expect(PositiveInt16.is(result)).toBe(true);
+        expect(Number.isInteger(result)).toBe(true);
+        expect(result).toBeGreaterThan(0);
+      }
+    });
+
+    test('generates values within PositiveInt16 range', () => {
+      for (let i = 0; i < 10; i++) {
+        const result = PositiveInt16.random(1, 30);
+        expect(result).toBeGreaterThanOrEqual(1);
+        expect(result).toBeLessThanOrEqual(32767);
+      }
+    });
+  });
+
+  describe('type assertions', () => {
+    test('type relationships', () => {
+      expectType<PositiveInt16, number>('<=');
+
+      expectTypeOf(asPositiveInt16(100)).toExtend<PositiveInt16>();
+    });
+  });
+});

package/src/number/branded-types/positive-int32.mts

@@ -0,0 +1,188 @@
+import { expectType } from '../../expect-type.mjs';
+import { TsVerifiedInternals } from '../refined-number-utils.mjs';
+
+type ElementType = PositiveInt32;
+
+const typeNameInMessage = 'a positive integer in [1, 2^31)';
+
+const {
+  MIN_VALUE,
+  MAX_VALUE,
+  min: min_,
+  max: max_,
+  pow,
+  add,
+  sub,
+  mul,
+  div,
+  random,
+  is,
+  castType,
+  clamp,
+} = TsVerifiedInternals.RefinedNumberUtils.operatorsForInteger<
+  ElementType,
+  1,
+  number
+>({
+  integerOrSafeInteger: 'SafeInteger',
+  MIN_VALUE: 1,
+  MAX_VALUE: 2 ** 31 - 1,
+  typeNameInMessage,
+} as const);
+
+/**
+ * Checks if a number is a PositiveInt32 (32-bit positive signed integer in the range [1, 2^31)).
+ * @param value The value to check.
+ * @returns `true` if the value is a PositiveInt32, `false` otherwise.
+ */
+export const isPositiveInt32 = is;
+
+/**
+ * Casts a number to a PositiveInt32 type.
+ * @param value The value to cast.
+ * @returns The value as a PositiveInt32 type.
+ * @throws {TypeError} If the value is not a positive integer in [1, 2^31).
+ * @example
+ * ```typescript
+ * const x = asPositiveInt32(1000); // PositiveInt32
+ * const y = asPositiveInt32(2147483647); // PositiveInt32
+ * // asPositiveInt32(0); // throws TypeError
+ * // asPositiveInt32(-1); // throws TypeError
+ * // asPositiveInt32(2147483648); // throws TypeError
+ * ```
+ */
+export const asPositiveInt32 = castType;
+
+/**
+ * Namespace providing type-safe arithmetic operations for 32-bit positive integers.
+ *
+ * All operations automatically clamp results to the valid PositiveInt32 range [1, 2147483647].
+ * This ensures that all arithmetic maintains the 32-bit positive integer constraint,
+ * with results below 1 clamped to MIN_VALUE and overflow results clamped to MAX_VALUE.
+ *
+ * @example
+ * ```typescript
+ * const a = asPositiveInt32(2000000000);
+ * const b = asPositiveInt32(500000000);
+ *
+ * // Arithmetic operations with automatic clamping and positive constraint
+ * const sum = PositiveInt32.add(a, b);       // PositiveInt32 (2147483647 - clamped to MAX_VALUE)
+ * const diff = PositiveInt32.sub(a, b);      // PositiveInt32 (1500000000)
+ * const reverseDiff = PositiveInt32.sub(b, a); // PositiveInt32 (1 - clamped to MIN_VALUE)
+ * const product = PositiveInt32.mul(a, b);   // PositiveInt32 (2147483647 - clamped due to overflow)
+ *
+ * // Range operations (maintaining positive constraint)
+ * const clamped = PositiveInt32.clamp(-1000);     // PositiveInt32 (1)
+ * const minimum = PositiveInt32.min(a, b);        // PositiveInt32 (500000000)
+ * const maximum = PositiveInt32.max(a, b);        // PositiveInt32 (2000000000)
+ *
+ * // Utility operations
+ * const random = PositiveInt32.random();          // PositiveInt32 (random value in [1, 2147483647])
+ * const power = PositiveInt32.pow(asPositiveInt32(2), asPositiveInt32(20)); // PositiveInt32 (1048576)
+ * ```
+ */
+export const PositiveInt32 = {
+  /**
+   * Type guard to check if a value is a PositiveInt32.
+   * @param value The value to check.
+   * @returns `true` if the value is a 32-bit positive integer, `false` otherwise.
+   */
+  is,
+
+  /**
+   * The minimum value for a 32-bit positive integer.
+   * @readonly
+   */
+  MIN_VALUE,
+
+  /**
+   * The maximum value for a 32-bit positive integer.
+   * @readonly
+   */
+  MAX_VALUE,
+
+  /**
+   * Returns the smaller of two PositiveInt32 values.
+   * @param a The first PositiveInt32.
+   * @param b The second PositiveInt32.
+   * @returns The minimum value as a PositiveInt32.
+   */
+  min: min_,
+
+  /**
+   * Returns the larger of two PositiveInt32 values.
+   * @param a The first PositiveInt32.
+   * @param b The second PositiveInt32.
+   * @returns The maximum value as a PositiveInt32.
+   */
+  max: max_,
+
+  /**
+   * Clamps a number to the PositiveInt32 range.
+   * @param value The number to clamp.
+   * @returns The value clamped to [1, 2147483647] as a PositiveInt32.
+   */
+  clamp,
+
+  /**
+   * Generates a random PositiveInt32 value within the valid range.
+   * @returns A random PositiveInt32 between 1 and 2147483647.
+   */
+  random,
+
+  /**
+   * Raises a PositiveInt32 to the power of another PositiveInt32.
+   * @param a The base PositiveInt32.
+   * @param b The exponent PositiveInt32.
+   * @returns `a ** b` clamped to [1, 2147483647] as a PositiveInt32.
+   */
+  pow,
+
+  /**
+   * Adds two PositiveInt32 values.
+   * @param a The first PositiveInt32.
+   * @param b The second PositiveInt32.
+   * @returns `a + b` clamped to [1, 2147483647] as a PositiveInt32.
+   */
+  add,
+
+  /**
+   * Subtracts one PositiveInt32 from another.
+   * @param a The minuend PositiveInt32.
+   * @param b The subtrahend PositiveInt32.
+   * @returns `a - b` clamped to [1, 2147483647] as a PositiveInt32 (minimum 1).
+   */
+  sub,
+
+  /**
+   * Multiplies two PositiveInt32 values.
+   * @param a The first PositiveInt32.
+   * @param b The second PositiveInt32.
+   * @returns `a * b` clamped to [1, 2147483647] as a PositiveInt32.
+   */
+  mul,
+
+  /**
+   * Divides one PositiveInt32 by another using floor division.
+   * @param a The dividend PositiveInt32.
+   * @param b The divisor PositiveInt32.
+   * @returns `⌊a / b⌋` clamped to [1, 2147483647] as a PositiveInt32.
+   */
+  div,
+} as const;
+
+expectType<
+  keyof typeof PositiveInt32,
+  keyof TsVerifiedInternals.RefinedNumberUtils.NumberClass<
+    ElementType,
+    'int' | 'positive' | 'range'
+  >
+>('=');
+
+expectType<
+  typeof PositiveInt32,
+  TsVerifiedInternals.RefinedNumberUtils.NumberClass<
+    ElementType,
+    'int' | 'positive' | 'range'
+  >
+>('<=');