@xyo-network/react-form-group 6.1.4 → 7.0.0

package/dist/browser/index.d.ts

@@ -1,393 +1,6 @@
-import * as react from 'react';
-import { PropsWithChildren } from 'react';
-import * as _xylabs_react_shared from '@xylabs/react-shared';
-import { ContextExState } from '@xylabs/react-shared';
-import { BaseParams } from '@xylabs/base';
-import { ModuleBaseEmitter } from '@xyo-network/module-event-emitter';
-import * as _xyo_network_payload_model from '@xyo-network/payload-model';
-import { Payload } from '@xyo-network/payload-model';
-import { Promisable } from '@xylabs/promise';
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import { EmptyObject } from '@xylabs/object';
-import { ArchivistInstance } from '@xyo-network/archivist-model';
-
-type ValidControlValue = string | undefined;
-
-interface SetOptions {
-    disableEmit?: boolean;
-}
-interface ControlSerializeSettings {
-    sensitive?: boolean;
-    serializable?: boolean;
-}
-interface ControlValueAccessor<T = ValidControlValue> {
-    readonly error: string;
-    readonly previousValue: T;
-    readonly serializeSettings: ControlSerializeSettings;
-    readonly touched: boolean;
-    readonly value: T;
-    registerOnChange(fn: (value: T) => void): void;
-    registerOnErrorChange(fn: (error: string) => void): void;
-    registerOnTouched(fn: (isTouched: boolean) => void): void;
-    setTouched(isTouched: boolean): void;
-    setValue(fieldValue: T, options?: SetOptions): void;
-}
-
-type ControlValueAccessorBaseConfig = {
-    disableEvents?: boolean;
-};
-declare const DefaultSetOptions: SetOptions;
-type ControlValueAccessorBaseEvents<TValue = ValidControlValue> = {
-    errorChanged: {
-        error: string;
-    };
-    touchChanged: {
-        touched: boolean;
-    };
-    valueChanged: {
-        value: TValue;
-    };
-};
-/**
- * The base class for control value accessors interface
- */
-declare class ControlValueAccessorBase<TValue = ValidControlValue, TEventData extends ControlValueAccessorBaseEvents<TValue> = ControlValueAccessorBaseEvents<TValue>> extends ModuleBaseEmitter<BaseParams, TEventData> implements ControlValueAccessor<TValue> {
-    private config;
-    private _error;
-    private _previousValue;
-    private _serializeSettings;
-    private _touched;
-    private _value;
-    constructor(config: ControlValueAccessorBaseConfig);
-    /**
-     * The error message for the control.
-     */
-    get error(): string;
-    /**
-     * The "previous value" of the input element.
-     */
-    get previousValue(): TValue;
-    /**
-     * The serialize settings of the input element.
-     */
-    get serializeSettings(): ControlSerializeSettings;
-    /**
-     * The "touched" state of the input element.
-     */
-    get touched(): boolean;
-    /**
-     * The current value of the input element.
-     */
-    get value(): TValue;
-    /**
-     * The registered callback function called when a change or input event occurs on the input
-     * element.
-     */
-    onChange: (_: TValue) => void;
-    /**
-     * Registers a function called when the control error changes.
-     */
-    onErrorChange: (error: string) => void;
-    /**
-     * The registered callback function called when a blur event occurs on the input element.
-     */
-    onTouched: (_isTouched: boolean) => void;
-    /**
-     * Registers a function called when the control value changes.
-     * @param  {(_value:ValidControlValue)=>void} fn
-     * @returns void
-     */
-    registerOnChange(fn: (_value: TValue) => void): void;
-    /**
-     * Registers a function called when the control error changes.
-     * @param  {(error:string)=>void} fn
-     */
-    registerOnErrorChange(fn: (error: string) => void): void;
-    /**
-     * Registers a function called when the control is touched.
-     * @param  {(isTouched:boolean)=>void} fn
-     * @returns void
-     */
-    registerOnTouched(fn: (isTouched: boolean) => void): void;
-    /**
-     * Sets the "touched" state of the input element.
-     * @param  {boolean} isTouched
-     */
-    setTouched(isTouched: boolean): void;
-    /**
-     * Sets the "value" property on the input element.
-     * @param  {ValidControlValue} value
-     * @returns void
-     */
-    setValue(value: TValue, options?: SetOptions): void;
-    /**
-     * Set the error message for the control.
-     * @param  {string} error
-     */
-    protected setError(error: string): void;
-    /**
-     * Sets the "previous value" of the input element.
-     * @param  {ValidControlValue} value
-     * @returns void
-     */
-    protected setPreviousValue(value: TValue): void;
-    /**
-     * Sets the serialize settings  of the input element.
-     * @param  {ControlSerializeSettings} settings
-     */
-    protected setSerializeSettings(settings: ControlSerializeSettings): void;
-}
-
-/**
- * Reports that a control is valid, meaning that no errors exist in the input value.
- */
-declare const VALID: "VALID";
-/**
- * Reports that a control is invalid, meaning that an error exists in the input value.
- */
-declare const INVALID: "INVALID";
-/**
- * Reports that a control is pending, meaning that async validation is occurring and
- * errors are not yet available for the input value.
- */
-declare const PENDING: "PENDING";
-/**
- * Reports that a control is disabled, meaning that the control is exempt from ancestor
- * calculations of validity or value.
- */
-declare const DISABLED: "DISABLED";
-/**
- * A control can have several different statuses. Each
- * possible status is returned as a string literal.
- *
- * * **VALID**: Reports that a control is valid, meaning that no errors exist in the input
- * value.
- * * **INVALID**: Reports that a control is invalid, meaning that an error exists in the input
- * value.
- * * **PENDING**: Reports that a control is pending, meaning that async validation is
- * occurring and errors are not yet available for the input value.
- * * **DISABLED**: Reports that a control is
- * disabled, meaning that the control is exempt from ancestor calculations of validity or value.
- */
-type FormControlStatus = typeof VALID | typeof INVALID | typeof PENDING | typeof DISABLED;
-
-type AbstractControlEvents<TValue> = ControlValueAccessorBaseEvents<TValue> & {
-    statusChanged: {
-        status: FormControlStatus;
-    };
-};
-/**
- * This is the base class for `Control` classes (i.e. FormControl),
- *
- * It provides some of the shared behavior that all controls and groups of controls have, like
- * running validators, calculating status, and resetting state. It also defines the properties
- * that are shared between all sub-classes, like `value`, `valid`, and `dirty`. It shouldn't be
- * instantiated directly.
- *
- * NOTE: Heavily borrowed from Angular's AbstractControl:
- * https://github.com/angular/angular/blob/5dcdbfcba934a930468aec140a7183b034466bdf/packages/forms/src/model/abstract_model.ts
- */
-declare class AbstractControl<TValue extends ValidControlValue = ValidControlValue> extends ControlValueAccessorBase<TValue, AbstractControlEvents<TValue>> {
-    private _status;
-    constructor();
-    /**
-     * A control is `disabled` when its `status` is `DISABLED`.
-     *
-     * Disabled controls are exempt from validation checks and
-     * are not included in the aggregate value of their ancestor
-     * controls.
-     *
-     * @returns True if the control is disabled, false otherwise.
-     */
-    /** @deprecated - disabled functionality not implemented */
-    get disabled(): boolean;
-    /**
-     * A control is `enabled` as long as its `status` is not `DISABLED`.
-     *
-     * @returns True if the control has any status other than 'DISABLED',
-     * false if the status is 'DISABLED'.
-     */
-    get enabled(): boolean;
-    /**
-     * A control is `invalid` when its `status` is `INVALID`.
-  
-     *
-     * @returns True if this control has failed one or more of its validation checks,
-     * false otherwise.
-     */
-    get invalid(): boolean;
-    /**
-     * A control is `pending` when its `status` is `PENDING`.
-     *
-     * @returns True if this control is in the process of conducting a validation check,
-     * false otherwise.
-     */
-    get pending(): boolean;
-    /**
-     * The raw value of the control.
-     */
-    get rawValue(): TValue;
-    /**
-     * The current status of the control.
-     */
-    get status(): FormControlStatus | undefined;
-    /**
-     * A control is `valid` when its `status` is `VALID`.
-     *
-     * @returns True if the control has passed all of its validation tests,
-     * false otherwise.
-     */
-    get valid(): boolean;
-    setErrorAndValidity(error: string, status: FormControlStatus): void;
-    setStatus(status: FormControlStatus): void;
-    validate(): boolean;
-}
-
-type CursorPosition = {
-    current: number | undefined;
-    previous: number | undefined;
-};
-interface FormControlValidator {
-    blurError?: (value: string) => void;
-    changeError?: (value: string) => void;
-    pattern?: RegExp;
-    patternStrict?: RegExp;
-    required?: boolean;
-}
-interface FormControlMask {
-    cursorPosition: CursorPosition;
-    getCursorPosition?: () => number | undefined;
-    mask?: (value: string) => string;
-    onCursorChange?: (cursor: number | undefined) => void;
-    unmask?: (value: string) => string;
-}
-interface FormControl<TProps extends EmptyObject = EmptyObject> extends FormControlValidator, FormControlMask, AbstractControl {
-    readonly name?: string;
-    props: TProps;
-}
-
-/**
- * A base class for form controls and their validation.
- */
-declare abstract class FormControlBase<TProps extends EmptyObject = EmptyObject> extends AbstractControl implements FormControl {
-    /**
-     * The current and previous cursor position of the input element.
-     */
-    cursorPosition: CursorPosition;
-    invalidMessage: string;
-    pattern: RegExp;
-    patternStrict: RegExp;
-    props: TProps;
-    required: boolean;
-    private _name;
-    constructor();
-    get name(): string | undefined;
-    get rawValue(): ValidControlValue;
-    blurError?(value: string): void | undefined;
-    changeError?(value: string): void;
-    getCursorPosition?(): number | undefined;
-    mask?(value: string): string;
-    onCursorChange: (cursor: number | undefined) => void;
-    setValue(value: string | undefined, setOptions: SetOptions): void;
-    unmask?(value: string): string;
-    validate(): boolean;
-    protected setName(name: string | undefined): void;
-}
-
-type ErrorSummary = {
-    errorMessage: string;
-    invalidFields: string[];
-};
-
-interface FormGroupStorage<TValue extends Payload = Payload> {
-    clear: () => Promisable<void>;
-    get: () => Promisable<TValue | undefined>;
-    insert: (state: TValue) => Promisable<void>;
-}
-
-declare class ArchivistFormGroupStorage implements FormGroupStorage {
-    private archivist;
-    constructor(archivist: ArchivistInstance);
-    clear(): Promise<void>;
-    get(): Promise<_xyo_network_payload_model.WithStorageMeta<_xyo_network_payload_model.WithStorageMeta<Payload>> | undefined>;
-    insert(value: Payload): Promise<void>;
-}
-
-type PayloadWithTimestamp = Payload<{
-    timestamp?: number;
-}>;
-type KeyOfString<T> = keyof T extends string ? keyof T : never;
-type FormGroupErrors<TValue> = Record<KeyOfString<TValue>, string>;
-type FormGroupParams<TStorageValue extends Payload = Payload> = {
-    serialize?: boolean;
-    storage?: {
-        sensitive?: FormGroupStorage<TStorageValue>;
-        storage?: FormGroupStorage<TStorageValue>;
-    };
-    ttlStorage?: number;
-};
-/**
- * Organize form controls in a group.
- *
- * NOTE: This is a work in progress and only supports top level controls.  Nested controls are not supported.
- */
-declare class FormGroup<TValue extends PayloadWithTimestamp = PayloadWithTimestamp, TStorageValue extends PayloadWithTimestamp = PayloadWithTimestamp> extends AbstractControl {
-    private fgParams?;
-    private _controls;
-    private serializeListeners;
-    private serializedSensitiveState;
-    private serializedState;
-    constructor(fgParams?: FormGroupParams<TStorageValue> | undefined);
-    get errorSummary(): ErrorSummary;
-    get errors(): FormGroupErrors<TValue>;
-    get nonSensitiveStorage(): FormGroupStorage<TStorageValue> | undefined;
-    get sensitiveStorage(): FormGroupStorage<TStorageValue> | undefined;
-    get touched(): boolean;
-    get valid(): boolean;
-    get values(): TValue;
-    getControl(name: string): Record<KeyOfString<TValue>, AbstractControl<ValidControlValue>>[KeyOfString<TValue>];
-    getSerializedValue(name: string, sensitive?: boolean): Promise<string | undefined>;
-    registerControl(name: string, control: AbstractControl): void;
-    resetControls(): void;
-    resetValues(): void;
-    unregisterControl(name: string): void;
-    validateFields(requiredFields?: string[] | undefined): void;
-    private serializeControlValue;
-    private serializeValues;
-    private setStateValueFromStorage;
-}
-
-declare const FormGroupBaseContext: react.Context<({
-    formGroup?: FormGroup<_xyo_network_payload_model.Payload, _xyo_network_payload_model.Payload> | undefined;
-} & {
-    provided: true;
-}) | (_xylabs_react_shared.FixedValues<_xylabs_react_shared.ProvidedContextExState<{
-    formGroup?: FormGroup<_xyo_network_payload_model.Payload, _xyo_network_payload_model.Payload> | undefined;
-}>, never> & {
-    provided: false;
-}) | (_xylabs_react_shared.FixedValues<_xylabs_react_shared.NotProvidedContextExState<{
-    formGroup?: FormGroup<_xyo_network_payload_model.Payload, _xyo_network_payload_model.Payload> | undefined;
-}>, never> & {
-    provided: false;
-})>;
-
-interface FormGroupPayloadProviderProps<TStorage extends Payload = Payload> extends PropsWithChildren {
-    params?: FormGroupParams<TStorage>;
-}
-/**
- * Provides a FormGroup to child components.
- */
-declare const FormGroupPayloadProvider: ({ children, params, ...props }: FormGroupPayloadProviderProps) => react_jsx_runtime.JSX.Element;
-
-type FormGroupContextWithPayloadState<TValue extends Payload = Payload, TStorageValue extends Payload = Payload> = ContextExState<{
-    formGroup?: FormGroup<TValue, TStorageValue>;
-}>;
-
-declare const useFormGroup: (required?: boolean) => Omit<{
-    formGroup?: FormGroup<_xyo_network_payload_model.Payload, _xyo_network_payload_model.Payload> | undefined;
-} & {
-    provided: true;
-}, "provided"> | Omit<_xylabs_react_shared.NotProvidedContextExState<FormGroupContextWithPayloadState>, "provided">;
-
-export { AbstractControl, ArchivistFormGroupStorage, ControlValueAccessorBase, DISABLED, DefaultSetOptions, FormControlBase, FormGroup, FormGroupBaseContext, FormGroupPayloadProvider, INVALID, PENDING, VALID, useFormGroup };
-export type { AbstractControlEvents, ControlSerializeSettings, ControlValueAccessor, ControlValueAccessorBaseConfig, ControlValueAccessorBaseEvents, CursorPosition, ErrorSummary, FormControl, FormControlMask, FormControlStatus, FormControlValidator, FormGroupContextWithPayloadState, FormGroupParams, FormGroupPayloadProviderProps, FormGroupStorage, KeyOfString, PayloadWithTimestamp, SetOptions, ValidControlValue };
+export * from './context/index.ts';
+export * from './control/index.ts';
+export * from './FormGroup.ts';
+export * from './InputError.ts';
+export * from './storage/index.ts';
+//# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/react-form-group",
-  "version": "6.1.4",
+  "version": "7.0.0",
   "description": "Common React library for all XYO projects that use React",
   "keywords": [
     "xyo",
@@ -38,26 +38,30 @@
   },
   "module": "dist/browser/index.mjs",
   "types": "dist/browser/index.d.ts",
+  "files": [
+    "dist",
+    "src"
+  ],
   "dependencies": {
-    "@xylabs/base": "^4.13.23",
-    "@xylabs/forget": "^4.13.23",
-    "@xylabs/object": "^4.13.23",
-    "@xylabs/promise": "^4.13.23",
-    "@xylabs/react-shared": "^6.3.13",
-    "@xyo-network/archivist-model": "^4.1.7",
-    "@xyo-network/module-event-emitter": "^4.1.7",
-    "@xyo-network/payload-model": "^4.1.7"
+    "@xylabs/base": "^5.0.0",
+    "@xylabs/forget": "^5.0.0",
+    "@xylabs/object": "^5.0.0",
+    "@xylabs/promise": "^5.0.0",
+    "@xylabs/react-shared": "^7.0.0",
+    "@xyo-network/archivist-model": "^5.0.0",
+    "@xyo-network/module-event-emitter": "^5.0.0",
+    "@xyo-network/payload-model": "^5.0.0"
   },
   "devDependencies": {
     "@mui/icons-material": "^7.2.0",
     "@mui/material": "^7.2.0",
     "@storybook/react-vite": "^9.0.18",
-    "@types/react": "^19.1.8",
-    "@xylabs/events": "^4.13.23",
-    "@xylabs/ts-scripts-yarn3": "next",
-    "@xylabs/tsconfig-react": "next",
-    "react": "^19.1.0",
-    "react-dom": "^19.1.0",
+    "@types/react": "^19.1.9",
+    "@xylabs/events": "^5.0.0",
+    "@xylabs/ts-scripts-yarn3": "^7.0.2",
+    "@xylabs/tsconfig-react": "^7.0.2",
+    "react": "^19.1.1",
+    "react-dom": "^19.1.1",
     "storybook": "^9.0.18",
     "typescript": "^5.8.3"
   },

package/typedoc.json

@@ -1,5 +0,0 @@
-{
-  "$schema": "https://typedoc.org/schema.json",
-  "entryPoints": ["src/index.ts"],
-  "tsconfig": "./tsconfig.typedoc.json"
-}

package/xy.config.ts

@@ -1,10 +0,0 @@
-import type { XyTsupConfig } from '@xylabs/ts-scripts-yarn3'
-const config: XyTsupConfig = {
-  compile: {
-    browser: { src: true },
-    node: {},
-    neutral: {},
-  },
-}
-
-export default config