@guardrail-sim/ucp-types


TypeScript types for the Universal Commerce Protocol — discount requests, checkout sessions, line items, payments, and converter functions to bridge between guardrail-sim's policy engine and UCP-formatted responses.

Part of guardrail-sim.

Install

``bash
npm install @guardrail-sim/ucp-types
`

Usage

`typescript
import {
buildDiscountExtensionResponse,
fromUCPLineItems,
} from '@guardrail-sim/ucp-types/converters';
import { PolicyEngine, defaultPolicy } from '@guardrail-sim/policy-engine';

// Convert UCP line items into a policy engine order
const order = fromUCPLineItems(checkoutLineItems, { productMargin: 0.35 });

// Evaluate and build a UCP-shaped response
const engine = new PolicyEngine(defaultPolicy);
const evaluation = await engine.evaluate(order, 0.15);
const response = buildDiscountExtensionResponse(['SUMMER20'], evaluation, 1500, 'Summer Sale');
`

Entry Points

- @guardrail-sim/ucp-types — everything re-exported from one place
- @guardrail-sim/ucp-types/discount — DiscountRequest, DiscountResponse, error codes
- @guardrail-sim/ucp-types/checkout — CheckoutResponse, LineItem, Buyer, payment types
- @guardrail-sim/ucp-types/converters — buildDiscountExtensionResponse, fromUCPLineItems, toUCPErrorCode`, etc.

Docs

- UCP Types Reference
- UCP Concepts

License

MIT