@koine/react 2.0.0-beta.14 → 2.0.0-beta.140

package/Forms/Toggle/useToggle-tailwind.mjs

@@ -1,201 +0,0 @@
-// import React, { useCallback, useId, useMemo } from "react";
-// import type { Option } from "@koine/react";
-// import type { FormControlElementProps } from "../FormControl";
-// export type UseToggleProps = FormControlElementProps<React.FC> & {
-//   // defaultChecked?: boolean;
-//   value?: boolean;
-//   valueTrue?: string;
-//   valueFalse?: string;
-//   options?: Option[];
-// };
-// /**
-//  * This hook is meant to power Checkboxes, Switches and checkbox-like Radios
-//  * components, it works in fact in two modes:
-//  *
-//  * 1: behaviour as standard checkbox
-//  * yup validation would simply look like:
-//  *
-//  * ```ts
-//  * privacy:  boolean().required(),
-//  * ```
-//  *
-//  * 1b: to make the checkbox required (either with `true` or `false`):
-//  * ```
-//  * privacy: boolean().oneOf([true]).required()
-//  * ```
-//  *
-//  * 2: beahviour as two radio for checkbox with custom true/false values as
-//  * strings yup validation would look like:
-//  *
-//  * ```ts
-//  * newsletter: string().oneOf(["yes", "no"]).required(),
-//  * // add `.nullable()` if you do not provide a string `defaultValue`
-//  *
-//  * // to do not make it required and avoid triggering an error when the input is
-//  * // untouched you need to set the default value of the input in the form
-//  * // initialization's `defaultValues` as such:
-//  *
-//  * useForm({ defaultValues: { newsletter: "no" }})
-//  * ```
-//  *
-//  * To enable this mode either pass the props `valueTrue` and `valueFalse` or
-//  * an array of options with the shape of `Option`
-//  */
-// export function useToggle(
-//   props: UseToggleProps,
-//   ref: React.ForwardedRef<HTMLInputElement>
-// ) {
-//   const {
-//     actions,
-//     form: { watch, register },
-//     name,
-//     state,
-//     strings: { label },
-//     options,
-//     value: propValue,
-//     ...restProps
-//   } = props;
-//   let {
-//     valueTrue,
-//     valueFalse,
-//     // defaultChecked,
-//     // defaultValue,
-//     // eslint-disable-next-line prefer-const
-//     // ...remainingInputProps
-//   } = restProps;
-//   // use options data convention to pass on the true/false values
-//   if (options) {
-//     valueTrue = options
-//       .filter((opt) => opt.value === "true")[0]
-//       .label.toString();
-//     valueFalse = options
-//       .filter((opt) => opt.value === "false")[0]
-//       .label.toString();
-//   }
-//   const id = useId();
-//   const idTrue = `${id}-true`;
-//   const idFalse = `${id}-false`;
-//   const isRadio = !!(valueTrue && valueFalse);
-//   // // manage default values for both toggle modes
-//   // defaultChecked = isUndefined(defaultChecked) ? false : defaultChecked;
-//   // // TODO: maybe throw an error if the defaultValue that arrives here is not
-//   // // a valid value
-//   // defaultValue =
-//   //   defaultValue === valueTrue || defaultValue === valueFalse
-//   //     ? defaultValue
-//   //     : valueFalse;
-//   // get the value either from the uncontrolled watched input or from the given
-//   // prop to control the component
-//   let value = watch(name);
-//   if (propValue) {
-//     value = propValue;
-//   }
-//   /**
-//    * Accessibility.
-//    *
-//    * Fake the spacebar keyboard behaviour on the radio mode of the checkbox.
-//    * Without this *only* the arrow keys would change the checkbox state
-//    */
-//   const handleKeyDown: React.KeyboardEventHandler<HTMLInputElement> =
-//     useCallback(
-//       (event) => {
-//         if (event.key === " ") {
-//           event.preventDefault();
-//           event.stopPropagation();
-//           const firstInput = event.target as HTMLInputElement;
-//           const next = firstInput.nextElementSibling as HTMLInputElement;
-//           const prev = firstInput.previousElementSibling as HTMLInputElement;
-//           const secondInput = next?.tagName === "INPUT" ? next : prev;
-//           let target = firstInput;
-//           if (firstInput.checked) {
-//             target = secondInput;
-//           } else {
-//             if (!secondInput.checked) {
-//               target =
-//                 firstInput.value === valueTrue ? firstInput : secondInput;
-//             }
-//           }
-//           if (target) target.click();
-//         }
-//       },
-//       [valueTrue]
-//     );
-//   // collect all the return values that are dependent on the current value
-//   // of the input
-//   const valueDependentProps = useMemo(
-//     () => ({
-//       rootProps: {
-//         htmlFor: isRadio
-//           ? !value || value === valueFalse
-//             ? idTrue
-//             : idFalse
-//           : id,
-//       },
-//       label: label ? label : value,
-//       value,
-//     }),
-//     [value, valueFalse, isRadio, id, idTrue, idFalse, label]
-//   );
-//   const Inputs = useMemo(
-//     () =>
-//       isRadio ? (
-//         <>
-//           <input
-//             className="peer sr-only"
-//             id={idFalse}
-//             {...register(name, {
-//               onBlur: () => actions.setFocused(false),
-//             })}
-//             onFocus={() => actions.setFocused(true)}
-//             // {...remainingInputProps}
-//             onKeyDown={handleKeyDown}
-//             type="radio"
-//             value={valueFalse}
-//             // defaultChecked={defaultValue === valueFalse}
-//           />
-//           <input
-//             className="peer sr-only"
-//             id={idTrue}
-//             {...register(name, {
-//               onBlur: () => actions.setFocused(false),
-//             })}
-//             onFocus={() => actions.setFocused(true)}
-//             // {...remainingInputProps}
-//             onKeyDown={handleKeyDown}
-//             type="radio"
-//             value={valueTrue}
-//             // defaultChecked={defaultValue === valueTrue}
-//           />
-//         </>
-//       ) : (
-//         <input
-//           className="peer sr-only"
-//           id={id}
-//           type="checkbox"
-//           {...register(name, { onBlur: () => actions.setFocused(false) })}
-//           onFocus={() => actions.setFocused(true)}
-//           // {...remainingInputProps}
-//           // defaultChecked={defaultChecked}
-//         />
-//       ),
-//     [
-//       name,
-//       actions,
-//       // remainingInputProps,
-//       handleKeyDown,
-//       isRadio,
-//       idFalse,
-//       idTrue,
-//       valueFalse,
-//       valueTrue,
-//       id,
-//       // defaultChecked,
-//       // defaultValue,
-//     ]
-//   );
-//   // console.log("useToggle: render", value);
-//   return {
-//     ...valueDependentProps,
-//     Inputs,
-//   };
-// }

package/Forms/Toggle/useToggle.d.ts

@@ -1,46 +0,0 @@
-/// <reference types="react" />
-import type { Option } from "../../types";
-import { FormControl } from "../helpers";
-export type UseToggleProps = Omit<FormControl, "value"> & {
-    value?: boolean;
-    valueTrue?: string;
-    valueFalse?: string;
-    options?: Option[];
-};
-/**
- * This hook is meant to power Checkboxes, Switches and checkbox-like Radios
- * components, it works in fact in two modes:
- *
- * 1: behaviour as standard checkbox
- * yup validation would simply look like:
- *
- * ```ts
- * privacy:  boolean().required(),
- * // add `.nullable()` if you do not provide a boolean `defaultValue`
- * ```
- *
- * 2: beahviour as two radio for checkbox with custom true/false values as
- * strings yup validation would look like:
- *
- * ```ts
- * newsletter: string().oneOf(["yes", "no"]).required(),
- * // add `.nullable()` if you do not provide a string `defaultValue`
- *
- * // to do not make it required and avoid triggering an error when the input is
- * // untouched you need to set the default value of the input in the form
- * // initialization's `defaultValues` as such:
- *
- * useForm({ defaultValues: { newsletter: "no" }})
- * ```
- *
- * To enable this mode either pass the props `valueTrue` and `valueFalse` or
- * an array of options with the shape of `Option`
- */
-export declare function useToggle(props: UseToggleProps, ref: React.ForwardedRef<HTMLInputElement>): {
-    Inputs: import("react/jsx-runtime").JSX.Element;
-    rootProps: {
-        htmlFor: string | undefined;
-    };
-    label: any;
-    value: any;
-};

package/Forms/Toggle/useToggle.mjs

@@ -1,163 +0,0 @@
-import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-runtime";
-import { useCallback, useMemo } from "react";
-import { useWatch } from "react-hook-form";
-import { InputInvisible } from "../styles";
-/**
- * This hook is meant to power Checkboxes, Switches and checkbox-like Radios
- * components, it works in fact in two modes:
- *
- * 1: behaviour as standard checkbox
- * yup validation would simply look like:
- *
- * ```ts
- * privacy:  boolean().required(),
- * // add `.nullable()` if you do not provide a boolean `defaultValue`
- * ```
- *
- * 2: beahviour as two radio for checkbox with custom true/false values as
- * strings yup validation would look like:
- *
- * ```ts
- * newsletter: string().oneOf(["yes", "no"]).required(),
- * // add `.nullable()` if you do not provide a string `defaultValue`
- *
- * // to do not make it required and avoid triggering an error when the input is
- * // untouched you need to set the default value of the input in the form
- * // initialization's `defaultValues` as such:
- *
- * useForm({ defaultValues: { newsletter: "no" }})
- * ```
- *
- * To enable this mode either pass the props `valueTrue` and `valueFalse` or
- * an array of options with the shape of `Option`
- */ export function useToggle(props, ref) {
-    const { name, control, register, label, options, value: propValue, ...restProps } = props;
-    let { id, valueTrue, valueFalse, // defaultChecked,
-    // defaultValue,
-    // eslint-disable-next-line prefer-const
-    ...remainingInputProps } = restProps;
-    // use options data convention to pass on the true/false values
-    if (options) {
-        valueTrue = options.filter((opt)=>opt.value === "true")[0].label.toString();
-        valueFalse = options.filter((opt)=>opt.value === "false")[0].label.toString();
-    }
-    id = `switch-${name}`;
-    const idTrue = `${id}-true`;
-    const idFalse = `${id}-false`;
-    const isRadio = !!(valueTrue && valueFalse);
-    // // manage default values for both toggle modes
-    // defaultChecked = isUndefined(defaultChecked) ? false : defaultChecked;
-    // // TODO: maybe throw an error if the defaultValue that arrives here is not
-    // // a valid value
-    // defaultValue =
-    //   defaultValue === valueTrue || defaultValue === valueFalse
-    //     ? defaultValue
-    //     : valueFalse;
-    // get the value either from the uncontrolled watched input or from the given
-    // prop to control the component
-    let value = useWatch({
-        name,
-        control
-    });
-    if (propValue) {
-        value = propValue;
-    }
-    // get the input props needed by react-hook-form, first check if we have
-    // a `register` function, then check if we have a `control` object or just
-    // rely on the `name` prop and `ref`, they probably would be passed alongside
-    // an `onChange` prop that is spreaded on the inputs
-    const inputProps = useMemo(()=>{
-        return register ? register(name) : control ? control.register(name) : {
-            name,
-            ref
-        };
-    }, [
-        register,
-        control,
-        name,
-        ref
-    ]);
-    /**
-   * Accessibility.
-   *
-   * Fake the spacebar keyboard behaviour on the radio mode of the checkbox.
-   * Without this *only* the arrow keys would change the checkbox state
-   */ const handleKeyDown = useCallback((event)=>{
-        if (event.key === " ") {
-            event.preventDefault();
-            event.stopPropagation();
-            const firstInput = event.target;
-            const next = firstInput.nextElementSibling;
-            const prev = firstInput.previousElementSibling;
-            const secondInput = next?.tagName === "INPUT" ? next : prev;
-            let target = firstInput;
-            if (firstInput.checked) {
-                target = secondInput;
-            } else {
-                if (!secondInput.checked) {
-                    target = firstInput.value === valueTrue ? firstInput : secondInput;
-                }
-            }
-            if (target) target.click();
-        }
-    }, [
-        valueTrue
-    ]);
-    // collect all the return values that are dependent on the current value
-    // of the input
-    const valueDependentProps = useMemo(()=>({
-            rootProps: {
-                htmlFor: isRadio ? !value || value === valueFalse ? idTrue : idFalse : id
-            },
-            label: label ? label : value,
-            value
-        }), [
-        value,
-        valueFalse,
-        isRadio,
-        id,
-        idTrue,
-        idFalse,
-        label
-    ]);
-    const Inputs = useMemo(()=>isRadio ? /*#__PURE__*/ _jsxs(_Fragment, {
-            children: [
-                /*#__PURE__*/ _jsx(InputInvisible, {
-                    id: idFalse,
-                    ...inputProps,
-                    ...remainingInputProps,
-                    onKeyDown: handleKeyDown,
-                    type: "radio",
-                    value: valueFalse
-                }),
-                /*#__PURE__*/ _jsx(InputInvisible, {
-                    id: idTrue,
-                    ...inputProps,
-                    ...remainingInputProps,
-                    onKeyDown: handleKeyDown,
-                    type: "radio",
-                    value: valueTrue
-                })
-            ]
-        }) : /*#__PURE__*/ _jsx(InputInvisible, {
-            id: id,
-            type: "checkbox",
-            ...inputProps,
-            ...remainingInputProps
-        }), [
-        inputProps,
-        remainingInputProps,
-        handleKeyDown,
-        isRadio,
-        idFalse,
-        idTrue,
-        valueFalse,
-        valueTrue,
-        id
-    ]);
-    // console.log("useToggle: render", value);
-    return {
-        ...valueDependentProps,
-        Inputs
-    };
-}

package/Forms/antispam.mjs

@@ -1,58 +0,0 @@
-import { object } from "@kuus/yup";
-import decode from "@koine/utils/decode";
-import encode from "@koine/utils/encode";
-import isUndefined from "@koine/utils/isUndefined";
-/**
- * Encode form
- *
- * Takes a record of yup validations and outputs a `yup` schema with encoded
- * names (antispam technique) and a record of the encoded/decoded input `name`s.
- *
- * We skip the names prefixed wth an underscore which are considered programmatic
- * form data not created by user input.
- *
- * FIXME: types https://github.com/jquense/yup/issues/1700
- */ export function encodeForm(validationRules) {
-    const encoded = {};
-    const encodedNames = {};
-    for(const name in validationRules){
-        if (!name.startsWith("_")) {
-            const encodedName = encode(name);
-            encoded[encodedName] = validationRules[name];
-            encodedNames[name] = encodedName;
-        }
-    }
-    // we need `.required()` to correctly infer the type @see
-    // https://github.com/jquense/yup/issues/946
-    const encodedSchema = object(encoded).required();
-    return {
-        encodedSchema,
-        encodedNames
-    };
-}
-/**
- * Decode form data
- *
- * This function is meant to be used inside an api endpoint to gather an encoded
- * form submit data and transform it to the decoded desired json data.
- *
- * Here too we skip encoding/decoding process for names prefixed wth an underscore
- * which are considered programmatic form data not created by user input.
- */ export function decodeForm(formData) {
-    const json = {};
-    for(const encodedName in formData){
-        const decodedName = decode(encodedName);
-        // always add underscore prefixed names as they are treated as internal
-        // private inputs outside of the honeypot system, normalise them here removing
-        // the underscore prefix
-        if (encodedName.startsWith("_")) {
-            // @ts-expect-error nevermind
-            json[encodedName.substring(1)] = formData[encodedName];
-        } else if (!isUndefined(formData[encodedName]) && formData[decodedName] === "") {
-            // @ts-expect-error nevermind
-            json[decodedName] = formData[encodedName];
-        }
-    }
-    // console.log(formData, decoded, json);
-    return json;
-}

package/Forms/helpers.d.ts

@@ -1,26 +0,0 @@
-/// <reference types="react" />
-import type { Control, UseFormRegister, UseFormSetValue } from "react-hook-form";
-import type { Option } from "../types";
-type FormControlNativeType = "input" | "select" | "textarea";
-type FormControlFieldValues = Record<string, any>;
-export type FormControlNative<T extends FormControlNativeType = "input"> = Omit<React.ComponentPropsWithRef<T>, "name">;
-export type FormControlProps<T extends FormControlFieldValues = any> = {
-    label?: React.ReactNode;
-    name: string;
-    control?: Control<T>;
-    register?: UseFormRegister<T>;
-    setValue?: UseFormSetValue<T>;
-};
-export type FormControl<TControlType extends FormControlNativeType = "input", TFieldValues extends FormControlFieldValues = any> = FormControlNative<TControlType> & FormControlProps<TFieldValues>;
-export declare const normaliseOptions: (options?: (string | Option)[]) => Option[];
-export declare function defaultOptionsFilterFn(options: Option[], inputValue?: string): Option[];
-/**
- * We are faking the native input `onChange` event
- */
-export declare function triggerOnChange<T extends HTMLElement = HTMLInputElement>(onChange?: React.ChangeEventHandler<T>, name?: string, value?: any): void;
-/**
- * @see https://hustle.bizongo.in/simulate-react-on-change-on-controlled-components-baa336920e04
- * @deprecated
- */
-export declare function triggerChange(input: HTMLInputElement, value?: string): void;
-export {};

package/Forms/helpers.mjs

@@ -1,52 +0,0 @@
-import isString from "@koine/utils/isString";
-import matchSorter from "@koine/utils/matchSorter";
-export const normaliseOptions = (options = [])=>{
-    return options.map((option)=>{
-        return isString(option) ? {
-            label: option,
-            value: option
-        } : option;
-    });
-};
-export function defaultOptionsFilterFn(options, inputValue) {
-    if (!inputValue) {
-        return options;
-    }
-    return matchSorter(options, inputValue, {
-        keys: [
-            "value",
-            "label"
-        ]
-    });
-}
-/**
- * We are faking the native input `onChange` event
- */ export function triggerOnChange(onChange, name, value) {
-    // @ts-expect-error nevermind
-    if (onChange) onChange({
-        target: {
-            name,
-            value
-        }
-    });
-}
-/**
- * @see https://hustle.bizongo.in/simulate-react-on-change-on-controlled-components-baa336920e04
- * @deprecated
- */ export function triggerChange(input, value) {
-    const obj = window.Object;
-    if (!obj) {
-        if (process.env["NODE_ENV"] !== "production") {
-            console.warn("[@koine/react:Forms:triggerChange] window.Object does not exists, bailing.");
-        }
-        return;
-    }
-    // @ts-expect-error nevermind
-    const nativeInputValueSetter = obj.getOwnPropertyDescriptor(window.HTMLInputElement.prototype, "value").set;
-    // @ts-expect-error nevermind
-    nativeInputValueSetter.call(input, value);
-    const inputEvent = new Event("input", {
-        bubbles: true
-    });
-    input.dispatchEvent(inputEvent);
-}

package/Forms/index.d.ts

@@ -1,15 +0,0 @@
-export * from "./antispam";
-export * from "./Checkbox";
-export * from "./Input";
-export * from "./InputGroup";
-export * from "./Feedback";
-export * from "./Field";
-export * from "./InputGroup";
-export * from "./Label";
-export * from "./Password";
-export * from "./Radio";
-export * from "./Switch";
-export * from "./Textarea";
-export * from "./Toggle";
-export * from "./helpers";
-export * from "./styles";

package/Forms/index.mjs

@@ -1,16 +0,0 @@
-export * from "./antispam";
-export * from "./Checkbox";
-export * from "./Input";
-export * from "./InputGroup";
-export * from "./Feedback";
-export * from "./Field";
-export * from "./InputGroup";
-export * from "./Label";
-export * from "./Password";
-export * from "./Radio";
-// export * from "./Select";
-export * from "./Switch";
-export * from "./Textarea";
-export * from "./Toggle";
-export * from "./helpers";
-export * from "./styles";

package/Forms/styles.d.ts

@@ -1,15 +0,0 @@
-export declare const InputInvisible: any;
-export declare const InputHoneypot: any;
-export declare const InputProgress: any;
-/**
- * Remove the default light blue background on autofilled inputs. To be used as
- * a function that outputs a CSS string.
- *
- * @see https://stackoverflow.com/a/62624824/1938970
- */
-export declare const inputResetAutofill = "\n  &:-webkit-autofill,\n  &:-webkit-autofill:hover,\n  &:-webkit-autofill:focus,\n  &:-webkit-autofill:active {\n    -webkit-background-clip: text;\n  }\n";
-export declare const inputBorder = "\n  border: 1px solid var(--forms-border-color);\n";
-export declare const inputPadding = "\n  padding: var(--forms-gutter-y) var(--forms-gutter-x);\n";
-export declare const inputReset: string;
-export declare const inputBase: string;
-export declare const inputFocus: string;

package/Forms/styles.mjs

@@ -1,61 +0,0 @@
-import { jsx as _jsx } from "react/jsx-runtime";
-import styled from "styled-components";
-import { ProgressLinear } from "../Progress/ProgressLinear";
-import { invisible, stateFocus } from "../styles/styled";
-export const InputInvisible = styled.input`
-  ${invisible}
-`;
-export const InputHoneypot = styled(InputInvisible).attrs({
-    type: "text",
-    autoComplete: "new-password",
-    tabIndex: -1
-})``;
-export const InputProgress = styled((p)=>/*#__PURE__*/ _jsx(ProgressLinear, {
-        fg: "var(--accent300)",
-        bg: "var(--accent400)",
-        ...p
-    }))`
-  position: absolute;
-  bottom: 0;
-  left: 0;
-  width: 100%;
-`;
-/**
- * Remove the default light blue background on autofilled inputs. To be used as
- * a function that outputs a CSS string.
- *
- * @see https://stackoverflow.com/a/62624824/1938970
- */ export const inputResetAutofill = `
-  &:-webkit-autofill,
-  &:-webkit-autofill:hover,
-  &:-webkit-autofill:focus,
-  &:-webkit-autofill:active {
-    -webkit-background-clip: text;
-  }
-`;
-/* FIXME: find a nice way to override this styling from implementation */ // border-bottom: 1px solid var(--forms-border-color);
-// border: 0;
-export const inputBorder = `
-  border: 1px solid var(--forms-border-color);
-`;
-export const inputPadding = `
-  padding: var(--forms-gutter-y) var(--forms-gutter-x);
-`;
-export const inputReset = `
-  width: 100%;
-  min-height: 44px;
-  ${inputBorder}
-  ${inputPadding}
-`;
-export const inputBase = `
-  ${inputReset}
-  ${inputResetAutofill}
-  background: transparent;
-`;
-export const inputFocus = `
-  &:focus {
-    outline: 0px;
-    appearance: none;
-    ${stateFocus}
-  }
-`;

package/Gauge/Gauge.d.ts

@@ -1,5 +0,0 @@
-export type GaugeProps = {
-    /** In percentage */
-    value: number;
-};
-export declare const Gauge: (_props: GaugeProps) => null;