@beechcms/forms-react 1.0.0

package/dist/types.d.ts

@@ -0,0 +1,138 @@
+import type { ReactNode } from 'react';
+export type FormBranchType = 'string' | 'text' | 'number' | 'boolean' | 'select' | 'date' | 'file' | 'email';
+export type ConditionalOperator = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'not_in' | 'is_empty' | 'is_not_empty' | 'contains';
+export interface ConditionalRule {
+    field: string;
+    op: ConditionalOperator;
+    value?: unknown;
+}
+export interface FormBranchSchema {
+    alias: string;
+    type: FormBranchType;
+    label?: string;
+    placeholder?: string;
+    required?: boolean;
+    options?: Array<{
+        label: string;
+        value: string | number;
+    }>;
+    defaultValue?: unknown;
+    dependsOn?: ConditionalRule | ConditionalRule[];
+    accept?: string;
+    maxSizeMb?: number;
+    helpText?: string;
+}
+export interface FormSeedSchema {
+    slug: string;
+    label?: string;
+    branches: FormBranchSchema[];
+}
+export interface FormFileAttachment {
+    filename: string;
+    mimeType: string;
+    data: string;
+}
+export interface FormTranslations {
+    submitButton: string;
+    submittingButton: string;
+    successTitle: string;
+    successMessage: string;
+    errorTitle: string;
+    genericErrorMessage: string;
+    requiredField: string;
+    invalidEmail: string;
+    invalidNumber: string;
+    invalidFileType: string;
+    fileTooLarge: (maxMb: number) => string;
+    draftRestored: string;
+    timeTrapWarning: string;
+    honeypotLabel: string;
+}
+export type Locale = 'it' | 'en';
+export interface UseBeechFormOptions<TValues extends Record<string, unknown> = Record<string, unknown>> {
+    seed: string | FormSeedSchema;
+    baseUrl?: string;
+    apiKey?: string;
+    locale?: Locale;
+    translations?: Partial<FormTranslations>;
+    initialValues?: Partial<TValues>;
+    disableDraft?: boolean;
+    disableAntiBot?: boolean;
+    honeypotField?: string;
+    includeFields?: string[];
+    excludeFields?: string[];
+    onSuccess?: (result: {
+        id?: string;
+        data: TValues;
+    }) => void;
+    onError?: (error: {
+        status: number;
+        message: string;
+        details?: unknown;
+    }) => void;
+}
+export interface FormFieldState {
+    value: unknown;
+    error?: string;
+    touched: boolean;
+    visible: boolean;
+}
+export interface UseBeechFormReturn<TValues extends Record<string, unknown> = Record<string, unknown>> {
+    seedSlug: string;
+    schema: FormSeedSchema | null;
+    isLoadingSchema: boolean;
+    values: TValues;
+    errors: Record<string, string | undefined>;
+    touched: Record<string, boolean | undefined>;
+    isSubmitting: boolean;
+    isSuccess: boolean;
+    isDraftRestored: boolean;
+    serverError: string | null;
+    timeTrapReady: boolean;
+    honeypotName: string;
+    honeypotValue: string;
+    translations: FormTranslations;
+    setFieldValue: (field: string, value: unknown) => void;
+    setFieldTouched: (field: string, isTouched?: boolean) => void;
+    setFieldError: (field: string, error?: string) => void;
+    setHoneypotValue: (value: string) => void;
+    isFieldVisible: (field: string) => boolean;
+    register: (field: string) => {
+        name: string;
+        value: string | number | readonly string[] | undefined;
+        onChange: (e: React.ChangeEvent<HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement>) => void;
+        onBlur: () => void;
+        'aria-invalid'?: boolean;
+        'aria-required'?: boolean;
+        'aria-describedby'?: string;
+    };
+    registerHoneypot: () => {
+        name: string;
+        value: string;
+        onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
+        tabIndex: number;
+        autoComplete: string;
+        'aria-hidden': boolean;
+    };
+    handleFileChange: (field: string, file: File | null) => Promise<void>;
+    handleSubmit: (e?: React.FormEvent<HTMLFormElement>) => Promise<boolean>;
+    reset: () => void;
+    clearDraft: () => void;
+}
+export interface BeechFormProps<TValues extends Record<string, unknown> = Record<string, unknown>> extends UseBeechFormOptions<TValues> {
+    className?: string;
+    children?: ReactNode | ((form: UseBeechFormReturn<TValues>) => ReactNode);
+}
+export interface FormFieldProps {
+    branch: FormBranchSchema;
+    form: UseBeechFormReturn;
+    className?: string;
+}
+export interface HoneypotFieldProps {
+    name?: string;
+    value?: string;
+    onChange?: (value: string) => void;
+    form?: UseBeechFormReturn<any>;
+    label?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAEtC,MAAM,MAAM,cAAc,GACtB,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,SAAS,GACT,QAAQ,GACR,MAAM,GACN,MAAM,GACN,OAAO,CAAA;AAEX,MAAM,MAAM,mBAAmB,GAC3B,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,QAAQ,GACR,UAAU,GACV,cAAc,GACd,UAAU,CAAA;AAEd,MAAM,WAAW,eAAe;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,EAAE,EAAE,mBAAmB,CAAA;IACvB,KAAK,CAAC,EAAE,OAAO,CAAA;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,cAAc,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,OAAO,CAAC,EAAE,KAAK,CAAC;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC,CAAA;IAC1D,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,SAAS,CAAC,EAAE,eAAe,GAAG,eAAe,EAAE,CAAA;IAC/C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,gBAAgB,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,kBAAkB;IACjC,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,gBAAgB;IAC/B,YAAY,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,MAAM,CAAA;IACxB,YAAY,EAAE,MAAM,CAAA;IACpB,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,EAAE,MAAM,CAAA;IAClB,mBAAmB,EAAE,MAAM,CAAA;IAC3B,aAAa,EAAE,MAAM,CAAA;IACrB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,eAAe,EAAE,MAAM,CAAA;IACvB,YAAY,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAA;IACvC,aAAa,EAAE,MAAM,CAAA;IACrB,eAAe,EAAE,MAAM,CAAA;IACvB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,MAAM,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;AAEhC,MAAM,WAAW,mBAAmB,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACpG,IAAI,EAAE,MAAM,GAAG,cAAc,CAAA;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,YAAY,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAA;IACxC,aAAa,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAA;IAChC,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE;QAAE,EAAE,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,CAAA;IAC5D,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,KAAK,IAAI,CAAA;CAClF;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,OAAO,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;CACjB;AAED,MAAM,WAAW,kBAAkB,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IACnG,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,EAAE,cAAc,GAAG,IAAI,CAAA;IAC7B,eAAe,EAAE,OAAO,CAAA;IACxB,MAAM,EAAE,OAAO,CAAA;IACf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAA;IAC1C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,SAAS,CAAC,CAAA;IAC5C,YAAY,EAAE,OAAO,CAAA;IACrB,SAAS,EAAE,OAAO,CAAA;IAClB,eAAe,EAAE,OAAO,CAAA;IACxB,WAAW,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,aAAa,EAAE,OAAO,CAAA;IACtB,YAAY,EAAE,MAAM,CAAA;IACpB,aAAa,EAAE,MAAM,CAAA;IACrB,YAAY,EAAE,gBAAgB,CAAA;IAC9B,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,KAAK,IAAI,CAAA;IACtD,eAAe,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,KAAK,IAAI,CAAA;IAC7D,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,KAAK,IAAI,CAAA;IACtD,gBAAgB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IACzC,cAAc,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAA;IAC1C,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK;QAC3B,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,MAAM,EAAE,GAAG,SAAS,CAAA;QACtD,QAAQ,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,GAAG,mBAAmB,GAAG,iBAAiB,CAAC,KAAK,IAAI,CAAA;QACpG,MAAM,EAAE,MAAM,IAAI,CAAA;QAClB,cAAc,CAAC,EAAE,OAAO,CAAA;QACxB,eAAe,CAAC,EAAE,OAAO,CAAA;QACzB,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAC5B,CAAA;IACD,gBAAgB,EAAE,MAAM;QACtB,IAAI,EAAE,MAAM,CAAA;QACZ,KAAK,EAAE,MAAM,CAAA;QACb,QAAQ,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,CAAC,KAAK,IAAI,CAAA;QAC1D,QAAQ,EAAE,MAAM,CAAA;QAChB,YAAY,EAAE,MAAM,CAAA;QACpB,aAAa,EAAE,OAAO,CAAA;KACvB,CAAA;IACD,gBAAgB,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,GAAG,IAAI,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACrE,YAAY,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,CAAC,eAAe,CAAC,KAAK,OAAO,CAAC,OAAO,CAAC,CAAA;IACxE,KAAK,EAAE,MAAM,IAAI,CAAA;IACjB,UAAU,EAAE,MAAM,IAAI,CAAA;CACvB;AAED,MAAM,WAAW,cAAc,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAC/F,SAAQ,mBAAmB,CAAC,OAAO,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,SAAS,GAAG,CAAC,CAAC,IAAI,EAAE,kBAAkB,CAAC,OAAO,CAAC,KAAK,SAAS,CAAC,CAAA;CAC1E;AAED,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,gBAAgB,CAAA;IACxB,IAAI,EAAE,kBAAkB,CAAA;IACxB,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAA;IAClC,IAAI,CAAC,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAA;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAA;CACf"}

package/dist/types.js

@@ -0,0 +1,4 @@
+// SPDX-License-Identifier: MIT
+// Copyright (c) 2024–2026 Flavio De Musso
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,+BAA+B;AAC/B,0CAA0C"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@beechcms/forms-react",
+  "version": "1.0.0",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "peerDependencies": {
+    "react": "^18.0.0 || ^19.0.0",
+    "react-dom": "^18.0.0 || ^19.0.0"
+  },
+  "dependencies": {
+    "@beechcms/client": "^0.8.0-preview.1",
+    "@beechcms/core": "^0.8.0"
+  },
+  "devDependencies": {
+    "@testing-library/jest-dom": "^6.6.3",
+    "@testing-library/react": "^16.3.0",
+    "@types/node": "^24.10.1",
+    "@types/react": "^19.2.7",
+    "@types/react-dom": "^19.2.3",
+    "@vitejs/plugin-react": "^5.2.0",
+    "@vitest/coverage-v8": "^4.1.0",
+    "jsdom": "^25.0.1",
+    "react": "^19.2.7",
+    "react-dom": "^19.2.7",
+    "typescript": "^5.9.3",
+    "vite": "^8.2.1",
+    "vitest": "^4.1.0"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w --preserveWatchOutput",
+    "lint": "eslint .",
+    "type-check": "tsc --noEmit",
+    "playground": "vite --port 5175",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage"
+  }
+}