ts-data-forge 1.0.0

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

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

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

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

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

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