backend-test-tools 1.0.6 → 1.1.1

package/.commitlintrc.js

@@ -0,0 +1,27 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'type-enum': [
+      2,
+      'always',
+      [
+        'feat',     // New feature
+        'fix',      // Bug fix
+        'docs',     // Documentation only changes
+        'style',    // Changes that don't affect the code meaning
+        'refactor', // Code change that neither fixes a bug nor adds a feature
+        'perf',     // Performance improvement
+        'test',     // Adding missing tests or correcting existing tests
+        'build',    // Changes that affect the build system or dependencies
+        'ci',       // Changes to CI configuration files and scripts
+        'chore',    // Other changes that don't modify src or test files
+        'revert'    // Reverts a previous commit
+      ]
+    ],
+    'subject-case': [0],
+    'subject-empty': [2, 'never'],
+    'subject-full-stop': [2, 'never', '.'],
+    'type-case': [2, 'always', 'lower-case'],
+    'type-empty': [2, 'never']
+  }
+};

package/.github/workflows/release.yml

@@ -0,0 +1,46 @@
+name: Release and Publish
+
+on:
+  push:
+    branches:
+      - main
+      - master
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write
+      id-token: write
+    
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org'
+
+      - name: Install dependencies
+        run: npm ci --ignore-scripts
+
+      - name: Build
+        run: npm run build
+
+      - name: Run tests
+        run: npm test || echo "No tests to run"
+
+      - name: Semantic Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

package/.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --edit $1

package/.releaserc.js

@@ -0,0 +1,56 @@
+module.exports = {
+  branches: ['main', 'master'],
+  plugins: [
+    [
+      '@semantic-release/commit-analyzer',
+      {
+        preset: 'conventionalcommits',
+        releaseRules: [
+          { type: 'feat', release: 'minor' },
+          { type: 'fix', release: 'patch' },
+          { type: 'perf', release: 'patch' },
+          { type: 'revert', release: 'patch' },
+          { type: 'docs', release: 'patch' },
+          { type: 'style', release: 'patch' },
+          { type: 'refactor', release: 'patch' },
+          { type: 'test', release: 'patch' },
+          { type: 'build', release: 'patch' },
+          { type: 'ci', release: 'patch' },
+          { type: 'chore', release: false },
+          { breaking: true, release: 'major' }
+        ]
+      }
+    ],
+    [
+      '@semantic-release/release-notes-generator',
+      {
+        preset: 'conventionalcommits',
+        presetConfig: {
+          types: [
+            { type: 'feat', section: '✨ Features' },
+            { type: 'fix', section: '🐛 Bug Fixes' },
+            { type: 'perf', section: '⚡ Performance' },
+            { type: 'revert', section: '⏪ Reverts' },
+            { type: 'docs', section: '📚 Documentation' },
+            { type: 'style', section: '💄 Styles' },
+            { type: 'refactor', section: '♻️ Code Refactoring' },
+            { type: 'test', section: '✅ Tests' },
+            { type: 'build', section: '🏗️ Build System' },
+            { type: 'ci', section: '👷 CI/CD' },
+            { type: 'chore', section: '🔧 Chores', hidden: true }
+          ]
+        }
+      }
+    ],
+    '@semantic-release/changelog',
+    '@semantic-release/npm',
+    [
+      '@semantic-release/git',
+      {
+        assets: ['package.json', 'package-lock.json', 'CHANGELOG.md'],
+        message: 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}'
+      }
+    ],
+    '@semantic-release/github'
+  ]
+};

package/CHANGELOG.md

@@ -0,0 +1,28 @@
+## [1.1.1](https://github.com/prakashmahendran/backend-test-tools/compare/v1.1.0...v1.1.1) (2025-12-09)
+
+### 🐛 Bug Fixes
+
+* revert to unscoped package name backend-test-tools ([fc94fd0](https://github.com/prakashmahendran/backend-test-tools/commit/fc94fd09df7c464929236e989e1fe17f0f1d0009))
+
+## [1.1.0](https://github.com/prakashmahendran/backend-test-tools/compare/v1.0.1...v1.1.0) (2025-12-09)
+
+### ✨ Features
+
+* new release ([2788d85](https://github.com/prakashmahendran/backend-test-tools/commit/2788d85d454f06ab3d847e42a0629127fa830d9f))
+
+## [1.0.1](https://github.com/prakashmahendran/backend-test-tools/compare/v1.0.0...v1.0.1) (2025-12-09)
+
+### 🐛 Bug Fixes
+
+* update package name to scoped @prakashmahendran/backend-test-tools with public access ([b290250](https://github.com/prakashmahendran/backend-test-tools/commit/b290250300e07a2f576dd0990a024b13ac965d4b))
+
+## 1.0.0 (2025-12-09)
+
+### ✨ Features
+
+* modernization and automated versioning ([d12a529](https://github.com/prakashmahendran/backend-test-tools/commit/d12a5293c3b2e3368dc1f0229d462409d1cfadda))
+
+### 👷 CI/CD
+
+* allow tests to fail gracefully ([b6f7b2a](https://github.com/prakashmahendran/backend-test-tools/commit/b6f7b2ab932e06648947e877ac277f30dd1d026a))
+* skip tests if not present ([c26a07e](https://github.com/prakashmahendran/backend-test-tools/commit/c26a07e3ed2b96c4b00bbc616a7bcec11323a039))

package/dist/factory/factory.js

@@ -6,12 +6,49 @@ Object.defineProperty(exports, "__esModule", {
 exports.factory = void 0;
 var _crypto = require("crypto");
 var _workers = require("./workers");
+/**
+ * Registry of available factory models and their worker functions.
+ * Add new models here to extend factory capabilities.
+ */
 const modelsMap = {
   user: _workers.userFactoryWorker
 };
+
+/**
+ * Factory for generating test data objects.
+ * 
+ * Provides a consistent interface for creating mock entities in tests.
+ * Inspired by factory-girl pattern for predictable test data generation.
+ * 
+ * @example
+ * ```typescript
+ * // Generate a single user
+ * const user = factory.build('user');
+ * 
+ * // Generate with custom attributes
+ * const admin = factory.build('user', { role: 'admin' });
+ * 
+ * // Generate multiple users
+ * const users = factory.buildMany('user', 5);
+ * ```
+ */
 const factory = exports.factory = {
   /**
-   * Build an object according to a defined model
+   * Build a single object according to a defined model.
+   * 
+   * @template T - The model type to build
+   * @param name - The name of the model to build (e.g., 'user')
+   * @param attributes - Override specific attributes of the generated object
+   * @param buildOptions - Options passed to the worker function for customization
+   * 
+   * @returns A new instance of the specified model with a generated UUID
+   * 
+   * @throws {Error} If the specified model name is not registered
+   * 
+   * @example
+   * ```typescript
+   * const user = factory.build('user', { email: 'test@example.com' });
+   * ```
    */
   build: function (name, attributes = {}, buildOptions = {}) {
     if (!Object.keys(modelsMap).includes(name)) throw new Error(`Factory: unknown model "${name}"`);
@@ -24,7 +61,23 @@ const factory = exports.factory = {
     };
   },
   /**
-   * Build multiple objects according to a defined model
+   * Build multiple objects according to a defined model.
+   * 
+   * @template T - The model type to build
+   * @param name - The name of the model to build (e.g., 'user')
+   * @param count - The number of instances to generate
+   * @param attributes - Override specific attributes for all generated objects
+   * @param buildOptions - Options passed to the worker function for customization
+   * 
+   * @returns An array of new instances of the specified model
+   * 
+   * @throws {Error} If the specified model name is not registered
+   * 
+   * @example
+   * ```typescript
+   * const users = factory.buildMany('user', 10);
+   * const admins = factory.buildMany('user', 3, { role: 'admin' });
+   * ```
    */
   buildMany: function (name, count, attributes = {}, buildOptions = {}) {
     const instances = [];

package/dist/factory/factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"factory.js","names":["_crypto","require","_workers","modelsMap","user","userFactoryWorker","factory","exports","build","name","attributes","buildOptions","Object","keys","includes","Error","worker","instance","id","randomUUID","buildMany","count","instances","i","push"],"sources":["../../src/factory/factory.ts"],"sourcesContent":["import { randomUUID } from 'crypto';\nimport {\n  FactoryModel,\n  FactoryBuildOptions,\n  FactoryModelOverride,\n  FactoryReturnType,\n  ModelsMap\n} from './factory.types';\nimport { userFactoryWorker } from './workers';\n\nconst modelsMap: ModelsMap = {\n  user: userFactoryWorker\n};\n\nexport const factory = {\n  /**\n   * Build an object according to a defined model\n   */\n  build: function <T extends FactoryModel>(\n    name: T,\n    attributes: FactoryModelOverride<T> = {},\n    buildOptions: FactoryBuildOptions<T> = {}\n  ): FactoryReturnType<T> {\n    if (!Object.keys(modelsMap).includes(name)) throw new Error(`Factory: unknown model \"${name}\"`);\n    const worker = modelsMap[name];\n    const instance = worker(buildOptions);\n    return {\n      id: randomUUID(),\n      ...instance,\n      ...attributes\n    };\n  },\n\n  /**\n   * Build multiple objects according to a defined model\n   */\n  buildMany: function <T extends FactoryModel>(\n    name: T,\n    count: number,\n    attributes: FactoryModelOverride<T> = {},\n    buildOptions: FactoryBuildOptions<T> = {}\n  ): Array<FactoryReturnType<T>> {\n    const instances: Array<FactoryReturnType<T>> = [];\n    for (let i = 0; i < count; i++) {\n      instances.push(this.build(name, attributes, buildOptions));\n    }\n    return instances;\n  }\n};\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAQA,IAAAC,QAAA,GAAAD,OAAA;AAEA,MAAME,SAAoB,GAAG;EAC3BC,IAAI,EAAEC;AACR,CAAC;AAEM,MAAMC,OAAO,GAAAC,OAAA,CAAAD,OAAA,GAAG;EACrB;AACF;AACA;EACEE,KAAK,EAAE,SAAAA,CACLC,IAAO,EACPC,UAAmC,GAAG,CAAC,CAAC,EACxCC,YAAoC,GAAG,CAAC,CAAC,EACnB;IACtB,IAAI,CAACC,MAAM,CAACC,IAAI,CAACV,SAAS,CAAC,CAACW,QAAQ,CAACL,IAAI,CAAC,EAAE,MAAM,IAAIM,KAAK,CAAC,2BAA2BN,IAAI,GAAG,CAAC;IAC/F,MAAMO,MAAM,GAAGb,SAAS,CAACM,IAAI,CAAC;IAC9B,MAAMQ,QAAQ,GAAGD,MAAM,CAACL,YAAY,CAAC;IACrC,OAAO;MACLO,EAAE,EAAE,IAAAC,kBAAU,EAAC,CAAC;MAChB,GAAGF,QAAQ;MACX,GAAGP;IACL,CAAC;EACH,CAAC;EAED;AACF;AACA;EACEU,SAAS,EAAE,SAAAA,CACTX,IAAO,EACPY,KAAa,EACbX,UAAmC,GAAG,CAAC,CAAC,EACxCC,YAAoC,GAAG,CAAC,CAAC,EACZ;IAC7B,MAAMW,SAAsC,GAAG,EAAE;IACjD,KAAK,IAAIC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGF,KAAK,EAAEE,CAAC,EAAE,EAAE;MAC9BD,SAAS,CAACE,IAAI,CAAC,IAAI,CAAChB,KAAK,CAACC,IAAI,EAAEC,UAAU,EAAEC,YAAY,CAAC,CAAC;IAC5D;IACA,OAAOW,SAAS;EAClB;AACF,CAAC","ignoreList":[]}
+{"version":3,"file":"factory.js","names":["_crypto","require","_workers","modelsMap","user","userFactoryWorker","factory","exports","build","name","attributes","buildOptions","Object","keys","includes","Error","worker","instance","id","randomUUID","buildMany","count","instances","i","push"],"sources":["../../src/factory/factory.ts"],"sourcesContent":["import { randomUUID } from 'crypto';\nimport {\n  FactoryModel,\n  FactoryBuildOptions,\n  FactoryModelOverride,\n  FactoryReturnType,\n  ModelsMap\n} from './factory.types';\nimport { userFactoryWorker } from './workers';\n\n/**\n * Registry of available factory models and their worker functions.\n * Add new models here to extend factory capabilities.\n */\nconst modelsMap: ModelsMap = {\n  user: userFactoryWorker\n};\n\n/**\n * Factory for generating test data objects.\n * \n * Provides a consistent interface for creating mock entities in tests.\n * Inspired by factory-girl pattern for predictable test data generation.\n * \n * @example\n * ```typescript\n * // Generate a single user\n * const user = factory.build('user');\n * \n * // Generate with custom attributes\n * const admin = factory.build('user', { role: 'admin' });\n * \n * // Generate multiple users\n * const users = factory.buildMany('user', 5);\n * ```\n */\nexport const factory = {\n  /**\n   * Build a single object according to a defined model.\n   * \n   * @template T - The model type to build\n   * @param name - The name of the model to build (e.g., 'user')\n   * @param attributes - Override specific attributes of the generated object\n   * @param buildOptions - Options passed to the worker function for customization\n   * \n   * @returns A new instance of the specified model with a generated UUID\n   * \n   * @throws {Error} If the specified model name is not registered\n   * \n   * @example\n   * ```typescript\n   * const user = factory.build('user', { email: 'test@example.com' });\n   * ```\n   */\n  build: function <T extends FactoryModel>(\n    name: T,\n    attributes: FactoryModelOverride<T> = {},\n    buildOptions: FactoryBuildOptions<T> = {}\n  ): FactoryReturnType<T> {\n    if (!Object.keys(modelsMap).includes(name)) throw new Error(`Factory: unknown model \"${name}\"`);\n    const worker = modelsMap[name];\n    const instance = worker(buildOptions);\n    return {\n      id: randomUUID(),\n      ...instance,\n      ...attributes\n    };\n  },\n\n  /**\n   * Build multiple objects according to a defined model.\n   * \n   * @template T - The model type to build\n   * @param name - The name of the model to build (e.g., 'user')\n   * @param count - The number of instances to generate\n   * @param attributes - Override specific attributes for all generated objects\n   * @param buildOptions - Options passed to the worker function for customization\n   * \n   * @returns An array of new instances of the specified model\n   * \n   * @throws {Error} If the specified model name is not registered\n   * \n   * @example\n   * ```typescript\n   * const users = factory.buildMany('user', 10);\n   * const admins = factory.buildMany('user', 3, { role: 'admin' });\n   * ```\n   */\n  buildMany: function <T extends FactoryModel>(\n    name: T,\n    count: number,\n    attributes: FactoryModelOverride<T> = {},\n    buildOptions: FactoryBuildOptions<T> = {}\n  ): Array<FactoryReturnType<T>> {\n    const instances: Array<FactoryReturnType<T>> = [];\n    for (let i = 0; i < count; i++) {\n      instances.push(this.build(name, attributes, buildOptions));\n    }\n    return instances;\n  }\n};\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AAQA,IAAAC,QAAA,GAAAD,OAAA;AAEA;AACA;AACA;AACA;AACA,MAAME,SAAoB,GAAG;EAC3BC,IAAI,EAAEC;AACR,CAAC;;AAED;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,OAAO,GAAAC,OAAA,CAAAD,OAAA,GAAG;EACrB;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEE,KAAK,EAAE,SAAAA,CACLC,IAAO,EACPC,UAAmC,GAAG,CAAC,CAAC,EACxCC,YAAoC,GAAG,CAAC,CAAC,EACnB;IACtB,IAAI,CAACC,MAAM,CAACC,IAAI,CAACV,SAAS,CAAC,CAACW,QAAQ,CAACL,IAAI,CAAC,EAAE,MAAM,IAAIM,KAAK,CAAC,2BAA2BN,IAAI,GAAG,CAAC;IAC/F,MAAMO,MAAM,GAAGb,SAAS,CAACM,IAAI,CAAC;IAC9B,MAAMQ,QAAQ,GAAGD,MAAM,CAACL,YAAY,CAAC;IACrC,OAAO;MACLO,EAAE,EAAE,IAAAC,kBAAU,EAAC,CAAC;MAChB,GAAGF,QAAQ;MACX,GAAGP;IACL,CAAC;EACH,CAAC;EAED;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACEU,SAAS,EAAE,SAAAA,CACTX,IAAO,EACPY,KAAa,EACbX,UAAmC,GAAG,CAAC,CAAC,EACxCC,YAAoC,GAAG,CAAC,CAAC,EACZ;IAC7B,MAAMW,SAAsC,GAAG,EAAE;IACjD,KAAK,IAAIC,CAAC,GAAG,CAAC,EAAEA,CAAC,GAAGF,KAAK,EAAEE,CAAC,EAAE,EAAE;MAC9BD,SAAS,CAACE,IAAI,CAAC,IAAI,CAAChB,KAAK,CAACC,IAAI,EAAEC,UAAU,EAAEC,YAAY,CAAC,CAAC;IAC5D;IACA,OAAOW,SAAS;EAClB;AACF,CAAC","ignoreList":[]}

package/dist/generators/generateAccessToken.js

@@ -6,7 +6,29 @@ Object.defineProperty(exports, "__esModule", {
 exports.generateAccessToken = generateAccessToken;
 var _crypto = require("crypto");
 var _jsonwebtoken = require("jsonwebtoken");
-/** Returns an API access token valid in test environment */
+/**
+ * Generates a mock JWT access token for testing purposes.
+ * 
+ * This token is self-signed and only valid in test environments. It simulates
+ * tokens that would typically be issued by an authentication service like Auth0.
+ * 
+ * @param userId - The user ID to include in the token subject. If not provided, a random UUID will be generated.
+ * @param options - Additional JWT signing options (expiresIn, audience, issuer, etc.)
+ * @param payload - Additional payload data to include in the token
+ * 
+ * @returns A signed JWT token string
+ * 
+ * @throws {Error} If JWT_SECRET environment variable is not set
+ * 
+ * @example
+ * ```typescript
+ * const token = generateAccessToken('user-123');
+ * const tokenWithCustomPayload = generateAccessToken('user-456', {}, { role: 'admin' });
+ * const shortLivedToken = generateAccessToken('user-789', { expiresIn: '1h' });
+ * ```
+ * 
+ * @see {@link https://github.com/auth0/node-jsonwebtoken jsonwebtoken package} for available options
+ */
 function generateAccessToken(userId, options = {}, payload = {}) {
   const id = userId ?? (0, _crypto.randomUUID)();
   if (!process.env.JWT_SECRET) throw new Error('Missing JWT signing secret');

package/dist/generators/generateAccessToken.js.map

@@ -1 +1 @@
-{"version":3,"file":"generateAccessToken.js","names":["_crypto","require","_jsonwebtoken","generateAccessToken","userId","options","payload","id","randomUUID","process","env","JWT_SECRET","Error","sign","user","expiresIn","audience","ACCESS_TOKEN_AUDIENCE","issuer","ACCESS_TOKEN_ISSUER","subject","jwtid"],"sources":["../../src/generators/generateAccessToken.ts"],"sourcesContent":["import { randomUUID } from 'crypto';\nimport { sign, SignOptions } from 'jsonwebtoken';\n\n/** Returns an API access token valid in test environment */\nexport function generateAccessToken(\n  userId: string,\n  options: SignOptions = {},\n  payload: string | Buffer | object = {}\n): string {\n  const id = userId ?? randomUUID();\n  if (!process.env.JWT_SECRET) throw new Error('Missing JWT signing secret');\n  return sign(\n    typeof payload === 'object' ? { ...payload, user: { id } } : payload,\n    process.env.JWT_SECRET,\n    {\n      expiresIn: '1d',\n      audience: process.env.ACCESS_TOKEN_AUDIENCE,\n      issuer: process.env.ACCESS_TOKEN_ISSUER,\n      subject: id,\n      jwtid: randomUUID(),\n      ...options\n    }\n  );\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAEA;AACO,SAASE,mBAAmBA,CACjCC,MAAc,EACdC,OAAoB,GAAG,CAAC,CAAC,EACzBC,OAAiC,GAAG,CAAC,CAAC,EAC9B;EACR,MAAMC,EAAE,GAAGH,MAAM,IAAI,IAAAI,kBAAU,EAAC,CAAC;EACjC,IAAI,CAACC,OAAO,CAACC,GAAG,CAACC,UAAU,EAAE,MAAM,IAAIC,KAAK,CAAC,4BAA4B,CAAC;EAC1E,OAAO,IAAAC,kBAAI,EACT,OAAOP,OAAO,KAAK,QAAQ,GAAG;IAAE,GAAGA,OAAO;IAAEQ,IAAI,EAAE;MAAEP;IAAG;EAAE,CAAC,GAAGD,OAAO,EACpEG,OAAO,CAACC,GAAG,CAACC,UAAU,EACtB;IACEI,SAAS,EAAE,IAAI;IACfC,QAAQ,EAAEP,OAAO,CAACC,GAAG,CAACO,qBAAqB;IAC3CC,MAAM,EAAET,OAAO,CAACC,GAAG,CAACS,mBAAmB;IACvCC,OAAO,EAAEb,EAAE;IACXc,KAAK,EAAE,IAAAb,kBAAU,EAAC,CAAC;IACnB,GAAGH;EACL,CACF,CAAC;AACH","ignoreList":[]}
+{"version":3,"file":"generateAccessToken.js","names":["_crypto","require","_jsonwebtoken","generateAccessToken","userId","options","payload","id","randomUUID","process","env","JWT_SECRET","Error","sign","user","expiresIn","audience","ACCESS_TOKEN_AUDIENCE","issuer","ACCESS_TOKEN_ISSUER","subject","jwtid"],"sources":["../../src/generators/generateAccessToken.ts"],"sourcesContent":["import { randomUUID } from 'crypto';\nimport { sign, SignOptions } from 'jsonwebtoken';\n\n/**\n * Generates a mock JWT access token for testing purposes.\n * \n * This token is self-signed and only valid in test environments. It simulates\n * tokens that would typically be issued by an authentication service like Auth0.\n * \n * @param userId - The user ID to include in the token subject. If not provided, a random UUID will be generated.\n * @param options - Additional JWT signing options (expiresIn, audience, issuer, etc.)\n * @param payload - Additional payload data to include in the token\n * \n * @returns A signed JWT token string\n * \n * @throws {Error} If JWT_SECRET environment variable is not set\n * \n * @example\n * ```typescript\n * const token = generateAccessToken('user-123');\n * const tokenWithCustomPayload = generateAccessToken('user-456', {}, { role: 'admin' });\n * const shortLivedToken = generateAccessToken('user-789', { expiresIn: '1h' });\n * ```\n * \n * @see {@link https://github.com/auth0/node-jsonwebtoken jsonwebtoken package} for available options\n */\nexport function generateAccessToken(\n  userId: string,\n  options: SignOptions = {},\n  payload: string | Buffer | object = {}\n): string {\n  const id = userId ?? randomUUID();\n  if (!process.env.JWT_SECRET) throw new Error('Missing JWT signing secret');\n  return sign(\n    typeof payload === 'object' ? { ...payload, user: { id } } : payload,\n    process.env.JWT_SECRET,\n    {\n      expiresIn: '1d',\n      audience: process.env.ACCESS_TOKEN_AUDIENCE,\n      issuer: process.env.ACCESS_TOKEN_ISSUER,\n      subject: id,\n      jwtid: randomUUID(),\n      ...options\n    }\n  );\n}\n"],"mappings":";;;;;;AAAA,IAAAA,OAAA,GAAAC,OAAA;AACA,IAAAC,aAAA,GAAAD,OAAA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASE,mBAAmBA,CACjCC,MAAc,EACdC,OAAoB,GAAG,CAAC,CAAC,EACzBC,OAAiC,GAAG,CAAC,CAAC,EAC9B;EACR,MAAMC,EAAE,GAAGH,MAAM,IAAI,IAAAI,kBAAU,EAAC,CAAC;EACjC,IAAI,CAACC,OAAO,CAACC,GAAG,CAACC,UAAU,EAAE,MAAM,IAAIC,KAAK,CAAC,4BAA4B,CAAC;EAC1E,OAAO,IAAAC,kBAAI,EACT,OAAOP,OAAO,KAAK,QAAQ,GAAG;IAAE,GAAGA,OAAO;IAAEQ,IAAI,EAAE;MAAEP;IAAG;EAAE,CAAC,GAAGD,OAAO,EACpEG,OAAO,CAACC,GAAG,CAACC,UAAU,EACtB;IACEI,SAAS,EAAE,IAAI;IACfC,QAAQ,EAAEP,OAAO,CAACC,GAAG,CAACO,qBAAqB;IAC3CC,MAAM,EAAET,OAAO,CAACC,GAAG,CAACS,mBAAmB;IACvCC,OAAO,EAAEb,EAAE;IACXc,KAAK,EAAE,IAAAb,kBAAU,EAAC,CAAC;IACnB,GAAGH;EACL,CACF,CAAC;AACH","ignoreList":[]}

package/dist/generators/generateLocale.js

@@ -5,10 +5,25 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.TEST_LOCALES = void 0;
 exports.generateLocale = generateLocale;
+/**
+ * List of supported locales for testing purposes.
+ * Includes major languages and regional variants.
+ */
 const TEST_LOCALES = exports.TEST_LOCALES = ['ar', 'en-US', 'es-ES', 'fr-FR', 'id-ID', 'it-IT', 'ja-JP', 'km-KH', 'ko-KR', 'ms-MY', 'my-MM', 'nl-NL', 'pt-PT', 'ry-RU', 'th-TH', 'uk-UA', 'vi-VN', 'zh-CN', 'zh-TW'];
 
 /**
- * Pick up a random locale from the list of testable ones
+ * Generates a random locale from the list of supported test locales.
+ * 
+ * Useful for testing internationalization (i18n) features and ensuring
+ * your application handles different locales correctly.
+ * 
+ * @returns A randomly selected locale code (e.g., 'en-US', 'fr-FR')
+ * 
+ * @example
+ * ```typescript
+ * const locale = generateLocale();
+ * console.log(locale); // e.g., 'ja-JP'
+ * ```
  */
 function generateLocale() {
   return TEST_LOCALES[Math.floor(Math.random() * TEST_LOCALES.length)];

package/dist/generators/generateLocale.js.map

@@ -1 +1 @@
-{"version":3,"file":"generateLocale.js","names":["TEST_LOCALES","exports","generateLocale","Math","floor","random","length"],"sources":["../../src/generators/generateLocale.ts"],"sourcesContent":["export const TEST_LOCALES = [\n  'ar',\n  'en-US',\n  'es-ES',\n  'fr-FR',\n  'id-ID',\n  'it-IT',\n  'ja-JP',\n  'km-KH',\n  'ko-KR',\n  'ms-MY',\n  'my-MM',\n  'nl-NL',\n  'pt-PT',\n  'ry-RU',\n  'th-TH',\n  'uk-UA',\n  'vi-VN',\n  'zh-CN',\n  'zh-TW',\n];\n\n/**\n * Pick up a random locale from the list of testable ones\n */\nexport function generateLocale(): string {\n  return TEST_LOCALES[Math.floor(Math.random() * TEST_LOCALES.length)];\n}\n"],"mappings":";;;;;;;AAAO,MAAMA,YAAY,GAAAC,OAAA,CAAAD,YAAA,GAAG,CAC1B,IAAI,EACJ,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,CACR;;AAED;AACA;AACA;AACO,SAASE,cAAcA,CAAA,EAAW;EACvC,OAAOF,YAAY,CAACG,IAAI,CAACC,KAAK,CAACD,IAAI,CAACE,MAAM,CAAC,CAAC,GAAGL,YAAY,CAACM,MAAM,CAAC,CAAC;AACtE","ignoreList":[]}
+{"version":3,"file":"generateLocale.js","names":["TEST_LOCALES","exports","generateLocale","Math","floor","random","length"],"sources":["../../src/generators/generateLocale.ts"],"sourcesContent":["/**\n * List of supported locales for testing purposes.\n * Includes major languages and regional variants.\n */\nexport const TEST_LOCALES = [\n  'ar',\n  'en-US',\n  'es-ES',\n  'fr-FR',\n  'id-ID',\n  'it-IT',\n  'ja-JP',\n  'km-KH',\n  'ko-KR',\n  'ms-MY',\n  'my-MM',\n  'nl-NL',\n  'pt-PT',\n  'ry-RU',\n  'th-TH',\n  'uk-UA',\n  'vi-VN',\n  'zh-CN',\n  'zh-TW',\n] as const;\n\n/**\n * Generates a random locale from the list of supported test locales.\n * \n * Useful for testing internationalization (i18n) features and ensuring\n * your application handles different locales correctly.\n * \n * @returns A randomly selected locale code (e.g., 'en-US', 'fr-FR')\n * \n * @example\n * ```typescript\n * const locale = generateLocale();\n * console.log(locale); // e.g., 'ja-JP'\n * ```\n */\nexport function generateLocale(): string {\n  return TEST_LOCALES[Math.floor(Math.random() * TEST_LOCALES.length)];\n}\n"],"mappings":";;;;;;;AAAA;AACA;AACA;AACA;AACO,MAAMA,YAAY,GAAAC,OAAA,CAAAD,YAAA,GAAG,CAC1B,IAAI,EACJ,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,EACP,OAAO,CACC;;AAEV;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASE,cAAcA,CAAA,EAAW;EACvC,OAAOF,YAAY,CAACG,IAAI,CAACC,KAAK,CAACD,IAAI,CAACE,MAAM,CAAC,CAAC,GAAGL,YAAY,CAACM,MAAM,CAAC,CAAC;AACtE","ignoreList":[]}

package/dist/generators/generateUserCrypto.js

@@ -9,23 +9,54 @@ exports.generateSignKeyEncrypted = generateSignKeyEncrypted;
 exports.generateSignKeyPub = generateSignKeyPub;
 var _crypto = _interopRequireDefault(require("crypto"));
 /**
- * Generates a fake base64 string that looks like a user public key
- * /!\ This is not a valid crypto key
+ * Generates a fake base64 string that resembles a user public key.
+ * 
+ * ⚠️ **WARNING**: This is NOT a valid cryptographic key. 
+ * This function is only for testing purposes to generate mock data.
+ * 
+ * @returns A base64-encoded random string (162 bytes)
+ * 
+ * @example
+ * ```typescript
+ * const mockPublicKey = generateSignKeyPub();
+ * // Use in tests where you need a public key format
+ * ```
  */
 function generateSignKeyPub() {
   return _crypto.default.randomBytes(162).toString('base64');
 }
+
 /**
- * Generates a fake base64 string that looks like a user encrypted private key
- * /!\ This is not a valid crypto key
+ * Generates a fake base64 string that resembles a user encrypted private key.
+ * 
+ * ⚠️ **WARNING**: This is NOT a valid cryptographic key.
+ * This function is only for testing purposes to generate mock data.
+ * 
+ * @returns A base64-encoded random string (640 bytes)
+ * 
+ * @example
+ * ```typescript
+ * const mockPrivateKey = generateSignKeyEncrypted();
+ * // Use in tests where you need an encrypted private key format
+ * ```
  */
 function generateSignKeyEncrypted() {
   return _crypto.default.randomBytes(640).toString('base64');
 }
 
 /**
- * Generates a fake base64 string that looks like a user encrypted Blackberry Passcode
- * /!\ This is not a valid crypto key
+ * Generates a fake base64 string that resembles an encrypted BlackBerry passcode.
+ * 
+ * ⚠️ **WARNING**: This is NOT a valid cryptographic key.
+ * This function is only for testing purposes to generate mock data.
+ * 
+ * @returns A base64-encoded random string (80 bytes)
+ * 
+ * @example
+ * ```typescript
+ * const mockPasscode = generateBbEncrypted();
+ * // Use in tests where you need a BlackBerry passcode format
+ * ```
  */
 function generateBbEncrypted() {
   return _crypto.default.randomBytes(80).toString('base64');

package/dist/generators/generateUserCrypto.js.map

@@ -1 +1 @@
-{"version":3,"file":"generateUserCrypto.js","names":["_crypto","_interopRequireDefault","require","generateSignKeyPub","crypto","randomBytes","toString","generateSignKeyEncrypted","generateBbEncrypted"],"sources":["../../src/generators/generateUserCrypto.ts"],"sourcesContent":["import crypto from 'crypto';\n\n/**\n * Generates a fake base64 string that looks like a user public key\n * /!\\ This is not a valid crypto key\n */\nexport function generateSignKeyPub(): string {\n  return crypto.randomBytes(162).toString('base64');\n}\n/**\n * Generates a fake base64 string that looks like a user encrypted private key\n * /!\\ This is not a valid crypto key\n */\nexport function generateSignKeyEncrypted(): string {\n  return crypto.randomBytes(640).toString('base64');\n}\n\n/**\n * Generates a fake base64 string that looks like a user encrypted Blackberry Passcode\n * /!\\ This is not a valid crypto key\n */\nexport function generateBbEncrypted(): string {\n  return crypto.randomBytes(80).toString('base64');\n}\n"],"mappings":";;;;;;;;;AAAA,IAAAA,OAAA,GAAAC,sBAAA,CAAAC,OAAA;AAEA;AACA;AACA;AACA;AACO,SAASC,kBAAkBA,CAAA,EAAW;EAC3C,OAAOC,eAAM,CAACC,WAAW,CAAC,GAAG,CAAC,CAACC,QAAQ,CAAC,QAAQ,CAAC;AACnD;AACA;AACA;AACA;AACA;AACO,SAASC,wBAAwBA,CAAA,EAAW;EACjD,OAAOH,eAAM,CAACC,WAAW,CAAC,GAAG,CAAC,CAACC,QAAQ,CAAC,QAAQ,CAAC;AACnD;;AAEA;AACA;AACA;AACA;AACO,SAASE,mBAAmBA,CAAA,EAAW;EAC5C,OAAOJ,eAAM,CAACC,WAAW,CAAC,EAAE,CAAC,CAACC,QAAQ,CAAC,QAAQ,CAAC;AAClD","ignoreList":[]}
+{"version":3,"file":"generateUserCrypto.js","names":["_crypto","_interopRequireDefault","require","generateSignKeyPub","crypto","randomBytes","toString","generateSignKeyEncrypted","generateBbEncrypted"],"sources":["../../src/generators/generateUserCrypto.ts"],"sourcesContent":["import crypto from 'crypto';\n\n/**\n * Generates a fake base64 string that resembles a user public key.\n * \n * ⚠️ **WARNING**: This is NOT a valid cryptographic key. \n * This function is only for testing purposes to generate mock data.\n * \n * @returns A base64-encoded random string (162 bytes)\n * \n * @example\n * ```typescript\n * const mockPublicKey = generateSignKeyPub();\n * // Use in tests where you need a public key format\n * ```\n */\nexport function generateSignKeyPub(): string {\n  return crypto.randomBytes(162).toString('base64');\n}\n\n/**\n * Generates a fake base64 string that resembles a user encrypted private key.\n * \n * ⚠️ **WARNING**: This is NOT a valid cryptographic key.\n * This function is only for testing purposes to generate mock data.\n * \n * @returns A base64-encoded random string (640 bytes)\n * \n * @example\n * ```typescript\n * const mockPrivateKey = generateSignKeyEncrypted();\n * // Use in tests where you need an encrypted private key format\n * ```\n */\nexport function generateSignKeyEncrypted(): string {\n  return crypto.randomBytes(640).toString('base64');\n}\n\n/**\n * Generates a fake base64 string that resembles an encrypted BlackBerry passcode.\n * \n * ⚠️ **WARNING**: This is NOT a valid cryptographic key.\n * This function is only for testing purposes to generate mock data.\n * \n * @returns A base64-encoded random string (80 bytes)\n * \n * @example\n * ```typescript\n * const mockPasscode = generateBbEncrypted();\n * // Use in tests where you need a BlackBerry passcode format\n * ```\n */\nexport function generateBbEncrypted(): string {\n  return crypto.randomBytes(80).toString('base64');\n}\n"],"mappings":";;;;;;;;;AAAA,IAAAA,OAAA,GAAAC,sBAAA,CAAAC,OAAA;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,kBAAkBA,CAAA,EAAW;EAC3C,OAAOC,eAAM,CAACC,WAAW,CAAC,GAAG,CAAC,CAACC,QAAQ,CAAC,QAAQ,CAAC;AACnD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASC,wBAAwBA,CAAA,EAAW;EACjD,OAAOH,eAAM,CAACC,WAAW,CAAC,GAAG,CAAC,CAACC,QAAQ,CAAC,QAAQ,CAAC;AACnD;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAASE,mBAAmBA,CAAA,EAAW;EAC5C,OAAOJ,eAAM,CAACC,WAAW,CAAC,EAAE,CAAC,CAACC,QAAQ,CAAC,QAAQ,CAAC;AAClD","ignoreList":[]}

package/dist/src/factory/factory.d.ts

@@ -0,0 +1,59 @@
+import { FactoryModel, FactoryBuildOptions, FactoryModelOverride, FactoryReturnType } from './factory.types';
+/**
+ * Factory for generating test data objects.
+ *
+ * Provides a consistent interface for creating mock entities in tests.
+ * Inspired by factory-girl pattern for predictable test data generation.
+ *
+ * @example
+ * ```typescript
+ * // Generate a single user
+ * const user = factory.build('user');
+ *
+ * // Generate with custom attributes
+ * const admin = factory.build('user', { role: 'admin' });
+ *
+ * // Generate multiple users
+ * const users = factory.buildMany('user', 5);
+ * ```
+ */
+export declare const factory: {
+    /**
+     * Build a single object according to a defined model.
+     *
+     * @template T - The model type to build
+     * @param name - The name of the model to build (e.g., 'user')
+     * @param attributes - Override specific attributes of the generated object
+     * @param buildOptions - Options passed to the worker function for customization
+     *
+     * @returns A new instance of the specified model with a generated UUID
+     *
+     * @throws {Error} If the specified model name is not registered
+     *
+     * @example
+     * ```typescript
+     * const user = factory.build('user', { email: 'test@example.com' });
+     * ```
+     */
+    build: <T extends FactoryModel>(name: T, attributes?: FactoryModelOverride<T>, buildOptions?: FactoryBuildOptions<T>) => FactoryReturnType<T>;
+    /**
+     * Build multiple objects according to a defined model.
+     *
+     * @template T - The model type to build
+     * @param name - The name of the model to build (e.g., 'user')
+     * @param count - The number of instances to generate
+     * @param attributes - Override specific attributes for all generated objects
+     * @param buildOptions - Options passed to the worker function for customization
+     *
+     * @returns An array of new instances of the specified model
+     *
+     * @throws {Error} If the specified model name is not registered
+     *
+     * @example
+     * ```typescript
+     * const users = factory.buildMany('user', 10);
+     * const admins = factory.buildMany('user', 3, { role: 'admin' });
+     * ```
+     */
+    buildMany: <T extends FactoryModel>(name: T, count: number, attributes?: FactoryModelOverride<T>, buildOptions?: FactoryBuildOptions<T>) => Array<FactoryReturnType<T>>;
+};

package/dist/src/generators/generateAccessToken.d.ts

@@ -0,0 +1,25 @@
+import { SignOptions } from 'jsonwebtoken';
+/**
+ * Generates a mock JWT access token for testing purposes.
+ *
+ * This token is self-signed and only valid in test environments. It simulates
+ * tokens that would typically be issued by an authentication service like Auth0.
+ *
+ * @param userId - The user ID to include in the token subject. If not provided, a random UUID will be generated.
+ * @param options - Additional JWT signing options (expiresIn, audience, issuer, etc.)
+ * @param payload - Additional payload data to include in the token
+ *
+ * @returns A signed JWT token string
+ *
+ * @throws {Error} If JWT_SECRET environment variable is not set
+ *
+ * @example
+ * ```typescript
+ * const token = generateAccessToken('user-123');
+ * const tokenWithCustomPayload = generateAccessToken('user-456', {}, { role: 'admin' });
+ * const shortLivedToken = generateAccessToken('user-789', { expiresIn: '1h' });
+ * ```
+ *
+ * @see {@link https://github.com/auth0/node-jsonwebtoken jsonwebtoken package} for available options
+ */
+export declare function generateAccessToken(userId: string, options?: SignOptions, payload?: string | Buffer | object): string;

package/dist/src/generators/generateLocale.d.ts

@@ -0,0 +1,20 @@
+/**
+ * List of supported locales for testing purposes.
+ * Includes major languages and regional variants.
+ */
+export declare const TEST_LOCALES: readonly ["ar", "en-US", "es-ES", "fr-FR", "id-ID", "it-IT", "ja-JP", "km-KH", "ko-KR", "ms-MY", "my-MM", "nl-NL", "pt-PT", "ry-RU", "th-TH", "uk-UA", "vi-VN", "zh-CN", "zh-TW"];
+/**
+ * Generates a random locale from the list of supported test locales.
+ *
+ * Useful for testing internationalization (i18n) features and ensuring
+ * your application handles different locales correctly.
+ *
+ * @returns A randomly selected locale code (e.g., 'en-US', 'fr-FR')
+ *
+ * @example
+ * ```typescript
+ * const locale = generateLocale();
+ * console.log(locale); // e.g., 'ja-JP'
+ * ```
+ */
+export declare function generateLocale(): string;

package/dist/src/generators/generateUserCrypto.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Generates a fake base64 string that resembles a user public key.
+ *
+ * ⚠️ **WARNING**: This is NOT a valid cryptographic key.
+ * This function is only for testing purposes to generate mock data.
+ *
+ * @returns A base64-encoded random string (162 bytes)
+ *
+ * @example
+ * ```typescript
+ * const mockPublicKey = generateSignKeyPub();
+ * // Use in tests where you need a public key format
+ * ```
+ */
+export declare function generateSignKeyPub(): string;
+/**
+ * Generates a fake base64 string that resembles a user encrypted private key.
+ *
+ * ⚠️ **WARNING**: This is NOT a valid cryptographic key.
+ * This function is only for testing purposes to generate mock data.
+ *
+ * @returns A base64-encoded random string (640 bytes)
+ *
+ * @example
+ * ```typescript
+ * const mockPrivateKey = generateSignKeyEncrypted();
+ * // Use in tests where you need an encrypted private key format
+ * ```
+ */
+export declare function generateSignKeyEncrypted(): string;
+/**
+ * Generates a fake base64 string that resembles an encrypted BlackBerry passcode.
+ *
+ * ⚠️ **WARNING**: This is NOT a valid cryptographic key.
+ * This function is only for testing purposes to generate mock data.
+ *
+ * @returns A base64-encoded random string (80 bytes)
+ *
+ * @example
+ * ```typescript
+ * const mockPasscode = generateBbEncrypted();
+ * // Use in tests where you need a BlackBerry passcode format
+ * ```
+ */
+export declare function generateBbEncrypted(): string;

package/eslint.config.mjs

@@ -3,9 +3,26 @@ import pluginJs from '@eslint/js';
 import tseslint from 'typescript-eslint';
 
 export default [
-  { files: ['.src/', '**/*.{js,mjs,cjs,ts}'] },
-  { languageOptions: { globals: { ...globals.browser, ...globals.node } } },
+  { files: ['src/**/*.{js,mjs,cjs,ts}', 'test/**/*.{js,mjs,cjs,ts}'] },
+  { 
+    languageOptions: { 
+      globals: { ...globals.node },
+      parserOptions: {
+        ecmaVersion: 2023,
+        sourceType: 'module'
+      }
+    } 
+  },
   pluginJs.configs.recommended,
-  { ignores: ['**/*.test.ts', '**/*.d.ts'] },
-  ...tseslint.configs.recommended
+  { ignores: ['**/*.test.ts', '**/*.d.ts', 'dist/**', 'node_modules/**'] },
+  ...tseslint.configs.recommended,
+  {
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'warn',
+      '@typescript-eslint/no-unused-vars': ['error', { 
+        'argsIgnorePattern': '^_',
+        'varsIgnorePattern': '^_'
+      }]
+    }
+  }
 ];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "backend-test-tools",
-  "version": "1.0.6",
-  "description": "Node test tools",
+  "version": "1.1.1",
+  "description": "Backend Node test tools",
   "main": "dist/index.js",
   "scripts": {
     "lint": "eslint ./src",
@@ -28,8 +28,12 @@
     "@babel/preset-env": "^7.26.0",
     "@babel/preset-typescript": "^7.26.0",
     "@babel/register": "^7.25.9",
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
     "@eslint/js": "^9.17.0",
     "@faker-js/faker": "^9.3.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
     "@types/chai": "^5.0.1",
     "@types/jsonwebtoken": "^9.0.7",
     "@types/mocha": "^10.0.10",
@@ -43,6 +47,7 @@
     "babel-plugin-istanbul": "^7.0.0",
     "babel-plugin-module-resolver": "^5.0.2",
     "babel-plugin-tsconfig-paths": "^1.0.3",
+    "conventional-changelog-conventionalcommits": "^8.0.0",
     "core-js": "^3.39.0",
     "eslint": "^9.17.0",
     "globals": "^15.14.0",
@@ -52,6 +57,7 @@
     "nyc": "^17.1.0",
     "prettier": "^3.4.2",
     "rimraf": "^6.0.1",
+    "semantic-release": "^24.2.9",
     "ts-node": "^10.9.2",
     "tsc-alias": "^1.8.10",
     "tsconfig-paths": "^4.2.0",
@@ -68,7 +74,7 @@
     "*.ts": "eslint"
   },
   "peerDependencies": {
-    "node-server-engine": "^1.1.5"
+    "node-server-engine": "^1.2.6"
   },
   "dependencies": {
     "@babel/runtime": "^7.26.0",

package/src/factory/factory.ts

@@ -8,13 +8,49 @@ import {
 } from './factory.types';
 import { userFactoryWorker } from './workers';
 
+/**
+ * Registry of available factory models and their worker functions.
+ * Add new models here to extend factory capabilities.
+ */
 const modelsMap: ModelsMap = {
   user: userFactoryWorker
 };
 
+/**
+ * Factory for generating test data objects.
+ * 
+ * Provides a consistent interface for creating mock entities in tests.
+ * Inspired by factory-girl pattern for predictable test data generation.
+ * 
+ * @example
+ * ```typescript
+ * // Generate a single user
+ * const user = factory.build('user');
+ * 
+ * // Generate with custom attributes
+ * const admin = factory.build('user', { role: 'admin' });
+ * 
+ * // Generate multiple users
+ * const users = factory.buildMany('user', 5);
+ * ```
+ */
 export const factory = {
   /**
-   * Build an object according to a defined model
+   * Build a single object according to a defined model.
+   * 
+   * @template T - The model type to build
+   * @param name - The name of the model to build (e.g., 'user')
+   * @param attributes - Override specific attributes of the generated object
+   * @param buildOptions - Options passed to the worker function for customization
+   * 
+   * @returns A new instance of the specified model with a generated UUID
+   * 
+   * @throws {Error} If the specified model name is not registered
+   * 
+   * @example
+   * ```typescript
+   * const user = factory.build('user', { email: 'test@example.com' });
+   * ```
    */
   build: function <T extends FactoryModel>(
     name: T,
@@ -32,7 +68,23 @@ export const factory = {
   },
 
   /**
-   * Build multiple objects according to a defined model
+   * Build multiple objects according to a defined model.
+   * 
+   * @template T - The model type to build
+   * @param name - The name of the model to build (e.g., 'user')
+   * @param count - The number of instances to generate
+   * @param attributes - Override specific attributes for all generated objects
+   * @param buildOptions - Options passed to the worker function for customization
+   * 
+   * @returns An array of new instances of the specified model
+   * 
+   * @throws {Error} If the specified model name is not registered
+   * 
+   * @example
+   * ```typescript
+   * const users = factory.buildMany('user', 10);
+   * const admins = factory.buildMany('user', 3, { role: 'admin' });
+   * ```
    */
   buildMany: function <T extends FactoryModel>(
     name: T,

package/src/generators/generateAccessToken.ts

@@ -1,7 +1,29 @@
 import { randomUUID } from 'crypto';
 import { sign, SignOptions } from 'jsonwebtoken';
 
-/** Returns an API access token valid in test environment */
+/**
+ * Generates a mock JWT access token for testing purposes.
+ * 
+ * This token is self-signed and only valid in test environments. It simulates
+ * tokens that would typically be issued by an authentication service like Auth0.
+ * 
+ * @param userId - The user ID to include in the token subject. If not provided, a random UUID will be generated.
+ * @param options - Additional JWT signing options (expiresIn, audience, issuer, etc.)
+ * @param payload - Additional payload data to include in the token
+ * 
+ * @returns A signed JWT token string
+ * 
+ * @throws {Error} If JWT_SECRET environment variable is not set
+ * 
+ * @example
+ * ```typescript
+ * const token = generateAccessToken('user-123');
+ * const tokenWithCustomPayload = generateAccessToken('user-456', {}, { role: 'admin' });
+ * const shortLivedToken = generateAccessToken('user-789', { expiresIn: '1h' });
+ * ```
+ * 
+ * @see {@link https://github.com/auth0/node-jsonwebtoken jsonwebtoken package} for available options
+ */
 export function generateAccessToken(
   userId: string,
   options: SignOptions = {},

package/src/generators/generateLocale.ts

@@ -1,3 +1,7 @@
+/**
+ * List of supported locales for testing purposes.
+ * Includes major languages and regional variants.
+ */
 export const TEST_LOCALES = [
   'ar',
   'en-US',
@@ -18,10 +22,21 @@ export const TEST_LOCALES = [
   'vi-VN',
   'zh-CN',
   'zh-TW',
-];
+] as const;
 
 /**
- * Pick up a random locale from the list of testable ones
+ * Generates a random locale from the list of supported test locales.
+ * 
+ * Useful for testing internationalization (i18n) features and ensuring
+ * your application handles different locales correctly.
+ * 
+ * @returns A randomly selected locale code (e.g., 'en-US', 'fr-FR')
+ * 
+ * @example
+ * ```typescript
+ * const locale = generateLocale();
+ * console.log(locale); // e.g., 'ja-JP'
+ * ```
  */
 export function generateLocale(): string {
   return TEST_LOCALES[Math.floor(Math.random() * TEST_LOCALES.length)];

package/src/generators/generateUserCrypto.ts

@@ -1,23 +1,54 @@
 import crypto from 'crypto';
 
 /**
- * Generates a fake base64 string that looks like a user public key
- * /!\ This is not a valid crypto key
+ * Generates a fake base64 string that resembles a user public key.
+ * 
+ * ⚠️ **WARNING**: This is NOT a valid cryptographic key. 
+ * This function is only for testing purposes to generate mock data.
+ * 
+ * @returns A base64-encoded random string (162 bytes)
+ * 
+ * @example
+ * ```typescript
+ * const mockPublicKey = generateSignKeyPub();
+ * // Use in tests where you need a public key format
+ * ```
  */
 export function generateSignKeyPub(): string {
   return crypto.randomBytes(162).toString('base64');
 }
+
 /**
- * Generates a fake base64 string that looks like a user encrypted private key
- * /!\ This is not a valid crypto key
+ * Generates a fake base64 string that resembles a user encrypted private key.
+ * 
+ * ⚠️ **WARNING**: This is NOT a valid cryptographic key.
+ * This function is only for testing purposes to generate mock data.
+ * 
+ * @returns A base64-encoded random string (640 bytes)
+ * 
+ * @example
+ * ```typescript
+ * const mockPrivateKey = generateSignKeyEncrypted();
+ * // Use in tests where you need an encrypted private key format
+ * ```
  */
 export function generateSignKeyEncrypted(): string {
   return crypto.randomBytes(640).toString('base64');
 }
 
 /**
- * Generates a fake base64 string that looks like a user encrypted Blackberry Passcode
- * /!\ This is not a valid crypto key
+ * Generates a fake base64 string that resembles an encrypted BlackBerry passcode.
+ * 
+ * ⚠️ **WARNING**: This is NOT a valid cryptographic key.
+ * This function is only for testing purposes to generate mock data.
+ * 
+ * @returns A base64-encoded random string (80 bytes)
+ * 
+ * @example
+ * ```typescript
+ * const mockPasscode = generateBbEncrypted();
+ * // Use in tests where you need a BlackBerry passcode format
+ * ```
  */
 export function generateBbEncrypted(): string {
   return crypto.randomBytes(80).toString('base64');

package/tsconfig.build.json

@@ -1,4 +1,8 @@
 {
   "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "noUnusedLocals": false,
+    "noUnusedParameters": false
+  },
   "include": ["src"]
 }

package/tsconfig.json

@@ -5,14 +5,21 @@
       "test": ["../test"],
       "test/*": ["../test/*"]
     },
-    "target": "ES6",
-    "lib": ["es2023"],
+    "target": "ES2022",
+    "lib": ["ES2023"],
     "module": "commonjs",
     "moduleResolution": "node",
     "outDir": "./dist",
+    "rootDir": "./",
     "noImplicitAny": true,
     "noImplicitThis": true,
     "strictNullChecks": true,
+    "strictBindCallApply": true,
+    "strictFunctionTypes": true,
+    "strictPropertyInitialization": true,
+    "noImplicitReturns": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
     "allowJs": true,
     "skipLibCheck": true,
     "esModuleInterop": true,
@@ -26,5 +33,6 @@
     "declaration": true,
     "emitDeclarationOnly": true
   },
-  "include": ["src", "test"]
+  "include": ["src", "test"],
+  "exclude": ["node_modules", "dist", "**/*.test.ts"]
 }

package/dist/factory/factory.d.ts

@@ -1,11 +0,0 @@
-import { FactoryModel, FactoryBuildOptions, FactoryModelOverride, FactoryReturnType } from './factory.types';
-export declare const factory: {
-    /**
-     * Build an object according to a defined model
-     */
-    build: <T extends FactoryModel>(name: T, attributes?: FactoryModelOverride<T>, buildOptions?: FactoryBuildOptions<T>) => FactoryReturnType<T>;
-    /**
-     * Build multiple objects according to a defined model
-     */
-    buildMany: <T extends FactoryModel>(name: T, count: number, attributes?: FactoryModelOverride<T>, buildOptions?: FactoryBuildOptions<T>) => Array<FactoryReturnType<T>>;
-};

package/dist/generators/generateAccessToken.d.ts

@@ -1,3 +0,0 @@
-import { SignOptions } from 'jsonwebtoken';
-/** Returns an API access token valid in test environment */
-export declare function generateAccessToken(userId: string, options?: SignOptions, payload?: string | Buffer | object): string;

package/dist/generators/generateLocale.d.ts

@@ -1,5 +0,0 @@
-export declare const TEST_LOCALES: string[];
-/**
- * Pick up a random locale from the list of testable ones
- */
-export declare function generateLocale(): string;

package/dist/generators/generateUserCrypto.d.ts

@@ -1,15 +0,0 @@
-/**
- * Generates a fake base64 string that looks like a user public key
- * /!\ This is not a valid crypto key
- */
-export declare function generateSignKeyPub(): string;
-/**
- * Generates a fake base64 string that looks like a user encrypted private key
- * /!\ This is not a valid crypto key
- */
-export declare function generateSignKeyEncrypted(): string;
-/**
- * Generates a fake base64 string that looks like a user encrypted Blackberry Passcode
- * /!\ This is not a valid crypto key
- */
-export declare function generateBbEncrypted(): string;