@i4e/invest4edu-access-core 0.30.0 → 0.32.0

package/src/entitlement-schema.js

@@ -1,194 +1,194 @@
-/**
- * Entitlement / subscription schema DEFINITIONS — @i4e/invest4edu-access-core (P6).
- *
- * Plain objects like access-schema.js (D4: no Mongoose in the package). Each backend registers its
- * own models from these, so field names cannot drift between v1 and v2.
- *
- * RBAC answers "may they?"; entitlement answers "is it unlocked, and are they in quota?". Both must
- * pass. See TDD §6, and §6.2a for the 2026-07-29 amendment that generalised quota period + subject
- * and added the service-facing meter.
- *
- * Design: nfd-ui-nextjs/IV-CodingAgent/specs/access-management/TDD-unified-access-and-subscription.md
- */
-
-/** How often a quota allowance resets. Carried in the period key, so no cron is needed. */
-export const PERIOD_GRANULARITIES = Object.freeze(["day", "month", "year", "term", "lifetime"]);
-
-/** Whose allowance is being spent. `account` = per firm (the legacy assumption); `user` = per seat. */
-export const QUOTA_SCOPES = Object.freeze(["account", "user"]);
-
-/** What happens when the allowance runs out. */
-export const OVERAGE_POLICIES = Object.freeze(["block", "single_usage", "unlimited"]);
-
-export const SUBSCRIPTION_STATUSES = Object.freeze([
-  "trialing", "active", "past_due", "blocked", "cancelled", "expired",
-]);
-
-/**
- * The timezone every calendar boundary is evaluated in.
- *
- * A daily quota is meaningless without one: in UTC an Indian partner's "10 a day" would reset at
- * 05:30 local, so they would lose the tail of every working day. Matches the `tz` the MIS pipelines
- * already use.
- */
-export const QUOTA_TIMEZONE = "Asia/Kolkata";
-
-/**
- * The synthetic feature that carries a credits-mode plan's allowance.
- *
- * Credits mode needed no new machinery precisely because the allowance is an ordinary
- * entitlement row on this code: it inherits cycle columns, effective-date versioning, trial
- * precedence, as-of resolution and the race-free counter. A plan IS credits-mode when a row for
- * this code resolves — there is no separate flag to drift out of step with the data.
- */
-export const CREDITS_FEATURE_CODE = "SUBSCRIPTION.CREDITS";
-
-/** Reasons an entitlement decision can carry. Stable strings — they surface in APIs and logs. */
-export const ENTITLEMENT_REASONS = Object.freeze({
-  OK: "ok",
-  NO_SUBSCRIPTION: "no_subscription",
-  NOT_IN_PLAN: "not_in_plan",
-  LOCKED: "locked",
-  QUOTA_EXCEEDED: "quota_exceeded",
-  SUBSCRIPTION_BLOCKED: "subscription_blocked",
-  ADMIN_BYPASS: "admin_bypass",
-  NOT_METERED: "not_metered",
-  ENGINE_OFF: "engine_off",
-  RESOLVE_FAILED: "resolve_failed",
-});
-
-/** Global: the plans on sale. */
-export const PLAN_CATALOG_DEF = Object.freeze({
-  collection: "plan_catalog",
-  fields: Object.freeze({
-    plan_code: { type: "String", required: true, unique: true, index: true, immutable: true },
-    name: { type: "String", required: true },
-    description: { type: "String" },
-    billing_cycle: { type: "String", enum: ["monthly", "quarterly", "annual"], default: "annual" },
-    price: { type: "Number", default: 0 },
-    currency: { type: "String", default: "INR" },
-    position: { type: "Number", default: 0 },
-    status: { type: "String", enum: ["active", "dormant", "retired"], default: "active" },
-  }),
-});
-
-/**
- * Global: `(plan, cycle, feature)` → what that plan grants for that feature.
- *
- * VERSIONED by `effective_date`: resolve the row with the greatest `effective_date <= now`. Prices
- * and quotas change, and a past invoice must remain explicable — so rows are superseded, never
- * edited in place.
- */
-export const PLAN_ENTITLEMENT_DEF = Object.freeze({
-  collection: "plan_entitlements",
-  fields: Object.freeze({
-    plan_code: { type: "String", required: true, index: true },
-    billing_cycle: { type: "String", required: true },
-    feature_code: { type: "String", required: true, index: true },
-
-    unlocked: { type: "Boolean", default: true },
-    // null = unlimited. 0 is a real value: "in the plan, but no allowance".
-    quota: { type: "Number", default: null },
-    period_granularity: { type: "String", enum: PERIOD_GRANULARITIES, default: "month" },
-    quota_scope: { type: "String", enum: QUOTA_SCOPES, default: "account" },
-    overage_policy: { type: "String", enum: OVERAGE_POLICIES, default: "block" },
-    single_usage_price: { type: "Number", default: null },
-
-    effective_date: { type: "Date", required: true, index: true },
-    superseded_date: { type: "Date", default: null },
-  }),
-  indexes: Object.freeze([
-    { keys: { plan_code: 1, billing_cycle: 1, feature_code: 1, effective_date: -1 } },
-  ]),
-});
-
-/** Tenant: one subscription per firm. Replaces AccountPlan + distributor.selected_plan. */
-export const ACCOUNT_SUBSCRIPTION_DEF = Object.freeze({
-  collection: "account_subscriptions",
-  fields: Object.freeze({
-    account_id: { type: "ObjectId", required: true, index: true },
-    plan_code: { type: "String", required: true },
-    billing_cycle: { type: "String", required: true },
-    status: { type: "String", enum: SUBSCRIPTION_STATUSES, default: "trialing", index: true },
-    start_date: { type: "Date", required: true },
-    end_date: { type: "Date", default: null },
-    is_trial: { type: "Boolean", default: false },
-    trial_ends_at: { type: "Date", default: null },
-    // Per-firm overrides of the plan row: [{ feature_code, quota, unlocked, … }]. Sales concessions
-    // belong here, NOT as an edit to the shared plan row.
-    entitlement_overrides: { type: "[Mixed]", default: [] },
-  }),
-});
-
-/**
- * Tenant: the quota counters. MUST live in the app DB — `consume` has to be atomic with the read,
- * so this cannot be a side/analytics store.
- *
- * `subject_key` is the account id or the user id depending on `quota_scope`, so one collection
- * serves both without a second shape.
- */
-export const SUBSCRIPTION_USAGE_DEF = Object.freeze({
-  collection: "subscription_usage",
-  fields: Object.freeze({
-    subscription_id: { type: "ObjectId", required: true, index: true },
-    subject_key: { type: "String", required: true },
-    feature_code: { type: "String", required: true },
-    period: { type: "String", required: true },
-    used: { type: "Number", default: 0 },
-    last_consumed_at: { type: "Date", default: null },
-  }),
-  indexes: Object.freeze([
-    { keys: { subscription_id: 1, subject_key: 1, feature_code: 1, period: 1 }, options: { unique: true } },
-  ]),
-});
-
-/**
- * Tenant: the exactly-once ledger for `consume`.
- *
- * A tool that times out and retries must not charge the partner twice, so every consume carries an
- * idempotency key and the unique index — not application logic — is what enforces it.
- */
-export const USAGE_IDEMPOTENCY_DEF = Object.freeze({
-  collection: "usage_idempotency",
-  fields: Object.freeze({
-    idempotency_key: { type: "String", required: true, unique: true, index: true },
-    account_id: { type: "ObjectId", index: true },
-    feature_code: { type: "String", required: true },
-    subject_key: { type: "String" },
-    period: { type: "String" },
-    n: { type: "Number", default: 1 },
-    // The decision returned the first time, replayed verbatim on a duplicate key.
-    result: { type: "Mixed", default: null },
-    created_date: { type: "Date", default: "now" },
-  }),
-});
-
-/** Global: the service callers allowed to meter, and which features each may meter. */
-export const METER_CLIENT_DEF = Object.freeze({
-  collection: "meter_clients",
-  fields: Object.freeze({
-    client_code: { type: "String", required: true, unique: true, index: true },
-    name: { type: "String", required: true },
-    // Key Vault SECRET NAME, never the secret. An admin API must never be able to read it back.
-    key_vault_ref: { type: "String", required: true },
-    // A tool may only meter what it is registered for — a leaked NFD-AI key cannot spend PFA quota.
-    allowed_features: { type: "[String]", default: [] },
-    status: { type: "String", enum: ["active", "disabled"], default: "active" },
-  }),
-});
-
-export default {
-  PERIOD_GRANULARITIES,
-  CREDITS_FEATURE_CODE,
-  QUOTA_SCOPES,
-  OVERAGE_POLICIES,
-  SUBSCRIPTION_STATUSES,
-  QUOTA_TIMEZONE,
-  ENTITLEMENT_REASONS,
-  PLAN_CATALOG_DEF,
-  PLAN_ENTITLEMENT_DEF,
-  ACCOUNT_SUBSCRIPTION_DEF,
-  SUBSCRIPTION_USAGE_DEF,
-  USAGE_IDEMPOTENCY_DEF,
-  METER_CLIENT_DEF,
-};
+/**
+ * Entitlement / subscription schema DEFINITIONS — @i4e/invest4edu-access-core (P6).
+ *
+ * Plain objects like access-schema.js (D4: no Mongoose in the package). Each backend registers its
+ * own models from these, so field names cannot drift between v1 and v2.
+ *
+ * RBAC answers "may they?"; entitlement answers "is it unlocked, and are they in quota?". Both must
+ * pass. See TDD §6, and §6.2a for the 2026-07-29 amendment that generalised quota period + subject
+ * and added the service-facing meter.
+ *
+ * Design: nfd-ui-nextjs/IV-CodingAgent/specs/access-management/TDD-unified-access-and-subscription.md
+ */
+
+/** How often a quota allowance resets. Carried in the period key, so no cron is needed. */
+export const PERIOD_GRANULARITIES = Object.freeze(["day", "month", "year", "term", "lifetime"]);
+
+/** Whose allowance is being spent. `account` = per firm (the legacy assumption); `user` = per seat. */
+export const QUOTA_SCOPES = Object.freeze(["account", "user"]);
+
+/** What happens when the allowance runs out. */
+export const OVERAGE_POLICIES = Object.freeze(["block", "single_usage", "unlimited"]);
+
+export const SUBSCRIPTION_STATUSES = Object.freeze([
+  "trialing", "active", "past_due", "blocked", "cancelled", "expired",
+]);
+
+/**
+ * The timezone every calendar boundary is evaluated in.
+ *
+ * A daily quota is meaningless without one: in UTC an Indian partner's "10 a day" would reset at
+ * 05:30 local, so they would lose the tail of every working day. Matches the `tz` the MIS pipelines
+ * already use.
+ */
+export const QUOTA_TIMEZONE = "Asia/Kolkata";
+
+/**
+ * The synthetic feature that carries a credits-mode plan's allowance.
+ *
+ * Credits mode needed no new machinery precisely because the allowance is an ordinary
+ * entitlement row on this code: it inherits cycle columns, effective-date versioning, trial
+ * precedence, as-of resolution and the race-free counter. A plan IS credits-mode when a row for
+ * this code resolves — there is no separate flag to drift out of step with the data.
+ */
+export const CREDITS_FEATURE_CODE = "SUBSCRIPTION.CREDITS";
+
+/** Reasons an entitlement decision can carry. Stable strings — they surface in APIs and logs. */
+export const ENTITLEMENT_REASONS = Object.freeze({
+  OK: "ok",
+  NO_SUBSCRIPTION: "no_subscription",
+  NOT_IN_PLAN: "not_in_plan",
+  LOCKED: "locked",
+  QUOTA_EXCEEDED: "quota_exceeded",
+  SUBSCRIPTION_BLOCKED: "subscription_blocked",
+  ADMIN_BYPASS: "admin_bypass",
+  NOT_METERED: "not_metered",
+  ENGINE_OFF: "engine_off",
+  RESOLVE_FAILED: "resolve_failed",
+});
+
+/** Global: the plans on sale. */
+export const PLAN_CATALOG_DEF = Object.freeze({
+  collection: "plan_catalog",
+  fields: Object.freeze({
+    plan_code: { type: "String", required: true, unique: true, index: true, immutable: true },
+    name: { type: "String", required: true },
+    description: { type: "String" },
+    billing_cycle: { type: "String", enum: ["monthly", "quarterly", "annual"], default: "annual" },
+    price: { type: "Number", default: 0 },
+    currency: { type: "String", default: "INR" },
+    position: { type: "Number", default: 0 },
+    status: { type: "String", enum: ["active", "dormant", "retired"], default: "active" },
+  }),
+});
+
+/**
+ * Global: `(plan, cycle, feature)` → what that plan grants for that feature.
+ *
+ * VERSIONED by `effective_date`: resolve the row with the greatest `effective_date <= now`. Prices
+ * and quotas change, and a past invoice must remain explicable — so rows are superseded, never
+ * edited in place.
+ */
+export const PLAN_ENTITLEMENT_DEF = Object.freeze({
+  collection: "plan_entitlements",
+  fields: Object.freeze({
+    plan_code: { type: "String", required: true, index: true },
+    billing_cycle: { type: "String", required: true },
+    feature_code: { type: "String", required: true, index: true },
+
+    unlocked: { type: "Boolean", default: true },
+    // null = unlimited. 0 is a real value: "in the plan, but no allowance".
+    quota: { type: "Number", default: null },
+    period_granularity: { type: "String", enum: PERIOD_GRANULARITIES, default: "month" },
+    quota_scope: { type: "String", enum: QUOTA_SCOPES, default: "account" },
+    overage_policy: { type: "String", enum: OVERAGE_POLICIES, default: "block" },
+    single_usage_price: { type: "Number", default: null },
+
+    effective_date: { type: "Date", required: true, index: true },
+    superseded_date: { type: "Date", default: null },
+  }),
+  indexes: Object.freeze([
+    { keys: { plan_code: 1, billing_cycle: 1, feature_code: 1, effective_date: -1 } },
+  ]),
+});
+
+/** Tenant: one subscription per firm. Replaces AccountPlan + distributor.selected_plan. */
+export const ACCOUNT_SUBSCRIPTION_DEF = Object.freeze({
+  collection: "account_subscriptions",
+  fields: Object.freeze({
+    account_id: { type: "ObjectId", required: true, index: true },
+    plan_code: { type: "String", required: true },
+    billing_cycle: { type: "String", required: true },
+    status: { type: "String", enum: SUBSCRIPTION_STATUSES, default: "trialing", index: true },
+    start_date: { type: "Date", required: true },
+    end_date: { type: "Date", default: null },
+    is_trial: { type: "Boolean", default: false },
+    trial_ends_at: { type: "Date", default: null },
+    // Per-firm overrides of the plan row: [{ feature_code, quota, unlocked, … }]. Sales concessions
+    // belong here, NOT as an edit to the shared plan row.
+    entitlement_overrides: { type: "[Mixed]", default: [] },
+  }),
+});
+
+/**
+ * Tenant: the quota counters. MUST live in the app DB — `consume` has to be atomic with the read,
+ * so this cannot be a side/analytics store.
+ *
+ * `subject_key` is the account id or the user id depending on `quota_scope`, so one collection
+ * serves both without a second shape.
+ */
+export const SUBSCRIPTION_USAGE_DEF = Object.freeze({
+  collection: "subscription_usage",
+  fields: Object.freeze({
+    subscription_id: { type: "ObjectId", required: true, index: true },
+    subject_key: { type: "String", required: true },
+    feature_code: { type: "String", required: true },
+    period: { type: "String", required: true },
+    used: { type: "Number", default: 0 },
+    last_consumed_at: { type: "Date", default: null },
+  }),
+  indexes: Object.freeze([
+    { keys: { subscription_id: 1, subject_key: 1, feature_code: 1, period: 1 }, options: { unique: true } },
+  ]),
+});
+
+/**
+ * Tenant: the exactly-once ledger for `consume`.
+ *
+ * A tool that times out and retries must not charge the partner twice, so every consume carries an
+ * idempotency key and the unique index — not application logic — is what enforces it.
+ */
+export const USAGE_IDEMPOTENCY_DEF = Object.freeze({
+  collection: "usage_idempotency",
+  fields: Object.freeze({
+    idempotency_key: { type: "String", required: true, unique: true, index: true },
+    account_id: { type: "ObjectId", index: true },
+    feature_code: { type: "String", required: true },
+    subject_key: { type: "String" },
+    period: { type: "String" },
+    n: { type: "Number", default: 1 },
+    // The decision returned the first time, replayed verbatim on a duplicate key.
+    result: { type: "Mixed", default: null },
+    created_date: { type: "Date", default: "now" },
+  }),
+});
+
+/** Global: the service callers allowed to meter, and which features each may meter. */
+export const METER_CLIENT_DEF = Object.freeze({
+  collection: "meter_clients",
+  fields: Object.freeze({
+    client_code: { type: "String", required: true, unique: true, index: true },
+    name: { type: "String", required: true },
+    // Key Vault SECRET NAME, never the secret. An admin API must never be able to read it back.
+    key_vault_ref: { type: "String", required: true },
+    // A tool may only meter what it is registered for — a leaked NFD-AI key cannot spend PFA quota.
+    allowed_features: { type: "[String]", default: [] },
+    status: { type: "String", enum: ["active", "disabled"], default: "active" },
+  }),
+});
+
+export default {
+  PERIOD_GRANULARITIES,
+  CREDITS_FEATURE_CODE,
+  QUOTA_SCOPES,
+  OVERAGE_POLICIES,
+  SUBSCRIPTION_STATUSES,
+  QUOTA_TIMEZONE,
+  ENTITLEMENT_REASONS,
+  PLAN_CATALOG_DEF,
+  PLAN_ENTITLEMENT_DEF,
+  ACCOUNT_SUBSCRIPTION_DEF,
+  SUBSCRIPTION_USAGE_DEF,
+  USAGE_IDEMPOTENCY_DEF,
+  METER_CLIENT_DEF,
+};

package/src/entitlement-store.d.ts

@@ -1,99 +1,99 @@
-/**
- * Type declarations for the entitlement store.
- *
- * The package is plain JavaScript with JSDoc, which is fine for the Node services. NFD AI is
- * TypeScript, and without declarations every call through this module widens to `any` — which
- * silently removes the type checking from the one place in the codebase that decides whether a
- * customer is over quota. Declaring it here rather than in the consumer keeps one definition:
- * a copy in each TypeScript service would be a second description of this contract, free to drift
- * from the implementation without anything failing.
- */
-
-export interface EntitlementResult {
-  /** False only on a deliberate refusal — never on an infrastructure failure. */
-  allowed: boolean;
-  unlocked: boolean;
-  /** True when this feature is counted; consume() is a no-op otherwise. */
-  metered: boolean;
-  quota: number | null;
-  used: number;
-  /** Plan allowance left PLUS unspent à-la-carte credits. */
-  remaining: number | null;
-  /** Unspent à-la-carte units bought for this subject and feature. */
-  credits?: number;
-  /** True when the plan allowance is gone and the next call spends a purchased credit. */
-  usingCredit?: boolean;
-  overage_policy: string;
-  reason?: string;
-  period?: string | null;
-  subject_key?: string | null;
-  /** Carried so consume() counts against the exact bucket that was just checked. */
-  carriedSubscriptionId?: unknown;
-  carriedSubjectType?: string;
-  carriedSubjectId?: string;
-  carriedPeriodStart?: Date | string | null;
-  carriedIdentity?: { accountId?: string | null; userId?: string | null };
-  carriedRow?: Record<string, unknown> | null;
-}
-
-export interface ConsumeResult {
-  consumed: boolean;
-  /** The unit came out of a purchased credit rather than the plan's period counter. */
-  fromCredit?: boolean;
-  /** "not_metered" | "quota_exceeded" | "error" */
-  reason?: string;
-}
-
-export interface EntitlementStore {
-  findSubscription(args: {
-    subjectType: string;
-    subjectId: string;
-  }): Promise<Record<string, unknown> | null>;
-
-  entitlementFor(args: {
-    subjectType: string;
-    subjectId: string;
-    featureCode: string;
-    feature?: Record<string, unknown>;
-    identity?: { accountId?: string | null; userId?: string | null };
-    bypass?: boolean;
-    now?: Date;
-  }): Promise<EntitlementResult>;
-
-  consume(args: {
-    entitlement?: EntitlementResult;
-    featureCode: string;
-    n?: number;
-    now?: Date;
-    subscriptionId?: unknown;
-    row?: Record<string, unknown> | null;
-    identity?: { accountId?: string | null; userId?: string | null };
-    periodStart?: Date | string | null;
-  }): Promise<ConsumeResult>;
-
-  /** Idempotent; returns null when there is no default plan or the write failed. */
-  provisionDefault(args: {
-    subjectType: string;
-    subjectId: string;
-    accountId?: string | null;
-    now?: Date;
-  }): Promise<Record<string, unknown> | null>;
-}
-
-export function createEntitlementStore(opts: {
-  /**
-   * The subscription master switch. Returning false makes the whole store inert — every
-   * entitlement answers OPEN, nothing is counted and no subject is auto-provisioned — so the code
-   * can ship to production long before the product does. Defaults to the `SUBSCRIPTION_ENABLED`
-   * environment variable, and therefore to OFF.
-   */
-  isEnabled?: () => boolean | Promise<boolean>;
-  /** Returns a raw MongoDB `Db`, or null/undefined when the connection is not ready. */
-  getDb: () => unknown;
-  /** Cast an id the way the caller's driver expects. Defaults to pass-through. */
-  toObjectId?: (v: string) => unknown;
-  logger?: { warn: (msg: string) => void };
-}): EntitlementStore;
-
-declare const _default: { createEntitlementStore: typeof createEntitlementStore };
-export default _default;
+/**
+ * Type declarations for the entitlement store.
+ *
+ * The package is plain JavaScript with JSDoc, which is fine for the Node services. NFD AI is
+ * TypeScript, and without declarations every call through this module widens to `any` — which
+ * silently removes the type checking from the one place in the codebase that decides whether a
+ * customer is over quota. Declaring it here rather than in the consumer keeps one definition:
+ * a copy in each TypeScript service would be a second description of this contract, free to drift
+ * from the implementation without anything failing.
+ */
+
+export interface EntitlementResult {
+  /** False only on a deliberate refusal — never on an infrastructure failure. */
+  allowed: boolean;
+  unlocked: boolean;
+  /** True when this feature is counted; consume() is a no-op otherwise. */
+  metered: boolean;
+  quota: number | null;
+  used: number;
+  /** Plan allowance left PLUS unspent à-la-carte credits. */
+  remaining: number | null;
+  /** Unspent à-la-carte units bought for this subject and feature. */
+  credits?: number;
+  /** True when the plan allowance is gone and the next call spends a purchased credit. */
+  usingCredit?: boolean;
+  overage_policy: string;
+  reason?: string;
+  period?: string | null;
+  subject_key?: string | null;
+  /** Carried so consume() counts against the exact bucket that was just checked. */
+  carriedSubscriptionId?: unknown;
+  carriedSubjectType?: string;
+  carriedSubjectId?: string;
+  carriedPeriodStart?: Date | string | null;
+  carriedIdentity?: { accountId?: string | null; userId?: string | null };
+  carriedRow?: Record<string, unknown> | null;
+}
+
+export interface ConsumeResult {
+  consumed: boolean;
+  /** The unit came out of a purchased credit rather than the plan's period counter. */
+  fromCredit?: boolean;
+  /** "not_metered" | "quota_exceeded" | "error" */
+  reason?: string;
+}
+
+export interface EntitlementStore {
+  findSubscription(args: {
+    subjectType: string;
+    subjectId: string;
+  }): Promise<Record<string, unknown> | null>;
+
+  entitlementFor(args: {
+    subjectType: string;
+    subjectId: string;
+    featureCode: string;
+    feature?: Record<string, unknown>;
+    identity?: { accountId?: string | null; userId?: string | null };
+    bypass?: boolean;
+    now?: Date;
+  }): Promise<EntitlementResult>;
+
+  consume(args: {
+    entitlement?: EntitlementResult;
+    featureCode: string;
+    n?: number;
+    now?: Date;
+    subscriptionId?: unknown;
+    row?: Record<string, unknown> | null;
+    identity?: { accountId?: string | null; userId?: string | null };
+    periodStart?: Date | string | null;
+  }): Promise<ConsumeResult>;
+
+  /** Idempotent; returns null when there is no default plan or the write failed. */
+  provisionDefault(args: {
+    subjectType: string;
+    subjectId: string;
+    accountId?: string | null;
+    now?: Date;
+  }): Promise<Record<string, unknown> | null>;
+}
+
+export function createEntitlementStore(opts: {
+  /**
+   * The subscription master switch. Returning false makes the whole store inert — every
+   * entitlement answers OPEN, nothing is counted and no subject is auto-provisioned — so the code
+   * can ship to production long before the product does. Defaults to the `SUBSCRIPTION_ENABLED`
+   * environment variable, and therefore to OFF.
+   */
+  isEnabled?: () => boolean | Promise<boolean>;
+  /** Returns a raw MongoDB `Db`, or null/undefined when the connection is not ready. */
+  getDb: () => unknown;
+  /** Cast an id the way the caller's driver expects. Defaults to pass-through. */
+  toObjectId?: (v: string) => unknown;
+  logger?: { warn: (msg: string) => void };
+}): EntitlementStore;
+
+declare const _default: { createEntitlementStore: typeof createEntitlementStore };
+export default _default;