Official JavaScript library for the Universal Commerce Protocol (UCP).
## Overview This repository contains the JavaScript SDK for the [Universal Commerce Protocol (UCP)](https://ucp.dev). It provides TypeScript types and [Zod](https://zod.dev/) schemas for UCP models, making it easy to build UCP-compliant applications in JavaScript and TypeScript. ### UCP Version Compatibility Each version of the JavaScript SDK is generated against a specific version of the UCP schema: | SDK Version | UCP Schema Version | | ----------- | ------------------ | | **`0.5.x`** | **`2026-08-25`** | | `0.4.x` | `2026-04-08` | | `0.1.1` | `2026-01-23` | | `0.1.0` | `2026-01-11` | ## Installation To install the SDK in your project, run: ```bash npm install @ucp-js/sdk ``` ## Usage The SDK provides Zod schemas and TypeScript types for UCP models. You can use Zod to validate incoming data or ensure your outgoing data matches the specification. ### TypeScript / ES Modules ```typescript import { CheckoutResponseSchema, CheckoutResponse } from "@ucp-js/sdk"; // Validate data against UCP schemas const parseResult = CheckoutResponseSchema.safeParse(checkoutData); if (parseResult.success) { const checkout: CheckoutResponse = parseResult.data; console.log(checkout.status); // "incomplete" | "ready_for_complete" | ... console.log(checkout.currency); // ISO 4217 currency code } else { console.error(parseResult.error); } ``` ### CommonJS ```javascript const { CheckoutResponseSchema } = require("@ucp-js/sdk"); const parseResult = CheckoutResponseSchema.safeParse(checkoutData); if (parseResult.success) { const checkout = parseResult.data; // ... } ``` ## Development ### Prerequisites This project uses `npm` for package management and `typescript` for building. ### Generating Models The models are automatically generated from the JSON schemas in the [UCP Specification](https://ucp.dev). To regenerate the models against a specific release version: ```bash npm run generate -- 2026-08-25 ``` Alternatively, you can point to a local directory containing the UCP repository or schemas: ```bash npm run generate -- /path/to/ucp ``` ### Building To build the project for both CommonJS and ESM: ```bash npm run build ``` ## Contributing We welcome community contributions. See our [Contribution Guide](https://github.com/Universal-Commerce-Protocol/.github/blob/main/CONTRIBUTING.md) for details. ## License UCP is an open-source project under the [Apache License 2.0](LICENSE).