@endora-commerce/mod-price-lists 0.100.0

package/dist/backend/services/pricing-service.interface.d.ts

@@ -0,0 +1,151 @@
+import type { DisplayMode, ListingPrice, ListingPriceOrderChunk, ListingPriceOrderQuery, ListingPriceViewerContext } from '@endora-commerce/contracts';
+import type { PriceBracketRow } from './price-bracket-resolver.js';
+/**
+ * The product a price is resolved for, as this engine reads it (feature 075
+ * Phase C).
+ *
+ * It used to be `catalog`'s `Product` **entity**, and that was two problems in
+ * one specifier: this module could not compile without `catalog`, and the
+ * contract an overlay decoration is written against named a class the overlay
+ * had no business seeing. The engine reads exactly two fields — the id it keys
+ * every bracket lookup on, and the legacy price attribute the listing chain
+ * falls back to — so those two are what it asks for.
+ *
+ * Narrowing is what makes this a cut rather than a rename: a `Product` entity
+ * and a `CatalogProductRecord` are both assignable here, and nothing wider is
+ * reachable from inside the engine.
+ */
+export interface PricedProductRef {
+    id: string;
+    /** JSONB `{ attributeKey: value }` — the legacy `defaultPrice` / `price`. */
+    attributeValues: Record<string, unknown>;
+}
+/**
+ * The buying organisation, as this engine reads it. Two fields: the id (a rule
+ * dimension and part of the cache key) and the group it belongs to, which a
+ * customer's own group overrides when set.
+ */
+export interface PricingOrganizationRef {
+    id: string;
+    /**
+     * Optional, and it has to be: `organizations` declares the column
+     * `customerGroupId?: string | null` and the published `OrganizationRecord`
+     * declares it `string | null`, so the narrow shape has to admit both. Every
+     * read of it here is `?? null`.
+     */
+    customerGroupId?: string | null;
+}
+/** The resolution context shared by both pricing entry points. */
+export interface PricingResolutionInput {
+    product: PricedProductRef;
+    variantId?: string | null;
+    context: {
+        quantity: number;
+        organization?: PricingOrganizationRef | null;
+        /** Feature 040 — customer's direct group overrides the org's (R6). */
+        customerGroupId?: string | null;
+        /** The request's resolved sales channel (only `id` + `defaultCurrency` read). */
+        salesChannel: {
+            id: string;
+            defaultCurrency: string;
+        };
+        currencyCode?: string;
+    };
+}
+export interface PricingEngineResult {
+    base: {
+        listId: string;
+        listName: string;
+        bracket: PriceBracketRow | null;
+    };
+    sale: {
+        listId: string;
+        listName: string;
+        bracket: PriceBracketRow;
+    } | null;
+    displayMode: DisplayMode;
+    currencyCode: string;
+}
+export interface PricingLineResult {
+    amount: string;
+    currency: string;
+    priceListId: string;
+    isSale: boolean;
+    bracketStartQuantity: number;
+    displayMode: DisplayMode;
+}
+/**
+ * The context a catalogue listing prices in. Quantity is fixed at 1 — a listing
+ * card, a search hit, a comparison column and a related-product tile all quote
+ * the unit price — so it is not part of the input.
+ */
+export interface ListingPricesInput {
+    products: readonly PricedProductRef[];
+    context: {
+        organization?: PricingOrganizationRef | null;
+        /** Feature 040 — customer's direct group overrides the org's (R6). */
+        customerGroupId?: string | null;
+        salesChannel: {
+            id: string;
+            defaultCurrency: string;
+        };
+        currencyCode?: string;
+    };
+}
+export interface PricingServiceContract {
+    resolveEngine(input: PricingResolutionInput): Promise<PricingEngineResult>;
+    resolveLinePrice(input: PricingResolutionInput): Promise<PricingLineResult | null>;
+    /**
+     * Issue #132 — the price a catalogue listing may render, per product, keyed
+     * by product id. Every requested product gets an entry; a product nothing
+     * priced gets the `none` arm rather than being missing from the map, so a
+     * caller cannot mistake "not asked about" for "no price".
+     *
+     * This is the whole chain (applicable list → the product's own price →
+     * nothing) behind one call, so a listing path cannot implement a step of it
+     * differently. Four of them did, which is what the issue reports.
+     */
+    resolveListingPrices(input: ListingPricesInput): Promise<Map<string, ListingPrice>>;
+    /**
+     * The lowest-quantity bracket amount on one **named** price list, per
+     * product, for callers that use a list verbatim rather than resolving it
+     * (a product feed pinned to a list — feature 067, FR-020). Products with no
+     * bracket on that list are absent from the map.
+     *
+     * It exists so that reading a named list is a port call rather than a raw
+     * `select` against `price_list_price_brackets` from another module: the
+     * table is this module's, and the port is what makes an absent owner refuse
+     * instead of a feed publishing prices the platform is not serving.
+     */
+    namedListPrices(input: {
+        priceListId: string;
+        currencyCode: string;
+        productIds: readonly string[];
+    }): Promise<Map<string, string>>;
+    /**
+     * Feature 062 — distinct bracket start quantities (ascending) across every
+     * ACTIVE price list for a (product, currency). The external catalog detail
+     * probes `resolveLinePrice` at each returned quantity to build the caller
+     * org's effective tier ladder without re-implementing resolution.
+     */
+    listBracketMinQuantities(productId: string, currencyCode: string): Promise<number[]>;
+    /**
+     * Feature 086 — the catalogue in resolved-unit-price order, for one viewer,
+     * one chunk at a time. Published as the `ListingPriceOrderPort` slice of the
+     * `pricingService` container, so an overlay decoration has to satisfy it in
+     * order to stay assignable here.
+     *
+     * The three methods below are the whole of the listing-ordering surface. They
+     * read this module's own tables and know nothing about visibility, channels
+     * or the buyer's category filter; the caller intersects.
+     */
+    orderByUnitPrice(input: ListingPriceOrderQuery): Promise<ListingPriceOrderChunk>;
+    pricedProductIds(input: {
+        context: ListingPriceViewerContext;
+        productIds: readonly string[];
+    }): Promise<ReadonlySet<string>>;
+    pageDisplayMode(input: {
+        context: ListingPriceViewerContext;
+    }): Promise<DisplayMode>;
+}
+//# sourceMappingURL=pricing-service.interface.d.ts.map

package/dist/backend/services/pricing-service.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"pricing-service.interface.d.ts","sourceRoot":"","sources":["../../../src/backend/services/pricing-service.interface.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EACV,WAAW,EACX,YAAY,EACZ,sBAAsB,EACtB,sBAAsB,EACtB,yBAAyB,EAC1B,MAAM,4BAA4B,CAAC;AACpC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAEnE;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,6EAA6E;IAC7E,eAAe,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC1C;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACrC,EAAE,EAAE,MAAM,CAAC;IACX;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACjC;AAED,kEAAkE;AAClE,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,gBAAgB,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,OAAO,EAAE;QACP,QAAQ,EAAE,MAAM,CAAC;QACjB,YAAY,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;QAC7C,sEAAsE;QACtE,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAChC,iFAAiF;QACjF,YAAY,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,eAAe,EAAE,MAAM,CAAA;SAAE,CAAC;QACtD,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;CACH;AAED,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,eAAe,GAAG,IAAI,CAAA;KAAE,CAAC;IAC5E,IAAI,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,eAAe,CAAA;KAAE,GAAG,IAAI,CAAC;IAC5E,WAAW,EAAE,WAAW,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,OAAO,CAAC;IAChB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,WAAW,EAAE,WAAW,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACtC,OAAO,EAAE;QACP,YAAY,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;QAC7C,sEAAsE;QACtE,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAChC,YAAY,EAAE;YAAE,EAAE,EAAE,MAAM,CAAC;YAAC,eAAe,EAAE,MAAM,CAAA;SAAE,CAAC;QACtD,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;CACH;AAED,MAAM,WAAW,sBAAsB;IACrC,aAAa,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC3E,gBAAgB,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAC;IACnF;;;;;;;;;OASG;IACH,oBAAoB,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC;IACpF;;;;;;;;;;OAUG;IACH,eAAe,CAAC,KAAK,EAAE;QACrB,WAAW,EAAE,MAAM,CAAC;QACpB,YAAY,EAAE,MAAM,CAAC;QACrB,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;KAC/B,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACjC;;;;;OAKG;IACH,wBAAwB,CAAC,SAAS,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IACrF;;;;;;;;;OASG;IACH,gBAAgB,CAAC,KAAK,EAAE,sBAAsB,GAAG,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACjF,gBAAgB,CAAC,KAAK,EAAE;QACtB,OAAO,EAAE,yBAAyB,CAAC;QACnC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC;KAC/B,GAAG,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;IACjC,eAAe,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,yBAAyB,CAAA;KAAE,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CACtF"}

package/dist/backend/services/pricing-service.interface.js

@@ -0,0 +1,10 @@
+// Formalized contract for the price-list pricing engine (feature 057, R4).
+//
+// This is the documented interface an overlay MUST satisfy to override the core
+// `PricingService` for a deployment. It captures exactly the surface consumers
+// depend on — `resolveEngine` and `resolveLinePrice` — so an overlay can replace
+// the implementation and every consumer keeps type-checking. The core class
+// `implements` this interface, so if the interface changes, a stale overlay
+// stops being assignable and the build fails (contract drift = build error).
+export {};
+//# sourceMappingURL=pricing-service.interface.js.map

package/dist/backend/services/pricing-service.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"pricing-service.interface.js","sourceRoot":"","sources":["../../../src/backend/services/pricing-service.interface.ts"],"names":[],"mappings":"AAAA,2EAA2E;AAC3E,EAAE;AACF,gFAAgF;AAChF,+EAA+E;AAC/E,iFAAiF;AACjF,4EAA4E;AAC5E,4EAA4E;AAC5E,6EAA6E"}