@saasicat/persistence-testing 1.0.0-rc.14 → 1.0.0-rc.16

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { PersistenceCapabilities, TransactionRunner, SubscriptionRepository, PlanVersionRepository, PromoCodeRepository, PromoCodeRedemptionRepository, MfaPort, AuditPort, AuditQueryPort, SubscriptionContractRepository, TenantSubscriptionWritePort, BundleRepository, SubscriptionBundleRepository, PlanRepository, PromoSubscriptionLookup, AppliedSettingsPort } from '@saasicat/core';
+import { PersistenceCapabilities, TransactionRunner, SubscriptionRepository, PlanVersionRepository, PromoCodeRepository, PromoCodeRedemptionRepository, MfaPort, AuditPort, AuditQueryPort, SubscriptionContractRepository, SubscriberRepository, CheckoutOfferRepository, TenantSubscriptionWritePort, BundleRepository, SubscriptionBundleRepository, PlanRepository, PromoSubscriptionLookup, AppliedSettingsPort } from '@saasicat/core';
 
 /**
  * Port instances under test. Required members define the minimum an adapter
@@ -18,6 +18,21 @@ interface ContractAdapterInstances {
     audit?: AuditPort;
     auditQuery?: AuditQueryPort;
     subscriptionContractRepository?: SubscriptionContractRepository;
+    /**
+     * Enables the subscriber scenarios: a customer number the database
+     * counts, one live subscriber per tenant however many callers create one
+     * at once, and a correction that records the values it replaced. A
+     * contract names its subscriber, so the contract scenarios write theirs
+     * through `seed.createSubscriber` rather than through this port.
+     */
+    subscriberRepository?: SubscriberRepository;
+    /**
+     * Enables the checkout offer scenarios: an offer is consumed once, and a
+     * consume on a transaction that rolls back leaves it open. Neither shipped
+     * adapter provides one; an application that implements the port wires it
+     * here.
+     */
+    checkoutOfferRepository?: CheckoutOfferRepository;
     /**
      * Enables the atomic plan-binding scenarios. Adapters should expose this
      * member only for a mode that promises to keep `plan`,
@@ -117,6 +132,19 @@ interface ContractSeed {
     }): Promise<{
         promoCodeId: string;
     }>;
+    /**
+     * A subscriber row for a contract scenario to name, linked to no tenant.
+     *
+     * A fixture writer for the reason `createBundleVersion` is one: the
+     * subscriber repository is a subject of its own scenarios, and a contract
+     * scenario that failed because of it would say the wrong thing. Optional
+     * like the port it stands beside; the contract scenarios report it missing.
+     */
+    createSubscriber?(input: {
+        legalName: string;
+    }): Promise<{
+        subscriberId: string;
+    }>;
 }
 interface PersistenceContractHarness {
     adapter: ContractAdapterInstances;
@@ -132,7 +160,7 @@ interface PersistenceContractHarness {
  * Each names the members its scenarios need; `contract.ts` holds the list with
  * what each one checks.
  */
-type ContractGap = 'atomicPlanBinding' | 'atomicOnboarding' | 'promoCodes' | 'promoCodeRedemptions' | 'promoSubscriptionLookup' | 'planRepository' | 'planLifecycle' | 'planRetirement' | 'planVersionReads' | 'planVersionRetirement' | 'bundleRepository' | 'bundleValidity' | 'bundleDraftDiscard' | 'bundleDraftPublish' | 'bundleRetirement' | 'bundleBookings' | 'halfCancelledBookingSeed' | 'countByPlanVersionId' | 'audit' | 'mfa' | 'subscriptionContracts' | 'appliedSettings';
+type ContractGap = 'atomicPlanBinding' | 'atomicOnboarding' | 'promoCodes' | 'promoCodeRedemptions' | 'promoSubscriptionLookup' | 'planRepository' | 'planLifecycle' | 'planRetirement' | 'planVersionReads' | 'planVersionRetirement' | 'bundleRepository' | 'bundleValidity' | 'bundleDraftDiscard' | 'bundleDraftPublish' | 'bundleRetirement' | 'bundleBookings' | 'halfCancelledBookingSeed' | 'countByPlanVersionId' | 'audit' | 'mfa' | 'subscriptionContracts' | 'subscribers' | 'checkoutOffers' | 'appliedSettings';
 interface PersistenceAdapterContractOptions {
     /** Display name in the test output, e.g. `'adapter-prisma @ postgres16'`. */
     name: string;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { PersistenceCapabilities, TransactionRunner, SubscriptionRepository, PlanVersionRepository, PromoCodeRepository, PromoCodeRedemptionRepository, MfaPort, AuditPort, AuditQueryPort, SubscriptionContractRepository, TenantSubscriptionWritePort, BundleRepository, SubscriptionBundleRepository, PlanRepository, PromoSubscriptionLookup, AppliedSettingsPort } from '@saasicat/core';
+import { PersistenceCapabilities, TransactionRunner, SubscriptionRepository, PlanVersionRepository, PromoCodeRepository, PromoCodeRedemptionRepository, MfaPort, AuditPort, AuditQueryPort, SubscriptionContractRepository, SubscriberRepository, CheckoutOfferRepository, TenantSubscriptionWritePort, BundleRepository, SubscriptionBundleRepository, PlanRepository, PromoSubscriptionLookup, AppliedSettingsPort } from '@saasicat/core';
 
 /**
  * Port instances under test. Required members define the minimum an adapter
@@ -18,6 +18,21 @@ interface ContractAdapterInstances {
     audit?: AuditPort;
     auditQuery?: AuditQueryPort;
     subscriptionContractRepository?: SubscriptionContractRepository;
+    /**
+     * Enables the subscriber scenarios: a customer number the database
+     * counts, one live subscriber per tenant however many callers create one
+     * at once, and a correction that records the values it replaced. A
+     * contract names its subscriber, so the contract scenarios write theirs
+     * through `seed.createSubscriber` rather than through this port.
+     */
+    subscriberRepository?: SubscriberRepository;
+    /**
+     * Enables the checkout offer scenarios: an offer is consumed once, and a
+     * consume on a transaction that rolls back leaves it open. Neither shipped
+     * adapter provides one; an application that implements the port wires it
+     * here.
+     */
+    checkoutOfferRepository?: CheckoutOfferRepository;
     /**
      * Enables the atomic plan-binding scenarios. Adapters should expose this
      * member only for a mode that promises to keep `plan`,
@@ -117,6 +132,19 @@ interface ContractSeed {
     }): Promise<{
         promoCodeId: string;
     }>;
+    /**
+     * A subscriber row for a contract scenario to name, linked to no tenant.
+     *
+     * A fixture writer for the reason `createBundleVersion` is one: the
+     * subscriber repository is a subject of its own scenarios, and a contract
+     * scenario that failed because of it would say the wrong thing. Optional
+     * like the port it stands beside; the contract scenarios report it missing.
+     */
+    createSubscriber?(input: {
+        legalName: string;
+    }): Promise<{
+        subscriberId: string;
+    }>;
 }
 interface PersistenceContractHarness {
     adapter: ContractAdapterInstances;
@@ -132,7 +160,7 @@ interface PersistenceContractHarness {
  * Each names the members its scenarios need; `contract.ts` holds the list with
  * what each one checks.
  */
-type ContractGap = 'atomicPlanBinding' | 'atomicOnboarding' | 'promoCodes' | 'promoCodeRedemptions' | 'promoSubscriptionLookup' | 'planRepository' | 'planLifecycle' | 'planRetirement' | 'planVersionReads' | 'planVersionRetirement' | 'bundleRepository' | 'bundleValidity' | 'bundleDraftDiscard' | 'bundleDraftPublish' | 'bundleRetirement' | 'bundleBookings' | 'halfCancelledBookingSeed' | 'countByPlanVersionId' | 'audit' | 'mfa' | 'subscriptionContracts' | 'appliedSettings';
+type ContractGap = 'atomicPlanBinding' | 'atomicOnboarding' | 'promoCodes' | 'promoCodeRedemptions' | 'promoSubscriptionLookup' | 'planRepository' | 'planLifecycle' | 'planRetirement' | 'planVersionReads' | 'planVersionRetirement' | 'bundleRepository' | 'bundleValidity' | 'bundleDraftDiscard' | 'bundleDraftPublish' | 'bundleRetirement' | 'bundleBookings' | 'halfCancelledBookingSeed' | 'countByPlanVersionId' | 'audit' | 'mfa' | 'subscriptionContracts' | 'subscribers' | 'checkoutOffers' | 'appliedSettings';
 interface PersistenceAdapterContractOptions {
     /** Display name in the test output, e.g. `'adapter-prisma @ postgres16'`. */
     name: string;