pricing-renderer 0.1.0 → 0.2.0

package/custom-elements.json

@@ -38,6 +38,19 @@
               "name": "defaultSelection",
               "type": { "text": "Partial<PricingSelection>" }
             },
+            {
+              "kind": "field",
+              "name": "currentSelection",
+              "type": { "text": "Partial<PricingSelection> | undefined" },
+              "description": "The customer's current contract. Marks the current plan and add-ons, and labels the other plans' calls to action as upgrades or downgrades. It does not change the selection in effect and emits no pricing-selection-change. The element keeps a deep copy."
+            },
+            {
+              "kind": "field",
+              "name": "pendingActionId",
+              "type": { "text": "string | undefined" },
+              "attribute": "pending-action-id",
+              "description": "Action id of the call to action whose work the host is doing. That control shows a busy state, every plan call to action and the summary action get aria-disabled, and activating them dispatches no pricing-action."
+            },
             {
               "kind": "field",
               "name": "presentation",
@@ -91,28 +104,245 @@
               "type": { "text": "\"light\" | \"dark\" | \"auto\"" },
               "attribute": "theme"
             },
+            {
+              "kind": "field",
+              "name": "density",
+              "type": { "text": "\"comfortable\" | \"compact\"" },
+              "attribute": "density"
+            },
             {
               "kind": "field",
               "name": "loadingLabel",
               "type": { "text": "string" },
               "attribute": "loading-label"
             },
+            {
+              "kind": "field",
+              "name": "onlyDifferences",
+              "type": { "text": "boolean | undefined" },
+              "attribute": "only-differences",
+              "description": "Initial state of the Only differences checkbox of the comparison toolbar. Absent is automatic (on when the pricing has more than 100 comparison rows, at least 2 plans and the toolbar is shown, otherwise off), present or any value except \"false\" is on, \"false\" is off."
+            },
+            {
+              "kind": "field",
+              "name": "toolbarThreshold",
+              "type": { "text": "number" },
+              "attribute": "toolbar-threshold",
+              "description": "The toolbar is shown when the pricing has more than this many comparison rows (default 40). Invalid or negative values fall back to 40."
+            },
+            {
+              "kind": "field",
+              "name": "addOnFilterThreshold",
+              "type": { "text": "number" },
+              "attribute": "add-on-filter-threshold",
+              "description": "The add-on grid switches to filter mode (search, counter and a cap of 8 initial cards, selected add-ons are never hidden) when the pricing has more add-ons than this (default 13). Invalid or negative values fall back to 13."
+            },
+            {
+              "kind": "field",
+              "name": "hideSections",
+              "type": { "text": "readonly PricingSectionName[] | undefined" },
+              "attribute": "hide-sections",
+              "description": "Sections that are not rendered: hero, metadata, billing, variables, plans, comparison, addOns, summary. The attribute is a whitespace separated list; tokens that are not section names are ignored. Hiding the hero keeps a visually hidden title that labels the renderer. Hiding the add-ons keeps the summary."
+            },
+            {
+              "kind": "field",
+              "name": "slots",
+              "type": { "text": "readonly PricingSlotName[] | undefined" },
+              "description": "Slots the host fills: plan-cta, summary-actions, loading, error. For each requested slot the element renders an empty div with data-pr-slot and the state as data-* attributes, in place of the built-in control, and reports the nodes with pricing-slots-change. A value that is not an array, and names that are not slot names, are ignored. No attribute."
+            },
+            {
+              "kind": "field",
+              "name": "resolvedState",
+              "type": { "text": "PricingSelectionChangeDetail | undefined" },
+              "readonly": true,
+              "description": "Detached snapshot of the selection in effect and its resolved pricing, or undefined while the element is not ready. It resolves the pricing on every read: read it on events, not in a render loop."
+            },
             {
               "kind": "method",
               "name": "reload",
               "return": { "type": { "text": "Promise<void>" } }
+            },
+            {
+              "kind": "method",
+              "name": "applySelection",
+              "parameters": [
+                {
+                  "name": "selection",
+                  "type": { "text": "Partial<PricingSelection>" }
+                }
+              ],
+              "return": { "type": { "text": "ApplySelectionResult" } },
+              "description": "Validates the selection against the loaded pricing and replaces the internal selection. Omitted fields take the schema defaults. Emits no pricing-selection-change. Refused by result (applied: false) while the element is not ready or when the selection property is set."
+            },
+            {
+              "kind": "method",
+              "name": "triggerPlanAction",
+              "parameters": [{ "name": "planId", "type": { "text": "string" } }],
+              "return": { "type": { "text": "boolean" } },
+              "description": "Fires the pricing-action that activating the built-in CTA of this plan fires, and returns the result of dispatchEvent. Returns false, without an event, while pendingActionId is set, ctaEnabled is false, the element is not ready, the plans are hidden, the plan is not rendered or its CTA is disabled (the current plan)."
+            }
+          ],
+          "attributes": [
+            { "name": "src", "fieldName": "src", "type": { "text": "string" } },
+            { "name": "locale", "fieldName": "locale", "type": { "text": "string" } },
+            { "name": "pricing-path", "fieldName": "pricingPath", "type": { "text": "string" } },
+            {
+              "name": "mode",
+              "fieldName": "mode",
+              "type": { "text": "\"commercial\" | \"catalog\"" }
+            },
+            {
+              "name": "layout",
+              "fieldName": "layout",
+              "type": { "text": "\"auto\" | \"compact\" | \"table\"" }
+            },
+            {
+              "name": "visibility",
+              "fieldName": "visibility",
+              "type": { "text": "\"public-only\" | \"all\"" }
+            },
+            {
+              "name": "theme",
+              "fieldName": "theme",
+              "type": { "text": "\"light\" | \"dark\" | \"auto\"" }
+            },
+            {
+              "name": "density",
+              "fieldName": "density",
+              "type": { "text": "\"comfortable\" | \"compact\"" }
+            },
+            { "name": "loading-label", "fieldName": "loadingLabel", "type": { "text": "string" } },
+            {
+              "name": "only-differences",
+              "fieldName": "onlyDifferences",
+              "type": { "text": "boolean | undefined" }
+            },
+            {
+              "name": "toolbar-threshold",
+              "fieldName": "toolbarThreshold",
+              "type": { "text": "number" }
+            },
+            {
+              "name": "add-on-filter-threshold",
+              "fieldName": "addOnFilterThreshold",
+              "type": { "text": "number" }
+            },
+            {
+              "name": "hide-sections",
+              "fieldName": "hideSections",
+              "type": { "text": "readonly PricingSectionName[] | undefined" }
+            },
+            {
+              "name": "pending-action-id",
+              "fieldName": "pendingActionId",
+              "type": { "text": "string | undefined" }
             }
           ],
           "events": [
-            { "name": "pricing-ready", "type": { "text": "CustomEvent<PricingReadyDetail>" } },
+            {
+              "name": "pricing-ready",
+              "type": { "text": "CustomEvent<PricingReadyDetail>" },
+              "description": "Fired after a successful load. The detail has pricing, diagnostics, and the selection in effect and its resolved pricing as selection and resolved."
+            },
             {
               "name": "pricing-selection-change",
               "type": { "text": "CustomEvent<PricingSelectionChangeDetail>" }
             },
-            { "name": "pricing-action", "type": { "text": "CustomEvent<PricingActionDetail>" } },
+            {
+              "name": "pricing-action",
+              "type": { "text": "CustomEvent<PricingActionDetail>" },
+              "description": "Fired when a call to action is activated. While currentSelection names a plan of the pricing, the detail also has relation and source ('plan' or 'summary'). Cancelable; a canceled link does not navigate."
+            },
             {
               "name": "pricing-diagnostic",
-              "type": { "text": "CustomEvent<PricingDiagnosticDetail>" }
+              "type": { "text": "CustomEvent<PricingDiagnosticDetail>" },
+              "description": "Fired with the diagnostics of a load, after an applySelection call that returns diagnostics, including its PR_SELECTION_NOT_READY and PR_SELECTION_CONTROLLED refusals, and when currentSelection or the pricing changes and currentSelection has a plan or add-on id the pricing does not define (PR_CURRENT_SELECTION_UNKNOWN_PLAN, PR_CURRENT_SELECTION_UNKNOWN_ADDON). Check the diagnostic code before treating an error as a load failure."
+            },
+            {
+              "name": "pricing-slots-change",
+              "type": { "text": "CustomEvent<PricingSlotsChangeDetail>" },
+              "description": "Fired after an update when the slot nodes the element rendered (detail.nodes, in document order) or their data-* values changed, or, with a summary-actions node, when the selection or its resolved prices changed. Fired with an empty list when the slots go away. Bubbles, composed, not cancelable. Nodes of a nested renderer or added by the host are not listed."
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "kind": "javascript-module",
+      "path": "dist/element/change-review-element.js",
+      "declarations": [
+        {
+          "kind": "class",
+          "name": "PricingChangeReviewElement",
+          "customElement": true,
+          "tagName": "pricing-change-review",
+          "description": "The review of a subscription change: it shows the comparison of the customer's current subscription with the edit, and asks the host to confirm it. Registered by importing pricing-renderer/define-change-review.",
+          "members": [
+            {
+              "kind": "field",
+              "name": "comparison",
+              "type": { "text": "SelectionComparison | undefined" },
+              "description": "The result of compareSelections. Nothing is rendered while it is unset."
+            },
+            {
+              "kind": "field",
+              "name": "notices",
+              "type": { "text": "string[]" },
+              "description": "Notices from the host, rendered as text. Defaults to an empty list."
+            },
+            {
+              "kind": "field",
+              "name": "pending",
+              "type": { "text": "boolean" },
+              "attribute": "pending",
+              "description": "True while the host applies the change. Confirm ignores activations, and the attribute is reflected. Confirm sets it when pricing-change-confirm is not canceled."
+            },
+            {
+              "kind": "field",
+              "name": "error",
+              "type": { "text": "string | undefined" },
+              "attribute": "error",
+              "description": "A plain-text error message from the host, rendered as text."
+            },
+            {
+              "kind": "field",
+              "name": "locale",
+              "type": { "text": "string" },
+              "attribute": "locale"
+            },
+            {
+              "kind": "field",
+              "name": "messages",
+              "type": { "text": "MessageCatalog | undefined" }
+            },
+            {
+              "kind": "field",
+              "name": "confirmLabel",
+              "type": { "text": "string | undefined" },
+              "attribute": "confirm-label",
+              "description": "Replaces the text of the Confirm button (pricing.reviewConfirm)."
+            }
+          ],
+          "attributes": [
+            { "name": "pending", "fieldName": "pending", "type": { "text": "boolean" } },
+            { "name": "error", "fieldName": "error", "type": { "text": "string | undefined" } },
+            { "name": "locale", "fieldName": "locale", "type": { "text": "string" } },
+            {
+              "name": "confirm-label",
+              "fieldName": "confirmLabel",
+              "type": { "text": "string | undefined" }
+            }
+          ],
+          "events": [
+            {
+              "name": "pricing-change-confirm",
+              "type": { "text": "CustomEvent<PricingChangeConfirmDetail>" },
+              "description": "Fired when Confirm is activated while pending is false and the relation is not current. Cancelable. When it is not canceled, the element sets pending to true. The detail has a deep copy of the comparison."
+            },
+            {
+              "name": "pricing-change-back",
+              "type": { "text": "CustomEvent<PricingChangeBackDetail>" },
+              "description": "Fired when Back is activated. Cancelable, with no default action. The detail has a deep copy of the comparison."
             }
           ]
         }

package/dist/core/apply-selection.d.ts

@@ -0,0 +1,8 @@
+import type { NormalizedPricing, PricingDiagnostic, PricingSelection } from './types.js';
+export interface ApplySelectionInputResult {
+    selection: PricingSelection;
+    removedAddOnIds: string[];
+    diagnostics: PricingDiagnostic[];
+}
+export declare function applySelectionInput(pricing: NormalizedPricing, current: PricingSelection, input: Partial<PricingSelection>): ApplySelectionInputResult;
+//# sourceMappingURL=apply-selection.d.ts.map

package/dist/core/apply-selection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply-selection.d.ts","sourceRoot":"","sources":["../../src/core/apply-selection.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAEV,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,YAAY,CAAC;AAGpB,MAAM,WAAW,yBAAyB;IACxC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,WAAW,EAAE,iBAAiB,EAAE,CAAC;CAClC;AAED,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,iBAAiB,EAC1B,OAAO,EAAE,gBAAgB,EACzB,KAAK,EAAE,OAAO,CAAC,gBAAgB,CAAC,GAC/B,yBAAyB,CA6E3B"}

package/dist/core/apply-selection.js

@@ -0,0 +1,76 @@
+import { mergeSelection, normalizeAddOnQuantity, reconcileSelection } from './resolve.js';
+import { cloneValue, isRecord } from './utils.js';
+export function applySelectionInput(pricing, current, input) {
+    const copy = cloneValue(input);
+    const diagnostics = [];
+    const validated = {};
+    if (copy.planId !== undefined) {
+        if (pricing.plans.some((plan) => plan.id === copy.planId)) {
+            validated.planId = copy.planId;
+        }
+        else {
+            diagnostics.push({
+                code: 'PR_SELECTION_UNKNOWN_PLAN',
+                severity: 'warning',
+                message: `Unknown plan "${copy.planId}"; the current plan is kept.`,
+                path: 'selection.planId',
+            });
+            if (current.planId !== undefined)
+                validated.planId = current.planId;
+        }
+    }
+    if (copy.billingPeriod !== undefined) {
+        if (pricing.billing.some((period) => period.id === copy.billingPeriod)) {
+            validated.billingPeriod = copy.billingPeriod;
+        }
+        else {
+            diagnostics.push({
+                code: 'PR_SELECTION_UNKNOWN_BILLING_PERIOD',
+                severity: 'warning',
+                message: `Unknown billing period "${copy.billingPeriod}"; the current billing period is kept.`,
+                path: 'selection.billingPeriod',
+            });
+            if (current.billingPeriod !== undefined)
+                validated.billingPeriod = current.billingPeriod;
+        }
+    }
+    if (isRecord(copy.variables)) {
+        validated.variables = copy.variables;
+    }
+    if (isRecord(copy.addOns)) {
+        const inputAddOns = copy.addOns;
+        const addOns = {};
+        for (const id of Object.keys(inputAddOns)) {
+            const entry = inputAddOns[id];
+            if (!pricing.addOns.some((addOn) => addOn.id === id)) {
+                diagnostics.push({
+                    code: 'PR_SELECTION_UNKNOWN_ADDON',
+                    severity: 'warning',
+                    message: `Unknown add-on "${id}"; it is ignored.`,
+                    path: `selection.addOns.${id}`,
+                });
+                continue;
+            }
+            // a known add-on without a plain-object entry counts as omitted: the default applies
+            if (!isRecord(entry))
+                continue;
+            const accepted = entry;
+            addOns[id] = entry.selected
+                ? { ...accepted, quantity: normalizeAddOnQuantity(pricing, id, accepted) }
+                : accepted;
+        }
+        validated.addOns = addOns;
+    }
+    const { selection, removedAddOnIds } = reconcileSelection(pricing, mergeSelection(pricing, validated));
+    for (const id of removedAddOnIds) {
+        diagnostics.push({
+            code: 'PR_SELECTION_ADDON_REMOVED',
+            severity: 'info',
+            message: `Add-on "${id}" is not available with the selected plan and was removed.`,
+            path: `selection.addOns.${id}`,
+            details: { addOnId: id },
+        });
+    }
+    return { selection, removedAddOnIds, diagnostics };
+}
+//# sourceMappingURL=apply-selection.js.map

package/dist/core/apply-selection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apply-selection.js","sourceRoot":"","sources":["../../src/core/apply-selection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAO1F,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAQlD,MAAM,UAAU,mBAAmB,CACjC,OAA0B,EAC1B,OAAyB,EACzB,KAAgC;IAEhC,MAAM,IAAI,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;IAC/B,MAAM,WAAW,GAAwB,EAAE,CAAC;IAC5C,MAAM,SAAS,GAA8B,EAAE,CAAC;IAEhD,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC9B,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAC1D,SAAS,CAAC,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QACjC,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,IAAI,CAAC;gBACf,IAAI,EAAE,2BAA2B;gBACjC,QAAQ,EAAE,SAAS;gBACnB,OAAO,EAAE,iBAAiB,IAAI,CAAC,MAAM,8BAA8B;gBACnE,IAAI,EAAE,kBAAkB;aACzB,CAAC,CAAC;YACH,IAAI,OAAO,CAAC,MAAM,KAAK,SAAS;gBAAE,SAAS,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;QACtE,CAAC;IACH,CAAC;IAED,IAAI,IAAI,CAAC,aAAa,KAAK,SAAS,EAAE,CAAC;QACrC,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,IAAI,CAAC,aAAa,CAAC,EAAE,CAAC;YACvE,SAAS,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;QAC/C,CAAC;aAAM,CAAC;YACN,WAAW,CAAC,IAAI,CAAC;gBACf,IAAI,EAAE,qCAAqC;gBAC3C,QAAQ,EAAE,SAAS;gBACnB,OAAO,EAAE,2BAA2B,IAAI,CAAC,aAAa,wCAAwC;gBAC9F,IAAI,EAAE,yBAAyB;aAChC,CAAC,CAAC;YACH,IAAI,OAAO,CAAC,aAAa,KAAK,SAAS;gBAAE,SAAS,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC3F,CAAC;IACH,CAAC;IAED,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;QAC7B,SAAS,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;IACvC,CAAC;IAED,IAAI,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,MAAM,WAAW,GAA4B,IAAI,CAAC,MAAM,CAAC;QACzD,MAAM,MAAM,GAAmC,EAAE,CAAC;QAClD,KAAK,MAAM,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC;YAC1C,MAAM,KAAK,GAAG,WAAW,CAAC,EAAE,CAAC,CAAC;YAC9B,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;gBACrD,WAAW,CAAC,IAAI,CAAC;oBACf,IAAI,EAAE,4BAA4B;oBAClC,QAAQ,EAAE,SAAS;oBACnB,OAAO,EAAE,mBAAmB,EAAE,mBAAmB;oBACjD,IAAI,EAAE,oBAAoB,EAAE,EAAE;iBAC/B,CAAC,CAAC;gBACH,SAAS;YACX,CAAC;YACD,qFAAqF;YACrF,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC;gBAAE,SAAS;YAC/B,MAAM,QAAQ,GAAG,KAAkC,CAAC;YACpD,MAAM,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,QAAQ;gBACzB,CAAC,CAAC,EAAE,GAAG,QAAQ,EAAE,QAAQ,EAAE,sBAAsB,CAAC,OAAO,EAAE,EAAE,EAAE,QAAQ,CAAC,EAAE;gBAC1E,CAAC,CAAC,QAAQ,CAAC;QACf,CAAC;QACD,SAAS,CAAC,MAAM,GAAG,MAAM,CAAC;IAC5B,CAAC;IAED,MAAM,EAAE,SAAS,EAAE,eAAe,EAAE,GAAG,kBAAkB,CACvD,OAAO,EACP,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,CACnC,CAAC;IAEF,KAAK,MAAM,EAAE,IAAI,eAAe,EAAE,CAAC;QACjC,WAAW,CAAC,IAAI,CAAC;YACf,IAAI,EAAE,4BAA4B;YAClC,QAAQ,EAAE,MAAM;YAChB,OAAO,EAAE,WAAW,EAAE,4DAA4D;YAClF,IAAI,EAAE,oBAAoB,EAAE,EAAE;YAC9B,OAAO,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;SACzB,CAAC,CAAC;IACL,CAAC;IAED,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,WAAW,EAAE,CAAC;AACrD,CAAC"}

package/dist/core/breakdown.d.ts

@@ -0,0 +1,13 @@
+import type { NormalizedBillingPeriod, NormalizedPricing, PriceBreakdown, PricingSelection, ResolvedPrice } from './types.js';
+interface BreakdownInput {
+    pricing: NormalizedPricing;
+    selection: PricingSelection;
+    reconciled: PricingSelection;
+    planPrices: Record<string, ResolvedPrice>;
+    addOnPrices: Record<string, ResolvedPrice>;
+    billingPeriod: NormalizedBillingPeriod | undefined;
+    addOnQuantity: (addOnId: string) => number;
+}
+export declare function buildBreakdown(input: BreakdownInput): PriceBreakdown;
+export {};
+//# sourceMappingURL=breakdown.d.ts.map

package/dist/core/breakdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"breakdown.d.ts","sourceRoot":"","sources":["../../src/core/breakdown.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uBAAuB,EACvB,iBAAiB,EACjB,cAAc,EAEd,gBAAgB,EAChB,aAAa,EACd,MAAM,YAAY,CAAC;AAEpB,UAAU,cAAc;IACtB,OAAO,EAAE,iBAAiB,CAAC;IAC3B,SAAS,EAAE,gBAAgB,CAAC;IAC5B,UAAU,EAAE,gBAAgB,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC1C,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IAC3C,aAAa,EAAE,uBAAuB,GAAG,SAAS,CAAC;IACnD,aAAa,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,CAAC;CAC5C;AAyBD,wBAAgB,cAAc,CAAC,KAAK,EAAE,cAAc,GAAG,cAAc,CAuDpE"}

package/dist/core/breakdown.js

@@ -0,0 +1,56 @@
+function createLine(kind, id, name, quantity, billingMultiplier, price) {
+    const base = { kind, id, name, quantity, billingMultiplier };
+    if (price?.kind === 'amount') {
+        return {
+            ...base,
+            unitAmount: price.baseAmount,
+            amount: price.baseAmount * billingMultiplier * quantity,
+            requiresQuote: false,
+        };
+    }
+    if (price?.kind === 'label') {
+        return { ...base, requiresQuote: true, label: price.label };
+    }
+    return { ...base, requiresQuote: true };
+}
+export function buildBreakdown(input) {
+    const { pricing, selection, reconciled, planPrices, addOnPrices, billingPeriod } = input;
+    const billingMultiplier = billingPeriod?.multiplier ?? 1;
+    const plan = pricing.plans.find((candidate) => candidate.id === selection.planId);
+    const planLine = plan
+        ? createLine('plan', plan.id, plan.name, 1, billingMultiplier, planPrices[plan.id])
+        : undefined;
+    const addOns = pricing.addOns
+        .filter((addOn) => reconciled.addOns[addOn.id]?.selected)
+        .map((addOn) => createLine('addOn', addOn.id, addOn.name, input.addOnQuantity(addOn.id), billingMultiplier, addOnPrices[addOn.id]));
+    let subtotal = planLine?.amount ?? 0;
+    for (const line of addOns) {
+        if (line.amount !== undefined)
+            subtotal += line.amount;
+    }
+    const knownAddOnIds = new Set(pricing.addOns.map((addOn) => addOn.id));
+    const requiresQuote = planLine === undefined ||
+        planLine.requiresQuote ||
+        addOns.some((line) => line.requiresQuote) ||
+        Object.entries(reconciled.addOns).some(([id, state]) => state.selected && !knownAddOnIds.has(id));
+    return {
+        currency: pricing.metadata.currency,
+        ...(plan?.unit ? { unit: plan.unit } : {}),
+        ...(billingPeriod
+            ? {
+                billingPeriod: {
+                    id: billingPeriod.id,
+                    label: billingPeriod.label,
+                    multiplier: billingPeriod.multiplier,
+                    // carried through, so a consumer can tell an invented period from a real choice
+                    ...(billingPeriod.synthesized ? { synthesized: true } : {}),
+                },
+            }
+            : {}),
+        ...(planLine ? { plan: planLine } : {}),
+        addOns,
+        subtotal,
+        requiresQuote,
+    };
+}
+//# sourceMappingURL=breakdown.js.map

package/dist/core/breakdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"breakdown.js","sourceRoot":"","sources":["../../src/core/breakdown.ts"],"names":[],"mappings":"AAmBA,SAAS,UAAU,CACjB,IAAgC,EAChC,EAAU,EACV,IAAY,EACZ,QAAgB,EAChB,iBAAyB,EACzB,KAAgC;IAEhC,MAAM,IAAI,GAAG,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,iBAAiB,EAAE,CAAC;IAC7D,IAAI,KAAK,EAAE,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO;YACL,GAAG,IAAI;YACP,UAAU,EAAE,KAAK,CAAC,UAAU;YAC5B,MAAM,EAAE,KAAK,CAAC,UAAU,GAAG,iBAAiB,GAAG,QAAQ;YACvD,aAAa,EAAE,KAAK;SACrB,CAAC;IACJ,CAAC;IACD,IAAI,KAAK,EAAE,IAAI,KAAK,OAAO,EAAE,CAAC;QAC5B,OAAO,EAAE,GAAG,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,CAAC;IAC9D,CAAC;IACD,OAAO,EAAE,GAAG,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;AAC1C,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,KAAqB;IAClD,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,UAAU,EAAE,WAAW,EAAE,aAAa,EAAE,GAAG,KAAK,CAAC;IACzF,MAAM,iBAAiB,GAAG,aAAa,EAAE,UAAU,IAAI,CAAC,CAAC;IAEzD,MAAM,IAAI,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,SAAS,CAAC,MAAM,CAAC,CAAC;IAClF,MAAM,QAAQ,GAAG,IAAI;QACnB,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,EAAE,iBAAiB,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACnF,CAAC,CAAC,SAAS,CAAC;IAEd,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM;SAC1B,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,QAAQ,CAAC;SACxD,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACb,UAAU,CACR,OAAO,EACP,KAAK,CAAC,EAAE,EACR,KAAK,CAAC,IAAI,EACV,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC,EAC7B,iBAAiB,EACjB,WAAW,CAAC,KAAK,CAAC,EAAE,CAAC,CACtB,CACF,CAAC;IAEJ,IAAI,QAAQ,GAAG,QAAQ,EAAE,MAAM,IAAI,CAAC,CAAC;IACrC,KAAK,MAAM,IAAI,IAAI,MAAM,EAAE,CAAC;QAC1B,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS;YAAE,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC;IACzD,CAAC;IAED,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC;IACvE,MAAM,aAAa,GACjB,QAAQ,KAAK,SAAS;QACtB,QAAQ,CAAC,aAAa;QACtB,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC;QACzC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,IAAI,CACpC,CAAC,CAAC,EAAE,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAC1D,CAAC;IAEJ,OAAO;QACL,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC,QAAQ;QACnC,GAAG,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1C,GAAG,CAAC,aAAa;YACf,CAAC,CAAC;gBACE,aAAa,EAAE;oBACb,EAAE,EAAE,aAAa,CAAC,EAAE;oBACpB,KAAK,EAAE,aAAa,CAAC,KAAK;oBAC1B,UAAU,EAAE,aAAa,CAAC,UAAU;oBACpC,gFAAgF;oBAChF,GAAG,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,IAAa,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACrE;aACF;YACH,CAAC,CAAC,EAAE,CAAC;QACP,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACvC,MAAM;QACN,QAAQ;QACR,aAAa;KACd,CAAC;AACJ,CAAC"}

package/dist/core/compare-sides.d.ts

@@ -0,0 +1,16 @@
+import type { ExpressionOptions, PriceBreakdown, PricingDiagnostic, PricingSelection, SelectionComparisonSide } from './types.js';
+export type SideName = 'before' | 'after';
+export interface ComparedSideState {
+    /** Merged, sanitized, quantity-normalized and reconciled selection. */
+    selection: PricingSelection;
+    /** Ids the input selects, including ids the pricing does not define. */
+    requestedAddOnIds: Set<string>;
+    /** Add-ons that reconciliation deselected, in pricing declaration order. */
+    removedAddOnIds: string[];
+    breakdown: PriceBreakdown;
+    /** Unknown plan, billing period and add-on warnings, in that order. */
+    diagnostics: PricingDiagnostic[];
+}
+/** Decision 2, steps 1 to 5: derive one side without throwing. */
+export declare function deriveSide(name: SideName, side: SelectionComparisonSide, expression: ExpressionOptions | undefined): ComparedSideState;
+//# sourceMappingURL=compare-sides.d.ts.map

package/dist/core/compare-sides.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compare-sides.d.ts","sourceRoot":"","sources":["../../src/core/compare-sides.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAEV,iBAAiB,EACjB,cAAc,EACd,iBAAiB,EACjB,gBAAgB,EAChB,uBAAuB,EACxB,MAAM,YAAY,CAAC;AAGpB,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE1C,MAAM,WAAW,iBAAiB;IAChC,uEAAuE;IACvE,SAAS,EAAE,gBAAgB,CAAC;IAC5B,wEAAwE;IACxE,iBAAiB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC/B,4EAA4E;IAC5E,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,SAAS,EAAE,cAAc,CAAC;IAC1B,uEAAuE;IACvE,WAAW,EAAE,iBAAiB,EAAE,CAAC;CAClC;AA8BD,kEAAkE;AAClE,wBAAgB,UAAU,CACxB,IAAI,EAAE,QAAQ,EACd,IAAI,EAAE,uBAAuB,EAC7B,UAAU,EAAE,iBAAiB,GAAG,SAAS,GACxC,iBAAiB,CA4DnB"}

package/dist/core/compare-sides.js

@@ -0,0 +1,73 @@
+import { mergeSelection, normalizeAddOnQuantity, reconcileSelection, resolvePricing, } from './resolve.js';
+import { cloneValue, isRecord } from './utils.js';
+function jsonCopy(value) {
+    try {
+        const copy = JSON.parse(JSON.stringify(value));
+        return isRecord(copy) ? copy : {};
+    }
+    catch {
+        return {};
+    }
+}
+function readInput(selection) {
+    if (!isRecord(selection))
+        return {};
+    const input = {};
+    if (typeof selection.planId === 'string')
+        input.planId = selection.planId;
+    if (typeof selection.billingPeriod === 'string')
+        input.billingPeriod = selection.billingPeriod;
+    if (isRecord(selection.variables))
+        input.variables = jsonCopy(selection.variables);
+    if (isRecord(selection.addOns)) {
+        input.addOns = { ...selection.addOns };
+    }
+    return input;
+}
+const warning = (code, message, path) => ({
+    code,
+    severity: 'warning',
+    message,
+    path,
+});
+/** Decision 2, steps 1 to 5: derive one side without throwing. */
+export function deriveSide(name, side, expression) {
+    const { pricing } = side;
+    const merged = mergeSelection(pricing, readInput(side.selection));
+    const diagnostics = [];
+    if (merged.planId !== undefined && !pricing.plans.some((plan) => plan.id === merged.planId)) {
+        diagnostics.push(warning('PR_COMPARE_UNKNOWN_PLAN', `Unknown plan "${merged.planId}" in the ${name} selection.`, `${name}.selection.planId`));
+    }
+    if (merged.billingPeriod !== undefined &&
+        !pricing.billing.some((period) => period.id === merged.billingPeriod)) {
+        diagnostics.push(warning('PR_COMPARE_UNKNOWN_BILLING_PERIOD', `Unknown billing period "${merged.billingPeriod}" in the ${name} selection.`, `${name}.selection.billingPeriod`));
+    }
+    const addOns = {};
+    const requestedAddOnIds = new Set();
+    for (const [id, value] of Object.entries(merged.addOns)) {
+        const entry = isRecord(value) && typeof value.selected === 'boolean' ? value : undefined;
+        if (entry?.selected)
+            requestedAddOnIds.add(id);
+        if (!pricing.addOns.some((addOn) => addOn.id === id)) {
+            diagnostics.push(warning('PR_COMPARE_UNKNOWN_ADDON', `Unknown add-on "${id}" in the ${name} selection; it is ignored.`, `${name}.selection.addOns.${id}`));
+            continue;
+        }
+        if (!entry)
+            continue;
+        addOns[id] = entry.selected
+            ? {
+                selected: true,
+                quantity: normalizeAddOnQuantity(pricing, id, entry),
+            }
+            : {
+                selected: false,
+                quantity: typeof entry.quantity === 'number' && Number.isFinite(entry.quantity)
+                    ? entry.quantity + 0
+                    : 0,
+            };
+    }
+    const { selection, removedAddOnIds } = reconcileSelection(pricing, { ...merged, addOns });
+    const breakdown = cloneValue(resolvePricing(pricing, selection, { expression }).breakdown);
+    return { selection, requestedAddOnIds, removedAddOnIds, breakdown, diagnostics };
+}
+//# sourceMappingURL=compare-sides.js.map

package/dist/core/compare-sides.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"compare-sides.js","sourceRoot":"","sources":["../../src/core/compare-sides.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,sBAAsB,EACtB,kBAAkB,EAClB,cAAc,GACf,MAAM,cAAc,CAAC;AAStB,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAgBlD,SAAS,QAAQ,CAAC,KAA8B;IAC9C,IAAI,CAAC;QACH,MAAM,IAAI,GAAY,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;QACxD,OAAO,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;IACpC,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,SAAkB;IACnC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;QAAE,OAAO,EAAE,CAAC;IACpC,MAAM,KAAK,GAA8B,EAAE,CAAC;IAC5C,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,QAAQ;QAAE,KAAK,CAAC,MAAM,GAAG,SAAS,CAAC,MAAM,CAAC;IAC1E,IAAI,OAAO,SAAS,CAAC,aAAa,KAAK,QAAQ;QAAE,KAAK,CAAC,aAAa,GAAG,SAAS,CAAC,aAAa,CAAC;IAC/F,IAAI,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC;QAAE,KAAK,CAAC,SAAS,GAAG,QAAQ,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IACnF,IAAI,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/B,KAAK,CAAC,MAAM,GAAG,EAAE,GAAG,SAAS,CAAC,MAAM,EAAoC,CAAC;IAC3E,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,IAAY,EAAE,OAAe,EAAE,IAAY,EAAqB,EAAE,CAAC,CAAC;IACnF,IAAI;IACJ,QAAQ,EAAE,SAAS;IACnB,OAAO;IACP,IAAI;CACL,CAAC,CAAC;AAEH,kEAAkE;AAClE,MAAM,UAAU,UAAU,CACxB,IAAc,EACd,IAA6B,EAC7B,UAAyC;IAEzC,MAAM,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC;IACzB,MAAM,MAAM,GAAG,cAAc,CAAC,OAAO,EAAE,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IAClE,MAAM,WAAW,GAAwB,EAAE,CAAC;IAE5C,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5F,WAAW,CAAC,IAAI,CACd,OAAO,CACL,yBAAyB,EACzB,iBAAiB,MAAM,CAAC,MAAM,YAAY,IAAI,aAAa,EAC3D,GAAG,IAAI,mBAAmB,CAC3B,CACF,CAAC;IACJ,CAAC;IACD,IACE,MAAM,CAAC,aAAa,KAAK,SAAS;QAClC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,KAAK,MAAM,CAAC,aAAa,CAAC,EACrE,CAAC;QACD,WAAW,CAAC,IAAI,CACd,OAAO,CACL,mCAAmC,EACnC,2BAA2B,MAAM,CAAC,aAAa,YAAY,IAAI,aAAa,EAC5E,GAAG,IAAI,0BAA0B,CAClC,CACF,CAAC;IACJ,CAAC;IAED,MAAM,MAAM,GAAmC,EAAE,CAAC;IAClD,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAU,CAAC;IAC5C,KAAK,MAAM,CAAC,EAAE,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,MAAiC,CAAC,EAAE,CAAC;QACnF,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,IAAI,OAAO,KAAK,CAAC,QAAQ,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;QACzF,IAAI,KAAK,EAAE,QAAQ;YAAE,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAC/C,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC;YACrD,WAAW,CAAC,IAAI,CACd,OAAO,CACL,0BAA0B,EAC1B,mBAAmB,EAAE,YAAY,IAAI,4BAA4B,EACjE,GAAG,IAAI,qBAAqB,EAAE,EAAE,CACjC,CACF,CAAC;YACF,SAAS;QACX,CAAC;QACD,IAAI,CAAC,KAAK;YAAE,SAAS;QACrB,MAAM,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,QAAQ;YACzB,CAAC,CAAC;gBACE,QAAQ,EAAE,IAAI;gBACd,QAAQ,EAAE,sBAAsB,CAAC,OAAO,EAAE,EAAE,EAAE,KAAkC,CAAC;aAClF;YACH,CAAC,CAAC;gBACE,QAAQ,EAAE,KAAK;gBACf,QAAQ,EACN,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC;oBACnE,CAAC,CAAC,KAAK,CAAC,QAAQ,GAAG,CAAC;oBACpB,CAAC,CAAC,CAAC;aACR,CAAC;IACR,CAAC;IAED,MAAM,EAAE,SAAS,EAAE,eAAe,EAAE,GAAG,kBAAkB,CAAC,OAAO,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAC1F,MAAM,SAAS,GAAG,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,SAAS,EAAE,EAAE,UAAU,EAAE,CAAC,CAAC,SAAS,CAAC,CAAC;IAC3F,OAAO,EAAE,SAAS,EAAE,iBAAiB,EAAE,eAAe,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC;AACnF,CAAC"}

package/dist/core/compare-values.d.ts

@@ -0,0 +1,13 @@
+import type { ComparedValue, NormalizedPricing, PricingSelection, UsageLimitChange } from './types.js';
+export type ComparedValueKind = 'feature' | 'usage-limit';
+export declare const UNLIMITED_TEXT: Set<string>;
+export declare function toComparedValue(raw: unknown, kind: ComparedValueKind): ComparedValue;
+/**
+ * The value of a feature or usage limit for a reconciled selection: the plan value (or the
+ * definition's default), replaced or extended by each selected add-on in declaration order.
+ */
+export declare function effectiveValue(pricing: NormalizedPricing, selection: PricingSelection, kind: ComparedValueKind, id: string, defaultValue: unknown): ComparedValue;
+export declare function hasCapability(value: ComparedValue): boolean;
+export declare function limitDirection(before: ComparedValue, after: ComparedValue): UsageLimitChange['direction'];
+export declare function exceedsUsage(after: ComparedValue, consumed: number): boolean;
+//# sourceMappingURL=compare-values.d.ts.map

package/dist/core/compare-values.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compare-values.d.ts","sourceRoot":"","sources":["../../src/core/compare-values.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,aAAa,EAEb,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,EACjB,MAAM,YAAY,CAAC;AAGpB,MAAM,MAAM,iBAAiB,GAAG,SAAS,GAAG,aAAa,CAAC;AAE1D,eAAO,MAAM,cAAc,aAA6C,CAAC;AAKzE,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,EAAE,iBAAiB,GAAG,aAAa,CAoBpF;AASD;;;GAGG;AACH,wBAAgB,cAAc,CAC5B,OAAO,EAAE,iBAAiB,EAC1B,SAAS,EAAE,gBAAgB,EAC3B,IAAI,EAAE,iBAAiB,EACvB,EAAE,EAAE,MAAM,EACV,YAAY,EAAE,OAAO,GACpB,aAAa,CAoBf;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAa3D;AAQD,wBAAgB,cAAc,CAC5B,MAAM,EAAE,aAAa,EACrB,KAAK,EAAE,aAAa,GACnB,gBAAgB,CAAC,WAAW,CAAC,CAQ/B;AAED,wBAAgB,YAAY,CAAC,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAI5E"}