@saasicat/persistence-testing 1.0.0-rc.6 → 1.0.0-rc.7

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { PersistenceCapabilities, TransactionRunner, SubscriptionRepository, PlanVersionRepository, PromoCodeRepository, PromoCodeRedemptionRepository, MfaPort, AuditPort, AuditQueryPort, SubscriptionContractRepository, TenantSubscriptionWritePort, BundleRepository, PlanRepository, PromoSubscriptionLookup } from '@saasicat/core';
+import { PersistenceCapabilities, TransactionRunner, SubscriptionRepository, PlanVersionRepository, PromoCodeRepository, PromoCodeRedemptionRepository, MfaPort, AuditPort, AuditQueryPort, SubscriptionContractRepository, TenantSubscriptionWritePort, BundleRepository, SubscriptionBundleRepository, PlanRepository, PromoSubscriptionLookup } from '@saasicat/core';
 
 /**
  * Port instances under test. Required members define the minimum an adapter
@@ -25,6 +25,14 @@ interface ContractAdapterInstances {
     tenantSubscriptionWrite?: TenantSubscriptionWritePort;
     /** Enables BundleVersion validity-window and auto-succession scenarios. */
     bundleRepository?: BundleRepository;
+    /**
+     * Enables the booking scenarios — the junction a tenant's bundles hang off.
+     *
+     * Separate from `bundleRepository`, which is the catalog: one answers what
+     * may be sold, the other what a tenant actually bought and for which
+     * period. `adapter-drizzle` has neither yet.
+     */
+    subscriptionBundleRepository?: SubscriptionBundleRepository;
     /** Enables PlanVersion lifecycle, identity and validity-window scenarios. */
     planRepository?: PlanRepository;
     /**
@@ -63,6 +71,34 @@ interface ContractSeed {
     }): Promise<{
         subscriptionId: string;
     }>;
+    /**
+     * A published BundleVersion to book against.
+     *
+     * A fixture writer rather than a call into `bundleRepository`: the catalog
+     * repository is a subject of the suite, not a tool for setting up someone
+     * else's scenario, and a booking scenario that failed because the catalog
+     * did would say the wrong thing.
+     *
+     * Optional because an adapter may not carry the catalog tables at all —
+     * `adapter-drizzle` does not. A required writer nobody can implement is a
+     * contract that lies about what conformance means; the booking scenarios
+     * gate on this and report the gap as a skip instead.
+     */
+    createBundleVersion?(input: {
+        bundleKey: string;
+        features: string[];
+    }): Promise<{
+        bundleVersionId: string;
+    }>;
+    /**
+     * Clears a booking's `canceledAt` while leaving `canceledEffectiveAt`.
+     *
+     * A shape no repository method produces, and one the nullable columns
+     * nonetheless permit — so the adapters have to agree on how to read it.
+     * Optional: a harness that cannot reach its store directly says so and the
+     * scenario skips, rather than the scenario inventing a way in.
+     */
+    clearBookingRequestDate?(subscriptionBundleId: string): Promise<void>;
     createPromoCode(input: {
         code: string;
         maxRedemptions: number | null;
@@ -82,8 +118,6 @@ interface PersistenceContractHarness {
 interface PersistenceAdapterContractOptions {
     /** Display name in the test output, e.g. `'adapter-prisma @ postgres16'`. */
     name: string;
-    /** Project identity used by catalog lifecycle scenarios. */
-    projectKey: string;
     /** Builds the harness once for the whole suite. */
     create(): Promise<PersistenceContractHarness>;
 }
@@ -94,7 +128,6 @@ interface PersistenceAdapterContractOptions {
  * ```ts
  * persistenceAdapterContract({
  *     name: 'adapter-prisma @ postgres',
- *     projectKey: 'my-app',
  *     create: () => createPrismaHarness(),
  * });
  * ```

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { PersistenceCapabilities, TransactionRunner, SubscriptionRepository, PlanVersionRepository, PromoCodeRepository, PromoCodeRedemptionRepository, MfaPort, AuditPort, AuditQueryPort, SubscriptionContractRepository, TenantSubscriptionWritePort, BundleRepository, PlanRepository, PromoSubscriptionLookup } from '@saasicat/core';
+import { PersistenceCapabilities, TransactionRunner, SubscriptionRepository, PlanVersionRepository, PromoCodeRepository, PromoCodeRedemptionRepository, MfaPort, AuditPort, AuditQueryPort, SubscriptionContractRepository, TenantSubscriptionWritePort, BundleRepository, SubscriptionBundleRepository, PlanRepository, PromoSubscriptionLookup } from '@saasicat/core';
 
 /**
  * Port instances under test. Required members define the minimum an adapter
@@ -25,6 +25,14 @@ interface ContractAdapterInstances {
     tenantSubscriptionWrite?: TenantSubscriptionWritePort;
     /** Enables BundleVersion validity-window and auto-succession scenarios. */
     bundleRepository?: BundleRepository;
+    /**
+     * Enables the booking scenarios — the junction a tenant's bundles hang off.
+     *
+     * Separate from `bundleRepository`, which is the catalog: one answers what
+     * may be sold, the other what a tenant actually bought and for which
+     * period. `adapter-drizzle` has neither yet.
+     */
+    subscriptionBundleRepository?: SubscriptionBundleRepository;
     /** Enables PlanVersion lifecycle, identity and validity-window scenarios. */
     planRepository?: PlanRepository;
     /**
@@ -63,6 +71,34 @@ interface ContractSeed {
     }): Promise<{
         subscriptionId: string;
     }>;
+    /**
+     * A published BundleVersion to book against.
+     *
+     * A fixture writer rather than a call into `bundleRepository`: the catalog
+     * repository is a subject of the suite, not a tool for setting up someone
+     * else's scenario, and a booking scenario that failed because the catalog
+     * did would say the wrong thing.
+     *
+     * Optional because an adapter may not carry the catalog tables at all —
+     * `adapter-drizzle` does not. A required writer nobody can implement is a
+     * contract that lies about what conformance means; the booking scenarios
+     * gate on this and report the gap as a skip instead.
+     */
+    createBundleVersion?(input: {
+        bundleKey: string;
+        features: string[];
+    }): Promise<{
+        bundleVersionId: string;
+    }>;
+    /**
+     * Clears a booking's `canceledAt` while leaving `canceledEffectiveAt`.
+     *
+     * A shape no repository method produces, and one the nullable columns
+     * nonetheless permit — so the adapters have to agree on how to read it.
+     * Optional: a harness that cannot reach its store directly says so and the
+     * scenario skips, rather than the scenario inventing a way in.
+     */
+    clearBookingRequestDate?(subscriptionBundleId: string): Promise<void>;
     createPromoCode(input: {
         code: string;
         maxRedemptions: number | null;
@@ -82,8 +118,6 @@ interface PersistenceContractHarness {
 interface PersistenceAdapterContractOptions {
     /** Display name in the test output, e.g. `'adapter-prisma @ postgres16'`. */
     name: string;
-    /** Project identity used by catalog lifecycle scenarios. */
-    projectKey: string;
     /** Builds the harness once for the whole suite. */
     create(): Promise<PersistenceContractHarness>;
 }
@@ -94,7 +128,6 @@ interface PersistenceAdapterContractOptions {
  * ```ts
  * persistenceAdapterContract({
  *     name: 'adapter-prisma @ postgres',
- *     projectKey: 'my-app',
  *     create: () => createPrismaHarness(),
  * });
  * ```