@tenstorrent/vesper 0.1.0

package/dist/utils/splitFormInputProps.d.ts

@@ -0,0 +1,119 @@
+import type { AriaAttributes, ComponentProps, ElementType } from "react";
+/**
+ * These props may not be forwarded at all. `role` should not be overridden for
+ * accessibility reasons, while `children` and `dangerouslySetInnerHTML` should
+ * not be allowed as each of our form input components render their own content
+ * */
+declare const DISALLOWED_PROPS: ["role", "children", "dangerouslySetInnerHTML"];
+/**
+ * Props which get forwarded to the underlying control element. Typically the
+ * underlying control will be a `button`, `input`, or `textarea` element.
+ *
+ * Other event handlers are omitted so they may be forwarded to wrappers.
+ * */
+declare const CONTROL_PROPS: ["autoCapitalize", "autoCorrect", "autoFocus", "enterKeyHint", "id", "inputMode", "ref", "spellCheck", "tabIndex", "title", "onBlur", "onBlurCapture", "onFocus", "onFocusCapture", "onKeyDown", "onKeyDownCapture", "onKeyPress", "onKeyPressCapture", "onKeyUp", "onKeyUpCapture", "onBeforeInput", "onBeforeInputCapture", "onChange", "onChangeCapture", "onInput", "onInputCapture", "onInvalid", "onInvalidCapture", "onSelect", "onSelectCapture", "onCopy", "onCopyCapture", "onCut", "onCutCapture", "onPaste", "onPasteCapture", "onCompositionEnd", "onCompositionEndCapture", "onCompositionStart", "onCompositionStartCapture", "onCompositionUpdate", "onCompositionUpdateCapture", "onScroll", "onScrollCapture", "onScrollEnd", "onScrollEndCapture", "onWheel", "onWheelCapture"];
+/** List of all aria attributes */
+declare const ARIA_PROPS: ["aria-activedescendant", "aria-atomic", "aria-autocomplete", "aria-braillelabel", "aria-brailleroledescription", "aria-busy", "aria-checked", "aria-colcount", "aria-colindex", "aria-colindextext", "aria-colspan", "aria-controls", "aria-current", "aria-describedby", "aria-description", "aria-details", "aria-disabled", "aria-dropeffect", "aria-errormessage", "aria-expanded", "aria-flowto", "aria-grabbed", "aria-haspopup", "aria-hidden", "aria-invalid", "aria-keyshortcuts", "aria-label", "aria-labelledby", "aria-level", "aria-live", "aria-modal", "aria-multiline", "aria-multiselectable", "aria-orientation", "aria-owns", "aria-placeholder", "aria-posinset", "aria-pressed", "aria-readonly", "aria-relevant", "aria-required", "aria-roledescription", "aria-rowcount", "aria-rowindex", "aria-rowindextext", "aria-rowspan", "aria-selected", "aria-setsize", "aria-sort", "aria-valuemax", "aria-valuemin", "aria-valuenow", "aria-valuetext"];
+type AssertNever<T extends never> = T;
+/** This will cause builds to fail if the ARIA_PROPS list does not contain all aria-attributes */
+export type AssertAllAriaAttributesAccountedFor = AssertNever<Exclude<keyof AriaAttributes, (typeof ARIA_PROPS)[number]>>;
+/** Form-related props for when the underlying control is a `button` */
+declare const BUTTON_FORM_PROPS: ["defaultChecked", "defaultValue", "disabled", "form", "name", "value"];
+/** Form-related props for when the underlying control is an `input` */
+declare const INPUT_FORM_PROPS: ["checked", "defaultChecked", "defaultValue", "disabled", "form", "name", "required", "value", "min", "max", "step", "multiple", "pattern", "list", "minLength", "maxLength", "readOnly", "placeholder", "autoComplete"];
+/** Form-related props for when the underlying control is a `textarea` */
+declare const TEXTAREA_FORM_PROPS: ["defaultChecked", "defaultValue", "disabled", "form", "name", "required", "value", "minLength", "maxLength", "readOnly", "placeholder", "autoComplete"];
+type ControlElementType = "textarea" | "button" | "input";
+type ControlProp = (typeof CONTROL_PROPS)[number];
+type DisallowedProp = (typeof DISALLOWED_PROPS)[number];
+type FormProp<C extends ControlElementType> = {
+    button: (typeof BUTTON_FORM_PROPS)[number];
+    input: (typeof INPUT_FORM_PROPS)[number];
+    textarea: (typeof TEXTAREA_FORM_PROPS)[number];
+}[C];
+type FormProps<C extends ControlElementType> = {
+    [key in FormProp<C>]?: ComponentProps<"input">[key];
+};
+type ControlProps<C extends ControlElementType> = {
+    [key in ControlProp]?: ComponentProps<C>[key];
+};
+type WrapperProps<W extends ElementType, C extends ControlElementType> = Omit<ComponentProps<W>, FormProp<C> | ControlProp | DisallowedProp | keyof AriaAttributes>;
+/**
+ * Helper generic that lets us define a form input component's prop surface
+ *
+ * `W` represents the element type of the wrapping component. Typically this
+ * will be a `div`.
+ *
+ * `C` represents the element type of the underlying control element. One of `button`, `input`, or `textarea`.
+ *
+ * `O` represents any remaining props we want to omit from the result
+ * */
+export type FormInputProps<W extends ElementType, C extends ControlElementType, O extends string = never> = Omit<WrapperProps<W, C> & ControlProps<C> & FormProps<C> & AriaAttributes, O>;
+/**
+ * Splits a given `props` object into four buckets: `ariaProps`, `controlProps`,
+ * `formProps`, and `wrapperProps`.
+ *
+ * @see splitFormProps
+ * @see splitControlProps
+ * @see splitAriaProps
+ *
+ * @example
+ * const {
+ *   ariaProps,
+ *   controlProps,
+ *   formProps,
+ *   wrapperProps
+ * } = splitFormInputProps(props)
+ */
+export declare function splitFormInputProps<A extends object>(props: A): {
+    ariaProps: OmitUnknown<Pick<Omit<OmitUnknown<Omit<OmitUnknown<Omit<A, "form" | "pattern" | "list" | "max" | "min" | "name" | "role" | "children" | "dangerouslySetInnerHTML" | "defaultChecked" | "defaultValue" | "disabled" | "value" | "autoComplete" | "checked" | "multiple" | "maxLength" | "minLength" | "step" | "placeholder" | "readOnly" | "required">>, "title" | "ref" | "id" | "role" | "tabIndex" | "children" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onInvalid" | "onInvalidCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onSelect" | "onSelectCapture" | "onScroll" | "onScrollCapture" | "onScrollEnd" | "onScrollEndCapture" | "onWheel" | "onWheelCapture" | "autoCapitalize" | "autoFocus" | "enterKeyHint" | "spellCheck" | "autoCorrect" | "inputMode">>, "role" | "children" | "dangerouslySetInnerHTML">, "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-braillelabel" | "aria-brailleroledescription" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colindextext" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-description" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowindextext" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext">>;
+    controlProps: OmitUnknown<Pick<Omit<OmitUnknown<Omit<A, "form" | "pattern" | "list" | "max" | "min" | "name" | "role" | "children" | "dangerouslySetInnerHTML" | "defaultChecked" | "defaultValue" | "disabled" | "value" | "autoComplete" | "checked" | "multiple" | "maxLength" | "minLength" | "step" | "placeholder" | "readOnly" | "required">>, "role" | "children" | "dangerouslySetInnerHTML">, "title" | "ref" | "id" | "tabIndex" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onInvalid" | "onInvalidCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onSelect" | "onSelectCapture" | "onScroll" | "onScrollCapture" | "onScrollEnd" | "onScrollEndCapture" | "onWheel" | "onWheelCapture" | "autoCapitalize" | "autoFocus" | "enterKeyHint" | "spellCheck" | "autoCorrect" | "inputMode">>;
+    formProps: OmitUnknown<Pick<Omit<A, "role" | "children" | "dangerouslySetInnerHTML">, "form" | "pattern" | "list" | "max" | "min" | "name" | "defaultChecked" | "defaultValue" | "disabled" | "value" | "autoComplete" | "checked" | "multiple" | "maxLength" | "minLength" | "step" | "placeholder" | "readOnly" | "required">>;
+    wrapperProps: OmitUnknown<Omit<OmitUnknown<Omit<OmitUnknown<Omit<A, "form" | "pattern" | "list" | "max" | "min" | "name" | "role" | "children" | "dangerouslySetInnerHTML" | "defaultChecked" | "defaultValue" | "disabled" | "value" | "autoComplete" | "checked" | "multiple" | "maxLength" | "minLength" | "step" | "placeholder" | "readOnly" | "required">>, "title" | "ref" | "id" | "role" | "tabIndex" | "children" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onInvalid" | "onInvalidCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onSelect" | "onSelectCapture" | "onScroll" | "onScrollCapture" | "onScrollEnd" | "onScrollEndCapture" | "onWheel" | "onWheelCapture" | "autoCapitalize" | "autoFocus" | "enterKeyHint" | "spellCheck" | "autoCorrect" | "inputMode">>, "role" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-braillelabel" | "aria-brailleroledescription" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colindextext" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-description" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowindextext" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "children" | "dangerouslySetInnerHTML">>;
+};
+/**
+ * Splits a given `props` object into two buckets based on whether a prop is a control prop or not
+ *
+ * @see CONTROL_PROPS
+ *
+ * @example
+ * const [controlProps, restProps] = splitControlProps(props)
+ * */
+export declare function splitControlProps<A extends object>(props: A): readonly [OmitUnknown<Pick<Omit<A, "role" | "children" | "dangerouslySetInnerHTML">, "title" | "ref" | "id" | "tabIndex" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onInvalid" | "onInvalidCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onSelect" | "onSelectCapture" | "onScroll" | "onScrollCapture" | "onScrollEnd" | "onScrollEndCapture" | "onWheel" | "onWheelCapture" | "autoCapitalize" | "autoFocus" | "enterKeyHint" | "spellCheck" | "autoCorrect" | "inputMode">>, OmitUnknown<Omit<A, "title" | "ref" | "id" | "role" | "tabIndex" | "children" | "dangerouslySetInnerHTML" | "onCopy" | "onCopyCapture" | "onCut" | "onCutCapture" | "onPaste" | "onPasteCapture" | "onCompositionEnd" | "onCompositionEndCapture" | "onCompositionStart" | "onCompositionStartCapture" | "onCompositionUpdate" | "onCompositionUpdateCapture" | "onFocus" | "onFocusCapture" | "onBlur" | "onBlurCapture" | "onChange" | "onChangeCapture" | "onBeforeInput" | "onBeforeInputCapture" | "onInput" | "onInputCapture" | "onInvalid" | "onInvalidCapture" | "onKeyDown" | "onKeyDownCapture" | "onKeyPress" | "onKeyPressCapture" | "onKeyUp" | "onKeyUpCapture" | "onSelect" | "onSelectCapture" | "onScroll" | "onScrollCapture" | "onScrollEnd" | "onScrollEndCapture" | "onWheel" | "onWheelCapture" | "autoCapitalize" | "autoFocus" | "enterKeyHint" | "spellCheck" | "autoCorrect" | "inputMode">>];
+/**
+ * Splits a given `props` object into two buckets based on whether a prop is a form prop or not
+ *
+ * @see INPUT_FORM_PROPS
+ * @see BUTTON_FORM_PROPS
+ * @see TEXTAREA_FORM_PROPS
+ *
+ * @example
+ * const [formProps, restProps] = splitFormProps(props)
+ * */
+export declare function splitFormProps<A extends object>(props: A): readonly [OmitUnknown<Pick<Omit<A, "role" | "children" | "dangerouslySetInnerHTML">, "form" | "pattern" | "list" | "max" | "min" | "name" | "defaultChecked" | "defaultValue" | "disabled" | "value" | "autoComplete" | "checked" | "multiple" | "maxLength" | "minLength" | "step" | "placeholder" | "readOnly" | "required">>, OmitUnknown<Omit<A, "form" | "pattern" | "list" | "max" | "min" | "name" | "role" | "children" | "dangerouslySetInnerHTML" | "defaultChecked" | "defaultValue" | "disabled" | "value" | "autoComplete" | "checked" | "multiple" | "maxLength" | "minLength" | "step" | "placeholder" | "readOnly" | "required">>];
+/**
+ * Splits a given `props` object into two buckets based on whether a prop is an aria-attribute or not
+ *
+ * @see ARIA_PROPS
+ *
+ * @example
+ * const [ariaProps, restProps] = splitAriaProps(props)
+ * */
+export declare function splitAriaProps<A extends object>(props: A): readonly [OmitUnknown<Pick<Omit<A, "role" | "children" | "dangerouslySetInnerHTML">, "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-braillelabel" | "aria-brailleroledescription" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colindextext" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-description" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowindextext" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext">>, OmitUnknown<Omit<A, "role" | "aria-activedescendant" | "aria-atomic" | "aria-autocomplete" | "aria-braillelabel" | "aria-brailleroledescription" | "aria-busy" | "aria-checked" | "aria-colcount" | "aria-colindex" | "aria-colindextext" | "aria-colspan" | "aria-controls" | "aria-current" | "aria-describedby" | "aria-description" | "aria-details" | "aria-disabled" | "aria-dropeffect" | "aria-errormessage" | "aria-expanded" | "aria-flowto" | "aria-grabbed" | "aria-haspopup" | "aria-hidden" | "aria-invalid" | "aria-keyshortcuts" | "aria-label" | "aria-labelledby" | "aria-level" | "aria-live" | "aria-modal" | "aria-multiline" | "aria-multiselectable" | "aria-orientation" | "aria-owns" | "aria-placeholder" | "aria-posinset" | "aria-pressed" | "aria-readonly" | "aria-relevant" | "aria-required" | "aria-roledescription" | "aria-rowcount" | "aria-rowindex" | "aria-rowindextext" | "aria-rowspan" | "aria-selected" | "aria-setsize" | "aria-sort" | "aria-valuemax" | "aria-valuemin" | "aria-valuenow" | "aria-valuetext" | "children" | "dangerouslySetInnerHTML">>];
+/**
+ * Splits a given `props` object into two buckets based on a given set of keys, ignoring disallowed props
+ *
+ * @see DISALLOWED_PROPS
+ *
+ * @example
+ * const [propsWithFoo, propsWithBat] = splitProps(
+ *   { foo: "bar", bat: "baz" },
+ *   new Set(["foo"] as const),
+ * )
+ * */
+export declare function splitProps<A extends object, K extends string>(props: A, keys: Set<K>): readonly [OmitUnknown<Pick<Omit<A, "role" | "children" | "dangerouslySetInnerHTML">, K>>, OmitUnknown<Omit<A, "role" | "children" | "dangerouslySetInnerHTML" | K>>];
+type OmitUnknown<T> = {
+    [K in keyof T as unknown extends T[K] ? T[K] extends unknown ? never : K : K]: T[K];
+};
+export {};
+//# sourceMappingURL=splitFormInputProps.d.ts.map

package/dist/utils/splitFormInputProps.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"splitFormInputProps.d.ts","sourceRoot":"","sources":["../../src/utils/splitFormInputProps.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,OAAO,CAAC;AAEzE;;;;KAIK;AACL,QAAA,MAAM,gBAAgB,iDAI8B,CAAC;AAErD;;;;;KAKK;AACL,QAAA,MAAM,aAAa,owBAwDiC,CAAC;AAErD,kCAAkC;AAClC,QAAA,MAAM,UAAU,66BAsD6B,CAAC;AAE9C,KAAK,WAAW,CAAC,CAAC,SAAS,KAAK,IAAI,CAAC,CAAC;AAEtC,iGAAiG;AACjG,MAAM,MAAM,mCAAmC,GAAG,WAAW,CAC3D,OAAO,CAAC,MAAM,cAAc,EAAE,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC,CAC3D,CAAC;AAEF,uEAAuE;AACvE,QAAA,MAAM,iBAAiB,yEAOgC,CAAC;AAExD,uEAAuE;AACvE,QAAA,MAAM,gBAAgB,0NAoBgC,CAAC;AAEvD,yEAAyE;AACzE,QAAA,MAAM,mBAAmB,0JAagC,CAAC;AAE1D,KAAK,kBAAkB,GAAG,UAAU,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE1D,KAAK,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AAElD,KAAK,cAAc,GAAG,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;AAExD,KAAK,QAAQ,CAAC,CAAC,SAAS,kBAAkB,IAAI;IAC5C,MAAM,EAAE,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;IAC3C,KAAK,EAAE,CAAC,OAAO,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC;IACzC,QAAQ,EAAE,CAAC,OAAO,mBAAmB,CAAC,CAAC,MAAM,CAAC,CAAC;CAChD,CAAC,CAAC,CAAC,CAAC;AAEL,KAAK,SAAS,CAAC,CAAC,SAAS,kBAAkB,IAAI;KAC5C,GAAG,IAAI,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC;CACpD,CAAC;AAEF,KAAK,YAAY,CAAC,CAAC,SAAS,kBAAkB,IAAI;KAC/C,GAAG,IAAI,WAAW,CAAC,CAAC,EAAE,cAAc,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;CAC9C,CAAC;AAEF,KAAK,YAAY,CAAC,CAAC,SAAS,WAAW,EAAE,CAAC,SAAS,kBAAkB,IAAI,IAAI,CAC3E,cAAc,CAAC,CAAC,CAAC,EACjB,QAAQ,CAAC,CAAC,CAAC,GAAG,WAAW,GAAG,cAAc,GAAG,MAAM,cAAc,CAClE,CAAC;AAEF;;;;;;;;;KASK;AACL,MAAM,MAAM,cAAc,CACxB,CAAC,SAAS,WAAW,EACrB,CAAC,SAAS,kBAAkB,EAC5B,CAAC,SAAS,MAAM,GAAG,KAAK,IACtB,IAAI,CACN,YAAY,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,YAAY,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,GAAG,cAAc,EACpE,CAAC,CACF,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC;;;;;EAW7D;AAWD;;;;;;;KAOK;AACL,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,owDAE3D;AAED;;;;;;;;;KASK;AACL,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,snBAExD;AAED;;;;;;;KAOK;AACL,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,gmEAExD;AAED;;;;;;;;;;KAUK;AACL,wBAAgB,UAAU,CAAC,CAAC,SAAS,MAAM,EAAE,CAAC,SAAS,MAAM,EAC3D,KAAK,EAAE,CAAC,EACR,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,wKAkBb;AAED,KAAK,WAAW,CAAC,CAAC,IAAI;KAElB,CAAC,IAAI,MAAM,CAAC,IAAI,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,GAChC,CAAC,CAAC,CAAC,CAAC,SAAS,OAAO,GAClB,KAAK,GACL,CAAC,GACH,CAAC,GACJ,CAAC,CAAC,CAAC,CAAC;CACR,CAAC"}

package/dist/utils/splitFormInputProps.js

@@ -0,0 +1,277 @@
+/**
+ * These props may not be forwarded at all. `role` should not be overridden for
+ * accessibility reasons, while `children` and `dangerouslySetInnerHTML` should
+ * not be allowed as each of our form input components render their own content
+ * */
+const DISALLOWED_PROPS = [
+    "role",
+    "children",
+    "dangerouslySetInnerHTML",
+];
+/**
+ * Props which get forwarded to the underlying control element. Typically the
+ * underlying control will be a `button`, `input`, or `textarea` element.
+ *
+ * Other event handlers are omitted so they may be forwarded to wrappers.
+ * */
+const CONTROL_PROPS = [
+    // base set of props
+    "autoCapitalize",
+    "autoCorrect",
+    "autoFocus",
+    "enterKeyHint",
+    "id",
+    "inputMode",
+    "ref",
+    "spellCheck",
+    "tabIndex",
+    "title",
+    // focus
+    "onBlur",
+    "onBlurCapture",
+    "onFocus",
+    "onFocusCapture",
+    // keyboard
+    "onKeyDown",
+    "onKeyDownCapture",
+    "onKeyPress",
+    "onKeyPressCapture",
+    "onKeyUp",
+    "onKeyUpCapture",
+    // input and value
+    "onBeforeInput",
+    "onBeforeInputCapture",
+    "onChange",
+    "onChangeCapture",
+    "onInput",
+    "onInputCapture",
+    "onInvalid",
+    "onInvalidCapture",
+    "onSelect",
+    "onSelectCapture",
+    // clipboard
+    "onCopy",
+    "onCopyCapture",
+    "onCut",
+    "onCutCapture",
+    "onPaste",
+    "onPasteCapture",
+    // composition, for input method editors
+    "onCompositionEnd",
+    "onCompositionEndCapture",
+    "onCompositionStart",
+    "onCompositionStartCapture",
+    "onCompositionUpdate",
+    "onCompositionUpdateCapture",
+    // the control is the element that overflows, never the wrapper
+    "onScroll",
+    "onScrollCapture",
+    "onScrollEnd",
+    "onScrollEndCapture",
+    "onWheel",
+    "onWheelCapture",
+];
+/** List of all aria attributes */
+const ARIA_PROPS = [
+    "aria-activedescendant",
+    "aria-atomic",
+    "aria-autocomplete",
+    "aria-braillelabel",
+    "aria-brailleroledescription",
+    "aria-busy",
+    "aria-checked",
+    "aria-colcount",
+    "aria-colindex",
+    "aria-colindextext",
+    "aria-colspan",
+    "aria-controls",
+    "aria-current",
+    "aria-describedby",
+    "aria-description",
+    "aria-details",
+    "aria-disabled",
+    "aria-dropeffect",
+    "aria-errormessage",
+    "aria-expanded",
+    "aria-flowto",
+    "aria-grabbed",
+    "aria-haspopup",
+    "aria-hidden",
+    "aria-invalid",
+    "aria-keyshortcuts",
+    "aria-label",
+    "aria-labelledby",
+    "aria-level",
+    "aria-live",
+    "aria-modal",
+    "aria-multiline",
+    "aria-multiselectable",
+    "aria-orientation",
+    "aria-owns",
+    "aria-placeholder",
+    "aria-posinset",
+    "aria-pressed",
+    "aria-readonly",
+    "aria-relevant",
+    "aria-required",
+    "aria-roledescription",
+    "aria-rowcount",
+    "aria-rowindex",
+    "aria-rowindextext",
+    "aria-rowspan",
+    "aria-selected",
+    "aria-setsize",
+    "aria-sort",
+    "aria-valuemax",
+    "aria-valuemin",
+    "aria-valuenow",
+    "aria-valuetext",
+];
+/** Form-related props for when the underlying control is a `button` */
+const BUTTON_FORM_PROPS = [
+    "defaultChecked",
+    "defaultValue",
+    "disabled",
+    "form",
+    "name",
+    "value",
+];
+/** Form-related props for when the underlying control is an `input` */
+const INPUT_FORM_PROPS = [
+    "checked",
+    "defaultChecked",
+    "defaultValue",
+    "disabled",
+    "form",
+    "name",
+    "required",
+    "value",
+    "min",
+    "max",
+    "step",
+    "multiple",
+    "pattern",
+    "list",
+    "minLength",
+    "maxLength",
+    "readOnly",
+    "placeholder",
+    "autoComplete",
+];
+/** Form-related props for when the underlying control is a `textarea` */
+const TEXTAREA_FORM_PROPS = [
+    "defaultChecked",
+    "defaultValue",
+    "disabled",
+    "form",
+    "name",
+    "required",
+    "value",
+    "minLength",
+    "maxLength",
+    "readOnly",
+    "placeholder",
+    "autoComplete",
+];
+/**
+ * Splits a given `props` object into four buckets: `ariaProps`, `controlProps`,
+ * `formProps`, and `wrapperProps`.
+ *
+ * @see splitFormProps
+ * @see splitControlProps
+ * @see splitAriaProps
+ *
+ * @example
+ * const {
+ *   ariaProps,
+ *   controlProps,
+ *   formProps,
+ *   wrapperProps
+ * } = splitFormInputProps(props)
+ */
+export function splitFormInputProps(props) {
+    const [formProps, _props] = splitFormProps(props);
+    const [controlProps, __props] = splitControlProps(_props);
+    const [ariaProps, wrapperProps] = splitAriaProps(__props);
+    return {
+        ariaProps,
+        controlProps,
+        formProps,
+        wrapperProps,
+    };
+}
+const disallowedPropsSet = new Set(DISALLOWED_PROPS);
+const ariaPropsSet = new Set(ARIA_PROPS);
+const controlPropsSet = new Set(CONTROL_PROPS);
+const formPropsSet = new Set([
+    ...INPUT_FORM_PROPS,
+    ...TEXTAREA_FORM_PROPS,
+    ...BUTTON_FORM_PROPS,
+]);
+/**
+ * Splits a given `props` object into two buckets based on whether a prop is a control prop or not
+ *
+ * @see CONTROL_PROPS
+ *
+ * @example
+ * const [controlProps, restProps] = splitControlProps(props)
+ * */
+export function splitControlProps(props) {
+    return splitProps(props, controlPropsSet);
+}
+/**
+ * Splits a given `props` object into two buckets based on whether a prop is a form prop or not
+ *
+ * @see INPUT_FORM_PROPS
+ * @see BUTTON_FORM_PROPS
+ * @see TEXTAREA_FORM_PROPS
+ *
+ * @example
+ * const [formProps, restProps] = splitFormProps(props)
+ * */
+export function splitFormProps(props) {
+    return splitProps(props, formPropsSet);
+}
+/**
+ * Splits a given `props` object into two buckets based on whether a prop is an aria-attribute or not
+ *
+ * @see ARIA_PROPS
+ *
+ * @example
+ * const [ariaProps, restProps] = splitAriaProps(props)
+ * */
+export function splitAriaProps(props) {
+    return splitProps(props, ariaPropsSet);
+}
+/**
+ * Splits a given `props` object into two buckets based on a given set of keys, ignoring disallowed props
+ *
+ * @see DISALLOWED_PROPS
+ *
+ * @example
+ * const [propsWithFoo, propsWithBat] = splitProps(
+ *   { foo: "bar", bat: "baz" },
+ *   new Set(["foo"] as const),
+ * )
+ * */
+export function splitProps(props, keys) {
+    const a = {};
+    // @ts-expect-error ts not smart enough to do this
+    const b = {};
+    for (const prop in props) {
+        // reject inherited props like prototype methods, etc
+        if (!Object.hasOwn(props, prop))
+            continue;
+        // @ts-expect-error ts is not smart enough to do this
+        if (disallowedPropsSet.has(prop))
+            continue;
+        // @ts-expect-error ts is not smart enough to do this
+        if (keys.has(prop))
+            b[prop] = props[prop];
+        // @ts-expect-error ts is not smart enough to do this
+        else
+            a[prop] = props[prop];
+    }
+    return [b, a];
+}
+//# sourceMappingURL=splitFormInputProps.js.map

package/dist/utils/splitFormInputProps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"splitFormInputProps.js","sourceRoot":"","sources":["../../src/utils/splitFormInputProps.ts"],"names":[],"mappings":"AAEA;;;;KAIK;AACL,MAAM,gBAAgB,GAAG;IACvB,MAAM;IACN,UAAU;IACV,yBAAyB;CACyB,CAAC;AAErD;;;;;KAKK;AACL,MAAM,aAAa,GAAG;IACpB,oBAAoB;IACpB,gBAAgB;IAChB,aAAa;IACb,WAAW;IACX,cAAc;IACd,IAAI;IACJ,WAAW;IACX,KAAK;IACL,YAAY;IACZ,UAAU;IACV,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,eAAe;IACf,SAAS;IACT,gBAAgB;IAChB,WAAW;IACX,WAAW;IACX,kBAAkB;IAClB,YAAY;IACZ,mBAAmB;IACnB,SAAS;IACT,gBAAgB;IAChB,kBAAkB;IAClB,eAAe;IACf,sBAAsB;IACtB,UAAU;IACV,iBAAiB;IACjB,SAAS;IACT,gBAAgB;IAChB,WAAW;IACX,kBAAkB;IAClB,UAAU;IACV,iBAAiB;IACjB,YAAY;IACZ,QAAQ;IACR,eAAe;IACf,OAAO;IACP,cAAc;IACd,SAAS;IACT,gBAAgB;IAChB,wCAAwC;IACxC,kBAAkB;IAClB,yBAAyB;IACzB,oBAAoB;IACpB,2BAA2B;IAC3B,qBAAqB;IACrB,4BAA4B;IAC5B,+DAA+D;IAC/D,UAAU;IACV,iBAAiB;IACjB,aAAa;IACb,oBAAoB;IACpB,SAAS;IACT,gBAAgB;CACkC,CAAC;AAErD,kCAAkC;AAClC,MAAM,UAAU,GAAG;IACjB,uBAAuB;IACvB,aAAa;IACb,mBAAmB;IACnB,mBAAmB;IACnB,6BAA6B;IAC7B,WAAW;IACX,cAAc;IACd,eAAe;IACf,eAAe;IACf,mBAAmB;IACnB,cAAc;IACd,eAAe;IACf,cAAc;IACd,kBAAkB;IAClB,kBAAkB;IAClB,cAAc;IACd,eAAe;IACf,iBAAiB;IACjB,mBAAmB;IACnB,eAAe;IACf,aAAa;IACb,cAAc;IACd,eAAe;IACf,aAAa;IACb,cAAc;IACd,mBAAmB;IACnB,YAAY;IACZ,iBAAiB;IACjB,YAAY;IACZ,WAAW;IACX,YAAY;IACZ,gBAAgB;IAChB,sBAAsB;IACtB,kBAAkB;IAClB,WAAW;IACX,kBAAkB;IAClB,eAAe;IACf,cAAc;IACd,eAAe;IACf,eAAe;IACf,eAAe;IACf,sBAAsB;IACtB,eAAe;IACf,eAAe;IACf,mBAAmB;IACnB,cAAc;IACd,eAAe;IACf,cAAc;IACd,WAAW;IACX,eAAe;IACf,eAAe;IACf,eAAe;IACf,gBAAgB;CAC2B,CAAC;AAS9C,uEAAuE;AACvE,MAAM,iBAAiB,GAAG;IACxB,gBAAgB;IAChB,cAAc;IACd,UAAU;IACV,MAAM;IACN,MAAM;IACN,OAAO;CAC8C,CAAC;AAExD,uEAAuE;AACvE,MAAM,gBAAgB,GAAG;IACvB,SAAS;IACT,gBAAgB;IAChB,cAAc;IACd,UAAU;IACV,MAAM;IACN,MAAM;IACN,UAAU;IACV,OAAO;IACP,KAAK;IACL,KAAK;IACL,MAAM;IACN,UAAU;IACV,SAAS;IACT,MAAM;IACN,WAAW;IACX,WAAW;IACX,UAAU;IACV,aAAa;IACb,cAAc;CACsC,CAAC;AAEvD,yEAAyE;AACzE,MAAM,mBAAmB,GAAG;IAC1B,gBAAgB;IAChB,cAAc;IACd,UAAU;IACV,MAAM;IACN,MAAM;IACN,UAAU;IACV,OAAO;IACP,WAAW;IACX,WAAW;IACX,UAAU;IACV,aAAa;IACb,cAAc;CACyC,CAAC;AA8C1D;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,mBAAmB,CAAmB,KAAQ;IAC5D,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,CAAC;IAClD,MAAM,CAAC,YAAY,EAAE,OAAO,CAAC,GAAG,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAC1D,MAAM,CAAC,SAAS,EAAE,YAAY,CAAC,GAAG,cAAc,CAAC,OAAO,CAAC,CAAC;IAE1D,OAAO;QACL,SAAS;QACT,YAAY;QACZ,SAAS;QACT,YAAY;KACb,CAAC;AACJ,CAAC;AAED,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC,gBAAgB,CAAC,CAAC;AACrD,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC;AACzC,MAAM,eAAe,GAAG,IAAI,GAAG,CAAC,aAAa,CAAC,CAAC;AAC/C,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC;IAC3B,GAAG,gBAAgB;IACnB,GAAG,mBAAmB;IACtB,GAAG,iBAAiB;CACrB,CAAC,CAAC;AAEH;;;;;;;KAOK;AACL,MAAM,UAAU,iBAAiB,CAAmB,KAAQ;IAC1D,OAAO,UAAU,CAAC,KAAK,EAAE,eAAe,CAAC,CAAC;AAC5C,CAAC;AAED;;;;;;;;;KASK;AACL,MAAM,UAAU,cAAc,CAAmB,KAAQ;IACvD,OAAO,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;AACzC,CAAC;AAED;;;;;;;KAOK;AACL,MAAM,UAAU,cAAc,CAAmB,KAAQ;IACvD,OAAO,UAAU,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC;AACzC,CAAC;AAED;;;;;;;;;;KAUK;AACL,MAAM,UAAU,UAAU,CACxB,KAAQ,EACR,IAAY;IAEZ,MAAM,CAAC,GAAG,EAA8C,CAAC;IACzD,kDAAkD;IAClD,MAAM,CAAC,GAAG,EAAmD,CAAC;IAE9D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,qDAAqD;QACrD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC;YAAE,SAAS;QAC1C,qDAAqD;QACrD,IAAI,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,SAAS;QAC3C,qDAAqD;QACrD,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,CAAC,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;QAC1C,qDAAqD;;YAChD,CAAC,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC;IAED,OAAO,CAAC,CAAC,EAAE,CAAC,CAAU,CAAC;AACzB,CAAC"}