ts-data-forge 9.0.0 → 10.0.0

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

@@ -1,128 +1,120 @@
 import { TsDataForgeInternals } from '../refined-number-utils.mjs';
 
-const typeNameInMessage = 'a non-negative safe integer';
-const { MAX_VALUE, MIN_VALUE, add, castType, clamp, div, is, max: max_, min: min_, mul, pow, random, sub, } = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
-    integerOrSafeInteger: 'SafeInteger',
-    MIN_VALUE: 0,
-    // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-max-safe-integer
-    MAX_VALUE: Number.MAX_SAFE_INTEGER,
-    typeNameInMessage,
+const typeNameInMessage = "a non-negative safe integer";
+const {
+  MAX_VALUE,
+  MIN_VALUE,
+  add,
+  castType,
+  clamp,
+  div,
+  is,
+  max: max_,
+  min: min_,
+  mul,
+  pow,
+  random,
+  sub
+} = TsDataForgeInternals.RefinedNumberUtils.operatorsForInteger({
+  integerOrSafeInteger: "SafeInteger",
+  MIN_VALUE: 0,
+  // eslint-disable-next-line total-functions/no-unsafe-type-assertion, math/prefer-number-max-safe-integer
+  MAX_VALUE: Number.MAX_SAFE_INTEGER,
+  typeNameInMessage
 });
-/**
- * Checks if a number is a SafeUint.
- *
- * @param value The value to check.
- * @returns `true` if the value is a SafeUint, `false` otherwise.
- */
 const isSafeUint = is;
-/**
- * Casts a number to a SafeUint type.
- *
- * @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.
- */
 const asSafeUint = castType;
-/**
- * Namespace providing type-safe arithmetic operations for safe unsigned
- * integers.
- *
- * 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.
- */
 const SafeUint = {
-    /**
-     * Type guard to check if a value is a SafeUint.
-     *
-     * @param value The value to check.
-     * @returns `true` if the value is a non-negative safe integer, `false`
-     *   otherwise.
-     */
-    is,
-    /**
-     * The minimum value for a safe unsigned integer.
-     *
-     * @readonly
-     */
-    MIN_VALUE,
-    /**
-     * The maximum safe integer value (2^53 - 1).
-     *
-     * @readonly
-     */
-    MAX_VALUE,
-    /**
-     * Returns the smaller of two SafeUint values.
-     *
-     * @param a The first SafeUint.
-     * @param b The second SafeUint.
-     * @returns The minimum value as a SafeUint.
-     */
-    min: min_,
-    /**
-     * Returns the larger of two SafeUint values.
-     *
-     * @param a The first SafeUint.
-     * @param b The second SafeUint.
-     * @returns The maximum value as a SafeUint.
-     */
-    max: max_,
-    /**
-     * Clamps a number to the safe unsigned integer range.
-     *
-     * @param value The number to clamp.
-     * @returns The value clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
-     */
-    clamp,
-    /**
-     * Generates a random SafeUint value within the valid range.
-     *
-     * @returns A random SafeUint between 0 and MAX_SAFE_INTEGER.
-     */
-    random,
-    /**
-     * Raises a SafeUint to the power of another SafeUint.
-     *
-     * @param a The base SafeUint.
-     * @param b The exponent SafeUint.
-     * @returns `a ** b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
-     */
-    pow,
-    /**
-     * Adds two SafeUint values.
-     *
-     * @param a The first SafeUint.
-     * @param b The second SafeUint.
-     * @returns `a + b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
-     */
-    add,
-    /**
-     * Subtracts one SafeUint from another.
-     *
-     * @param a The minuend SafeUint.
-     * @param b The subtrahend SafeUint.
-     * @returns `a - b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint (minimum
-     *   0).
-     */
-    sub,
-    /**
-     * Multiplies two SafeUint values.
-     *
-     * @param a The first SafeUint.
-     * @param b The second SafeUint.
-     * @returns `a * b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
-     */
-    mul,
-    /**
-     * Divides one SafeUint by another using floor division.
-     *
-     * @param a The dividend SafeUint.
-     * @param b The divisor SafeUint.
-     * @returns `⌊a / b⌋` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
-     */
-    div,
+  /**
+   * Type guard to check if a value is a SafeUint.
+   *
+   * @param value The value to check.
+   * @returns `true` if the value is a non-negative safe integer, `false`
+   *   otherwise.
+   */
+  is,
+  /**
+   * The minimum value for a safe unsigned integer.
+   *
+   * @readonly
+   */
+  MIN_VALUE,
+  /**
+   * The maximum safe integer value (2^53 - 1).
+   *
+   * @readonly
+   */
+  MAX_VALUE,
+  /**
+   * Returns the smaller of two SafeUint values.
+   *
+   * @param a The first SafeUint.
+   * @param b The second SafeUint.
+   * @returns The minimum value as a SafeUint.
+   */
+  min: min_,
+  /**
+   * Returns the larger of two SafeUint values.
+   *
+   * @param a The first SafeUint.
+   * @param b The second SafeUint.
+   * @returns The maximum value as a SafeUint.
+   */
+  max: max_,
+  /**
+   * Clamps a number to the safe unsigned integer range.
+   *
+   * @param value The number to clamp.
+   * @returns The value clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
+   */
+  clamp,
+  /**
+   * Generates a random SafeUint value within the valid range.
+   *
+   * @returns A random SafeUint between 0 and MAX_SAFE_INTEGER.
+   */
+  random,
+  /**
+   * Raises a SafeUint to the power of another SafeUint.
+   *
+   * @param a The base SafeUint.
+   * @param b The exponent SafeUint.
+   * @returns `a ** b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
+   */
+  pow,
+  /**
+   * Adds two SafeUint values.
+   *
+   * @param a The first SafeUint.
+   * @param b The second SafeUint.
+   * @returns `a + b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
+   */
+  add,
+  /**
+   * Subtracts one SafeUint from another.
+   *
+   * @param a The minuend SafeUint.
+   * @param b The subtrahend SafeUint.
+   * @returns `a - b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint (minimum
+   *   0).
+   */
+  sub,
+  /**
+   * Multiplies two SafeUint values.
+   *
+   * @param a The first SafeUint.
+   * @param b The second SafeUint.
+   * @returns `a * b` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
+   */
+  mul,
+  /**
+   * Divides one SafeUint by another using floor division.
+   *
+   * @param a The dividend SafeUint.
+   * @param b The divisor SafeUint.
+   * @returns `⌊a / b⌋` clamped to [0, MAX_SAFE_INTEGER] as a SafeUint.
+   */
+  div
 };
 
 export { SafeUint, asSafeUint, isSafeUint };

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":[null],"names":[],"mappings":";;AAQA,MAAM,iBAAiB,GAAG,6BAA6B;AAEvD,MAAM,EACJ,SAAS,EACT,SAAS,EACT,GAAG,EACH,QAAQ,EACR,KAAK,EACL,GAAG,EACH,EAAE,EACF,GAAG,EAAE,IAAI,EACT,GAAG,EAAE,IAAI,EACT,GAAG,EACH,GAAG,EACH,MAAM,EACN,GAAG,GACJ,GAAG,oBAAoB,CAAC,kBAAkB,CAAC,mBAAmB,CAI7D;AACA,IAAA,oBAAoB,EAAE,aAAa;AACnC,IAAA,SAAS,EAAE,CAAC;;IAEZ,SAAS,EAAE,MAAM,CAAC,gBAA4B;IAC9C,iBAAiB;AACT,CAAA,CAAC;AAEX;;;;;AAKG;AACI,MAAM,UAAU,GAAG;AAE1B;;;;;;AAMG;AACI,MAAM,UAAU,GAAG;AAE1B;;;;;;;;AAQG;AACI,MAAM,QAAQ,GAAG;AACtB;;;;;;AAMG;IACH,EAAE;AAEF;;;;AAIG;IACH,SAAS;AAET;;;;AAIG;IACH,SAAS;AAET;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;;AAMG;AACH,IAAA,GAAG,EAAE,IAAI;AAET;;;;;AAKG;IACH,KAAK;AAEL;;;;AAIG;IACH,MAAM;AAEN;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;;AAOG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;AAEH;;;;;;AAMG;IACH,GAAG;;;;;"}
+{"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;;;;"}

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

@@ -35,14 +35,14 @@ export declare const isUint: (a: number) => a is import("ts-type-forge").NonNega
  * @throws {TypeError} If the value is not a non-negative integer.
  */
 export declare const asUint: <N extends number>(x: N) => number & {
-    readonly NaNValue: false;
-    readonly Finite: true;
-    readonly Int: true;
     readonly "> -2^16": true;
     readonly "> -2^32": true;
     readonly ">= -2^15": true;
     readonly ">= -2^31": true;
     readonly ">=0": true;
+    readonly Finite: true;
+    readonly Int: true;
+    readonly NaNValue: false;
 } & Readonly<{
     'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
 }> & N;
@@ -232,16 +232,16 @@ export declare const Uint: {
      * @param b The divisor Uint.
      * @returns `⌊a / b⌋` clamped to [0, +∞) as a Uint.
      */
-    readonly div: (x: import("ts-type-forge").WithSmallInt<import("ts-type-forge").NonNegativeInt>, y: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 11 | 10 | 20 | 30 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | import("ts-type-forge").NormalizeBrandUnion<number & {
-        readonly NaNValue: false;
-        readonly Finite: true;
-        readonly Int: true;
+    readonly div: (x: import("ts-type-forge").WithSmallInt<import("ts-type-forge").NonNegativeInt>, 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;
         readonly "> -2^16": true;
         readonly "> -2^32": true;
         readonly ">= -2^15": true;
         readonly ">= -2^31": true;
         readonly ">=0": true;
-        readonly "!=0": true;
+        readonly Finite: true;
+        readonly Int: true;
+        readonly NaNValue: false;
     } & Readonly<{
         'TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3': unknown;
     }>>) => import("ts-type-forge").NonNegativeInt;