genkode 1.1.0 → 1.3.0

package/.github/workflows/ci.yml

@@ -0,0 +1,95 @@
+name: CI/CD Pipeline
+
+on:
+  push:
+    branches:
+      - 'feature/**'
+      - master
+  pull_request:
+    branches:
+      - master
+
+jobs:
+  build-and-test:
+    name: Build & Test
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build project
+        run: npm run build
+
+      - name: Run tests
+        run: npm test
+
+  publish:
+    name: Auto Version & Publish
+    runs-on: ubuntu-latest
+    needs: build-and-test
+    if: "github.ref == 'refs/heads/master'"
+    permissions:
+      contents: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org/
+
+      - name: Install dependencies
+        run: npm install
+
+      - name: Build project
+        run: npm run build
+
+      - name: Configure Git
+        run: |
+          git config user.name "github-actions"
+          git config user.email "github-actions@github.com"
+
+      - name: Determine version bump
+        id: version
+        run: |
+          MSG="$(git log -1 --pretty=%B)"
+
+          if [[ "$MSG" == *"BREAKING"* ]]; then
+            echo "type=major" >> "$GITHUB_OUTPUT"
+          elif [[ "$MSG" == *"feat"* ]]; then
+            echo "type=minor" >> "$GITHUB_OUTPUT"
+          else
+            echo "type=patch" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Stage build output
+        run: |
+          git add -A
+          git diff --cached --quiet || git commit -m "chore: build output"
+
+      - name: Bump version
+        run: 'npm version ${{ steps.version.outputs.type }} -m "release: %s"'
+
+      - name: Push version commit
+        run: git push origin master --follow-tags
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publish to npm
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/README.md

@@ -26,37 +26,30 @@ npm install genkode
 import { generateCode } from 'genkode';
 
 generateCode({ length: 12 });
-// Example: aZ8kL2pQ9xW1
+// Example: rqfvYxJRWfoP  (alpha by default)
 
-generateCode({ length: 12, type: "alpha" });
-// Example: rqfvYxJRWfoP
+generateCode({ length: 12, type: "alphanumeric" });
+// Example: aZ8kL2pQ9xW1
 
 generateCode({ length: 12, type: "numeric" });
 // Example: 362128126198
-```
-
----
-
-### Simple helper functions
 
-```ts
-import { randomString, randomAlpha, randomNumeric } from 'genkode';
-
-randomString(12);   // alphanumeric
-randomAlpha(12);    // alphabets only
-randomNumeric(12);  // numbers only
+// Cryptographically secure generation
+generateCode({ length: 12, type: "alphanumeric", secure: true });
+// Example: Tz3mW8qA1nXp
 ```
 
 ---
 
 ## ⚙️ API
 
-### generateCode(options)
+### `generateCode(options)`
 
-| Property | Type | Description |
-|----------|------|-------------|
-| length   | number | Required length of string |
-| type     | "alpha" \| "numeric" \| "alphanumeric" | Optional (default: alphanumeric) |
+| Property | Type | Default | Description |
+|----------|------|---------|-------------|
+| `length` | `number` | — | Required. Length of the generated string |
+| `type` | `"alpha"` \| `"numeric"` \| `"alphanumeric"` | `"alpha"` | Character set to use |
+| `secure` | `boolean` | `false` | Use `crypto.getRandomValues` for cryptographically secure output |
 
 ---
 
@@ -67,6 +60,7 @@ randomNumeric(12);  // numbers only
 - TypeScript support
 - Simple and flexible API
 - Multiple formats (alpha, numeric, alphanumeric)
+- Optional cryptographically secure mode via Web Crypto API
 
 ---
 
@@ -80,10 +74,15 @@ randomNumeric(12);  // numbers only
 
 ---
 
-## 🔒 Notes
+## 🔒 Security
+
+By default, `generateCode` uses `Math.random`, which is fast but **not cryptographically secure**.
 
-- Uses Math.random (not cryptographically secure)
-- Suitable for general-purpose usage
+Set `secure: true` to use `crypto.getRandomValues` (Web Crypto API), which produces unbiased, cryptographically secure output. Use this when generating tokens, API keys, or any value where predictability is a security concern.
+
+```ts
+generateCode({ length: 32, type: "alphanumeric", secure: true });
+```
 
 ---
 
@@ -98,4 +97,4 @@ https://www.npmjs.com/package/node-mumble
 
 ## 📄 License
 
-MIT
+MIT

package/dist/index.d.ts

@@ -1,6 +1,3 @@
-import type { GenerateCodeOptions } from "./kode.interface.js";
-export declare function generateCode({ length, type }: GenerateCodeOptions): string;
-export declare function randomString(length: number): string;
-export declare function randomAlpha(length: number): string;
-export declare function randomNumeric(length: number): string;
+import type { GenerateOptions } from "./kode.interface.js";
+export declare function generateCode({ length, type, secure }: GenerateOptions): string;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAmB/D,wBAAgB,YAAY,CAAC,EAAE,MAAM,EAAE,IAAqB,EAAE,EAAE,mBAAmB,GAAG,MAAM,CAI3F;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEnD;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAElD;AAED,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAEpD"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAmD3D,wBAAgB,YAAY,CAAC,EAAC,MAAM,EAAC,IAAc,EAAC,MAAc,EAAC,EAAE,eAAe,GAAG,MAAM,CAS5F"}

package/dist/index.js

@@ -11,20 +11,34 @@ function generate(length, charset) {
     }
     return result;
 }
-export function generateCode({ length, type = "alphanumeric" }) {
-    if (type === "alpha")
-        return generate(length, ALPHA);
-    if (type === "numeric")
-        return generate(length, NUMERIC);
-    return generate(length, ALPHANUM);
+function generateSecure(length, charset) {
+    const max = charset.length;
+    const result = [];
+    const randomBuffer = new Uint8Array(1);
+    while (result.length < length) {
+        crypto.getRandomValues(randomBuffer);
+        const byte = randomBuffer[0];
+        if (byte < Math.floor(256 / max) * max) {
+            result.push(charset[byte % max]);
+        }
+    }
+    return result.join("");
 }
-export function randomString(length) {
+function randomString(length) {
     return generate(length, ALPHANUM);
 }
-export function randomAlpha(length) {
+function randomAlpha(length) {
     return generate(length, ALPHA);
 }
-export function randomNumeric(length) {
+function randomNumeric(length) {
     return generate(length, NUMERIC);
 }
+export function generateCode({ length, type = "alpha", secure = false }) {
+    const charset = type === "alpha" ? ALPHA :
+        type === "numeric" ? NUMERIC :
+            ALPHANUM;
+    return secure
+        ? generateSecure(length, charset)
+        : generate(length, charset);
+}
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAEA,MAAM,KAAK,GAAG,sDAAsD,CAAC;AACrE,MAAM,OAAO,GAAG,YAAY,CAAC;AAC7B,MAAM,QAAQ,GAAG,KAAK,GAAG,OAAO,CAAC;AAEjC,SAAS,QAAQ,CAAC,MAAc,EAAE,OAAe;IAC/C,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;IAE3B,OAAO,MAAM,GAAG,CAAC,EAAE,CAAC;QAClB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC;QAC9C,MAAM,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;QACzB,MAAM,EAAE,CAAC;IACX,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,EAAE,MAAM,EAAE,IAAI,GAAG,cAAc,EAAuB;IACjF,IAAI,IAAI,KAAK,OAAO;QAAE,OAAO,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACrD,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACzD,OAAO,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,MAAc;IACzC,OAAO,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACpC,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,MAAc;IACxC,OAAO,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AACjC,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,MAAc;IAC1C,OAAO,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACnC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAEA,MAAM,KAAK,GAAG,sDAAsD,CAAC;AACrE,MAAM,OAAO,GAAG,YAAY,CAAC;AAC7B,MAAM,QAAQ,GAAG,KAAK,GAAG,OAAO,CAAC;AAEjC,SAAS,QAAQ,CAAC,MAAc,EAAE,OAAe;IAC/C,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;IAE3B,OAAO,MAAM,GAAG,CAAC,EAAE,CAAC;QAClB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC;QAC9C,MAAM,IAAI,OAAO,CAAC,KAAK,CAAE,CAAC;QAC1B,MAAM,EAAE,CAAC;IACX,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAGD,SAAS,cAAc,CAAC,MAAc,EAAE,OAAe;IACrD,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC;IAC3B,MAAM,MAAM,GAAa,EAAE,CAAC;IAC5B,MAAM,YAAY,GAAG,IAAI,UAAU,CAAC,CAAC,CAAC,CAAC;IAEvC,OAAO,MAAM,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC;QAC9B,MAAM,CAAC,eAAe,CAAC,YAAY,CAAC,CAAC;QACrC,MAAM,IAAI,GAAG,YAAY,CAAC,CAAC,CAAE,CAAC;QAE9B,IAAI,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,GAAG,CAAC,GAAG,GAAG,EAAE,CAAC;YACvC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,GAAG,GAAG,CAAE,CAAC,CAAC;QACpC,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AACzB,CAAC;AAGD,SAAS,YAAY,CAAC,MAAc;IAClC,OAAO,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AACpC,CAAC;AAED,SAAS,WAAW,CAAC,MAAc;IACjC,OAAO,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;AACjC,CAAC;AAED,SAAS,aAAa,CAAC,MAAc;IACnC,OAAO,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AACnC,CAAC;AAGD,MAAM,UAAU,YAAY,CAAC,EAAC,MAAM,EAAC,IAAI,GAAG,OAAO,EAAC,MAAM,GAAG,KAAK,EAAkB;IAClF,MAAM,OAAO,GACX,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC1B,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;YAC9B,QAAQ,CAAC;IAEX,OAAO,MAAM;QACX,CAAC,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC;QACjC,CAAC,CAAC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAChC,CAAC"}

package/dist/kode.interface.d.ts

@@ -1,5 +1,7 @@
-export interface GenerateCodeOptions {
+export type CodeType = "alpha" | "numeric" | "alphanumeric";
+export interface GenerateOptions {
     length: number;
-    type?: "alpha" | "numeric" | "alphanumeric";
+    type?: CodeType;
+    secure?: boolean;
 }
 //# sourceMappingURL=kode.interface.d.ts.map

package/dist/kode.interface.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kode.interface.d.ts","sourceRoot":"","sources":["../kode.interface.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,OAAO,GAAG,SAAS,GAAG,cAAc,CAAC;CAC7C"}
+{"version":3,"file":"kode.interface.d.ts","sourceRoot":"","sources":["../kode.interface.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,cAAc,CAAC;AAE5D,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB"}

package/index.ts

@@ -1,4 +1,4 @@
-import type { GenerateCodeOptions } from "./kode.interface.js";
+import type { GenerateOptions } from "./kode.interface.js";
 
 const ALPHA = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
 const NUMERIC = "0123456789";
@@ -10,27 +10,52 @@ function generate(length: number, charset: string): string {
 
   while (length > 0) {
     const index = Math.floor(Math.random() * max);
-    result += charset[index];
+    result += charset[index]!;
     length--;
   }
 
   return result;
 }
 
-export function generateCode({ length, type = "alphanumeric" }: GenerateCodeOptions): string {
-  if (type === "alpha") return generate(length, ALPHA);
-  if (type === "numeric") return generate(length, NUMERIC);
-  return generate(length, ALPHANUM);
+
+function generateSecure(length: number, charset: string): string {
+  const max = charset.length;
+  const result: string[] = [];
+  const randomBuffer = new Uint8Array(1);
+
+  while (result.length < length) {
+    crypto.getRandomValues(randomBuffer);
+    const byte = randomBuffer[0]!;
+
+    if (byte < Math.floor(256 / max) * max) {
+      result.push(charset[byte % max]!);
+    }
+  }
+
+  return result.join("");
 }
 
-export function randomString(length: number): string {
+
+function randomString(length: number): string {
   return generate(length, ALPHANUM);
 }
 
-export function randomAlpha(length: number): string {
+function randomAlpha(length: number): string {
   return generate(length, ALPHA);
 }
 
-export function randomNumeric(length: number): string {
+function randomNumeric(length: number): string {
   return generate(length, NUMERIC);
 }
+
+
+export function generateCode({length,type = "alpha",secure = false}: GenerateOptions): string {
+  const charset =
+    type === "alpha" ? ALPHA :
+    type === "numeric" ? NUMERIC :
+    ALPHANUM;
+
+  return secure
+    ? generateSecure(length, charset)
+    : generate(length, charset);
+}

package/kode.interface.ts

@@ -1,4 +1,7 @@
-export interface GenerateCodeOptions {
+export type CodeType = "alpha" | "numeric" | "alphanumeric";
+
+export interface GenerateOptions {
   length: number;
-  type?: "alpha" | "numeric" | "alphanumeric";
+  type?: CodeType;
+  secure?: boolean;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "genkode",
-  "version": "1.1.0",
-  "description": "A node package that creates a random unique characters string (Typescript Supported)",
+  "version": "1.3.0",
+  "description": "A lightweight Node.js utility to generate random alphanumeric, alphabetic, or numeric strings.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": {
@@ -10,6 +10,7 @@
   },
   "type": "module",
   "scripts": {
+    "test": "node --test",
     "build": "tsc",
     "prepublishOnly": "npm run build"
   },
@@ -36,6 +37,7 @@
   "author": "",
   "license": "MIT",
   "devDependencies": {
+    "@types/node": "^25.5.0",
     "tsx": "^4.21.0",
     "txc": "^0.0.1",
     "typescript": "^6.0.2"
@@ -43,5 +45,8 @@
   "bugs": {
     "url": "https://github.com/sammitpal/genkode/issues"
   },
-  "homepage": "https://github.com/sammitpal/genkode#readme"
+  "homepage": "https://github.com/sammitpal/genkode#readme",
+  "dependencies": {
+    "crypto": "^1.0.1"
+  }
 }

package/test/genkode.test.ts

@@ -0,0 +1,64 @@
+/// <reference types="node" />
+import test from "node:test";
+import assert from "node:assert";
+import { generateCode } from "../dist/index.js";
+
+// Helper regex
+const alphaRegex = /^[A-Za-z]+$/;
+const numericRegex = /^[0-9]+$/;
+const alphanumRegex = /^[A-Za-z0-9]+$/;
+
+test("should generate string of correct length", () => {
+  const result = generateCode({ length: 20 });
+  assert.strictEqual(result.length, 20);
+});
+
+test("should generate alphabet-only string", () => {
+  const result = generateCode({ length: 30, type: "alpha" });
+  assert.ok(alphaRegex.test(result));
+});
+
+test("should generate numeric-only string", () => {
+  const result = generateCode({ length: 30, type: "numeric" });
+  assert.ok(numericRegex.test(result));
+});
+
+test("should generate alphanumeric string", () => {
+  const result = generateCode({ length: 30, type: "alphanumeric" });
+  assert.ok(alphanumRegex.test(result));
+});
+
+test("should generate secure string (alpha)", () => {
+  const result = generateCode({ length: 25, type: "alpha", secure: true });
+  assert.strictEqual(result.length, 25);
+  assert.ok(alphaRegex.test(result));
+});
+
+test("should generate secure numeric string", () => {
+  const result = generateCode({ length: 25, type: "numeric", secure: true });
+  assert.strictEqual(result.length, 25);
+  assert.ok(numericRegex.test(result));
+});
+
+test("should generate secure alphanumeric string", () => {
+  const result = generateCode({ length: 25, type: "alphanumeric", secure: true });
+  assert.strictEqual(result.length, 25);
+  assert.ok(alphanumRegex.test(result));
+});
+
+test("should generate different values each time (non-deterministic)", () => {
+  const a = generateCode({ length: 20 });
+  const b = generateCode({ length: 20 });
+
+  assert.notStrictEqual(a, b);
+});
+
+test("should handle small length", () => {
+  const result = generateCode({ length: 1 });
+  assert.strictEqual(result.length, 1);
+});
+
+test("should handle large length", () => {
+  const result = generateCode({ length: 1000 });
+  assert.strictEqual(result.length, 1000);
+});

package/tsconfig.json

@@ -3,23 +3,29 @@
     "rootDir": ".",
     "outDir": "./dist",
 
-    "module": "nodenext",
-    "target": "esnext",
-    "types": [],
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "target": "ES2022",
+
+    "types": ["node"],
 
     "sourceMap": true,
     "declaration": true,
     "declarationMap": true,
 
+    "strict": true,
     "noUncheckedIndexedAccess": true,
     "exactOptionalPropertyTypes": true,
 
-
-    "strict": true,
     "verbatimModuleSyntax": true,
     "isolatedModules": true,
     "noUncheckedSideEffectImports": true,
     "moduleDetection": "force",
-    "skipLibCheck": true,
-  }
-}
+
+    "skipLibCheck": true
+  },
+
+  "include": ["index.ts"],
+
+  "exclude": ["test", "dist", "node_modules"]
+}