@form-engine-ts/core 1.0.0 → 2.0.0

package/README.md

@@ -24,4 +24,38 @@ const result = validateAnswers(schema, { name: "Ada" });
 if (!result.valid) console.error(result.issues);
 ```
 
+## Multi-step, localization, analytics, and events
+
+Add `pages` to partition every field into an accessible wizard and use `validatePageAnswers(schema, pageIndex, values)`
+for step-scoped validation. Schemas without `pages` remain single-page forms.
+
+Store authoring-time translations on forms, fields, options, and pages. `resolveLocalizedSchema` applies them synchronously,
+while `populateSchemaTranslations` fills them through an injected `AsyncTranslationAdapter`. Population defaults to
+`overwrite: "missing-only"`, accepts per-slot `shouldOverwrite` and `createMetadata` callbacks, and returns
+`{ schema, report }` with updated and skipped translation slots.
+
+Forms, pages, fields, options, and submissions accept JSON-only `metadata` and per-locale/property
+`translationMetadata`. These extension values survive sanitization, localization, submission creation, and storage
+round-trips. `completionMessage` is localized with the rest of the form text.
+
+`calculateCrossTabulation` builds a two-question frequency matrix from submissions. `dispatchWebhook` posts typed
+`response.submitted` or `schema.updated` events with timeout handling, custom headers, and optional HMAC-SHA256 signing.
+
+CSV export neutralizes string cells whose first non-whitespace character is `=`, `+`, `-`, or `@`. This is enabled by
+default; trusted callers can pass `{ neutralizeFormulas: false }`. RFC 4180 quoting and the UTF-8 BOM remain unchanged.
+
+Storage adapters share inclusive ISO 8601 submission-range filtering:
+
+```ts
+import type { SubmissionQueryOptions } from "@form-engine-ts/core";
+
+const range: SubmissionQueryOptions = {
+  since: "2026-01-01T00:00:00.000Z",
+  until: "2026-01-31T23:59:59.999Z"
+};
+const submissions = await storage.listSubmissions("contact", 1, range);
+```
+
+Results are ordered by `submittedAt`, then submission ID. Both boundaries are inclusive.
+
 See the [project documentation](https://github.com/nitta-a/form-engine-ts#readme) for the complete schema and API guide.