@saastro/forms 0.5.0 → 0.6.0

package/dist/index.d.ts

@@ -3025,6 +3025,69 @@ declare global {
  */
 declare function recaptchaPlugin(config: RecaptchaPluginConfig): FormPlugin;
 
+/**
+ * ============================================
+ * TURNSTILE PLUGIN - Cloudflare Turnstile
+ * ============================================
+ *
+ * Mirrors `recaptchaPlugin` but for Cloudflare Turnstile. Unlike
+ * reCAPTCHA v3 (purely programmatic), Turnstile is widget-based: it must
+ * be rendered into a DOM element. This plugin renders the widget in
+ * explicit + `execution: 'execute'` mode (so it only challenges at submit
+ * time) into a container it manages, captures the token via the success
+ * callback, and attaches it to every submission via `transformValues`.
+ *
+ * The token field defaults to `_captchaToken` — the canonical field the
+ * Hub submit helper (`createHubFormSubmit`) extracts and forwards to the
+ * worker as `captchaToken`.
+ */
+interface TurnstilePluginConfig {
+    /** Cloudflare Turnstile site key. */
+    siteKey: string;
+    /** Field name for the token in submitted values (default: '_captchaToken'). */
+    tokenField?: string;
+    /**
+     * Widget appearance. 'interaction-only' (default) keeps it invisible
+     * unless Cloudflare decides a challenge is needed — closest to the
+     * reCAPTCHA v3 UX. 'always' renders a visible widget.
+     */
+    appearance?: 'always' | 'execute' | 'interaction-only';
+    /**
+     * CSS selector for the element to render the widget into. Defaults to
+     * `[data-saastro-turnstile]` (rendered inline by `HubForm`). If no such
+     * element exists, the plugin creates a fixed, bottom-right container so
+     * an interactive challenge can still surface.
+     */
+    container?: string;
+}
+interface TurnstileApi {
+    render: (el: HTMLElement | string, options: Record<string, unknown>) => string;
+    execute: (widgetId?: string, options?: Record<string, unknown>) => void;
+    reset: (widgetId?: string) => void;
+    remove: (widgetId?: string) => void;
+    getResponse: (widgetId?: string) => string | undefined;
+}
+declare global {
+    interface Window {
+        turnstile?: TurnstileApi;
+    }
+}
+/**
+ * Cloudflare Turnstile plugin.
+ *
+ * @example
+ * ```tsx
+ * import { turnstilePlugin, PluginManager, FormBuilder } from '@saastro/forms';
+ *
+ * const pm = new PluginManager();
+ * pm.register(turnstilePlugin({ siteKey: '0x4AAAAAAA...' }));
+ * ```
+ *
+ * With `HubForm`, this is wired automatically when the form schema
+ * declares `meta.captchaProvider === 'turnstile'`.
+ */
+declare function turnstilePlugin(config: TurnstilePluginConfig): FormPlugin;
+
 /**
  * ============================================
  * SHADCN/UI PRESET - Component Registry
@@ -3870,4 +3933,4 @@ declare function getFieldClass(formLayout?: {
  */
 declare function getHiddenClasses(hidden?: Partial<Record<Breakpoint, 'visible' | 'hidden'>>): string;
 
-export { type AccordionContentProps, type AccordionItemProps, type AccordionProps, type AccordionTriggerProps, BUILD_METHODS, BUILTIN_RESOLVERS, type BaseFieldProps, type Breakpoint$1 as Breakpoint, type BuiltinTransform, type ButtonCardFieldProps, type ButtonCardOption, type ButtonCheckboxFieldProps, type ButtonConfig, type ButtonProps, type ButtonRadioFieldProps, COMMON_CLASSES, COMMON_METHODS, COMMON_STRINGS, type CalendarProps, type CheckboxFieldProps, type CheckboxGroupFieldProps, type CheckboxProps, type ColumnsValue, type ComboboxFieldProps, type CommandEmptyProps, type CommandFieldProps, type CommandGroupProps, type CommandInputProps, type CommandItemProps, type CommandListProps, type CommandProps, type ComponentName, type ComponentOverrides, ComponentProvider, type ComponentProviderProps, type ComponentRegistry, type ComponentRegistryInput, ComponentResolver, type ComponentResolverConfig, type Condition, type ConditionGroup, type ConditionOperator, type CreateHubFormSubmitOptions, type CurrencyFieldProps, type CustomSubmitAction, type CustomSubmitConfig, DEFAULT_HUB_URL, type DatabowlConfig, type DateFieldProps, type DateRangeFieldProps, type DefaultSubmitConfig, type DefinePlugin, type DialogContentProps, type DialogDescriptionProps, type DialogHeaderProps, type DialogProps, type DialogTitleProps, type DialogTriggerProps, type EmailProvider, type EmailSubmitAction, type EndpointConfig, FIELD_DEFAULTS, FieldBuilder, type FieldConfig, type FieldDescriptionProps, type FieldErrorProps, type FieldLabelProps, type FieldLayoutConfig, type FieldMapEntry, type FieldMapping, type FieldMappingConfig, type FieldProps, FieldRenderer, type FieldResolver, type FieldTransformFn, type Fields, type FileFieldProps, Form, FormBuilder, type FormButtonProps, type FormButtons, FormComponentsProvider, type FormComponentsProviderProps, type FormConfig, type FormControlProps, type FormFieldProps, type FormLayout, type FormPlugin, type FormProps, type FormRef, type FormStepsInfo, type GapValue, type GlobModules, type HiddenFieldProps, type HtmlFieldProps, type HttpAuthConfig, type HttpBodyConfig, type HttpEndpointConfig, type HttpRetryConfig, type HttpSubmitAction, HubForm, type HubFormProps, type InputGroupFieldProps, type InputOTPGroupProps, type InputOTPProps, type InputOTPSlotProps, type InputProps, type InputSize, type IntegrationSubmitAction, InternalComponentProvider, type InternalComponentProviderProps, type LabelProps, MissingComponentFallback, type MissingComponentFallbackProps, type NativeSelectFieldProps, type NativeSelectProps, OPTION_BASED_TYPES, type Option, type OtpFieldProps, type PartialComponentRegistry, PluginManager, type PopoverContentProps, type PopoverProps, type PopoverTriggerProps, type PropertyMapping, type RadioFieldProps, type RadioGroupItemProps, type RadioGroupProps, type RangeFieldProps, type RecaptchaConfig, type RecaptchaPluginConfig, type RepeaterFieldProps, type ResolvedComponents, SUSPENSE_CONFIG, type SchemaType, type SelectContentProps, type SelectFieldProps, type SelectItemProps, type SelectProps, type SelectTriggerProps, type SelectValueProps, type SeparatorProps, type SerializableFieldResolver, type SerializationHint, type SliderFieldProps, type SliderProps, type Step, type StepCondition, type StepInfo, type StepStatus, type Steps, StepsAccordion, StepsNavigation, StepsProgress, type SubmitAction, type SubmitActionCondition, type SubmitActionNode, type SubmitActionResult, type SubmitActionType, type SubmitActionsResult, type SubmitConfig, type SubmitConfirmationConfig, type SubmitExecutionConfig, type SubmitTrigger, type SubmitTriggerType, type SubmitType, type SwitchFieldProps, type SwitchGroupFieldProps, type SwitchProps, TYPE_SPECIFIC_PROPERTIES, type TestDataLocale, type TestDataOptions, type TextFieldProps, type TextareaFieldProps, type TextareaProps, type TooltipContentProps, type TooltipProps, type TooltipProviderProps, type TooltipTriggerProps, type UseSubmitConfirmationReturn, VALIDATION_METHODS, type ValidateComponentRegistry, type ValidationContext, type ValidationPresetMeta, type ValidationRules, type WebhookSubmitAction, analyticsPlugin, applyBuiltinTransform, applyFieldMapping, applyFieldMappingSync, applyFieldTransforms, applyTransform, autosavePlugin, compileValidationRules, configureComponents, coreComponents, createComponentRegistry, createHubFormSubmit, createMissingComponentPlaceholder, createShadcnRegistry, databowlAction, databowlPlugin, defaultSubmit, definePlugin, detectLocale, executeCustomAction, executeEmailAction, executeHttpAction, executeSubmitAction, executeSubmitActions, executeSubmitActionsByTrigger, executeWebhookAction, fieldTypeComponents, generateFieldValue, generateTestData, getActionsByTrigger, getAllKnownMethods, getAvailablePresets, getComponentResolver, getFieldClass, getFormGridClass, getHiddenClasses, getInstallCommand, getMinDelayMs, getMissingComponents, getRequiredComponents, globalPluginManager, groupMissingByPackage, iconVariants, iconVariantsConfig, inputVariants, inputVariantsConfig, isAdvancedMapping, isValidationRules, isZodSchema, localStoragePlugin, mergeComponentRegistries, parseGlobModules, pxToRem, recaptchaPlugin, registerPreset, resolvePreset, resolveValue, resolveValueSync, textareaVariants, textareaVariantsConfig, useComponentMode, useComponents, useComputedFields, useFormLayout, useFormState, useFormStepsInfo, useHasComponentProvider, useHiddenFieldResolvers, usePartialComponents, useRecaptcha, useSubmitActionTriggers, useSubmitConfirmation, withComponents };
+export { type AccordionContentProps, type AccordionItemProps, type AccordionProps, type AccordionTriggerProps, BUILD_METHODS, BUILTIN_RESOLVERS, type BaseFieldProps, type Breakpoint$1 as Breakpoint, type BuiltinTransform, type ButtonCardFieldProps, type ButtonCardOption, type ButtonCheckboxFieldProps, type ButtonConfig, type ButtonProps, type ButtonRadioFieldProps, COMMON_CLASSES, COMMON_METHODS, COMMON_STRINGS, type CalendarProps, type CheckboxFieldProps, type CheckboxGroupFieldProps, type CheckboxProps, type ColumnsValue, type ComboboxFieldProps, type CommandEmptyProps, type CommandFieldProps, type CommandGroupProps, type CommandInputProps, type CommandItemProps, type CommandListProps, type CommandProps, type ComponentName, type ComponentOverrides, ComponentProvider, type ComponentProviderProps, type ComponentRegistry, type ComponentRegistryInput, ComponentResolver, type ComponentResolverConfig, type Condition, type ConditionGroup, type ConditionOperator, type CreateHubFormSubmitOptions, type CurrencyFieldProps, type CustomSubmitAction, type CustomSubmitConfig, DEFAULT_HUB_URL, type DatabowlConfig, type DateFieldProps, type DateRangeFieldProps, type DefaultSubmitConfig, type DefinePlugin, type DialogContentProps, type DialogDescriptionProps, type DialogHeaderProps, type DialogProps, type DialogTitleProps, type DialogTriggerProps, type EmailProvider, type EmailSubmitAction, type EndpointConfig, FIELD_DEFAULTS, FieldBuilder, type FieldConfig, type FieldDescriptionProps, type FieldErrorProps, type FieldLabelProps, type FieldLayoutConfig, type FieldMapEntry, type FieldMapping, type FieldMappingConfig, type FieldProps, FieldRenderer, type FieldResolver, type FieldTransformFn, type Fields, type FileFieldProps, Form, FormBuilder, type FormButtonProps, type FormButtons, FormComponentsProvider, type FormComponentsProviderProps, type FormConfig, type FormControlProps, type FormFieldProps, type FormLayout, type FormPlugin, type FormProps, type FormRef, type FormStepsInfo, type GapValue, type GlobModules, type HiddenFieldProps, type HtmlFieldProps, type HttpAuthConfig, type HttpBodyConfig, type HttpEndpointConfig, type HttpRetryConfig, type HttpSubmitAction, HubForm, type HubFormProps, type InputGroupFieldProps, type InputOTPGroupProps, type InputOTPProps, type InputOTPSlotProps, type InputProps, type InputSize, type IntegrationSubmitAction, InternalComponentProvider, type InternalComponentProviderProps, type LabelProps, MissingComponentFallback, type MissingComponentFallbackProps, type NativeSelectFieldProps, type NativeSelectProps, OPTION_BASED_TYPES, type Option, type OtpFieldProps, type PartialComponentRegistry, PluginManager, type PopoverContentProps, type PopoverProps, type PopoverTriggerProps, type PropertyMapping, type RadioFieldProps, type RadioGroupItemProps, type RadioGroupProps, type RangeFieldProps, type RecaptchaConfig, type RecaptchaPluginConfig, type RepeaterFieldProps, type ResolvedComponents, SUSPENSE_CONFIG, type SchemaType, type SelectContentProps, type SelectFieldProps, type SelectItemProps, type SelectProps, type SelectTriggerProps, type SelectValueProps, type SeparatorProps, type SerializableFieldResolver, type SerializationHint, type SliderFieldProps, type SliderProps, type Step, type StepCondition, type StepInfo, type StepStatus, type Steps, StepsAccordion, StepsNavigation, StepsProgress, type SubmitAction, type SubmitActionCondition, type SubmitActionNode, type SubmitActionResult, type SubmitActionType, type SubmitActionsResult, type SubmitConfig, type SubmitConfirmationConfig, type SubmitExecutionConfig, type SubmitTrigger, type SubmitTriggerType, type SubmitType, type SwitchFieldProps, type SwitchGroupFieldProps, type SwitchProps, TYPE_SPECIFIC_PROPERTIES, type TestDataLocale, type TestDataOptions, type TextFieldProps, type TextareaFieldProps, type TextareaProps, type TooltipContentProps, type TooltipProps, type TooltipProviderProps, type TooltipTriggerProps, type TurnstilePluginConfig, type UseSubmitConfirmationReturn, VALIDATION_METHODS, type ValidateComponentRegistry, type ValidationContext, type ValidationPresetMeta, type ValidationRules, type WebhookSubmitAction, analyticsPlugin, applyBuiltinTransform, applyFieldMapping, applyFieldMappingSync, applyFieldTransforms, applyTransform, autosavePlugin, compileValidationRules, configureComponents, coreComponents, createComponentRegistry, createHubFormSubmit, createMissingComponentPlaceholder, createShadcnRegistry, databowlAction, databowlPlugin, defaultSubmit, definePlugin, detectLocale, executeCustomAction, executeEmailAction, executeHttpAction, executeSubmitAction, executeSubmitActions, executeSubmitActionsByTrigger, executeWebhookAction, fieldTypeComponents, generateFieldValue, generateTestData, getActionsByTrigger, getAllKnownMethods, getAvailablePresets, getComponentResolver, getFieldClass, getFormGridClass, getHiddenClasses, getInstallCommand, getMinDelayMs, getMissingComponents, getRequiredComponents, globalPluginManager, groupMissingByPackage, iconVariants, iconVariantsConfig, inputVariants, inputVariantsConfig, isAdvancedMapping, isValidationRules, isZodSchema, localStoragePlugin, mergeComponentRegistries, parseGlobModules, pxToRem, recaptchaPlugin, registerPreset, resolvePreset, resolveValue, resolveValueSync, textareaVariants, textareaVariantsConfig, turnstilePlugin, useComponentMode, useComponents, useComputedFields, useFormLayout, useFormState, useFormStepsInfo, useHasComponentProvider, useHiddenFieldResolvers, usePartialComponents, useRecaptcha, useSubmitActionTriggers, useSubmitConfirmation, withComponents };

package/dist/index.js

@@ -6071,6 +6071,156 @@ function recaptchaPlugin(config) {
   });
 }
 
+// src/plugins/turnstile.ts
+var SCRIPT_SRC = "https://challenges.cloudflare.com/turnstile/v0/api.js?render=explicit";
+var TOKEN_TIMEOUT_MS = 2e4;
+function waitForTurnstile(timeoutMs = 1e4) {
+  return new Promise((resolve, reject) => {
+    if (typeof window === "undefined") {
+      reject(new Error("turnstile: no window"));
+      return;
+    }
+    if (window.turnstile) {
+      resolve(window.turnstile);
+      return;
+    }
+    const start = Date.now();
+    const tick = () => {
+      if (window.turnstile) {
+        resolve(window.turnstile);
+      } else if (Date.now() - start > timeoutMs) {
+        reject(new Error("turnstile: script did not load"));
+      } else {
+        setTimeout(tick, 100);
+      }
+    };
+    tick();
+  });
+}
+function turnstilePlugin(config) {
+  const {
+    siteKey,
+    tokenField = "_captchaToken",
+    appearance = "interaction-only",
+    container
+  } = config;
+  let scriptElement = null;
+  let createdContainer = null;
+  let widgetId;
+  let lastToken = null;
+  let pending = null;
+  const resolveContainer = () => {
+    if (container) {
+      const found = document.querySelector(container);
+      if (found) return found;
+    }
+    const byData = document.querySelector("[data-saastro-turnstile]");
+    if (byData) return byData;
+    if (!createdContainer) {
+      createdContainer = document.createElement("div");
+      createdContainer.setAttribute("data-saastro-turnstile-fallback", "");
+      createdContainer.style.position = "fixed";
+      createdContainer.style.bottom = "12px";
+      createdContainer.style.right = "12px";
+      createdContainer.style.zIndex = "2147483647";
+      document.body.appendChild(createdContainer);
+    }
+    return createdContainer;
+  };
+  const ensureWidget = async () => {
+    const api = await waitForTurnstile();
+    if (widgetId === void 0) {
+      const el = resolveContainer();
+      widgetId = api.render(el, {
+        sitekey: siteKey,
+        appearance,
+        execution: "execute",
+        callback: (token) => {
+          lastToken = token;
+          pending?.resolve(token);
+          pending = null;
+        },
+        "error-callback": () => {
+          pending?.reject(new Error("turnstile: challenge failed"));
+          pending = null;
+          return true;
+        },
+        "expired-callback": () => {
+          lastToken = null;
+        }
+      });
+    }
+    return api;
+  };
+  return definePlugin({
+    name: "turnstile",
+    version: "1.0.0",
+    description: "Cloudflare Turnstile \u2014 widget render and token generation",
+    onFormInit() {
+      if (typeof window === "undefined") return;
+      if (!window.turnstile && !document.querySelector('script[src*="turnstile/v0/api.js"]')) {
+        scriptElement = document.createElement("script");
+        scriptElement.src = SCRIPT_SRC;
+        scriptElement.async = true;
+        scriptElement.defer = true;
+        document.body.appendChild(scriptElement);
+      }
+      void ensureWidget().catch(() => {
+      });
+    },
+    async transformValues(values) {
+      if (typeof window === "undefined") return values;
+      try {
+        const api = await ensureWidget();
+        const token = await new Promise((resolve, reject) => {
+          pending = { resolve, reject };
+          const timer = setTimeout(() => {
+            if (pending) {
+              pending = null;
+              reject(new Error("turnstile: token timeout"));
+            }
+          }, TOKEN_TIMEOUT_MS);
+          const wrappedResolve = (t) => {
+            clearTimeout(timer);
+            resolve(t);
+          };
+          const wrappedReject = (e) => {
+            clearTimeout(timer);
+            reject(e);
+          };
+          pending = { resolve: wrappedResolve, reject: wrappedReject };
+          lastToken = null;
+          api.reset(widgetId);
+          api.execute(widgetId);
+        });
+        return { ...values, [tokenField]: token };
+      } catch (error) {
+        console.error("turnstilePlugin: failed to get token:", error);
+        return values;
+      }
+    },
+    cleanup() {
+      if (typeof window !== "undefined" && window.turnstile && widgetId !== void 0) {
+        try {
+          window.turnstile.remove(widgetId);
+        } catch {
+        }
+      }
+      widgetId = void 0;
+      lastToken = null;
+      pending = null;
+      if (createdContainer?.parentNode) {
+        createdContainer.parentNode.removeChild(createdContainer);
+        createdContainer = null;
+      }
+      if (scriptElement?.parentNode) {
+        scriptElement.parentNode.removeChild(scriptElement);
+        scriptElement = null;
+      }
+    }
+  });
+}
+
 // src/presets/shadcn.ts
 function createComponentRegistry(components) {
   return {
@@ -6901,6 +7051,13 @@ function createHubFormSubmit(opts) {
 // src/components/HubForm.tsx
 import { useEffect as useEffect8, useMemo as useMemo7, useState as useState5 } from "react";
 import { Fragment as Fragment3, jsx as jsx14, jsxs as jsxs11 } from "react/jsx-runtime";
+function readCaptchaMeta(schema) {
+  const meta = schema.meta;
+  return {
+    captchaProvider: meta?.captchaProvider,
+    captchaSiteKey: meta?.captchaSiteKey
+  };
+}
 function isRenderableSchema(value) {
   if (!value || typeof value !== "object") return false;
   const schema = value;
@@ -6970,6 +7127,18 @@ function HubForm({
       }
     };
   }, [hubUrl, siteId, formSlug, onSuccess, onError]);
+  const captcha = useMemo7(() => {
+    if (state.status !== "ready") return void 0;
+    const { captchaProvider, captchaSiteKey } = readCaptchaMeta(state.schema);
+    if (!captchaProvider || !captchaSiteKey) return void 0;
+    const pm = new PluginManager();
+    if (captchaProvider === "turnstile") {
+      pm.register(turnstilePlugin({ siteKey: captchaSiteKey, tokenField: "_captchaToken" }));
+    } else {
+      pm.register(recaptchaPlugin({ siteKey: captchaSiteKey, tokenField: "_captchaToken" }));
+    }
+    return { pm, provider: captchaProvider };
+  }, [state]);
   if (state.status === "loading") {
     return loadingFallback ?? /* @__PURE__ */ jsx14("div", { "data-saastro-hubform-loading": true, style: loadingStyle, children: "Loading\u2026" });
   }
@@ -6990,9 +7159,13 @@ function HubForm({
   }
   const config = {
     ...state.schema,
-    submit: wrappedSubmit
+    submit: wrappedSubmit,
+    ...captcha ? { pluginManager: captcha.pm } : {}
   };
-  return /* @__PURE__ */ jsx14(Form, { ...formProps, config });
+  return /* @__PURE__ */ jsxs11(Fragment3, { children: [
+    /* @__PURE__ */ jsx14(Form, { ...formProps, config }),
+    captcha?.provider === "turnstile" ? /* @__PURE__ */ jsx14("div", { "data-saastro-turnstile": true }) : null
+  ] });
 }
 var loadingStyle = {
   padding: "2rem 1rem",
@@ -7332,6 +7505,7 @@ export {
   resolveValueSync,
   textareaVariants,
   textareaVariantsConfig,
+  turnstilePlugin,
   useComponentMode,
   useComponents,
   useComputedFields,