SDK
OverviewLast updated on
Last updated on
TypeScript SDK for creating and working with Paradoc artifacts
The @paradoc/sdk package is the main framework entry point for creating,
validating, rendering, and sealing Paradoc artifacts.
The SDK builds artifacts in TypeScript. For the JSON shape of the same artifacts, see the schema reference.
Installation
npm install @paradoc/sdkWhat the SDK includes
@paradoc/sdk re-exports four packages, so one import covers the common path:
| Package | Description |
|---|---|
@paradoc/core | Builders, instances, lifecycle types, bundle assembly, and sealing for every artifact type |
@paradoc/format | Locale-aware presentation of artifact values |
@paradoc/sessions | Event-sourced form-completion sessions |
@paradoc/render | The MIME-selected createLayerRenderer() entry point, plus the PDF placement helpers locate, locator, and extractFieldsFromPdf |
The SDK also exports hostedSealAdapter, which converts non-PDF layers through the hosted converter when you seal.
Install @paradoc/render directly when you import its format subpaths
(@paradoc/render/text, /pdf, /docx) or want rendering as an explicit
dependency.
Related packages
These packages are not part of @paradoc/sdk. Install each one on its own.
| Package | Description |
|---|---|
@paradoc/resolvers | Read file-backed layers from the filesystem (/fs), over HTTP (/http), or from memory (/memory) |
@paradoc/expr | The expression language behind artifact logic |
@paradoc/react | React bindings, pagination, and the runtime for React layers |
@paradoc/react-pdf | PDF rendering and composition checks for @paradoc/react |
@paradoc/essentials | Ready-to-use artifacts for common business forms |
@paradoc/ai-tools | Framework-neutral AI tool definitions |
@paradoc/ai-sdk | Adapter for the Vercel AI SDK |
@paradoc/tanstack-ai | Adapter for TanStack AI |
@paradoc/mastra | Adapter for Mastra |