@cyclone-ui/state 0.0.2

package/dist/form/types.d.cts

@@ -0,0 +1,288 @@
+import { AtomRecordConstraint, SetStateActionWithReset, SplitAtomAction } from "../types.cjs";
+import { MoleculeState } from "../base/utilities/create-molecule.cjs";
+import { Atom, Getter, PrimitiveAtom, SetStateAction, Setter, WritableAtom } from "jotai";
+import { RESET } from "jotai/utils";
+import { Ref } from "react";
+import { MaskitoOptions } from "@maskito/core";
+import { MaybePromise } from "@stryke/types/base";
+import { SelectOption, SelectOptionValue } from "@stryke/types/form";
+import { IsPlainObject } from "@stryke/types/object";
+import { ValidationDetail } from "@stryke/types/validations";
+//#region src/form/types.d.ts
+/**
+ * "server" is only intended for SSR/SSG validation and should not execute anything
+ */
+type ValidationCause = "initialize" | "change" | "blur" | "submit" | "server";
+declare const ValidationCause: {
+  INITIALIZE: ValidationCause;
+  CHANGE: ValidationCause;
+  BLUR: ValidationCause;
+  SUBMIT: ValidationCause;
+  SERVER: ValidationCause;
+};
+type Validator<TValue = any> = (value: TValue, previousValue: TValue, cause: ValidationCause, get: Getter, set: Setter) => MaybePromise<ValidationDetail[]>;
+type ValidationResults = Partial<Record<ValidationCause, ValidationDetail[]>>;
+/**
+ * The field status.
+ */
+type FieldStatus = "primary" | "secondary" | "discovery" | "success" | "info" | "warning" | "danger" | "positive" | "negative";
+type InferFieldState<TValues, TState> = IsPlainObject<TValues> extends true ? { [TKey in keyof TValues]: InferFieldState<TValues[TKey], TState>; } : TState;
+type InferFormState<TValues extends Record<string, any>, TState> = { [TKey in keyof TValues]: InferFieldState<TValues[TKey], TState>; };
+type FormValuesState<TValues extends Record<string, any>> = TValues & { [TKey in keyof TValues]: IsPlainObject<TValues[TKey]> extends true ? FormValuesState<TValues[TKey]> : TValues[TKey] | null; };
+type FieldChangeEventHandler<TFieldValue = any> = (event: CustomEvent<TFieldValue>) => any;
+interface CallbackContext<TState extends AtomRecordConstraint<TState> = Record<string, Atom<unknown>>> {
+  get: Getter;
+  set: Setter;
+  atoms: MoleculeState<TState>;
+}
+/**
+ * The form options.
+ */
+interface FormOptions<TFormValues extends Record<string, any> = Record<string, any>> {
+  /**
+   * The theme of the form.
+   */
+  theme?: string;
+  /**
+   * The disabled state value.
+   *
+   * @defaultValue false
+   */
+  disabled?: boolean;
+  /**
+   * The initial values of the form.
+   */
+  initialValues?: FormValuesState<TFormValues>;
+  /**
+   * The validations to run on the form when certain events occur.
+   */
+  validate?: Record<`on${Capitalize<ValidationCause>}`, Validator<FormValuesState<TFormValues>>[] | undefined>;
+  /**
+   * How long to debounce the `onChange` event and validation calls in milliseconds.
+   *
+   * @defaultValue 250
+   */
+  debounceMs?: number;
+  /**
+   * A function that compares two sets of form values to determine if they are equal.
+   *
+   * @remarks
+   * The default `isEqual` function is provided by the `@stryke/discoveryers` package.
+   *
+   * @defaultValue `isEqual`
+   */
+  isEqual?: (value1: FormValuesState<TFormValues>, value2: FormValuesState<TFormValues>) => boolean;
+  /**
+   * The default options provided to all fields when they are created.
+   */
+  defaultFieldOptions?: Partial<Omit<FieldOptions<TFormValues>, "name" | "mode">>;
+  /**
+   * A callback that is called when the form is initialized.
+   */
+  onInitialize?: (context: CallbackContext<FormAtoms<TFormValues>>) => MaybePromise<void>;
+  /**
+   * A callback that is called when the form is changed.
+   */
+  onChange?: (context: CallbackContext<FormAtoms<TFormValues>>) => MaybePromise<void>;
+  /**
+   * A callback that is called when the form is submitted.
+   */
+  onSubmit?: (context: CallbackContext<FormAtoms<TFormValues>>) => MaybePromise<void>;
+}
+type FormOptionsState<TFormValues extends Record<string, any> = Record<string, any>> = FormOptions<TFormValues> & Required<Pick<FormOptions<TFormValues>, "theme" | "debounceMs" | "isEqual" | "disabled" | "initialValues" | "defaultFieldOptions">>;
+interface FormAtoms<TFormValues extends Record<string, any> = Record<string, any>> {
+  options: WritableAtom<FormOptionsState<TFormValues>, [SetStateActionWithReset<FormOptions<TFormValues>>], void>;
+  name: Atom<string>;
+  initialValues: WritableAtom<FormValuesState<TFormValues>, [typeof RESET | SetStateAction<FormValuesState<TFormValues>>], void>;
+  previousValues: Atom<FormValuesState<TFormValues>>;
+  values: WritableAtom<FormValuesState<TFormValues>, [typeof RESET | SetStateAction<FormValuesState<TFormValues>>], void>;
+  disabled: WritableAtom<boolean, [typeof RESET | SetStateAction<boolean>], void>;
+  formValidating: WritableAtom<boolean, [SetStateActionWithReset<boolean>], void>;
+  validationResults: WritableAtom<ValidationResults, [SetStateActionWithReset<ValidationResults>], void>;
+  submitting: WritableAtom<boolean, [SetStateActionWithReset<boolean>], void>;
+  submitted: WritableAtom<boolean, [SetStateActionWithReset<boolean>], void>;
+  submitAttempts: WritableAtom<number, [SetStateActionWithReset<number>], void>;
+  focusedFields: WritableAtom<InferFormState<TFormValues, boolean>, [SetStateActionWithReset<InferFormState<TFormValues, boolean>>], void>;
+  requiredFields: WritableAtom<InferFormState<TFormValues, boolean>, [SetStateActionWithReset<InferFormState<TFormValues, boolean>>], void>;
+  disabledFields: WritableAtom<InferFormState<TFormValues, boolean>, [SetStateActionWithReset<InferFormState<TFormValues, boolean>>], void>;
+  touchedFields: WritableAtom<InferFormState<TFormValues, boolean>, [SetStateActionWithReset<InferFormState<TFormValues, boolean>>], void>;
+  blurredFields: WritableAtom<InferFormState<TFormValues, boolean>, [SetStateActionWithReset<InferFormState<TFormValues, boolean>>], void>;
+  validatingFields: WritableAtom<InferFormState<TFormValues, boolean>, [SetStateActionWithReset<InferFormState<TFormValues, boolean>>], void>;
+  validationResultsFields: WritableAtom<InferFormState<TFormValues, ValidationResults>, [SetStateActionWithReset<InferFormState<TFormValues, ValidationResults>>], void>;
+  tabIndexes: WritableAtom<InferFormState<TFormValues, number>, [{
+    field: string;
+    tabIndex?: number;
+  } | SetStateActionWithReset<InferFormState<TFormValues, number>>], void>;
+  refs: WritableAtom<InferFormState<TFormValues, Ref<HTMLInputElement>>, [SetStateActionWithReset<InferFormState<TFormValues, Ref<HTMLInputElement>>>], void>;
+  dirty: Atom<boolean>;
+  pristine: Atom<boolean>;
+  blurred: Atom<boolean>;
+  touched: Atom<boolean>;
+  validating: Atom<boolean>;
+  dangerMessages: Atom<ValidationDetail<"danger">[]>;
+  warningMessages: Atom<ValidationDetail<"warning">[]>;
+  infoMessages: Atom<ValidationDetail<"info">[]>;
+  discoveryMessages: Atom<ValidationDetail<"discovery">[]>;
+  successMessages: Atom<ValidationDetail<"success">[]>;
+  positiveMessages: Atom<ValidationDetail<"positive">[]>;
+  negativeMessages: Atom<ValidationDetail<"negative">[]>;
+  messages: Atom<ValidationDetail[]>;
+  dangerFields: Atom<InferFieldState<TFormValues, ValidationDetail<"danger">[]>>;
+  warningFields: Atom<InferFieldState<TFormValues, ValidationDetail<"warning">[]>>;
+  infoFields: Atom<InferFieldState<TFormValues, ValidationDetail<"info">[]>>;
+  discoveryFields: Atom<InferFieldState<TFormValues, ValidationDetail<"discovery">[]>>;
+  successFields: Atom<InferFieldState<TFormValues, ValidationDetail<"success">[]>>;
+  fieldDangerMessages: Atom<ValidationDetail<"danger">[]>;
+  fieldWarningMessages: Atom<ValidationDetail<"warning">[]>;
+  fieldInfoMessages: Atom<ValidationDetail<"info">[]>;
+  fieldHelpMessages: Atom<ValidationDetail<"discovery">[]>;
+  fieldsSuccessMessages: Atom<ValidationDetail<"success">[]>;
+  valid: Atom<boolean>;
+  invalid: Atom<boolean>;
+  canSubmit: Atom<boolean>;
+  theme: Atom<string>;
+}
+/**
+ * The field options.
+ */
+interface FieldOptions<TFieldValue> {
+  /**
+   * The default theme of the field.
+   */
+  theme?: string;
+  /**
+   * The default size of the field.
+   *
+   * @defaultValue "$true"
+   */
+  size?: `$${string}` | `$${string}.${string}` | `$${string}.${number}` | `$${number}`;
+  /**
+   * The default required status of the field.
+   *
+   * @defaultValue false
+   */
+  required?: boolean;
+  /**
+   * The default disabled status of the field.
+   *
+   * @defaultValue false
+   */
+  disabled?: boolean;
+  /**
+   * Whether the field's value can be cleared by its control.
+   *
+   * @defaultValue false
+   */
+  clearable?: boolean;
+  /**
+   * The options to be used as potential values for the field.
+   *
+   * @remarks
+   * This is only used for certain fields (e.g. `Select`, `RadioGroup`, etc.).
+   */
+  items?: Array<Partial<SelectOption> & Pick<SelectOption, "name" | "value">>;
+  /**
+   * The validations to run on the field when certain events occur.
+   */
+  validate?: Record<`on${Capitalize<ValidationCause>}`, Validator<TFieldValue>[] | undefined>;
+  /**
+   * How long to debounce the `onChange` event and validation calls in milliseconds.
+   *
+   * @defaultValue 250
+   */
+  debounceMs?: number;
+  /**
+   * A function that compares two field values to determine if they are equal.
+   *
+   * @remarks
+   * The default `isEqual` function is provided by the `@stryke/discoveryers` package.
+   *
+   * @defaultValue `isEqual`
+   */
+  isEqual?: (value1: TFieldValue, value2: TFieldValue) => boolean;
+  /**
+   * The options provided to the Maskito library when masking user input
+   *
+   * @remarks
+   * More information can be found in the [Maskito documentation](https://maskito.dev/core-concepts/overview).
+   *
+   * API reference: https://github.com/taiga-family/maskito/blob/main/projects/core/src/lib/types/mask-options.ts
+   */
+  mask?: MaskitoOptions;
+  /**
+   * A callback that is called when the field is initialized.
+   */
+  onInitialize?: (context: CallbackContext<FieldAtoms<TFieldValue>>) => MaybePromise<void>;
+  /**
+   * A callback that is called when the field is blurred.
+   */
+  onBlur?: (context: CallbackContext<FieldAtoms<TFieldValue>>) => MaybePromise<void>;
+  /**
+   * A callback that is called when the field is focused.
+   */
+  onFocus?: (context: CallbackContext<FieldAtoms<TFieldValue>>) => MaybePromise<void>;
+  /**
+   * A callback that is called when the field is changed.
+   */
+  onChange?: (context: CallbackContext<FieldAtoms<TFieldValue>>) => MaybePromise<void>;
+  /**
+   * A callback that is called when the field is submitted.
+   */
+  onSubmit?: (context: CallbackContext<FieldAtoms<TFieldValue>>) => MaybePromise<void>;
+  /**
+   * A function that formats the field value for display.
+   */
+  format?: (value: TFieldValue) => string;
+  /**
+   * A function that parses the field value for storage.
+   */
+  parse?: (value: any) => TFieldValue;
+  [key: string]: any;
+}
+type FieldOptionsState<TFieldValue = any> = FieldOptions<TFieldValue> & Required<Pick<FieldOptions<TFieldValue>, "theme" | "size" | "debounceMs" | "isEqual" | "disabled" | "clearable" | "required" | "initialValue">>;
+interface FieldAtoms<TFieldValue> {
+  options: WritableAtom<FieldOptionsState<TFieldValue>, [SetStateActionWithReset<FieldOptions<TFieldValue>>], void>;
+  form: Atom<string>;
+  name: Atom<string>;
+  path: Atom<string[]>;
+  focused: WritableAtom<InferFieldState<TFieldValue, boolean>, [SetStateAction<InferFieldState<TFieldValue, boolean>>], void>;
+  required: WritableAtom<InferFieldState<TFieldValue, boolean>, [SetStateAction<InferFieldState<TFieldValue, boolean>>], void>;
+  disabled: WritableAtom<InferFieldState<TFieldValue, boolean>, [SetStateAction<InferFieldState<TFieldValue, boolean>>], void>;
+  clearable: Atom<boolean>;
+  touched: WritableAtom<InferFieldState<TFieldValue, boolean>, [SetStateAction<InferFieldState<TFieldValue, boolean>>], void>;
+  blurred: WritableAtom<InferFieldState<TFieldValue, boolean>, [SetStateAction<InferFieldState<TFieldValue, boolean>>], void>;
+  validating: WritableAtom<InferFieldState<TFieldValue, boolean>, [SetStateAction<InferFieldState<TFieldValue, boolean>>], void>;
+  validationResults: WritableAtom<InferFieldState<TFieldValue, ValidationResults>, [SetStateAction<InferFieldState<TFieldValue, ValidationResults>>], void>;
+  tabIndex: WritableAtom<InferFieldState<TFieldValue, number>, [SetStateAction<InferFieldState<TFieldValue, number>>], void>;
+  ref: WritableAtom<InferFieldState<TFieldValue, Ref<HTMLInputElement>>, [SetStateAction<InferFieldState<TFieldValue, Ref<HTMLInputElement>>>], void>;
+  pristine: Atom<boolean>;
+  dirty: Atom<boolean>;
+  previousValue: Atom<TFieldValue | null>;
+  initialValue: WritableAtom<TFieldValue, [SetStateAction<TFieldValue>], void>;
+  value: WritableAtom<TFieldValue, [SetStateAction<TFieldValue>], void>;
+  formattedValue: Atom<string>;
+  items: WritableAtom<SelectOption<SelectOptionValue, string>[], [SetStateAction<SelectOption<SelectOptionValue, string>[]>], void>;
+  itemsAtoms: WritableAtom<PrimitiveAtom<SelectOption<SelectOptionValue, string>>[], [SplitAtomAction<SelectOption<SelectOptionValue, string>>], void>;
+  size: WritableAtom<`$${string}` | `$${string}.${string}` | `$${string}.${number}` | `$${number}`, [SetStateAction<`$${string}` | `$${string}.${string}` | `$${string}.${number}` | `$${number}`>], void>;
+  errors: Atom<ValidationDetail<"danger">[]>;
+  warnings: Atom<ValidationDetail<"warning">[]>;
+  info: Atom<ValidationDetail<"info">[]>;
+  discovery: Atom<ValidationDetail<"discovery">[]>;
+  success: Atom<ValidationDetail<"success">[]>;
+  positive: Atom<ValidationDetail<"positive">[]>;
+  negative: Atom<ValidationDetail<"negative">[]>;
+  dangerMessages: Atom<ValidationDetail<"danger">[]>;
+  warningMessages: Atom<ValidationDetail<"warning">[]>;
+  infoMessages: Atom<ValidationDetail<"info">[]>;
+  discoveryMessages: Atom<ValidationDetail<"discovery">[]>;
+  successMessages: Atom<ValidationDetail<"success">[]>;
+  positiveMessages: Atom<ValidationDetail<"positive">[]>;
+  negativeMessages: Atom<ValidationDetail<"negative">[]>;
+  theme: Atom<string>;
+  messages: Atom<ValidationDetail[]>;
+  invalid: Atom<boolean>;
+  valid: Atom<boolean>;
+}
+//#endregion
+export { CallbackContext, FieldAtoms, FieldChangeEventHandler, FieldOptions, FieldOptionsState, FieldStatus, FormAtoms, FormOptions, FormOptionsState, FormValuesState, InferFieldState, InferFormState, ValidationCause, ValidationResults, Validator };
+//# sourceMappingURL=types.d.cts.map

package/dist/form/types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.cts","names":[],"sources":["../../src/form/types.ts"],"mappings":";;;;;;;;;;;;;;KA2CY;cAGC;EACiB,YAAA;EACR,QAAA;EACJ,MAAA;EACI,QAAA;EACA,QAAA;;KAGV,UAAU,iBACpB,OAAO,QACP,eAAe,QACf,OAAO,iBACP,KAAK,QACL,KAAK,WACF,aAAa;KAEN,oBAAoB,QAC9B,OAAO,iBAAiB;;;;KAMd;KA6BA,gBAAgB,SAAS,UACnC,cAAc,2BAEP,cAAc,UAAU,gBAAgB,QAAQ,OAAO,aAE1D;KAEM,eAAe,gBAAgB,qBAAqB,aAC7D,cAAc,UAAU,gBAAgB,QAAQ,OAAO;KAG9C,gBAAgB,gBAAgB,uBAAuB,aAChE,cAAc,UAAU,cAAc,QAAQ,sBAC3C,gBAAgB,QAAQ,SACxB,QAAQ;KAGF,wBAAwB,sBAClC,OAAO,YAAY;UAGJ,gBACf,eAAe,qBAAqB,UAAU,eAAe;EAE7D,KAAK;EACL,KAAK;EACL,OAAO,cAAc;;;;;UAMN,YACf,oBAAoB,sBAAsB;;;;EAK1C;;;;;;EAOA;;;;EAKA,gBAAgB,gBAAgB;;;;EAKhC,WAAW,YACJ,WAAW,oBAChB,UAAU,gBAAgB;;;;;;EAQ5B;;;;;;;;;EAUA,WACE,QAAQ,gBAAgB,cACxB,QAAQ,gBAAgB;;;;EAM1B,sBAAsB,QACpB,KAAK,aAAa;;;;EAMpB,gBACE,SAAS,gBAAgB,UAAU,kBAChC;;;;EAKL,YACE,SAAS,gBAAgB,UAAU,kBAChC;;;;EAKL,YACE,SAAS,gBAAgB,UAAU,kBAChC;;KAGK,iBACV,oBAAoB,sBAAsB,uBACxC,YAAY,eACd,SACE,KACE,YAAY;UAUD,UACf,oBAAoB,sBAAsB;EAE1C,SAAS,aACP,iBAAiB,eAChB,wBAAwB,YAAY;EAIvC,MAAM;EAEN,eAAe,aACb,gBAAgB,sBACR,QAAQ,eAAe,gBAAgB;EAGjD,gBAAgB,KAAK,gBAAgB;EACrC,QAAQ,aACN,gBAAgB,sBACR,QAAQ,eAAe,gBAAgB;EAIjD,UAAU,8BAEA,QAAQ;EAGlB,gBAAgB,uBAEb;EAGH,mBAAmB,aACjB,oBACC,wBAAwB;EAG3B,YAAY,uBAAuB;EACnC,WAAW,uBAAuB;EAClC,gBAAgB,sBAAsB;EAEtC,eAAe,aACb,eAAe,wBACd,wBAAwB,eAAe;EAG1C,gBAAgB,aACd,eAAe,wBACd,wBAAwB,eAAe;EAG1C,gBAAgB,aACd,eAAe,wBACd,wBAAwB,eAAe;EAG1C,eAAe,aACb,eAAe,wBACd,wBAAwB,eAAe;EAG1C,eAAe,aACb,eAAe,wBACd,wBAAwB,eAAe;EAG1C,kBAAkB,aAChB,eAAe,wBACd,wBAAwB,eAAe;EAG1C,yBAAyB,aACvB,eAAe,aAAa,qBAC3B,wBAAwB,eAAe,aAAa;EAGvD,YAAY,aACV,eAAe;IAET;IAAe;MACjB,wBAAwB,eAAe;EAI7C,MAAM,aACJ,eAAe,aAAa,IAAI,qBAE9B,wBACE,eAAe,aAAa,IAAI;EAMtC,OAAO;EACP,UAAU;EAEV,SAAS;EACT,SAAS;EACT,YAAY;EAEZ,gBAAgB,KAAK;EACrB,iBAAiB,KAAK;EACtB,cAAc,KAAK;EACnB,mBAAmB,KAAK;EACxB,iBAAiB,KAAK;EACtB,kBAAkB,KAAK;EACvB,kBAAkB,KAAK;EACvB,UAAU,KAAK;EAEf,cAAc,KACZ,gBAAgB,aAAa;EAE/B,eAAe,KACb,gBAAgB,aAAa;EAE/B,YAAY,KAAK,gBAAgB,aAAa;EAC9C,iBAAiB,KACf,gBAAgB,aAAa;EAE/B,eAAe,KACb,gBAAgB,aAAa;EAG/B,qBAAqB,KAAK;EAC1B,sBAAsB,KAAK;EAC3B,mBAAmB,KAAK;EACxB,mBAAmB,KAAK;EACxB,uBAAuB,KAAK;EAE5B,OAAO;EACP,SAAS;EACT,WAAW;EACX,OAAO;;;;;UAuGQ,aAAa;;;;EAI5B;;;;;;EAOA;;;;;;EAWA;;;;;;EAOA;;;;;;EAOA;;;;;;;EAQA,QAAQ,MAAM,QAAQ,gBAAgB,KAAK;;;;EAK3C,WAAW,YACJ,WAAW,oBAChB,UAAU;;;;;;EAQZ;;;;;;;;;EAUA,WAAW,QAAQ,aAAa,QAAQ;;;;;;;;;EAUxC,OAAO;;;;EAKP,gBACE,SAAS,gBAAgB,WAAW,kBACjC;;;;EAKL,UACE,SAAS,gBAAgB,WAAW,kBACjC;;;;EAKL,WACE,SAAS,gBAAgB,WAAW,kBACjC;;;;EAKL,YACE,SAAS,gBAAgB,WAAW,kBACjC;;;;EAKL,YACE,SAAS,gBAAgB,WAAW,kBACjC;;;;EAKL,UAAU,OAAO;;;;EAKjB,SAAS,eAAe;GAEvB;;KAGS,kBAAkB,qBAAqB,aAAa,eAC9D,SACE,KACE,aAAa;UAYF,WAAW;EAC1B,SAAS,aACP,kBAAkB,eACjB,wBAAwB,aAAa;EAIxC,MAAM;EACN,MAAM;EACN,MAAM;EAEN,SAAS,aACP,gBAAgB,wBACf,eAAe,gBAAgB;EAGlC,UAAU,aACR,gBAAgB,wBACf,eAAe,gBAAgB;EAGlC,UAAU,aACR,gBAAgB,wBACf,eAAe,gBAAgB;EAGlC,WAAW;EACX,SAAS,aACP,gBAAgB,wBACf,eAAe,gBAAgB;EAGlC,SAAS,aACP,gBAAgB,wBACf,eAAe,gBAAgB;EAGlC,YAAY,aACV,gBAAgB,wBACf,eAAe,gBAAgB;EAGlC,mBAAmB,aACjB,gBAAgB,aAAa,qBAC5B,eAAe,gBAAgB,aAAa;EAG/C,UAAU,aACR,gBAAgB,uBACf,eAAe,gBAAgB;EAGlC,KAAK,aACH,gBAAgB,aAAa,IAAI,qBAChC,eAAe,gBAAgB,aAAa,IAAI;EAInD,UAAU;EACV,OAAO;EAEP,eAAe,KAAK;EACpB,cAAc,aAAa,cAAc,eAAe;EACxD,OAAO,aAAa,cAAc,eAAe;EACjD,gBAAgB;EAEhB,OAAO,aACL,aAAa,+BACZ,eAAe,aAAa;EAG/B,YAAY,aACV,cAAc,aAAa,gCAC1B,gBAAgB,aAAa;EAIhC,MAAM,6FAMF;EAUJ,QAAQ,KAAK;EACb,UAAU,KAAK;EACf,MAAM,KAAK;EACX,WAAW,KAAK;EAChB,SAAS,KAAK;EACd,UAAU,KAAK;EACf,UAAU,KAAK;EAEf,gBAAgB,KAAK;EACrB,iBAAiB,KAAK;EACtB,cAAc,KAAK;EACnB,mBAAmB,KAAK;EACxB,iBAAiB,KAAK;EACtB,kBAAkB,KAAK;EACvB,kBAAkB,KAAK;EAEvB,OAAO;EACP,UAAU,KAAK;EAEf,SAAS;EACT,OAAO"}

package/dist/form/types.d.mts

@@ -0,0 +1,288 @@
+import { AtomRecordConstraint, SetStateActionWithReset, SplitAtomAction } from "../types.mjs";
+import { MoleculeState } from "../base/utilities/create-molecule.mjs";
+import { RESET } from "jotai/utils";
+import { Atom, Getter, PrimitiveAtom, SetStateAction, Setter, WritableAtom } from "jotai";
+import { Ref } from "react";
+import { MaskitoOptions } from "@maskito/core";
+import { MaybePromise } from "@stryke/types/base";
+import { SelectOption, SelectOptionValue } from "@stryke/types/form";
+import { IsPlainObject } from "@stryke/types/object";
+import { ValidationDetail } from "@stryke/types/validations";
+//#region src/form/types.d.ts
+/**
+ * "server" is only intended for SSR/SSG validation and should not execute anything
+ */
+type ValidationCause = "initialize" | "change" | "blur" | "submit" | "server";
+declare const ValidationCause: {
+  INITIALIZE: ValidationCause;
+  CHANGE: ValidationCause;
+  BLUR: ValidationCause;
+  SUBMIT: ValidationCause;
+  SERVER: ValidationCause;
+};
+type Validator<TValue = any> = (value: TValue, previousValue: TValue, cause: ValidationCause, get: Getter, set: Setter) => MaybePromise<ValidationDetail[]>;
+type ValidationResults = Partial<Record<ValidationCause, ValidationDetail[]>>;
+/**
+ * The field status.
+ */
+type FieldStatus = "primary" | "secondary" | "discovery" | "success" | "info" | "warning" | "danger" | "positive" | "negative";
+type InferFieldState<TValues, TState> = IsPlainObject<TValues> extends true ? { [TKey in keyof TValues]: InferFieldState<TValues[TKey], TState>; } : TState;
+type InferFormState<TValues extends Record<string, any>, TState> = { [TKey in keyof TValues]: InferFieldState<TValues[TKey], TState>; };
+type FormValuesState<TValues extends Record<string, any>> = TValues & { [TKey in keyof TValues]: IsPlainObject<TValues[TKey]> extends true ? FormValuesState<TValues[TKey]> : TValues[TKey] | null; };
+type FieldChangeEventHandler<TFieldValue = any> = (event: CustomEvent<TFieldValue>) => any;
+interface CallbackContext<TState extends AtomRecordConstraint<TState> = Record<string, Atom<unknown>>> {
+  get: Getter;
+  set: Setter;
+  atoms: MoleculeState<TState>;
+}
+/**
+ * The form options.
+ */
+interface FormOptions<TFormValues extends Record<string, any> = Record<string, any>> {
+  /**
+   * The theme of the form.
+   */
+  theme?: string;
+  /**
+   * The disabled state value.
+   *
+   * @defaultValue false
+   */
+  disabled?: boolean;
+  /**
+   * The initial values of the form.
+   */
+  initialValues?: FormValuesState<TFormValues>;
+  /**
+   * The validations to run on the form when certain events occur.
+   */
+  validate?: Record<`on${Capitalize<ValidationCause>}`, Validator<FormValuesState<TFormValues>>[] | undefined>;
+  /**
+   * How long to debounce the `onChange` event and validation calls in milliseconds.
+   *
+   * @defaultValue 250
+   */
+  debounceMs?: number;
+  /**
+   * A function that compares two sets of form values to determine if they are equal.
+   *
+   * @remarks
+   * The default `isEqual` function is provided by the `@stryke/discoveryers` package.
+   *
+   * @defaultValue `isEqual`
+   */
+  isEqual?: (value1: FormValuesState<TFormValues>, value2: FormValuesState<TFormValues>) => boolean;
+  /**
+   * The default options provided to all fields when they are created.
+   */
+  defaultFieldOptions?: Partial<Omit<FieldOptions<TFormValues>, "name" | "mode">>;
+  /**
+   * A callback that is called when the form is initialized.
+   */
+  onInitialize?: (context: CallbackContext<FormAtoms<TFormValues>>) => MaybePromise<void>;
+  /**
+   * A callback that is called when the form is changed.
+   */
+  onChange?: (context: CallbackContext<FormAtoms<TFormValues>>) => MaybePromise<void>;
+  /**
+   * A callback that is called when the form is submitted.
+   */
+  onSubmit?: (context: CallbackContext<FormAtoms<TFormValues>>) => MaybePromise<void>;
+}
+type FormOptionsState<TFormValues extends Record<string, any> = Record<string, any>> = FormOptions<TFormValues> & Required<Pick<FormOptions<TFormValues>, "theme" | "debounceMs" | "isEqual" | "disabled" | "initialValues" | "defaultFieldOptions">>;
+interface FormAtoms<TFormValues extends Record<string, any> = Record<string, any>> {
+  options: WritableAtom<FormOptionsState<TFormValues>, [SetStateActionWithReset<FormOptions<TFormValues>>], void>;
+  name: Atom<string>;
+  initialValues: WritableAtom<FormValuesState<TFormValues>, [typeof RESET | SetStateAction<FormValuesState<TFormValues>>], void>;
+  previousValues: Atom<FormValuesState<TFormValues>>;
+  values: WritableAtom<FormValuesState<TFormValues>, [typeof RESET | SetStateAction<FormValuesState<TFormValues>>], void>;
+  disabled: WritableAtom<boolean, [typeof RESET | SetStateAction<boolean>], void>;
+  formValidating: WritableAtom<boolean, [SetStateActionWithReset<boolean>], void>;
+  validationResults: WritableAtom<ValidationResults, [SetStateActionWithReset<ValidationResults>], void>;
+  submitting: WritableAtom<boolean, [SetStateActionWithReset<boolean>], void>;
+  submitted: WritableAtom<boolean, [SetStateActionWithReset<boolean>], void>;
+  submitAttempts: WritableAtom<number, [SetStateActionWithReset<number>], void>;
+  focusedFields: WritableAtom<InferFormState<TFormValues, boolean>, [SetStateActionWithReset<InferFormState<TFormValues, boolean>>], void>;
+  requiredFields: WritableAtom<InferFormState<TFormValues, boolean>, [SetStateActionWithReset<InferFormState<TFormValues, boolean>>], void>;
+  disabledFields: WritableAtom<InferFormState<TFormValues, boolean>, [SetStateActionWithReset<InferFormState<TFormValues, boolean>>], void>;
+  touchedFields: WritableAtom<InferFormState<TFormValues, boolean>, [SetStateActionWithReset<InferFormState<TFormValues, boolean>>], void>;
+  blurredFields: WritableAtom<InferFormState<TFormValues, boolean>, [SetStateActionWithReset<InferFormState<TFormValues, boolean>>], void>;
+  validatingFields: WritableAtom<InferFormState<TFormValues, boolean>, [SetStateActionWithReset<InferFormState<TFormValues, boolean>>], void>;
+  validationResultsFields: WritableAtom<InferFormState<TFormValues, ValidationResults>, [SetStateActionWithReset<InferFormState<TFormValues, ValidationResults>>], void>;
+  tabIndexes: WritableAtom<InferFormState<TFormValues, number>, [{
+    field: string;
+    tabIndex?: number;
+  } | SetStateActionWithReset<InferFormState<TFormValues, number>>], void>;
+  refs: WritableAtom<InferFormState<TFormValues, Ref<HTMLInputElement>>, [SetStateActionWithReset<InferFormState<TFormValues, Ref<HTMLInputElement>>>], void>;
+  dirty: Atom<boolean>;
+  pristine: Atom<boolean>;
+  blurred: Atom<boolean>;
+  touched: Atom<boolean>;
+  validating: Atom<boolean>;
+  dangerMessages: Atom<ValidationDetail<"danger">[]>;
+  warningMessages: Atom<ValidationDetail<"warning">[]>;
+  infoMessages: Atom<ValidationDetail<"info">[]>;
+  discoveryMessages: Atom<ValidationDetail<"discovery">[]>;
+  successMessages: Atom<ValidationDetail<"success">[]>;
+  positiveMessages: Atom<ValidationDetail<"positive">[]>;
+  negativeMessages: Atom<ValidationDetail<"negative">[]>;
+  messages: Atom<ValidationDetail[]>;
+  dangerFields: Atom<InferFieldState<TFormValues, ValidationDetail<"danger">[]>>;
+  warningFields: Atom<InferFieldState<TFormValues, ValidationDetail<"warning">[]>>;
+  infoFields: Atom<InferFieldState<TFormValues, ValidationDetail<"info">[]>>;
+  discoveryFields: Atom<InferFieldState<TFormValues, ValidationDetail<"discovery">[]>>;
+  successFields: Atom<InferFieldState<TFormValues, ValidationDetail<"success">[]>>;
+  fieldDangerMessages: Atom<ValidationDetail<"danger">[]>;
+  fieldWarningMessages: Atom<ValidationDetail<"warning">[]>;
+  fieldInfoMessages: Atom<ValidationDetail<"info">[]>;
+  fieldHelpMessages: Atom<ValidationDetail<"discovery">[]>;
+  fieldsSuccessMessages: Atom<ValidationDetail<"success">[]>;
+  valid: Atom<boolean>;
+  invalid: Atom<boolean>;
+  canSubmit: Atom<boolean>;
+  theme: Atom<string>;
+}
+/**
+ * The field options.
+ */
+interface FieldOptions<TFieldValue> {
+  /**
+   * The default theme of the field.
+   */
+  theme?: string;
+  /**
+   * The default size of the field.
+   *
+   * @defaultValue "$true"
+   */
+  size?: `$${string}` | `$${string}.${string}` | `$${string}.${number}` | `$${number}`;
+  /**
+   * The default required status of the field.
+   *
+   * @defaultValue false
+   */
+  required?: boolean;
+  /**
+   * The default disabled status of the field.
+   *
+   * @defaultValue false
+   */
+  disabled?: boolean;
+  /**
+   * Whether the field's value can be cleared by its control.
+   *
+   * @defaultValue false
+   */
+  clearable?: boolean;
+  /**
+   * The options to be used as potential values for the field.
+   *
+   * @remarks
+   * This is only used for certain fields (e.g. `Select`, `RadioGroup`, etc.).
+   */
+  items?: Array<Partial<SelectOption> & Pick<SelectOption, "name" | "value">>;
+  /**
+   * The validations to run on the field when certain events occur.
+   */
+  validate?: Record<`on${Capitalize<ValidationCause>}`, Validator<TFieldValue>[] | undefined>;
+  /**
+   * How long to debounce the `onChange` event and validation calls in milliseconds.
+   *
+   * @defaultValue 250
+   */
+  debounceMs?: number;
+  /**
+   * A function that compares two field values to determine if they are equal.
+   *
+   * @remarks
+   * The default `isEqual` function is provided by the `@stryke/discoveryers` package.
+   *
+   * @defaultValue `isEqual`
+   */
+  isEqual?: (value1: TFieldValue, value2: TFieldValue) => boolean;
+  /**
+   * The options provided to the Maskito library when masking user input
+   *
+   * @remarks
+   * More information can be found in the [Maskito documentation](https://maskito.dev/core-concepts/overview).
+   *
+   * API reference: https://github.com/taiga-family/maskito/blob/main/projects/core/src/lib/types/mask-options.ts
+   */
+  mask?: MaskitoOptions;
+  /**
+   * A callback that is called when the field is initialized.
+   */
+  onInitialize?: (context: CallbackContext<FieldAtoms<TFieldValue>>) => MaybePromise<void>;
+  /**
+   * A callback that is called when the field is blurred.
+   */
+  onBlur?: (context: CallbackContext<FieldAtoms<TFieldValue>>) => MaybePromise<void>;
+  /**
+   * A callback that is called when the field is focused.
+   */
+  onFocus?: (context: CallbackContext<FieldAtoms<TFieldValue>>) => MaybePromise<void>;
+  /**
+   * A callback that is called when the field is changed.
+   */
+  onChange?: (context: CallbackContext<FieldAtoms<TFieldValue>>) => MaybePromise<void>;
+  /**
+   * A callback that is called when the field is submitted.
+   */
+  onSubmit?: (context: CallbackContext<FieldAtoms<TFieldValue>>) => MaybePromise<void>;
+  /**
+   * A function that formats the field value for display.
+   */
+  format?: (value: TFieldValue) => string;
+  /**
+   * A function that parses the field value for storage.
+   */
+  parse?: (value: any) => TFieldValue;
+  [key: string]: any;
+}
+type FieldOptionsState<TFieldValue = any> = FieldOptions<TFieldValue> & Required<Pick<FieldOptions<TFieldValue>, "theme" | "size" | "debounceMs" | "isEqual" | "disabled" | "clearable" | "required" | "initialValue">>;
+interface FieldAtoms<TFieldValue> {
+  options: WritableAtom<FieldOptionsState<TFieldValue>, [SetStateActionWithReset<FieldOptions<TFieldValue>>], void>;
+  form: Atom<string>;
+  name: Atom<string>;
+  path: Atom<string[]>;
+  focused: WritableAtom<InferFieldState<TFieldValue, boolean>, [SetStateAction<InferFieldState<TFieldValue, boolean>>], void>;
+  required: WritableAtom<InferFieldState<TFieldValue, boolean>, [SetStateAction<InferFieldState<TFieldValue, boolean>>], void>;
+  disabled: WritableAtom<InferFieldState<TFieldValue, boolean>, [SetStateAction<InferFieldState<TFieldValue, boolean>>], void>;
+  clearable: Atom<boolean>;
+  touched: WritableAtom<InferFieldState<TFieldValue, boolean>, [SetStateAction<InferFieldState<TFieldValue, boolean>>], void>;
+  blurred: WritableAtom<InferFieldState<TFieldValue, boolean>, [SetStateAction<InferFieldState<TFieldValue, boolean>>], void>;
+  validating: WritableAtom<InferFieldState<TFieldValue, boolean>, [SetStateAction<InferFieldState<TFieldValue, boolean>>], void>;
+  validationResults: WritableAtom<InferFieldState<TFieldValue, ValidationResults>, [SetStateAction<InferFieldState<TFieldValue, ValidationResults>>], void>;
+  tabIndex: WritableAtom<InferFieldState<TFieldValue, number>, [SetStateAction<InferFieldState<TFieldValue, number>>], void>;
+  ref: WritableAtom<InferFieldState<TFieldValue, Ref<HTMLInputElement>>, [SetStateAction<InferFieldState<TFieldValue, Ref<HTMLInputElement>>>], void>;
+  pristine: Atom<boolean>;
+  dirty: Atom<boolean>;
+  previousValue: Atom<TFieldValue | null>;
+  initialValue: WritableAtom<TFieldValue, [SetStateAction<TFieldValue>], void>;
+  value: WritableAtom<TFieldValue, [SetStateAction<TFieldValue>], void>;
+  formattedValue: Atom<string>;
+  items: WritableAtom<SelectOption<SelectOptionValue, string>[], [SetStateAction<SelectOption<SelectOptionValue, string>[]>], void>;
+  itemsAtoms: WritableAtom<PrimitiveAtom<SelectOption<SelectOptionValue, string>>[], [SplitAtomAction<SelectOption<SelectOptionValue, string>>], void>;
+  size: WritableAtom<`$${string}` | `$${string}.${string}` | `$${string}.${number}` | `$${number}`, [SetStateAction<`$${string}` | `$${string}.${string}` | `$${string}.${number}` | `$${number}`>], void>;
+  errors: Atom<ValidationDetail<"danger">[]>;
+  warnings: Atom<ValidationDetail<"warning">[]>;
+  info: Atom<ValidationDetail<"info">[]>;
+  discovery: Atom<ValidationDetail<"discovery">[]>;
+  success: Atom<ValidationDetail<"success">[]>;
+  positive: Atom<ValidationDetail<"positive">[]>;
+  negative: Atom<ValidationDetail<"negative">[]>;
+  dangerMessages: Atom<ValidationDetail<"danger">[]>;
+  warningMessages: Atom<ValidationDetail<"warning">[]>;
+  infoMessages: Atom<ValidationDetail<"info">[]>;
+  discoveryMessages: Atom<ValidationDetail<"discovery">[]>;
+  successMessages: Atom<ValidationDetail<"success">[]>;
+  positiveMessages: Atom<ValidationDetail<"positive">[]>;
+  negativeMessages: Atom<ValidationDetail<"negative">[]>;
+  theme: Atom<string>;
+  messages: Atom<ValidationDetail[]>;
+  invalid: Atom<boolean>;
+  valid: Atom<boolean>;
+}
+//#endregion
+export { CallbackContext, FieldAtoms, FieldChangeEventHandler, FieldOptions, FieldOptionsState, FieldStatus, FormAtoms, FormOptions, FormOptionsState, FormValuesState, InferFieldState, InferFormState, ValidationCause, ValidationResults, Validator };
+//# sourceMappingURL=types.d.mts.map

package/dist/form/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","names":[],"sources":["../../src/form/types.ts"],"mappings":""}

package/dist/form/types.mjs

@@ -0,0 +1,2 @@
+const e={INITIALIZE:`initialize`,CHANGE:`change`,BLUR:`blur`,SUBMIT:`submit`,SERVER:`server`};export{e as ValidationCause};
+//# sourceMappingURL=types.mjs.map

package/dist/form/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","names":[],"sources":[],"mappings":""}

package/dist/form/utilities/abort-error.cjs

@@ -0,0 +1 @@
+var e=class extends Error{name=`AbortError`;constructor(e=`Aborted`){super(e)}};exports.AbortError=e;

package/dist/form/utilities/abort-error.d.cts

@@ -0,0 +1,13 @@
+//#region src/form/utilities/abort-error.d.ts
+/**
+ * Error used to cancel in-flight form validation when a provider unmounts.
+ *
+ * `@stryke/async` no longer exports `AbortError`.
+ */
+declare class AbortError extends Error {
+  name: string;
+  constructor(message?: string);
+}
+//#endregion
+export { AbortError };
+//# sourceMappingURL=abort-error.d.cts.map

package/dist/form/utilities/abort-error.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abort-error.d.cts","names":[],"sources":["../../../src/form/utilities/abort-error.ts"],"mappings":";;;;;;cAuBa,mBAAmB;EACrB;EAEG,YAAA"}

package/dist/form/utilities/abort-error.d.mts

@@ -0,0 +1,13 @@
+//#region src/form/utilities/abort-error.d.ts
+/**
+ * Error used to cancel in-flight form validation when a provider unmounts.
+ *
+ * `@stryke/async` no longer exports `AbortError`.
+ */
+declare class AbortError extends Error {
+  name: string;
+  constructor(message?: string);
+}
+//#endregion
+export { AbortError };
+//# sourceMappingURL=abort-error.d.mts.map

package/dist/form/utilities/abort-error.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"abort-error.d.mts","names":[],"sources":["../../../src/form/utilities/abort-error.ts"],"mappings":""}

package/dist/form/utilities/abort-error.mjs

@@ -0,0 +1,2 @@
+var e=class extends Error{name=`AbortError`;constructor(e=`Aborted`){super(e)}};export{e as AbortError};
+//# sourceMappingURL=abort-error.mjs.map

package/dist/form/utilities/abort-error.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"abort-error.mjs","names":[],"sources":[],"mappings":""}

package/dist/form/utilities/index.cjs

@@ -0,0 +1 @@
+const e=require("./is-validation-results.cjs"),t=require("./validators.cjs"),n=require("./abort-error.cjs");exports.AbortError=n.AbortError,exports.isValidationResults=e.isValidationResults,exports.requiredValidator=t.requiredValidator;

package/dist/form/utilities/index.d.cts

@@ -0,0 +1,4 @@
+import { AbortError } from "./abort-error.cjs";
+import { isValidationResults } from "./is-validation-results.cjs";
+import { requiredValidator } from "./validators.cjs";
+export { AbortError, isValidationResults, requiredValidator };