@sudobility/ratelimit_service 1.0.1

package/dist/helpers/RateLimitChecker.d.ts

@@ -0,0 +1,90 @@
+import type { PostgresJsDatabase } from "drizzle-orm/postgres-js";
+import type { PgTable, TableConfig } from "drizzle-orm/pg-core";
+import { PeriodType, type RateLimits, type RateLimitCheckResult, type UsageHistory } from "../types";
+/**
+ * Configuration for RateLimitChecker.
+ */
+export interface RateLimitCheckerConfig {
+    /** Drizzle database instance */
+    db: PostgresJsDatabase<any>;
+    /** The rate_limit_counters table from your schema */
+    table: PgTable<TableConfig>;
+}
+/**
+ * Checks and updates rate limits for a user.
+ * Uses period-based counters with history preservation.
+ *
+ * @example
+ * ```typescript
+ * import { db, rateLimitCounters } from "./db";
+ *
+ * const checker = new RateLimitChecker({ db, table: rateLimitCounters });
+ *
+ * const result = await checker.checkAndIncrement(
+ *   userId,
+ *   { hourly: 10, daily: 100, monthly: undefined },
+ *   subscriptionStartedAt  // from RevenueCat
+ * );
+ *
+ * if (!result.allowed) {
+ *   return c.json({ error: "Rate limit exceeded" }, 429);
+ * }
+ * ```
+ */
+export declare class RateLimitChecker {
+    private readonly db;
+    private readonly table;
+    constructor(config: RateLimitCheckerConfig);
+    /**
+     * Check if request is within rate limits and increment counters.
+     *
+     * @param userId - The user's ID
+     * @param limits - The rate limits to apply
+     * @param subscriptionStartedAt - When the subscription started (for monthly calculation)
+     * @returns Result indicating if request is allowed and remaining limits
+     */
+    checkAndIncrement(userId: string, limits: RateLimits, subscriptionStartedAt?: Date | null): Promise<RateLimitCheckResult>;
+    /**
+     * Get current usage without incrementing (for status queries).
+     */
+    checkOnly(userId: string, limits: RateLimits, subscriptionStartedAt?: Date | null): Promise<RateLimitCheckResult>;
+    /**
+     * Get usage history for a user.
+     *
+     * @param userId - The user's ID
+     * @param periodType - The period type to get history for
+     * @param subscriptionStartedAt - When the subscription started (for calculating period_end)
+     * @param limit - Maximum number of entries to return (default: 100)
+     * @returns Usage history with period start/end and counts
+     */
+    getHistory(userId: string, periodType: PeriodType, subscriptionStartedAt?: Date | null, limit?: number): Promise<UsageHistory>;
+    /**
+     * Get current counts for each period type.
+     */
+    private getCurrentCounts;
+    /**
+     * Get the counter value for a specific period.
+     */
+    private getCountForPeriod;
+    /**
+     * Increment counters for enabled limit types.
+     */
+    private incrementCounters;
+    /**
+     * Increment a specific period counter (upsert).
+     */
+    private incrementPeriodCounter;
+    /**
+     * Check limits and return result.
+     */
+    private checkLimits;
+    /**
+     * Calculate remaining requests for each period.
+     */
+    private calculateRemaining;
+    /**
+     * Get the end of a period for history entries.
+     */
+    private getPeriodEnd;
+}
+//# sourceMappingURL=RateLimitChecker.d.ts.map

package/dist/helpers/RateLimitChecker.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RateLimitChecker.d.ts","sourceRoot":"","sources":["../../src/helpers/RateLimitChecker.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,EACL,UAAU,EACV,KAAK,UAAU,EACf,KAAK,oBAAoB,EAGzB,KAAK,YAAY,EAElB,MAAM,UAAU,CAAC;AAUlB;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,gCAAgC;IAChC,EAAE,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAC5B,qDAAqD;IACrD,KAAK,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,EAAE,CAA0B;IAC7C,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAuB;gBAEjC,MAAM,EAAE,sBAAsB;IAK1C;;;;;;;OAOG;IACG,iBAAiB,CACrB,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,UAAU,EAClB,qBAAqB,GAAE,IAAI,GAAG,IAAW,GACxC,OAAO,CAAC,oBAAoB,CAAC;IAsChC;;OAEG;IACG,SAAS,CACb,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,UAAU,EAClB,qBAAqB,GAAE,IAAI,GAAG,IAAW,GACxC,OAAO,CAAC,oBAAoB,CAAC;IAiBhC;;;;;;;;OAQG;IACG,UAAU,CACd,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,UAAU,EACtB,qBAAqB,GAAE,IAAI,GAAG,IAAW,EACzC,KAAK,GAAE,MAAY,GAClB,OAAO,CAAC,YAAY,CAAC;IAgCxB;;OAEG;YACW,gBAAgB;IA0B9B;;OAEG;YACW,iBAAiB;IA2B/B;;OAEG;YACW,iBAAiB;IA4C/B;;OAEG;YACW,sBAAsB;IA4CpC;;OAEG;IACH,OAAO,CAAC,WAAW;IA+CnB;;OAEG;IACH,OAAO,CAAC,kBAAkB;IAoB1B;;OAEG;IACH,OAAO,CAAC,YAAY;CAiBrB"}

package/dist/helpers/RateLimitChecker.js

@@ -0,0 +1,264 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateLimitChecker = void 0;
+const drizzle_orm_1 = require("drizzle-orm");
+const types_1 = require("../types");
+const time_1 = require("../utils/time");
+/**
+ * Checks and updates rate limits for a user.
+ * Uses period-based counters with history preservation.
+ *
+ * @example
+ * ```typescript
+ * import { db, rateLimitCounters } from "./db";
+ *
+ * const checker = new RateLimitChecker({ db, table: rateLimitCounters });
+ *
+ * const result = await checker.checkAndIncrement(
+ *   userId,
+ *   { hourly: 10, daily: 100, monthly: undefined },
+ *   subscriptionStartedAt  // from RevenueCat
+ * );
+ *
+ * if (!result.allowed) {
+ *   return c.json({ error: "Rate limit exceeded" }, 429);
+ * }
+ * ```
+ */
+class RateLimitChecker {
+    constructor(config) {
+        this.db = config.db;
+        this.table = config.table;
+    }
+    /**
+     * Check if request is within rate limits and increment counters.
+     *
+     * @param userId - The user's ID
+     * @param limits - The rate limits to apply
+     * @param subscriptionStartedAt - When the subscription started (for monthly calculation)
+     * @returns Result indicating if request is allowed and remaining limits
+     */
+    async checkAndIncrement(userId, limits, subscriptionStartedAt = null) {
+        const now = new Date();
+        // Get current counts for each period type
+        const counts = await this.getCurrentCounts(userId, subscriptionStartedAt, now);
+        // Check limits before incrementing
+        const checkResult = this.checkLimits(counts, limits);
+        if (!checkResult.allowed) {
+            return checkResult;
+        }
+        // Increment counters for enabled limit types
+        await this.incrementCounters(userId, limits, subscriptionStartedAt, now);
+        // Calculate remaining after increment
+        const remaining = this.calculateRemaining({
+            hourly: counts.hourly + (limits.hourly !== undefined ? 1 : 0),
+            daily: counts.daily + (limits.daily !== undefined ? 1 : 0),
+            monthly: counts.monthly + (limits.monthly !== undefined ? 1 : 0),
+        }, limits);
+        return {
+            allowed: true,
+            statusCode: 200,
+            remaining,
+            limits,
+        };
+    }
+    /**
+     * Get current usage without incrementing (for status queries).
+     */
+    async checkOnly(userId, limits, subscriptionStartedAt = null) {
+        const now = new Date();
+        const counts = await this.getCurrentCounts(userId, subscriptionStartedAt, now);
+        const checkResult = this.checkLimits(counts, limits);
+        const remaining = this.calculateRemaining(counts, limits);
+        return {
+            ...checkResult,
+            remaining,
+            limits,
+        };
+    }
+    /**
+     * Get usage history for a user.
+     *
+     * @param userId - The user's ID
+     * @param periodType - The period type to get history for
+     * @param subscriptionStartedAt - When the subscription started (for calculating period_end)
+     * @param limit - Maximum number of entries to return (default: 100)
+     * @returns Usage history with period start/end and counts
+     */
+    async getHistory(userId, periodType, subscriptionStartedAt = null, limit = 100) {
+        const tableAny = this.table;
+        const rows = await this.db
+            .select()
+            .from(this.table)
+            .where((0, drizzle_orm_1.and)((0, drizzle_orm_1.eq)(tableAny.user_id, userId), (0, drizzle_orm_1.eq)(tableAny.period_type, periodType)))
+            .orderBy((0, drizzle_orm_1.desc)(tableAny.period_start))
+            .limit(limit);
+        const entries = rows.map(row => {
+            const counter = row;
+            return {
+                period_start: counter.period_start,
+                period_end: this.getPeriodEnd(periodType, counter.period_start, subscriptionStartedAt),
+                request_count: counter.request_count,
+            };
+        });
+        return {
+            user_id: userId,
+            period_type: periodType,
+            entries,
+        };
+    }
+    /**
+     * Get current counts for each period type.
+     */
+    async getCurrentCounts(userId, subscriptionStartedAt, now) {
+        const [hourlyCount, dailyCount, monthlyCount] = await Promise.all([
+            this.getCountForPeriod(userId, types_1.PeriodType.HOURLY, (0, time_1.getCurrentHourStart)(now)),
+            this.getCountForPeriod(userId, types_1.PeriodType.DAILY, (0, time_1.getCurrentDayStart)(now)),
+            this.getCountForPeriod(userId, types_1.PeriodType.MONTHLY, (0, time_1.getSubscriptionMonthStart)(subscriptionStartedAt, now)),
+        ]);
+        return {
+            hourly: hourlyCount,
+            daily: dailyCount,
+            monthly: monthlyCount,
+        };
+    }
+    /**
+     * Get the counter value for a specific period.
+     */
+    async getCountForPeriod(userId, periodType, periodStart) {
+        const tableAny = this.table;
+        const rows = await this.db
+            .select()
+            .from(this.table)
+            .where((0, drizzle_orm_1.and)((0, drizzle_orm_1.eq)(tableAny.user_id, userId), (0, drizzle_orm_1.eq)(tableAny.period_type, periodType), (0, drizzle_orm_1.eq)(tableAny.period_start, periodStart)))
+            .limit(1);
+        if (rows.length === 0) {
+            return 0;
+        }
+        const counter = rows[0];
+        return counter.request_count;
+    }
+    /**
+     * Increment counters for enabled limit types.
+     */
+    async incrementCounters(userId, limits, subscriptionStartedAt, now) {
+        const updates = [];
+        if (limits.hourly !== undefined) {
+            updates.push(this.incrementPeriodCounter(userId, types_1.PeriodType.HOURLY, (0, time_1.getCurrentHourStart)(now), now));
+        }
+        if (limits.daily !== undefined) {
+            updates.push(this.incrementPeriodCounter(userId, types_1.PeriodType.DAILY, (0, time_1.getCurrentDayStart)(now), now));
+        }
+        if (limits.monthly !== undefined) {
+            updates.push(this.incrementPeriodCounter(userId, types_1.PeriodType.MONTHLY, (0, time_1.getSubscriptionMonthStart)(subscriptionStartedAt, now), now));
+        }
+        await Promise.all(updates);
+    }
+    /**
+     * Increment a specific period counter (upsert).
+     */
+    async incrementPeriodCounter(userId, periodType, periodStart, now) {
+        const tableAny = this.table;
+        // Try to find existing counter
+        const existing = await this.db
+            .select()
+            .from(this.table)
+            .where((0, drizzle_orm_1.and)((0, drizzle_orm_1.eq)(tableAny.user_id, userId), (0, drizzle_orm_1.eq)(tableAny.period_type, periodType), (0, drizzle_orm_1.eq)(tableAny.period_start, periodStart)))
+            .limit(1);
+        if (existing.length > 0) {
+            // Update existing counter
+            const counter = existing[0];
+            await this.db
+                .update(this.table)
+                .set({
+                request_count: counter.request_count + 1,
+                updated_at: now,
+            })
+                .where((0, drizzle_orm_1.eq)(tableAny.id, counter.id));
+        }
+        else {
+            // Insert new counter
+            await this.db.insert(this.table).values({
+                user_id: userId,
+                period_type: periodType,
+                period_start: periodStart,
+                request_count: 1,
+                created_at: now,
+                updated_at: now,
+            });
+        }
+    }
+    /**
+     * Check limits and return result.
+     */
+    checkLimits(counts, limits) {
+        const remaining = this.calculateRemaining(counts, limits);
+        // Check hourly limit
+        if (limits.hourly !== undefined && counts.hourly >= limits.hourly) {
+            return {
+                allowed: false,
+                statusCode: 429,
+                remaining,
+                exceededLimit: "hourly",
+                limits,
+            };
+        }
+        // Check daily limit
+        if (limits.daily !== undefined && counts.daily >= limits.daily) {
+            return {
+                allowed: false,
+                statusCode: 429,
+                remaining,
+                exceededLimit: "daily",
+                limits,
+            };
+        }
+        // Check monthly limit
+        if (limits.monthly !== undefined && counts.monthly >= limits.monthly) {
+            return {
+                allowed: false,
+                statusCode: 429,
+                remaining,
+                exceededLimit: "monthly",
+                limits,
+            };
+        }
+        return {
+            allowed: true,
+            statusCode: 200,
+            remaining,
+            limits,
+        };
+    }
+    /**
+     * Calculate remaining requests for each period.
+     */
+    calculateRemaining(counts, limits) {
+        return {
+            hourly: limits.hourly !== undefined
+                ? Math.max(0, limits.hourly - counts.hourly)
+                : undefined,
+            daily: limits.daily !== undefined
+                ? Math.max(0, limits.daily - counts.daily)
+                : undefined,
+            monthly: limits.monthly !== undefined
+                ? Math.max(0, limits.monthly - counts.monthly)
+                : undefined,
+        };
+    }
+    /**
+     * Get the end of a period for history entries.
+     */
+    getPeriodEnd(periodType, periodStart, subscriptionStartedAt) {
+        switch (periodType) {
+            case types_1.PeriodType.HOURLY:
+                return (0, time_1.getNextHourStart)(periodStart);
+            case types_1.PeriodType.DAILY:
+                return (0, time_1.getNextDayStart)(periodStart);
+            case types_1.PeriodType.MONTHLY:
+                return (0, time_1.getNextSubscriptionMonthStart)(subscriptionStartedAt, periodStart);
+        }
+    }
+}
+exports.RateLimitChecker = RateLimitChecker;
+//# sourceMappingURL=RateLimitChecker.js.map

package/dist/helpers/RateLimitChecker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RateLimitChecker.js","sourceRoot":"","sources":["../../src/helpers/RateLimitChecker.ts"],"names":[],"mappings":";;;AAAA,6CAA4C;AAG5C,oCAQkB;AAClB,wCAOuB;AAYvB;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,gBAAgB;IAI3B,YAAY,MAA8B;QACxC,IAAI,CAAC,EAAE,GAAG,MAAM,CAAC,EAAE,CAAC;QACpB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;IAC5B,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,iBAAiB,CACrB,MAAc,EACd,MAAkB,EAClB,wBAAqC,IAAI;QAEzC,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QAEvB,0CAA0C;QAC1C,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,gBAAgB,CACxC,MAAM,EACN,qBAAqB,EACrB,GAAG,CACJ,CAAC;QAEF,mCAAmC;QACnC,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAErD,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,CAAC;YACzB,OAAO,WAAW,CAAC;QACrB,CAAC;QAED,6CAA6C;QAC7C,MAAM,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,qBAAqB,EAAE,GAAG,CAAC,CAAC;QAEzE,sCAAsC;QACtC,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CACvC;YACE,MAAM,EAAE,MAAM,CAAC,MAAM,GAAG,CAAC,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7D,KAAK,EAAE,MAAM,CAAC,KAAK,GAAG,CAAC,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC1D,OAAO,EAAE,MAAM,CAAC,OAAO,GAAG,CAAC,MAAM,CAAC,OAAO,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACjE,EACD,MAAM,CACP,CAAC;QAEF,OAAO;YACL,OAAO,EAAE,IAAI;YACb,UAAU,EAAE,GAAG;YACf,SAAS;YACT,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CACb,MAAc,EACd,MAAkB,EAClB,wBAAqC,IAAI;QAEzC,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,gBAAgB,CACxC,MAAM,EACN,qBAAqB,EACrB,GAAG,CACJ,CAAC;QACF,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACrD,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAE1D,OAAO;YACL,GAAG,WAAW;YACd,SAAS;YACT,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,UAAU,CACd,MAAc,EACd,UAAsB,EACtB,wBAAqC,IAAI,EACzC,QAAgB,GAAG;QAEnB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAY,CAAC;QAEnC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,EAAE;aACvB,MAAM,EAAE;aACR,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;aAChB,KAAK,CACJ,IAAA,iBAAG,EAAC,IAAA,gBAAE,EAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,IAAA,gBAAE,EAAC,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CACxE;aACA,OAAO,CAAC,IAAA,kBAAI,EAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;aACpC,KAAK,CAAC,KAAK,CAAC,CAAC;QAEhB,MAAM,OAAO,GAAwB,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YAClD,MAAM,OAAO,GAAG,GAAqC,CAAC;YACtD,OAAO;gBACL,YAAY,EAAE,OAAO,CAAC,YAAY;gBAClC,UAAU,EAAE,IAAI,CAAC,YAAY,CAC3B,UAAU,EACV,OAAO,CAAC,YAAY,EACpB,qBAAqB,CACtB;gBACD,aAAa,EAAE,OAAO,CAAC,aAAa;aACrC,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO;YACL,OAAO,EAAE,MAAM;YACf,WAAW,EAAE,UAAU;YACvB,OAAO;SACR,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,gBAAgB,CAC5B,MAAc,EACd,qBAAkC,EAClC,GAAS;QAET,MAAM,CAAC,WAAW,EAAE,UAAU,EAAE,YAAY,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAChE,IAAI,CAAC,iBAAiB,CACpB,MAAM,EACN,kBAAU,CAAC,MAAM,EACjB,IAAA,0BAAmB,EAAC,GAAG,CAAC,CACzB;YACD,IAAI,CAAC,iBAAiB,CAAC,MAAM,EAAE,kBAAU,CAAC,KAAK,EAAE,IAAA,yBAAkB,EAAC,GAAG,CAAC,CAAC;YACzE,IAAI,CAAC,iBAAiB,CACpB,MAAM,EACN,kBAAU,CAAC,OAAO,EAClB,IAAA,gCAAyB,EAAC,qBAAqB,EAAE,GAAG,CAAC,CACtD;SACF,CAAC,CAAC;QAEH,OAAO;YACL,MAAM,EAAE,WAAW;YACnB,KAAK,EAAE,UAAU;YACjB,OAAO,EAAE,YAAY;SACtB,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,iBAAiB,CAC7B,MAAc,EACd,UAAsB,EACtB,WAAiB;QAEjB,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAY,CAAC;QAEnC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,EAAE;aACvB,MAAM,EAAE;aACR,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;aAChB,KAAK,CACJ,IAAA,iBAAG,EACD,IAAA,gBAAE,EAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,EAC5B,IAAA,gBAAE,EAAC,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC,EACpC,IAAA,gBAAE,EAAC,QAAQ,CAAC,YAAY,EAAE,WAAW,CAAC,CACvC,CACF;aACA,KAAK,CAAC,CAAC,CAAC,CAAC;QAEZ,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,OAAO,CAAC,CAAC;QACX,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,CAAC,CAAmC,CAAC;QAC1D,OAAO,OAAO,CAAC,aAAa,CAAC;IAC/B,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,iBAAiB,CAC7B,MAAc,EACd,MAAkB,EAClB,qBAAkC,EAClC,GAAS;QAET,MAAM,OAAO,GAAoB,EAAE,CAAC;QAEpC,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,CAAC,IAAI,CACV,IAAI,CAAC,sBAAsB,CACzB,MAAM,EACN,kBAAU,CAAC,MAAM,EACjB,IAAA,0BAAmB,EAAC,GAAG,CAAC,EACxB,GAAG,CACJ,CACF,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;YAC/B,OAAO,CAAC,IAAI,CACV,IAAI,CAAC,sBAAsB,CACzB,MAAM,EACN,kBAAU,CAAC,KAAK,EAChB,IAAA,yBAAkB,EAAC,GAAG,CAAC,EACvB,GAAG,CACJ,CACF,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YACjC,OAAO,CAAC,IAAI,CACV,IAAI,CAAC,sBAAsB,CACzB,MAAM,EACN,kBAAU,CAAC,OAAO,EAClB,IAAA,gCAAyB,EAAC,qBAAqB,EAAE,GAAG,CAAC,EACrD,GAAG,CACJ,CACF,CAAC;QACJ,CAAC;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAC7B,CAAC;IAED;;OAEG;IACK,KAAK,CAAC,sBAAsB,CAClC,MAAc,EACd,UAAsB,EACtB,WAAiB,EACjB,GAAS;QAET,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAY,CAAC;QAEnC,+BAA+B;QAC/B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,EAAE;aAC3B,MAAM,EAAE;aACR,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;aAChB,KAAK,CACJ,IAAA,iBAAG,EACD,IAAA,gBAAE,EAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,EAC5B,IAAA,gBAAE,EAAC,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC,EACpC,IAAA,gBAAE,EAAC,QAAQ,CAAC,YAAY,EAAE,WAAW,CAAC,CACvC,CACF;aACA,KAAK,CAAC,CAAC,CAAC,CAAC;QAEZ,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,0BAA0B;YAC1B,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,CAAmC,CAAC;YAC9D,MAAM,IAAI,CAAC,EAAE;iBACV,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;iBAClB,GAAG,CAAC;gBACH,aAAa,EAAE,OAAO,CAAC,aAAa,GAAG,CAAC;gBACxC,UAAU,EAAE,GAAG;aAChB,CAAC;iBACD,KAAK,CAAC,IAAA,gBAAE,EAAC,QAAQ,CAAC,EAAE,EAAE,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC;QACxC,CAAC;aAAM,CAAC;YACN,qBAAqB;YACrB,MAAM,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC;gBACtC,OAAO,EAAE,MAAM;gBACf,WAAW,EAAE,UAAU;gBACvB,YAAY,EAAE,WAAW;gBACzB,aAAa,EAAE,CAAC;gBAChB,UAAU,EAAE,GAAG;gBACf,UAAU,EAAE,GAAG;aAChB,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED;;OAEG;IACK,WAAW,CACjB,MAA0D,EAC1D,MAAkB;QAElB,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAE1D,qBAAqB;QACrB,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;YAClE,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,UAAU,EAAE,GAAG;gBACf,SAAS;gBACT,aAAa,EAAE,QAAQ;gBACvB,MAAM;aACP,CAAC;QACJ,CAAC;QAED,oBAAoB;QACpB,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;YAC/D,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,UAAU,EAAE,GAAG;gBACf,SAAS;gBACT,aAAa,EAAE,OAAO;gBACtB,MAAM;aACP,CAAC;QACJ,CAAC;QAED,sBAAsB;QACtB,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS,IAAI,MAAM,CAAC,OAAO,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACrE,OAAO;gBACL,OAAO,EAAE,KAAK;gBACd,UAAU,EAAE,GAAG;gBACf,SAAS;gBACT,aAAa,EAAE,SAAS;gBACxB,MAAM;aACP,CAAC;QACJ,CAAC;QAED,OAAO;YACL,OAAO,EAAE,IAAI;YACb,UAAU,EAAE,GAAG;YACf,SAAS;YACT,MAAM;SACP,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,kBAAkB,CACxB,MAA0D,EAC1D,MAAkB;QAElB,OAAO;YACL,MAAM,EACJ,MAAM,CAAC,MAAM,KAAK,SAAS;gBACzB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;gBAC5C,CAAC,CAAC,SAAS;YACf,KAAK,EACH,MAAM,CAAC,KAAK,KAAK,SAAS;gBACxB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;gBAC1C,CAAC,CAAC,SAAS;YACf,OAAO,EACL,MAAM,CAAC,OAAO,KAAK,SAAS;gBAC1B,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC;gBAC9C,CAAC,CAAC,SAAS;SAChB,CAAC;IACJ,CAAC;IAED;;OAEG;IACK,YAAY,CAClB,UAAsB,EACtB,WAAiB,EACjB,qBAAkC;QAElC,QAAQ,UAAU,EAAE,CAAC;YACnB,KAAK,kBAAU,CAAC,MAAM;gBACpB,OAAO,IAAA,uBAAgB,EAAC,WAAW,CAAC,CAAC;YACvC,KAAK,kBAAU,CAAC,KAAK;gBACnB,OAAO,IAAA,sBAAe,EAAC,WAAW,CAAC,CAAC;YACtC,KAAK,kBAAU,CAAC,OAAO;gBACrB,OAAO,IAAA,oCAA6B,EAClC,qBAAqB,EACrB,WAAW,CACZ,CAAC;QACN,CAAC;IACH,CAAC;CACF;AAvXD,4CAuXC"}

package/dist/helpers/RateLimitRouteHandler.cjs

@@ -0,0 +1,191 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateLimitRouteHandler = void 0;
+const RevenueCatHelper_1 = require("./RevenueCatHelper");
+const EntitlementHelper_1 = require("./EntitlementHelper");
+const RateLimitChecker_1 = require("./RateLimitChecker");
+const types_1 = require("../types");
+/**
+ * Default display names for common entitlements.
+ */
+const DEFAULT_DISPLAY_NAMES = {
+    none: "Free",
+    starter: "Starter",
+    pro: "Pro",
+    enterprise: "Enterprise",
+};
+/**
+ * Helper for rate limit API endpoints.
+ * Provides data for /ratelimits and /ratelimits/history endpoints.
+ */
+class RateLimitRouteHandler {
+    constructor(config) {
+        this.rcHelper = new RevenueCatHelper_1.RevenueCatHelper({ apiKey: config.revenueCatApiKey });
+        this.entitlementHelper = new EntitlementHelper_1.EntitlementHelper(config.rateLimitsConfig);
+        this.rateLimitChecker = new RateLimitChecker_1.RateLimitChecker({
+            db: config.db,
+            table: config.rateLimitsTable,
+        });
+        this.rateLimitsConfig = config.rateLimitsConfig;
+        this.displayNames = {
+            ...DEFAULT_DISPLAY_NAMES,
+            ...config.entitlementDisplayNames,
+        };
+    }
+    /**
+     * Get rate limits configuration data for /ratelimits endpoint.
+     *
+     * @param userId - The user's ID (e.g., Firebase UID)
+     * @returns RateLimitsConfigData for API response
+     */
+    async getRateLimitsConfigData(userId) {
+        // Get all tiers from config
+        const tiers = Object.entries(this.rateLimitsConfig).map(([entitlement, limits]) => ({
+            entitlement,
+            displayName: this.getDisplayName(entitlement),
+            limits: this.convertLimits(limits),
+        }));
+        // Get user's subscription info from RevenueCat
+        let entitlements;
+        let subscriptionStartedAt = null;
+        try {
+            const subscriptionInfo = await this.rcHelper.getSubscriptionInfo(userId);
+            entitlements = subscriptionInfo.entitlements;
+            subscriptionStartedAt = subscriptionInfo.subscriptionStartedAt;
+        }
+        catch (error) {
+            console.error("RevenueCat error, using 'none' entitlement:", error);
+            entitlements = [types_1.NONE_ENTITLEMENT];
+        }
+        // Get the primary entitlement (first one that has limits configured)
+        const currentEntitlement = this.getPrimaryEntitlement(entitlements);
+        // Get rate limits for user's entitlements
+        const internalLimits = this.entitlementHelper.getRateLimits(entitlements);
+        const currentLimits = this.convertLimits(internalLimits);
+        // Get current usage
+        const checkResult = await this.rateLimitChecker.checkOnly(userId, internalLimits, subscriptionStartedAt);
+        const currentUsage = {
+            hourly: internalLimits.hourly !== undefined
+                ? internalLimits.hourly - (checkResult.remaining.hourly ?? 0)
+                : 0,
+            daily: internalLimits.daily !== undefined
+                ? internalLimits.daily - (checkResult.remaining.daily ?? 0)
+                : 0,
+            monthly: internalLimits.monthly !== undefined
+                ? internalLimits.monthly - (checkResult.remaining.monthly ?? 0)
+                : 0,
+        };
+        return {
+            tiers,
+            currentEntitlement,
+            currentLimits,
+            currentUsage,
+        };
+    }
+    /**
+     * Get rate limit history data for /ratelimits/history/{periodType} endpoint.
+     *
+     * @param userId - The user's ID (e.g., Firebase UID)
+     * @param periodType - The period type (hour, day, month)
+     * @param limit - Maximum number of entries to return (default: 100)
+     * @returns RateLimitHistoryData for API response
+     */
+    async getRateLimitHistoryData(userId, periodType, limit = 100) {
+        // Convert API period type to internal period type
+        const internalPeriodType = this.convertPeriodType(periodType);
+        // Get user's subscription info for subscription month calculation
+        let subscriptionStartedAt = null;
+        let entitlements = [types_1.NONE_ENTITLEMENT];
+        try {
+            const subscriptionInfo = await this.rcHelper.getSubscriptionInfo(userId);
+            subscriptionStartedAt = subscriptionInfo.subscriptionStartedAt;
+            entitlements = subscriptionInfo.entitlements;
+        }
+        catch (error) {
+            console.error("RevenueCat error:", error);
+        }
+        // Get the limit for this period type
+        const internalLimits = this.entitlementHelper.getRateLimits(entitlements);
+        const periodLimit = this.getLimitForPeriod(internalLimits, periodType);
+        // Get history from database
+        const history = await this.rateLimitChecker.getHistory(userId, internalPeriodType, subscriptionStartedAt, limit);
+        // Convert to API format
+        const entries = history.entries.map(entry => ({
+            periodStart: entry.period_start.toISOString(),
+            periodEnd: entry.period_end.toISOString(),
+            requestCount: entry.request_count,
+            limit: periodLimit,
+        }));
+        return {
+            periodType,
+            entries,
+            totalEntries: entries.length,
+        };
+    }
+    /**
+     * Get display name for an entitlement.
+     */
+    getDisplayName(entitlement) {
+        if (this.displayNames[entitlement]) {
+            return this.displayNames[entitlement];
+        }
+        // Capitalize first letter as fallback
+        return entitlement.charAt(0).toUpperCase() + entitlement.slice(1);
+    }
+    /**
+     * Get the primary entitlement from a list.
+     * Returns the first entitlement that has configured limits, or "none".
+     */
+    getPrimaryEntitlement(entitlements) {
+        for (const entitlement of entitlements) {
+            if (entitlement !== types_1.NONE_ENTITLEMENT &&
+                this.rateLimitsConfig[entitlement]) {
+                return entitlement;
+            }
+        }
+        return types_1.NONE_ENTITLEMENT;
+    }
+    /**
+     * Convert internal RateLimits to API RateLimits.
+     * Internal uses undefined for unlimited, API uses null.
+     */
+    convertLimits(limits) {
+        return {
+            hourly: limits.hourly ?? null,
+            daily: limits.daily ?? null,
+            monthly: limits.monthly ?? null,
+        };
+    }
+    /**
+     * Convert API period type to internal period type.
+     */
+    convertPeriodType(periodType) {
+        switch (periodType) {
+            case "hour":
+                return types_1.PeriodType.HOURLY;
+            case "day":
+                return types_1.PeriodType.DAILY;
+            case "month":
+                return types_1.PeriodType.MONTHLY;
+            default:
+                throw new Error(`Invalid period type: ${periodType}`);
+        }
+    }
+    /**
+     * Get the limit for a specific period type.
+     */
+    getLimitForPeriod(limits, periodType) {
+        switch (periodType) {
+            case "hour":
+                return limits.hourly ?? null;
+            case "day":
+                return limits.daily ?? null;
+            case "month":
+                return limits.monthly ?? null;
+            default:
+                return null;
+        }
+    }
+}
+exports.RateLimitRouteHandler = RateLimitRouteHandler;
+//# sourceMappingURL=RateLimitRouteHandler.js.map

package/dist/helpers/RateLimitRouteHandler.d.ts

@@ -0,0 +1,70 @@
+import type { PostgresJsDatabase } from "drizzle-orm/postgres-js";
+import type { PgTable, TableConfig } from "drizzle-orm/pg-core";
+import type { RateLimitsConfigData, RateLimitHistoryData, RateLimitPeriodType } from "@sudobility/types";
+import { type RateLimitsConfig } from "../types";
+/**
+ * Configuration for RateLimitRouteHandler.
+ */
+export interface RateLimitRouteHandlerConfig {
+    /** RevenueCat API key */
+    revenueCatApiKey: string;
+    /** Rate limits configuration */
+    rateLimitsConfig: RateLimitsConfig;
+    /** Drizzle database instance */
+    db: PostgresJsDatabase<any>;
+    /** The rate_limit_counters table from your schema */
+    rateLimitsTable: PgTable<TableConfig>;
+    /** Display name mapping for entitlements (optional) */
+    entitlementDisplayNames?: Record<string, string>;
+}
+/**
+ * Helper for rate limit API endpoints.
+ * Provides data for /ratelimits and /ratelimits/history endpoints.
+ */
+export declare class RateLimitRouteHandler {
+    private readonly rcHelper;
+    private readonly entitlementHelper;
+    private readonly rateLimitChecker;
+    private readonly rateLimitsConfig;
+    private readonly displayNames;
+    constructor(config: RateLimitRouteHandlerConfig);
+    /**
+     * Get rate limits configuration data for /ratelimits endpoint.
+     *
+     * @param userId - The user's ID (e.g., Firebase UID)
+     * @returns RateLimitsConfigData for API response
+     */
+    getRateLimitsConfigData(userId: string): Promise<RateLimitsConfigData>;
+    /**
+     * Get rate limit history data for /ratelimits/history/{periodType} endpoint.
+     *
+     * @param userId - The user's ID (e.g., Firebase UID)
+     * @param periodType - The period type (hour, day, month)
+     * @param limit - Maximum number of entries to return (default: 100)
+     * @returns RateLimitHistoryData for API response
+     */
+    getRateLimitHistoryData(userId: string, periodType: RateLimitPeriodType, limit?: number): Promise<RateLimitHistoryData>;
+    /**
+     * Get display name for an entitlement.
+     */
+    private getDisplayName;
+    /**
+     * Get the primary entitlement from a list.
+     * Returns the first entitlement that has configured limits, or "none".
+     */
+    private getPrimaryEntitlement;
+    /**
+     * Convert internal RateLimits to API RateLimits.
+     * Internal uses undefined for unlimited, API uses null.
+     */
+    private convertLimits;
+    /**
+     * Convert API period type to internal period type.
+     */
+    private convertPeriodType;
+    /**
+     * Get the limit for a specific period type.
+     */
+    private getLimitForPeriod;
+}
+//# sourceMappingURL=RateLimitRouteHandler.d.ts.map

package/dist/helpers/RateLimitRouteHandler.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RateLimitRouteHandler.d.ts","sourceRoot":"","sources":["../../src/helpers/RateLimitRouteHandler.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAClE,OAAO,KAAK,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,KAAK,EACV,oBAAoB,EAIpB,oBAAoB,EAEpB,mBAAmB,EACpB,MAAM,mBAAmB,CAAC;AAI3B,OAAO,EAGL,KAAK,gBAAgB,EAEtB,MAAM,UAAU,CAAC;AAElB;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,yBAAyB;IACzB,gBAAgB,EAAE,MAAM,CAAC;IACzB,gCAAgC;IAChC,gBAAgB,EAAE,gBAAgB,CAAC;IACnC,gCAAgC;IAChC,EAAE,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAC5B,qDAAqD;IACrD,eAAe,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;IACtC,uDAAuD;IACvD,uBAAuB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClD;AAYD;;;GAGG;AACH,qBAAa,qBAAqB;IAChC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAC5C,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAoB;IACtD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAmB;IACpD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAmB;IACpD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAyB;gBAE1C,MAAM,EAAE,2BAA2B;IAc/C;;;;;OAKG;IACG,uBAAuB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC;IA2D5E;;;;;;;OAOG;IACG,uBAAuB,CAC3B,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,mBAAmB,EAC/B,KAAK,GAAE,MAAY,GAClB,OAAO,CAAC,oBAAoB,CAAC;IA0ChC;;OAEG;IACH,OAAO,CAAC,cAAc;IAQtB;;;OAGG;IACH,OAAO,CAAC,qBAAqB;IAY7B;;;OAGG;IACH,OAAO,CAAC,aAAa;IAQrB;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAazB;;OAEG;IACH,OAAO,CAAC,iBAAiB;CAe1B"}