========
Overview
========

``zopyx.surveyjs`` integrates SurveyJS into Plone. It provides a visual form
builder (SurveyJS Creator), a public form viewer, storage for submissions,
export tools, and optional integrations such as mail delivery or POSTing
submissions to external endpoints.

Key capabilities
================

- SurveyJS Creator-backed form editor stored as JSON.
- Public survey rendering with SurveyJS.
- Configurable actions per Survey (store, mail, notification, POST).
- Multi-format exports: text, Markdown, HTML, PDF, CSV, XLSX, XML, DOCX, JSON.
- Optional server-side validation (Python and external SurveyJS binary).
- Embedding support via an opt-in embed view and JavaScript API.
- AI Generator for drafting and refining SurveyJS JSON.

Core concepts
=============

Survey
  A Plone content item storing the SurveyJS form JSON, submission settings,
  and actions.

Form version
  Every time a form is saved, a new version is stored. The latest version is
  used for rendering and submission validation.

Submission (poll)
  The JSON payload produced by a completed survey. Submissions can be stored,
  exported, mailed, and POSTed to external endpoints.

Actions
  Per-survey behaviors triggered on submission: store, mail, notification,
  and POST.