Schema

Runtime validation and TypeScript types for portable .oqs.json documents.

import { parseDocument, parseEstimator } from "@openquotestack/schema";
const document = parseDocument(input);
const estimator = parseEstimator(input);

The document wrapper requires schemaVersion: "1" and estimator. Optional template metadata describes category and template version. Estimators include metadata, currency/exponent, steps, typed fields, validation, visibility conditions, pricing rules, decimal-string constants and output/CTA settings. Unknown properties fail.

parseDocument returns the complete normalized document. parseEstimator returns only its estimator. Both validate JSON data budgets and cross-references. They throw validation errors; unsupported versions are rejected rather than guessed. Future migrations will be explicit version-to-version transformations.

Numeric fields are nonnegative quantities. Choice IDs, field IDs and rule IDs are stable references. Visibility references preceding fields only. Conditions and formula ASTs are JSON data. Currency exponent is declared by the document author; confirm it against the intended currency rather than assuming two decimal places.

See the moving template and pricing semantics. No web application imports are needed. License: AGPL-3.0-only.

Supported field types include text/textarea, number/currency/quantity/slider, email/phone/address, date/time, select/radio/image choice, checkbox/yes-no, multiselect, information/divider and authored hidden values. Defaults are validated; hidden values cannot be overridden by customer answers. Image-choice URLs use HTTP(S); logo storage is an application concern.

Definitions also include locale translations, contact capture mode/fields, terms and optional expiration days. Enabled capture requires name and email. These are version-1 authoring additions; older strict readers can reject unsupported fields. Use compatible package releases rather than assuming forward compatibility from the schema version alone.

This package is ESM with generated TypeScript declarations. Node.js 20+ is supported; repository verification uses Node.js 24. External package publication is separate.