@saasicat/adapter-prisma 0.8.0 → 0.10.0

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { PersistenceInjectionToken, PasswordHasher, SaasicatPersistenceAdapter, TransactionRunner, TransactionContext, MfaPort, AuditPort, AdminActor, AuditQueryPort, AuditQuery, AuditEntry, AuditStatsPort, RlsBypassPort, SubscriptionRepository, SubscriptionRecord, SubscriptionBundleRepository, SubscriptionBundleRecord, CreateSubscriptionBundleData, CancelSubscriptionBundleData, TenantSubscriptionWritePort, ApplyOnboardingSelectionInput, RedeemPromoInTransactionCallback, ApplyOnboardingSelectionResult, ImmediatePlanChangeInput, ScheduledPlanChangeInput, PlanVersionRepository, PlanVersionRecord, PromoCodeRepository, PromoCodeRecord, PromoCodeFilter, CreatePromoCodeData, UpdatePromoCodeData, PromoCodeRedemptionRepository, PromoCodeRedemptionRecord, PromoCodeRedemptionStatus, PromoCodeRedemptionListItem, PromoCodeValidationLogRepository, PromoSubscriptionLookup, BillingCycle, PromoRevenueDeductionAggregator, SuperAdminProvisioningPort, CreateSuperAdminCliInput, PlatformUserDto, PlanCatalogReadSink, PlanCatalogReadSnapshot, PlanCatalogImportSink, UpsertPlanInput, UpsertResult, UpsertPlanVersionInput, UpsertFeatureCatalogEntryInput, PlanRepository, PlanListFilter, PlanRow, CreatePlanData, UpdatePlanData, PlanVersionRow, CreatePlanVersionDraftData, UpdatePlanVersionDraftData, VersionChange, BundleRepository, BundleVersionRow, BundleListFilter, BundleRow, CreateBundleData, UpdateBundleData, CreateBundleVersionDraftData, UpdateBundleVersionDraftData, CatalogEntryRepository, CatalogEntryFilter, CapabilityCatalogEntryRow, FeatureCatalogEntryRow, QuotaCatalogEntryRow, UpsertCapabilityEntryData, UpsertFeatureEntryData, UpsertQuotaEntryData, SetCatalogEntryReviewData, CatalogEntryI18n, UpdateCatalogEntryBaseData, MarketingProjectionRepository, MarketingProjectionFilter, MarketingProjectionRow, CreateMarketingProjectionData, UpdateMarketingProjectionData, MarketingSettingsRepository, MarketingSettingsRow, UpdateMarketingSettingsData, PromotionRepository, PromotionFilter, PromotionRow, CreatePromotionData, UpdatePromotionData, SubscriptionContractRepository, SubscriptionContractFilter, SubscriptionContractRecord, CreateSubscriptionContractData, TerminateSubscriptionContractData } from '@saasicat/types';
+import { AdminResourcesPort, AdminTenantListFilter, AdminTenantListRow, AdminTenantDetail, AdminTenantStateResult, AdminUserListFilter, AdminUserListRow, AdminAuditListFilter, AuditEntry, AdminSubscriptionListRow, BundleRepository, TransactionContext, BundleVersionRow, BundleListFilter, BundleRow, CreateBundleData, UpdateBundleData, CreateBundleVersionDraftData, UpdateBundleVersionDraftData, VersionChange, PersistenceInjectionToken, PasswordHasher, SaasicatPersistenceAdapter, TransactionRunner, MfaPort, AuditPort, AdminActor, AuditQueryPort, AuditQuery, AuditStatsPort, RlsBypassPort, SubscriptionRepository, SubscriptionRecord, SubscriptionUsagePort, SubscriptionUsageRecord, SubscriptionBundleRepository, SubscriptionBundleRecord, CreateSubscriptionBundleData, CancelSubscriptionBundleData, TenantSubscriptionWritePort, ApplyOnboardingSelectionInput, RedeemPromoInTransactionCallback, ApplyOnboardingSelectionResult, ImmediatePlanChangeInput, ScheduledPlanChangeInput, PlanVersionRepository, PlanVersionRecord, PromoCodeRepository, PromoCodeRecord, PromoCodeFilter, CreatePromoCodeData, UpdatePromoCodeData, PromoCodeRedemptionRepository, PromoCodeRedemptionRecord, PromoCodeRedemptionStatus, PromoCodeRedemptionListItem, PromoCodeValidationLogRepository, PromoSubscriptionLookup, BillingCycle, PromoRevenueDeductionAggregator, SuperAdminProvisioningPort, CreateSuperAdminCliInput, PlatformUserDto, PlanCatalogReadSink, PlanCatalogReadSnapshot, PlanCatalogImportSink, UpsertPlanInput, UpsertResult, UpsertPlanVersionInput, UpsertFeatureCatalogEntryInput, PlanRepository, PlanListFilter, PlanRow, CreatePlanData, UpdatePlanData, PlanVersionRow, CreatePlanVersionDraftData, UpdatePlanVersionDraftData, CatalogEntryRepository, CatalogEntryFilter, CapabilityCatalogEntryRow, FeatureCatalogEntryRow, QuotaCatalogEntryRow, UpsertCapabilityEntryData, UpsertFeatureEntryData, UpsertQuotaEntryData, SetCatalogEntryReviewData, CatalogEntryI18n, UpdateCatalogEntryBaseData, MarketingProjectionRepository, MarketingProjectionFilter, MarketingProjectionRow, CreateMarketingProjectionData, UpdateMarketingProjectionData, MarketingSettingsRepository, MarketingSettingsRow, UpdateMarketingSettingsData, PromotionRepository, PromotionFilter, PromotionRow, CreatePromotionData, UpdatePromotionData, SubscriptionContractRepository, SubscriptionContractFilter, SubscriptionContractRecord, CreateSubscriptionContractData, TerminateSubscriptionContractData } from '@saasicat/types';
 
 declare const PRISMA_CLIENT_TOKEN: unique symbol;
 /** Prisma `Decimal` values arrive as objects with `toString()`; tests may use plain values. */
@@ -19,6 +19,17 @@ interface SubscriptionRowLike {
     planVersionId: string;
     pendingPlanVersionId: string | null;
     startedAt: Date | null;
+    /** Rich tenant-billing fields present in the canonical schema. */
+    trialEndsAt?: Date | null;
+    pilotEndsAt?: Date | null;
+    currentPeriodStart?: Date | null;
+    currentPeriodEnd?: Date | null;
+    pendingBillingCycle?: string | null;
+    pendingPlanVersionEffectiveAt?: Date | null;
+    pendingPlanVersionAccepted?: boolean;
+    pendingPlanVersionAcceptedAt?: Date | null;
+    packageSnapshot?: unknown | null;
+    checkoutOfferId?: string | null;
 }
 interface PlanVersionRowLike {
     id: string;
@@ -334,9 +345,21 @@ interface PromoCodeDelegateLike {
         };
         data: {
             status?: string;
+            valueType?: string;
+            value?: string;
+            durationType?: string;
+            durationValue?: number | null;
+            validFrom?: Date | null;
             description?: string | null;
             validUntil?: Date | null;
             maxRedemptions?: number | null;
+            appliesToPlans?: string[];
+            appliesToBilling?: string | null;
+            firstTimeCustomersOnly?: boolean;
+            minimumPlanAmountGross?: string | null;
+            allowZeroInvoice?: boolean;
+            campaignTag?: string | null;
+            revenueDeductionAccount?: string | null;
             deletedAt?: Date;
         };
     }): Promise<PromoCodeRowLike>;
@@ -450,7 +473,10 @@ interface AuditLogDelegateLike {
             entityId?: string;
             action?: string;
             actorTag?: string | {
-                startsWith: string;
+                startsWith?: string;
+                endsWith?: string;
+                contains?: string;
+                mode?: 'insensitive';
             };
             createdAt?: {
                 gte?: Date;
@@ -677,6 +703,117 @@ declare function createPrismaPlanBindingResolver(options?: PrismaPlanBindingOpti
 /** Resolves a configurable Prisma delegate and fails early on misspellings. */
 declare function getPrismaDelegate<Row>(client: unknown, delegateName: string): PrismaModelDelegateLike<Row>;
 
+interface PrismaAdminResourcesOptions {
+    /**
+     * Relation counters exposed on tenant rows and tenant details. The names
+     * must match relations on the app's Tenant model. Default: `['users']`.
+     */
+    tenantMetrics?: readonly string[];
+    listLimit?: number;
+}
+/**
+ * Convention-based adapter for the standard SuperAdmin resource pages.
+ *
+ * It expects the common Prisma delegate names `tenant`, `user`,
+ * `subscription` and `auditLog`, and the common scalar fields shown by the
+ * platform UI. Apps with a different schema implement `AdminResourcesPort`;
+ * they do not need to replace controllers or DTOs.
+ */
+declare class PrismaAdminResourcesAdapter implements AdminResourcesPort {
+    private readonly prisma;
+    private readonly metrics;
+    private readonly listLimit;
+    private readonly audit;
+    constructor(prisma: PrismaLike, options?: PrismaAdminResourcesOptions);
+    listTenants(filter: AdminTenantListFilter): Promise<AdminTenantListRow[]>;
+    getTenantDetail(slug: string): Promise<AdminTenantDetail | null>;
+    setTenantActive(slug: string, active: boolean, subscriptionStatus: string): Promise<AdminTenantStateResult | null>;
+    listUsers(filter: AdminUserListFilter): Promise<AdminUserListRow[]>;
+    listAudit(filter: AdminAuditListFilter): Promise<AuditEntry[]>;
+    listSubscriptions(): Promise<AdminSubscriptionListRow[]>;
+    private tenants;
+    private users;
+    private subscriptions;
+}
+
+/**
+ * Root-client shape accepted by this repository. Delegates and `$transaction`
+ * stay opaque at the injection boundary because generated Prisma delegates
+ * have schema-specific generic signatures; calls are narrowed locally to the
+ * exact Bundle operations below.
+ */
+interface BundlePrismaClient {
+    bundle: unknown;
+    bundleVersion: unknown;
+    $transaction: unknown;
+}
+/**
+ * Optional DI token for apps that register `PrismaBundleRepository` directly
+ * as a Nest provider. Factory users may pass the same options as the second
+ * constructor argument.
+ */
+declare const PRISMA_BUNDLE_REPOSITORY_OPTIONS: unique symbol;
+interface PrismaBundleRepositoryOptions {
+    /**
+     * Enables reads and writes of `BundleVersion.validFrom`/`validUntil`.
+     *
+     * Default `false` preserves compatibility with databases and Prisma
+     * clients generated from the 0.6 schema, where the columns do not exist.
+     */
+    validityWindows?: boolean;
+}
+/**
+ * `BundleRepository` against the canonical `bundles` + `bundle_versions`
+ * tables (SPEC_V2 §5 + §11.1 M3). Versioning mirrors `PlanVersion`: at most one
+ * draft (`publishedAt IS NULL`) per bundle, monotonically incrementing
+ * `version`, `supersededAt` marking the previous live version on publish.
+ *
+ * Validity-window support is opt-in via `{ validityWindows: true }`. The
+ * default deliberately does not select, read or write `validFrom`/
+ * `validUntil`, and therefore keeps working with the 0.6 schema. In the
+ * enabled mode the repository expects both nullable columns to exist.
+ *
+ * In validity-window mode `publishDraft` opens an internal transaction when
+ * the caller did not provide one. This makes superseding the predecessor,
+ * applying its auto-succession end date and publishing the draft atomic.
+ * Legacy mode retains the 0.6 transaction behavior unchanged.
+ */
+declare class PrismaBundleRepository implements BundleRepository {
+    private readonly prisma;
+    private readonly validityWindows;
+    /**
+     * Present only when validity-window mode is enabled. This mirrors the
+     * optional port capability and lets 0.6-schema consumers detect that an
+     * active-at-time lookup is unavailable.
+     */
+    readonly findActiveBundleVersion?: (bundleId: string, asOf?: Date, tx?: TransactionContext) => Promise<BundleVersionRow | null>;
+    constructor(prisma: BundlePrismaClient, options?: PrismaBundleRepositoryOptions);
+    private db;
+    private transaction;
+    list(filter: BundleListFilter): Promise<BundleRow[]>;
+    findById(bundleId: string): Promise<BundleRow | null>;
+    findByKey(projectKey: string, bundleKey: string): Promise<BundleRow | null>;
+    create(data: CreateBundleData): Promise<BundleRow>;
+    update(bundleId: string, data: UpdateBundleData): Promise<BundleRow>;
+    softDelete(bundleId: string): Promise<void>;
+    listVersions(bundleId: string): Promise<BundleVersionRow[]>;
+    findVersionById(versionId: string): Promise<BundleVersionRow | null>;
+    findCurrentDraft(bundleId: string): Promise<BundleVersionRow | null>;
+    findLatestLive(bundleId: string, tx?: TransactionContext): Promise<BundleVersionRow | null>;
+    private findActiveBundleVersionWithValidity;
+    createDraft(data: CreateBundleVersionDraftData): Promise<BundleVersionRow>;
+    updateDraft(versionId: string, data: UpdateBundleVersionDraftData): Promise<BundleVersionRow>;
+    publishDraft(versionId: string, publishMeta: {
+        publishedByUserId: string | null;
+        publishedChanges: VersionChange[];
+        nonRegressive: boolean;
+        validFrom: Date;
+        validUntil: Date | null;
+    }, tx?: TransactionContext): Promise<BundleVersionRow>;
+    private publishDraftWithValidity;
+    deleteDraft(versionId: string): Promise<void>;
+}
+
 interface PrismaPersistenceOptions {
     /**
      * The app's Prisma client: either its injection token (typically the
@@ -704,6 +841,22 @@ interface PrismaPersistenceOptions {
      * termination columns.
      */
     schema?: PrismaSchemaOptions;
+    /**
+     * Standard SuperAdmin Tenant/User/Audit/Subscription pages. Set `false`
+     * for schemas without conventional `tenant`/`user` delegates.
+     */
+    adminResources?: false | PrismaAdminResourcesOptions;
+    /**
+     * Options for the bundle repository the catalog and entitlement slices
+     * share — notably `{ validityWindows: true }` for schemas that carry
+     * `BundleVersion.validFrom`/`validUntil`.
+     *
+     * Without this the bundle builds the repository with its 0.6-compatible
+     * defaults, and the repository's `@Optional() @Inject(...)` options
+     * provider never applies, because the bundle constructs the instance
+     * directly rather than through Nest DI.
+     */
+    bundle?: PrismaBundleRepositoryOptions;
 }
 /**
  * Builds the `SaasicatPersistenceAdapter` bundle for Prisma + PostgreSQL on
@@ -716,14 +869,9 @@ interface PrismaPersistenceOptions {
  * });
  * ```
  *
- * This bundle covers the core/entitlement/promo/plan-catalog slices consumed
- * by `SaasPlatformModule`. The catalog plane (CatalogModule) and the V3
- * contract loop take their repositories directly as `forRoot` options — wire
- * the standalone `PrismaPlanRepository` / `PrismaBundleRepository` /
- * `PrismaCatalogEntryRepository` /
- * `PrismaMarketingProjectionRepository` / `PrismaMarketingSettingsRepository` /
- * `PrismaPromotionRepository` / `PrismaSubscriptionContractRepository` exports
- * there. The registration and tenant-billing write ports remain app-specific.
+ * The bundle covers the complete canonical core, entitlement, catalog,
+ * tenant-billing, promo and plan-catalog persistence. App-specific behavior
+ * such as quota counters and authentication remains in the consumer.
  */
 declare function prismaPersistence(options: PrismaPersistenceOptions): SaasicatPersistenceAdapter;
 
@@ -867,6 +1015,28 @@ declare class PrismaSubscriptionRepository implements SubscriptionRepository {
     private planKeysForProject;
 }
 
+interface SubscriptionUsageClient {
+    plan: unknown;
+}
+/**
+ * Rich subscription read adapter for `GET /billing/usage`.
+ *
+ * It uses flat delegate reads instead of Prisma `include`, so it stays
+ * structurally compatible with consumer-generated clients and with the
+ * configurable subscription/PlanVersion delegate names.
+ */
+declare class PrismaSubscriptionUsageAdapter implements SubscriptionUsagePort {
+    private readonly prisma;
+    private readonly binding;
+    private readonly planVersionDelegateName;
+    private readonly subscriptionDelegateName;
+    constructor(prisma: SubscriptionUsageClient, options?: PrismaSchemaOptions);
+    findForTenant(tenantId: string): Promise<SubscriptionUsageRecord | null>;
+    private toPlanVersion;
+    private subscriptions;
+    private planVersions;
+}
+
 interface SubscriptionBundleClient {
     subscriptionBundle: unknown;
 }
@@ -1173,84 +1343,6 @@ declare class PrismaPlanRepository implements PlanRepository {
     private toPlanVersionRow;
 }
 
-/**
- * Root-client shape accepted by this repository. Delegates and `$transaction`
- * stay opaque at the injection boundary because generated Prisma delegates
- * have schema-specific generic signatures; calls are narrowed locally to the
- * exact Bundle operations below.
- */
-interface BundlePrismaClient {
-    bundle: unknown;
-    bundleVersion: unknown;
-    $transaction: unknown;
-}
-/**
- * Optional DI token for apps that register `PrismaBundleRepository` directly
- * as a Nest provider. Factory users may pass the same options as the second
- * constructor argument.
- */
-declare const PRISMA_BUNDLE_REPOSITORY_OPTIONS: unique symbol;
-interface PrismaBundleRepositoryOptions {
-    /**
-     * Enables reads and writes of `BundleVersion.validFrom`/`validUntil`.
-     *
-     * Default `false` preserves compatibility with databases and Prisma
-     * clients generated from the 0.6 schema, where the columns do not exist.
-     */
-    validityWindows?: boolean;
-}
-/**
- * `BundleRepository` against the canonical `bundles` + `bundle_versions`
- * tables (SPEC_V2 §5 + §11.1 M3). Versioning mirrors `PlanVersion`: at most one
- * draft (`publishedAt IS NULL`) per bundle, monotonically incrementing
- * `version`, `supersededAt` marking the previous live version on publish.
- *
- * Validity-window support is opt-in via `{ validityWindows: true }`. The
- * default deliberately does not select, read or write `validFrom`/
- * `validUntil`, and therefore keeps working with the 0.6 schema. In the
- * enabled mode the repository expects both nullable columns to exist.
- *
- * In validity-window mode `publishDraft` opens an internal transaction when
- * the caller did not provide one. This makes superseding the predecessor,
- * applying its auto-succession end date and publishing the draft atomic.
- * Legacy mode retains the 0.6 transaction behavior unchanged.
- */
-declare class PrismaBundleRepository implements BundleRepository {
-    private readonly prisma;
-    private readonly validityWindows;
-    /**
-     * Present only when validity-window mode is enabled. This mirrors the
-     * optional port capability and lets 0.6-schema consumers detect that an
-     * active-at-time lookup is unavailable.
-     */
-    readonly findActiveBundleVersion?: (bundleId: string, asOf?: Date, tx?: TransactionContext) => Promise<BundleVersionRow | null>;
-    constructor(prisma: BundlePrismaClient, options?: PrismaBundleRepositoryOptions);
-    private db;
-    private transaction;
-    list(filter: BundleListFilter): Promise<BundleRow[]>;
-    findById(bundleId: string): Promise<BundleRow | null>;
-    findByKey(projectKey: string, bundleKey: string): Promise<BundleRow | null>;
-    create(data: CreateBundleData): Promise<BundleRow>;
-    update(bundleId: string, data: UpdateBundleData): Promise<BundleRow>;
-    softDelete(bundleId: string): Promise<void>;
-    listVersions(bundleId: string): Promise<BundleVersionRow[]>;
-    findVersionById(versionId: string): Promise<BundleVersionRow | null>;
-    findCurrentDraft(bundleId: string): Promise<BundleVersionRow | null>;
-    findLatestLive(bundleId: string, tx?: TransactionContext): Promise<BundleVersionRow | null>;
-    private findActiveBundleVersionWithValidity;
-    createDraft(data: CreateBundleVersionDraftData): Promise<BundleVersionRow>;
-    updateDraft(versionId: string, data: UpdateBundleVersionDraftData): Promise<BundleVersionRow>;
-    publishDraft(versionId: string, publishMeta: {
-        publishedByUserId: string | null;
-        publishedChanges: VersionChange[];
-        nonRegressive: boolean;
-        validFrom: Date;
-        validUntil: Date | null;
-    }, tx?: TransactionContext): Promise<BundleVersionRow>;
-    private publishDraftWithValidity;
-    deleteDraft(versionId: string): Promise<void>;
-}
-
 interface CatalogEntryRepositoryClient {
     capabilityCatalogEntry: unknown;
     featureCatalogEntry: unknown;
@@ -1369,4 +1461,4 @@ declare class PrismaSubscriptionContractRepository implements SubscriptionContra
     terminate(contractId: string, data: TerminateSubscriptionContractData): Promise<SubscriptionContractRecord>;
 }
 
-export { AsyncLocalRlsBypassAdapter, type DecimalLike, PASSWORD_HASHER_TOKEN, PRISMA_BUNDLE_REPOSITORY_OPTIONS, PRISMA_CLIENT_TOKEN, PRISMA_SCHEMA_OPTIONS_TOKEN, PrismaAuditAdapter, PrismaAuditQueryAdapter, PrismaAuditStatsAdapter, PrismaBundleRepository, type PrismaBundleRepositoryOptions, PrismaCatalogEntryRepository, type PrismaLike, PrismaMarketingProjectionRepository, PrismaMarketingSettingsRepository, PrismaMfaAdapter, type PrismaModelDelegateLike, type PrismaPersistenceOptions, type PrismaPlanBindingMode, type PrismaPlanBindingOptions, type PrismaPlanBindingResolver, PrismaPlanCatalogImportSink, PrismaPlanCatalogReadSink, type PrismaPlanDelegateOptions, PrismaPlanRepository, type PrismaPlanVersionFieldCapabilities, type PrismaPlanVersionFieldOptions, PrismaPlanVersionRepository, PrismaPromoCodeRedemptionRepository, PrismaPromoCodeRepository, PrismaPromoCodeValidationLogRepository, PrismaPromoSubscriptionLookup, PrismaPromotionRepository, type PrismaSchemaOptions, PrismaSubscriptionBundleRepository, PrismaSubscriptionContractRepository, PrismaSubscriptionRepository, PrismaSuperAdminBootstrapAdapter, type PrismaTenantSubscriptionOptions, PrismaTenantSubscriptionWriteAdapter, PrismaTransactionRunner, type PrismaTxLike, type ResolvedPrismaSchemaOptions, ZeroPromoRevenueDeductionAggregator, buildActorTag, createPrismaPlanBindingResolver, getPrismaDelegate, prismaPersistence, resolvePrismaSchemaOptions };
+export { AsyncLocalRlsBypassAdapter, type DecimalLike, PASSWORD_HASHER_TOKEN, PRISMA_BUNDLE_REPOSITORY_OPTIONS, PRISMA_CLIENT_TOKEN, PRISMA_SCHEMA_OPTIONS_TOKEN, PrismaAdminResourcesAdapter, type PrismaAdminResourcesOptions, PrismaAuditAdapter, PrismaAuditQueryAdapter, PrismaAuditStatsAdapter, PrismaBundleRepository, type PrismaBundleRepositoryOptions, PrismaCatalogEntryRepository, type PrismaLike, PrismaMarketingProjectionRepository, PrismaMarketingSettingsRepository, PrismaMfaAdapter, type PrismaModelDelegateLike, type PrismaPersistenceOptions, type PrismaPlanBindingMode, type PrismaPlanBindingOptions, type PrismaPlanBindingResolver, PrismaPlanCatalogImportSink, PrismaPlanCatalogReadSink, type PrismaPlanDelegateOptions, PrismaPlanRepository, type PrismaPlanVersionFieldCapabilities, type PrismaPlanVersionFieldOptions, PrismaPlanVersionRepository, PrismaPromoCodeRedemptionRepository, PrismaPromoCodeRepository, PrismaPromoCodeValidationLogRepository, PrismaPromoSubscriptionLookup, PrismaPromotionRepository, type PrismaSchemaOptions, PrismaSubscriptionBundleRepository, PrismaSubscriptionContractRepository, PrismaSubscriptionRepository, PrismaSubscriptionUsageAdapter, PrismaSuperAdminBootstrapAdapter, type PrismaTenantSubscriptionOptions, PrismaTenantSubscriptionWriteAdapter, PrismaTransactionRunner, type PrismaTxLike, type ResolvedPrismaSchemaOptions, ZeroPromoRevenueDeductionAggregator, buildActorTag, createPrismaPlanBindingResolver, getPrismaDelegate, prismaPersistence, resolvePrismaSchemaOptions };