feat(paykit): secondary storage

packages/paykit/src/secondary-storage/options.ts

@@ -0,0 +1,25 @@
+export interface PayKitSecondaryStorage {
+  /**
+   * Retrieve a value by key.
+   *
+   * @param key - The storage key.
+   * @returns The stored string value, or null if not found.
+   */
+  get: (key: string) => Promise<string | null>;
+
+  /**
+   * Store a value with an optional TTL.
+   *
+   * @param key - The storage key.
+   * @param value - The value to store.
+   * @param ttl - Time to live in seconds. If ommitted, the value should be stored indefinitely.
+   */
+  set: (key: string, value: string, ttl?: number) => Promise<void> | void;
+
+  /**
+   * Delete a value by key.
+   *
+   * @param key - The storage key.
+   */
+  delete: (key: string) => Promise<void> | void;
+}

packages/paykit/src/types/options.ts

@@ -2,6 +2,7 @@ import type { Pool } from "pg";
 import type { LevelWithSilent, Logger } from "pino";
 
 import type { StripeProviderConfig } from "../providers/provider";
+import type { PayKitSecondaryStorage } from "../secondary-storage/options";
 import type { PayKitEventHandlers } from "./events";
 import type { PayKitPlugin } from "./plugin";
 import type { PayKitPlansModule } from "./schema";
@@ -27,6 +28,7 @@ export interface PayKitOptions {
   } | null>;
   on?: PayKitEventHandlers;
   plugins?: PayKitPlugin[];
+  secondaryStorage?: PayKitSecondaryStorage;
   logging?: PayKitLoggingOptions;
   testing?: PayKitTestingOptions;
 }