@molecule/api-entitlements 1.0.0

package/LICENSE

@@ -0,0 +1,115 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work.
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship.
+
+      "Contribution" shall mean any work of authorship, including the
+      original version of the Work and any modifications or additions
+      to that Work, that is intentionally submitted to the Licensor for
+      inclusion in the Work by the copyright owner or by an individual or
+      Legal Entity authorized to submit on behalf of the copyright owner.
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by the Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      patent license to make, have made, use, offer to sell, sell, import,
+      and otherwise transfer the Work.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file.
+
+   5. Submission of Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND.
+
+   8. Limitation of Liability. In no event and under no legal theory shall
+      any Contributor be liable to You for damages.
+
+   9. Accepting Warranty or Additional Liability.
+
+   Copyright 2026 Molecule Dev, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/dist/browser-guard.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=browser-guard.d.ts.map

package/dist/browser-guard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-guard.d.ts","sourceRoot":"","sources":["../src/browser-guard.ts"],"names":[],"mappings":"AAuBA,OAAO,EAAE,CAAA"}

package/dist/browser-guard.js

@@ -0,0 +1,19 @@
+/**
+ * Browser guard — `@molecule/api-entitlements` is SERVER-ONLY.
+ *
+ * Generated by scripts/gen-browser-guards.mjs (workspace root) — edit THAT, not this.
+ * Evaluating a server package in a browser bundle is always an import-graph mistake
+ * (node APIs, secrets); without this guard it surfaces as a cryptic downstream crash
+ * ("Buffer is not defined") far from the culprit. Throwing here names the package and
+ * the fix at the exact moment the client bundle evaluates it. jsdom tests and SSR are
+ * unaffected: the throw requires browser globals AND the absence of a node runtime.
+ */
+const g = globalThis;
+if (g.window !== undefined && g.document !== undefined && !g.process?.versions?.node) {
+    throw new Error('@molecule/api-entitlements is SERVER-ONLY: it was bundled into browser/client code. Import it only ' +
+        'from server code (a server route/function or your API), or dynamic-import it inside ' +
+        'the server handler — never from components or shared client modules, and never ' +
+        'polyfill Buffer/process to silence this.');
+}
+export {};
+//# sourceMappingURL=browser-guard.js.map

package/dist/browser-guard.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"browser-guard.js","sourceRoot":"","sources":["../src/browser-guard.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AACH,MAAM,CAAC,GAAG,UAIT,CAAA;AACD,IAAI,CAAC,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;IACrF,MAAM,IAAI,KAAK,CACb,qGAAqG;QACnG,sFAAsF;QACtF,iFAAiF;QACjF,0CAA0C,CAC7C,CAAA;AACH,CAAC"}

package/dist/cache.d.ts

@@ -0,0 +1,120 @@
+/**
+ * Per-process plan-key cache.
+ *
+ * Resolving a user's effective plan key on every request would saturate the
+ * database connection pool under load. The plan cache holds a short-lived
+ * mapping from `userId` → effective plan key (with anonymous and expired-plan
+ * handling already applied), evicted by TTL and bounded by a max-entries cap.
+ *
+ * The cache is a module-level singleton — there is one cache per process,
+ * which is what production deployments want. Tests should call
+ * `clearPlanCache()` between cases to avoid cross-test contamination.
+ *
+ * @module
+ */
+/**
+ * App-specific hook that maps a stored `(planKey, planExpiresAt)` pair to the
+ * EFFECTIVE plan key — applied by {@link getCachedPlanKey} on every cache miss
+ * before the value is cached, so the cached (hot-path) result already reflects
+ * the app's plan-key semantics.
+ *
+ * The cache itself only knows the generic expiry rule (a past `planExpiresAt`
+ * demotes to default). Conventions like "an in-app-purchase key with no expiry
+ * is unverified → demote to free" are APP-specific (the `apple*`/`google*`
+ * prefix set is defined by the app, not this package). Apps inject that rule
+ * here so the hot path and the app's own `resolveEffectivePlanKey` cannot
+ * diverge — there is one demotion implementation, reused.
+ *
+ * @param planKey - The user's stored plan key (or `null` when unset).
+ * @param planExpiresAt - The user's stored plan expiry, or `null`.
+ * @returns The effective plan key (possibly demoted), or `null` for default tier.
+ */
+export type EffectivePlanKeyResolver = (planKey: string | null, planExpiresAt: string | null | undefined) => string | null;
+/** Configuration options for the plan cache. */
+export interface PlanCacheOptions {
+    /** Cache entry TTL in milliseconds. Defaults to 5 minutes. */
+    ttlMs?: number;
+    /**
+     * Max number of cached entries. When exceeded, the oldest insertion-order
+     * entry is evicted on the next write. Defaults to 50,000.
+     */
+    maxEntries?: number;
+    /**
+     * App-specific effective-plan-key demotion (see
+     * {@link EffectivePlanKeyResolver}). Applied on every cache MISS so the cached
+     * hot-path result already reflects the app's plan-key semantics — e.g. an
+     * in-app-purchase key with no expiry demoting to free. Defaults to identity.
+     * Pass `null` to clear a previously-set resolver back to identity.
+     */
+    effectivePlanKeyResolver?: EffectivePlanKeyResolver | null;
+}
+/**
+ * Reconfigures the plan cache. Existing entries remain; only future
+ * insertions and TTL checks observe the new settings.
+ *
+ * @param options - Optional overrides for TTL, maxEntries, and the
+ *   effective-plan-key resolver.
+ */
+export declare const configurePlanCache: (options?: PlanCacheOptions) => void;
+/**
+ * Drops every cached plan-key entry. Intended for tests and graceful
+ * shutdown — production code should not need to call this.
+ */
+export declare const clearPlanCache: () => void;
+/**
+ * Returns the number of currently cached entries. Mainly useful for tests
+ * and operational metrics.
+ *
+ * @returns Current cache size.
+ */
+export declare const planCacheSize: () => number;
+/**
+ * Resolve the effective plan key for a user, hitting the cache on warm reads
+ * and falling back to a DB lookup on cache miss.
+ *
+ * The effective plan key:
+ * - Returns `'anonymous'` for users flagged as anonymous, regardless of stored plan.
+ * - Returns `null` for users whose `planExpiresAt` is in the past — callers
+ *   should treat this as the default tier.
+ * - Returns the stored plan key otherwise (or `null` if none was stored).
+ *
+ * @param userId - The user ID to look up.
+ * @returns The effective plan key, or `null` for default-tier users.
+ */
+export declare const getCachedPlanKey: (userId: string) => Promise<string | null>;
+/**
+ * Resolve a user's effective plan key AND the plan expiry it was derived from,
+ * hitting the same cache {@link getCachedPlanKey} uses.
+ *
+ * Exists because the expiry is already read on every cache miss: a consumer
+ * that needs the subscription's period boundary — an allowance that refreshes
+ * with the billing period, a renewal countdown — can have it for free instead
+ * of issuing its own per-request user lookup, which is precisely the database
+ * load this cache was introduced to remove.
+ *
+ * `planExpiresAt` is the STORED value, not an effective one: it is `null` for
+ * anonymous/free users and may be in the past for a plan that has just lapsed
+ * (in which case `planKey` is already demoted to `null`).
+ *
+ * @param userId - The user ID to look up.
+ * @returns The effective plan key and the stored plan expiry.
+ */
+export declare const getCachedPlanState: (userId: string) => Promise<{
+    planKey: string | null;
+    planExpiresAt: string | null;
+}>;
+/**
+ * Invalidate a single user's cached plan-key entry. Call this immediately
+ * after writing a new `planKey` / `planExpiresAt` to the user record (e.g.
+ * from a webhook handler) so the next request reflects the change without
+ * waiting out the TTL.
+ *
+ * @param userId - The user ID whose cache entry should be evicted.
+ */
+export declare const invalidateCachedPlanKey: (userId: string) => void;
+/**
+ * Sweep expired entries from the cache. Safe to call from a recurring
+ * cleanup interval; idempotent and O(n) in cache size.
+ */
+export declare const sweepExpiredPlanCacheEntries: () => void;
+//# sourceMappingURL=cache.d.ts.map

package/dist/cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAsBH;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,MAAM,wBAAwB,GAAG,CACrC,OAAO,EAAE,MAAM,GAAG,IAAI,EACtB,aAAa,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,KACrC,MAAM,GAAG,IAAI,CAAA;AAElB,gDAAgD;AAChD,MAAM,WAAW,gBAAgB;IAC/B,8DAA8D;IAC9D,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;;;;OAMG;IACH,wBAAwB,CAAC,EAAE,wBAAwB,GAAG,IAAI,CAAA;CAC3D;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAAI,UAAS,gBAAqB,KAAG,IAMnE,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,QAAO,IAEjC,CAAA;AAED;;;;;GAKG;AACH,eAAO,MAAM,aAAa,QAAO,MAEhC,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,gBAAgB,GAAU,QAAQ,MAAM,KAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAE5E,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,kBAAkB,GAC7B,QAAQ,MAAM,KACb,OAAO,CAAC;IAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,aAAa,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,CAkDlE,CAAA;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,uBAAuB,GAAI,QAAQ,MAAM,KAAG,IAExD,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,4BAA4B,QAAO,IAK/C,CAAA"}

package/dist/cache.js

@@ -0,0 +1,163 @@
+/**
+ * Per-process plan-key cache.
+ *
+ * Resolving a user's effective plan key on every request would saturate the
+ * database connection pool under load. The plan cache holds a short-lived
+ * mapping from `userId` → effective plan key (with anonymous and expired-plan
+ * handling already applied), evicted by TTL and bounded by a max-entries cap.
+ *
+ * The cache is a module-level singleton — there is one cache per process,
+ * which is what production deployments want. Tests should call
+ * `clearPlanCache()` between cases to avoid cross-test contamination.
+ *
+ * @module
+ */
+import { findById } from '@molecule/api-database';
+const DEFAULT_TTL_MS = 300_000; // 5 minutes
+const DEFAULT_MAX_ENTRIES = 50_000;
+let ttlMs = DEFAULT_TTL_MS;
+let maxEntries = DEFAULT_MAX_ENTRIES;
+/**
+ * Optional app-specific demotion applied to the freshly-resolved
+ * `(planKey, planExpiresAt)` on a cache MISS, before the result is cached.
+ * Defaults to identity (no demotion). See {@link EffectivePlanKeyResolver} and
+ * {@link configurePlanCache}.
+ */
+let resolveEffective = (planKey) => planKey;
+const cache = new Map();
+/**
+ * Reconfigures the plan cache. Existing entries remain; only future
+ * insertions and TTL checks observe the new settings.
+ *
+ * @param options - Optional overrides for TTL, maxEntries, and the
+ *   effective-plan-key resolver.
+ */
+export const configurePlanCache = (options = {}) => {
+    if (options.ttlMs != null)
+        ttlMs = options.ttlMs;
+    if (options.maxEntries != null)
+        maxEntries = options.maxEntries;
+    if (options.effectivePlanKeyResolver !== undefined) {
+        resolveEffective = options.effectivePlanKeyResolver ?? ((planKey) => planKey);
+    }
+};
+/**
+ * Drops every cached plan-key entry. Intended for tests and graceful
+ * shutdown — production code should not need to call this.
+ */
+export const clearPlanCache = () => {
+    cache.clear();
+};
+/**
+ * Returns the number of currently cached entries. Mainly useful for tests
+ * and operational metrics.
+ *
+ * @returns Current cache size.
+ */
+export const planCacheSize = () => {
+    return cache.size;
+};
+/**
+ * Resolve the effective plan key for a user, hitting the cache on warm reads
+ * and falling back to a DB lookup on cache miss.
+ *
+ * The effective plan key:
+ * - Returns `'anonymous'` for users flagged as anonymous, regardless of stored plan.
+ * - Returns `null` for users whose `planExpiresAt` is in the past — callers
+ *   should treat this as the default tier.
+ * - Returns the stored plan key otherwise (or `null` if none was stored).
+ *
+ * @param userId - The user ID to look up.
+ * @returns The effective plan key, or `null` for default-tier users.
+ */
+export const getCachedPlanKey = async (userId) => {
+    return (await getCachedPlanState(userId)).planKey;
+};
+/**
+ * Resolve a user's effective plan key AND the plan expiry it was derived from,
+ * hitting the same cache {@link getCachedPlanKey} uses.
+ *
+ * Exists because the expiry is already read on every cache miss: a consumer
+ * that needs the subscription's period boundary — an allowance that refreshes
+ * with the billing period, a renewal countdown — can have it for free instead
+ * of issuing its own per-request user lookup, which is precisely the database
+ * load this cache was introduced to remove.
+ *
+ * `planExpiresAt` is the STORED value, not an effective one: it is `null` for
+ * anonymous/free users and may be in the past for a plan that has just lapsed
+ * (in which case `planKey` is already demoted to `null`).
+ *
+ * @param userId - The user ID to look up.
+ * @returns The effective plan key and the stored plan expiry.
+ */
+export const getCachedPlanState = async (userId) => {
+    const now = Date.now();
+    const cached = cache.get(userId);
+    if (cached && cached.expiresAt > now) {
+        return { planKey: cached.planKey, planExpiresAt: cached.planExpiresAt };
+    }
+    const user = await findById('users', userId);
+    let planKey;
+    if (user?.isAnonymous) {
+        planKey = 'anonymous';
+    }
+    else {
+        planKey = user?.planKey ?? null;
+        if (planKey && user?.planExpiresAt) {
+            const expiresAt = new Date(user.planExpiresAt).getTime();
+            if (Number.isFinite(expiresAt) && expiresAt < now) {
+                planKey = null;
+            }
+        }
+        // Apply the app-specific effective-plan-key demotion (identity by default).
+        // Reuses the app's own `resolveEffectivePlanKey` so the hot path and the
+        // app cannot diverge — e.g. an `apple*`/`google*` IAP key with NO expiry is
+        // unverified and demotes to free here, exactly as it does off the hot path.
+        // (Anonymous keeps its 'anonymous' key — the resolver only sees real plans.)
+        planKey = resolveEffective(planKey, user?.planExpiresAt ?? null);
+    }
+    if (cache.size >= maxEntries) {
+        const firstKey = cache.keys().next().value;
+        if (firstKey != null)
+            cache.delete(firstKey);
+    }
+    // [C6-1] Cap the cache entry at the plan's actual expiry, not just the flat TTL: without
+    // this, a paid plan that lapses inside a warm window keeps returning the elevated planKey
+    // (and its higher tier limits) for up to a full TTL after the subscription ended — there
+    // is no event-based invalidation at the expiry instant. A finite future planExpiresAt is a
+    // deterministic demotion time; clamp to it so the cache demotes exactly when the plan
+    // lapses. (Lapsed plans already resolved to null above; anonymous/no-expiry keep the TTL.)
+    let expiresAt = now + ttlMs;
+    if (planKey && planKey !== 'anonymous' && user?.planExpiresAt) {
+        const planExpiry = new Date(user.planExpiresAt).getTime();
+        if (Number.isFinite(planExpiry) && planExpiry > now) {
+            expiresAt = Math.min(expiresAt, planExpiry);
+        }
+    }
+    const planExpiresAt = user?.planExpiresAt ?? null;
+    cache.set(userId, { planKey, expiresAt, planExpiresAt });
+    return { planKey, planExpiresAt };
+};
+/**
+ * Invalidate a single user's cached plan-key entry. Call this immediately
+ * after writing a new `planKey` / `planExpiresAt` to the user record (e.g.
+ * from a webhook handler) so the next request reflects the change without
+ * waiting out the TTL.
+ *
+ * @param userId - The user ID whose cache entry should be evicted.
+ */
+export const invalidateCachedPlanKey = (userId) => {
+    cache.delete(userId);
+};
+/**
+ * Sweep expired entries from the cache. Safe to call from a recurring
+ * cleanup interval; idempotent and O(n) in cache size.
+ */
+export const sweepExpiredPlanCacheEntries = () => {
+    const now = Date.now();
+    for (const [key, entry] of cache) {
+        if (entry.expiresAt <= now)
+            cache.delete(key);
+    }
+};
+//# sourceMappingURL=cache.js.map

package/dist/cache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.js","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAIjD,MAAM,cAAc,GAAG,OAAO,CAAA,CAAC,YAAY;AAC3C,MAAM,mBAAmB,GAAG,MAAM,CAAA;AAElC,IAAI,KAAK,GAAG,cAAc,CAAA;AAC1B,IAAI,UAAU,GAAG,mBAAmB,CAAA;AAEpC;;;;;GAKG;AACH,IAAI,gBAAgB,GAA6B,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAA;AAErE,MAAM,KAAK,GAAG,IAAI,GAAG,EAA0B,CAAA;AA6C/C;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC,UAA4B,EAAE,EAAQ,EAAE;IACzE,IAAI,OAAO,CAAC,KAAK,IAAI,IAAI;QAAE,KAAK,GAAG,OAAO,CAAC,KAAK,CAAA;IAChD,IAAI,OAAO,CAAC,UAAU,IAAI,IAAI;QAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAA;IAC/D,IAAI,OAAO,CAAC,wBAAwB,KAAK,SAAS,EAAE,CAAC;QACnD,gBAAgB,GAAG,OAAO,CAAC,wBAAwB,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,CAAA;IAC/E,CAAC;AACH,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,cAAc,GAAG,GAAS,EAAE;IACvC,KAAK,CAAC,KAAK,EAAE,CAAA;AACf,CAAC,CAAA;AAED;;;;;GAKG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,GAAW,EAAE;IACxC,OAAO,KAAK,CAAC,IAAI,CAAA;AACnB,CAAC,CAAA;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,EAAE,MAAc,EAA0B,EAAE;IAC/E,OAAO,CAAC,MAAM,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAA;AACnD,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,KAAK,EACrC,MAAc,EACqD,EAAE;IACrE,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;IACtB,MAAM,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAA;IAEhC,IAAI,MAAM,IAAI,MAAM,CAAC,SAAS,GAAG,GAAG,EAAE,CAAC;QACrC,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,aAAa,EAAE,MAAM,CAAC,aAAa,EAAE,CAAA;IACzE,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAiB,OAAO,EAAE,MAAM,CAAC,CAAA;IAE5D,IAAI,OAAsB,CAAA;IAC1B,IAAI,IAAI,EAAE,WAAW,EAAE,CAAC;QACtB,OAAO,GAAG,WAAW,CAAA;IACvB,CAAC;SAAM,CAAC;QACN,OAAO,GAAG,IAAI,EAAE,OAAO,IAAI,IAAI,CAAA;QAC/B,IAAI,OAAO,IAAI,IAAI,EAAE,aAAa,EAAE,CAAC;YACnC,MAAM,SAAS,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,EAAE,CAAA;YACxD,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC,IAAI,SAAS,GAAG,GAAG,EAAE,CAAC;gBAClD,OAAO,GAAG,IAAI,CAAA;YAChB,CAAC;QACH,CAAC;QACD,4EAA4E;QAC5E,yEAAyE;QACzE,4EAA4E;QAC5E,4EAA4E;QAC5E,6EAA6E;QAC7E,OAAO,GAAG,gBAAgB,CAAC,OAAO,EAAE,IAAI,EAAE,aAAa,IAAI,IAAI,CAAC,CAAA;IAClE,CAAC;IAED,IAAI,KAAK,CAAC,IAAI,IAAI,UAAU,EAAE,CAAC;QAC7B,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,CAAA;QAC1C,IAAI,QAAQ,IAAI,IAAI;YAAE,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;IAC9C,CAAC;IACD,yFAAyF;IACzF,0FAA0F;IAC1F,yFAAyF;IACzF,2FAA2F;IAC3F,sFAAsF;IACtF,2FAA2F;IAC3F,IAAI,SAAS,GAAG,GAAG,GAAG,KAAK,CAAA;IAC3B,IAAI,OAAO,IAAI,OAAO,KAAK,WAAW,IAAI,IAAI,EAAE,aAAa,EAAE,CAAC;QAC9D,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,OAAO,EAAE,CAAA;QACzD,IAAI,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,UAAU,GAAG,GAAG,EAAE,CAAC;YACpD,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,UAAU,CAAC,CAAA;QAC7C,CAAC;IACH,CAAC;IACD,MAAM,aAAa,GAAG,IAAI,EAAE,aAAa,IAAI,IAAI,CAAA;IACjD,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAA;IAExD,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,CAAA;AACnC,CAAC,CAAA;AAED;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,MAAc,EAAQ,EAAE;IAC9D,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;AACtB,CAAC,CAAA;AAED;;;GAGG;AACH,MAAM,CAAC,MAAM,4BAA4B,GAAG,GAAS,EAAE;IACrD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;IACtB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,KAAK,EAAE,CAAC;QACjC,IAAI,KAAK,CAAC,SAAS,IAAI,GAAG;YAAE,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAA;IAC/C,CAAC;AACH,CAAC,CAAA"}

package/dist/error.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Structured limit-error helpers.
+ *
+ * When a tier limit is exceeded, handlers and middleware return a
+ * `LimitErrorPayload` so the client can render a typed upgrade prompt
+ * (current tier, current limit, next tier, upgraded limit, upgrade vs signup).
+ *
+ * @module
+ */
+import type { LimitErrorPayload, LimitType } from './types.js';
+/** Options for building a limit error payload. */
+export interface BuildLimitErrorOptions<TLimits = unknown> {
+    /** Identifier for the limit that was hit (e.g. `'maxProjects'`). */
+    limitType: LimitType;
+    /** The current user's tier category (e.g. `'free'`, `'anonymous'`). */
+    category: string;
+    /** The numeric limit that was exceeded. */
+    currentLimit: number;
+    /**
+     * Optional accessor that maps the next-up tier's `limits` to the relevant
+     * numeric value. When omitted, `upgradedLimit` is `null` and the upgrade
+     * prompt simply names the next tier without a number.
+     */
+    resolveUpgradedLimit?: (nextLimits: TLimits) => number | null | undefined;
+    /** Seconds until the client should retry, when applicable. */
+    retryAfter?: number;
+    /** Optional override for the localized error message. */
+    message?: string;
+}
+/**
+ * Build a `LimitErrorPayload` describing a tier-limit violation.
+ *
+ * Reads the bonded entitlements registry to resolve the next-up category and
+ * (optionally) the upgraded limit value. Anonymous users are flagged with
+ * `requiresSignup: true` so the client can offer a sign-up prompt rather than
+ * an upgrade prompt.
+ *
+ * @param options - The limit type, current tier category, current limit, and
+ *   optional upgrade-limit resolver / retry-after / message override.
+ * @returns A structured payload safe to send as a 429 / 403 response body.
+ */
+export declare const buildLimitError: <TLimits = unknown>(options: BuildLimitErrorOptions<TLimits>) => LimitErrorPayload;
+//# sourceMappingURL=error.d.ts.map

package/dist/error.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAKH,OAAO,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,YAAY,CAAA;AAE9D,kDAAkD;AAClD,MAAM,WAAW,sBAAsB,CAAC,OAAO,GAAG,OAAO;IACvD,oEAAoE;IACpE,SAAS,EAAE,SAAS,CAAA;IAEpB,uEAAuE;IACvE,QAAQ,EAAE,MAAM,CAAA;IAEhB,2CAA2C;IAC3C,YAAY,EAAE,MAAM,CAAA;IAEpB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,CAAC,UAAU,EAAE,OAAO,KAAK,MAAM,GAAG,IAAI,GAAG,SAAS,CAAA;IAEzE,8DAA8D;IAC9D,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB,yDAAyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,GAAI,OAAO,GAAG,OAAO,EAC/C,SAAS,sBAAsB,CAAC,OAAO,CAAC,KACvC,iBAsCF,CAAA"}

package/dist/error.js

@@ -0,0 +1,55 @@
+/**
+ * Structured limit-error helpers.
+ *
+ * When a tier limit is exceeded, handlers and middleware return a
+ * `LimitErrorPayload` so the client can render a typed upgrade prompt
+ * (current tier, current limit, next tier, upgraded limit, upgrade vs signup).
+ *
+ * @module
+ */
+import { t } from '@molecule/api-i18n';
+import { getProvider } from './provider.js';
+/**
+ * Build a `LimitErrorPayload` describing a tier-limit violation.
+ *
+ * Reads the bonded entitlements registry to resolve the next-up category and
+ * (optionally) the upgraded limit value. Anonymous users are flagged with
+ * `requiresSignup: true` so the client can offer a sign-up prompt rather than
+ * an upgrade prompt.
+ *
+ * @param options - The limit type, current tier category, current limit, and
+ *   optional upgrade-limit resolver / retry-after / message override.
+ * @returns A structured payload safe to send as a 429 / 403 response body.
+ */
+export const buildLimitError = (options) => {
+    const { limitType, category, currentLimit, resolveUpgradedLimit, retryAfter, message } = options;
+    const registry = getProvider();
+    const nextCategory = registry.getNextCategory(category);
+    const requiresSignup = category === 'anonymous';
+    let upgradedLimit = null;
+    if (nextCategory && resolveUpgradedLimit) {
+        const nextTier = registry.getAllTiers().find((tier) => tier.category === nextCategory);
+        if (nextTier) {
+            const value = resolveUpgradedLimit(nextTier.limits);
+            if (typeof value === 'number')
+                upgradedLimit = value;
+        }
+    }
+    const localizedMessage = message ??
+        t('entitlements.error.limitExceeded', { limitType, currentLimit, currentTier: category }, {
+            defaultValue: requiresSignup
+                ? `Limit reached (${currentLimit}). Create a free account for more.`
+                : `Limit reached (${currentLimit}). Upgrade your plan for more.`,
+        });
+    return {
+        error: localizedMessage,
+        limitType,
+        currentLimit,
+        upgradedLimit,
+        currentTier: category,
+        upgradeTier: nextCategory,
+        requiresSignup,
+        ...(retryAfter != null ? { retryAfter } : {}),
+    };
+};
+//# sourceMappingURL=error.js.map

package/dist/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../src/error.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,oBAAoB,CAAA;AAEtC,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAA;AA4B3C;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,eAAe,GAAG,CAC7B,OAAwC,EACrB,EAAE;IACrB,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,YAAY,EAAE,oBAAoB,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAA;IAEhG,MAAM,QAAQ,GAAG,WAAW,EAAW,CAAA;IACvC,MAAM,YAAY,GAAG,QAAQ,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAA;IACvD,MAAM,cAAc,GAAG,QAAQ,KAAK,WAAW,CAAA;IAE/C,IAAI,aAAa,GAAkB,IAAI,CAAA;IACvC,IAAI,YAAY,IAAI,oBAAoB,EAAE,CAAC;QACzC,MAAM,QAAQ,GAAG,QAAQ,CAAC,WAAW,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,KAAK,YAAY,CAAC,CAAA;QACtF,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,KAAK,GAAG,oBAAoB,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAA;YACnD,IAAI,OAAO,KAAK,KAAK,QAAQ;gBAAE,aAAa,GAAG,KAAK,CAAA;QACtD,CAAC;IACH,CAAC;IAED,MAAM,gBAAgB,GACpB,OAAO;QACP,CAAC,CACC,kCAAkC,EAClC,EAAE,SAAS,EAAE,YAAY,EAAE,WAAW,EAAE,QAAQ,EAAE,EAClD;YACE,YAAY,EAAE,cAAc;gBAC1B,CAAC,CAAC,kBAAkB,YAAY,oCAAoC;gBACpE,CAAC,CAAC,kBAAkB,YAAY,gCAAgC;SACnE,CACF,CAAA;IAEH,OAAO;QACL,KAAK,EAAE,gBAAgB;QACvB,SAAS;QACT,YAAY;QACZ,aAAa;QACb,WAAW,EAAE,QAAQ;QACrB,WAAW,EAAE,YAAY;QACzB,cAAc;QACd,GAAG,CAAC,UAAU,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;KAC9C,CAAA;AACH,CAAC,CAAA"}

package/dist/index.d.ts

@@ -0,0 +1,101 @@
+/**
+ * Tier-based entitlements core for molecule.dev.
+ *
+ * Provides the typed `Tier<TLimits>` / `TierRegistry<TLimits>` shapes, a
+ * per-process plan-key cache, and Express middleware factories that gate
+ * endpoints by tier category or quantitative limit.
+ *
+ * Apps declare their own `TLimits` shape, construct a registry via
+ * `defineTiers(...)`, and bond it via `setProvider(...)` at startup. The
+ * webhook glue that maps Stripe / Apple / Google subscription events to
+ * `users.planKey` already lives in `@molecule/api-resource-user`.
+ *
+ * @example
+ * ```typescript
+ * import { defineTiers, setProvider, enforceLimit, requireCategoryAtLeast } from '@molecule/api-entitlements'
+ * import { count } from '@molecule/api-database'
+ *
+ * interface BlogLimits {
+ *   maxPosts: number
+ *   maxCommentsPerDay: number
+ * }
+ *
+ * const registry = defineTiers<BlogLimits>({
+ *   tiers: {
+ *     free: { planKey: 'free', category: 'free', name: 'Free', limits: { maxPosts: 5, maxCommentsPerDay: 50 } },
+ *     stripeMonthly: { planKey: 'stripeMonthly', category: 'pro', name: 'Pro', limits: { maxPosts: 100, maxCommentsPerDay: 1000 } },
+ *   },
+ *   defaultPlanKey: 'free',
+ *   categoryOrder: ['free', 'pro'],
+ * })
+ *
+ * setProvider(registry)
+ *
+ * // Gate the API routes — the SERVER enforces tiers, never the UI alone:
+ * router.post('/posts',
+ *   enforceLimit<BlogLimits>({
+ *     limitType: 'maxPosts',
+ *     getLimit: (limits) => limits.maxPosts,
+ *     getCurrent: (userId) => count('posts', [{ field: 'userId', operator: '=', value: userId }]),
+ *   }),
+ *   handlers.createPost,
+ * )
+ * router.get('/analytics', requireCategoryAtLeast('pro'), handlers.analytics)
+ * ```
+ *
+ * @remarks
+ * - **Enforcement is middleware on the API route** (`requireCategory`,
+ *   `requireCategoryAtLeast`, `enforceLimit`) — hiding a button in the UI is
+ *   not entitlement enforcement. The middleware reads the authenticated user
+ *   from `res.locals.session.userId`, so it must be registered AFTER the auth
+ *   middleware; unauthenticated requests get a 401.
+ * - **`enforceLimit` blocks at `current >= limit`** and responds with a
+ *   structured `LimitErrorPayload` (default 403; pass `status: 429` for
+ *   usage-style limits) that the app's limit/upgrade notice renders — don't
+ *   swallow it into a generic error page.
+ * - **It is a SOFT ceiling — `getCurrent` COUNTS, then the handler CREATES the
+ *   resource afterwards.** Under concurrency N requests can all read the same
+ *   `current < limit` and all create, so the limit can be exceeded by a few.
+ *   That is fine for plan limits (max projects / seats / collaborators — a
+ *   bounded, harmless overshoot). It is NOT enough for a HARD limit where going
+ *   over is a real loss: money / wallet balances, physical inventory (stock,
+ *   tickets, seats), or metered credits. Enforce THOSE atomically at the write
+ *   with a conditional `UPDATE ... WHERE remaining >= $n RETURNING` that affects
+ *   0 rows when it wouldn't fit (or an advisory-lock reserve for a ledger SUM) —
+ *   never a count-then-allow middleware.
+ * - **Plan keys are cached per process** (default 5-minute TTL). The
+ *   resource-user payment webhook glue invalidates on plan change; any custom
+ *   path that mutates a user's `planKey` must call
+ *   `invalidateCachedPlanKey(userId)` or the old tier lingers until TTL.
+ * - Unknown, expired, or missing plan keys resolve to the `defaultPlanKey`
+ *   tier — make the default tier's limits the safe floor.
+ * - The middleware factories are connect/Express-shaped conveniences. Other
+ *   stacks (queues, websockets, non-Express frameworks) enforce the same tiers
+ *   directly via `getProvider()` + `getCachedPlanKey(userId)`.
+ *
+ * @e2e
+ * Integration checklist — drive the real UI (live preview, no mocks), adapt
+ * each item to this app's actual screens/flows, and check every box off one
+ * by one. A box you can't check is an integration bug to fix — not a skip:
+ * - [ ] The pricing/plans surface lists every tier with its name, price, and limits
+ *   (rendered from `/api/billing/tiers`, not hardcoded).
+ * - [ ] A free-tier user who hits a quantitative limit (e.g. creates the max
+ *   allowed items, then one more) gets a visible limit/upgrade notice — never a
+ *   silent failure, a blank page, or a raw 500.
+ * - [ ] The blocked action really is blocked server-side: after a full page reload
+ *   the over-limit item was NOT created.
+ * - [ ] A higher-tier user (seed or upgrade one) can perform the same action that
+ *   was blocked on the free tier.
+ * - [ ] Tier-gated features/sections are hidden or clearly locked for tiers that
+ *   lack them, and usable for tiers that have them.
+ *
+ * @module
+ */
+export * from './browser-guard.js';
+export * from './cache.js';
+export * from './error.js';
+export * from './middleware.js';
+export * from './provider.js';
+export * from './registry.js';
+export * from './types.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4FG;AAEH,cAAc,oBAAoB,CAAA;AAClC,cAAc,YAAY,CAAA;AAC1B,cAAc,YAAY,CAAA;AAC1B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA;AAC7B,cAAc,YAAY,CAAA"}