Form schema checking is disabled.
Set LINT_DEFINITIONS=true in .env and restart the app.
Load a sample schema
JSON definition · shared/definitions/creator-load-save.json
View on GitHub
{
"title": "Support request",
"elements": [
{
"type": "dropdown",
"name": "product",
"title": "Product",
"choices": [
"Form Library",
"Survey Creator",
"Dashboard",
"PDF Generator"
]
},
{
"type": "comment",
"name": "issue",
"title": "Describe the issue",
"isRequired": true
},
{
"type": "radiogroup",
"name": "urgency",
"title": "How urgent is it?",
"choices": [
"Low",
"Normal",
"Blocking"
]
},
{
"type": "boolean",
"name": "callback",
"title": "Call me back"
}
]
}
Client · shared/client/lint-definition.js · sjs:lint-definition.client
View on GitHub
// Display the server's errors and warnings and return the actual save result to Creator
async function saveDefinition(definition) {
const response = await fetch(`/api/forms/${formId}`, {
method: "PUT", headers: { "Content-Type": "application/json" }, body: JSON.stringify(definition)
});
const report = response.status === 204 ? {} : await response.json();
reportFindings(report);
if (response.status === 422 && Array.isArray(report.errors) && report.errors.length) {
note("Form schema not saved. Fix the reported errors and retry.", "error");
return false;
}
if (!response.ok) throw new Error(report.error || "Couldn't save the form schema. Please try again.");
const count = report.warnings?.length ?? 0;
note(count ? `Schema saved with ${count} warning${count === 1 ? "" : "s"}. Review the findings above.` : "Form schema saved successfully.", "ok");
return true;
}
creator.saveSurveyFunc = async (saveNo, callback) => callback(saveNo, await checkAndSave(creator.JSON));
Server · routes/lint-definition.js · sjs:lint-definition.server
View on GitHub
// PUT /api/forms/:id — lint the definition from Creator before storing it
app.put("/api/forms/:id", (req, res) => {
const denied = can(req.user, "edit-forms");
if (denied) throw httpError(403, denied);
const definition = req.body; // the parsed raw body: {} stays {} (see Load and Save Form JSON Schemas)
if (definition === null || typeof definition !== "object" || Array.isArray(definition)) {
throw httpError(400, "Expected a form definition");
}
const { findings } = lintSurvey(definition, lintOptions);
const errors = findings.filter((finding) => finding.severity === "error");
const warnings = findings.filter((finding) => finding.severity !== "error");
if (errors.length > 0) return res.status(422).json({ errors, warnings }); // refuse the save: the previous version stays
db(req).prepare("INSERT INTO forms (key, json) VALUES (?, ?) ON CONFLICT (key) DO UPDATE SET json = excluded.json")
.run(req.params.id, JSON.stringify(definition)); // stored as it arrived, never a copy
if (warnings.length > 0) return res.json({ warnings }); // warnings don't block the save
res.sendStatus(204);
});