@otp-service/redis-store 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,20 @@
+import { ChallengeStore } from '@otp-service/core';
+
+interface RedisStoreClient {
+    del(key: string): Promise<number>;
+    get(key: string): Promise<string | null>;
+    set(key: string, value: string, options: {
+        expiration: {
+            type: "EX";
+            value: number;
+        };
+    }): Promise<unknown>;
+}
+interface CreateRedisChallengeStoreOptions {
+    client: RedisStoreClient;
+    clock?: () => Date;
+    keyPrefix?: string;
+}
+declare function createRedisChallengeStore(options: CreateRedisChallengeStoreOptions): ChallengeStore;
+
+export { type CreateRedisChallengeStoreOptions, type RedisStoreClient, createRedisChallengeStore };

package/dist/index.js

@@ -0,0 +1,105 @@
+// src/index.ts
+function createRedisChallengeStore(options) {
+  const clock = options.clock ?? (() => /* @__PURE__ */ new Date());
+  const keyPrefix = options.keyPrefix ?? "otp:challenge";
+  return {
+    async create(record) {
+      await options.client.set(toRedisKey(keyPrefix, record.challengeId), serializeRecord(record), {
+        expiration: {
+          type: "EX",
+          value: ttlSecondsFrom(record.expiresAt, clock)
+        }
+      });
+    },
+    async delete(challengeId) {
+      await options.client.del(toRedisKey(keyPrefix, challengeId));
+    },
+    async get(challengeId) {
+      const value = await options.client.get(toRedisKey(keyPrefix, challengeId));
+      if (value === null) {
+        return null;
+      }
+      return deserializeRecord(value);
+    },
+    async update(record) {
+      const ttlSeconds = ttlSecondsFrom(record.expiresAt, clock);
+      if (ttlSeconds <= 0) {
+        await options.client.del(toRedisKey(keyPrefix, record.challengeId));
+        return;
+      }
+      await options.client.set(toRedisKey(keyPrefix, record.challengeId), serializeRecord(record), {
+        expiration: {
+          type: "EX",
+          value: ttlSeconds
+        }
+      });
+    }
+  };
+}
+function deserializeRecord(value) {
+  let parsed;
+  try {
+    parsed = JSON.parse(value);
+  } catch {
+    throw new Error("Redis challenge record contains invalid JSON.");
+  }
+  assertSerializedChallengeRecord(parsed);
+  return {
+    attemptsRemaining: parsed.attemptsRemaining,
+    channel: parsed.channel,
+    challengeId: parsed.challengeId,
+    createdAt: new Date(parsed.createdAt),
+    expiresAt: new Date(parsed.expiresAt),
+    otpHash: parsed.otpHash,
+    purpose: parsed.purpose,
+    recipient: parsed.recipient
+  };
+}
+function assertSerializedChallengeRecord(value) {
+  if (typeof value !== "object" || value === null) {
+    throw new Error("Redis challenge record must be an object.");
+  }
+  const record = value;
+  if (!Number.isInteger(record.attemptsRemaining)) {
+    throw new Error("Redis challenge record attemptsRemaining must be an integer.");
+  }
+  if (record.channel !== "sms" && record.channel !== "email") {
+    throw new Error("Redis challenge record channel is invalid.");
+  }
+  const stringFields = ["challengeId", "createdAt", "expiresAt", "otpHash", "purpose", "recipient"];
+  for (const field of stringFields) {
+    const fieldValue = record[field];
+    if (typeof fieldValue !== "string" || fieldValue.trim().length === 0) {
+      throw new Error(`Redis challenge record ${field} must be a non-empty string.`);
+    }
+  }
+  if (Number.isNaN(new Date(record.createdAt).getTime())) {
+    throw new Error("Redis challenge record createdAt must be a valid ISO date string.");
+  }
+  if (Number.isNaN(new Date(record.expiresAt).getTime())) {
+    throw new Error("Redis challenge record expiresAt must be a valid ISO date string.");
+  }
+}
+function serializeRecord(record) {
+  return JSON.stringify({
+    attemptsRemaining: record.attemptsRemaining,
+    channel: record.channel,
+    challengeId: record.challengeId,
+    createdAt: record.createdAt.toISOString(),
+    expiresAt: record.expiresAt.toISOString(),
+    otpHash: record.otpHash,
+    purpose: record.purpose,
+    recipient: record.recipient
+  });
+}
+function toRedisKey(keyPrefix, challengeId) {
+  return `${keyPrefix}:${challengeId}`;
+}
+function ttlSecondsFrom(expiresAt, clock) {
+  const millisecondsRemaining = expiresAt.getTime() - clock().getTime();
+  return Math.max(0, Math.ceil(millisecondsRemaining / 1e3));
+}
+
+export { createRedisChallengeStore };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";AAyBO,SAAS,0BACd,OAAA,EACgB;AAChB,EAAA,MAAM,KAAA,GAAQ,OAAA,CAAQ,KAAA,KAAU,0BAAU,IAAA,EAAK,CAAA;AAC/C,EAAA,MAAM,SAAA,GAAY,QAAQ,SAAA,IAAa,eAAA;AAEvC,EAAA,OAAO;AAAA,IACL,MAAM,OAAO,MAAA,EAAQ;AACnB,MAAA,MAAM,OAAA,CAAQ,MAAA,CAAO,GAAA,CAAI,UAAA,CAAW,SAAA,EAAW,OAAO,WAAW,CAAA,EAAG,eAAA,CAAgB,MAAM,CAAA,EAAG;AAAA,QAC3F,UAAA,EAAY;AAAA,UACV,IAAA,EAAM,IAAA;AAAA,UACN,KAAA,EAAO,cAAA,CAAe,MAAA,CAAO,SAAA,EAAW,KAAK;AAAA;AAC/C,OACD,CAAA;AAAA,IACH,CAAA;AAAA,IAEA,MAAM,OAAO,WAAA,EAAa;AACxB,MAAA,MAAM,QAAQ,MAAA,CAAO,GAAA,CAAI,UAAA,CAAW,SAAA,EAAW,WAAW,CAAC,CAAA;AAAA,IAC7D,CAAA;AAAA,IAEA,MAAM,IAAI,WAAA,EAAa;AACrB,MAAA,MAAM,KAAA,GAAQ,MAAM,OAAA,CAAQ,MAAA,CAAO,IAAI,UAAA,CAAW,SAAA,EAAW,WAAW,CAAC,CAAA;AACzE,MAAA,IAAI,UAAU,IAAA,EAAM;AAClB,QAAA,OAAO,IAAA;AAAA,MACT;AAEA,MAAA,OAAO,kBAAkB,KAAK,CAAA;AAAA,IAChC,CAAA;AAAA,IAEA,MAAM,OAAO,MAAA,EAAQ;AACnB,MAAA,MAAM,UAAA,GAAa,cAAA,CAAe,MAAA,CAAO,SAAA,EAAW,KAAK,CAAA;AACzD,MAAA,IAAI,cAAc,CAAA,EAAG;AACnB,QAAA,MAAM,QAAQ,MAAA,CAAO,GAAA,CAAI,WAAW,SAAA,EAAW,MAAA,CAAO,WAAW,CAAC,CAAA;AAClE,QAAA;AAAA,MACF;AAEA,MAAA,MAAM,OAAA,CAAQ,MAAA,CAAO,GAAA,CAAI,UAAA,CAAW,SAAA,EAAW,OAAO,WAAW,CAAA,EAAG,eAAA,CAAgB,MAAM,CAAA,EAAG;AAAA,QAC3F,UAAA,EAAY;AAAA,UACV,IAAA,EAAM,IAAA;AAAA,UACN,KAAA,EAAO;AAAA;AACT,OACD,CAAA;AAAA,IACH;AAAA,GACF;AACF;AAEA,SAAS,kBAAkB,KAAA,EAAgC;AACzD,EAAA,IAAI,MAAA;AAEJ,EAAA,IAAI;AACF,IAAA,MAAA,GAAS,IAAA,CAAK,MAAM,KAAK,CAAA;AAAA,EAC3B,CAAA,CAAA,MAAQ;AACN,IAAA,MAAM,IAAI,MAAM,+CAA+C,CAAA;AAAA,EACjE;AAEA,EAAA,+BAAA,CAAgC,MAAM,CAAA;AAEtC,EAAA,OAAO;AAAA,IACL,mBAAmB,MAAA,CAAO,iBAAA;AAAA,IAC1B,SAAS,MAAA,CAAO,OAAA;AAAA,IAChB,aAAa,MAAA,CAAO,WAAA;AAAA,IACpB,SAAA,EAAW,IAAI,IAAA,CAAK,MAAA,CAAO,SAAS,CAAA;AAAA,IACpC,SAAA,EAAW,IAAI,IAAA,CAAK,MAAA,CAAO,SAAS,CAAA;AAAA,IACpC,SAAS,MAAA,CAAO,OAAA;AAAA,IAChB,SAAS,MAAA,CAAO,OAAA;AAAA,IAChB,WAAW,MAAA,CAAO;AAAA,GACpB;AACF;AAEA,SAAS,gCAAgC,KAAA,EAA4D;AACnG,EAAA,IAAI,OAAO,KAAA,KAAU,QAAA,IAAY,KAAA,KAAU,IAAA,EAAM;AAC/C,IAAA,MAAM,IAAI,MAAM,2CAA2C,CAAA;AAAA,EAC7D;AAEA,EAAA,MAAM,MAAA,GAAS,KAAA;AAEf,EAAA,IAAI,CAAC,MAAA,CAAO,SAAA,CAAU,MAAA,CAAO,iBAAiB,CAAA,EAAG;AAC/C,IAAA,MAAM,IAAI,MAAM,8DAA8D,CAAA;AAAA,EAChF;AAEA,EAAA,IAAI,MAAA,CAAO,OAAA,KAAY,KAAA,IAAS,MAAA,CAAO,YAAY,OAAA,EAAS;AAC1D,IAAA,MAAM,IAAI,MAAM,4CAA4C,CAAA;AAAA,EAC9D;AAEA,EAAA,MAAM,eAAe,CAAC,aAAA,EAAe,aAAa,WAAA,EAAa,SAAA,EAAW,WAAW,WAAW,CAAA;AAEhG,EAAA,KAAA,MAAW,SAAS,YAAA,EAAc;AAChC,IAAA,MAAM,UAAA,GAAa,OAAO,KAAK,CAAA;AAC/B,IAAA,IAAI,OAAO,UAAA,KAAe,QAAA,IAAY,WAAW,IAAA,EAAK,CAAE,WAAW,CAAA,EAAG;AACpE,MAAA,MAAM,IAAI,KAAA,CAAM,CAAA,uBAAA,EAA0B,KAAK,CAAA,4BAAA,CAA8B,CAAA;AAAA,IAC/E;AAAA,EACF;AAEA,EAAA,IAAI,MAAA,CAAO,MAAM,IAAI,IAAA,CAAK,OAAO,SAAmB,CAAA,CAAE,OAAA,EAAS,CAAA,EAAG;AAChE,IAAA,MAAM,IAAI,MAAM,mEAAmE,CAAA;AAAA,EACrF;AAEA,EAAA,IAAI,MAAA,CAAO,MAAM,IAAI,IAAA,CAAK,OAAO,SAAmB,CAAA,CAAE,OAAA,EAAS,CAAA,EAAG;AAChE,IAAA,MAAM,IAAI,MAAM,mEAAmE,CAAA;AAAA,EACrF;AACF;AAEA,SAAS,gBAAgB,MAAA,EAAiC;AACxD,EAAA,OAAO,KAAK,SAAA,CAAU;AAAA,IACpB,mBAAmB,MAAA,CAAO,iBAAA;AAAA,IAC1B,SAAS,MAAA,CAAO,OAAA;AAAA,IAChB,aAAa,MAAA,CAAO,WAAA;AAAA,IACpB,SAAA,EAAW,MAAA,CAAO,SAAA,CAAU,WAAA,EAAY;AAAA,IACxC,SAAA,EAAW,MAAA,CAAO,SAAA,CAAU,WAAA,EAAY;AAAA,IACxC,SAAS,MAAA,CAAO,OAAA;AAAA,IAChB,SAAS,MAAA,CAAO,OAAA;AAAA,IAChB,WAAW,MAAA,CAAO;AAAA,GACiB,CAAA;AACvC;AAEA,SAAS,UAAA,CAAW,WAAmB,WAAA,EAA6B;AAClE,EAAA,OAAO,CAAA,EAAG,SAAS,CAAA,CAAA,EAAI,WAAW,CAAA,CAAA;AACpC;AAEA,SAAS,cAAA,CAAe,WAAiB,KAAA,EAA2B;AAClE,EAAA,MAAM,wBAAwB,SAAA,CAAU,OAAA,EAAQ,GAAI,KAAA,GAAQ,OAAA,EAAQ;AACpE,EAAA,OAAO,KAAK,GAAA,CAAI,CAAA,EAAG,KAAK,IAAA,CAAK,qBAAA,GAAwB,GAAI,CAAC,CAAA;AAC5D","file":"index.js","sourcesContent":["import type { ChallengeRecord, ChallengeStore, OtpChannel } from \"@otp-service/core\";\n\nexport interface RedisStoreClient {\n  del(key: string): Promise<number>;\n  get(key: string): Promise<string | null>;\n  set(key: string, value: string, options: { expiration: { type: \"EX\"; value: number } }): Promise<unknown>;\n}\n\nexport interface CreateRedisChallengeStoreOptions {\n  client: RedisStoreClient;\n  clock?: () => Date;\n  keyPrefix?: string;\n}\n\ninterface SerializedChallengeRecord {\n  attemptsRemaining: number;\n  channel: OtpChannel;\n  challengeId: string;\n  createdAt: string;\n  expiresAt: string;\n  otpHash: string;\n  purpose: string;\n  recipient: string;\n}\n\nexport function createRedisChallengeStore(\n  options: CreateRedisChallengeStoreOptions\n): ChallengeStore {\n  const clock = options.clock ?? (() => new Date());\n  const keyPrefix = options.keyPrefix ?? \"otp:challenge\";\n\n  return {\n    async create(record) {\n      await options.client.set(toRedisKey(keyPrefix, record.challengeId), serializeRecord(record), {\n        expiration: {\n          type: \"EX\",\n          value: ttlSecondsFrom(record.expiresAt, clock)\n        }\n      });\n    },\n\n    async delete(challengeId) {\n      await options.client.del(toRedisKey(keyPrefix, challengeId));\n    },\n\n    async get(challengeId) {\n      const value = await options.client.get(toRedisKey(keyPrefix, challengeId));\n      if (value === null) {\n        return null;\n      }\n\n      return deserializeRecord(value);\n    },\n\n    async update(record) {\n      const ttlSeconds = ttlSecondsFrom(record.expiresAt, clock);\n      if (ttlSeconds <= 0) {\n        await options.client.del(toRedisKey(keyPrefix, record.challengeId));\n        return;\n      }\n\n      await options.client.set(toRedisKey(keyPrefix, record.challengeId), serializeRecord(record), {\n        expiration: {\n          type: \"EX\",\n          value: ttlSeconds\n        }\n      });\n    }\n  };\n}\n\nfunction deserializeRecord(value: string): ChallengeRecord {\n  let parsed: unknown;\n\n  try {\n    parsed = JSON.parse(value);\n  } catch {\n    throw new Error(\"Redis challenge record contains invalid JSON.\");\n  }\n\n  assertSerializedChallengeRecord(parsed);\n\n  return {\n    attemptsRemaining: parsed.attemptsRemaining,\n    channel: parsed.channel,\n    challengeId: parsed.challengeId,\n    createdAt: new Date(parsed.createdAt),\n    expiresAt: new Date(parsed.expiresAt),\n    otpHash: parsed.otpHash,\n    purpose: parsed.purpose,\n    recipient: parsed.recipient\n  };\n}\n\nfunction assertSerializedChallengeRecord(value: unknown): asserts value is SerializedChallengeRecord {\n  if (typeof value !== \"object\" || value === null) {\n    throw new Error(\"Redis challenge record must be an object.\");\n  }\n\n  const record = value as Record<string, unknown>;\n\n  if (!Number.isInteger(record.attemptsRemaining)) {\n    throw new Error(\"Redis challenge record attemptsRemaining must be an integer.\");\n  }\n\n  if (record.channel !== \"sms\" && record.channel !== \"email\") {\n    throw new Error(\"Redis challenge record channel is invalid.\");\n  }\n\n  const stringFields = [\"challengeId\", \"createdAt\", \"expiresAt\", \"otpHash\", \"purpose\", \"recipient\"] as const;\n\n  for (const field of stringFields) {\n    const fieldValue = record[field];\n    if (typeof fieldValue !== \"string\" || fieldValue.trim().length === 0) {\n      throw new Error(`Redis challenge record ${field} must be a non-empty string.`);\n    }\n  }\n\n  if (Number.isNaN(new Date(record.createdAt as string).getTime())) {\n    throw new Error(\"Redis challenge record createdAt must be a valid ISO date string.\");\n  }\n\n  if (Number.isNaN(new Date(record.expiresAt as string).getTime())) {\n    throw new Error(\"Redis challenge record expiresAt must be a valid ISO date string.\");\n  }\n}\n\nfunction serializeRecord(record: ChallengeRecord): string {\n  return JSON.stringify({\n    attemptsRemaining: record.attemptsRemaining,\n    channel: record.channel,\n    challengeId: record.challengeId,\n    createdAt: record.createdAt.toISOString(),\n    expiresAt: record.expiresAt.toISOString(),\n    otpHash: record.otpHash,\n    purpose: record.purpose,\n    recipient: record.recipient\n  } satisfies SerializedChallengeRecord);\n}\n\nfunction toRedisKey(keyPrefix: string, challengeId: string): string {\n  return `${keyPrefix}:${challengeId}`;\n}\n\nfunction ttlSecondsFrom(expiresAt: Date, clock: () => Date): number {\n  const millisecondsRemaining = expiresAt.getTime() - clock().getTime();\n  return Math.max(0, Math.ceil(millisecondsRemaining / 1000));\n}\n"]}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@otp-service/redis-store",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "Redis-backed challenge state storage for OTP services.",
+  "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/redis-store#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"
+  },
+  "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"
+  }
+}