ts-data-forge 11.0.0 → 12.0.0

package/dist/number/branded-types/safe-uint.d.mts

@@ -1,18 +1,24 @@
 import { type SafeUint as TtfImported_SafeUint } from 'ts-type-forge';
 export type SafeUint = TtfImported_SafeUint;
 /**
- * Checks if a number is a SafeUint.
+ * Type guard that checks if a value is a non-negative safe integer.
  *
- * @param value The value to check.
- * @returns `true` if the value is a SafeUint, `false` otherwise.
+ * Returns `true` for a non-negative safe integer — a value with no fractional
+ * component.
+ *
+ * @param value - The value to check
+ * @returns `true` if the value is a non-negative safe integer, `false` otherwise
  */
 export declare const isSafeUint: (a: number) => a is TtfImported_SafeUint;
 /**
- * Casts a number to a SafeUint type.
+ * Casts a `number` to the `SafeUint` branded type.
+ *
+ * Validates that the value is a non-negative safe integer and returns it with
+ * the `SafeUint` brand. Throws a `TypeError` otherwise.
  *
- * @param value The value to cast.
- * @returns The value as a SafeUint type.
- * @throws {TypeError} If the value is not a non-negative safe integer.
+ * @param value - The value to cast
+ * @returns The value as a `SafeUint`
+ * @throws {TypeError} If the value is not a non-negative safe integer
  */
 export declare const asSafeUint: <N extends number>(x: N) => number & {
     readonly "> -2^16": true;
@@ -28,103 +34,107 @@ export declare const asSafeUint: <N extends number>(x: N) => number & {
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
 /**
- * Namespace providing type-safe arithmetic operations for safe unsigned
- * integers.
+ * Namespace providing type-safe operations for the `SafeUint` branded type.
  *
- * All operations automatically clamp results to the safe unsigned integer range
- * [0, MAX_SAFE_INTEGER]. This ensures that all arithmetic maintains both the
- * non-negative constraint and IEEE 754 precision guarantees, preventing
- * precision loss while ensuring results are never negative.
+ * The `SafeUint` type represents a non-negative safe integer. Division (`div`)
+ * uses floor division.
  */
 export declare const SafeUint: {
     /**
-     * Type guard to check if a value is a SafeUint.
+     * Type guard that checks if a value is a non-negative safe integer.
      *
-     * @param value The value to check.
-     * @returns `true` if the value is a non-negative safe integer, `false`
-     *   otherwise.
+     * @param value - The value to check
+     * @returns `true` if the value is a non-negative safe integer, `false` otherwise
+     * @see {@link isSafeUint} for usage examples
      */
     readonly is: (a: number) => a is TtfImported_SafeUint;
     /**
-     * The minimum value for a safe unsigned integer.
-     *
-     * @readonly
+     * The smallest value representable as `SafeUint` (the lower saturation target
+     * of `fromNumber`).
      */
     readonly MIN_VALUE: 0;
     /**
-     * The maximum safe integer value (2^53 - 1).
-     *
-     * @readonly
+     * The largest value representable as `SafeUint` (the upper saturation target
+     * of `fromNumber`).
      */
     readonly MAX_VALUE: TtfImported_SafeUint;
     /**
-     * Returns the smaller of two SafeUint values.
+     * Returns the smallest of the given non-negative safe integers.
      *
-     * @param a The first SafeUint.
-     * @param b The second SafeUint.
-     * @returns The minimum value as a SafeUint.
+     * @param values - The non-negative safe integers to compare (at least one required)
+     * @returns The smallest value as a `SafeUint`
      */
     readonly min: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_SafeUint>[]) => TtfImported_SafeUint;
     /**
-     * Returns the larger of two SafeUint values.
+     * Returns the largest of the given non-negative safe integers.
      *
-     * @param a The first SafeUint.
-     * @param b The second SafeUint.
-     * @returns The maximum value as a SafeUint.
+     * @param values - The non-negative safe integers to compare (at least one required)
+     * @returns The largest value as a `SafeUint`
      */
     readonly max: (...values: readonly import("ts-type-forge").WithSmallInt<TtfImported_SafeUint>[]) => TtfImported_SafeUint;
     /**
-     * Clamps a number to the safe unsigned integer range.
+     * Converts an arbitrary `number` into a `SafeUint`, rounding to the nearest
+     * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
+     *
+     * Unlike `asSafeUint`, this is total: out-of-range inputs are clamped to the
+     * nearest representable `SafeUint` instead of throwing.
      *
-     * @param value The number to clamp.
-     * @returns The value clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
+     * @param value - The value to convert
+     * @returns The value as a `SafeUint`
      */
-    readonly clamp: (x: number) => TtfImported_SafeUint;
+    readonly fromNumber: (x: number) => TtfImported_SafeUint;
     /**
-     * Generates a random SafeUint value within the valid range.
+     * Generates a random `SafeUint` within the given range.
+     *
+     * The range is inclusive on both ends.
      *
-     * @returns A random SafeUint between 0 and MAX_SAFE_INTEGER.
+     * @param min - The minimum value (inclusive)
+     * @param max - The maximum value (inclusive)
+     * @returns A random `SafeUint` in `[min, max]`
      */
     readonly random: (min?: import("ts-type-forge").WithSmallInt<TtfImported_SafeUint> | undefined, max?: import("ts-type-forge").WithSmallInt<TtfImported_SafeUint> | undefined) => TtfImported_SafeUint;
     /**
-     * Raises a SafeUint to the power of another SafeUint.
+     * Raises `a` to the power `b`, returning `a ** b` as a `SafeUint` (floored to
+     * an integer).
      *
-     * @param a The base SafeUint.
-     * @param b The exponent SafeUint.
-     * @returns `a ** b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
+     * @param a - The base non-negative safe integer
+     * @param b - The exponent non-negative safe integer
+     * @returns `a ** b` as a `SafeUint`
      */
     readonly pow: (x: import("ts-type-forge").WithSmallInt<TtfImported_SafeUint>, y: import("ts-type-forge").WithSmallInt<TtfImported_SafeUint>) => TtfImported_SafeUint;
     /**
-     * Adds two SafeUint values.
+     * Adds two non-negative safe integers, returning `a + b` as a `SafeUint`.
      *
-     * @param a The first SafeUint.
-     * @param b The second SafeUint.
-     * @returns `a + b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
+     * @param a - The first non-negative safe integer
+     * @param b - The second non-negative safe integer
+     * @returns The sum of `a` and `b` as a `SafeUint`
      */
     readonly add: (x: import("ts-type-forge").WithSmallInt<TtfImported_SafeUint>, y: import("ts-type-forge").WithSmallInt<TtfImported_SafeUint>) => TtfImported_SafeUint;
     /**
-     * Subtracts one SafeUint from another.
+     * Subtracts two non-negative safe integers, returning `a - b` as a
+     * `SafeUint`.
      *
-     * @param a The minuend SafeUint.
-     * @param b The subtrahend SafeUint.
-     * @returns `a - b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint (minimum
-     *   0).
+     * @param a - The first non-negative safe integer
+     * @param b - The second non-negative safe integer
+     * @returns The difference of `a` and `b` as a `SafeUint`
      */
     readonly sub: (x: import("ts-type-forge").WithSmallInt<TtfImported_SafeUint>, y: import("ts-type-forge").WithSmallInt<TtfImported_SafeUint>) => TtfImported_SafeUint;
     /**
-     * Multiplies two SafeUint values.
+     * Multiplies two non-negative safe integers, returning `a * b` as a
+     * `SafeUint`.
      *
-     * @param a The first SafeUint.
-     * @param b The second SafeUint.
-     * @returns `a * b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
+     * @param a - The first non-negative safe integer
+     * @param b - The second non-negative safe integer
+     * @returns The product of `a` and `b` as a `SafeUint`
      */
     readonly mul: (x: import("ts-type-forge").WithSmallInt<TtfImported_SafeUint>, y: import("ts-type-forge").WithSmallInt<TtfImported_SafeUint>) => TtfImported_SafeUint;
     /**
-     * Divides one SafeUint by another using floor division.
+     * Divides two non-negative safe integers using floor division (`⌊a / b⌋`):
+     * the result is `a / b` rounded toward negative infinity, as a `SafeUint`.
      *
-     * @param a The dividend SafeUint.
-     * @param b The divisor SafeUint.
-     * @returns `⌊a / b⌋` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
+     * @param a - The dividend
+     * @param b - The divisor (must be non-zero)
+     * @returns The floored quotient as a `SafeUint`
      */
     readonly div: (x: import("ts-type-forge").WithSmallInt<TtfImported_SafeUint>, y: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | import("ts-type-forge").NormalizeBrandUnion<number & {
         readonly "!=0": true;

package/dist/number/branded-types/safe-uint.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"safe-uint.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/safe-uint.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,IAAI,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAItE,MAAM,MAAM,QAAQ,GAAG,oBAAoB,CAAC;AAgC5C;;;;;GAKG;AACH,eAAO,MAAM,UAAU,0CAAK,CAAC;AAE7B;;;;;;GAMG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;MAAW,CAAC;AAEnC;;;;;;;;GAQG;AACH,eAAO,MAAM,QAAQ;IACnB;;;;;;OAMG;;IAGH;;;;OAIG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;OAKG;;IAGH;;;;OAIG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;OAMG;;;;;;;;;;;;;;;CAEK,CAAC"}
+{"version":3,"file":"safe-uint.d.mts","sourceRoot":"","sources":["../../../src/number/branded-types/safe-uint.mts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,QAAQ,IAAI,oBAAoB,EAAE,MAAM,eAAe,CAAC;AAItE,MAAM,MAAM,QAAQ,GAAG,oBAAoB,CAAC;AAgC5C;;;;;;;;GAQG;AACH,eAAO,MAAM,UAAU,0CAAK,CAAC;AAE7B;;;;;;;;;GASG;AACH,eAAO,MAAM,UAAU;;;;;;;;;;;;MAAW,CAAC;AAEnC;;;;;GAKG;AACH,eAAO,MAAM,QAAQ;IACnB;;;;;;OAMG;;IAGH;;;OAGG;;IAGH;;;OAGG;;IAGH;;;;;OAKG;;IAGH;;;;;OAKG;;IAGH;;;;;;;;;OASG;;IAGH;;;;;;;;OAQG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;OAMG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;IAGH;;;;;;;OAOG;;;;;;;;;;;;;;;CAEK,CAAC"}

package/dist/number/branded-types/safe-uint.mjs

@@ -6,8 +6,8 @@ const {
   MIN_VALUE,
   add,
   castType,
-  clamp,
   div,
+  fromNumber,
   is,
   max: max_,
   min: min_,
@@ -26,93 +26,100 @@ const isSafeUint = is;
 const asSafeUint = castType;
 const SafeUint = {
   /**
-   * Type guard to check if a value is a SafeUint.
+   * Type guard that checks if a value is a non-negative safe integer.
    *
-   * @param value The value to check.
-   * @returns `true` if the value is a non-negative safe integer, `false`
-   *   otherwise.
+   * @param value - The value to check
+   * @returns `true` if the value is a non-negative safe integer, `false` otherwise
+   * @see {@link isSafeUint} for usage examples
    */
   is,
   /**
-   * The minimum value for a safe unsigned integer.
-   *
-   * @readonly
+   * The smallest value representable as `SafeUint` (the lower saturation target
+   * of `fromNumber`).
    */
   MIN_VALUE,
   /**
-   * The maximum safe integer value (2^53 - 1).
-   *
-   * @readonly
+   * The largest value representable as `SafeUint` (the upper saturation target
+   * of `fromNumber`).
    */
   MAX_VALUE,
   /**
-   * Returns the smaller of two SafeUint values.
+   * Returns the smallest of the given non-negative safe integers.
    *
-   * @param a The first SafeUint.
-   * @param b The second SafeUint.
-   * @returns The minimum value as a SafeUint.
+   * @param values - The non-negative safe integers to compare (at least one required)
+   * @returns The smallest value as a `SafeUint`
    */
   min: min_,
   /**
-   * Returns the larger of two SafeUint values.
+   * Returns the largest of the given non-negative safe integers.
    *
-   * @param a The first SafeUint.
-   * @param b The second SafeUint.
-   * @returns The maximum value as a SafeUint.
+   * @param values - The non-negative safe integers to compare (at least one required)
+   * @returns The largest value as a `SafeUint`
    */
   max: max_,
   /**
-   * Clamps a number to the safe unsigned integer range.
+   * Converts an arbitrary `number` into a `SafeUint`, rounding to the nearest
+   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.
    *
-   * @param value The number to clamp.
-   * @returns The value clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
+   * Unlike `asSafeUint`, this is total: out-of-range inputs are clamped to the
+   * nearest representable `SafeUint` instead of throwing.
+   *
+   * @param value - The value to convert
+   * @returns The value as a `SafeUint`
    */
-  clamp,
+  fromNumber,
   /**
-   * Generates a random SafeUint value within the valid range.
+   * Generates a random `SafeUint` within the given range.
+   *
+   * The range is inclusive on both ends.
    *
-   * @returns A random SafeUint between 0 and MAX_SAFE_INTEGER.
+   * @param min - The minimum value (inclusive)
+   * @param max - The maximum value (inclusive)
+   * @returns A random `SafeUint` in `[min, max]`
    */
   random,
   /**
-   * Raises a SafeUint to the power of another SafeUint.
+   * Raises `a` to the power `b`, returning `a ** b` as a `SafeUint` (floored to
+   * an integer).
    *
-   * @param a The base SafeUint.
-   * @param b The exponent SafeUint.
-   * @returns `a ** b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
+   * @param a - The base non-negative safe integer
+   * @param b - The exponent non-negative safe integer
+   * @returns `a ** b` as a `SafeUint`
    */
   pow,
   /**
-   * Adds two SafeUint values.
+   * Adds two non-negative safe integers, returning `a + b` as a `SafeUint`.
    *
-   * @param a The first SafeUint.
-   * @param b The second SafeUint.
-   * @returns `a + b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
+   * @param a - The first non-negative safe integer
+   * @param b - The second non-negative safe integer
+   * @returns The sum of `a` and `b` as a `SafeUint`
    */
   add,
   /**
-   * Subtracts one SafeUint from another.
+   * Subtracts two non-negative safe integers, returning `a - b` as a
+   * `SafeUint`.
    *
-   * @param a The minuend SafeUint.
-   * @param b The subtrahend SafeUint.
-   * @returns `a - b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint (minimum
-   *   0).
+   * @param a - The first non-negative safe integer
+   * @param b - The second non-negative safe integer
+   * @returns The difference of `a` and `b` as a `SafeUint`
    */
   sub,
   /**
-   * Multiplies two SafeUint values.
+   * Multiplies two non-negative safe integers, returning `a * b` as a
+   * `SafeUint`.
    *
-   * @param a The first SafeUint.
-   * @param b The second SafeUint.
-   * @returns `a * b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
+   * @param a - The first non-negative safe integer
+   * @param b - The second non-negative safe integer
+   * @returns The product of `a` and `b` as a `SafeUint`
    */
   mul,
   /**
-   * Divides one SafeUint by another using floor division.
+   * Divides two non-negative safe integers using floor division (`⌊a / b⌋`):
+   * the result is `a / b` rounded toward negative infinity, as a `SafeUint`.
    *
-   * @param a The dividend SafeUint.
-   * @param b The divisor SafeUint.
-   * @returns `⌊a / b⌋` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
+   * @param a - The dividend
+   * @param b - The divisor (must be non-zero)
+   * @returns The floored quotient as a `SafeUint`
    */
   div
 };

package/dist/number/branded-types/safe-uint.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"safe-uint.mjs","sources":["../../../src/number/branded-types/safe-uint.mts"],"sourcesContent":["import { type SafeUint as TtfImported_SafeUint } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type SafeUint = TtfImported_SafeUint;\n\ntype ElementType = SafeUint;\n\nconst typeNameInMessage = 'a non-negative safe integer';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  add,\n  castType,\n  clamp,\n  div,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  0,\n  SafeUint\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: 0,\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-max-safe-integer\n  MAX_VALUE: Number.MAX_SAFE_INTEGER as SafeUint,\n  typeNameInMessage,\n} as const);\n\n/**\n * Checks if a number is a SafeUint.\n *\n * @param value The value to check.\n * @returns `true` if the value is a SafeUint, `false` otherwise.\n */\nexport const isSafeUint = is;\n\n/**\n * Casts a number to a SafeUint type.\n *\n * @param value The value to cast.\n * @returns The value as a SafeUint type.\n * @throws {TypeError} If the value is not a non-negative safe integer.\n */\nexport const asSafeUint = castType;\n\n/**\n * Namespace providing type-safe arithmetic operations for safe unsigned\n * integers.\n *\n * All operations automatically clamp results to the safe unsigned integer range\n * [0, MAX_SAFE_INTEGER]. This ensures that all arithmetic maintains both the\n * non-negative constraint and IEEE 754 precision guarantees, preventing\n * precision loss while ensuring results are never negative.\n */\nexport const SafeUint = {\n  /**\n   * Type guard to check if a value is a SafeUint.\n   *\n   * @param value The value to check.\n   * @returns `true` if the value is a non-negative safe integer, `false`\n   *   otherwise.\n   */\n  is,\n\n  /**\n   * The minimum value for a safe unsigned integer.\n   *\n   * @readonly\n   */\n  MIN_VALUE,\n\n  /**\n   * The maximum safe integer value (2^53 - 1).\n   *\n   * @readonly\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smaller of two SafeUint values.\n   *\n   * @param a The first SafeUint.\n   * @param b The second SafeUint.\n   * @returns The minimum value as a SafeUint.\n   */\n  min: min_,\n\n  /**\n   * Returns the larger of two SafeUint values.\n   *\n   * @param a The first SafeUint.\n   * @param b The second SafeUint.\n   * @returns The maximum value as a SafeUint.\n   */\n  max: max_,\n\n  /**\n   * Clamps a number to the safe unsigned integer range.\n   *\n   * @param value The number to clamp.\n   * @returns The value clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.\n   */\n  clamp,\n\n  /**\n   * Generates a random SafeUint value within the valid range.\n   *\n   * @returns A random SafeUint between 0 and MAX_SAFE_INTEGER.\n   */\n  random,\n\n  /**\n   * Raises a SafeUint to the power of another SafeUint.\n   *\n   * @param a The base SafeUint.\n   * @param b The exponent SafeUint.\n   * @returns `a ** b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.\n   */\n  pow,\n\n  /**\n   * Adds two SafeUint values.\n   *\n   * @param a The first SafeUint.\n   * @param b The second SafeUint.\n   * @returns `a + b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.\n   */\n  add,\n\n  /**\n   * Subtracts one SafeUint from another.\n   *\n   * @param a The minuend SafeUint.\n   * @param b The subtrahend SafeUint.\n   * @returns `a - b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint (minimum\n   *   0).\n   */\n  sub,\n\n  /**\n   * Multiplies two SafeUint values.\n   *\n   * @param a The first SafeUint.\n   * @param b The second SafeUint.\n   * @returns `a * b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.\n   */\n  mul,\n\n  /**\n   * Divides one SafeUint by another using floor division.\n   *\n   * @param a The dividend SafeUint.\n   * @param b The divisor SafeUint.\n   * @returns `⌊a / b⌋` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof SafeUint,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof SafeUint,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,6BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,KAAA;AAAA,EACA,GAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,SAAA,EAAW,CAAA;AAAA;AAAA,EAEX,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAQH,MAAM,UAAA,GAAa;AASnB,MAAM,UAAA,GAAa;AAWnB,MAAM,QAAA,GAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQtB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,KAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA;AACF;;;;"}
+{"version":3,"file":"safe-uint.mjs","sources":["../../../src/number/branded-types/safe-uint.mts"],"sourcesContent":["import { type SafeUint as TtfImported_SafeUint } from 'ts-type-forge';\nimport { expectType } from '../../expect-type.mjs';\nimport { TsDataForgeInternals } from '../refined-number-utils.mjs';\n\nexport type SafeUint = TtfImported_SafeUint;\n\ntype ElementType = SafeUint;\n\nconst typeNameInMessage = 'a non-negative safe integer';\n\nconst {\n  MAX_VALUE,\n  MIN_VALUE,\n  add,\n  castType,\n  div,\n  fromNumber,\n  is,\n  max: max_,\n  min: min_,\n  mul,\n  pow,\n  random,\n  sub,\n} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger<\n  ElementType,\n  0,\n  SafeUint\n>({\n  integerOrSafeInteger: 'SafeInteger',\n  MIN_VALUE: 0,\n  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-max-safe-integer\n  MAX_VALUE: Number.MAX_SAFE_INTEGER as SafeUint,\n  typeNameInMessage,\n} as const);\n\n/**\n * Type guard that checks if a value is a non-negative safe integer.\n *\n * Returns `true` for a non-negative safe integer — a value with no fractional\n * component.\n *\n * @param value - The value to check\n * @returns `true` if the value is a non-negative safe integer, `false` otherwise\n */\nexport const isSafeUint = is;\n\n/**\n * Casts a `number` to the `SafeUint` branded type.\n *\n * Validates that the value is a non-negative safe integer and returns it with\n * the `SafeUint` brand. Throws a `TypeError` otherwise.\n *\n * @param value - The value to cast\n * @returns The value as a `SafeUint`\n * @throws {TypeError} If the value is not a non-negative safe integer\n */\nexport const asSafeUint = castType;\n\n/**\n * Namespace providing type-safe operations for the `SafeUint` branded type.\n *\n * The `SafeUint` type represents a non-negative safe integer. Division (`div`)\n * uses floor division.\n */\nexport const SafeUint = {\n  /**\n   * Type guard that checks if a value is a non-negative safe integer.\n   *\n   * @param value - The value to check\n   * @returns `true` if the value is a non-negative safe integer, `false` otherwise\n   * @see {@link isSafeUint} for usage examples\n   */\n  is,\n\n  /**\n   * The smallest value representable as `SafeUint` (the lower saturation target\n   * of `fromNumber`).\n   */\n  MIN_VALUE,\n\n  /**\n   * The largest value representable as `SafeUint` (the upper saturation target\n   * of `fromNumber`).\n   */\n  MAX_VALUE,\n\n  /**\n   * Returns the smallest of the given non-negative safe integers.\n   *\n   * @param values - The non-negative safe integers to compare (at least one required)\n   * @returns The smallest value as a `SafeUint`\n   */\n  min: min_,\n\n  /**\n   * Returns the largest of the given non-negative safe integers.\n   *\n   * @param values - The non-negative safe integers to compare (at least one required)\n   * @returns The largest value as a `SafeUint`\n   */\n  max: max_,\n\n  /**\n   * Converts an arbitrary `number` into a `SafeUint`, rounding to the nearest\n   * integer and saturating the result into the range `[MIN_VALUE, MAX_VALUE]`.\n   *\n   * Unlike `asSafeUint`, this is total: out-of-range inputs are clamped to the\n   * nearest representable `SafeUint` instead of throwing.\n   *\n   * @param value - The value to convert\n   * @returns The value as a `SafeUint`\n   */\n  fromNumber,\n\n  /**\n   * Generates a random `SafeUint` within the given range.\n   *\n   * The range is inclusive on both ends.\n   *\n   * @param min - The minimum value (inclusive)\n   * @param max - The maximum value (inclusive)\n   * @returns A random `SafeUint` in `[min, max]`\n   */\n  random,\n\n  /**\n   * Raises `a` to the power `b`, returning `a ** b` as a `SafeUint` (floored to\n   * an integer).\n   *\n   * @param a - The base non-negative safe integer\n   * @param b - The exponent non-negative safe integer\n   * @returns `a ** b` as a `SafeUint`\n   */\n  pow,\n\n  /**\n   * Adds two non-negative safe integers, returning `a + b` as a `SafeUint`.\n   *\n   * @param a - The first non-negative safe integer\n   * @param b - The second non-negative safe integer\n   * @returns The sum of `a` and `b` as a `SafeUint`\n   */\n  add,\n\n  /**\n   * Subtracts two non-negative safe integers, returning `a - b` as a\n   * `SafeUint`.\n   *\n   * @param a - The first non-negative safe integer\n   * @param b - The second non-negative safe integer\n   * @returns The difference of `a` and `b` as a `SafeUint`\n   */\n  sub,\n\n  /**\n   * Multiplies two non-negative safe integers, returning `a * b` as a\n   * `SafeUint`.\n   *\n   * @param a - The first non-negative safe integer\n   * @param b - The second non-negative safe integer\n   * @returns The product of `a` and `b` as a `SafeUint`\n   */\n  mul,\n\n  /**\n   * Divides two non-negative safe integers using floor division (`⌊a / b⌋`):\n   * the result is `a / b` rounded toward negative infinity, as a `SafeUint`.\n   *\n   * @param a - The dividend\n   * @param b - The divisor (must be non-zero)\n   * @returns The floored quotient as a `SafeUint`\n   */\n  div,\n} as const;\n\nexpectType<\n  keyof typeof SafeUint,\n  keyof TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('=');\n\nexpectType<\n  typeof SafeUint,\n  TsDataForgeInternals.RefinedNumberUtils.NumberClass<\n    ElementType,\n    'int' | 'non-negative' | 'range'\n  >\n>('<=');\n"],"names":[],"mappings":";;AAQA,MAAM,iBAAA,GAAoB,6BAAA;AAE1B,MAAM;AAAA,EACJ,SAAA;AAAA,EACA,SAAA;AAAA,EACA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,GAAA;AAAA,EACA,UAAA;AAAA,EACA,EAAA;AAAA,EACA,GAAA,EAAK,IAAA;AAAA,EACL,GAAA,EAAK,IAAA;AAAA,EACL,GAAA;AAAA,EACA,GAAA;AAAA,EACA,MAAA;AAAA,EACA;AACF,CAAA,GAAI,oBAAA,CAAqB,mBAAmB,mBAAA,CAI1C;AAAA,EACA,oBAAA,EAAsB,aAAA;AAAA,EACtB,SAAA,EAAW,CAAA;AAAA;AAAA,EAEX,WAAW,MAAA,CAAO,gBAAA;AAAA,EAClB;AACF,CAAU,CAAA;AAWH,MAAM,UAAA,GAAa;AAYnB,MAAM,UAAA,GAAa;AAQnB,MAAM,QAAA,GAAW;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQtB,EAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,SAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQL,GAAA,EAAK,IAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYL,UAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWA,MAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA,GAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAUA;AACF;;;;"}