attio 0.0.1-experimental.20250821.2 → 0.0.1-experimental.20250825

package/lib/client/forms/number.d.ts

@@ -1,11 +1,35 @@
 import type { FormValue } from "./value";
+/**
+ * A number form value.
+ */
 export interface FormNumber<TOptional extends boolean = false> extends FormValue {
     type: "number";
+    /**
+     * Whether this number is optional, i.e. allows `undefined` values.
+     */
     isOptional: TOptional;
+    /**
+     * Make this number optional, i.e. allow `undefined` values.
+     */
     optional(): FormNumber<true>;
+    /**
+     * Set the default value of this number. The default value will be returned if the user
+     * doesn't provide a value.
+     *
+     * NOTE that this is not the same as an initial value!
+     */
     default(value: number): FormNumber<TOptional>;
+    /**
+     * Set the maximum value of this number.
+     */
     max(max: number): FormNumber<TOptional>;
+    /**
+     * Set the minimum value of this number.
+     */
     min(min: number): FormNumber<TOptional>;
 }
+/**
+ * Create a new number form value.
+ */
 export declare function number(): FormNumber<false>;
 //# sourceMappingURL=number.d.ts.map

package/lib/client/forms/number.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../../../src/client/forms/number.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,SAAS,CAAA;AAKtC,MAAM,WAAW,UAAU,CAAC,SAAS,SAAS,OAAO,GAAG,KAAK,CAAE,SAAQ,SAAS;IAC5E,IAAI,EAAE,QAAQ,CAAA;IAKd,UAAU,EAAE,SAAS,CAAA;IAKrB,QAAQ,IAAI,UAAU,CAAC,IAAI,CAAC,CAAA;IAQ5B,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;IAK7C,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;IAKvC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;CAC1C;AAKD,MAAM,CAAC,OAAO,UAAU,MAAM,IAAI,UAAU,CAAC,KAAK,CAAC,CAAA"}
+{"version":3,"file":"number.d.ts","sourceRoot":"","sources":["../../../src/client/forms/number.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,SAAS,CAAA;AAEtC;;GAEG;AACH,MAAM,WAAW,UAAU,CAAC,SAAS,SAAS,OAAO,GAAG,KAAK,CAAE,SAAQ,SAAS;IAC5E,IAAI,EAAE,QAAQ,CAAA;IAEd;;OAEG;IACH,UAAU,EAAE,SAAS,CAAA;IAErB;;OAEG;IACH,QAAQ,IAAI,UAAU,CAAC,IAAI,CAAC,CAAA;IAE5B;;;;;OAKG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;IAE7C;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;IAEvC;;OAEG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;CAC1C;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,MAAM,IAAI,UAAU,CAAC,KAAK,CAAC,CAAA"}

package/lib/client/forms/string.d.ts

@@ -1,18 +1,65 @@
 import type { FormValue } from "./value";
+/**
+ * A string form value.
+ */
 export interface FormString<TOptional extends boolean = false> extends FormValue {
     type: "string";
+    /**
+     * Whether or not this string is multiline.
+     *
+     * Multiline strings are rendered as textarea fields.
+     */
     isMultiline: boolean;
+    /**
+     * Whether this string is optional, i.e. allows `""` or `undefined` values.
+     */
     isOptional: TOptional;
+    /**
+     * Whether this string is required to be a valid URL.
+     */
     isUrl: boolean;
+    /**
+     * Set the default value of this string. The default value will be returned if the user
+     * doesn't provide a value.
+     *
+     * NOTE that this is not the same as an initial value!
+     */
     default(value: string): FormString<TOptional>;
+    /**
+     * Make this string optional, i.e. allow `""` or `undefined` values.
+     */
     optional(): FormString<true>;
+    /**
+     * Make this string multiline, i.e. render as textarea field.
+     */
     multiline(): FormString<TOptional>;
+    /**
+     * Set the maximum length of this string.
+     */
     maxLength(length: number): FormString<TOptional>;
+    /**
+     * Set the minimum length of this string.
+     */
     minLength(length: number): FormString<TOptional>;
+    /**
+     * Ensure that this string is a valid URL.
+     *
+     * A URL without a protocol, e.g. "attio.com" will pass validation, but will be
+     * given to `onSubmit` as "https://attio.com".
+     *
+     * @param options - The options for URL validation.
+     * @param options.protocol - The protocol regex to use for URL validation. If not provided,
+     * the default is `https?`.
+     * @param options.message - The message to use for URL validation errors. If not provided,
+     * the default is `Must be a valid URL`.
+     */
     url(options?: {
         protocol: RegExp;
         message?: string;
     }): FormString<TOptional>;
 }
+/**
+ * Create a new string form value.
+ */
 export declare function string(): FormString<false>;
 //# sourceMappingURL=string.d.ts.map

package/lib/client/forms/string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../../src/client/forms/string.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,SAAS,CAAA;AAKtC,MAAM,WAAW,UAAU,CAAC,SAAS,SAAS,OAAO,GAAG,KAAK,CAAE,SAAQ,SAAS;IAC5E,IAAI,EAAE,QAAQ,CAAA;IAMd,WAAW,EAAE,OAAO,CAAA;IAKpB,UAAU,EAAE,SAAS,CAAA;IAKrB,KAAK,EAAE,OAAO,CAAA;IAQd,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;IAK7C,QAAQ,IAAI,UAAU,CAAC,IAAI,CAAC,CAAA;IAK5B,SAAS,IAAI,UAAU,CAAC,SAAS,CAAC,CAAA;IAKlC,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;IAKhD,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;IAchD,GAAG,CAAC,OAAO,CAAC,EAAE;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAC,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;CAC7E;AAKD,MAAM,CAAC,OAAO,UAAU,MAAM,IAAI,UAAU,CAAC,KAAK,CAAC,CAAA"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../../src/client/forms/string.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,SAAS,CAAA;AAEtC;;GAEG;AACH,MAAM,WAAW,UAAU,CAAC,SAAS,SAAS,OAAO,GAAG,KAAK,CAAE,SAAQ,SAAS;IAC5E,IAAI,EAAE,QAAQ,CAAA;IACd;;;;OAIG;IACH,WAAW,EAAE,OAAO,CAAA;IAEpB;;OAEG;IACH,UAAU,EAAE,SAAS,CAAA;IAErB;;OAEG;IACH,KAAK,EAAE,OAAO,CAAA;IAEd;;;;;OAKG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;IAE7C;;OAEG;IACH,QAAQ,IAAI,UAAU,CAAC,IAAI,CAAC,CAAA;IAE5B;;OAEG;IACH,SAAS,IAAI,UAAU,CAAC,SAAS,CAAC,CAAA;IAElC;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;IAEhD;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;IAEhD;;;;;;;;;;;OAWG;IACH,GAAG,CAAC,OAAO,CAAC,EAAE;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAC,GAAG,UAAU,CAAC,SAAS,CAAC,CAAA;CAC7E;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,MAAM,IAAI,UAAU,CAAC,KAAK,CAAC,CAAA"}

package/lib/client/forms/value.d.ts

@@ -1,5 +1,13 @@
+/**
+ * An opaque type for form values.
+ */
 export interface FormValue {
     readonly __brand: unique symbol;
+    /**
+     * Control how the form value is serialized to a JSON object.
+     *
+     * https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify#tojson_behavior
+     */
     toJSON(): Readonly<Record<string, unknown>>;
 }
 //# sourceMappingURL=value.d.ts.map

package/lib/client/forms/value.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"value.d.ts","sourceRoot":"","sources":["../../../src/client/forms/value.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,SAAS;IACtB,QAAQ,CAAC,OAAO,EAAE,OAAO,MAAM,CAAA;IAO/B,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CAC9C"}
+{"version":3,"file":"value.d.ts","sourceRoot":"","sources":["../../../src/client/forms/value.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB,QAAQ,CAAC,OAAO,EAAE,OAAO,MAAM,CAAA;IAE/B;;;;OAIG;IACH,MAAM,IAAI,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;CAC9C"}

package/lib/client/hooks/use-async-cache.d.ts

@@ -1,7 +1,69 @@
+/**
+ * An async function that returns data.
+ */
 export type AsyncFunction<Input extends Array<any>, Output> = (...args: Input) => Promise<Output>;
+/**
+ * A type-safe configuration object for multiple loaders.
+ *
+ * The key is used to cache the result of the loader.
+ * The value is a loader that takes an array of arguments and returns a promise.
+ */
 export interface AsyncCacheConfig {
     [K: string]: AsyncFunction<Array<any>, any> | [AsyncFunction<Array<any>, any>, ...Array<any>];
 }
+/**
+ * A hook that returns, and caches, the results of calling one or more async functions,
+ * typically to load data from a third party via server functions.
+ *
+ * The component it is used in will suspend until ALL async functions have resolved.
+ *
+ * ## EXAMPLE USAGE
+ *
+ * ----
+ * ```ts
+ * // load-widgets.server.ts
+ * export default async function loadWidgets() : Promise<Array<Widget>> {
+ *   // fetch widgets from somewhere
+ * }
+ * ```
+ * ----
+ * ```ts
+ * // load-sprockets.server.ts
+ * export default async function loadSprockets(
+ *   material: Material,
+ *   max?: number
+ * ): Promise<Array<Sprocket>> {
+ *   // fetch sprockets from somewhere
+ * }
+ * ```
+ * ----
+ * ```ts
+ * import { useAsyncCache } from "attio/client"
+ *
+ * import loadWidgets from "./load-widgets.server.ts"
+ * import loadSprockets from "./load-sprockets.server.ts"
+ *
+ * ...
+ *
+ * // inside component:
+ *
+ * const results = useAsyncCache({
+ *   // loadWidgets takes zero parameters and can thus be called without an array
+ *   widgets: loadWidgets,
+ *   // loadSprockets takes a `material` parameter, so we call it like this
+ *   ironSprockets: [loadSprockets, "iron"],
+ *   copperSprockets: [loadSprockets, "copper", 42],
+ * })
+ *
+ * const { widgets, ironSprockets, copperSprockets } = results.values
+ *
+ * ...
+ *
+ * // inside an event handler, perhaps, to refetch _only_ the iron sprockets
+ * results.invalidate("ironSprockets")
+ * ```
+ * ----
+ */
 export declare function useAsyncCache<Config extends AsyncCacheConfig>(config: Config): {
     values: {
         [K in keyof Config]: Config[K] extends AsyncFunction<any, infer Output> ? Output : Config[K] extends [AsyncFunction<infer Input, infer Output>, ...infer Args] ? Args extends Input ? Output : never : never;

package/lib/client/hooks/use-async-cache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-async-cache.d.ts","sourceRoot":"","sources":["../../../src/client/hooks/use-async-cache.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,aAAa,CAAC,KAAK,SAAS,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,IAAI,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;AAQjG,MAAM,WAAW,gBAAgB;IAC7B,CAAC,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;CAChG;AAuDD,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,MAAM,SAAS,gBAAgB,EACjE,MAAM,EAAE,MAAM,GACf;IACC,MAAM,EAAE;SACH,CAAC,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,aAAa,CAAC,GAAG,EAAE,MAAM,MAAM,CAAC,GACjE,MAAM,GACN,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,MAAM,KAAK,EAAE,MAAM,MAAM,CAAC,EAAE,GAAG,MAAM,IAAI,CAAC,GACzE,IAAI,SAAS,KAAK,GACd,MAAM,GACN,KAAK,GACT,KAAK;KAChB,CAAA;IACD,UAAU,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,CAAA;CAC5D,CAAA"}
+{"version":3,"file":"use-async-cache.d.ts","sourceRoot":"","sources":["../../../src/client/hooks/use-async-cache.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,aAAa,CAAC,KAAK,SAAS,KAAK,CAAC,GAAG,CAAC,EAAE,MAAM,IAAI,CAAC,GAAG,IAAI,EAAE,KAAK,KAAK,OAAO,CAAC,MAAM,CAAC,CAAA;AAEjG;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB;IAC7B,CAAC,CAAC,EAAE,MAAM,GAAG,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAA;CAChG;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,MAAM,CAAC,OAAO,UAAU,aAAa,CAAC,MAAM,SAAS,gBAAgB,EACjE,MAAM,EAAE,MAAM,GACf;IACC,MAAM,EAAE;SACH,CAAC,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,aAAa,CAAC,GAAG,EAAE,MAAM,MAAM,CAAC,GACjE,MAAM,GACN,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,MAAM,KAAK,EAAE,MAAM,MAAM,CAAC,EAAE,GAAG,MAAM,IAAI,CAAC,GACzE,IAAI,SAAS,KAAK,GACd,MAAM,GACN,KAAK,GACT,KAAK;KAChB,CAAA;IACD,UAAU,EAAE,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,MAAM,EAAE,MAAM,CAAC,KAAK,IAAI,CAAA;CAC5D,CAAA"}

package/lib/client/hooks/use-form.d.ts

@@ -3,78 +3,228 @@ import type { DecoratedComboboxOption, DecoratedComboboxOptionsProvider, PlainCo
 import type { PathTo, ValueOf } from "../forms/path";
 import type { FormValue } from "../forms/value";
 export type FormSchema = Record<string, FormValue>;
+/**
+ * Recursive type for validation errors that can be nested.
+ * Each field can either be a string error message or a nested object of errors.
+ */
 export type ValidationErrors<T> = Partial<{
     [K in keyof T]: T[K] extends object ? ValidationErrors<T[K]> : string;
 }>;
+/**
+ * A <Form> component that must wrap all the fields and provide a submit handler.
+ *
+ * @example
+ * ```tsx
+ * <Form onSubmit={(values) => {
+ *   console.log(values)
+ * }}>
+ *   <TextInput name="name" label="Name" />
+ *   <NumberInput name="age" label="Age" />
+ *   <Checkbox name="isActive" label="Is Active" />
+ *   <Toggle name="isExpress" label="Is Express" />
+ *   <SubmitButton label="Submit" />
+ * </Form>
+ * ```
+ */
 type Form<TSchema extends FormSchema> = (props: {
+    /** The contents of the form, including layout and input components */
     children: React.ReactNode;
+    /**
+     * The function to call when the form is submitted.
+     *
+     * `onSubmit` will NOT be called if there are validation errors.
+     */
     onSubmit: (values: ValueOf<TSchema>) => void | Promise<void>;
 }) => JSX.Element;
+/**
+ * A text input field.
+ */
 type TextInput<TSchema extends FormSchema> = (props: {
+    /** The type of the input field. Defaults to "text". */
     type?: "text" | "email" | "password" | "tel" | "url";
+    /** The label of the input field */
     label: string;
+    /**
+     * The path to the value of the input field, e.g. `"name"` or `"address.street"`
+     * @deprecated Use `name` instead
+     **/
     data?: PathTo<TSchema, "string">;
+    /** The path to the value of the input field, e.g. `"name"` or `"address.street"` */
     name: PathTo<TSchema, "string">;
+    /** The optional placeholder text of the input field */
     placeholder?: string;
+    /** Whether the input field is disabled */
     disabled?: boolean;
 }) => JSX.Element;
+/**
+ * A number input field.
+ */
 type NumberInput<TSchema extends FormSchema> = (props: {
+    /** The label of the input field */
     label: string;
+    /**
+     * The path to the value of the input field, e.g. `"age"` or `"shipping.cost"`
+     * @deprecated Use `name` instead
+     **/
     data?: PathTo<TSchema, "number">;
+    /** The path to the value of the input field, e.g. `"age"` or `"shipping.cost"` */
     name: PathTo<TSchema, "number">;
+    /** The optional placeholder text of the input field */
     placeholder?: string;
+    /** Whether the input field is disabled */
     disabled?: boolean;
 }) => JSX.Element;
+/**
+ * A rich text input field.
+ */
 type RichTextInput<TSchema extends FormSchema> = (props: {
+    /** The label of the input field */
     label: string;
+    /** The path to the value of the input field, e.g. `"name"` or `"address.street"` */
     name: PathTo<TSchema, "string">;
+    /** The optional placeholder text of the input field */
     placeholder?: string;
+    /** Whether the input field is disabled */
     disabled?: boolean;
 }) => JSX.Element;
+/**
+ * A checkbox input field.
+ */
 type Checkbox<TSchema extends FormSchema> = (props: {
+    /** The label of the input field */
     label: string;
+    /**
+     * The path to the value of the input field, e.g. `"is_active"` or `"shipping.is_express"`
+     * @deprecated Use `name` instead
+     **/
     data?: PathTo<TSchema, "boolean">;
+    /** The path to the value of the input field, e.g. `"is_active"` or `"shipping.is_express"` */
     name: PathTo<TSchema, "boolean">;
+    /** Whether the input field is disabled */
     disabled?: boolean;
 }) => JSX.Element;
+/**
+ * A toggle input field.
+ */
 type Toggle<TSchema extends FormSchema> = (props: {
+    /** The label of the input field */
     label: string;
+    /**
+     * The path to the value of the input field, e.g. `"is_active"` or `"shipping.is_express"`
+     * @deprecated Use `name` instead
+     **/
     data?: PathTo<TSchema, "boolean">;
+    /** The path to the value of the input field, e.g. `"is_active"` or `"shipping.is_express"` */
     name: PathTo<TSchema, "boolean">;
+    /** Whether the input field is disabled */
     disabled?: boolean;
 }) => JSX.Element;
+/**
+ * Base props common to all combobox variants.
+ */
 export interface BaseComboboxProps<TSchema extends FormSchema> {
+    /** The label of the combobox field */
     label: string;
+    /**
+     * The path to the value of the combobox field, e.g. `"mode"` or `"shipping.method"`
+     * @deprecated Use `name` instead
+     **/
     data?: PathTo<TSchema, "string">;
+    /** The path to the value of the combobox field, e.g. `"mode"` or `"shipping.method"` */
     name: PathTo<TSchema, "string">;
+    /**
+     * The optional placeholder text for the search input
+     *
+     * @default "Search..."
+     */
     searchPlaceholder?: string;
+    /** Whether the combobox field is disabled */
     disabled?: boolean;
 }
+/**
+ * Props for decorated combobox variant.
+ */
 export interface DecoratedComboboxProps {
+    /**
+     * If decorated, the combobox will be require decorated options. Defaults to true.
+     *
+     * @deprecated This may change in the future.
+     */
     __experimental_decorated: true;
+    /**
+     * The options of the combobox field
+     *
+     * Either an array of options, or a provider that asynchronously fetches options.
+     */
     options: Array<DecoratedComboboxOption> | DecoratedComboboxOptionsProvider;
+    /**
+     * The optional placeholder text or option of the combobox field
+     **/
     placeholder?: string | Omit<DecoratedComboboxOption, "value">;
 }
+/**
+ * Props for plain combobox variant.
+ */
 export interface PlainComboboxProps {
+    /**
+     * If not decorated, the combobox will be plain. Defaults to false.
+     *
+     * @deprecated This may change in the future.
+     */
     __experimental_decorated?: false;
+    /**
+     * The options of the combobox field
+     *
+     * Either an array of options, or a provider that asynchronously fetches options.
+     */
     options: Array<PlainComboboxOption> | PlainComboboxOptionsProvider;
+    /**
+     * The optional placeholder text or option of the combobox field
+     **/
     placeholder?: string;
 }
+/**
+ * A combobox input field.
+ */
 type Combobox<TSchema extends FormSchema> = (props: BaseComboboxProps<TSchema> & (DecoratedComboboxProps | PlainComboboxProps)) => JSX.Element;
+/**
+ * A component used to render a collection of inputs.
+ */
 type Collection<TSchema extends FormSchema, TPath extends PathTo<TSchema, "array">> = (props: {
+    /** The label of the collection field */
     label: string;
+    /**
+     * The path to the value of the collection field, e.g. `"items"` or `"shipping.items"`
+     * @deprecated Use `name` instead
+     **/
     data?: TPath;
+    /** The path to the value of the collection field, e.g. `"items"` or `"shipping.items"` */
     name: TPath;
+    /**
+     * A render prop that receives the path and index of one of the items and renders
+     * the inputs for that item
+     */
     children: (args: {
         path: `${TPath}.${number}`;
         index: number;
     }) => React.ReactNode;
 }) => JSX.Element;
+/**
+ * A component used to group inputs in a collection together
+ */
 type CollectionItem = (props: {
+    /** The label of the collection item */
     label: string;
+    /** The inputs of the collection item */
     children: React.ReactNode;
 }) => JSX.Element;
+/**
+ * A submit button for the form.
+ *
+ * If the form is rendered inside a dialog, the submit button will be placed at the bottom of the dialog.
+ */
 type SubmitButton = (props: {
+    /** The label of the submit button */
     label: string;
 }) => JSX.Element;
 export interface WithStateProps<TSchema extends FormSchema, TValues extends boolean = false, TSubmitting extends boolean = false, TErrors extends boolean = false> {
@@ -87,22 +237,108 @@ export interface WithStateProps<TSchema extends FormSchema, TValues extends bool
         errors: TErrors extends true ? Record<string, string> : never;
     }) => JSX.Element;
 }
+/**
+ * A component that provides the form state via a render prop.
+ *
+ * You may specifically request various parts of form state, such as
+ * `values`, `submitting`, and `errors`. This component will rerender
+ * whenever any of the values requested change.
+ */
 type WithState<TSchema extends FormSchema> = (props: WithStateProps<TSchema> | WithStateProps<TSchema, true> | WithStateProps<TSchema, boolean, true> | WithStateProps<TSchema, boolean, boolean, true>) => JSX.Element;
 export interface FormApi<TSchema extends FormSchema> {
+    /**
+     * Submits the form.
+     *
+     * This will validate the form and call the `onSubmit` handler.
+     */
     submit: () => void;
+    /**
+     * Changes the value of a field.
+     */
     change: <TPath extends PathTo<TSchema, "string" | "number">>(path: TPath, value: ValueOf<TSchema>[TPath]) => void;
+    /**
+     * The <Form> component to wrap the fields of this form and provide a submit handler.
+     */
     Form: Form<TSchema>;
+    /**
+     * A text input field.
+     */
     TextInput: TextInput<TSchema>;
+    /**
+     * A number input field.
+     */
     NumberInput: NumberInput<TSchema>;
+    /**
+     * A rich text input field.
+     */
     Experimental_RichTextInput: RichTextInput<TSchema>;
+    /**
+     * A checkbox input field.
+     */
     Checkbox: Checkbox<TSchema>;
+    /**
+     * A toggle input field.
+     */
     Toggle: Toggle<TSchema>;
+    /**
+     * A combobox input field.
+     */
     Combobox: Combobox<TSchema>;
+    /**
+     * A component used to render a collection of inputs.
+     * @deprecated This is not fully built yet.
+     */
     Collection: Collection<TSchema, any>;
+    /**
+     * A component used to group inputs in a collection together.
+     * @deprecated This is not fully built yet.
+     */
     CollectionItem: CollectionItem;
+    /**
+     * A submit button for the form.
+     */
     SubmitButton: SubmitButton;
+    /**
+     * A component that provides the form state via a render prop.
+     */
     WithState: WithState<TSchema>;
 }
-export declare function useForm<TSchema extends FormSchema>(schema: TSchema, initialValues: Partial<ValueOf<TSchema>>, validate?: (values: ValueOf<TSchema>) => ValidationErrors<ValueOf<TSchema>>): FormApi<TSchema>;
+/**
+ * Creates a form API for a given schema and initial values.
+ *
+ * @example
+ * ```tsx
+ * const api = useForm({
+ *   name: Forms.string(),
+ *   age: Forms.number(),
+ *   isActive: Forms.boolean(),
+ *   isExpress: Forms.boolean(),
+ * }, {
+ *   name: "John",
+ *   age: 30,
+ *   isActive: true,
+ *   isExpress: false,
+ * });
+ * ```
+ */
+export declare function useForm<TSchema extends FormSchema>(schema: TSchema, initialValues: Partial<ValueOf<TSchema>>, 
+/**
+ * Optional function to validate the form.
+ *
+ * Errors should be returned as a record of field names to error messages.
+ * The keys must match the keys of the form schema.
+ *
+ * Errors can be nested for complex objects. e.g.
+ * ```ts
+ * {
+ *   shipping: {
+ *     street: "Street is required"
+ *   }
+ * }
+ * ```
+ *
+ * Errors given here will be overridden by errors generated by the form schema.
+ */
+validate?: (values: ValueOf<TSchema>) => ValidationErrors<ValueOf<TSchema>>): FormApi<TSchema>;
 export {};
 //# sourceMappingURL=use-form.d.ts.map

package/lib/client/hooks/use-form.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-form.d.ts","sourceRoot":"","sources":["../../../src/client/hooks/use-form.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,OAAO,CAAA;AAE9B,OAAO,KAAK,EACR,uBAAuB,EACvB,gCAAgC,EAChC,mBAAmB,EACnB,4BAA4B,EAC/B,MAAM,wBAAwB,CAAA;AAC/B,OAAO,KAAK,EAAC,MAAM,EAAE,OAAO,EAAC,MAAM,eAAe,CAAA;AAClD,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAA;AAE7C,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;AAMlD,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,OAAO,CAAC;KACrC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM;CACxE,CAAC,CAAA;AAoBF,KAAK,IAAI,CAAC,OAAO,SAAS,UAAU,IAAI,CAAC,KAAK,EAAE;IAE5C,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IAOzB,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC/D,KAAK,GAAG,CAAC,OAAO,CAAA;AAKjB,KAAK,SAAS,CAAC,OAAO,SAAS,UAAU,IAAI,CAAC,KAAK,EAAE;IAEjD,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,KAAK,GAAG,KAAK,CAAA;IAGpD,KAAK,EAAE,MAAM,CAAA;IAMb,IAAI,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAGhC,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAG/B,WAAW,CAAC,EAAE,MAAM,CAAA;IAGpB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB,KAAK,GAAG,CAAC,OAAO,CAAA;AAKjB,KAAK,WAAW,CAAC,OAAO,SAAS,UAAU,IAAI,CAAC,KAAK,EAAE;IAEnD,KAAK,EAAE,MAAM,CAAA;IAMb,IAAI,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAGhC,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAG/B,WAAW,CAAC,EAAE,MAAM,CAAA;IAGpB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB,KAAK,GAAG,CAAC,OAAO,CAAA;AAKjB,KAAK,aAAa,CAAC,OAAO,SAAS,UAAU,IAAI,CAAC,KAAK,EAAE;IAErD,KAAK,EAAE,MAAM,CAAA;IAGb,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAG/B,WAAW,CAAC,EAAE,MAAM,CAAA;IAGpB,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB,KAAK,GAAG,CAAC,OAAO,CAAA;AAKjB,KAAK,QAAQ,CAAC,OAAO,SAAS,UAAU,IAAI,CAAC,KAAK,EAAE;IAEhD,KAAK,EAAE,MAAM,CAAA;IAMb,IAAI,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;IAGjC,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;IAGhC,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB,KAAK,GAAG,CAAC,OAAO,CAAA;AAKjB,KAAK,MAAM,CAAC,OAAO,SAAS,UAAU,IAAI,CAAC,KAAK,EAAE;IAE9C,KAAK,EAAE,MAAM,CAAA;IAMb,IAAI,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;IAGjC,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;IAGhC,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB,KAAK,GAAG,CAAC,OAAO,CAAA;AAKjB,MAAM,WAAW,iBAAiB,CAAC,OAAO,SAAS,UAAU;IAEzD,KAAK,EAAE,MAAM,CAAA;IAMb,IAAI,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAGhC,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAO/B,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAG1B,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB;AAKD,MAAM,WAAW,sBAAsB;IAMnC,wBAAwB,EAAE,IAAI,CAAA;IAO9B,OAAO,EAAE,KAAK,CAAC,uBAAuB,CAAC,GAAG,gCAAgC,CAAA;IAI1E,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAA;CAChE;AAKD,MAAM,WAAW,kBAAkB;IAM/B,wBAAwB,CAAC,EAAE,KAAK,CAAA;IAOhC,OAAO,EAAE,KAAK,CAAC,mBAAmB,CAAC,GAAG,4BAA4B,CAAA;IAIlE,WAAW,CAAC,EAAE,MAAM,CAAA;CACvB;AAKD,KAAK,QAAQ,CAAC,OAAO,SAAS,UAAU,IAAI,CACxC,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,GAAG,kBAAkB,CAAC,KAChF,GAAG,CAAC,OAAO,CAAA;AAKhB,KAAK,UAAU,CAAC,OAAO,SAAS,UAAU,EAAE,KAAK,SAAS,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE;IAE1F,KAAK,EAAE,MAAM,CAAA;IAMb,IAAI,CAAC,EAAE,KAAK,CAAA;IAGZ,IAAI,EAAE,KAAK,CAAA;IAMX,QAAQ,EAAE,CAAC,IAAI,EAAE;QAAC,IAAI,EAAE,GAAG,KAAK,IAAI,MAAM,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,KAAK,KAAK,CAAC,SAAS,CAAA;CACnF,KAAK,GAAG,CAAC,OAAO,CAAA;AAKjB,KAAK,cAAc,GAAG,CAAC,KAAK,EAAE;IAE1B,KAAK,EAAE,MAAM,CAAA;IAGb,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC5B,KAAK,GAAG,CAAC,OAAO,CAAA;AAOjB,KAAK,YAAY,GAAG,CAAC,KAAK,EAAE;IAExB,KAAK,EAAE,MAAM,CAAA;CAChB,KAAK,GAAG,CAAC,OAAO,CAAA;AAEjB,MAAM,WAAW,cAAc,CAC3B,OAAO,SAAS,UAAU,EAC1B,OAAO,SAAS,OAAO,GAAG,KAAK,EAC/B,WAAW,SAAS,OAAO,GAAG,KAAK,EACnC,OAAO,SAAS,OAAO,GAAG,KAAK;IAE/B,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,UAAU,CAAC,EAAE,WAAW,CAAA;IACxB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,CAAC,KAAK,EAAE;QACd,MAAM,EAAE,OAAO,SAAS,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,KAAK,CAAA;QACvD,UAAU,EAAE,WAAW,SAAS,IAAI,GAAG,OAAO,GAAG,KAAK,CAAA;QACtD,MAAM,EAAE,OAAO,SAAS,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,KAAK,CAAA;KAChE,KAAK,GAAG,CAAC,OAAO,CAAA;CACpB;AASD,KAAK,SAAS,CAAC,OAAO,SAAS,UAAU,IAAI,CACzC,KAAK,EACC,cAAc,CAAC,OAAO,CAAC,GACvB,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,GAC7B,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,GACtC,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,KACpD,GAAG,CAAC,OAAO,CAAA;AAIhB,MAAM,WAAW,OAAO,CAAC,OAAO,SAAS,UAAU;IAM/C,MAAM,EAAE,MAAM,IAAI,CAAA;IAKlB,MAAM,EAAE,CAAC,KAAK,SAAS,MAAM,CAAC,OAAO,EAAE,QAAQ,GAAG,QAAQ,CAAC,EACvD,IAAI,EAAE,KAAK,EACX,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,KAC7B,IAAI,CAAA;IAKT,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;IAKnB,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IAK7B,WAAW,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAKjC,0BAA0B,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;IAKlD,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;IAK3B,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;IAKvB,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;IAM3B,UAAU,EAAE,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;IAMpC,cAAc,EAAE,cAAc,CAAA;IAK9B,YAAY,EAAE,YAAY,CAAA;IAK1B,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;CAChC;AAoBD,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,OAAO,SAAS,UAAU,EACtD,MAAM,EAAE,OAAO,EACf,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,EAkBxC,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAC5E,OAAO,CAAC,OAAO,CAAC,CAAA"}
+{"version":3,"file":"use-form.d.ts","sourceRoot":"","sources":["../../../src/client/hooks/use-form.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,GAAG,EAAC,MAAM,OAAO,CAAA;AAE9B,OAAO,KAAK,EACR,uBAAuB,EACvB,gCAAgC,EAChC,mBAAmB,EACnB,4BAA4B,EAC/B,MAAM,wBAAwB,CAAA;AAC/B,OAAO,KAAK,EAAC,MAAM,EAAE,OAAO,EAAC,MAAM,eAAe,CAAA;AAClD,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,gBAAgB,CAAA;AAE7C,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;AAElD;;;GAGG;AACH,MAAM,MAAM,gBAAgB,CAAC,CAAC,IAAI,OAAO,CAAC;KACrC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,MAAM;CACxE,CAAC,CAAA;AAIF;;;;;;;;;;;;;;;GAeG;AACH,KAAK,IAAI,CAAC,OAAO,SAAS,UAAU,IAAI,CAAC,KAAK,EAAE;IAC5C,sEAAsE;IACtE,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IAEzB;;;;OAIG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC/D,KAAK,GAAG,CAAC,OAAO,CAAA;AAEjB;;GAEG;AACH,KAAK,SAAS,CAAC,OAAO,SAAS,UAAU,IAAI,CAAC,KAAK,EAAE;IACjD,uDAAuD;IACvD,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,KAAK,GAAG,KAAK,CAAA;IAEpD,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAA;IAEb;;;QAGI;IACJ,IAAI,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAEhC,oFAAoF;IACpF,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAE/B,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB,KAAK,GAAG,CAAC,OAAO,CAAA;AAEjB;;GAEG;AACH,KAAK,WAAW,CAAC,OAAO,SAAS,UAAU,IAAI,CAAC,KAAK,EAAE;IACnD,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAA;IAEb;;;QAGI;IACJ,IAAI,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAEhC,kFAAkF;IAClF,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAE/B,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB,KAAK,GAAG,CAAC,OAAO,CAAA;AAEjB;;GAEG;AACH,KAAK,aAAa,CAAC,OAAO,SAAS,UAAU,IAAI,CAAC,KAAK,EAAE;IACrD,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAA;IAEb,oFAAoF;IACpF,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAE/B,uDAAuD;IACvD,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB,KAAK,GAAG,CAAC,OAAO,CAAA;AAEjB;;GAEG;AACH,KAAK,QAAQ,CAAC,OAAO,SAAS,UAAU,IAAI,CAAC,KAAK,EAAE;IAChD,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAA;IAEb;;;QAGI;IACJ,IAAI,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;IAEjC,8FAA8F;IAC9F,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;IAEhC,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB,KAAK,GAAG,CAAC,OAAO,CAAA;AAEjB;;GAEG;AACH,KAAK,MAAM,CAAC,OAAO,SAAS,UAAU,IAAI,CAAC,KAAK,EAAE;IAC9C,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAA;IAEb;;;QAGI;IACJ,IAAI,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;IAEjC,8FAA8F;IAC9F,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,SAAS,CAAC,CAAA;IAEhC,0CAA0C;IAC1C,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB,KAAK,GAAG,CAAC,OAAO,CAAA;AAEjB;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,OAAO,SAAS,UAAU;IACzD,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAA;IAEb;;;QAGI;IACJ,IAAI,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAEhC,wFAAwF;IACxF,IAAI,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;IAE/B;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B,6CAA6C;IAC7C,QAAQ,CAAC,EAAE,OAAO,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACnC;;;;OAIG;IACH,wBAAwB,EAAE,IAAI,CAAA;IAE9B;;;;OAIG;IACH,OAAO,EAAE,KAAK,CAAC,uBAAuB,CAAC,GAAG,gCAAgC,CAAA;IAC1E;;QAEI;IACJ,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC,uBAAuB,EAAE,OAAO,CAAC,CAAA;CAChE;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,KAAK,CAAA;IAEhC;;;;OAIG;IACH,OAAO,EAAE,KAAK,CAAC,mBAAmB,CAAC,GAAG,4BAA4B,CAAA;IAClE;;QAEI;IACJ,WAAW,CAAC,EAAE,MAAM,CAAA;CACvB;AAED;;GAEG;AACH,KAAK,QAAQ,CAAC,OAAO,SAAS,UAAU,IAAI,CACxC,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC,GAAG,CAAC,sBAAsB,GAAG,kBAAkB,CAAC,KAChF,GAAG,CAAC,OAAO,CAAA;AAEhB;;GAEG;AACH,KAAK,UAAU,CAAC,OAAO,SAAS,UAAU,EAAE,KAAK,SAAS,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,KAAK,EAAE;IAC1F,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAA;IAEb;;;QAGI;IACJ,IAAI,CAAC,EAAE,KAAK,CAAA;IAEZ,0FAA0F;IAC1F,IAAI,EAAE,KAAK,CAAA;IAEX;;;OAGG;IACH,QAAQ,EAAE,CAAC,IAAI,EAAE;QAAC,IAAI,EAAE,GAAG,KAAK,IAAI,MAAM,EAAE,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAC,KAAK,KAAK,CAAC,SAAS,CAAA;CACnF,KAAK,GAAG,CAAC,OAAO,CAAA;AAEjB;;GAEG;AACH,KAAK,cAAc,GAAG,CAAC,KAAK,EAAE;IAC1B,uCAAuC;IACvC,KAAK,EAAE,MAAM,CAAA;IAEb,wCAAwC;IACxC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC5B,KAAK,GAAG,CAAC,OAAO,CAAA;AAEjB;;;;GAIG;AACH,KAAK,YAAY,GAAG,CAAC,KAAK,EAAE;IACxB,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAA;CAChB,KAAK,GAAG,CAAC,OAAO,CAAA;AAEjB,MAAM,WAAW,cAAc,CAC3B,OAAO,SAAS,UAAU,EAC1B,OAAO,SAAS,OAAO,GAAG,KAAK,EAC/B,WAAW,SAAS,OAAO,GAAG,KAAK,EACnC,OAAO,SAAS,OAAO,GAAG,KAAK;IAE/B,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,UAAU,CAAC,EAAE,WAAW,CAAA;IACxB,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,QAAQ,EAAE,CAAC,KAAK,EAAE;QACd,MAAM,EAAE,OAAO,SAAS,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,KAAK,CAAA;QACvD,UAAU,EAAE,WAAW,SAAS,IAAI,GAAG,OAAO,GAAG,KAAK,CAAA;QACtD,MAAM,EAAE,OAAO,SAAS,IAAI,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,KAAK,CAAA;KAChE,KAAK,GAAG,CAAC,OAAO,CAAA;CACpB;AAED;;;;;;GAMG;AACH,KAAK,SAAS,CAAC,OAAO,SAAS,UAAU,IAAI,CACzC,KAAK,EACC,cAAc,CAAC,OAAO,CAAC,GACvB,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,GAC7B,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,GACtC,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,KACpD,GAAG,CAAC,OAAO,CAAA;AAIhB,MAAM,WAAW,OAAO,CAAC,OAAO,SAAS,UAAU;IAC/C;;;;OAIG;IACH,MAAM,EAAE,MAAM,IAAI,CAAA;IAElB;;OAEG;IACH,MAAM,EAAE,CAAC,KAAK,SAAS,MAAM,CAAC,OAAO,EAAE,QAAQ,GAAG,QAAQ,CAAC,EACvD,IAAI,EAAE,KAAK,EACX,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,KAC7B,IAAI,CAAA;IAET;;OAEG;IACH,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAA;IAEnB;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;IAE7B;;OAEG;IACH,WAAW,EAAE,WAAW,CAAC,OAAO,CAAC,CAAA;IAEjC;;OAEG;IACH,0BAA0B,EAAE,aAAa,CAAC,OAAO,CAAC,CAAA;IAElD;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;IAE3B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;IAEvB;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;IAE3B;;;OAGG;IACH,UAAU,EAAE,UAAU,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;IAEpC;;;OAGG;IACH,cAAc,EAAE,cAAc,CAAA;IAE9B;;OAEG;IACH,YAAY,EAAE,YAAY,CAAA;IAE1B;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC,OAAO,CAAC,CAAA;CAChC;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,OAAO,SAAS,UAAU,EACtD,MAAM,EAAE,OAAO,EACf,aAAa,EAAE,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACxC;;;;;;;;;;;;;;;;GAgBG;AACH,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,gBAAgB,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAC5E,OAAO,CAAC,OAAO,CAAC,CAAA"}

package/lib/client/hooks/use-query.d.ts

@@ -1,3 +1,48 @@
 import type { Query } from "../run-query";
+/**
+ * A hook that runs a GraphQL query and returns the result.
+ *
+ * Your component will suspend until the query completes.
+ *
+ * If you import the query from a `.graphql` file, and run `attio dev`,
+ * your query variables and result will be strongly typed.
+ *
+ * ## EXAMPLE USAGE
+ *
+ * ----
+ * ```graphql
+ * # get-person.graphql
+ * query getPerson($id: String!) {
+ *   workspace {
+ *     person(id: $id) {
+ *       name {
+ *         first
+ *         last
+ *       }
+ *     }
+ *   }
+ * }
+ * ```
+ * ----
+ * ```tsx
+ * // Component.tsx
+ * import { useQuery, useRecord } from "attio/client"
+ * import getPersonQuery from "./get-person.graphql"
+ *
+ * ...
+ *
+ * // in component:
+ * const { recordId } = useRecord()
+ * const result = useQuery(getPersonQuery, { id: recordId })
+ *
+ * const firstName : string | null = result.workspace?.person?.name?.first
+ * const lastName : string | null = result.workspace?.person?.name?.last
+ * ```
+ * ----
+ *
+ * @param query - The GraphQL query to run.
+ * @param variableValues - The variables to pass to the query.
+ * @returns The result of the query.
+ */
 export declare function useQuery<Variables extends Record<string, any> | never, Result>(query: Query<Variables, Result>, variableValues?: Variables extends never ? never : Variables): Result;
 //# sourceMappingURL=use-query.d.ts.map

package/lib/client/hooks/use-query.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-query.d.ts","sourceRoot":"","sources":["../../../src/client/hooks/use-query.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,cAAc,CAAA;AA+CvC,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,KAAK,EAAE,MAAM,EAClF,KAAK,EAAE,KAAK,CAAC,SAAS,EAAE,MAAM,CAAC,EAC/B,cAAc,CAAC,EAAE,SAAS,SAAS,KAAK,GAAG,KAAK,GAAG,SAAS,GAC7D,MAAM,CAAA"}
+{"version":3,"file":"use-query.d.ts","sourceRoot":"","sources":["../../../src/client/hooks/use-query.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,KAAK,EAAC,MAAM,cAAc,CAAA;AAEvC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AACH,MAAM,CAAC,OAAO,UAAU,QAAQ,CAAC,SAAS,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,KAAK,EAAE,MAAM,EAClF,KAAK,EAAE,KAAK,CAAC,SAAS,EAAE,MAAM,CAAC,EAC/B,cAAc,CAAC,EAAE,SAAS,SAAS,KAAK,GAAG,KAAK,GAAG,SAAS,GAC7D,MAAM,CAAA"}

package/lib/client/hooks/use-record.d.ts

@@ -1,6 +1,15 @@
 import type { ObjectSlug } from "../object-slug.js";
+/**
+ * Get information about the current record.
+ */
 export declare function useRecord(): {
+    /**
+     * The ID of the current record.
+     */
     recordId: string;
+    /**
+     * The object type of the current record.
+     */
     object: ObjectSlug;
 };
 //# sourceMappingURL=use-record.d.ts.map

package/lib/client/hooks/use-record.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"use-record.d.ts","sourceRoot":"","sources":["../../../src/client/hooks/use-record.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,mBAAmB,CAAA;AAKjD,MAAM,CAAC,OAAO,UAAU,SAAS,IAAI;IAIjC,QAAQ,EAAE,MAAM,CAAA;IAIhB,MAAM,EAAE,UAAU,CAAA;CACrB,CAAA"}
+{"version":3,"file":"use-record.d.ts","sourceRoot":"","sources":["../../../src/client/hooks/use-record.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,mBAAmB,CAAA;AAEjD;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,IAAI;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAA;CACrB,CAAA"}