@saasicat/nest 1.0.0-rc.2 → 1.0.0-rc.21

package/dist/subscriber.service-5W6Gi-1B.d.cts

@@ -0,0 +1,68 @@
+import { SubscriberRepository, PlanCatalogSettings, NewSubscriberDetails, TransactionContext, SubscriberRecord, SubscriptionContractParties, SubscriberContactChange, SubscriberIdentityCorrection, SubscriberCorrectionRecord } from '@saasicat/core';
+
+/**
+ * The parties contracts are concluded with.
+ *
+ * SaaSiCat creates no tenants, so it cannot create their subscribers on its
+ * own: wherever an application creates a tenant that will hold a subscription,
+ * it calls `createForTenant` in the same transaction. Every way a contract
+ * arises then finds the party it is concluded with, and refuses without one.
+ */
+declare class SubscriberService {
+    private readonly repo;
+    private readonly settings;
+    constructor(repo: SubscriberRepository, settings: PlanCatalogSettings);
+    /**
+     * Creates the tenant's subscriber and assigns its customer number, behind
+     * the prefix `config/saas.yaml` names. With `tx` it is written on that
+     * transaction and undone with it — pass the one the tenant is created on.
+     *
+     * Refused with `SUBSCRIBER_ALREADY_EXISTS` when the tenant has one: a second
+     * party for the same tenant is not a correction of the first.
+     */
+    createForTenant(tenantId: string, details: NewSubscriberDetails, tx?: TransactionContext): Promise<SubscriberRecord>;
+    /** The tenant's subscriber, or `null` when it has none. */
+    findByTenantId(tenantId: string, tx?: TransactionContext): Promise<SubscriberRecord | null>;
+    /** The tenant's subscriber, refused with `SUBSCRIBER_REQUIRED` when it has none. */
+    requireForTenant(tenantId: string, tx?: TransactionContext): Promise<SubscriberRecord>;
+    /**
+     * Who a contract concluded for this tenant now is between: its subscriber
+     * as the record stands, and the issuer as the running configuration names
+     * it. Refused with `SUBSCRIBER_REQUIRED` when the tenant has no subscriber.
+     */
+    contractPartiesFor(tenantId: string, tx?: TransactionContext): Promise<SubscriptionContractParties>;
+    getById(subscriberId: string): Promise<SubscriberRecord>;
+    /**
+     * Changes how the subscriber is reached — the address, the country, the
+     * invoice email — at any time. A contract keeps the copy it was concluded
+     * with; what comes later reads the new details. The legal name and the tax
+     * identifiers are refused here: they change by `correctIdentity`.
+     */
+    changeContact(subscriberId: string, change: SubscriberContactChange): Promise<SubscriberRecord>;
+    /**
+     * A tenant's own change of how its subscriber is reached, from its billing
+     * area. The address and the invoice email can be changed but not cleared —
+     * `SUBSCRIBER_DETAIL_INVALID` names the field — since without them nothing
+     * can be invoiced. The legal name and the tax identifiers are refused as
+     * with `changeContact`: they are the party, and only the operator corrects
+     * them.
+     */
+    changeContactOfTenant(tenantId: string, change: SubscriberContactChange): Promise<SubscriberRecord>;
+    /** Writes contact details already settled; settling twice would check one copy and write another. */
+    private writeContact;
+    /**
+     * Corrects the legal identity of the same legal entity — a misspelt name, a
+     * wrong tax identifier, a change of name that entity went through — and
+     * records the values it replaced, the reason and who made it. A contract
+     * keeps the copy it was concluded with.
+     *
+     * The operator declares what the change is, because nothing here can tell:
+     * another legal entity taking over is a transfer, and is refused with
+     * `SUBSCRIBER_TAKEOVER_IS_A_TRANSFER` rather than recorded as an edit.
+     */
+    correctIdentity(subscriberId: string, correction: SubscriberIdentityCorrection): Promise<SubscriberCorrectionRecord>;
+    /** Every correction of the subscriber's legal identity, the latest first. */
+    listCorrections(subscriberId: string): Promise<SubscriberCorrectionRecord[]>;
+}
+
+export { SubscriberService as S };

package/dist/subscriber.service-5W6Gi-1B.d.ts

@@ -0,0 +1,68 @@
+import { SubscriberRepository, PlanCatalogSettings, NewSubscriberDetails, TransactionContext, SubscriberRecord, SubscriptionContractParties, SubscriberContactChange, SubscriberIdentityCorrection, SubscriberCorrectionRecord } from '@saasicat/core';
+
+/**
+ * The parties contracts are concluded with.
+ *
+ * SaaSiCat creates no tenants, so it cannot create their subscribers on its
+ * own: wherever an application creates a tenant that will hold a subscription,
+ * it calls `createForTenant` in the same transaction. Every way a contract
+ * arises then finds the party it is concluded with, and refuses without one.
+ */
+declare class SubscriberService {
+    private readonly repo;
+    private readonly settings;
+    constructor(repo: SubscriberRepository, settings: PlanCatalogSettings);
+    /**
+     * Creates the tenant's subscriber and assigns its customer number, behind
+     * the prefix `config/saas.yaml` names. With `tx` it is written on that
+     * transaction and undone with it — pass the one the tenant is created on.
+     *
+     * Refused with `SUBSCRIBER_ALREADY_EXISTS` when the tenant has one: a second
+     * party for the same tenant is not a correction of the first.
+     */
+    createForTenant(tenantId: string, details: NewSubscriberDetails, tx?: TransactionContext): Promise<SubscriberRecord>;
+    /** The tenant's subscriber, or `null` when it has none. */
+    findByTenantId(tenantId: string, tx?: TransactionContext): Promise<SubscriberRecord | null>;
+    /** The tenant's subscriber, refused with `SUBSCRIBER_REQUIRED` when it has none. */
+    requireForTenant(tenantId: string, tx?: TransactionContext): Promise<SubscriberRecord>;
+    /**
+     * Who a contract concluded for this tenant now is between: its subscriber
+     * as the record stands, and the issuer as the running configuration names
+     * it. Refused with `SUBSCRIBER_REQUIRED` when the tenant has no subscriber.
+     */
+    contractPartiesFor(tenantId: string, tx?: TransactionContext): Promise<SubscriptionContractParties>;
+    getById(subscriberId: string): Promise<SubscriberRecord>;
+    /**
+     * Changes how the subscriber is reached — the address, the country, the
+     * invoice email — at any time. A contract keeps the copy it was concluded
+     * with; what comes later reads the new details. The legal name and the tax
+     * identifiers are refused here: they change by `correctIdentity`.
+     */
+    changeContact(subscriberId: string, change: SubscriberContactChange): Promise<SubscriberRecord>;
+    /**
+     * A tenant's own change of how its subscriber is reached, from its billing
+     * area. The address and the invoice email can be changed but not cleared —
+     * `SUBSCRIBER_DETAIL_INVALID` names the field — since without them nothing
+     * can be invoiced. The legal name and the tax identifiers are refused as
+     * with `changeContact`: they are the party, and only the operator corrects
+     * them.
+     */
+    changeContactOfTenant(tenantId: string, change: SubscriberContactChange): Promise<SubscriberRecord>;
+    /** Writes contact details already settled; settling twice would check one copy and write another. */
+    private writeContact;
+    /**
+     * Corrects the legal identity of the same legal entity — a misspelt name, a
+     * wrong tax identifier, a change of name that entity went through — and
+     * records the values it replaced, the reason and who made it. A contract
+     * keeps the copy it was concluded with.
+     *
+     * The operator declares what the change is, because nothing here can tell:
+     * another legal entity taking over is a transfer, and is refused with
+     * `SUBSCRIBER_TAKEOVER_IS_A_TRANSFER` rather than recorded as an edit.
+     */
+    correctIdentity(subscriberId: string, correction: SubscriberIdentityCorrection): Promise<SubscriberCorrectionRecord>;
+    /** Every correction of the subscriber's legal identity, the latest first. */
+    listCorrections(subscriberId: string): Promise<SubscriberCorrectionRecord[]>;
+}
+
+export { SubscriberService as S };

package/dist/subscription-contract/index.d.cts

@@ -1,6 +1,8 @@
-export { C as CreateContractFromOfferOptions, S as SubscriptionContractService, c as contractLineItemToInvoiceLineItem, s as sortContractLineItemsForInvoice, a as subscriptionContractToInvoiceSnapshot } from '../subscription-contract.service-hD87MKyg.cjs';
-export { S as SubscriptionContractModule, a as SubscriptionContractModuleOptions } from '../subscription-contract.module-CEK8HS5-.cjs';
+export { C as CreateContractFromOfferOptions, S as SubscriptionContractService, c as contractLineItemToInvoiceLineItem, s as sortContractLineItemsForInvoice, a as subscriptionContractToInvoiceSnapshot } from '../subscription-contract.service-CfNApLuP.cjs';
+export { a as SubscriptionContractModule, S as SubscriptionContractModuleOptions } from '../subscription-contract.module-DTMuUJYd.cjs';
+export { C as ContractLineMoney, a as ContractLineTotals, P as PricedContractLineItem, c as contractTotalsOf, r as recordContractLinesMoney } from '../contract-line-item-money-B0Z3Ogur.cjs';
 import '@saasicat/core';
+import '../subscriber.service-5W6Gi-1B.cjs';
 import '@nestjs/common';
 import '../di-CcNeq9v-.cjs';
 

package/dist/subscription-contract/index.d.ts

@@ -1,6 +1,8 @@
-export { C as CreateContractFromOfferOptions, S as SubscriptionContractService, c as contractLineItemToInvoiceLineItem, s as sortContractLineItemsForInvoice, a as subscriptionContractToInvoiceSnapshot } from '../subscription-contract.service-hD87MKyg.js';
-export { S as SubscriptionContractModule, a as SubscriptionContractModuleOptions } from '../subscription-contract.module-fDFdQ0jm.js';
+export { C as CreateContractFromOfferOptions, S as SubscriptionContractService, c as contractLineItemToInvoiceLineItem, s as sortContractLineItemsForInvoice, a as subscriptionContractToInvoiceSnapshot } from '../subscription-contract.service-CPZrTM9C.js';
+export { a as SubscriptionContractModule, S as SubscriptionContractModuleOptions } from '../subscription-contract.module-BfIRpc1o.js';
+export { C as ContractLineMoney, a as ContractLineTotals, P as PricedContractLineItem, c as contractTotalsOf, r as recordContractLinesMoney } from '../contract-line-item-money-B0Z3Ogur.js';
 import '@saasicat/core';
+import '../subscriber.service-5W6Gi-1B.js';
 import '@nestjs/common';
 import '../di-CcNeq9v-.js';
 

package/dist/subscription-contract/index.js

@@ -1,24 +1,32 @@
-import "../chunk-2SLTRKXC.js";
+import "../chunk-BHZOH2DY.js";
 import {
   SubscriptionContractModule
-} from "../chunk-AU3OOREM.js";
+} from "../chunk-XSSWYPP5.js";
 import {
   SubscriptionContractService,
   contractLineItemToInvoiceLineItem,
   sortContractLineItemsForInvoice,
   subscriptionContractToInvoiceSnapshot
-} from "../chunk-KFT5AIIH.js";
-import "../chunk-BSK6YBLI.js";
+} from "../chunk-NDLC5GYK.js";
 import {
   SUBSCRIPTION_CONTRACT_REPOSITORY_TOKEN
 } from "../chunk-VBRYPU7V.js";
-import "../chunk-SABTXESR.js";
+import {
+  contractTotalsOf,
+  recordContractLinesMoney
+} from "../chunk-6PJE7EWO.js";
+import "../chunk-WOEJ6K7M.js";
+import "../chunk-LF6J4YYN.js";
+import "../chunk-FEQZCWUL.js";
+import "../chunk-J7NJRK3K.js";
 import "../chunk-SHUYVCID.js";
 export {
   SUBSCRIPTION_CONTRACT_REPOSITORY_TOKEN,
   SubscriptionContractModule,
   SubscriptionContractService,
   contractLineItemToInvoiceLineItem,
+  contractTotalsOf,
+  recordContractLinesMoney,
   sortContractLineItemsForInvoice,
   subscriptionContractToInvoiceSnapshot
 };

package/dist/{subscription-contract.module-fDFdQ0jm.d.ts → subscription-contract.module-BfIRpc1o.d.ts}

@@ -1,9 +1,15 @@
 import { Type, DynamicModule, ForwardReference, Provider } from '@nestjs/common';
-import { SubscriptionContractRepository } from '@saasicat/core';
+import { SubscriptionContractRepository, SubscriberRepository } from '@saasicat/core';
 import { P as ProviderSpec } from './di-CcNeq9v-.js';
 
 interface SubscriptionContractModuleOptions {
     subscriptionContractRepository: ProviderSpec<SubscriptionContractRepository>;
+    /**
+     * The parties contracts are concluded with. The module provides
+     * `SubscriberService` over it as well, for the application's own tenant
+     * creation to call.
+     */
+    subscriberRepository: ProviderSpec<SubscriberRepository>;
     /** Modules that provide dependencies used by the repository factory. */
     imports?: Array<Type<unknown> | DynamicModule | Promise<DynamicModule> | ForwardReference>;
     extraProviders?: Provider[];
@@ -13,4 +19,4 @@ declare class SubscriptionContractModule {
     static forRoot(options: SubscriptionContractModuleOptions): DynamicModule;
 }
 
-export { SubscriptionContractModule as S, type SubscriptionContractModuleOptions as a };
+export { type SubscriptionContractModuleOptions as S, SubscriptionContractModule as a };

package/dist/{subscription-contract.module-CEK8HS5-.d.cts → subscription-contract.module-DTMuUJYd.d.cts}

@@ -1,9 +1,15 @@
 import { Type, DynamicModule, ForwardReference, Provider } from '@nestjs/common';
-import { SubscriptionContractRepository } from '@saasicat/core';
+import { SubscriptionContractRepository, SubscriberRepository } from '@saasicat/core';
 import { P as ProviderSpec } from './di-CcNeq9v-.cjs';
 
 interface SubscriptionContractModuleOptions {
     subscriptionContractRepository: ProviderSpec<SubscriptionContractRepository>;
+    /**
+     * The parties contracts are concluded with. The module provides
+     * `SubscriberService` over it as well, for the application's own tenant
+     * creation to call.
+     */
+    subscriberRepository: ProviderSpec<SubscriberRepository>;
     /** Modules that provide dependencies used by the repository factory. */
     imports?: Array<Type<unknown> | DynamicModule | Promise<DynamicModule> | ForwardReference>;
     extraProviders?: Provider[];
@@ -13,4 +19,4 @@ declare class SubscriptionContractModule {
     static forRoot(options: SubscriptionContractModuleOptions): DynamicModule;
 }
 
-export { SubscriptionContractModule as S, type SubscriptionContractModuleOptions as a };
+export { type SubscriptionContractModuleOptions as S, SubscriptionContractModule as a };

package/dist/{subscription-contract.service-hD87MKyg.d.cts → subscription-contract.service-CPZrTM9C.d.ts}

@@ -1,4 +1,5 @@
-import { SubscriptionContractRepository, SubscriptionContractRecord, SubscriptionContractInvoiceSnapshot, CreateSubscriptionContractData, TerminateSubscriptionContractData, CheckoutOfferRow, ContractLineItemRecord, InvoiceLineItemSnapshot } from '@saasicat/core';
+import { SubscriptionContractRepository, SubscriptionContractRecord, SubscriptionContractInvoiceSnapshot, CreateSubscriptionContractData, TransactionContext, TerminateSubscriptionContractData, CheckoutOfferRow, ContractLineItemRecord, InvoiceLineItemSnapshot } from '@saasicat/core';
+import { S as SubscriberService } from './subscriber.service-5W6Gi-1B.js';
 
 interface CreateContractFromOfferOptions {
     tenantId: string;
@@ -10,18 +11,46 @@ interface CreateContractFromOfferOptions {
 }
 declare class SubscriptionContractService {
     private readonly repo;
-    constructor(repo: SubscriptionContractRepository);
+    private readonly subscribers;
+    constructor(repo: SubscriptionContractRepository, subscribers: SubscriberService);
     list(filter: Parameters<SubscriptionContractRepository['list']>[0]): Promise<SubscriptionContractRecord[]>;
     getById(contractId: string): Promise<SubscriptionContractRecord>;
     findActiveByTenantId(tenantId: string, asOf?: Date): Promise<SubscriptionContractRecord | null>;
     getActiveInvoiceSnapshotForTenant(tenantId: string, asOf?: Date): Promise<SubscriptionContractInvoiceSnapshot>;
-    create(data: CreateSubscriptionContractData): Promise<SubscriptionContractRecord>;
+    /**
+     * Writes the contract between the tenant's subscriber and the issuer
+     * `config/saas.yaml` names, copying both as they stand. With `tx`, the
+     * contract is written on that transaction and undone with it, and the
+     * subscriber is read there too — so one created earlier on the same
+     * transaction is found.
+     *
+     * Refused with `SUBSCRIBER_REQUIRED` for a tenant without a subscriber:
+     * nothing is agreed without the party to it.
+     */
+    create(data: CreateSubscriptionContractData, tx?: TransactionContext): Promise<SubscriptionContractRecord>;
+    /**
+     * Refuses, with `SUBSCRIBER_REQUIRED`, a contract this tenant could not
+     * have. For callers that change something before the contract is written —
+     * closing the one in force, changing a plan — and must refuse before that
+     * rather than after.
+     */
+    assertPartyFor(tenantId: string, tx?: TransactionContext): Promise<void>;
+    /** The contract concluded from a checkout offer, or `null` when none was. */
+    findByOriginalOfferId(offerId: string, tx?: TransactionContext): Promise<SubscriptionContractRecord | null>;
     terminate(contractId: string, data: TerminateSubscriptionContractData): Promise<SubscriptionContractRecord>;
     replaceActiveContract(tenantId: string, data: CreateSubscriptionContractData, terminateAt: Date): Promise<{
         previous: SubscriptionContractRecord | null;
         next: SubscriptionContractRecord;
     }>;
     createDataFromOffer(offer: CheckoutOfferRow, options: CreateContractFromOfferOptions): CreateSubscriptionContractData;
+    /**
+     * The contract an offer becomes, checked the way `create` checks it, before
+     * anything is written. Unlike `createDataFromOffer` it takes an offer that
+     * is still open: concluding an offer refuses a contract it could not create
+     * before the offer is consumed, rather than after.
+     */
+    prepareFromOffer(offer: CheckoutOfferRow, options: CreateContractFromOfferOptions): CreateSubscriptionContractData;
+    private dataFromOffer;
     createFromOffer(offer: CheckoutOfferRow, options: CreateContractFromOfferOptions): Promise<SubscriptionContractRecord>;
     private lineItemsFromOffer;
     private offerLineItemToContractLineItem;

package/dist/{subscription-contract.service-hD87MKyg.d.ts → subscription-contract.service-CfNApLuP.d.cts}

@@ -1,4 +1,5 @@
-import { SubscriptionContractRepository, SubscriptionContractRecord, SubscriptionContractInvoiceSnapshot, CreateSubscriptionContractData, TerminateSubscriptionContractData, CheckoutOfferRow, ContractLineItemRecord, InvoiceLineItemSnapshot } from '@saasicat/core';
+import { SubscriptionContractRepository, SubscriptionContractRecord, SubscriptionContractInvoiceSnapshot, CreateSubscriptionContractData, TransactionContext, TerminateSubscriptionContractData, CheckoutOfferRow, ContractLineItemRecord, InvoiceLineItemSnapshot } from '@saasicat/core';
+import { S as SubscriberService } from './subscriber.service-5W6Gi-1B.cjs';
 
 interface CreateContractFromOfferOptions {
     tenantId: string;
@@ -10,18 +11,46 @@ interface CreateContractFromOfferOptions {
 }
 declare class SubscriptionContractService {
     private readonly repo;
-    constructor(repo: SubscriptionContractRepository);
+    private readonly subscribers;
+    constructor(repo: SubscriptionContractRepository, subscribers: SubscriberService);
     list(filter: Parameters<SubscriptionContractRepository['list']>[0]): Promise<SubscriptionContractRecord[]>;
     getById(contractId: string): Promise<SubscriptionContractRecord>;
     findActiveByTenantId(tenantId: string, asOf?: Date): Promise<SubscriptionContractRecord | null>;
     getActiveInvoiceSnapshotForTenant(tenantId: string, asOf?: Date): Promise<SubscriptionContractInvoiceSnapshot>;
-    create(data: CreateSubscriptionContractData): Promise<SubscriptionContractRecord>;
+    /**
+     * Writes the contract between the tenant's subscriber and the issuer
+     * `config/saas.yaml` names, copying both as they stand. With `tx`, the
+     * contract is written on that transaction and undone with it, and the
+     * subscriber is read there too — so one created earlier on the same
+     * transaction is found.
+     *
+     * Refused with `SUBSCRIBER_REQUIRED` for a tenant without a subscriber:
+     * nothing is agreed without the party to it.
+     */
+    create(data: CreateSubscriptionContractData, tx?: TransactionContext): Promise<SubscriptionContractRecord>;
+    /**
+     * Refuses, with `SUBSCRIBER_REQUIRED`, a contract this tenant could not
+     * have. For callers that change something before the contract is written —
+     * closing the one in force, changing a plan — and must refuse before that
+     * rather than after.
+     */
+    assertPartyFor(tenantId: string, tx?: TransactionContext): Promise<void>;
+    /** The contract concluded from a checkout offer, or `null` when none was. */
+    findByOriginalOfferId(offerId: string, tx?: TransactionContext): Promise<SubscriptionContractRecord | null>;
     terminate(contractId: string, data: TerminateSubscriptionContractData): Promise<SubscriptionContractRecord>;
     replaceActiveContract(tenantId: string, data: CreateSubscriptionContractData, terminateAt: Date): Promise<{
         previous: SubscriptionContractRecord | null;
         next: SubscriptionContractRecord;
     }>;
     createDataFromOffer(offer: CheckoutOfferRow, options: CreateContractFromOfferOptions): CreateSubscriptionContractData;
+    /**
+     * The contract an offer becomes, checked the way `create` checks it, before
+     * anything is written. Unlike `createDataFromOffer` it takes an offer that
+     * is still open: concluding an offer refuses a contract it could not create
+     * before the offer is consumed, rather than after.
+     */
+    prepareFromOffer(offer: CheckoutOfferRow, options: CreateContractFromOfferOptions): CreateSubscriptionContractData;
+    private dataFromOffer;
     createFromOffer(offer: CheckoutOfferRow, options: CreateContractFromOfferOptions): Promise<SubscriptionContractRecord>;
     private lineItemsFromOffer;
     private offerLineItemToContractLineItem;