@10x-media/form-builder 0.1.0-beta.0 → 0.1.0-beta.2

package/dist/presentations/defaults.d.ts

@@ -0,0 +1,33 @@
+//#region src/presentations/defaults.d.ts
+declare const DEFAULT_PRESENTATION_NAME = "page";
+declare const defaultPresentationDescriptors: {
+  page: {
+    name: string;
+    label: "formBuilder:presentation.page";
+    surface: "page";
+    density: "comfortable";
+  };
+  inline: {
+    name: string;
+    label: "formBuilder:presentation.inline";
+    surface: "inline";
+    density: "comfortable";
+  };
+  modal: {
+    name: string;
+    label: "formBuilder:presentation.modal";
+    surface: "overlay";
+    density: "comfortable";
+    dismissOnSuccess: true;
+  };
+  drawer: {
+    name: string;
+    label: "formBuilder:presentation.drawer";
+    surface: "overlay";
+    density: "comfortable";
+    dismissOnSuccess: true;
+  };
+};
+//#endregion
+export { DEFAULT_PRESENTATION_NAME, defaultPresentationDescriptors };
+//# sourceMappingURL=defaults.d.ts.map

package/dist/presentations/defaults.js

@@ -0,0 +1,35 @@
+import { keys } from "../translations/keys.js";
+//#region src/presentations/defaults.ts
+const DEFAULT_PRESENTATION_NAME = "page";
+const defaultPresentationDescriptors = {
+	page: {
+		name: "page",
+		label: keys.presentationPage,
+		surface: "page",
+		density: "comfortable"
+	},
+	inline: {
+		name: "inline",
+		label: keys.presentationInline,
+		surface: "inline",
+		density: "comfortable"
+	},
+	modal: {
+		name: "modal",
+		label: keys.presentationModal,
+		surface: "overlay",
+		density: "comfortable",
+		dismissOnSuccess: true
+	},
+	drawer: {
+		name: "drawer",
+		label: keys.presentationDrawer,
+		surface: "overlay",
+		density: "comfortable",
+		dismissOnSuccess: true
+	}
+};
+//#endregion
+export { DEFAULT_PRESENTATION_NAME, defaultPresentationDescriptors };
+
+//# sourceMappingURL=defaults.js.map

package/dist/presentations/defaults.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"defaults.js","names":[],"sources":["../../src/presentations/defaults.ts"],"sourcesContent":["import { keys } from '../translations/keys'\nimport type { PresentationDescriptor } from './types'\n\nexport const DEFAULT_PRESENTATION_NAME = 'page'\n\nexport const defaultPresentationDescriptors = {\n\tpage: { name: 'page', label: keys.presentationPage, surface: 'page', density: 'comfortable' },\n\tinline: {\n\t\tname: 'inline',\n\t\tlabel: keys.presentationInline,\n\t\tsurface: 'inline',\n\t\tdensity: 'comfortable',\n\t},\n\tmodal: {\n\t\tname: 'modal',\n\t\tlabel: keys.presentationModal,\n\t\tsurface: 'overlay',\n\t\tdensity: 'comfortable',\n\t\tdismissOnSuccess: true,\n\t},\n\tdrawer: {\n\t\tname: 'drawer',\n\t\tlabel: keys.presentationDrawer,\n\t\tsurface: 'overlay',\n\t\tdensity: 'comfortable',\n\t\tdismissOnSuccess: true,\n\t},\n} satisfies Record<string, PresentationDescriptor>\n"],"mappings":";;AAGA,MAAa,4BAA4B;AAEzC,MAAa,iCAAiC;CAC7C,MAAM;EAAE,MAAM;EAAQ,OAAO,KAAK;EAAkB,SAAS;EAAQ,SAAS;CAAc;CAC5F,QAAQ;EACP,MAAM;EACN,OAAO,KAAK;EACZ,SAAS;EACT,SAAS;CACV;CACA,OAAO;EACN,MAAM;EACN,OAAO,KAAK;EACZ,SAAS;EACT,SAAS;EACT,kBAAkB;CACnB;CACA,QAAQ;EACP,MAAM;EACN,OAAO,KAAK;EACZ,SAAS;EACT,SAAS;EACT,kBAAkB;CACnB;AACD"}

package/dist/presentations/registry.d.ts

@@ -0,0 +1,15 @@
+import { PresentationDescriptor } from "./types.js";
+
+//#region src/presentations/registry.d.ts
+type PresentationDescriptorRegistry = Map<string, PresentationDescriptor>;
+/** Per-name override: `false` removes, `true` keeps the default, a descriptor adds or replaces one. */
+type PresentationDescriptorOption = boolean | PresentationDescriptor;
+type PresentationsDescriptorConfig = Record<string, PresentationDescriptorOption>;
+/**
+ * Resolve the active presentation descriptors from the defaults and a consumer override map.
+ * Mirrors the field-type, validation-rule, and renderer registry convention.
+ */
+declare const resolvePresentationDescriptors: (defaults: Record<string, PresentationDescriptor>, config?: PresentationsDescriptorConfig) => PresentationDescriptorRegistry;
+//#endregion
+export { PresentationDescriptorOption, PresentationDescriptorRegistry, PresentationsDescriptorConfig, resolvePresentationDescriptors };
+//# sourceMappingURL=registry.d.ts.map

package/dist/presentations/registry.js

@@ -0,0 +1,15 @@
+//#region src/presentations/registry.ts
+/**
+* Resolve the active presentation descriptors from the defaults and a consumer override map.
+* Mirrors the field-type, validation-rule, and renderer registry convention.
+*/
+const resolvePresentationDescriptors = (defaults, config = {}) => {
+	const registry = new Map(Object.entries(defaults));
+	for (const [name, option] of Object.entries(config)) if (option === false) registry.delete(name);
+	else if (option === true) {} else registry.set(name, option);
+	return registry;
+};
+//#endregion
+export { resolvePresentationDescriptors };
+
+//# sourceMappingURL=registry.js.map

package/dist/presentations/registry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"registry.js","names":[],"sources":["../../src/presentations/registry.ts"],"sourcesContent":["import type { PresentationDescriptor } from './types'\n\nexport type PresentationDescriptorRegistry = Map<string, PresentationDescriptor>\n\n/** Per-name override: `false` removes, `true` keeps the default, a descriptor adds or replaces one. */\nexport type PresentationDescriptorOption = boolean | PresentationDescriptor\n\nexport type PresentationsDescriptorConfig = Record<string, PresentationDescriptorOption>\n\n/**\n * Resolve the active presentation descriptors from the defaults and a consumer override map.\n * Mirrors the field-type, validation-rule, and renderer registry convention.\n */\nexport const resolvePresentationDescriptors = (\n\tdefaults: Record<string, PresentationDescriptor>,\n\tconfig: PresentationsDescriptorConfig = {}\n): PresentationDescriptorRegistry => {\n\tconst registry: PresentationDescriptorRegistry = new Map(Object.entries(defaults))\n\tfor (const [name, option] of Object.entries(config)) {\n\t\tif (option === false) {\n\t\t\tregistry.delete(name)\n\t\t} else if (option === true) {\n\t\t\t// keep the default; no-op when no default exists for this name\n\t\t} else {\n\t\t\tregistry.set(name, option)\n\t\t}\n\t}\n\treturn registry\n}\n"],"mappings":";;;;;AAaA,MAAa,kCACZ,UACA,SAAwC,CAAC,MACL;CACpC,MAAM,WAA2C,IAAI,IAAI,OAAO,QAAQ,QAAQ,CAAC;CACjF,KAAK,MAAM,CAAC,MAAM,WAAW,OAAO,QAAQ,MAAM,GACjD,IAAI,WAAW,OACd,SAAS,OAAO,IAAI;MACd,IAAI,WAAW,MAAM,CAE5B,OACC,SAAS,IAAI,MAAM,MAAM;CAG3B,OAAO;AACR"}

package/dist/presentations/types.d.ts

@@ -0,0 +1,18 @@
+//#region src/presentations/types.d.ts
+/** How a presentation surfaces the form. Drives wrapper selection and CSS. */
+type PresentationSurface = 'inline' | 'page' | 'overlay';
+type PresentationDensity = 'comfortable' | 'compact';
+/**
+ * Serializable, framework-agnostic description of a presentation. The admin select and the
+ * stored `defaultPresentation` use only this; the React `Wrapper` is added in `./react`. No React here.
+ */
+type PresentationDescriptor = {
+  name: string; /** i18n key or literal shown in the admin select. */
+  label: string;
+  surface: PresentationSurface;
+  density: PresentationDensity; /** Overlay surfaces request dismissal after a successful submit. */
+  dismissOnSuccess?: boolean;
+};
+//#endregion
+export { PresentationDensity, PresentationDescriptor, PresentationSurface };
+//# sourceMappingURL=types.d.ts.map

package/dist/react/Form.d.ts

@@ -0,0 +1,110 @@
+import { AnyFormFieldDefinition } from "../fields/types.js";
+import { FormFieldInstance } from "../submissions/types.js";
+import { FormFlow } from "../flow/types.js";
+import { RendererTranslate } from "./contract.js";
+import { FormEventSink } from "../events/types.js";
+import { AnyValidationRuleDefinition } from "../validation/types.js";
+import { FormPresentation } from "./presentation/types.js";
+import { PresentationsConfig } from "./presentation/registry.js";
+import { RenderersConfig } from "./registry.js";
+import { SubmitHandler } from "./submitForm.js";
+import { ReactNode } from "react";
+
+//#region src/react/Form.d.ts
+type FormDocument = {
+  id: number | string;
+  fields: FormFieldInstance[];
+  flow?: FormFlow; /** Stored presentation name; overridden by the `presentation` prop. */
+  defaultPresentation?: string;
+};
+/** Props passed to `renderSubmit`. */
+type SubmitButtonRenderProps = {
+  label: string;
+  submitting: boolean;
+};
+/** Props passed to `renderNext`. */
+type NextButtonRenderProps = {
+  label: string;
+  submitting: boolean;
+  onClick: () => void;
+};
+/** Props passed to `renderBack`. */
+type BackButtonRenderProps = {
+  label: string;
+  submitting: boolean;
+  onClick: () => void;
+};
+type FormProps = {
+  form: FormDocument;
+  fieldTypes?: AnyFormFieldDefinition[];
+  rules?: AnyValidationRuleDefinition[];
+  renderers?: RenderersConfig;
+  apiRoute?: string;
+  onSubmit?: SubmitHandler;
+  onSuccess?: (submissionId?: string) => void;
+  onError?: (message: string) => void;
+  events?: FormEventSink;
+  t?: RendererTranslate;
+  locale?: string;
+  layout?: boolean;
+  submitLabel?: string;
+  nextLabel?: string;
+  backLabel?: string; /** Label for the overlay close control (modal/drawer). */
+  closeLabel?: string;
+  successMessage?: string; /** Active presentation: a name into the registry or an inline presentation. Overrides the form's stored default. */
+  presentation?: string | FormPresentation; /** Per-render presentation overrides merged onto the defaults (add, replace, or `false` to remove). */
+  presentations?: PresentationsConfig; /** Invoked when an overlay presentation dismisses (close button, Escape, outside click, or `dismissOnSuccess`). */
+  onClose?: () => void; /** Accessible name for an overlay surface. */
+  title?: string; /** Seed initial field values (e.g. from `valuesFromSearchParams`). Still validated on submit. */
+  initialValues?: Record<string, unknown>; /** Honeypot decoy (on by default). `false` removes it; `{ name }` matches a customized server `spam.honeypot.fieldName`. */
+  honeypot?: false | {
+    name?: string;
+  }; /** A token from your captcha widget; verified server-side when a captcha provider is configured. */
+  captchaToken?: string; /** Custom layout: render fields with `useField`/`useFormState` instead of the auto-rendered field loop. */
+  children?: ReactNode; /** Additional CSS class names applied to the root `<form>` element (and the success node). */
+  className?: string; /** Replace the default submit button entirely. Receives the resolved label and submitting state. */
+  renderSubmit?: (props: SubmitButtonRenderProps) => ReactNode; /** Replace the default "Next" button in multi-step forms. */
+  renderNext?: (props: NextButtonRenderProps) => ReactNode; /** Replace the default "Back" button in multi-step forms. */
+  renderBack?: (props: BackButtonRenderProps) => ReactNode; /** CSS class forwarded to the default submit `<button>`. Ignored when `renderSubmit` is provided. */
+  submitButtonClassName?: string; /** CSS class forwarded to the default "Next" `<button>`. Ignored when `renderNext` is provided. */
+  nextButtonClassName?: string; /** CSS class forwarded to the default "Back" `<button>`. Ignored when `renderBack` is provided. */
+  backButtonClassName?: string;
+};
+/** The headless form controller: state, progressive client validation, conditional visibility, submission, events. */
+declare const Form: ({
+  form,
+  fieldTypes,
+  rules,
+  renderers,
+  apiRoute,
+  onSubmit,
+  onSuccess,
+  onError,
+  events,
+  t,
+  locale,
+  layout,
+  submitLabel,
+  nextLabel,
+  backLabel,
+  closeLabel,
+  successMessage,
+  presentation,
+  presentations,
+  onClose,
+  title,
+  initialValues,
+  honeypot,
+  captchaToken,
+  children,
+  className,
+  renderSubmit,
+  renderNext,
+  renderBack,
+  submitButtonClassName,
+  nextButtonClassName,
+  backButtonClassName
+}: FormProps) => import("react/jsx-runtime").JSX.Element;
+//#endregion
+export { BackButtonRenderProps, Form, FormDocument, FormProps, NextButtonRenderProps, SubmitButtonRenderProps };
+//# sourceMappingURL=Form.d.ts.map