@x12i/reportix-composer-types

Shared Zod schemas and TypeScript types used across Reportix Composer packages.

Most consumers should depend on @x12i/reportix-composer-core or @x12i/reportix-composer-api-client instead. Use this package directly when you need to validate template manifests, render requests, or API payloads yourself.

Install

npm install @x12i/reportix-composer-types

Usage

import {
  TemplateManifestSchema,
  RenderRequestSchema,
  CreateTemplateFromHtmlInputSchema,
  type Template,
  type TemplateSummary,
  type RenderOptions
} from "@x12i/reportix-composer-types";

const manifest = TemplateManifestSchema.parse(rawJson);
const request = RenderRequestSchema.parse({
  markdown: "# Hello",
  templateId: "clean-report",
  options: { pdf: { format: "A4" } } satisfies RenderOptions
});

What it exports

• Template models — TemplateManifestSchema (includes docx + pptx configs), page/theme/DOCX/PPTX style schemas, Template, TemplateSummary
• Render models — RenderFormat (html | pdf | docx | pptx), RenderOptions, RenderRequest, RenderHtmlResponse
• API models — create-from-HTML/image inputs, TemplatePatch, ReportixComposerApiErrorSchema

Peer dependency: zod is bundled as a normal dependency.