@otp-service/nest 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,17 @@
+import { Type, DynamicModule } from '@nestjs/common';
+import { OtpService, VerifyChallengeResult } from '@otp-service/core';
+
+declare const OTP_SERVICE_TOKEN: unique symbol;
+interface CreateNestOtpModuleOptions {
+    otpService: OtpService;
+    pathPrefix?: string;
+}
+interface NestOtpController {
+    generateChallenge(body: unknown): Promise<ReturnType<OtpService["generateChallenge"]> extends Promise<infer T> ? T : never>;
+    verifyChallenge(body: unknown): Promise<VerifyChallengeResult>;
+}
+type NestOtpControllerClass = Type<NestOtpController>;
+declare function createNestOtpModule(options: CreateNestOtpModuleOptions): DynamicModule;
+declare function createOtpController(pathPrefix?: string): NestOtpControllerClass;
+
+export { type CreateNestOtpModuleOptions, type NestOtpController, type NestOtpControllerClass, OTP_SERVICE_TOKEN, createNestOtpModule, createOtpController };

package/dist/index.js

@@ -0,0 +1,121 @@
+import 'reflect-metadata';
+import { Module, Post, Body, Controller, Inject, UnprocessableEntityException } from '@nestjs/common';
+
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result) __defProp(target, key, result);
+  return result;
+};
+var __decorateParam = (index, decorator) => (target, key) => decorator(target, key, index);
+var OTP_SERVICE_TOKEN = /* @__PURE__ */ Symbol("OTP_SERVICE_TOKEN");
+function createNestOtpModule(options) {
+  const controller = createOtpController(options.pathPrefix ?? "otp");
+  const provider = {
+    provide: OTP_SERVICE_TOKEN,
+    useValue: options.otpService
+  };
+  let OtpModule = class {
+  };
+  OtpModule = __decorateClass([
+    Module({
+      controllers: [controller],
+      providers: [provider],
+      exports: [provider]
+    })
+  ], OtpModule);
+  return {
+    controllers: [controller],
+    exports: [provider],
+    module: OtpModule,
+    providers: [provider]
+  };
+}
+function createOtpController(pathPrefix = "otp") {
+  let OtpController = class {
+    constructor(otpService) {
+      this.otpService = otpService;
+    }
+    otpService;
+    async generateChallenge(body) {
+      const input = mapGenerateChallengeBody(body);
+      return this.otpService.generateChallenge(input);
+    }
+    async verifyChallenge(body) {
+      const input = mapVerifyChallengeBody(body);
+      return this.otpService.verifyChallenge(input);
+    }
+  };
+  __decorateClass([
+    Post("generate"),
+    __decorateParam(0, Body())
+  ], OtpController.prototype, "generateChallenge", 1);
+  __decorateClass([
+    Post("verify"),
+    __decorateParam(0, Body())
+  ], OtpController.prototype, "verifyChallenge", 1);
+  OtpController = __decorateClass([
+    Controller(pathPrefix),
+    __decorateParam(0, Inject(OTP_SERVICE_TOKEN))
+  ], OtpController);
+  return OtpController;
+}
+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 UnprocessableEntityException({
+      error: {
+        code: "VALIDATION_ERROR",
+        message
+      }
+    });
+  }
+  return value;
+}
+function requireTrimmedString(value, message) {
+  if (typeof value !== "string" || value.trim().length === 0) {
+    throw new UnprocessableEntityException({
+      error: {
+        code: "VALIDATION_ERROR",
+        message
+      }
+    });
+  }
+  return value.trim();
+}
+function requireChannel(value) {
+  if (value === "sms" || value === "email") {
+    return value;
+  }
+  throw new UnprocessableEntityException({
+    error: {
+      code: "VALIDATION_ERROR",
+      message: "Generate challenge channel must be either sms or email."
+    }
+  });
+}
+
+export { OTP_SERVICE_TOKEN, createNestOtpModule, createOtpController };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAqBO,IAAM,iBAAA,0BAA2B,mBAAmB;AAcpD,SAAS,oBAAoB,OAAA,EAAoD;AACtF,EAAA,MAAM,UAAA,GAAa,mBAAA,CAAoB,OAAA,CAAQ,UAAA,IAAc,KAAK,CAAA;AAClE,EAAA,MAAM,QAAA,GAAqB;AAAA,IACzB,OAAA,EAAS,iBAAA;AAAA,IACT,UAAU,OAAA,CAAQ;AAAA,GACpB;AAOA,EAAA,IAAM,YAAN,MAAgB;AAAA,GAAC;AAAX,EAAA,SAAA,GAAN,eAAA,CAAA;AAAA,IALC,MAAA,CAAO;AAAA,MACN,WAAA,EAAa,CAAC,UAAU,CAAA;AAAA,MACxB,SAAA,EAAW,CAAC,QAAQ,CAAA;AAAA,MACpB,OAAA,EAAS,CAAC,QAAQ;AAAA,KACnB;AAAA,GAAA,EACK,SAAA,CAAA;AAEN,EAAA,OAAO;AAAA,IACL,WAAA,EAAa,CAAC,UAAU,CAAA;AAAA,IACxB,OAAA,EAAS,CAAC,QAAQ,CAAA;AAAA,IAClB,MAAA,EAAQ,SAAA;AAAA,IACR,SAAA,EAAW,CAAC,QAAQ;AAAA,GACtB;AACF;AAEO,SAAS,mBAAA,CAAoB,aAAa,KAAA,EAA+B;AAE9E,EAAA,IAAM,gBAAN,MAAiD;AAAA,IAC/C,YAAuD,UAAA,EAAwB;AAAxB,MAAA,IAAA,CAAA,UAAA,GAAA,UAAA;AAAA,IAAyB;AAAA,IAAzB,UAAA;AAAA,IAGvD,MAAM,kBAA0B,IAAA,EAAe;AAC7C,MAAA,MAAM,KAAA,GAAQ,yBAAyB,IAAI,CAAA;AAC3C,MAAA,OAAO,IAAA,CAAK,UAAA,CAAW,iBAAA,CAAkB,KAAK,CAAA;AAAA,IAChD;AAAA,IAGA,MAAM,gBAAwB,IAAA,EAA+C;AAC3E,MAAA,MAAM,KAAA,GAAQ,uBAAuB,IAAI,CAAA;AACzC,MAAA,OAAO,IAAA,CAAK,UAAA,CAAW,eAAA,CAAgB,KAAK,CAAA;AAAA,IAC9C;AAAA,GACF;AAVQ,EAAA,eAAA,CAAA;AAAA,IADL,KAAK,UAAU,CAAA;AAAA,IACS,eAAA,CAAA,CAAA,EAAA,IAAA,EAAK;AAAA,GAAA,EAJ1B,aAAA,CAIE,SAAA,EAAA,mBAAA,EAAA,CAAA,CAAA;AAMA,EAAA,eAAA,CAAA;AAAA,IADL,KAAK,QAAQ,CAAA;AAAA,IACS,eAAA,CAAA,CAAA,EAAA,IAAA,EAAK;AAAA,GAAA,EAVxB,aAAA,CAUE,SAAA,EAAA,iBAAA,EAAA,CAAA,CAAA;AAVF,EAAA,aAAA,GAAN,eAAA,CAAA;AAAA,IADC,WAAW,UAAU,CAAA;AAAA,IAEP,0BAAO,iBAAiB,CAAA;AAAA,GAAA,EADjC,aAAA,CAAA;AAgBN,EAAA,OAAO,aAAA;AACT;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,4BAAA,CAA6B;AAAA,MACrC,KAAA,EAAO;AAAA,QACL,IAAA,EAAM,kBAAA;AAAA,QACN;AAAA;AACF,KACD,CAAA;AAAA,EACH;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,4BAAA,CAA6B;AAAA,MACrC,KAAA,EAAO;AAAA,QACL,IAAA,EAAM,kBAAA;AAAA,QACN;AAAA;AACF,KACD,CAAA;AAAA,EACH;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,4BAAA,CAA6B;AAAA,IACrC,KAAA,EAAO;AAAA,MACL,IAAA,EAAM,kBAAA;AAAA,MACN,OAAA,EAAS;AAAA;AACX,GACD,CAAA;AACH","file":"index.js","sourcesContent":["import \"reflect-metadata\";\n\nimport {\n  Body,\n  Controller,\n  Inject,\n  Module,\n  Post,\n  UnprocessableEntityException,\n  type Type,\n  type DynamicModule,\n  type Provider\n} from \"@nestjs/common\";\n\nimport type {\n  GenerateChallengeInput,\n  OtpService,\n  VerifyChallengeInput,\n  VerifyChallengeResult\n} from \"@otp-service/core\";\n\nexport const OTP_SERVICE_TOKEN = Symbol(\"OTP_SERVICE_TOKEN\");\n\nexport interface CreateNestOtpModuleOptions {\n  otpService: OtpService;\n  pathPrefix?: string;\n}\n\nexport interface NestOtpController {\n  generateChallenge(body: unknown): Promise<ReturnType<OtpService[\"generateChallenge\"]> extends Promise<infer T> ? T : never>;\n  verifyChallenge(body: unknown): Promise<VerifyChallengeResult>;\n}\n\nexport type NestOtpControllerClass = Type<NestOtpController>;\n\nexport function createNestOtpModule(options: CreateNestOtpModuleOptions): DynamicModule {\n  const controller = createOtpController(options.pathPrefix ?? \"otp\");\n  const provider: Provider = {\n    provide: OTP_SERVICE_TOKEN,\n    useValue: options.otpService\n  };\n\n  @Module({\n    controllers: [controller],\n    providers: [provider],\n    exports: [provider]\n  })\n  class OtpModule {}\n\n  return {\n    controllers: [controller],\n    exports: [provider],\n    module: OtpModule,\n    providers: [provider]\n  };\n}\n\nexport function createOtpController(pathPrefix = \"otp\"): NestOtpControllerClass {\n  @Controller(pathPrefix)\n  class OtpController implements NestOtpController {\n    constructor(@Inject(OTP_SERVICE_TOKEN) public readonly otpService: OtpService) {}\n\n    @Post(\"generate\")\n    async generateChallenge(@Body() body: unknown) {\n      const input = mapGenerateChallengeBody(body);\n      return this.otpService.generateChallenge(input);\n    }\n\n    @Post(\"verify\")\n    async verifyChallenge(@Body() body: unknown): Promise<VerifyChallengeResult> {\n      const input = mapVerifyChallengeBody(body);\n      return this.otpService.verifyChallenge(input);\n    }\n  }\n\n  return OtpController as NestOtpControllerClass;\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 UnprocessableEntityException({\n      error: {\n        code: \"VALIDATION_ERROR\",\n        message\n      }\n    });\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 UnprocessableEntityException({\n      error: {\n        code: \"VALIDATION_ERROR\",\n        message\n      }\n    });\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 UnprocessableEntityException({\n    error: {\n      code: \"VALIDATION_ERROR\",\n      message: \"Generate challenge channel must be either sms or email.\"\n    }\n  });\n}\n"]}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@otp-service/nest",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "Nest module and controller helpers for OTP 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/nest#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": {
+    "@nestjs/common": "^11.0.0",
+    "@nestjs/core": "^11.0.0"
+  },
+  "devDependencies": {
+    "@nestjs/common": "^11.1.6",
+    "@nestjs/core": "^11.1.6",
+    "@nestjs/testing": "^11.1.6",
+    "reflect-metadata": "^0.2.2",
+    "rxjs": "^7.8.2"
+  },
+  "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"
+  }
+}