@marktiderman/genesis-forms 0.4.1 → 0.5.0

package/dist/server.d.cts

@@ -1,5 +1,5 @@
-import { J as Json, e as FormEvent, F as FormDefinition } from './types-BBKBQ8sp.cjs';
-import { F as FieldValidator } from './validate-BXXqi0fq.cjs';
+import { F as FieldValidator, H as HostOptions } from './validate-BsZ0YTQS.cjs';
+import { J as Json, e as FormEvent, F as FormDefinition } from './types-BhYUbLJ-.cjs';
 
 interface SubmissionInput {
     /** Answers keyed by field id. Ignored when `events` is given. */
@@ -15,8 +15,33 @@ interface SubmissionOptions {
     /** `false` checks a draft: formats only, nothing required. Default true. */
     complete?: boolean | undefined;
     validators?: Record<string, FieldValidator> | undefined;
-    /** Most events accepted, counted after `compactEvents`. Default 10 000. */
+    /**
+     * Most events accepted, counted after `compactEvents`. Default `MAX_EVENTS`
+     * (10,000). At most `RAW_EVENTS_PER_EVENT` (10) times as many may be sent.
+     */
     maxEvents?: number | undefined;
+    /**
+     * Most JSON values in the answers, answer events and hidden inputs
+     * together (each number, text, true / false, list item, row and cell
+     * counts one; a run of answers to one field, as typing in a table sends,
+     * counts its last only). Default `MAX_SUBMISSION_VALUES` (200,000).
+     */
+    maxValues?: number | undefined;
+    /**
+     * Most work replaying the events may take: one unit per block each time
+     * the path is walked, one per calculated field each time the answers
+     * settle, and a formula's size (its numbers, answers and operators) each
+     * time it is worked out. Default `MAX_REPLAY_WORK` (1,000,000). Only the
+     * replay counts: the submit that follows it does not.
+     */
+    maxReplayWork?: number | undefined;
+    /**
+     * The option lists the app supplies for `optionsFrom: { source: "host" }`
+     * choice fields, loaded here on the server (never taken from the client):
+     * an answer must be one of the field's own options or of these. Pass what
+     * the form was shown with, loaded afresh, such as the current staff.
+     */
+    hostOptions?: HostOptions | undefined;
 }
 interface CheckedSubmission {
     status: "draft" | "completed";
@@ -43,15 +68,24 @@ type SubmissionResult = {
 };
 /** Default for `SubmissionOptions.maxEvents`. */
 declare const MAX_EVENTS = 10000;
+/** Default for `SubmissionOptions.maxValues`. */
+declare const MAX_SUBMISSION_VALUES = 200000;
+/** Default for `SubmissionOptions.maxReplayWork`. */
+declare const MAX_REPLAY_WORK = 1000000;
+/**
+ * Most events sent, before compaction, as a multiple of `maxEvents`: a
+ * keystroke log compacts to far fewer, but every event sent is looked at.
+ */
+declare const RAW_EVENTS_PER_EVENT = 10;
 /**
  * Check a submission against the published definition. Never throws on a
  * malformed submission: it returns `{ ok: false, errors: { "": … } }`.
  */
-declare function validateSubmission(definition: FormDefinition, submission: SubmissionInput, options?: SubmissionOptions): SubmissionResult;
+declare function validateSubmission(published: FormDefinition, submission: SubmissionInput, options?: SubmissionOptions): SubmissionResult;
 /**
  * The definition as respondents may see it. R1 forms hold nothing secret;
  * assessment answer keys (R4) will be stripped here.
  */
 declare function publicDefinition(definition: FormDefinition): FormDefinition;
 
-export { type CheckedSubmission, MAX_EVENTS, type SubmissionInput, type SubmissionOptions, type SubmissionResult, publicDefinition, validateSubmission };
+export { type CheckedSubmission, MAX_EVENTS, MAX_REPLAY_WORK, MAX_SUBMISSION_VALUES, RAW_EVENTS_PER_EVENT, type SubmissionInput, type SubmissionOptions, type SubmissionResult, publicDefinition, validateSubmission };

package/dist/server.d.ts

@@ -1,5 +1,5 @@
-import { J as Json, e as FormEvent, F as FormDefinition } from './types-BBKBQ8sp.js';
-import { F as FieldValidator } from './validate-BjNwF1UE.js';
+import { F as FieldValidator, H as HostOptions } from './validate-Bs1lyoOl.js';
+import { J as Json, e as FormEvent, F as FormDefinition } from './types-BhYUbLJ-.js';
 
 interface SubmissionInput {
     /** Answers keyed by field id. Ignored when `events` is given. */
@@ -15,8 +15,33 @@ interface SubmissionOptions {
     /** `false` checks a draft: formats only, nothing required. Default true. */
     complete?: boolean | undefined;
     validators?: Record<string, FieldValidator> | undefined;
-    /** Most events accepted, counted after `compactEvents`. Default 10 000. */
+    /**
+     * Most events accepted, counted after `compactEvents`. Default `MAX_EVENTS`
+     * (10,000). At most `RAW_EVENTS_PER_EVENT` (10) times as many may be sent.
+     */
     maxEvents?: number | undefined;
+    /**
+     * Most JSON values in the answers, answer events and hidden inputs
+     * together (each number, text, true / false, list item, row and cell
+     * counts one; a run of answers to one field, as typing in a table sends,
+     * counts its last only). Default `MAX_SUBMISSION_VALUES` (200,000).
+     */
+    maxValues?: number | undefined;
+    /**
+     * Most work replaying the events may take: one unit per block each time
+     * the path is walked, one per calculated field each time the answers
+     * settle, and a formula's size (its numbers, answers and operators) each
+     * time it is worked out. Default `MAX_REPLAY_WORK` (1,000,000). Only the
+     * replay counts: the submit that follows it does not.
+     */
+    maxReplayWork?: number | undefined;
+    /**
+     * The option lists the app supplies for `optionsFrom: { source: "host" }`
+     * choice fields, loaded here on the server (never taken from the client):
+     * an answer must be one of the field's own options or of these. Pass what
+     * the form was shown with, loaded afresh, such as the current staff.
+     */
+    hostOptions?: HostOptions | undefined;
 }
 interface CheckedSubmission {
     status: "draft" | "completed";
@@ -43,15 +68,24 @@ type SubmissionResult = {
 };
 /** Default for `SubmissionOptions.maxEvents`. */
 declare const MAX_EVENTS = 10000;
+/** Default for `SubmissionOptions.maxValues`. */
+declare const MAX_SUBMISSION_VALUES = 200000;
+/** Default for `SubmissionOptions.maxReplayWork`. */
+declare const MAX_REPLAY_WORK = 1000000;
+/**
+ * Most events sent, before compaction, as a multiple of `maxEvents`: a
+ * keystroke log compacts to far fewer, but every event sent is looked at.
+ */
+declare const RAW_EVENTS_PER_EVENT = 10;
 /**
  * Check a submission against the published definition. Never throws on a
  * malformed submission: it returns `{ ok: false, errors: { "": … } }`.
  */
-declare function validateSubmission(definition: FormDefinition, submission: SubmissionInput, options?: SubmissionOptions): SubmissionResult;
+declare function validateSubmission(published: FormDefinition, submission: SubmissionInput, options?: SubmissionOptions): SubmissionResult;
 /**
  * The definition as respondents may see it. R1 forms hold nothing secret;
  * assessment answer keys (R4) will be stripped here.
  */
 declare function publicDefinition(definition: FormDefinition): FormDefinition;
 
-export { type CheckedSubmission, MAX_EVENTS, type SubmissionInput, type SubmissionOptions, type SubmissionResult, publicDefinition, validateSubmission };
+export { type CheckedSubmission, MAX_EVENTS, MAX_REPLAY_WORK, MAX_SUBMISSION_VALUES, RAW_EVENTS_PER_EVENT, type SubmissionInput, type SubmissionOptions, type SubmissionResult, publicDefinition, validateSubmission };