@formancy/server-core 0.3.0 → 0.5.0

package/README.md

@@ -27,19 +27,30 @@ server gets argon2id and a CSPRNG.
 ## Use
 
 ```ts
-import { publishForm, createSubmission, can } from '@formancy/server-core'
+import { publishForm, formToFill, createSubmission, can } from '@formancy/server-core'
 
 const published = await publishForm(deps, { path: 'contact-us', schema })
 // publishForm is the save gate: structural validation, then the engine's own
 // compile — a form that could loop is refused here and never persisted.
 
+// What a respondent is handed: the current version, and the token its response is
+// sent back with, so that a response sent twice is stored once.
+const form = await formToFill(deps, 'contact-us')
+
 const outcome = await createSubmission(deps, {
   path: 'contact-us',
-  declaredSchemaHash: published.schemaHash,
+  declaredSchemaHash: form.schemaHash,
+  token: form.submissionToken,
   data: payload,
 })
+// The same token again: { ok: false, kind: 'token_spent', id }, and nothing stored.
 ```
 
+`publishForm`, `keepExamples` and `createSubmission` write their audit row inside
+the transaction of what they record. Give them a `requestId` and the row names
+that request, so it can be read beside a request log — `@formancy/server` passes
+Fastify's request id. Without one, the row names none.
+
 Authorization is one readable table (`can(actor, action)`), deliberately not
 Postgres row-level security: RLS couples the application to per-request database
 roles and hides authorization from the test suite.