@opencxh/domain 1.303.0 → 1.304.0

package/dist/entities/agreement/types.d.ts

@@ -145,9 +145,10 @@ export interface AgreementLine {
     billingStart?: BillingStart;
     /** Set by fulfilment, never by a person: the first day it ran. A resume does not move it. */
     activatedAt?: number;
-    /** From the quote line (047 step 8): what the provider asked, and the check made with it. */
-    answers?: Record<string, string>;
-    qualificationId?: string;
+    /** From the quote line (plan 053): see {@link SalesLine.configurationId}. */
+    configurationId?: string;
+    /** A sub-line of that configuration: the answer it comes from (see `SalesLine.optionKey`). */
+    optionKey?: string;
 }
 export type LineBilling = "advance" | "arrears";
 /** When a line starts billing: on its dates, or once what it sells runs (047 §10.2). */

package/dist/entities/catalog/pricing.d.ts

@@ -3,7 +3,7 @@ import { PricePer } from '../money/period-price';
 import { SalesLine } from '../transaction/types';
 import { PriceRule, SellableProduct } from './types';
 /** What the ladder reads of an article: its identity and sales' price row. */
-export type PricedProduct = Pick<SellableProduct, "id" | "categoryKey" | "listPriceCents" | "currency" | "pricePer" | "rateCardId">;
+export type PricedProduct = Pick<SellableProduct, "id" | "categoryKey" | "listPriceCents" | "currency" | "pricePer" | "rateCardId" | "markupPercent">;
 /**
  * The ladder: the most specific rule wins, whole. No sum, no stacking.
  *
@@ -30,6 +30,8 @@ export interface PriceContext {
     quantity: number;
     /** Epoch ms; the validity window is judged against this, not against "now". */
     at: number;
+    /** What one unit costs us, for a `markupPercent` article (from the line's configuration). */
+    costCents?: Cents;
 }
 /** Amount, currency and period travel together: € 222 means nothing without "per year". */
 export interface ResolvedPrice {

package/dist/entities/catalog/types.d.ts

@@ -147,6 +147,11 @@ export interface SalesProduct {
     pricing?: ProductPricing;
     /** The default card of a `rated` product. A price agreement may name another. */
     rateCardId?: string;
+    /**
+     * Priced as cost plus this percentage instead of a list price (plan 053: an extra EVC costs us
+     * anything from € 4 to € 397). The line's cost comes from its configuration; no cost = no price.
+     */
+    markupPercent?: number;
     /** The unit a new line starts in (a box); absent = the base unit. */
     unitKey?: string;
     updatedAt?: number;

package/dist/entities/fulfilment/configuration.d.ts

@@ -0,0 +1,99 @@
+import { AnswerSpec, OfferRef, Preparation, ProvisioningAnswers, Requirement, RequirementGate } from '../../platform/provisioning';
+import { Commitment, LineRhythm } from '../agreement/types';
+/**
+ * One article configured for one customer (plan 053): the answers, the offer chosen and what the
+ * provider last said. Sales carries only its id; fulfilment freezes the answers into the request.
+ */
+export interface Configuration {
+    id: string;
+    organizationId: string;
+    businessEntityId: string;
+    customerCompanyId: string;
+    productId: string;
+    /** The offer it is bought through; its `sku` follows the `main` answer. */
+    ref?: OfferRef;
+    supplierOfferId?: string;
+    answers: ProvisioningAnswers;
+    preparation?: Preparation;
+    preparedAt?: number;
+    createdBy: string;
+    updatedAt: number;
+}
+export type ConfigurationStatus = "open" | "ready" | "expired";
+/** "Via leverancier" (plan 053): a provider whose flow asks something, and what it starts with. */
+export interface SupplierFlow {
+    app: string;
+    label: string;
+    asks: AnswerSpec[];
+    productIds: string[];
+}
+/** Step 1, one article on the answers so far: can it be delivered, and from what cost. */
+export interface ArticleCheck {
+    productId: string;
+    supplierOfferId: string;
+    available: boolean;
+    /** The first unmet condition's reason; absent when only questions are left. */
+    reason?: string;
+    /** The cheapest main option, per month where it recurs. Internal: colleagues only. */
+    fromCents?: number;
+    labels: string[];
+}
+/** One line a configuration sells, with the upsell article it becomes — or none yet. */
+export interface ConfiguredSale {
+    /** The answer it comes from; absent for the main line. */
+    optionKey?: string;
+    label: string;
+    sku: string;
+    quantity: number;
+    costCents?: number;
+    recurring?: "month";
+    /** Our article: the configured one for the main line, the upsell rule's for a sub-line. */
+    productId?: string;
+    commitment?: Partial<Commitment>;
+}
+export interface ConfigurationView {
+    configuration: Configuration;
+    status: ConfigurationStatus;
+    sales: ConfiguredSale[];
+}
+/** What still stands in the way of `gate`: at `order`, the quote's requirements count too. */
+export declare function blockersOf(preparation: Preparation, gate: RequirementGate): Requirement[];
+/** Ready for `gate` when prepared, not expired and nothing blocks it. */
+export declare function configurationStatus(config: Pick<Configuration, "preparation">, gate: RequirementGate, now: number): ConfigurationStatus;
+/** A chosen product: the main line's or one add-on's. Cost is per unit, internal. */
+export interface ConfiguredLine {
+    /** The answer it comes from (`evc_2`, `sla`). */
+    key: string;
+    /** As the provider names it: what an upsell article's match reads. */
+    label: string;
+    sku: string;
+    quantity: number;
+    costCents?: number;
+    recurring?: "month";
+    commitment?: Partial<Commitment>;
+    billedEvery?: LineRhythm;
+}
+/**
+ * What the answers buy: the supplier's product for the main line, and one sub-line per add-on
+ * taken (decided 05-10: an add-on is its own sales line). A `no` or a `0` is no line.
+ */
+export declare function linesOf(preparation: Preparation, answers: ProvisioningAnswers): {
+    main?: ConfiguredLine;
+    addons: ConfiguredLine[];
+};
+/** The offer as bought: the chosen main product becomes its sku, its option's commitment ours. */
+export declare function chosenOf(ref: OfferRef, preparation: Preparation, answers: ProvisioningAnswers): {
+    ref: OfferRef;
+    commitment?: Partial<Commitment>;
+    billedEvery?: LineRhythm;
+};
+/**
+ * The answers that go out, frozen on the request: only keys the provider asked for, its own
+ * proposal where nobody typed one. A stray key never reaches the supplier.
+ */
+export declare function orderAnswers(preparation: Preparation, answers: ProvisioningAnswers): ProvisioningAnswers;
+/**
+ * An exclusive item configured per unit (plan 053 G2: ten SIMs, ten numbers to port): one set of
+ * answers per unit, the shared ones copied, the `perUnit` ones from `perUnitValues` in order.
+ */
+export declare function splitUnits(preparation: Preparation, answers: ProvisioningAnswers, quantity: number, perUnitValues?: Record<string, string[]>): ProvisioningAnswers[];

package/dist/entities/fulfilment/configuration.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/entities/fulfilment/index.d.ts

@@ -1,4 +1,5 @@
 export * from './adopt';
+export * from './configuration';
 export * from './customers';
 export * from './execute';
 export * from './goods';

package/dist/entities/fulfilment/target.d.ts

@@ -78,7 +78,8 @@ export declare function draftRequest(input: {
     /** What was asked on the sale (047 step 8): the item's own purchase carries it. */
     answers?: {
         params: Record<string, string>;
-        qualificationId?: string;
+        configurationId?: string;
+        termMonths?: number;
     };
     revision: string;
     requestedBy: string;
@@ -118,7 +119,8 @@ export declare function planFor(input: {
     /** The sale's answers, for the item's own request only: what it needs is made without them. */
     answers?: {
         params: Record<string, string>;
-        qualificationId?: string;
+        configurationId?: string;
+        termMonths?: number;
     };
     revision: string;
     requestedBy: string;

package/dist/entities/fulfilment/types.d.ts

@@ -1,4 +1,4 @@
-import { ProvidedResource, ProviderQualification, ProvisioningAction, ProvisioningCommand, ProvisioningResult } from '../../platform/provisioning';
+import { ProvidedResource, ProvisioningAction, ProvisioningCommand, ProvisioningResult } from '../../platform/provisioning';
 import { DeliverTo } from '../purchase/types';
 /**
  * What runs at or for a customer (plan 047 v2): a subscription, an account, a bought number, one
@@ -36,6 +36,8 @@ export interface ProvisionedItem {
     at?: {
         app: string;
         offer?: string;
+        /** The supplier offer it is bought on (`SupplierOffer.id`): what "Te bestellen" orders. */
+        offerId?: string;
         externalRef?: string;
         fulfillment?: Record<string, string>;
     };
@@ -136,8 +138,8 @@ export interface ProvisioningRequest {
     app: string;
     offer: string;
     params: Record<string, string>;
-    /** The delivery check the sale was made on (047 step 8); its answers are in `params`. */
-    qualificationId?: string;
+    /** The configuration the sale was made on (plan 053); its answers are in `params`. */
+    configurationId?: string;
     /** Bound by role from what the item requires, then checked by kind (§10.1). */
     inputs?: {
         role: string;
@@ -289,33 +291,3 @@ export interface Delivery {
     carrier?: string;
     trackingNumber?: string;
 }
-/**
- * Deliverable here, before the promise (047 step 8, TMF679): the answers asked for one article,
- * what each provider said (`perOffer`, with cost: internal) and that answer in our own assortment
- * (`products`: the only part a customer may see). No address field: `site` is a crm address id.
- */
-export interface Qualification {
-    id: string;
-    organizationId: string;
-    businessEntityId: string;
-    productId: string;
-    params: Record<string, string>;
-    perOffer: OfferQualification[];
-    products: QualifiedProduct[];
-    expiresAt: number;
-    createdBy: string;
-    at: number;
-}
-export type OfferQualification = ProviderQualification & {
-    app: string;
-    offer: string;
-};
-export interface QualifiedProduct {
-    productId: string;
-    available: boolean;
-    /** A code, never the supplier's words: `unavailable` or `no_answer`. */
-    reason?: "unavailable" | "no_answer";
-}
-/** What leaves fulfilment for a person or a portal: never the suppliers, networks or costs. */
-export type QualificationView = Omit<Qualification, "perOffer">;
-export declare const qualificationView: ({ perOffer: _, ...view }: Qualification) => QualificationView;

package/dist/entities/purchase/choose.d.ts

@@ -10,9 +10,14 @@ export interface OfferNeed {
     /** `own` through our warehouse, anything else straight to the customer. */
     deliverTo?: DeliverTo["kind"];
     /** The delivery check the sale was made on: only what it found available qualifies (6c). */
+    /**
+     * The offers a delivery check found deliverable. `vendorSku` tells products apart that share
+     * one provider offer (every Nextpertise connection is `connection`, 045 D N-4).
+     */
     qualified?: readonly {
         app: string;
         offer: string;
+        vendorSku?: string;
     }[];
     /** The administration's currency; prices in another one need `rates`. */
     currency: string;

package/dist/entities/purchase/demand.d.ts

@@ -39,6 +39,8 @@ export interface DemandItem {
         warnings?: string[];
     };
     costUnknown?: boolean;
+    /** The term it is ordered for: the offer's, else the sale's (045 D N-3). The price is asked on it. */
+    termMonths?: number;
     /** The request's answers (the site as a crm address id): what a per-order price is asked on. */
     params?: Record<string, string>;
     /** The request this waits for: the customer's account before its numbers. */

package/dist/entities/purchase/index.d.ts

@@ -7,3 +7,4 @@ export * from './logic';
 export * from './match';
 export * from './packing-slip';
 export * from './types';
+export * from './upsell';

package/dist/entities/purchase/types.d.ts

@@ -1,9 +1,27 @@
-import { ProvisioningAction, ProvisioningState } from '../../platform/provisioning';
+import { ProvisioningAction, ProvisioningAnswers, ProvisioningState } from '../../platform/provisioning';
 import { LineRhythm } from '../agreement/types';
 import { Cents } from '../money/money';
 import { PricePer } from '../money/period-price';
 import { PostalAddress } from '../organization/types';
 import { Transaction, TransactionLine } from '../transaction/types';
+/** How an offer is ordered through an app, and what of that app's assortment it stands for. */
+export interface OfferProvider {
+    app: string;
+    offer: string;
+    /**
+     * The article as a filter (plan 053): fixed answers in this provider's own words
+     * (`technology: fiber`, `min_download: 1000`). They go to `prepare` with every other answer.
+     */
+    answers?: ProvisioningAnswers;
+    /**
+     * An upsell article: which of the provider's options it sells — by answer key (`evc_*` is every
+     * circuit) and option key or label (`24x7`); no `match` = every option of that answer.
+     */
+    option?: {
+        answer: string;
+        match?: string;
+    };
+}
 /**
  * What a supplier asks for a product: one row per supplier and product (and validity window).
  * The default offer is the product's cost price; the rest are the alternatives a buyer compares.
@@ -55,10 +73,7 @@ export interface SupplierOffer {
      * Ordered through an app instead of by mail (fase 9). Where it lands is not the offer's to say:
      * the provider of that platform declares what it needs (047 v2 §2.3).
      */
-    provider?: {
-        app: string;
-        offer: string;
-    };
+    provider?: OfferProvider;
     /** The supplier's advised price (the Microsoft ERP price), from a feed (plan 045 G). */
     listCents?: Cents;
     /** The last known stock; only the latest, no history (plan 045 B.1). */

package/dist/entities/purchase/upsell.d.ts

@@ -0,0 +1,20 @@
+import { OfferProvider, SupplierOffer } from './types';
+/** One option a configuration took, as its provider named it. */
+export interface TakenOption {
+    /** The answer it comes from: `evc_2`, `sla`, `cpe`. */
+    answer: string;
+    /** The provider's own option key (`608`) and label (`24x7`). */
+    key: string;
+    label: string;
+}
+/**
+ * Whether an upsell article's rule covers an option (plan 053): the answer by name, or every
+ * numbered one with a trailing `*` (`evc_*`); then the option by key or label, or any.
+ */
+export declare function sellsOption(rule: OfferProvider["option"], option: TakenOption): boolean;
+/**
+ * The upsell article that sells this option at this provider, or none: then a colleague is told
+ * "no sales article linked" and nothing is sold without a price. The exact match wins over a
+ * catch-all (`SLA 24x7` over a rule for every SLA).
+ */
+export declare function upsellOfferFor(offers: readonly SupplierOffer[], app: string, option: TakenOption): SupplierOffer | undefined;

package/dist/entities/purchase/upsell.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/entities/transaction/types.d.ts

@@ -298,12 +298,17 @@ export interface SalesLine extends TransactionLine {
         lineId: string;
     };
     /**
-     * The answers to what a provider asks before the promise (047 step 8), by param key; an address
-     * is a crm address id (`site: "<addressId>"`). Travel to the agreement and the request.
+     * Ordered through a supplier (plan 053): fulfilment's `Configuration` holds the answers, the
+     * offer chosen and what the supplier said. Sales carries only the id; it travels to the
+     * agreement and the request. Never on the paper.
      */
-    answers?: Record<string, string>;
-    /** The delivery check made with those answers (fulfilment's `Qualification`). */
-    qualificationId?: string;
+    configurationId?: string;
+    /**
+     * A sub-line of that configuration (an extra EVC, a paid SLA): the answer it comes from
+     * (`evc_2`). The main line has the same `configurationId` and no `optionKey`. Billed as its
+     * own line, ordered as part of the main one.
+     */
+    optionKey?: string;
 }
 export interface TransactionTotals {
     netCents: Cents;