attio 0.0.1-experimental.20250821.3 → 0.0.1-experimental.20250825

package/lib/client/components/dialog-list.d.ts

@@ -1,19 +1,56 @@
 import type React from "react";
 import type { Icon } from "../icon";
 declare const DialogListItem: (props: {
+    /**
+     * The children will be rendered as the text of the list item.
+     */
     children: React.ReactNode;
+    /**
+     * The icon of the list item.
+     */
     icon: Icon;
+    /**
+     * The action label of the list item.
+     */
     actionLabel: string;
+    /**
+     * The on trigger handler of the list item.
+     */
     onTrigger: () => void | Promise<void>;
+    /**
+     * The suffix that will be rendered on the right side of the list item.
+     */
     suffix?: React.ReactNode;
 }) => React.JSX.Element;
+/**
+ * @deprecated This part of the SDK is not yet released and may change. DO NOT USE
+ * IN PRODUCTION VERSIONS OF THE APP.
+ */
 export declare const DialogList: {
     (props: {
+        /**
+         * A message and action buttons to display when the list is empty.
+         */
         emptyState: {
+            /**
+             * The empty state's text.
+             */
             text: string;
+            /**
+             * The empty state's actions.
+             */
             actions?: Array<{
+                /**
+                 * The text appearing on the button.
+                 */
                 text: string;
+                /**
+                 * A function to run when the button is triggered.
+                 */
                 onTrigger: () => void;
+                /**
+                 * An optional button icon.
+                 */
                 icon?: Icon;
             }>;
         } | string;

package/lib/client/components/dialog-list.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dialog-list.d.ts","sourceRoot":"","sources":["../../../src/client/components/dialog-list.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,SAAS,CAAA;AAEjC,OAAO,CAAC,MAAM,cAAc,EAAE,CAAC,KAAK,EAAE;IAIlC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IAKzB,IAAI,EAAE,IAAI,CAAA;IAKV,WAAW,EAAE,MAAM,CAAA;IAKnB,SAAS,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAKrC,MAAM,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC3B,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA;AAMvB,MAAM,CAAC,OAAO,CAAC,MAAM,UAAU,EAAE;IAC7B,CAAC,KAAK,EAAE;QAIJ,UAAU,EACJ;YAII,IAAI,EAAE,MAAM,CAAA;YAIZ,OAAO,CAAC,EAAE,KAAK,CAAC;gBAIZ,IAAI,EAAE,MAAM,CAAA;gBAIZ,SAAS,EAAE,MAAM,IAAI,CAAA;gBAIrB,IAAI,CAAC,EAAE,IAAI,CAAA;aACd,CAAC,CAAA;SACL,GACD,MAAM,CAAA;QAEZ,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;KAC5B,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA;IACrB,IAAI,EAAE,OAAO,cAAc,CAAA;CAC9B,CAAA"}
+{"version":3,"file":"dialog-list.d.ts","sourceRoot":"","sources":["../../../src/client/components/dialog-list.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,SAAS,CAAA;AAEjC,OAAO,CAAC,MAAM,cAAc,EAAE,CAAC,KAAK,EAAE;IAClC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IAEzB;;OAEG;IACH,IAAI,EAAE,IAAI,CAAA;IAEV;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAErC;;OAEG;IACH,MAAM,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC3B,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA;AAEvB;;;GAGG;AACH,MAAM,CAAC,OAAO,CAAC,MAAM,UAAU,EAAE;IAC7B,CAAC,KAAK,EAAE;QACJ;;WAEG;QACH,UAAU,EACJ;YACI;;eAEG;YACH,IAAI,EAAE,MAAM,CAAA;YACZ;;eAEG;YACH,OAAO,CAAC,EAAE,KAAK,CAAC;gBACZ;;mBAEG;gBACH,IAAI,EAAE,MAAM,CAAA;gBACZ;;mBAEG;gBACH,SAAS,EAAE,MAAM,IAAI,CAAA;gBACrB;;mBAEG;gBACH,IAAI,CAAC,EAAE,IAAI,CAAA;aACd,CAAC,CAAA;SACL,GACD,MAAM,CAAA;QAEZ,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;KAC5B,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA;IACrB,IAAI,EAAE,OAAO,cAAc,CAAA;CAC9B,CAAA"}

package/lib/client/components/divider.d.ts

@@ -1,3 +1,6 @@
 import type React from "react";
+/**
+ * A component for rendering a divider line.
+ */
 export declare function Divider(): React.JSX.Element;
 //# sourceMappingURL=divider.d.ts.map

package/lib/client/components/divider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"divider.d.ts","sourceRoot":"","sources":["../../../src/client/components/divider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAK9B,MAAM,CAAC,OAAO,UAAU,OAAO,IAAI,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}
+{"version":3,"file":"divider.d.ts","sourceRoot":"","sources":["../../../src/client/components/divider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,IAAI,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}

package/lib/client/components/icon.d.ts

@@ -1,5 +1,8 @@
 import type React from "react";
 import type { Icon } from "../icon";
+/**
+ * @deprecated This part of the SDK has not been released yet and may change. DO NOT USE IN PRODUCTION.
+ */
 export declare function Experimental_Icon(props: {
     icon: Icon;
 }): React.JSX.Element;

package/lib/client/components/icon.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"icon.d.ts","sourceRoot":"","sources":["../../../src/client/components/icon.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,SAAS,CAAA;AAKjC,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,KAAK,EAAE;IAAC,IAAI,EAAE,IAAI,CAAA;CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}
+{"version":3,"file":"icon.d.ts","sourceRoot":"","sources":["../../../src/client/components/icon.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,SAAS,CAAA;AAEjC;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,iBAAiB,CAAC,KAAK,EAAE;IAAC,IAAI,EAAE,IAAI,CAAA;CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}

package/lib/client/components/json.d.ts

@@ -1,4 +1,7 @@
 import React from "react";
+/**
+ * A component for displaying JSON data, primarily used for debugging.
+ */
 export declare function Json(props: {
     data: unknown;
 }): React.JSX.Element;

package/lib/client/components/json.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../../../src/client/components/json.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAKzB,MAAM,CAAC,OAAO,UAAU,IAAI,CAAC,KAAK,EAAE;IAAC,IAAI,EAAE,OAAO,CAAA;CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}
+{"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../../../src/client/components/json.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,IAAI,CAAC,KAAK,EAAE;IAAC,IAAI,EAAE,OAAO,CAAA;CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}

package/lib/client/components/keyboard-key.d.ts

@@ -1,2 +1,8 @@
-export type KeyboardKey = "mod" | "backspace" | "tab" | "enter" | "return" | "shift" | "ctrl" | "alt" | "esc" | "space" | "left" | "up" | "right" | "down" | "plus" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "0";
+export type KeyboardKey = 
+/** Handles command on mac, ctrl on mac */
+"mod" | "backspace" | "tab"
+/** Watch out! Different to return! */
+ | "enter"
+/** Watch out! Different to enter! */
+ | "return" | "shift" | "ctrl" | "alt" | "esc" | "space" | "left" | "up" | "right" | "down" | "plus" | "a" | "b" | "c" | "d" | "e" | "f" | "g" | "h" | "i" | "j" | "k" | "l" | "m" | "n" | "o" | "p" | "q" | "r" | "s" | "t" | "u" | "v" | "w" | "x" | "y" | "z" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "0";
 //# sourceMappingURL=keyboard-key.d.ts.map

package/lib/client/components/keyboard-key.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"keyboard-key.d.ts","sourceRoot":"","sources":["../../../src/client/components/keyboard-key.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW,GAEjB,KAAK,GACL,WAAW,GACX,KAAK,GAEL,OAAO,GAEP,QAAQ,GACR,OAAO,GACP,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,MAAM,GACN,IAAI,GACJ,OAAO,GACP,MAAM,GACN,MAAM,GACN,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,CAAA"}
+{"version":3,"file":"keyboard-key.d.ts","sourceRoot":"","sources":["../../../src/client/components/keyboard-key.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,WAAW;AACnB,0CAA0C;AACxC,KAAK,GACL,WAAW,GACX,KAAK;AACP,sCAAsC;GACpC,OAAO;AACT,qCAAqC;GACnC,QAAQ,GACR,OAAO,GACP,MAAM,GACN,KAAK,GACL,KAAK,GACL,OAAO,GACP,MAAM,GACN,IAAI,GACJ,OAAO,GACP,MAAM,GACN,MAAM,GACN,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,GACH,GAAG,CAAA"}

package/lib/client/components/link.d.ts

@@ -1,6 +1,15 @@
 import React from "react";
+/**
+ * An external hyperlink.
+ */
 export declare function Link(props: {
+    /**
+     * The URL to link to.
+     */
     href: string;
+    /**
+     * The content of the link. Usually text.
+     */
     children: React.ReactNode;
 }): React.JSX.Element;
 //# sourceMappingURL=link.d.ts.map

package/lib/client/components/link.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"link.d.ts","sourceRoot":"","sources":["../../../src/client/components/link.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAKzB,MAAM,CAAC,OAAO,UAAU,IAAI,CAAC,KAAK,EAAE;IAIhC,IAAI,EAAE,MAAM,CAAA;IAKZ,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC5B,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}
+{"version":3,"file":"link.d.ts","sourceRoot":"","sources":["../../../src/client/components/link.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,IAAI,CAAC,KAAK,EAAE;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC5B,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}

package/lib/client/components/row.d.ts

@@ -1,7 +1,20 @@
 import type React from "react";
+/**
+ * A component for laying out children horizontally.
+ *
+ * It will automatically wrap after the third child.
+ */
 export declare function Row(props: {
     children: React.ReactNode;
+    /**
+     * How to align the children within the row.
+     *
+     * @default "left"
+     */
     align?: "left" | "center" | "right" | "space-between" | "space-evenly" | "space-around";
+    /**
+     * A function to call when the row is triggered.
+     */
     onTrigger?: () => void | Promise<void>;
 }): React.JSX.Element;
 //# sourceMappingURL=row.d.ts.map

package/lib/client/components/row.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"row.d.ts","sourceRoot":"","sources":["../../../src/client/components/row.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAO9B,MAAM,CAAC,OAAO,UAAU,GAAG,CAAC,KAAK,EAAE;IAC/B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IAOzB,KAAK,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,eAAe,GAAG,cAAc,GAAG,cAAc,CAAA;IAKvF,SAAS,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACzC,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}
+{"version":3,"file":"row.d.ts","sourceRoot":"","sources":["../../../src/client/components/row.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B;;;;GAIG;AACH,MAAM,CAAC,OAAO,UAAU,GAAG,CAAC,KAAK,EAAE;IAC/B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IAEzB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,GAAG,eAAe,GAAG,cAAc,GAAG,cAAc,CAAA;IAEvF;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACzC,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}

package/lib/client/components/section.d.ts

@@ -1,6 +1,17 @@
 import React from "react";
+/**
+ * A section of a page with a title.
+ */
 export declare function Section(props: {
+    /**
+     * The title of the section.
+     *
+     * It will be displayed in a stronger font than the content of the section.
+     */
     title: string;
+    /**
+     * The content of the section, either text or other components.
+     */
     children?: React.ReactNode;
 }): React.JSX.Element;
 //# sourceMappingURL=section.d.ts.map

package/lib/client/components/section.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"section.d.ts","sourceRoot":"","sources":["../../../src/client/components/section.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAKzB,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,KAAK,EAAE;IAMnC,KAAK,EAAE,MAAM,CAAA;IAIb,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC7B,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}
+{"version":3,"file":"section.d.ts","sourceRoot":"","sources":["../../../src/client/components/section.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,KAAK,EAAE;IACnC;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,SAAS,CAAA;CAC7B,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}

package/lib/client/components/status-badge.d.ts

@@ -1,7 +1,13 @@
 import type React from "react";
 export type StatusBadgeIndicatorColor = "blue" | "violet" | "pink" | "red" | "orange" | "yellow" | "green" | "cyan" | "grey" | `#${string}`;
 interface StatusBadgeProps {
+    /**
+     * A supported indicator color name or a custom hex color in the format `#RRGGBB`.
+     */
     color: StatusBadgeIndicatorColor;
+    /**
+     * The label of the badge
+     */
     children: React.ReactNode;
 }
 export declare function StatusBadge(props: StatusBadgeProps): React.JSX.Element;

package/lib/client/components/status-badge.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"status-badge.d.ts","sourceRoot":"","sources":["../../../src/client/components/status-badge.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B,MAAM,MAAM,yBAAyB,GAC/B,MAAM,GACN,QAAQ,GACR,MAAM,GACN,KAAK,GACL,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,MAAM,GACN,MAAM,GACN,IAAI,MAAM,EAAE,CAAA;AAElB,UAAU,gBAAgB;IAItB,KAAK,EAAE,yBAAyB,CAAA;IAIhC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC5B;AAED,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}
+{"version":3,"file":"status-badge.d.ts","sourceRoot":"","sources":["../../../src/client/components/status-badge.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAA;AAE9B,MAAM,MAAM,yBAAyB,GAC/B,MAAM,GACN,QAAQ,GACR,MAAM,GACN,KAAK,GACL,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,MAAM,GACN,MAAM,GACN,IAAI,MAAM,EAAE,CAAA;AAElB,UAAU,gBAAgB;IACtB;;OAEG;IACH,KAAK,EAAE,yBAAyB,CAAA;IAChC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC5B;AAED,MAAM,CAAC,OAAO,UAAU,WAAW,CAAC,KAAK,EAAE,gBAAgB,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}

package/lib/client/components/text-block.d.ts

@@ -1,6 +1,17 @@
 import React from "react";
+/**
+ * A text block, whose content can optionally be aligned.
+ */
 export declare function TextBlock(props: {
+    /**
+     * How to align the content of the text block.
+     *
+     * @default "center"
+     */
     align?: "left" | "center" | "right";
+    /**
+     * The content of the text block. Usually text, but can also be other components.
+     */
     children: React.ReactNode;
 }): React.JSX.Element;
 //# sourceMappingURL=text-block.d.ts.map

package/lib/client/components/text-block.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"text-block.d.ts","sourceRoot":"","sources":["../../../src/client/components/text-block.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAKzB,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,KAAK,EAAE;IAMrC,KAAK,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAA;IAInC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC5B,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}
+{"version":3,"file":"text-block.d.ts","sourceRoot":"","sources":["../../../src/client/components/text-block.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,SAAS,CAAC,KAAK,EAAE;IACrC;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,OAAO,CAAA;IACnC;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC5B,GAAG,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}

package/lib/client/components/typography.d.ts

@@ -1,10 +1,23 @@
 import React from "react";
+/**
+ * A set of components for styling text.
+ */
 interface TypographyType {
     Body: (props: {
+        /**
+         * The variant of the text.
+         *
+         * @default "standard"
+         */
         variant?: "standard" | "large" | "strong" | "interactive";
         children: React.ReactNode;
     }) => React.JSX.Element;
     Title: (props: {
+        /**
+         * The variant of the text.
+         *
+         * @default "standard"
+         */
         variant?: "extraLarge" | "large" | "standard" | "medium" | "small" | "extraSmall";
         children: React.ReactNode;
     }) => React.JSX.Element;

package/lib/client/components/typography.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typography.d.ts","sourceRoot":"","sources":["../../../src/client/components/typography.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAKzB,UAAU,cAAc;IACpB,IAAI,EAAE,CAAC,KAAK,EAAE;QAMV,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,QAAQ,GAAG,aAAa,CAAA;QACzD,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;KAC5B,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA;IACvB,KAAK,EAAE,CAAC,KAAK,EAAE;QAMX,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,YAAY,CAAA;QACjF,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;KAC5B,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA;IACvB,OAAO,EAAE,CAAC,KAAK,EAAE;QAAC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;KAAC,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA;CACrE;AAED,MAAM,CAAC,OAAO,CAAC,MAAM,UAAU,EAAE,cAAc,CAAA"}
+{"version":3,"file":"typography.d.ts","sourceRoot":"","sources":["../../../src/client/components/typography.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAA;AAEzB;;GAEG;AACH,UAAU,cAAc;IACpB,IAAI,EAAE,CAAC,KAAK,EAAE;QACV;;;;WAIG;QACH,OAAO,CAAC,EAAE,UAAU,GAAG,OAAO,GAAG,QAAQ,GAAG,aAAa,CAAA;QACzD,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;KAC5B,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA;IACvB,KAAK,EAAE,CAAC,KAAK,EAAE;QACX;;;;WAIG;QACH,OAAO,CAAC,EAAE,YAAY,GAAG,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,OAAO,GAAG,YAAY,CAAA;QACjF,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;KAC5B,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA;IACvB,OAAO,EAAE,CAAC,KAAK,EAAE;QAAC,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;KAAC,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA;CACrE;AAED,MAAM,CAAC,OAAO,CAAC,MAAM,UAAU,EAAE,cAAc,CAAA"}

package/lib/client/components/widget-badge.d.ts

@@ -1,11 +1,16 @@
 type BadgeColor = "amber" | "blue" | "cyan" | "green" | "grey" | "lavender" | "lime" | "orange" | "pink" | "purple" | "red" | "yellow";
 interface BaseWidgetBadgeProps {
+    /** The variant of the badge */
     color: BadgeColor;
 }
 interface WidgetTextBadgeProps extends BaseWidgetBadgeProps {
+    /** The text contents of the badge */
     text: string;
 }
 type WidgetBadgeProps = WidgetTextBadgeProps;
+/**
+ * Badge component for a widget
+ */
 export declare const WidgetBadge: (props: WidgetBadgeProps) => React.JSX.Element;
 export {};
 //# sourceMappingURL=widget-badge.d.ts.map

package/lib/client/components/widget-badge.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"widget-badge.d.ts","sourceRoot":"","sources":["../../../src/client/components/widget-badge.ts"],"names":[],"mappings":"AAAA,KAAK,UAAU,GACT,OAAO,GACP,MAAM,GACN,MAAM,GACN,OAAO,GACP,MAAM,GACN,UAAU,GACV,MAAM,GACN,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,KAAK,GACL,QAAQ,CAAA;AAEd,UAAU,oBAAoB;IAE1B,KAAK,EAAE,UAAU,CAAA;CACpB;AAED,UAAU,oBAAqB,SAAQ,oBAAoB;IAEvD,IAAI,EAAE,MAAM,CAAA;CACf;AAcD,KAAK,gBAAgB,GAAG,oBAAoB,CAAA;AAK5C,MAAM,CAAC,OAAO,CAAC,MAAM,WAAW,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}
+{"version":3,"file":"widget-badge.d.ts","sourceRoot":"","sources":["../../../src/client/components/widget-badge.ts"],"names":[],"mappings":"AAAA,KAAK,UAAU,GACT,OAAO,GACP,MAAM,GACN,MAAM,GACN,OAAO,GACP,MAAM,GACN,UAAU,GACV,MAAM,GACN,QAAQ,GACR,MAAM,GACN,QAAQ,GACR,KAAK,GACL,QAAQ,CAAA;AAEd,UAAU,oBAAoB;IAC1B,+BAA+B;IAC/B,KAAK,EAAE,UAAU,CAAA;CACpB;AAED,UAAU,oBAAqB,SAAQ,oBAAoB;IACvD,qCAAqC;IACrC,IAAI,EAAE,MAAM,CAAA;CACf;AAcD,KAAK,gBAAgB,GAAG,oBAAoB,CAAA;AAE5C;;GAEG;AACH,MAAM,CAAC,OAAO,CAAC,MAAM,WAAW,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}

package/lib/client/components/widget-loading.d.ts

@@ -1,2 +1,7 @@
+/**
+ * Loading component for a widget.
+ *
+ * Useful as a fallback if you're doing suspense manually inside your widget.
+ */
 export declare const WidgetLoading: () => React.JSX.Element;
 //# sourceMappingURL=widget-loading.d.ts.map

package/lib/client/components/widget-loading.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"widget-loading.d.ts","sourceRoot":"","sources":["../../../src/client/components/widget-loading.ts"],"names":[],"mappings":"AAKA,MAAM,CAAC,OAAO,CAAC,MAAM,aAAa,EAAE,MAAM,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}
+{"version":3,"file":"widget-loading.d.ts","sourceRoot":"","sources":["../../../src/client/components/widget-loading.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,CAAC,OAAO,CAAC,MAAM,aAAa,EAAE,MAAM,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}

package/lib/client/components/widget-text-primary.d.ts

@@ -1,6 +1,12 @@
+/**
+ * Props for the WidgetTextPrimary component
+ */
 interface WidgetTextPrimaryProps {
     children: React.ReactNode;
 }
+/**
+ * Primary text component for a widget
+ */
 export declare const WidgetTextPrimary: (props: WidgetTextPrimaryProps) => React.JSX.Element;
 export {};
 //# sourceMappingURL=widget-text-primary.d.ts.map

package/lib/client/components/widget-text-primary.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"widget-text-primary.d.ts","sourceRoot":"","sources":["../../../src/client/components/widget-text-primary.ts"],"names":[],"mappings":"AAGA,UAAU,sBAAsB;IAC5B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC5B;AAKD,MAAM,CAAC,OAAO,CAAC,MAAM,iBAAiB,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}
+{"version":3,"file":"widget-text-primary.d.ts","sourceRoot":"","sources":["../../../src/client/components/widget-text-primary.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,UAAU,sBAAsB;IAC5B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,CAAC,MAAM,iBAAiB,EAAE,CAAC,KAAK,EAAE,sBAAsB,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}

package/lib/client/components/widget-text-secondary.d.ts

@@ -1,6 +1,12 @@
+/**
+ * Props for the WidgetTextSecondary component
+ */
 interface WidgetTextSecondaryProps {
     children: React.ReactNode;
 }
+/**
+ * Secondary text component for a widget
+ */
 export declare const WidgetTextSecondary: (props: WidgetTextSecondaryProps) => React.JSX.Element;
 export {};
 //# sourceMappingURL=widget-text-secondary.d.ts.map

package/lib/client/components/widget-text-secondary.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"widget-text-secondary.d.ts","sourceRoot":"","sources":["../../../src/client/components/widget-text-secondary.ts"],"names":[],"mappings":"AAGA,UAAU,wBAAwB;IAC9B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC5B;AAKD,MAAM,CAAC,OAAO,CAAC,MAAM,mBAAmB,EAAE,CAAC,KAAK,EAAE,wBAAwB,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}
+{"version":3,"file":"widget-text-secondary.d.ts","sourceRoot":"","sources":["../../../src/client/components/widget-text-secondary.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,UAAU,wBAAwB;IAC9B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,CAAC,MAAM,mBAAmB,EAAE,CAAC,KAAK,EAAE,wBAAwB,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}

package/lib/client/components/widget-text-widget.d.ts

@@ -1,7 +1,23 @@
+/**
+ * Props for the TextWidget component
+ */
 interface WidgetTextWidgetProps {
+    /**
+     * The content of the widget.
+     */
     children: React.ReactNode;
+    /**
+     * If provided, this callback will be called when the user triggers the widget.
+     *
+     * (like onClick for the web)
+     *
+     * You may want to call a server function or open a dialog with showDialog().
+     */
     onTrigger?: () => void | Promise<void>;
 }
+/**
+ * A text widget component
+ */
 export declare const WidgetTextWidget: (props: WidgetTextWidgetProps) => React.JSX.Element;
 export {};
 //# sourceMappingURL=widget-text-widget.d.ts.map

package/lib/client/components/widget-text-widget.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"widget-text-widget.d.ts","sourceRoot":"","sources":["../../../src/client/components/widget-text-widget.ts"],"names":[],"mappings":"AAGA,UAAU,qBAAqB;IAI3B,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IASzB,SAAS,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACzC;AAKD,MAAM,CAAC,OAAO,CAAC,MAAM,gBAAgB,EAAE,CAAC,KAAK,EAAE,qBAAqB,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}
+{"version":3,"file":"widget-text-widget.d.ts","sourceRoot":"","sources":["../../../src/client/components/widget-text-widget.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,UAAU,qBAAqB;IAC3B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;IAEzB;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CACzC;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,CAAC,MAAM,gBAAgB,EAAE,CAAC,KAAK,EAAE,qBAAqB,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}

package/lib/client/components/widget-title.d.ts

@@ -1,6 +1,12 @@
+/**
+ * Props for the WidgetTitle component
+ */
 interface WidgetTitleProps {
     children: React.ReactNode;
 }
+/**
+ * Title component for a widget
+ */
 export declare const WidgetTitle: (props: WidgetTitleProps) => React.JSX.Element;
 export {};
 //# sourceMappingURL=widget-title.d.ts.map

package/lib/client/components/widget-title.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"widget-title.d.ts","sourceRoot":"","sources":["../../../src/client/components/widget-title.ts"],"names":[],"mappings":"AAGA,UAAU,gBAAgB;IACtB,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC5B;AAKD,MAAM,CAAC,OAAO,CAAC,MAAM,WAAW,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}
+{"version":3,"file":"widget-title.d.ts","sourceRoot":"","sources":["../../../src/client/components/widget-title.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,UAAU,gBAAgB;IACtB,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,CAAC,MAAM,WAAW,EAAE,CAAC,KAAK,EAAE,gBAAgB,KAAK,KAAK,CAAC,GAAG,CAAC,OAAO,CAAA"}

package/lib/client/components/widget.d.ts

@@ -4,6 +4,10 @@ import type { WidgetTextPrimary } from "./widget-text-primary";
 import type { WidgetTextSecondary } from "./widget-text-secondary";
 import type { WidgetTextWidget } from "./widget-text-widget";
 import type { WidgetTitle } from "./widget-title";
+/**
+ * Widget component API
+ * @deprecated This part of the SDK is not yet released and may change. Do not use it yet.
+ */
 export declare const Widget: {
     Title: typeof WidgetTitle;
     Badge: typeof WidgetBadge;

package/lib/client/components/widget.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"widget.d.ts","sourceRoot":"","sources":["../../../src/client/components/widget.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAA;AAC/C,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,kBAAkB,CAAA;AACnD,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAA;AAC5D,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,yBAAyB,CAAA;AAChE,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAA;AAM/C,MAAM,CAAC,OAAO,CAAC,MAAM,MAAM,EAAE;IACzB,KAAK,EAAE,OAAO,WAAW,CAAA;IACzB,KAAK,EAAE,OAAO,WAAW,CAAA;IACzB,OAAO,EAAE,OAAO,aAAa,CAAA;IAC7B,IAAI,EAAE;QACF,OAAO,EAAE,OAAO,iBAAiB,CAAA;QACjC,SAAS,EAAE,OAAO,mBAAmB,CAAA;KACxC,CAAA;IACD,UAAU,EAAE,OAAO,gBAAgB,CAAA;CACtC,CAAA"}
+{"version":3,"file":"widget.d.ts","sourceRoot":"","sources":["../../../src/client/components/widget.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAA;AAC/C,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,kBAAkB,CAAA;AACnD,OAAO,KAAK,EAAC,iBAAiB,EAAC,MAAM,uBAAuB,CAAA;AAC5D,OAAO,KAAK,EAAC,mBAAmB,EAAC,MAAM,yBAAyB,CAAA;AAChE,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,gBAAgB,CAAA;AAE/C;;;GAGG;AACH,MAAM,CAAC,OAAO,CAAC,MAAM,MAAM,EAAE;IACzB,KAAK,EAAE,OAAO,WAAW,CAAA;IACzB,KAAK,EAAE,OAAO,WAAW,CAAA;IACzB,OAAO,EAAE,OAAO,aAAa,CAAA;IAC7B,IAAI,EAAE;QACF,OAAO,EAAE,OAAO,iBAAiB,CAAA;QACjC,SAAS,EAAE,OAAO,mBAAmB,CAAA;KACxC,CAAA;IACD,UAAU,EAAE,OAAO,gBAAgB,CAAA;CACtC,CAAA"}

package/lib/client/confirm.d.ts

@@ -1,23 +1,81 @@
 import type { Icon } from "./icon";
 interface BaseConfirmOptions {
+    /**
+     * Label for the "Cancel" button.
+     *
+     * Defaults to "Cancel".
+     * @default "Cancel"
+     */
     cancelLabel?: string;
+    /**
+     * Label for the "Confirm" button.
+     *
+     * Defaults to "OK".
+     * @default "OK"
+     */
     confirmLabel?: string;
+    /**
+     * Icon to display on the confirm button.
+     */
     confirmIcon?: Icon;
+    /**
+     * Variant of the "confirm" button.
+     *
+     * Defaults to "primary".
+     * @default "primary"
+     */
     confirmVariant?: "primary" | "secondary" | "secondary-destructive" | "destructive";
 }
 interface ConfirmNoTextOptions extends BaseConfirmOptions {
+    /**
+     * Title of the prompt.
+     */
     title: string;
+    /**
+     * No text will be displayed.
+     */
     text?: never;
 }
 interface ConfirmNoTitleOptions extends BaseConfirmOptions {
+    /**
+     * No title will be displayed.
+     */
     title?: never;
+    /**
+     * Text to display
+     */
     text: string;
 }
 interface ConfirmWithTextAndTitleOptions extends BaseConfirmOptions {
+    /**
+     * Title of the prompt.
+     */
     title: string;
+    /**
+     * Text to display below the title.
+     */
     text: string;
 }
 export type ConfirmOptions = ConfirmNoTextOptions | ConfirmNoTitleOptions | ConfirmWithTextAndTitleOptions;
+/**
+ * Shows a confirm prompt to the user.
+ *
+ * ## EXAMPLE USAGE
+ *
+ * ----
+ * ```tsx
+ * // app.tsx
+ * import { showPrompt } from "attio/client";
+ *
+ * await confirm({
+ *     title: "Are you sure you want to delete this item?",
+ *     text: "This action cannot be undone.",
+ *     cancelLabel: "Cancel",
+ *     confirmLabel: "Delete",
+ * });
+ * ```
+ * ----
+ */
 export declare function confirm(options: ConfirmOptions): Promise<boolean>;
 export {};
 //# sourceMappingURL=confirm.d.ts.map

package/lib/client/confirm.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"confirm.d.ts","sourceRoot":"","sources":["../../src/client/confirm.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAEhC,UAAU,kBAAkB;IAOxB,WAAW,CAAC,EAAE,MAAM,CAAA;IAQpB,YAAY,CAAC,EAAE,MAAM,CAAA;IAKrB,WAAW,CAAC,EAAE,IAAI,CAAA;IAQlB,cAAc,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,uBAAuB,GAAG,aAAa,CAAA;CACrF;AAED,UAAU,oBAAqB,SAAQ,kBAAkB;IAIrD,KAAK,EAAE,MAAM,CAAA;IAKb,IAAI,CAAC,EAAE,KAAK,CAAA;CACf;AAED,UAAU,qBAAsB,SAAQ,kBAAkB;IAItD,KAAK,CAAC,EAAE,KAAK,CAAA;IAKb,IAAI,EAAE,MAAM,CAAA;CACf;AAED,UAAU,8BAA+B,SAAQ,kBAAkB;IAI/D,KAAK,EAAE,MAAM,CAAA;IAKb,IAAI,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,cAAc,GACpB,oBAAoB,GACpB,qBAAqB,GACrB,8BAA8B,CAAA;AAqBpC,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA"}
+{"version":3,"file":"confirm.d.ts","sourceRoot":"","sources":["../../src/client/confirm.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,QAAQ,CAAA;AAEhC,UAAU,kBAAkB;IACxB;;;;;OAKG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,IAAI,CAAA;IAElB;;;;;OAKG;IACH,cAAc,CAAC,EAAE,SAAS,GAAG,WAAW,GAAG,uBAAuB,GAAG,aAAa,CAAA;CACrF;AAED,UAAU,oBAAqB,SAAQ,kBAAkB;IACrD;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,KAAK,CAAA;CACf;AAED,UAAU,qBAAsB,SAAQ,kBAAkB;IACtD;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAA;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACf;AAED,UAAU,8BAA+B,SAAQ,kBAAkB;IAC/D;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACf;AAED,MAAM,MAAM,cAAc,GACpB,oBAAoB,GACpB,qBAAqB,GACrB,8BAA8B,CAAA;AAEpC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA"}

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

@@ -1,9 +1,21 @@
 import type { FormValue } from "./value";
+/**
+ * An array form value.
+ */
 export interface FormArray<T extends FormValue | Record<string, FormValue>, TOptional extends boolean = false> extends FormValue {
     type: "array";
     elementType: T;
+    /**
+     * Whether this array is optional, i.e. allows `undefined` values.
+     */
     isOptional: TOptional;
+    /**
+     * Make this array optional, i.e. allow `undefined` values.
+     */
     optional(): FormArray<T, true>;
 }
+/**
+ * Create a new array form value.
+ */
 export declare function array<T extends FormValue | Record<string, FormValue>>(elementType: T): FormArray<T, false>;
 //# sourceMappingURL=array.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../../src/client/forms/array.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,SAAS,CAAA;AAKtC,MAAM,WAAW,SAAS,CACtB,CAAC,SAAS,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EAC/C,SAAS,SAAS,OAAO,GAAG,KAAK,CACnC,SAAQ,SAAS;IACf,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,EAAE,CAAC,CAAA;IAKd,UAAU,EAAE,SAAS,CAAA;IAKrB,QAAQ,IAAI,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;CACjC;AAKD,MAAM,CAAC,OAAO,UAAU,KAAK,CAAC,CAAC,SAAS,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EACzE,WAAW,EAAE,CAAC,GACf,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA"}
+{"version":3,"file":"array.d.ts","sourceRoot":"","sources":["../../../src/client/forms/array.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,SAAS,CAAA;AAEtC;;GAEG;AACH,MAAM,WAAW,SAAS,CACtB,CAAC,SAAS,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EAC/C,SAAS,SAAS,OAAO,GAAG,KAAK,CACnC,SAAQ,SAAS;IACf,IAAI,EAAE,OAAO,CAAA;IACb,WAAW,EAAE,CAAC,CAAA;IAEd;;OAEG;IACH,UAAU,EAAE,SAAS,CAAA;IAErB;;OAEG;IACH,QAAQ,IAAI,SAAS,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,KAAK,CAAC,CAAC,SAAS,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,EACzE,WAAW,EAAE,CAAC,GACf,SAAS,CAAC,CAAC,EAAE,KAAK,CAAC,CAAA"}

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

@@ -1,8 +1,20 @@
 import type { FormValue } from "./value";
+/**
+ * A boolean form value.
+ */
 export interface FormBoolean<TOptional extends boolean = false> extends FormValue {
     type: "boolean";
+    /**
+     * Whether this boolean is optional, i.e. allows `undefined` values.
+     */
     isOptional: TOptional;
+    /**
+     * Make this boolean optional, i.e. allow `undefined` values.
+     */
     optional(): FormBoolean<true>;
 }
+/**
+ * Create a new boolean form value.
+ */
 export declare function boolean(): FormBoolean<false>;
 //# sourceMappingURL=boolean.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"boolean.d.ts","sourceRoot":"","sources":["../../../src/client/forms/boolean.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,SAAS,CAAA;AAKtC,MAAM,WAAW,WAAW,CAAC,SAAS,SAAS,OAAO,GAAG,KAAK,CAAE,SAAQ,SAAS;IAC7E,IAAI,EAAE,SAAS,CAAA;IAKf,UAAU,EAAE,SAAS,CAAA;IAKrB,QAAQ,IAAI,WAAW,CAAC,IAAI,CAAC,CAAA;CAChC;AAKD,MAAM,CAAC,OAAO,UAAU,OAAO,IAAI,WAAW,CAAC,KAAK,CAAC,CAAA"}
+{"version":3,"file":"boolean.d.ts","sourceRoot":"","sources":["../../../src/client/forms/boolean.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,SAAS,CAAA;AAEtC;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,SAAS,SAAS,OAAO,GAAG,KAAK,CAAE,SAAQ,SAAS;IAC7E,IAAI,EAAE,SAAS,CAAA;IAEf;;OAEG;IACH,UAAU,EAAE,SAAS,CAAA;IAErB;;OAEG;IACH,QAAQ,IAAI,WAAW,CAAC,IAAI,CAAC,CAAA;CAChC;AAED;;GAEG;AACH,MAAM,CAAC,OAAO,UAAU,OAAO,IAAI,WAAW,CAAC,KAAK,CAAC,CAAA"}

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"}