@otp-service/express 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 otp-service contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,18 @@
+import { RequestHandler } from 'express';
+import { GenerateChallengeInput, OtpService, VerifyChallengeInput } from '@otp-service/core';
+
+interface CreateGenerateChallengeHandlerOptions {
+    mapBody?: (body: unknown) => GenerateChallengeInput;
+    otpService: OtpService;
+}
+interface CreateVerifyChallengeHandlerOptions {
+    mapBody?: (body: unknown) => VerifyChallengeInput;
+    otpService: OtpService;
+}
+declare function createGenerateChallengeHandler(options: CreateGenerateChallengeHandlerOptions): RequestHandler;
+declare function createVerifyChallengeHandler(options: CreateVerifyChallengeHandlerOptions): RequestHandler;
+declare class ExpressOtpValidationError extends Error {
+    constructor(message: string);
+}
+
+export { type CreateGenerateChallengeHandlerOptions, type CreateVerifyChallengeHandlerOptions, ExpressOtpValidationError, createGenerateChallengeHandler, createVerifyChallengeHandler };

package/dist/index.js

@@ -0,0 +1,99 @@
+// src/index.ts
+function createGenerateChallengeHandler(options) {
+  return async (request, response, next) => {
+    try {
+      const input = (options.mapBody ?? mapGenerateChallengeBody)(request.body);
+      const result = await options.otpService.generateChallenge(input);
+      response.status(201).json(result);
+    } catch (error) {
+      if (error instanceof ExpressOtpValidationError) {
+        response.status(422).json({
+          error: {
+            code: "VALIDATION_ERROR",
+            message: error.message
+          }
+        });
+        return;
+      }
+      next(error);
+    }
+  };
+}
+function createVerifyChallengeHandler(options) {
+  return async (request, response, next) => {
+    try {
+      const input = (options.mapBody ?? mapVerifyChallengeBody)(request.body);
+      const result = await options.otpService.verifyChallenge(input);
+      response.status(statusCodeForVerifyResult(result)).json(result);
+    } catch (error) {
+      if (error instanceof ExpressOtpValidationError) {
+        response.status(422).json({
+          error: {
+            code: "VALIDATION_ERROR",
+            message: error.message
+          }
+        });
+        return;
+      }
+      next(error);
+    }
+  };
+}
+var ExpressOtpValidationError = class extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "ExpressOtpValidationError";
+  }
+};
+function mapGenerateChallengeBody(body) {
+  const record = requireObject(body, "Generate challenge body must be an object.");
+  return {
+    channel: requireChannel(record.channel),
+    purpose: requireTrimmedString(record.purpose, "Generate challenge purpose must be a non-empty string."),
+    recipient: requireTrimmedString(record.recipient, "Generate challenge recipient must be a non-empty string.")
+  };
+}
+function mapVerifyChallengeBody(body) {
+  const record = requireObject(body, "Verify challenge body must be an object.");
+  return {
+    challengeId: requireTrimmedString(
+      record.challengeId,
+      "Verify challenge challengeId must be a non-empty string."
+    ),
+    otp: requireTrimmedString(record.otp, "Verify challenge otp must be a non-empty string.")
+  };
+}
+function requireObject(value, message) {
+  if (typeof value !== "object" || value === null) {
+    throw new ExpressOtpValidationError(message);
+  }
+  return value;
+}
+function requireTrimmedString(value, message) {
+  if (typeof value !== "string" || value.trim().length === 0) {
+    throw new ExpressOtpValidationError(message);
+  }
+  return value.trim();
+}
+function requireChannel(value) {
+  if (value === "sms" || value === "email") {
+    return value;
+  }
+  throw new ExpressOtpValidationError("Generate challenge channel must be either sms or email.");
+}
+function statusCodeForVerifyResult(result) {
+  switch (result.status) {
+    case "VERIFIED":
+      return 200;
+    case "INVALID":
+      return 400;
+    case "EXPIRED":
+      return 410;
+    case "ATTEMPTS_EXCEEDED":
+      return 429;
+  }
+}
+
+export { ExpressOtpValidationError, createGenerateChallengeHandler, createVerifyChallengeHandler };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAmBO,SAAS,+BACd,OAAA,EACgB;AAChB,EAAA,OAAO,OAAO,OAAA,EAAS,QAAA,EAAU,IAAA,KAAS;AACxC,IAAA,IAAI;AACF,MAAA,MAAM,KAAA,GAAA,CAAS,OAAA,CAAQ,OAAA,IAAW,wBAAA,EAA0B,QAAQ,IAAI,CAAA;AACxE,MAAA,MAAM,MAAA,GAAS,MAAM,OAAA,CAAQ,UAAA,CAAW,kBAAkB,KAAK,CAAA;AAC/D,MAAA,QAAA,CAAS,MAAA,CAAO,GAAG,CAAA,CAAE,IAAA,CAAK,MAAM,CAAA;AAAA,IAClC,SAAS,KAAA,EAAO;AACd,MAAA,IAAI,iBAAiB,yBAAA,EAA2B;AAC9C,QAAA,QAAA,CAAS,MAAA,CAAO,GAAG,CAAA,CAAE,IAAA,CAAK;AAAA,UACxB,KAAA,EAAO;AAAA,YACL,IAAA,EAAM,kBAAA;AAAA,YACN,SAAS,KAAA,CAAM;AAAA;AACjB,SACD,CAAA;AACD,QAAA;AAAA,MACF;AAEA,MAAA,IAAA,CAAK,KAAK,CAAA;AAAA,IACZ;AAAA,EACF,CAAA;AACF;AAEO,SAAS,6BACd,OAAA,EACgB;AAChB,EAAA,OAAO,OAAO,OAAA,EAAS,QAAA,EAAU,IAAA,KAAS;AACxC,IAAA,IAAI;AACF,MAAA,MAAM,KAAA,GAAA,CAAS,OAAA,CAAQ,OAAA,IAAW,sBAAA,EAAwB,QAAQ,IAAI,CAAA;AACtE,MAAA,MAAM,MAAA,GAAS,MAAM,OAAA,CAAQ,UAAA,CAAW,gBAAgB,KAAK,CAAA;AAC7D,MAAA,QAAA,CAAS,OAAO,yBAAA,CAA0B,MAAM,CAAC,CAAA,CAAE,KAAK,MAAM,CAAA;AAAA,IAChE,SAAS,KAAA,EAAO;AACd,MAAA,IAAI,iBAAiB,yBAAA,EAA2B;AAC9C,QAAA,QAAA,CAAS,MAAA,CAAO,GAAG,CAAA,CAAE,IAAA,CAAK;AAAA,UACxB,KAAA,EAAO;AAAA,YACL,IAAA,EAAM,kBAAA;AAAA,YACN,SAAS,KAAA,CAAM;AAAA;AACjB,SACD,CAAA;AACD,QAAA;AAAA,MACF;AAEA,MAAA,IAAA,CAAK,KAAK,CAAA;AAAA,IACZ;AAAA,EACF,CAAA;AACF;AAEO,IAAM,yBAAA,GAAN,cAAwC,KAAA,CAAM;AAAA,EACnD,YAAY,OAAA,EAAiB;AAC3B,IAAA,KAAA,CAAM,OAAO,CAAA;AACb,IAAA,IAAA,CAAK,IAAA,GAAO,2BAAA;AAAA,EACd;AACF;AAEA,SAAS,yBAAyB,IAAA,EAAuC;AACvE,EAAA,MAAM,MAAA,GAAS,aAAA,CAAc,IAAA,EAAM,4CAA4C,CAAA;AAC/E,EAAA,OAAO;AAAA,IACL,OAAA,EAAS,cAAA,CAAe,MAAA,CAAO,OAAO,CAAA;AAAA,IACtC,OAAA,EAAS,oBAAA,CAAqB,MAAA,CAAO,OAAA,EAAS,wDAAwD,CAAA;AAAA,IACtG,SAAA,EAAW,oBAAA,CAAqB,MAAA,CAAO,SAAA,EAAW,0DAA0D;AAAA,GAC9G;AACF;AAEA,SAAS,uBAAuB,IAAA,EAAqC;AACnE,EAAA,MAAM,MAAA,GAAS,aAAA,CAAc,IAAA,EAAM,0CAA0C,CAAA;AAC7E,EAAA,OAAO;AAAA,IACL,WAAA,EAAa,oBAAA;AAAA,MACX,MAAA,CAAO,WAAA;AAAA,MACP;AAAA,KACF;AAAA,IACA,GAAA,EAAK,oBAAA,CAAqB,MAAA,CAAO,GAAA,EAAK,kDAAkD;AAAA,GAC1F;AACF;AAEA,SAAS,aAAA,CAAc,OAAgB,OAAA,EAA0C;AAC/E,EAAA,IAAI,OAAO,KAAA,KAAU,QAAA,IAAY,KAAA,KAAU,IAAA,EAAM;AAC/C,IAAA,MAAM,IAAI,0BAA0B,OAAO,CAAA;AAAA,EAC7C;AAEA,EAAA,OAAO,KAAA;AACT;AAEA,SAAS,oBAAA,CAAqB,OAAgB,OAAA,EAAyB;AACrE,EAAA,IAAI,OAAO,KAAA,KAAU,QAAA,IAAY,MAAM,IAAA,EAAK,CAAE,WAAW,CAAA,EAAG;AAC1D,IAAA,MAAM,IAAI,0BAA0B,OAAO,CAAA;AAAA,EAC7C;AAEA,EAAA,OAAO,MAAM,IAAA,EAAK;AACpB;AAEA,SAAS,eAAe,KAAA,EAAmD;AACzE,EAAA,IAAI,KAAA,KAAU,KAAA,IAAS,KAAA,KAAU,OAAA,EAAS;AACxC,IAAA,OAAO,KAAA;AAAA,EACT;AAEA,EAAA,MAAM,IAAI,0BAA0B,yDAAyD,CAAA;AAC/F;AAEA,SAAS,0BAA0B,MAAA,EAAuC;AACxE,EAAA,QAAQ,OAAO,MAAA;AAAQ,IACrB,KAAK,UAAA;AACH,MAAA,OAAO,GAAA;AAAA,IACT,KAAK,SAAA;AACH,MAAA,OAAO,GAAA;AAAA,IACT,KAAK,SAAA;AACH,MAAA,OAAO,GAAA;AAAA,IACT,KAAK,mBAAA;AACH,MAAA,OAAO,GAAA;AAAA;AAEb","file":"index.js","sourcesContent":["import type { RequestHandler } from \"express\";\n\nimport type {\n  GenerateChallengeInput,\n  OtpService,\n  VerifyChallengeInput,\n  VerifyChallengeResult\n} from \"@otp-service/core\";\n\nexport interface CreateGenerateChallengeHandlerOptions {\n  mapBody?: (body: unknown) => GenerateChallengeInput;\n  otpService: OtpService;\n}\n\nexport interface CreateVerifyChallengeHandlerOptions {\n  mapBody?: (body: unknown) => VerifyChallengeInput;\n  otpService: OtpService;\n}\n\nexport function createGenerateChallengeHandler(\n  options: CreateGenerateChallengeHandlerOptions\n): RequestHandler {\n  return async (request, response, next) => {\n    try {\n      const input = (options.mapBody ?? mapGenerateChallengeBody)(request.body);\n      const result = await options.otpService.generateChallenge(input);\n      response.status(201).json(result);\n    } catch (error) {\n      if (error instanceof ExpressOtpValidationError) {\n        response.status(422).json({\n          error: {\n            code: \"VALIDATION_ERROR\",\n            message: error.message\n          }\n        });\n        return;\n      }\n\n      next(error);\n    }\n  };\n}\n\nexport function createVerifyChallengeHandler(\n  options: CreateVerifyChallengeHandlerOptions\n): RequestHandler {\n  return async (request, response, next) => {\n    try {\n      const input = (options.mapBody ?? mapVerifyChallengeBody)(request.body);\n      const result = await options.otpService.verifyChallenge(input);\n      response.status(statusCodeForVerifyResult(result)).json(result);\n    } catch (error) {\n      if (error instanceof ExpressOtpValidationError) {\n        response.status(422).json({\n          error: {\n            code: \"VALIDATION_ERROR\",\n            message: error.message\n          }\n        });\n        return;\n      }\n\n      next(error);\n    }\n  };\n}\n\nexport class ExpressOtpValidationError extends Error {\n  constructor(message: string) {\n    super(message);\n    this.name = \"ExpressOtpValidationError\";\n  }\n}\n\nfunction mapGenerateChallengeBody(body: unknown): GenerateChallengeInput {\n  const record = requireObject(body, \"Generate challenge body must be an object.\");\n  return {\n    channel: requireChannel(record.channel),\n    purpose: requireTrimmedString(record.purpose, \"Generate challenge purpose must be a non-empty string.\"),\n    recipient: requireTrimmedString(record.recipient, \"Generate challenge recipient must be a non-empty string.\")\n  };\n}\n\nfunction mapVerifyChallengeBody(body: unknown): VerifyChallengeInput {\n  const record = requireObject(body, \"Verify challenge body must be an object.\");\n  return {\n    challengeId: requireTrimmedString(\n      record.challengeId,\n      \"Verify challenge challengeId must be a non-empty string.\"\n    ),\n    otp: requireTrimmedString(record.otp, \"Verify challenge otp must be a non-empty string.\")\n  };\n}\n\nfunction requireObject(value: unknown, message: string): Record<string, unknown> {\n  if (typeof value !== \"object\" || value === null) {\n    throw new ExpressOtpValidationError(message);\n  }\n\n  return value as Record<string, unknown>;\n}\n\nfunction requireTrimmedString(value: unknown, message: string): string {\n  if (typeof value !== \"string\" || value.trim().length === 0) {\n    throw new ExpressOtpValidationError(message);\n  }\n\n  return value.trim();\n}\n\nfunction requireChannel(value: unknown): GenerateChallengeInput[\"channel\"] {\n  if (value === \"sms\" || value === \"email\") {\n    return value;\n  }\n\n  throw new ExpressOtpValidationError(\"Generate challenge channel must be either sms or email.\");\n}\n\nfunction statusCodeForVerifyResult(result: VerifyChallengeResult): number {\n  switch (result.status) {\n    case \"VERIFIED\":\n      return 200;\n    case \"INVALID\":\n      return 400;\n    case \"EXPIRED\":\n      return 410;\n    case \"ATTEMPTS_EXCEEDED\":\n      return 429;\n  }\n}\n"]}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@otp-service/express",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "Express route helpers for OTP generate and verify flows.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Suraj-H/otp-service-package-v2.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Suraj-H/otp-service-package-v2/issues"
+  },
+  "homepage": "https://github.com/Suraj-H/otp-service-package-v2/tree/main/packages/express#readme",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@otp-service/core": "0.1.0"
+  },
+  "peerDependencies": {
+    "express": "^4.21.0 || ^5.0.0"
+  },
+  "devDependencies": {
+    "@types/express": "^5.0.3",
+    "express": "^5.1.0"
+  },
+  "scripts": {
+    "build": "tsup --config tsup.config.ts",
+    "clean": "rm -rf dist",
+    "lint": "eslint src test",
+    "test": "vitest run --config vitest.config.ts",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}