chore: migrate vendor

package.json

@@ -31,8 +31,7 @@
     "index.js",
     "lib",
     "locale",
-    "tsconfig.json",
-    "vendor"
+    "tsconfig.json"
   ],
   "scripts": {
     "preinstall": "npx only-allow pnpm",

src/internet.ts

@@ -1,6 +1,6 @@
 import type { Faker } from '.';
 
-const random_ua = require('../vendor/user-agent');
+import * as random_ua from './vendor/user-agent';
 
 export class Internet {
   constructor(private readonly faker: Faker) {

src/mersenne.ts

@@ -1,4 +1,4 @@
-const Gen = require('../vendor/mersenne').MersenneTwister19937;
+import Gen from './vendor/mersenne';
 
 export class Mersenne {
   private gen = new Gen();

src/unique.ts

@@ -1,4 +1,4 @@
-const uniqueExec = require('../vendor/unique');
+import * as uniqueExec from './vendor/unique';
 
 export class Unique {
   // maximum time unique.exec will attempt to run before aborting

vendor/mersenne.js → src/vendor/mersenne.ts

@@ -7,89 +7,91 @@
 // lines commented with /* and */ are original comments.
 // lines commented with // are additional comments in this JavaScript version.
 // before using this version, create at least one instance of MersenneTwister19937 class, and initialize the each state, given below in c comments, of all the instances.
-/*
-   A C-program for MT19937, with initialization improved 2002/1/26.
-   Coded by Takuji Nishimura and Makoto Matsumoto.
-
-   Before using, initialize the state by using init_genrand(seed)
-   or init_by_array(init_key, key_length).
-
-   Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
-   All rights reserved.
-
-   Redistribution and use in source and binary forms, with or without
-   modification, are permitted provided that the following conditions
-   are met:
-
-     1. Redistributions of source code must retain the above copyright
-        notice, this list of conditions and the following disclaimer.
-
-     2. Redistributions in binary form must reproduce the above copyright
-        notice, this list of conditions and the following disclaimer in the
-        documentation and/or other materials provided with the distribution.
-
-     3. The names of its contributors may not be used to endorse or promote
-        products derived from this software without specific prior written
-        permission.
-
-   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-   A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
-   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
-   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
-   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
-   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
-   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
-   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
-   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
+/*
+ *   A C-program for MT19937, with initialization improved 2002/1/26.
+ *   Coded by Takuji Nishimura and Makoto Matsumoto.
+ *
+ *   Before using, initialize the state by using init_genrand(seed)
+ *   or init_by_array(init_key, key_length).
+ *
+ *   Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
+ *   All rights reserved.
+ *
+ *   Redistribution and use in source and binary forms, with or without
+ *   modification, are permitted provided that the following conditions
+ *   are met:
+ *
+ *     1. Redistributions of source code must retain the above copyright
+ *        notice, this list of conditions and the following disclaimer.
+ *
+ *     2. Redistributions in binary form must reproduce the above copyright
+ *        notice, this list of conditions and the following disclaimer in the
+ *        documentation and/or other materials provided with the distribution.
+ *
+ *     3. The names of its contributors may not be used to endorse or promote
+ *        products derived from this software without specific prior written
+ *        permission.
+ *
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ *   A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+ *   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ *   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ *   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ *   PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ *   LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ *   NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ *   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ *
+ *   Any feedback is very welcome.
+ *   http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html
+ *   email: m-mat @ math.sci.hiroshima-u.ac.jp (remove space)
+ */
 
-   Any feedback is very welcome.
-   http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html
-   email: m-mat @ math.sci.hiroshima-u.ac.jp (remove space)
-*/
+let dbg: number;
 
-function MersenneTwister19937() {
+function MersenneTwister19937(): void {
   /* constants should be scoped inside the class */
-  var N, M, MATRIX_A, UPPER_MASK, LOWER_MASK;
   /* Period parameters */
   //c//#define N 624
   //c//#define M 397
   //c//#define MATRIX_A 0x9908b0dfUL   /* constant vector a */
   //c//#define UPPER_MASK 0x80000000UL /* most significant w-r bits */
   //c//#define LOWER_MASK 0x7fffffffUL /* least significant r bits */
-  N = 624;
-  M = 397;
-  MATRIX_A = 0x9908b0df; /* constant vector a */
-  UPPER_MASK = 0x80000000; /* most significant w-r bits */
-  LOWER_MASK = 0x7fffffff; /* least significant r bits */
+  const N = 624;
+  const M = 397;
+  const MATRIX_A = 0x9908b0df; /* constant vector a */
+  const UPPER_MASK = 0x80000000; /* most significant w-r bits */
+  const LOWER_MASK = 0x7fffffff; /* least significant r bits */
   //c//static unsigned long mt[N]; /* the array for the state vector  */
   //c//static int mti=N+1; /* mti==N+1 means mt[N] is not initialized */
-  var mt = new Array(N); /* the array for the state vector  */
-  var mti = N + 1; /* mti==N+1 means mt[N] is not initialized */
+  const mt: number[] = new Array(N); /* the array for the state vector  */
+  let mti = N + 1; /* mti==N+1 means mt[N] is not initialized */
 
-  function unsigned32(n1) {
+  function unsigned32(n1: number): number {
     // returns a 32-bits unsiged integer from an operand to which applied a bit operator.
     return n1 < 0 ? (n1 ^ UPPER_MASK) + UPPER_MASK : n1;
   }
 
-  function subtraction32(n1, n2) {
+  function subtraction32(n1: number, n2: number): number {
     // emulates lowerflow of a c 32-bits unsiged integer variable, instead of the operator -. these both arguments must be non-negative integers expressible using unsigned 32 bits.
     return n1 < n2
       ? unsigned32((0x100000000 - (n2 - n1)) & 0xffffffff)
       : n1 - n2;
   }
 
-  function addition32(n1, n2) {
+  function addition32(n1: number, n2: number): number {
     // emulates overflow of a c 32-bits unsiged integer variable, instead of the operator +. these both arguments must be non-negative integers expressible using unsigned 32 bits.
     return unsigned32((n1 + n2) & 0xffffffff);
   }
 
-  function multiplication32(n1, n2) {
+  function multiplication32(n1: number, n2: number): number {
     // emulates overflow of a c 32-bits unsiged integer variable, instead of the operator *. these both arguments must be non-negative integers expressible using unsigned 32 bits.
-    var sum = 0;
-    for (var i = 0; i < 32; ++i) {
+    let sum = 0;
+    for (let i = 0; i < 32; ++i) {
       if ((n1 >>> i) & 0x1) {
         sum = addition32(sum, unsigned32(n2 << i));
       }
@@ -99,7 +101,7 @@ function MersenneTwister19937() {
 
   /* initializes mt[N] with a seed */
   //c//void init_genrand(unsigned long s)
-  this.init_genrand = function (s) {
+  this.init_genrand = function (s: number) {
     //c//mt[0]= s & 0xffffffff;
     mt[0] = unsigned32(s & 0xffffffff);
     for (mti = 1; mti < N; mti++) {
@@ -128,13 +130,11 @@ function MersenneTwister19937() {
   /* slight change for C++, 2004/2/26 */
   //c//void init_by_array(unsigned long init_key[], int key_length)
   this.init_by_array = function (init_key, key_length) {
-    //c//int i, j, k;
-    var i, j, k;
     //c//init_genrand(19650218);
     this.init_genrand(19650218);
-    i = 1;
-    j = 0;
-    k = N > key_length ? N : key_length;
+    let i = 1;
+    let j = 0;
+    let k = N > key_length ? N : key_length;
     for (; k; k--) {
       //c//mt[i] = (mt[i] ^ ((mt[i-1] ^ (mt[i-1] >> 30)) * 1664525))
       //c//	+ init_key[j] + j; /* non linear */
@@ -189,20 +189,20 @@ function MersenneTwister19937() {
   };
 
   /* moved outside of genrand_int32() by jwatte 2010-11-17; generate less garbage */
-  var mag01 = [0x0, MATRIX_A];
+  const mag01 = [0x0, MATRIX_A];
 
   /* generates a random number on [0,0xffffffff]-interval */
   //c//unsigned long genrand_int32(void)
   this.genrand_int32 = function () {
     //c//unsigned long y;
     //c//static unsigned long mag01[2]={0x0UL, MATRIX_A};
-    var y;
+    let y: number;
     /* mag01[x] = x * MATRIX_A  for x=0,1 */
 
     if (mti >= N) {
       /* generate N words at one time */
       //c//int kk;
-      var kk;
+      let kk: number;
 
       if (mti == N + 1) {
         /* if init_genrand() has not been called, */
@@ -246,40 +246,40 @@ function MersenneTwister19937() {
 
   /* generates a random number on [0,0x7fffffff]-interval */
   //c//long genrand_int31(void)
-  this.genrand_int31 = function () {
+  this.genrand_int31 = function (): number {
     //c//return (genrand_int32()>>1);
     return this.genrand_int32() >>> 1;
   };
 
   /* generates a random number on [0,1]-real-interval */
   //c//double genrand_real1(void)
-  this.genrand_real1 = function () {
+  this.genrand_real1 = function (): number {
     //c//return genrand_int32()*(1.0/4294967295.0);
     return this.genrand_int32() * (1.0 / 4294967295.0);
     /* divided by 2^32-1 */
   };
 
   /* generates a random number on [0,1)-real-interval */
   //c//double genrand_real2(void)
-  this.genrand_real2 = function () {
+  this.genrand_real2 = function (): number {
     //c//return genrand_int32()*(1.0/4294967296.0);
     return this.genrand_int32() * (1.0 / 4294967296.0);
     /* divided by 2^32 */
   };
 
   /* generates a random number on (0,1)-real-interval */
   //c//double genrand_real3(void)
-  this.genrand_real3 = function () {
+  this.genrand_real3 = function (): number {
     //c//return ((genrand_int32()) + 0.5)*(1.0/4294967296.0);
     return (this.genrand_int32() + 0.5) * (1.0 / 4294967296.0);
     /* divided by 2^32 */
   };
 
   /* generates a random number on [0,1) with 53-bit resolution*/
   //c//double genrand_res53(void)
-  this.genrand_res53 = function () {
+  this.genrand_res53 = function (): number {
     //c//unsigned long a=genrand_int32()>>5, b=genrand_int32()>>6;
-    var a = this.genrand_int32() >>> 5,
+    const a = this.genrand_int32() >>> 5,
       b = this.genrand_int32() >>> 6;
     return (a * 67108864.0 + b) * (1.0 / 9007199254740992.0);
   };
@@ -289,4 +289,4 @@ function MersenneTwister19937() {
 //  Exports: Public API
 
 //  Export the twister class
-exports.MersenneTwister19937 = MersenneTwister19937;
+export default MersenneTwister19937;

vendor/unique.js → src/vendor/unique.ts

@@ -1,30 +1,31 @@
-// the `unique` module
-var unique = {};
-
 // global results store
 // currently uniqueness is global to entire faker instance
 // this means that faker should currently *never* return duplicate values across all API methods when using `Faker.unique`
 // it's possible in the future that some users may want to scope found per function call instead of faker instance
-var found = {};
+const found = {};
 
 // global exclude list of results
 // defaults to nothing excluded
-var exclude = [];
+const exclude: string[] = [];
 
 // current iteration or retries of unique.exec ( current loop depth )
-var currentIterations = 0;
+let currentIterations = 0;
 
 // uniqueness compare function
 // default behavior is to check value as key against object hash
-var defaultCompare = function (obj, key) {
+function defaultCompare<T, Key extends keyof T>(obj: T, key: Key): 0 | -1 {
   if (typeof obj[key] === 'undefined') {
     return -1;
   }
   return 0;
-};
+}
 
 // common error handler for messages
-unique.errorMessage = function (now, code, opts) {
+function errorMessage(
+  now: number,
+  code: string,
+  opts: { startTime: number }
+): never {
   console.error('error', code);
   console.log(
     'found',
@@ -39,12 +40,21 @@ unique.errorMessage = function (now, code, opts) {
     code +
       ' for uniqueness check \n\nMay not be able to generate any more unique values with current settings. \nTry adjusting maxTime or maxRetries parameters for faker.unique()'
   );
-};
-
-unique.exec = function (method, args, opts) {
-  //console.log(currentIterations)
-
-  var now = new Date().getTime();
+}
+
+export function exec<Method extends Function, Args extends any[], Result>(
+  method: Method,
+  args: Args,
+  opts: {
+    maxTime?: number;
+    maxRetries?: number;
+    exclude?: string | (string | Result)[];
+    compare?: (obj: any, key: string) => 0 | -1;
+    currentIterations?: number;
+    startTime?: number;
+  }
+): Result {
+  const now = new Date().getTime();
 
   opts = opts || {};
   opts.maxTime = opts.maxTime || 3;
@@ -60,7 +70,7 @@ unique.exec = function (method, args, opts) {
     opts.startTime = new Date().getTime();
   }
 
-  var startTime = opts.startTime;
+  const startTime = opts.startTime;
 
   // support single exclude argument as string
   if (typeof opts.exclude === 'string') {
@@ -73,19 +83,25 @@ unique.exec = function (method, args, opts) {
 
   // console.log(now - startTime)
   if (now - startTime >= opts.maxTime) {
-    return unique.errorMessage(now, 'Exceeded maxTime:' + opts.maxTime, opts);
+    return errorMessage(
+      now,
+      'Exceeded maxTime:' + opts.maxTime,
+      // @ts-expect-error: we know that opts.startTime is defined
+      opts
+    );
   }
 
   if (opts.currentIterations >= opts.maxRetries) {
-    return unique.errorMessage(
+    return errorMessage(
       now,
       'Exceeded maxRetries:' + opts.maxRetries,
+      // @ts-expect-error: we know that opts.startTime is defined
       opts
     );
   }
 
-  // execute the provided method to find a potential satifised value
-  var result = method.apply(this, args);
+  // execute the provided method to find a potential satisfied value
+  const result = method.apply(this, args);
 
   // if the result has not been previously found, add it to the found array and return the value as it's unique
   if (
@@ -98,8 +114,6 @@ unique.exec = function (method, args, opts) {
   } else {
     // console.log('conflict', result);
     opts.currentIterations++;
-    return unique.exec(method, args, opts);
+    return exec(method, args, opts);
   }
-};
-
-module.exports = unique;
+}