@ariakit/components 0.1.0

package/dist/dialog-store-BOLvw2IX.d.ts

@@ -0,0 +1,16 @@
+import { a as DisclosureStoreState, n as DisclosureStoreFunctions, r as DisclosureStoreOptions } from "./disclosure-store-xKlQffR0.js";
+import { Store, StoreProps } from "@ariakit/store";
+
+//#region src/dialog/dialog-store.d.ts
+/**
+ * Creates a dialog store.
+ */
+declare function createDialogStore(props?: DialogStoreProps): DialogStore;
+interface DialogStoreState extends DisclosureStoreState {}
+interface DialogStoreFunctions extends DisclosureStoreFunctions {}
+interface DialogStoreOptions extends DisclosureStoreOptions {}
+interface DialogStoreProps extends DialogStoreOptions, StoreProps<DialogStoreState> {}
+interface DialogStore extends DialogStoreFunctions, Store<DialogStoreState> {}
+//#endregion
+export { DialogStoreState as a, DialogStoreProps as i, DialogStoreFunctions as n, createDialogStore as o, DialogStoreOptions as r, DialogStore as t };
+//# sourceMappingURL=dialog-store-BOLvw2IX.d.ts.map

package/dist/dialog-store-BOLvw2IX.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"dialog-store-BOLvw2IX.d.ts","names":["Store","StoreProps","DisclosureStoreFunctions","DisclosureStoreOptions","DisclosureStoreState","createDialogStore","DialogStoreProps","DialogStore","props","DialogStoreState","DialogStoreFunctions","DialogStoreOptions"],"sources":["../src/dialog/dialog-store.d.ts"],"mappings":";;;;;;AAKA;iBAAwBK,iBAAAA,CAAkBG,KAAAA,GAAQF,gBAAAA,GAAmBC,WAAW;AAAA,UAC/DE,gBAAAA,SAAyBL,oBAAoB;AAAA,UAE7CM,oBAAAA,SAA6BR,wBAAwB;AAAA,UAErDS,kBAAAA,SAA2BR,sBAAsB;AAAA,UAEjDG,gBAAAA,SAAyBK,kBAAAA,EAAoBV,UAAAA,CAAWQ,gBAAAA;AAAAA,UAExDF,WAAAA,SAAoBG,oBAAAA,EAAsBV,KAAAA,CAAMS,gBAAAA"}

package/dist/disclosure/disclosure-store.d.ts

@@ -0,0 +1,2 @@
+import { a as DisclosureStoreState, i as DisclosureStoreProps, n as DisclosureStoreFunctions, o as createDisclosureStore, r as DisclosureStoreOptions, t as DisclosureStore } from "../disclosure-store-xKlQffR0.js";
+export { DisclosureStore, DisclosureStoreFunctions, DisclosureStoreOptions, DisclosureStoreProps, DisclosureStoreState, createDisclosureStore };

package/dist/disclosure/disclosure-store.js

@@ -0,0 +1,47 @@
+import { createStore, mergeStore, omit, setup, subscribe, sync, throwOnConflictingProps } from "@ariakit/store";
+import { defaultValue } from "@ariakit/utils";
+//#region src/disclosure/disclosure-store.ts
+/**
+* Creates a disclosure store.
+*/
+function createDisclosureStore(props = {}) {
+	const store = mergeStore(props.store, omit(props.disclosure, ["contentElement", "disclosureElement"]));
+	throwOnConflictingProps(props, store);
+	const syncState = store?.getState();
+	const open = defaultValue(props.open, syncState?.open, props.defaultOpen, false);
+	const animated = defaultValue(props.animated, syncState?.animated, false);
+	const disclosure = createStore({
+		open,
+		animated,
+		animating: !!animated && open,
+		mounted: open,
+		contentElement: defaultValue(syncState?.contentElement, null),
+		disclosureElement: defaultValue(syncState?.disclosureElement, null)
+	}, store);
+	setup(disclosure, () => sync(disclosure, ["animated", "animating"], (state) => {
+		if (state.animated) return;
+		disclosure.setState("animating", false);
+	}));
+	setup(disclosure, () => subscribe(disclosure, ["open"], () => {
+		if (!disclosure.getState().animated) return;
+		disclosure.setState("animating", true);
+	}));
+	setup(disclosure, () => sync(disclosure, ["open", "animating"], (state) => {
+		disclosure.setState("mounted", state.open || state.animating);
+	}));
+	return {
+		...disclosure,
+		disclosure: props.disclosure,
+		setOpen: (value) => disclosure.setState("open", value),
+		show: () => disclosure.setState("open", true),
+		hide: () => disclosure.setState("open", false),
+		toggle: () => disclosure.setState("open", (open) => !open),
+		stopAnimation: () => disclosure.setState("animating", false),
+		setContentElement: (value) => disclosure.setState("contentElement", value),
+		setDisclosureElement: (value) => disclosure.setState("disclosureElement", value)
+	};
+}
+//#endregion
+export { createDisclosureStore };
+
+//# sourceMappingURL=disclosure-store.js.map

package/dist/disclosure/disclosure-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"disclosure-store.js","names":[],"sources":["../../src/disclosure/disclosure-store.ts"],"sourcesContent":["import {\n  createStore,\n  mergeStore,\n  omit,\n  setup,\n  subscribe,\n  sync,\n  throwOnConflictingProps,\n} from \"@ariakit/store\";\nimport type { Store, StoreOptions, StoreProps } from \"@ariakit/store\";\nimport { defaultValue } from \"@ariakit/utils\";\nimport type { SetState } from \"@ariakit/utils\";\n\n/**\n * Creates a disclosure store.\n */\nexport function createDisclosureStore(\n  props: DisclosureStoreProps = {},\n): DisclosureStore {\n  const store = mergeStore(\n    props.store,\n    omit(props.disclosure, [\"contentElement\", \"disclosureElement\"]),\n  );\n\n  throwOnConflictingProps(props, store);\n\n  const syncState = store?.getState();\n\n  const open = defaultValue(\n    props.open,\n    syncState?.open,\n    props.defaultOpen,\n    false,\n  );\n\n  const animated = defaultValue(props.animated, syncState?.animated, false);\n\n  const initialState: DisclosureStoreState = {\n    open,\n    animated,\n    animating: !!animated && open,\n    mounted: open,\n    contentElement: defaultValue(syncState?.contentElement, null),\n    disclosureElement: defaultValue(syncState?.disclosureElement, null),\n  };\n\n  const disclosure = createStore(initialState, store);\n\n  setup(disclosure, () =>\n    sync(disclosure, [\"animated\", \"animating\"], (state) => {\n      if (state.animated) return;\n      // Reset animating to false when animation is disabled.\n      disclosure.setState(\"animating\", false);\n    }),\n  );\n\n  setup(disclosure, () =>\n    subscribe(disclosure, [\"open\"], () => {\n      if (!disclosure.getState().animated) return;\n      disclosure.setState(\"animating\", true);\n    }),\n  );\n\n  setup(disclosure, () =>\n    sync(disclosure, [\"open\", \"animating\"], (state) => {\n      disclosure.setState(\"mounted\", state.open || state.animating);\n    }),\n  );\n\n  return {\n    ...disclosure,\n    disclosure: props.disclosure,\n    setOpen: (value) => disclosure.setState(\"open\", value),\n    show: () => disclosure.setState(\"open\", true),\n    hide: () => disclosure.setState(\"open\", false),\n    toggle: () => disclosure.setState(\"open\", (open) => !open),\n    stopAnimation: () => disclosure.setState(\"animating\", false),\n    setContentElement: (value) => disclosure.setState(\"contentElement\", value),\n    setDisclosureElement: (value) =>\n      disclosure.setState(\"disclosureElement\", value),\n  };\n}\n\nexport interface DisclosureStoreState {\n  /**\n   * Whether the content is visible.\n   *\n   * Live examples:\n   * - [Combobox with links](https://ariakit.com/examples/combobox-links)\n   * - [Dialog with React\n   *   Router](https://ariakit.com/examples/dialog-react-router)\n   * - [Menu with\n   *   Motion](https://ariakit.com/examples/menu-framer-motion)\n   * - [Lazy Popover](https://ariakit.com/examples/popover-lazy)\n   * @default false\n   */\n  open: boolean;\n  /**\n   * The mounted state usually matches the\n   * [`open`](https://ariakit.com/reference/disclosure-provider#open) value.\n   * However, if the content element is animated, it waits for the animation to\n   * finish before turning `false`. This ensures the content element doesn't get\n   * unmounted during the animation.\n   *\n   * Live examples:\n   * - [Navigation Menubar](https://ariakit.com/examples/menubar-navigation)\n   * - [Responsive Popover](https://ariakit.com/examples/popover-responsive)\n   */\n  mounted: boolean;\n  /**\n   * Determines whether the content should animate when it is shown or hidden.\n   * - If `true`, the `animating` state will be `true` when the content is shown\n   *   or hidden and it will wait for a CSS animation/transition to end before\n   *   becoming `false`.\n   * - If it's set to a number, the `animating` state will be `true` when the\n   *   content is shown or hidden and it will wait for the number of\n   *   milliseconds to pass before becoming `false`.\n   */\n  animated: boolean | number;\n  /**\n   * Whether the content is currently animating.\n   */\n  animating: boolean;\n  /**\n   * The content element that is being shown or hidden.\n   */\n  contentElement: HTMLElement | null;\n  /**\n   * The disclosure button element that toggles the content.\n   */\n  disclosureElement: HTMLElement | null;\n}\n\nexport interface DisclosureStoreFunctions extends Pick<\n  DisclosureStoreOptions,\n  \"disclosure\"\n> {\n  /**\n   * Sets the [`open`](https://ariakit.com/reference/disclosure-provider#open)\n   * state.\n   *\n   * Live examples:\n   * - [Textarea with inline\n   *   Combobox](https://ariakit.com/examples/combobox-textarea)\n   * @example\n   * store.setOpen(true);\n   * store.setOpen((open) => !open);\n   */\n  setOpen: SetState<DisclosureStoreState[\"open\"]>;\n  /**\n   * Sets the [`open`](https://ariakit.com/reference/disclosure-provider#open)\n   * state to `true`.\n   *\n   * Live examples:\n   * - [Textarea with inline\n   *   Combobox](https://ariakit.com/examples/combobox-textarea)\n   * - [Dialog with\n   *   Motion](https://ariakit.com/examples/dialog-framer-motion)\n   * - [Context Menu](https://ariakit.com/examples/menu-context-menu)\n   * - [Navigation Menubar](https://ariakit.com/examples/menubar-navigation)\n   */\n  show: () => void;\n  /**\n   * Sets the [`open`](https://ariakit.com/reference/disclosure-provider#open)\n   * state to `false`.\n   *\n   * Live examples:\n   * - [Textarea with inline\n   *   Combobox](https://ariakit.com/examples/combobox-textarea)\n   * - [Sliding Menu](https://ariakit.com/examples/menu-slide)\n   */\n  hide: () => void;\n  /**\n   * Toggles the\n   * [`open`](https://ariakit.com/reference/disclosure-provider#open) state.\n   */\n  toggle: () => void;\n  /**\n   * Sets the `animating` state to `false`, which will automatically set the\n   * `mounted` state to `false` if it was `true`. This means that the content\n   * element can be safely unmounted.\n   * @deprecated Use `setState(\"animating\", false)` instead.\n   */\n  stopAnimation: () => void;\n  /**\n   * Sets the `contentElement` state.\n   */\n  setContentElement: SetState<DisclosureStoreState[\"contentElement\"]>;\n  /**\n   * Sets the `disclosureElement` state.\n   *\n   * Live examples:\n   * - [Navigation Menubar](https://ariakit.com/examples/menubar-navigation)\n   */\n  setDisclosureElement: SetState<DisclosureStoreState[\"disclosureElement\"]>;\n}\n\nexport interface DisclosureStoreOptions extends StoreOptions<\n  DisclosureStoreState,\n  \"open\" | \"animated\"\n> {\n  /**\n   * @deprecated Manually setting the `animated` prop is no longer necessary.\n   * This will be removed in a future release.\n   */\n  animated?: DisclosureStoreState[\"animated\"];\n  /**\n   * Whether the content should be visible by default.\n   * @default false\n   */\n  defaultOpen?: DisclosureStoreState[\"open\"];\n  /**\n   * A reference to another disclosure store that controls another disclosure\n   * component to keep them in sync. Element states like `contentElement` and\n   * `disclosureElement` won't be synced. For that, use the\n   * [`store`](https://ariakit.com/reference/disclosure-provider#store) prop\n   * instead.\n   */\n  disclosure?: DisclosureStore | null;\n}\n\nexport interface DisclosureStoreProps\n  extends DisclosureStoreOptions, StoreProps<DisclosureStoreState> {}\n\nexport interface DisclosureStore\n  extends DisclosureStoreFunctions, Store<DisclosureStoreState> {}\n"],"mappings":";;;;;;AAgBA,SAAgB,sBACd,QAA8B,CAAC,GACd;CACjB,MAAM,QAAQ,WACZ,MAAM,OACN,KAAK,MAAM,YAAY,CAAC,kBAAkB,mBAAmB,CAAC,CAChE;CAEA,wBAAwB,OAAO,KAAK;CAEpC,MAAM,YAAY,OAAO,SAAS;CAElC,MAAM,OAAO,aACX,MAAM,MACN,WAAW,MACX,MAAM,aACN,KACF;CAEA,MAAM,WAAW,aAAa,MAAM,UAAU,WAAW,UAAU,KAAK;CAWxE,MAAM,aAAa,YAAY;EAR7B;EACA;EACA,WAAW,CAAC,CAAC,YAAY;EACzB,SAAS;EACT,gBAAgB,aAAa,WAAW,gBAAgB,IAAI;EAC5D,mBAAmB,aAAa,WAAW,mBAAmB,IAAI;CAG1B,GAAG,KAAK;CAElD,MAAM,kBACJ,KAAK,YAAY,CAAC,YAAY,WAAW,IAAI,UAAU;EACrD,IAAI,MAAM,UAAU;EAEpB,WAAW,SAAS,aAAa,KAAK;CACxC,CAAC,CACH;CAEA,MAAM,kBACJ,UAAU,YAAY,CAAC,MAAM,SAAS;EACpC,IAAI,CAAC,WAAW,SAAS,EAAE,UAAU;EACrC,WAAW,SAAS,aAAa,IAAI;CACvC,CAAC,CACH;CAEA,MAAM,kBACJ,KAAK,YAAY,CAAC,QAAQ,WAAW,IAAI,UAAU;EACjD,WAAW,SAAS,WAAW,MAAM,QAAQ,MAAM,SAAS;CAC9D,CAAC,CACH;CAEA,OAAO;EACL,GAAG;EACH,YAAY,MAAM;EAClB,UAAU,UAAU,WAAW,SAAS,QAAQ,KAAK;EACrD,YAAY,WAAW,SAAS,QAAQ,IAAI;EAC5C,YAAY,WAAW,SAAS,QAAQ,KAAK;EAC7C,cAAc,WAAW,SAAS,SAAS,SAAS,CAAC,IAAI;EACzD,qBAAqB,WAAW,SAAS,aAAa,KAAK;EAC3D,oBAAoB,UAAU,WAAW,SAAS,kBAAkB,KAAK;EACzE,uBAAuB,UACrB,WAAW,SAAS,qBAAqB,KAAK;CAClD;AACF"}

package/dist/disclosure-store-xKlQffR0.d.ts

@@ -0,0 +1,142 @@
+import { Store, StoreOptions, StoreProps } from "@ariakit/store";
+import { SetState } from "@ariakit/utils";
+
+//#region src/disclosure/disclosure-store.d.ts
+/**
+ * Creates a disclosure store.
+ */
+declare function createDisclosureStore(props?: DisclosureStoreProps): DisclosureStore;
+interface DisclosureStoreState {
+  /**
+   * Whether the content is visible.
+   *
+   * Live examples:
+   * - [Combobox with links](https://ariakit.com/examples/combobox-links)
+   * - [Dialog with React
+   *   Router](https://ariakit.com/examples/dialog-react-router)
+   * - [Menu with
+   *   Motion](https://ariakit.com/examples/menu-framer-motion)
+   * - [Lazy Popover](https://ariakit.com/examples/popover-lazy)
+   * @default false
+   */
+  open: boolean;
+  /**
+   * The mounted state usually matches the
+   * [`open`](https://ariakit.com/reference/disclosure-provider#open) value.
+   * However, if the content element is animated, it waits for the animation to
+   * finish before turning `false`. This ensures the content element doesn't get
+   * unmounted during the animation.
+   *
+   * Live examples:
+   * - [Navigation Menubar](https://ariakit.com/examples/menubar-navigation)
+   * - [Responsive Popover](https://ariakit.com/examples/popover-responsive)
+   */
+  mounted: boolean;
+  /**
+   * Determines whether the content should animate when it is shown or hidden.
+   * - If `true`, the `animating` state will be `true` when the content is shown
+   *   or hidden and it will wait for a CSS animation/transition to end before
+   *   becoming `false`.
+   * - If it's set to a number, the `animating` state will be `true` when the
+   *   content is shown or hidden and it will wait for the number of
+   *   milliseconds to pass before becoming `false`.
+   */
+  animated: boolean | number;
+  /**
+   * Whether the content is currently animating.
+   */
+  animating: boolean;
+  /**
+   * The content element that is being shown or hidden.
+   */
+  contentElement: HTMLElement | null;
+  /**
+   * The disclosure button element that toggles the content.
+   */
+  disclosureElement: HTMLElement | null;
+}
+interface DisclosureStoreFunctions extends Pick<DisclosureStoreOptions, "disclosure"> {
+  /**
+   * Sets the [`open`](https://ariakit.com/reference/disclosure-provider#open)
+   * state.
+   *
+   * Live examples:
+   * - [Textarea with inline
+   *   Combobox](https://ariakit.com/examples/combobox-textarea)
+   * @example
+   * store.setOpen(true);
+   * store.setOpen((open) => !open);
+   */
+  setOpen: SetState<DisclosureStoreState["open"]>;
+  /**
+   * Sets the [`open`](https://ariakit.com/reference/disclosure-provider#open)
+   * state to `true`.
+   *
+   * Live examples:
+   * - [Textarea with inline
+   *   Combobox](https://ariakit.com/examples/combobox-textarea)
+   * - [Dialog with
+   *   Motion](https://ariakit.com/examples/dialog-framer-motion)
+   * - [Context Menu](https://ariakit.com/examples/menu-context-menu)
+   * - [Navigation Menubar](https://ariakit.com/examples/menubar-navigation)
+   */
+  show: () => void;
+  /**
+   * Sets the [`open`](https://ariakit.com/reference/disclosure-provider#open)
+   * state to `false`.
+   *
+   * Live examples:
+   * - [Textarea with inline
+   *   Combobox](https://ariakit.com/examples/combobox-textarea)
+   * - [Sliding Menu](https://ariakit.com/examples/menu-slide)
+   */
+  hide: () => void;
+  /**
+   * Toggles the
+   * [`open`](https://ariakit.com/reference/disclosure-provider#open) state.
+   */
+  toggle: () => void;
+  /**
+   * Sets the `animating` state to `false`, which will automatically set the
+   * `mounted` state to `false` if it was `true`. This means that the content
+   * element can be safely unmounted.
+   * @deprecated Use `setState("animating", false)` instead.
+   */
+  stopAnimation: () => void;
+  /**
+   * Sets the `contentElement` state.
+   */
+  setContentElement: SetState<DisclosureStoreState["contentElement"]>;
+  /**
+   * Sets the `disclosureElement` state.
+   *
+   * Live examples:
+   * - [Navigation Menubar](https://ariakit.com/examples/menubar-navigation)
+   */
+  setDisclosureElement: SetState<DisclosureStoreState["disclosureElement"]>;
+}
+interface DisclosureStoreOptions extends StoreOptions<DisclosureStoreState, "open" | "animated"> {
+  /**
+   * @deprecated Manually setting the `animated` prop is no longer necessary.
+   * This will be removed in a future release.
+   */
+  animated?: DisclosureStoreState["animated"];
+  /**
+   * Whether the content should be visible by default.
+   * @default false
+   */
+  defaultOpen?: DisclosureStoreState["open"];
+  /**
+   * A reference to another disclosure store that controls another disclosure
+   * component to keep them in sync. Element states like `contentElement` and
+   * `disclosureElement` won't be synced. For that, use the
+   * [`store`](https://ariakit.com/reference/disclosure-provider#store) prop
+   * instead.
+   */
+  disclosure?: DisclosureStore | null;
+}
+interface DisclosureStoreProps extends DisclosureStoreOptions, StoreProps<DisclosureStoreState> {}
+interface DisclosureStore extends DisclosureStoreFunctions, Store<DisclosureStoreState> {}
+//#endregion
+export { DisclosureStoreState as a, DisclosureStoreProps as i, DisclosureStoreFunctions as n, createDisclosureStore as o, DisclosureStoreOptions as r, DisclosureStore as t };
+//# sourceMappingURL=disclosure-store-xKlQffR0.d.ts.map

package/dist/disclosure-store-xKlQffR0.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"disclosure-store-xKlQffR0.d.ts","names":["Store","StoreOptions","StoreProps","SetState","createDisclosureStore","DisclosureStoreProps","DisclosureStore","props","DisclosureStoreState","HTMLElement","open","mounted","animated","animating","contentElement","disclosureElement","DisclosureStoreFunctions","DisclosureStoreOptions","Pick","setOpen","show","hide","toggle","stopAnimation","setContentElement","setDisclosureElement","defaultOpen","disclosure"],"sources":["../src/disclosure/disclosure-store.d.ts"],"mappings":";;;;;;AAKA;iBAAwBI,qBAAAA,CAAsBG,KAAAA,GAAQF,oBAAAA,GAAuBC,eAAe;AAAA,UAC3EE,oBAAAA;EAD2E;;;;;AAAA;AAC5F;;;;;;EAaIE,IAAAA;EA0BAG;;;;;;AAQ8B;AAElC;;;;EAxBIF,OAAAA;EAoCSR;;;;;;;;;EA1BTS,QAAAA;EA0BAO;;;EAtBAN,SAAAA;EA6CAQ;;;EAzCAP,cAAAA,EAAgBL,WAAAA;EAyDGN;;;EArDnBY,iBAAAA,EAAmBN,WAAW;AAAA;AAAA,UAEjBO,wBAAAA,SAAiCE,IAAAA,CAAKD,sBAAAA;EA0DA;AAEvD;;;;;;;;;;EAhDIE,OAAAA,EAAShB,QAAAA,CAASK,oBAAAA;EAgDuCA;;;;;;;;AAkB7B;AAEhC;;;EAvDIY,IAAAA;EAuD0CH;;;;;;;;AAAuD;EA7CjGI,IAAAA;EA+C4B;;;;EA1C5BC,MAAAA;EA0CoE;;;;;;EAnCpEC,aAAAA;;;;EAIAC,iBAAAA,EAAmBrB,QAAAA,CAASK,oBAAAA;;;;;;;EAO5BiB,oBAAAA,EAAsBtB,QAAAA,CAASK,oBAAAA;AAAAA;AAAAA,UAElBS,sBAAAA,SAA+BhB,YAAAA,CAAaO,oBAAAA;;;;;EAKzDI,QAAAA,GAAWJ,oBAAAA;;;;;EAKXkB,WAAAA,GAAclB,oBAAAA;;;;;;;;EAQdmB,UAAAA,GAAarB,eAAAA;AAAAA;AAAAA,UAEAD,oBAAAA,SAA6BY,sBAAAA,EAAwBf,UAAAA,CAAWM,oBAAAA;AAAAA,UAEhEF,eAAAA,SAAwBU,wBAAAA,EAA0BhB,KAAAA,CAAMQ,oBAAAA"}

package/dist/form/form-store.d.ts

@@ -0,0 +1,247 @@
+import { i as CollectionStoreOptions, n as CollectionStoreFunctions, o as CollectionStoreState, r as CollectionStoreItem } from "../collection-store-yNe83BiS.js";
+import { DeepMap, DeepPartial, Names, StringLike } from "./types.js";
+import { Store, StoreOptions, StoreProps } from "@ariakit/store";
+import { AnyObject, PickRequired, SetState, SetStateAction } from "@ariakit/utils";
+
+//#region src/form/form-store.d.ts
+type ErrorMessage = string | undefined | null;
+declare function hasMessages(object: FormStoreValues): boolean;
+declare function get<T>(values: FormStoreValues, path: StringLike | string[], defaultValue?: T): T;
+/**
+ * Creates a form store.
+ */
+declare function createFormStore<T extends FormStoreValues = FormStoreValues>(props: PickRequired<FormStoreProps<T>, "values" | "defaultValues" | "errors" | "defaultErrors" | "touched" | "defaultTouched">): FormStore<T>;
+declare function createFormStore(props: FormStoreProps): FormStore;
+type FormStoreCallback<T extends FormStoreState = FormStoreState> = (state: T) => void | Promise<void>;
+type FormStoreValues = AnyObject;
+interface FormStoreItem extends CollectionStoreItem {
+  type: "field" | "label" | "description" | "error" | "button";
+  name: string;
+}
+interface FormStoreState<T extends FormStoreValues = FormStoreValues> extends CollectionStoreState<FormStoreItem> {
+  /**
+   * Form values.
+   *
+   * Live examples:
+   * - [FormRadio](https://ariakit.com/examples/form-radio)
+   * - [FormSelect](https://ariakit.com/examples/form-select)
+   * @default {}
+   */
+  values: T;
+  /**
+   * Form errors.
+   */
+  errors: DeepPartial<DeepMap<T, ErrorMessage>>;
+  /**
+   * The touched state of the form.
+   */
+  touched: DeepPartial<DeepMap<T, boolean>>;
+  /**
+   * Whether the form is valid.
+   */
+  valid: boolean;
+  /**
+   * Whether the form is validating.
+   */
+  validating: boolean;
+  /**
+   * Whether the form is submitting.
+   */
+  submitting: boolean;
+  /**
+   * The number of times
+   * [`submit`](https://ariakit.com/reference/use-form-store#submit) has been
+   * called with a successful response.
+   */
+  submitSucceed: number;
+  /**
+   * The number of times
+   * [`submit`](https://ariakit.com/reference/use-form-store#submit) has been
+   * called with an error response.
+   */
+  submitFailed: number;
+}
+interface FormStoreFunctions<T extends FormStoreValues = FormStoreValues> extends CollectionStoreFunctions<FormStoreItem> {
+  /**
+   * An object containing the names of the form fields for type safety.
+   *
+   * Live examples:
+   * - [FormRadio](https://ariakit.com/examples/form-radio)
+   * - [FormSelect](https://ariakit.com/examples/form-select)
+   * @example
+   * store.names.name; // "name"
+   * store.names.name.first; // "name.first"
+   * store.names.name.last; // "name.last"
+   */
+  names: Names<T>;
+  /**
+   * Sets the [`values`](https://ariakit.com/reference/form-provider#values)
+   * state.
+   * @example
+   * store.setValues({ name: "John" });
+   * store.setValues((values) => ({ ...values, name: "John" }));
+   */
+  setValues: SetState<FormStoreState<T>["values"]>;
+  /**
+   * Retrieves a field value.
+   *
+   * Live examples:
+   * - [FormRadio](https://ariakit.com/examples/form-radio)
+   * @example
+   * const nameValue = store.getValue("name");
+   * // Can also use store.names for type-safety.
+   * const emailValue = store.getValue(store.names.email);
+   */
+  getValue: <T = any>(name: StringLike) => T;
+  /**
+   * Sets a field value.
+   *
+   * Live examples:
+   * - [FormSelect](https://ariakit.com/examples/form-select)
+   * @example
+   * store.setValue("name", "John");
+   * store.setValue("name", (value) => value + " Doe");
+   * // Can also use store.names for type-safety.
+   * store.setValue(store.names.name, "John");
+   */
+  setValue: <T>(name: StringLike, value: SetStateAction<T>) => void;
+  /**
+   * Pushes a value to an array field.
+   * @example
+   * store.pushValue("tags", "new tag");
+   * store.pushValue("tags", { id: 1, name: "new tag" });
+   * // Can also use store.names for type-safety.
+   * store.pushValue(store.names.tags, "new tag");
+   */
+  pushValue: <T>(name: StringLike, value: T) => void;
+  /**
+   * Removes a value from an array field.
+   * @example
+   * store.removeValue("tags", 0);
+   * store.removeValue("tags", 1);
+   * // Can also use store.names for type-safety.
+   * store.removeValue(store.names.tags, 0);
+   */
+  removeValue: (name: StringLike, index: number) => void;
+  /**
+   * Sets the [`errors`](https://ariakit.com/reference/form-provider#errors)
+   * state.
+   * @example
+   * store.setErrors({ name: "Name is required" });
+   * store.setErrors((errors) => ({ ...errors, name: "Name is required" }));
+   */
+  setErrors: SetState<FormStoreState<T>["errors"]>;
+  /**
+   * Retrieves a field error.
+   * @example
+   * const nameError = store.getError("name");
+   * // Can also use store.names for type-safety.
+   * const emailError = store.getError(store.names.email);
+   */
+  getError: (name: StringLike) => ErrorMessage;
+  /**
+   * Sets a field error.
+   *
+   * Live examples:
+   * - [FormRadio](https://ariakit.com/examples/form-radio)
+   * @example
+   * store.setError("name", "Name is required");
+   * store.setError("name", (error) => error + "!");
+   * // Can also use store.names for type-safety.
+   * store.setError(store.names.name, "Name is required");
+   */
+  setError: (name: StringLike, error: SetStateAction<ErrorMessage>) => void;
+  /**
+   * Sets the [`touched`](https://ariakit.com/reference/form-provider#touched)
+   * state.
+   * @example
+   * store.setTouched({ name: true });
+   * store.setTouched((touched) => ({ ...touched, name: true }));
+   */
+  setTouched: SetState<FormStoreState<T>["touched"]>;
+  /**
+   * Retrieves a field touched state.
+   * @example
+   * const nameTouched = store.getFieldTouched("name");
+   * // Can also use store.names for type-safety.
+   * const emailTouched = store.getFieldTouched(store.names.email);
+   */
+  getFieldTouched: (name: StringLike) => boolean;
+  /**
+   * Sets a field touched state.
+   * @example
+   * store.setFieldTouched("name", true);
+   * store.setFieldTouched("name", (value) => !value);
+   * // Can also use store.names for type-safety.
+   * store.setFieldTouched(store.names.name, true);
+   */
+  setFieldTouched: (name: StringLike, value: SetStateAction<boolean>) => void;
+  /**
+   * Function that accepts a callback that will be used to validate the form
+   * when [`validate`](https://ariakit.com/reference/use-form-store#validate) is
+   * called. It returns a cleanup function that will remove the callback.
+   * @example
+   * const cleanup = store.onValidate(async (state) => {
+   *   const errors = await api.validate(state.values);
+   *   if (errors) {
+   *     store.setErrors(errors);
+   *   }
+   * });
+   */
+  onValidate: (callback: FormStoreCallback<FormStoreState<T>>) => () => void;
+  /**
+   * Function that accepts a callback that will be used to submit the form when
+   * [`submit`](https://ariakit.com/reference/use-form-store#submit) is called.
+   * It returns a cleanup function that will remove the callback.
+   * @param callback The callback function.
+   * @example
+   * const cleanup = store.onSubmit(async (state) => {
+   *   try {
+   *     await api.submit(state.values);
+   *   } catch (errors) {
+   *     store.setErrors(errors);
+   *   }
+   * });
+   */
+  onSubmit: (callback: FormStoreCallback<FormStoreState<T>>) => () => void;
+  /**
+   * Validates the form.
+   * @example
+   * if (await store.validate()) {
+   *  // Form is valid.
+   * }
+   */
+  validate: () => Promise<boolean>;
+  /**
+   * Submits the form. This also triggers validation.
+   * @example
+   * if (await form.submit()) {
+   *   // Form is submitted.
+   * }
+   */
+  submit: () => Promise<boolean>;
+  /**
+   * Resets the form to its default values.
+   */
+  reset: () => void;
+}
+interface FormStoreOptions<T extends FormStoreValues = FormStoreValues> extends CollectionStoreOptions<FormStoreItem>, StoreOptions<FormStoreState<T>, "values" | "errors" | "touched"> {
+  /**
+   * The default values of the form.
+   * @default {}
+   */
+  defaultValues?: FormStoreState<T>["values"];
+  /**
+   * The default errors of the form.
+   */
+  defaultErrors?: FormStoreState<T>["errors"];
+  /**
+   * The default touched state of the form.
+   */
+  defaultTouched?: FormStoreState<T>["touched"];
+}
+interface FormStoreProps<T extends FormStoreValues = FormStoreValues> extends FormStoreOptions<T>, StoreProps<FormStoreState<T>> {}
+interface FormStore<T extends FormStoreValues = FormStoreValues> extends FormStoreFunctions<T>, Store<FormStoreState<T>> {}
+//#endregion
+export { FormStore, FormStoreCallback, FormStoreFunctions, FormStoreItem, FormStoreOptions, FormStoreProps, FormStoreState, FormStoreValues, createFormStore, get, hasMessages };
+//# sourceMappingURL=form-store.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"form-store.d.ts","names":["Store","StoreOptions","StoreProps","AnyObject","PickRequired","SetState","SetStateAction","CollectionStoreFunctions","CollectionStoreItem","CollectionStoreOptions","CollectionStoreState","DeepMap","DeepPartial","Names","StringLike","ErrorMessage","hasMessages","FormStoreValues","object","get","T","values","path","defaultValue","createFormStore","FormStoreProps","FormStore","props","FormStoreCallback","FormStoreState","Promise","state","FormStoreItem","type","name","errors","touched","valid","validating","submitting","submitSucceed","submitFailed","FormStoreFunctions","names","setValues","getValue","setValue","value","pushValue","removeValue","index","setErrors","getError","setError","error","setTouched","getFieldTouched","setFieldTouched","onValidate","callback","onSubmit","validate","submit","reset","FormStoreOptions","defaultValues","defaultErrors","defaultTouched"],"sources":["../../src/form/form-store.d.ts"],"mappings":";;;;;;KAIKe,YAAAA;AAAAA,iBACmBC,WAAAA,CAAYE,MAAuB,EAAfD,eAAe;AAAA,iBACnCE,GAAAA,GAAAA,CAAOE,MAAAA,EAAQJ,eAAAA,EAAiBK,IAAAA,EAAMR,UAAAA,aAAuBS,YAAAA,GAAeH,CAAAA,GAAIA,CAAAA;;;;iBAIhFI,eAAAA,WAA0BP,eAAAA,GAAkBA,eAAAA,CAAAA,CAAiBU,KAAAA,EAAOvB,YAAAA,CAAaqB,cAAAA,CAAeL,CAAAA,6FAA8FM,SAAAA,CAAUN,CAAAA;AAAAA,iBACxMI,eAAAA,CAAgBG,KAAAA,EAAOF,cAAAA,GAAiBC,SAAS;AAAA,KAC7DE,iBAAAA,WAA4BC,cAAAA,GAAiBA,cAAAA,KAAmBE,KAAAA,EAAOX,CAAAA,YAAaU,OAAAA;AAAAA,KACpFb,eAAAA,GAAkBd,SAAS;AAAA,UACtB6B,aAAAA,SAAsBxB,mBAAmB;EACtDyB,IAAAA;EACAC,IAAAA;AAAAA;AAAAA,UAEaL,cAAAA,WAAyBZ,eAAAA,GAAkBA,eAAAA,UAAyBP,oBAAAA,CAAqBsB,aAAAA;EAZnEf;;;;;;;;EAqBnCI,MAAAA,EAAQD,CAAAA;EArBkDN;;;EAyB1DqB,MAAAA,EAAQvB,WAAAA,CAAYD,OAAAA,CAAQS,CAAAA,EAAGL,YAAAA;EAzBqEK;;AAAC;EA6BrGgB,OAAAA,EAASxB,WAAAA,CAAYD,OAAAA,CAAQS,CAAAA;EAzBM;;;EA6BnCiB,KAAAA;EA7BoHjB;;;EAiCpHkB,UAAAA;EAjCkNZ;;;EAqClNa,UAAAA;EArC8CtB;;;;;EA2C9CuB,aAAAA;EA3CkNd;;;AAAW;AACjO;EAgDIe,YAAAA;AAAAA;AAAAA,UAEaC,kBAAAA,WAA6BzB,eAAAA,GAAkBA,eAAAA,UAAyBV,wBAAAA,CAAyByB,aAAAA;EAlDnEP;;;;AAA0B;AACzE;;;;;;EA6DIkB,KAAAA,EAAO9B,KAAAA,CAAMO,CAAAA;EA7DsF;;;;;;;EAqEnGwB,SAAAA,EAAWvC,QAAAA,CAASwB,cAAAA,CAAeT,CAAAA;EArEgE;AAAA;AACvG;;;;AAAuC;AACvC;;;EA8EIyB,QAAAA,YAAoBX,IAAAA,EAAMpB,UAAAA,KAAeM,CAAAA;EA9ENZ;;;;AAE/B;AAER;;;;;;EAsFIsC,QAAAA,MAAcZ,IAAAA,EAAMpB,UAAAA,EAAYiC,KAAAA,EAAOzC,cAAAA,CAAec,CAAAA;EAzE1BA;;;;;;;;EAkF5B4B,SAAAA,MAAed,IAAAA,EAAMpB,UAAAA,EAAYiC,KAAAA,EAAO3B,CAAAA;EA/F6D;;;;;;;;EAwGrG6B,WAAAA,GAAcf,IAAAA,EAAMpB,UAAAA,EAAYoC,KAAAA;EA3FxBtC;;;;;;;EAmGRuC,SAAAA,EAAW9C,QAAAA,CAASwB,cAAAA,CAAeT,CAAAA;EA3FnCiB;;;;;;AAoBY;EA+EZe,QAAAA,GAAWlB,IAAAA,EAAMpB,UAAAA,KAAeC,YAAAA;EA7ED;;;;;;;;;;;EAyF/BsC,QAAAA,GAAWnB,IAAAA,EAAMpB,UAAAA,EAAYwC,KAAAA,EAAOhD,cAAAA,CAAeS,YAAAA;EA9C/BD;;;;;;;EAsDpByC,UAAAA,EAAYlD,QAAAA,CAASwB,cAAAA,CAAeT,CAAAA;EA5BzBf;;;;;;;EAoCXmD,eAAAA,GAAkBtB,IAAAA,EAAMpB,UAAAA;EARZT;;;;;;;;EAiBZoD,eAAAA,GAAkBvB,IAAAA,EAAMpB,UAAAA,EAAYiC,KAAAA,EAAOzC,cAAAA;EA4BtBsB;;;;;;;;;;;;EAfrB8B,UAAAA,GAAaC,QAAAA,EAAU/B,iBAAAA,CAAkBC,cAAAA,CAAeT,CAAAA;EAnH3CA;;;;;;;;;;;;;;EAkIbwC,QAAAA,GAAWD,QAAAA,EAAU/B,iBAAAA,CAAkBC,cAAAA,CAAeT,CAAAA;EAnGAA;;;;;;;EA2GtDyC,QAAAA,QAAgB/B,OAAAA;EAzFhBmB;;;;;;;EAiGAa,MAAAA,QAAchC,OAAAA;EAjFdsB;;;EAqFAW,KAAAA;AAAAA;AAAAA,UAEaC,gBAAAA,WAA2B/C,eAAAA,GAAkBA,eAAAA,UAAyBR,sBAAAA,CAAuBuB,aAAAA,GAAgB/B,YAAAA,CAAa4B,cAAAA,CAAeT,CAAAA;EA3E3Ic;;;;EAgFX+B,aAAAA,GAAgBpC,cAAAA,CAAeT,CAAAA;EAxEnBf;;;EA4EZ6D,aAAAA,GAAgBrC,cAAAA,CAAeT,CAAAA;EApEPN;;;EAwExBqD,cAAAA,GAAiBtC,cAAAA,CAAeT,CAAAA;AAAAA;AAAAA,UAEnBK,cAAAA,WAAyBR,eAAAA,GAAkBA,eAAAA,UAAyB+C,gBAAAA,CAAiB5C,CAAAA,GAAIlB,UAAAA,CAAW2B,cAAAA,CAAeT,CAAAA;AAAAA,UAEnHM,SAAAA,WAAoBT,eAAAA,GAAkBA,eAAAA,UAAyByB,kBAAAA,CAAmBtB,CAAAA,GAAIpB,KAAAA,CAAM6B,cAAAA,CAAeT,CAAAA"}