@kubuild/renderer 0.1.0 → 0.2.0

package/dist/form-context.d.ts

@@ -0,0 +1,114 @@
+import React from 'react';
+import type { FormConfig, FormFieldBinding, ActionPipeline, PageDocument, ValidationRule, ValidateOnEvent } from '@kubuild/schema';
+import { type Diagnostic } from '@kubuild/core';
+/**
+ * Form Runtime State representation.
+ */
+export interface FormRuntimeState {
+    values: Record<string, unknown>;
+    errors: Record<string, string>;
+    touched: Record<string, boolean>;
+    isSubmitting: boolean;
+    isValid: boolean;
+    dirty: boolean;
+}
+/**
+ * Partial / input structure for registering a field binding.
+ */
+export interface FormFieldBindingInput {
+    name: string;
+    label?: string;
+    defaultValue?: unknown;
+    rules?: ValidationRule[];
+    validateOn?: ValidateOnEvent;
+    transform?: 'trim' | 'lowercase' | 'uppercase' | 'number';
+    disabled?: boolean;
+    required?: boolean;
+}
+/**
+ * Form Runtime Context Value containing state and mutation callbacks.
+ */
+export interface FormRuntimeContextValue extends FormRuntimeState {
+    formId: string;
+    formConfig?: FormConfig;
+    initialValues: Record<string, unknown>;
+    setFieldValue: (name: string, value: unknown, shouldValidate?: boolean) => void;
+    setFieldTouched: (name: string, isTouched?: boolean, shouldValidate?: boolean) => void;
+    setFieldError: (name: string, error: string | null) => void;
+    setErrors: (errors: Record<string, string>) => void;
+    setValues: (values: Record<string, unknown>, replace?: boolean) => void;
+    setSubmitting: (isSubmitting: boolean) => void;
+    resetForm: (nextInitialValues?: Record<string, unknown>) => void;
+    validateField: (name: string, value?: unknown) => string | null;
+    validateForm: (valuesToValidate?: Record<string, unknown>) => Record<string, string>;
+    handleFormSubmit: (e?: React.FormEvent | Event) => Promise<boolean>;
+    registerField: (binding: FormFieldBindingInput) => () => void;
+    getFieldBinding: (name: string) => FormFieldBinding | undefined;
+}
+/**
+ * FormRuntimeContext for consuming form state across the React tree.
+ */
+export declare const FormRuntimeContext: React.Context<FormRuntimeContextValue | null>;
+/**
+ * Props for FormRuntimeProvider.
+ */
+export interface FormRuntimeProviderProps {
+    formId?: string;
+    formConfig?: FormConfig;
+    initialValues?: Record<string, unknown>;
+    onSubmit?: (values: Record<string, unknown>, helpers: {
+        formId: string;
+        setSubmitting: (isSubmitting: boolean) => void;
+        resetForm: (nextInitialValues?: Record<string, unknown>) => void;
+        setErrors: (errors: Record<string, string>) => void;
+    }) => Promise<void> | void;
+    onSuccess?: (values: Record<string, unknown>) => void;
+    onError?: (errors: Record<string, string>) => void;
+    actions?: ActionPipeline[];
+    nodeId?: string;
+    document?: PageDocument;
+    onDiagnostic?: (diagnostic: Diagnostic) => void;
+    children: React.ReactNode;
+}
+/**
+ * FormRuntimeProvider manages local reactive form state, field validation,
+ * submission handling, and action pipeline execution.
+ */
+export declare const FormRuntimeProvider: React.FC<FormRuntimeProviderProps>;
+/**
+ * Hook to access the current FormRuntimeContext.
+ * Returns null if invoked outside of a FormRuntimeProvider.
+ */
+export declare function useFormRuntime(): FormRuntimeContextValue | null;
+/**
+ * Hook to access the current FormRuntimeContext (alias for useFormRuntime).
+ */
+export declare function useFormContext(): FormRuntimeContextValue | null;
+/**
+ * Hook providing status properties of the nearest form context.
+ */
+export declare function useFormStatus(): {
+    isSubmitting: boolean;
+    isValid: boolean;
+    dirty: boolean;
+    errors: Record<string, string>;
+};
+/**
+ * Result returned by the `useFormField` hook.
+ */
+export interface UseFormFieldReturn<T = unknown> {
+    value: T;
+    error?: string;
+    touched: boolean;
+    isInvalid: boolean;
+    setValue: (value: T, shouldValidate?: boolean) => void;
+    setTouched: (touched?: boolean, shouldValidate?: boolean) => void;
+    setError: (error: string | null) => void;
+    onChange: (e: React.ChangeEvent<HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement> | T) => void;
+    onBlur: (e?: React.FocusEvent<HTMLInputElement | HTMLTextAreaElement | HTMLSelectElement>) => void;
+}
+/**
+ * Hook to bind a field component to the nearest FormRuntimeContext.
+ */
+export declare function useFormField<T = unknown>(name: string, binding?: FormFieldBindingInput): UseFormFieldReturn<T>;
+//# sourceMappingURL=form-context.d.ts.map

package/dist/form-context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"form-context.d.ts","sourceRoot":"","sources":["../src/form-context.tsx"],"names":[],"mappings":"AAAA,OAAO,KAQN,MAAM,OAAO,CAAC;AACf,OAAO,KAAK,EACV,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,YAAY,EACZ,cAAc,EACd,eAAe,EAChB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAKL,KAAK,UAAU,EAChB,MAAM,eAAe,CAAC;AAIvB;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAChC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC/B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,YAAY,EAAE,OAAO,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,UAAU,CAAC,EAAE,eAAe,CAAC;IAC7B,SAAS,CAAC,EAAE,MAAM,GAAG,WAAW,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC1D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAGvC,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,cAAc,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IAChF,eAAe,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,OAAO,EAAE,cAAc,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IACvF,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;IAC5D,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC;IACpD,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IACxE,aAAa,EAAE,CAAC,YAAY,EAAE,OAAO,KAAK,IAAI,CAAC;IAC/C,SAAS,EAAE,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;IACjE,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,OAAO,KAAK,MAAM,GAAG,IAAI,CAAC;IAChE,YAAY,EAAE,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrF,gBAAgB,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS,GAAG,KAAK,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;IAGpE,aAAa,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,MAAM,IAAI,CAAC;IAC9D,eAAe,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,gBAAgB,GAAG,SAAS,CAAC;CACjE;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,+CAAsD,CAAC;AAEtF;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACxC,QAAQ,CAAC,EAAE,CACT,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,OAAO,EAAE;QACP,MAAM,EAAE,MAAM,CAAC;QACf,aAAa,EAAE,CAAC,YAAY,EAAE,OAAO,KAAK,IAAI,CAAC;QAC/C,SAAS,EAAE,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;QACjE,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC;KACrD,KACE,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;IAC1B,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,IAAI,CAAC;IACtD,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC;IACnD,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;IAC3B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,YAAY,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,KAAK,IAAI,CAAC;IAChD,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B;AAkBD;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,KAAK,CAAC,EAAE,CAAC,wBAAwB,CAialE,CAAC;AAEF;;;GAGG;AACH,wBAAgB,cAAc,IAAI,uBAAuB,GAAG,IAAI,CAE/D;AAED;;GAEG;AACH,wBAAgB,cAAc,IAAI,uBAAuB,GAAG,IAAI,CAE/D;AAED;;GAEG;AACH,wBAAgB,aAAa,IAAI;IAC/B,YAAY,EAAE,OAAO,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAChC,CAQA;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,GAAG,OAAO;IAC7C,KAAK,EAAE,CAAC,CAAC;IACT,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,cAAc,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IACvD,UAAU,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,EAAE,cAAc,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IAClE,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;IACzC,QAAQ,EAAE,CAAC,CAAC,EAAE,KAAK,CAAC,WAAW,CAAC,gBAAgB,GAAG,mBAAmB,GAAG,iBAAiB,CAAC,GAAG,CAAC,KAAK,IAAI,CAAC;IACzG,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,UAAU,CAAC,gBAAgB,GAAG,mBAAmB,GAAG,iBAAiB,CAAC,KAAK,IAAI,CAAC;CACpG;AAED;;GAEG;AACH,wBAAgB,YAAY,CAAC,CAAC,GAAG,OAAO,EACtC,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,qBAAqB,GAC9B,kBAAkB,CAAC,CAAC,CAAC,CAqFvB"}