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

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { A as HiddenFormField, B as UrlFormField, C as FormHookContext, D as FormNotifications, E as FormNotificationItem, F as SelectFormField, G as isFormField, H as isCheckboxFormField, I as SubmissionDocument, J as isSelectFormField, K as isFormFieldType, L as TextFormField, M as PhoneFormField, N as RadioFormField, O as FormSettings, P as ResolvedFormBuilderConfig, R as TextareaFormField, S as FormFieldTypeId, T as FormNotification, U as isEmailFormField, V as ValidationRules, W as isFileFormField, Y as isTextFormField, _ as FormBuilderPluginOptions, a as BUILT_IN_FORM_FIELD_TYPES, b as FormField, c as ConditionalLogic, d as DateFormField, f as EmailConfig, g as FormAccess, h as FileFormField, i as AnyFormField, j as NumberFormField, k as FormSubmission, l as ConditionalLogicCondition, m as FieldBlockConfig, n as NewSubmissionRow, o as BaseFormField, p as EmailFormField, q as isKnownFormField, r as NewSubmissionsData, s as CheckboxFormField, t as NEW_SUBMISSIONS_WIDGET_ID, u as CustomFormField, v as FormConfig, w as FormHooks, x as FormFieldType, y as FormDocument, z as TimeFormField } from "./new-submissions-DGiIhdBF.js";
+import { A as NumberFormField, B as ValidationRules, C as FormHooks, D as FormSettings, E as FormNotifications, F as SubmissionDocument, G as isFormFieldType, H as isEmailFormField, I as TextFormField, J as isTextFormField, K as isKnownFormField, L as TextareaFormField, M as RadioFormField, N as ResolvedFormBuilderConfig, O as FormSubmission, P as SelectFormField, R as TimeFormField, S as FormHookContext, T as FormNotificationItem, U as isFileFormField, V as isCheckboxFormField, W as isFormField, X as NewSubmissionRow, Y as NEW_SUBMISSIONS_WIDGET_ID, Z as NewSubmissionsData, _ as FormConfig, a as ConditionalLogic, b as FormFieldType, c as ConsentFormField, d as EmailConfig, f as EmailFormField, g as FormBuilderPluginOptions, h as FormAccess, i as CheckboxFormField, j as PhoneFormField, k as HiddenFormField, l as CustomFormField, m as FileFormField, n as BUILT_IN_FORM_FIELD_TYPES, o as ConditionalLogicCondition, p as FieldBlockConfig, q as isSelectFormField, r as BaseFormField, s as ConsentAnswer, t as AnyFormField, u as DateFormField, v as FormDocument, w as FormNotification, x as FormFieldTypeId, y as FormField, z as UrlFormField } from "./types-XdBrUfi1.js";
 import { PluginDefinition } from "@nextlyhq/plugin-sdk";
 import { CollectionConfig, PluginContext } from "nextly";
 import { z } from "zod";
@@ -47,7 +47,7 @@ export declare function getFormBuilderConfig(nextly: unknown): ResolvedFormBuild
  * Error codes for form validation failures.
  * Used for programmatic error handling.
  */
-type FormValidationErrorCode = "SLUG_REQUIRED" | "SLUG_INVALID_TYPE" | "SLUG_TOO_SHORT" | "SLUG_TOO_LONG" | "SLUG_INVALID_FORMAT" | "SLUG_RESERVED" | "FIELDS_REQUIRED" | "FIELDS_INVALID_TYPE" | "FIELDS_EMPTY" | "FIELD_NAME_REQUIRED" | "FIELD_NAME_INVALID_FORMAT" | "FIELD_NAME_DUPLICATE" | "FIELD_TYPE_REQUIRED" | "FIELD_TYPE_INVALID" | "FIELD_LABEL_REQUIRED" | "OPTIONS_REQUIRED" | "OPTIONS_EMPTY" | "MIN_GREATER_THAN_MAX" | "MIN_LENGTH_GREATER_THAN_MAX" | "FILE_MAX_SIZE_INVALID" | "CONDITIONS_REQUIRED" | "CONDITION_FIELD_REQUIRED" | "CONDITION_COMPARISON_REQUIRED" | "SETTINGS_INVALID_TYPE" | "REDIRECT_URL_REQUIRED" | "REDIRECT_PAGE_REQUIRED" | "ACCESS_INVALID_TYPE" | "ACCESS_FUNCTION_INVALID";
+type FormValidationErrorCode = "SLUG_REQUIRED" | "SLUG_INVALID_TYPE" | "SLUG_TOO_SHORT" | "SLUG_TOO_LONG" | "SLUG_INVALID_FORMAT" | "SLUG_RESERVED" | "FIELDS_REQUIRED" | "FIELDS_INVALID_TYPE" | "FIELDS_EMPTY" | "FIELD_NAME_REQUIRED" | "FIELD_NAME_INVALID_FORMAT" | "FIELD_NAME_DUPLICATE" | "FIELD_TYPE_REQUIRED" | "FIELD_TYPE_INVALID" | "FIELD_LABEL_REQUIRED" | "OPTIONS_REQUIRED" | "OPTIONS_EMPTY" | "MIN_GREATER_THAN_MAX" | "MIN_LENGTH_GREATER_THAN_MAX" | "FILE_MAX_SIZE_INVALID" | "CONSENT_TEXT_REQUIRED" | "CONDITIONS_REQUIRED" | "CONDITION_FIELD_REQUIRED" | "CONDITION_COMPARISON_REQUIRED" | "SETTINGS_INVALID_TYPE" | "REDIRECT_URL_REQUIRED" | "REDIRECT_PAGE_REQUIRED" | "ACCESS_INVALID_TYPE" | "ACCESS_FUNCTION_INVALID";
 /**
  * A single validation error with path and context.
  *
@@ -649,6 +649,27 @@ export declare const time: (config: Omit<TimeFormField, "type">) => TimeFormFiel
  * ```
  */
 export declare const hidden: (config: Omit<HiddenFormField, "type">) => HiddenFormField;
+/**
+ * Creates a consent field configuration.
+ *
+ * A box the visitor ticks to agree to `agreementText`. It is always required,
+ * and the stored answer keeps the text the visitor was shown, so a later
+ * change to the text leaves what earlier visitors agreed to as it was. Staff
+ * can never edit a submitted consent.
+ *
+ * @param config - Field configuration without the `type` property
+ * @returns Complete consent field configuration
+ *
+ * @example
+ * ```typescript
+ * consent({
+ *   name: 'privacy',
+ *   label: 'Privacy',
+ *   agreementText: 'I agree to the privacy policy',
+ * })
+ * ```
+ */
+export declare const consent: (config: Omit<ConsentFormField, "type" | "required">) => ConsentFormField;
 /**
  * Comparison operators supported by the conditional logic system.
  */
@@ -887,12 +908,15 @@ interface ExportedJSON {
  * formatExportValue(new Date(), { type: 'date' }); // "2024-01-15"
  * ```
  */
-export declare function formatExportValue(value: unknown, field?: AnyFormField): string;
+export declare function formatExportValue(value: unknown, field?: {
+  readonly type: string;
+}): string;
 /**
  * Export submissions to CSV format.
  *
  * Generates an RFC 4180 compliant CSV string with:
- * - Form field values as columns (in form definition order)
+ * - Form field values as columns (in form definition order), headed by the
+ *   fields' labels, a choice answer by its option's label
  * - Optional metadata columns at the end (_id, _status, _submittedAt, etc.)
  * - Proper escaping of special characters
  * - Optional UTF-8 BOM for Excel compatibility
@@ -1011,6 +1035,12 @@ interface SubmitFormOptions {
     ipAddress?: string;
     /** Submitter's user agent string */
     userAgent?: string;
+    /**
+     * The page it was sent from, such as the request's `Referer`. Kept as
+     * its origin and path only, and only when it is a web page
+     * (`pageFromReferer`).
+     */
+    page?: string;
   };
   /**
    * The HTTP request this submission arrived on.
@@ -1391,5 +1421,5 @@ interface ExtendedCollectionConfig extends Omit<CollectionConfig, "admin"> {
  */
 export declare function submissionsCollection(pluginConfig: ResolvedFormBuilderConfig): ExtendedCollectionConfig;
 export declare const formBuilderPlugin: ReturnType<typeof formBuilder>["plugin"];
-export { type AnyFormField, BUILT_IN_FORM_FIELD_TYPES, type BaseFormField, type CSVExportOptions, type CheckboxFormField, type ComparisonOperator, type ConditionalLogic, type ConditionalLogicCondition, type CustomFormField, type DateFormField, type EmailConfig, type EmailFormField, type ExportedJSON, type FieldBlockConfig, type FileFormField, type FormAccess, type FormBuilderPluginOptions, type FormBuilderPluginResult, type FormConfig, type FormDocument, type FormField, type FormFieldOption, type FormFieldType, type FormFieldTypeId, type FormHookContext, type FormHooks, type FormNotification, type FormNotificationItem, type FormNotifications, type FormSettings, type FormSubmission, type FormValidationError, type FormValidationErrorCode, type FormValidationResult, type HiddenFormField, type JSONExportOptions, NEW_SUBMISSIONS_WIDGET_ID, type NewSubmissionRow, type NewSubmissionsData, type NextlyPlugin, type NumberFormField, type PhoneFormField, type RadioFormField, type ResolvedFormBuilderConfig, type SelectFormField, type SpamCheckConfig, type SpamCheckOptions, type SpamCheckResult, type SubmissionDocument, type SubmitFormContext, type SubmitFormOptions, type SubmitFormResult, type TextFormField, type TextareaFormField, type TimeFormField, type UrlFormField, type ValidationRules, isCheckboxFormField, isEmailFormField, isFileFormField, isFormField, isFormFieldType, isKnownFormField, isSelectFormField, isTextFormField };
+export { type AnyFormField, BUILT_IN_FORM_FIELD_TYPES, type BaseFormField, type CSVExportOptions, type CheckboxFormField, type ComparisonOperator, type ConditionalLogic, type ConditionalLogicCondition, type ConsentAnswer, type ConsentFormField, type CustomFormField, type DateFormField, type EmailConfig, type EmailFormField, type ExportedJSON, type FieldBlockConfig, type FileFormField, type FormAccess, type FormBuilderPluginOptions, type FormBuilderPluginResult, type FormConfig, type FormDocument, type FormField, type FormFieldOption, type FormFieldType, type FormFieldTypeId, type FormHookContext, type FormHooks, type FormNotification, type FormNotificationItem, type FormNotifications, type FormSettings, type FormSubmission, type FormValidationError, type FormValidationErrorCode, type FormValidationResult, type HiddenFormField, type JSONExportOptions, NEW_SUBMISSIONS_WIDGET_ID, type NewSubmissionRow, type NewSubmissionsData, type NextlyPlugin, type NumberFormField, type PhoneFormField, type RadioFormField, type ResolvedFormBuilderConfig, type SelectFormField, type SpamCheckConfig, type SpamCheckOptions, type SpamCheckResult, type SubmissionDocument, type SubmitFormContext, type SubmitFormOptions, type SubmitFormResult, type TextFormField, type TextareaFormField, type TimeFormField, type UrlFormField, type ValidationRules, isCheckboxFormField, isEmailFormField, isFileFormField, isFormField, isFormFieldType, isKnownFormField, isSelectFormField, isTextFormField };
 //# sourceMappingURL=index.d.ts.map