@nextlyhq/plugin-form-builder 0.0.2-alpha.74 → 0.0.2-alpha.76

package/dist/{new-submissions-CzlhVGhH.d.ts → types-XdBrUfi1.d.ts}

@@ -1,6 +1,37 @@
 import "@nextlyhq/plugin-sdk";
 import { CollectionConfig, FieldDefinition, RequestContext } from "nextly";
 import { ComponentType } from "react";
+/** The widget's id, the one core's default names. */
+declare const NEW_SUBMISSIONS_WIDGET_ID = "form-builder/new-submissions";
+/** One new submission, as the card draws it. */
+interface NewSubmissionRow {
+  id: string;
+  /** The submitter's name or email, or "Submission" where the form has neither answered. */
+  title: string;
+  /** The form's name, where the reader may read it. */
+  form?: string;
+  /** The first line of the first text answer not already the title. */
+  excerpt?: string;
+  /** When it was submitted, as an ISO string. */
+  at?: string;
+  /** The submission, in the admin. */
+  href: string;
+}
+/** The card's data: its "Number of entries" of rows, how many new submissions there are, and their list. */
+interface NewSubmissionsData {
+  items: NewSubmissionRow[];
+  /** How many new submissions the reader may read, in all. */
+  total: number;
+  /** `total` is a floor: there are at least this many. */
+  atLeast?: true;
+  /** Every submission, in the admin. */
+  allHref: string;
+  /**
+   * The submissions collection's slug as the site installed it, the one a
+   * row is marked read in when it is opened.
+   */
+  collection: string;
+}
 /**
  * Reading the document a form's redirect setting points at.
  *
@@ -53,8 +84,11 @@ interface EmailConfig {
  * the `form-builder.beforeEmail` D63 filter seam.
  */
 interface FormEmailNotification {
-  /** Resolved recipient address. */
-  to: string;
+  /**
+   * Resolved recipient address, or the addresses of a team notification
+   * that has several. A notification with one recipient keeps a string.
+   */
+  to: string | string[];
   /** Email template slug to render. */
   templateSlug: string;
   /** Template variables (submitted data + form metadata). */
@@ -74,6 +108,14 @@ interface FormEmailNotification {
   bcc?: string[];
   /** Source notification id; undefined for filter-injected emails. */
   notificationId?: string;
+  /**
+   * The files that go with this email, by media id: the notification's own
+   * choice of file fields. Absent on a filter-injected email, which takes the
+   * files of the fields marked to attach to notification emails.
+   */
+  attachments?: Array<{
+    mediaId: string;
+  }>;
 }
 /**
  * A single email notification rule stored on a form.
@@ -96,10 +138,25 @@ interface FormNotification {
    * the template/provider default.
    */
   senderEmail?: string;
+  /**
+   * Which preset the notification started from: one to the team, or a
+   * confirmation to the person who submitted. Absent on rules saved before
+   * presets, which read by their recipient.
+   */
+  kind?: "team" | "visitor";
   /** How the recipient address is determined */
   recipientType: "static" | "field";
-  /** Recipient: static email address or a {{fieldName}} reference */
+  /**
+   * Recipient: static email address or a {{fieldName}} reference. A team
+   * notification with several addresses keeps them in `recipients`; this
+   * then holds the first, for readers that know only one.
+   */
   to: string;
+  /**
+   * A team notification's addresses. Absent on rules saved before several
+   * were allowed, whose single `to` reads as a list of one.
+   */
+  recipients?: string[];
   /** CC email addresses */
   cc: string[];
   /** BCC email addresses */
@@ -116,6 +173,20 @@ interface FormNotification {
    * multi-condition tree without a migration.
    */
   condition?: ConditionalLogicCondition;
+  /**
+   * Several send conditions: all must hold, or any one. Takes the place of
+   * `condition`, which reads as a list of one under `all` when this is absent.
+   */
+  conditions?: {
+    match: "all" | "any";
+    list: ConditionalLogicCondition[];
+  };
+  /**
+   * The names of the form's file fields whose files go with this email.
+   * Absent on rules saved before it, which attach exactly the file fields
+   * marked to attach to notification emails.
+   */
+  attachFields?: string[];
   /** Slug of the email template to use */
   templateSlug?: string;
 }
@@ -168,6 +239,12 @@ interface SubmissionDocument {
   userAgent?: string;
   /** Which spam check flagged this, when one did. */
   spamReason?: string | null;
+  /**
+   * What it was asked, as the write seam stored it (`utils/asked-fields`):
+   * its fields' labels and option labels at the time. Absent on a
+   * submission stored before submissions kept it.
+   */
+  asked?: unknown;
   submittedAt: Date;
   createdAt: Date;
   updatedAt: Date;
@@ -197,6 +274,7 @@ interface FormFieldToggles {
   date: boolean | Partial<FieldBlockConfig>;
   time: boolean | Partial<FieldBlockConfig>;
   hidden: boolean | Partial<FieldBlockConfig>;
+  consent: boolean | Partial<FieldBlockConfig>;
 }
 /** What a host may override on a collection this plugin contributes. */
 type CollectionOverrides = Partial<CollectionConfig> & {
@@ -407,6 +485,21 @@ interface FormBuilderPluginOptions {
   /**
    * Spam protection configuration.
    */
+  /**
+   * One response per person.
+   */
+  oneResponse?: {
+    /**
+     * How many earlier submissions a form may have for a change of its
+     * one-response setting to give them their keys inside the save itself,
+     * so the save answers with the form as it then stands. A form with more
+     * is brought up to date by the plugin's background sweep instead, and
+     * until it is, each new submission is compared with the earlier answers.
+     * Lower it to keep saves short on a slow database.
+     * @default 200
+     */
+    keysInSave?: number;
+  };
   spamProtection?: {
     /**
      * Enable honeypot field for spam detection.
@@ -414,15 +507,29 @@ interface FormBuilderPluginOptions {
      */
     honeypot?: boolean;
     /**
-     * Enable reCAPTCHA v3.
-     * @default false
+     * Google reCAPTCHA v3: a score for each visitor, in the background.
+     * `enabled` makes it the site default for forms whose bot check is "Site
+     * default". The token is verified on the server with `secretKey`; the
+     * visitor's form renders the widget with `siteKey`.
+     * @default { enabled: false }
      */
     recaptcha?: {
       enabled: boolean;
       siteKey?: string;
       secretKey?: string;
+      /** Below this score (0.0 to 1.0) a visitor is a bot. @default 0.5 */
       scoreThreshold?: number;
     };
+    /**
+     * Cloudflare Turnstile: a check in the background that rarely shows a
+     * puzzle. `enabled` makes it the site default when reCAPTCHA's is not.
+     * @default { enabled: false }
+     */
+    turnstile?: {
+      enabled: boolean;
+      siteKey?: string;
+      secretKey?: string;
+    };
     /**
      * Rate limiting configuration.
      */
@@ -525,7 +632,7 @@ interface FormConfig {
  * Form field type (discriminated union).
  * Uses the `type` property as the discriminant.
  */
-type FormField = TextFormField | EmailFormField | NumberFormField | PhoneFormField | UrlFormField | TextareaFormField | SelectFormField | CheckboxFormField | RadioFormField | FileFormField | DateFormField | TimeFormField | HiddenFormField;
+type FormField = TextFormField | EmailFormField | NumberFormField | PhoneFormField | UrlFormField | TextareaFormField | SelectFormField | CheckboxFormField | RadioFormField | FileFormField | DateFormField | TimeFormField | HiddenFormField | ConsentFormField;
 /**
  * A form field of a built-in type OR a plugin-contributed type. Stored form
  * data and the builder work with this; `isKnownFormField` narrows it back to
@@ -536,7 +643,7 @@ type AnyFormField = FormField | CustomFormField;
 /**
  * All available built-in form field type identifiers.
  */
-type FormFieldType = "text" | "email" | "number" | "phone" | "url" | "textarea" | "select" | "checkbox" | "radio" | "file" | "date" | "time" | "hidden";
+type FormFieldType = "text" | "email" | "number" | "phone" | "url" | "textarea" | "select" | "checkbox" | "radio" | "file" | "date" | "time" | "hidden" | "consent";
 /**
  * A form field's type on the wire: a built-in or a plugin-contributed type id
  * that opted into the forms surface. The `(string & {})` arm admits the plugin
@@ -727,6 +834,25 @@ interface HiddenFormField extends Omit<BaseFormField, "type"> {
   type: "hidden";
   defaultValue?: string;
 }
+/**
+ * A box the visitor ticks to agree to a text, such as a privacy policy. It is
+ * always required, and its answer keeps the text the visitor was shown, so a
+ * later change to the text does not change what an earlier visitor agreed to.
+ */
+interface ConsentFormField extends Omit<BaseFormField, "type"> {
+  type: "consent";
+  /** What the visitor agrees to, shown beside the box and stored with it. */
+  agreementText: string;
+}
+/**
+ * A consent field's stored answer: whether the visitor agreed, and the text
+ * the form showed them. Made by the server from the form, never taken from
+ * the visitor, and never changed by an edit of the submission.
+ */
+interface ConsentAnswer {
+  agreed: boolean;
+  text: string;
+}
 interface ValidationRules {
   /** Custom error message */
   errorMessage?: string;
@@ -757,6 +883,10 @@ interface ConditionalLogicCondition {
   /** Value to compare against (not used for isEmpty/isNotEmpty) */
   value?: unknown;
 }
+/** How a form tells one person's response from another's. */
+type OneResponseMode = "off" | "email" | "browser" | "ip";
+/** Which bot check a form asks for. */
+type BotCheckMode = "default" | "off" | "recaptcha" | "turnstile";
 /**
  * Form settings and behavior.
  */
@@ -791,8 +921,57 @@ interface FormSettings {
     relationTo: string;
     value: string;
   };
-  /** Allow multiple submissions from same IP (default true) */
+  /**
+   * Allow multiple submissions from same IP (default true).
+   * @deprecated Read as `oneResponse` (true is `"off"`, false is `"ip"`);
+   * no longer written.
+   */
   allowMultipleSubmissions?: boolean;
+  /**
+   * One response per person, and how a person is told apart: `"off"` allows
+   * several; `"email"` by the answer to `oneResponseField`, `"browser"` by a
+   * token the browser keeps, `"ip"` by network address.
+   *
+   * @default "off"
+   */
+  oneResponse?: OneResponseMode;
+  /** The email field `oneResponse: "email"` reads, by name. */
+  oneResponseField?: string;
+  /**
+   * Which run of one-response checks the form is on: a whole number from 0,
+   * moved on when the mode changes so earlier responses count afresh.
+   *
+   * @default 0
+   */
+  oneResponseVersion?: number;
+  /**
+   * The one-response version whose earlier submissions all carry their keys.
+   * Behind `oneResponseVersion` while the plugin is still making them, after
+   * a change of mode or Email field; unset reads as up to date. Written by
+   * the plugin only.
+   */
+  oneResponseKeyedVersion?: number;
+  /**
+   * The bot check: `"default"` follows the plugin's option, `"off"` none, or
+   * a named provider.
+   *
+   * @default "default"
+   */
+  botCheck?: BotCheckMode;
+  /** When the form stops taking submissions, as an ISO date and time. */
+  closesAt?: string;
+  /** How many submissions the form takes before it closes; none for no limit. */
+  submissionLimit?: number;
+  /**
+   * Whether a submission keeps the visitor's IP address and browser.
+   *
+   * @default true
+   */
+  storeIpAndBrowser?: boolean;
+  /** How many days submissions are kept; none to keep them. */
+  keepDays?: number;
+  /** A note about the form, for people in the admin only. */
+  internalNote?: string;
   /**
    * Per-form honeypot override. Unset inherits the plugin's
    * `spamProtection.honeypot`; the form wins where set.
@@ -801,6 +980,8 @@ interface FormSettings {
   /**
    * Per-form reCAPTCHA override. Unset inherits the plugin's
    * `spamProtection.recaptcha.enabled`; the form wins where set.
+   * @deprecated Read as `botCheck` (unset is `"default"`, true
+   * `"recaptcha"`, false `"off"`); no longer written.
    */
   captchaEnabled?: boolean;
   /** reCAPTCHA site key (client-facing) when captcha is enabled per-form */
@@ -913,9 +1094,10 @@ interface ResolvedFormBuilderConfig {
   /**
    * Whether each redirect target collection is localized, keyed by slug.
    *
-   * Resolved at `init` from the collection's own registered metadata rather
-   * than asked for in options, because the collection already declares it and
-   * a second declaration drifts.
+   * Resolved at `init` from the collection's own declaration rather than
+   * asked for in options, because the collection already declares it and a
+   * second declaration drifts: the configuration's for a collection code
+   * declares, the registry row's for one made in the Schema Builder.
    *
    * It decides whether a target's main-row `status` answers for the document:
    * a localized collection publishes on a locale companion, so the row reads
@@ -931,6 +1113,8 @@ interface ResolvedFormBuilderConfig {
     defaultToEmail?: string;
     enabled: boolean;
   };
+  /** `FormBuilderPluginOptions["oneResponse"]`, every option filled. */
+  oneResponse: Required<NonNullable<FormBuilderPluginOptions["oneResponse"]>>;
   spamProtection: {
     honeypot: boolean;
     recaptcha?: {
@@ -939,6 +1123,11 @@ interface ResolvedFormBuilderConfig {
       secretKey?: string;
       scoreThreshold?: number;
     };
+    turnstile?: {
+      enabled: boolean;
+      siteKey?: string;
+      secretKey?: string;
+    };
     rateLimit?: {
       maxSubmissions: number;
       windowMs: number;
@@ -983,36 +1172,5 @@ declare function isCheckboxFormField(field: FormField): field is CheckboxFormFie
  * Type guard for file field.
  */
 declare function isFileFormField(field: FormField): field is FileFormField;
-/** The widget's id, the one core's default names. */
-declare const NEW_SUBMISSIONS_WIDGET_ID = "form-builder/new-submissions";
-/** One new submission, as the card draws it. */
-interface NewSubmissionRow {
-  id: string;
-  /** The submitter's name or email, or "Submission" where the form has neither answered. */
-  title: string;
-  /** The form's name, where the reader may read it. */
-  form?: string;
-  /** The first line of the first text answer not already the title. */
-  excerpt?: string;
-  /** When it was submitted, as an ISO string. */
-  at?: string;
-  /** The submission, in the admin. */
-  href: string;
-}
-/** The card's data: the rows its size holds, how many new submissions there are, and their list. */
-interface NewSubmissionsData {
-  items: NewSubmissionRow[];
-  /** How many new submissions the reader may read, in all. */
-  total: number;
-  /** `total` is a floor: there are at least this many. */
-  atLeast?: true;
-  /** Every submission, in the admin. */
-  allHref: string;
-  /**
-   * The submissions collection's slug as the site installed it, the one a
-   * row is marked read in when it is opened.
-   */
-  collection: string;
-}
-export { HiddenFormField as A, UrlFormField as B, FormHookContext as C, FormNotifications as D, FormNotificationItem as E, SelectFormField as F, isFormField as G, isCheckboxFormField as H, SubmissionDocument as I, isSelectFormField as J, isFormFieldType as K, TextFormField as L, PhoneFormField as M, RadioFormField as N, FormSettings as O, ResolvedFormBuilderConfig as P, TextareaFormField as R, FormFieldTypeId as S, FormNotification as T, isEmailFormField as U, ValidationRules as V, isFileFormField as W, isTextFormField as Y, FormBuilderPluginOptions as _, BUILT_IN_FORM_FIELD_TYPES as a, FormField as b, ConditionalLogic as c, DateFormField as d, EmailConfig as f, FormAccess as g, FileFormField as h, AnyFormField as i, NumberFormField as j, FormSubmission as k, ConditionalLogicCondition as l, FieldBlockConfig as m, NewSubmissionRow as n, BaseFormField as o, EmailFormField as p, isKnownFormField as q, NewSubmissionsData as r, CheckboxFormField as s, NEW_SUBMISSIONS_WIDGET_ID as t, CustomFormField as u, FormConfig as v, FormHooks as w, FormFieldType as x, FormDocument as y, TimeFormField as z };
-//# sourceMappingURL=new-submissions-CzlhVGhH.d.ts.map
+export { NumberFormField as A, ValidationRules as B, FormHooks as C, FormSettings as D, FormNotifications as E, SubmissionDocument as F, isFormFieldType as G, isEmailFormField as H, TextFormField as I, isTextFormField as J, isKnownFormField as K, TextareaFormField as L, RadioFormField as M, ResolvedFormBuilderConfig as N, FormSubmission as O, SelectFormField as P, TimeFormField as R, FormHookContext as S, FormNotificationItem as T, isFileFormField as U, isCheckboxFormField as V, isFormField as W, NewSubmissionRow as X, NEW_SUBMISSIONS_WIDGET_ID as Y, NewSubmissionsData as Z, FormConfig as _, ConditionalLogic as a, FormFieldType as b, ConsentFormField as c, EmailConfig as d, EmailFormField as f, FormBuilderPluginOptions as g, FormAccess as h, CheckboxFormField as i, PhoneFormField as j, HiddenFormField as k, CustomFormField as l, FileFormField as m, BUILT_IN_FORM_FIELD_TYPES as n, ConditionalLogicCondition as o, FieldBlockConfig as p, isSelectFormField as q, BaseFormField as r, ConsentAnswer as s, AnyFormField as t, DateFormField as u, FormDocument as v, FormNotification as w, FormFieldTypeId as x, FormField as y, UrlFormField as z };
+//# sourceMappingURL=types-XdBrUfi1.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nextlyhq/plugin-form-builder",
-  "version": "0.0.2-alpha.74",
+  "version": "0.0.2-alpha.76",
   "description": "Visual form builder plugin for Nextly with Code-First and Schema Builder support",
   "license": "MIT",
   "type": "module",
@@ -30,20 +30,20 @@
     "zod": "^4.6.7"
   },
   "peerDependencies": {
-    "@nextlyhq/admin": "0.0.2-alpha.74",
-    "@nextlyhq/plugin-sdk": "0.0.2-alpha.74",
-    "@nextlyhq/ui": "^0.0.2-alpha.74",
+    "@nextlyhq/admin": "0.0.2-alpha.76",
+    "@nextlyhq/plugin-sdk": "0.0.2-alpha.76",
+    "@nextlyhq/ui": "^0.0.2-alpha.76",
     "@tanstack/react-query": ">=5.0.0",
     "lucide-react": ">=0.400.0",
     "next": "^16.4.1",
-    "nextly": "0.0.2-alpha.74",
+    "nextly": "0.0.2-alpha.76",
     "react": "^19.3.0"
   },
   "devDependencies": {
-    "@nextlyhq/admin": "0.0.2-alpha.74",
-    "@nextlyhq/plugin-sdk": "0.0.2-alpha.74",
-    "@nextlyhq/tsconfig": "0.0.2-alpha.74",
-    "@nextlyhq/ui": "0.0.2-alpha.74",
+    "@nextlyhq/admin": "0.0.2-alpha.76",
+    "@nextlyhq/plugin-sdk": "0.0.2-alpha.76",
+    "@nextlyhq/tsconfig": "0.0.2-alpha.76",
+    "@nextlyhq/ui": "0.0.2-alpha.76",
     "@tanstack/react-query": "^5.62.0",
     "@testing-library/jest-dom": "^6.9.1",
     "@testing-library/react": "^16.3.0",
@@ -52,7 +52,7 @@
     "@types/react": "19.3.0",
     "jsdom": "^27.1.0",
     "lucide-react": "^0.544.0",
-    "nextly": "0.0.2-alpha.74",
+    "nextly": "0.0.2-alpha.76",
     "react": "19.3.1",
     "react-dom": "19.3.1",
     "tsdown": "^0.23.1",