@paragrav/rhf-utils 0.0.135 → 0.0.137

package/dist/esm/form/utils/getSubmitterButtonData.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"getSubmitterButtonData.mjs","sources":["../../../../src/form/utils/getSubmitterButtonData.ts"],"sourcesContent":["import React from 'react';\n\n/**\n * Get [name, value] tuple of button/input that submitted form.\n * Useful when determining user intent\n */\nconst getSubmitterButtonData = (\n  event: React.BaseSyntheticEvent,\n): [name: string, value: string] | undefined => {\n  if (!(event.nativeEvent instanceof SubmitEvent)) return; // not submit\n  if (\n    !(event.nativeEvent.submitter instanceof HTMLButtonElement) && // not button\n    !(event.nativeEvent.submitter instanceof HTMLInputElement) // not input\n  )\n    return;\n\n  if (!event.nativeEvent.submitter.name) return; // no name on button\n\n  return [\n    event.nativeEvent.submitter.name,\n    event.nativeEvent.submitter.value,\n  ] as const;\n};\n\nexport default getSubmitterButtonData;\n"],"names":["getSubmitterButtonData","event","getSubmitterButtonData$1"],"mappings":";AAMA,MAAMA,IAAyB,CAC7BC,MAC8C;AAC1C,MAAEA,EAAM,uBAAuB,eAEjC,IAAEA,EAAM,YAAY,qBAAqB;AAAA,EACzC,EAAEA,EAAM,YAAY,qBAAqB,sBAItCA,EAAM,YAAY,UAAU;AAE1B,WAAA;AAAA,MACLA,EAAM,YAAY,UAAU;AAAA,MAC5BA,EAAM,YAAY,UAAU;AAAA,IAAA;AAEhC,GAEAC,IAAeF;"}

package/dist/esm/form/utils/useFormRequestSubmit.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"useFormRequestSubmit.mjs","sources":["../../../../src/form/utils/useFormRequestSubmit.ts"],"sourcesContent":["/**\n * Get callback to trigger submit manually on form.\n * @link https://developer.mozilla.org/docs/Web/API/HTMLFormElement/requestSubmit\n */\nconst useFormRequestSubmit =\n  (\n    ref: React.RefObject<HTMLFormElement>, // limit scope to avoid mistakes (allows for `{[string]: any}`)\n  ): HTMLFormElement['requestSubmit'] =>\n  (submitter) => {\n    // typeguard (should never happen at runtime when callback is called)\n    if (!ref.current) throw new Error();\n\n    requestSubmitByForm(ref.current, submitter);\n  };\n\nexport default useFormRequestSubmit;\n\n//\n\nconst requestSubmitByForm = (\n  form: Pick<HTMLFormElement, 'requestSubmit'>, // narrow to avoid `{[string]: any}` type\n  submitter?: HTMLElement | null,\n) => {\n  form.requestSubmit(submitter);\n};\n"],"names":["useFormRequestSubmit","ref","submitter","requestSubmitByForm","form"],"mappings":"AAIA,MAAMA,IACJ,CACEC,MAEF,CAACC,MAAc;AAEb,MAAI,CAACD,EAAI,QAAS,OAAM,IAAI,MAAM;AAEd,EAAAE,EAAAF,EAAI,SAASC,CAAS;AAC5C,GAMIC,IAAsB,CAC1BC,GACAF,MACG;AACH,EAAAE,EAAK,cAAcF,CAAS;AAC9B;"}

package/dist/esm/submit/error/FormSubmitError.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"FormSubmitError.mjs","sources":["../../../../src/submit/error/FormSubmitError.ts"],"sourcesContent":["import type { SafeFieldValues } from '@/form/SafeFieldValues';\n\nimport type { FormSubmitErrors } from './FormSubmitErrors';\n\nexport class FormSubmitError<\n  TFieldValues extends SafeFieldValues = SafeFieldValues,\n> extends Error {\n  constructor(\n    public errors: FormSubmitErrors<TFieldValues>,\n    message?: string, // error message\n    // options?: ErrorOptions, // requires es2022\n  ) {\n    super(message);\n  }\n}\n"],"names":["FormSubmitError","errors","message"],"mappings":"AAIO,MAAMA,UAEH,MAAM;AAAA,EACd,YACSC,GACPC,GAEA;AACA,UAAMA,CAAO,GAJN,KAAA,SAAAD;AAAA,EAKT;AACF;"}

package/dist/esm/submit/error/setCtxErrorsByFormSubmitErrors.mjs

@@ -1,13 +0,0 @@
-const s = (r, t) => {
-  Object.entries(t).forEach(([o, e]) => {
-    r.setError(o, {
-      type: "FormSubmitError",
-      // default
-      ...e
-    });
-  });
-};
-export {
-  s as default
-};
-//# sourceMappingURL=setCtxErrorsByFormSubmitErrors.mjs.map

package/dist/esm/submit/error/setCtxErrorsByFormSubmitErrors.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"setCtxErrorsByFormSubmitErrors.mjs","sources":["../../../../src/submit/error/setCtxErrorsByFormSubmitErrors.ts"],"sourcesContent":["import type { FieldPath, UseFormReturn } from 'react-hook-form';\n\nimport type { SafeFieldValues } from '@/form/SafeFieldValues';\n\nimport type { FormSubmitErrors } from './FormSubmitErrors';\n\n/**\n * Handle thrown {@link FormSubmitError}.\n * Add key/values as name/message to RHF context errors.\n */\nconst setCtxErrorsByFormSubmitErrors = <\n  TFieldValues extends SafeFieldValues,\n  TTransformedValues extends SafeFieldValues,\n>(\n  ctx: UseFormReturn<TFieldValues, unknown, TTransformedValues>,\n  errors: FormSubmitErrors,\n) => {\n  // loop through error object and set errors in rhf context\n  Object.entries(errors).forEach(([name, fieldError]) => {\n    ctx.setError(name as FieldPath<TFieldValues>, {\n      type: 'FormSubmitError', // default\n      ...fieldError,\n    });\n  });\n};\n\nexport default setCtxErrorsByFormSubmitErrors;\n"],"names":["setCtxErrorsByFormSubmitErrors","ctx","errors","name","fieldError"],"mappings":"AAUM,MAAAA,IAAiC,CAIrCC,GACAC,MACG;AAEI,SAAA,QAAQA,CAAM,EAAE,QAAQ,CAAC,CAACC,GAAMC,CAAU,MAAM;AACrD,IAAAH,EAAI,SAASE,GAAiC;AAAA,MAC5C,MAAM;AAAA;AAAA,MACN,GAAGC;AAAA,IAAA,CACJ;AAAA,EAAA,CACF;AACH;"}

package/dist/esm/submit/useFormOnSubmitted.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"useFormOnSubmitted.mjs","sources":["../../../src/submit/useFormOnSubmitted.ts"],"sourcesContent":["import type { MaybePromise } from '@trpc/server/unstable-core-do-not-import';\nimport React from 'react';\nimport { useFormState } from 'react-hook-form';\n\nimport useRefIfValueWasTrue from '@/utils/useRefIfValueWasTrue';\n\nconst useFormOnSubmitted = (\n  callback?: (success: boolean) => MaybePromise<unknown>,\n  options?: { successful?: boolean },\n) => {\n  const { isSubmitSuccessful, isSubmitting } = useFormState();\n\n  const [wasSubmitting, resetWasSubmitting] =\n    useRefIfValueWasTrue(isSubmitting);\n\n  // on successful submit, call callback\n  React.useEffect(() => {\n    if (!callback) return;\n\n    // if currently submitting, ignore\n    if (isSubmitting) return;\n\n    // wait for submit to finish\n    if (!wasSubmitting) return;\n\n    // always reset to wait for next submit\n    resetWasSubmitting();\n\n    // check success against options passed\n    if (\n      options?.successful === undefined || // if option not specified, call on any submit\n      isSubmitSuccessful === options.successful // otherwise, call only if matches\n    ) {\n      callback(isSubmitSuccessful);\n    }\n\n    // eslint-disable-next-line react-hooks/exhaustive-deps -- only track isSubmitting -- so success is checked each time\n  }, [isSubmitting]);\n};\n\nexport default useFormOnSubmitted;\n"],"names":["useFormOnSubmitted","callback","options","isSubmitSuccessful","isSubmitting","useFormState","wasSubmitting","resetWasSubmitting","useRefIfValueWasTrue","React"],"mappings":";;;AAMM,MAAAA,IAAqB,CACzBC,GACAC,MACG;AACH,QAAM,EAAE,oBAAAC,GAAoB,cAAAC,EAAa,IAAIC,EAAa,GAEpD,CAACC,GAAeC,CAAkB,IACtCC,EAAqBJ,CAAY;AAGnC,EAAAK,EAAM,UAAU,MAAM;AACpB,IAAKR,MAGDG,KAGCE,MAGcC,KAOjBN,EAASE,CAAkB;AAAA,EAC7B,GAGC,CAACC,CAAY,CAAC;AACnB;"}

package/dist/esm/submit/useResetFormOnSubmitted.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"useResetFormOnSubmitted.mjs","sources":["../../../src/submit/useResetFormOnSubmitted.ts"],"sourcesContent":["import { useFormContext } from 'react-hook-form';\n\nimport useFormOnSubmitted from './useFormOnSubmitted';\n\n/**\n * Configuration options for {@link useResetFormOnSubmitted}.\n */\nexport type UseResetFormOnSubmittedOptions =\n  // disabled\n  | undefined\n\n  // enabled\n  | {\n      /**\n       * Reset values on successful submit.\n       * - `defaults`: reset current values to defaults\n       * - `current`: reset defaults to current values\n       */\n      success?: { values: 'defaults' | 'current' };\n\n      /**\n       * Reset values to defaults on submit error.\n       */\n      error?: { values: 'defaults' };\n    };\n\n/**\n * Control resetting of values and (some) state (e.g., `isDirty`) after form submitted.\n *\n * `isDirty` and other state is reset, but submit-related state is preserved, as well as errors.\n *\n * Use cases:\n * - on success:\n *   - `defaults`: reset current values to defaults (e.g., clear form)\n *   - `current`: reset defaults to current values (e.g., keep values)\n * - on error:\n *   - reset current values to default values (e.g., submitOnChange reset)\n *\n * See `Rules` section: https://react-hook-form.com/api/useform/reset/\n * Specifically: \"- It's recommended to reset inside useEffect after submission.\"\n */\nconst useResetFormOnSubmitted = (options: UseResetFormOnSubmittedOptions) => {\n  const { getValues, reset } = useFormContext();\n\n  useFormOnSubmitted((success) => {\n    if (!options) return;\n\n    const whichValues = options[success ? 'success' : 'error']?.values;\n\n    if (!whichValues) return;\n\n    const keepValues = whichValues === 'current';\n\n    const values = keepValues\n      ? getValues() // current values\n      : undefined; // default values\n\n    reset(values, {\n      // keep submit stuff for tracking relevant state (e.g., `useFormOnSubmitSuccessful`)\n      keepIsSubmitSuccessful: true,\n      keepIsSubmitted: true,\n      keepSubmitCount: true,\n\n      /**\n       * This is necessary when setting default values to current values (lest form stop updating).\n       *\n       * Technically, we are keeping values and resetting default values to same values.\n       *\n       * Steps to repro:\n       * - RhfUtilsClientConfig with resetOnSubmitted set to success values to current\n       * - remove `keepValues` prop from reset\n       * - create valid form, submit\n       * - form values should be unchanged\n       * - unexpectedly: can no longer type into input\n       */\n      keepValues,\n\n      // keep errors in the case of unsuccessful submit\n      keepErrors: true,\n    });\n  });\n};\n\nexport default useResetFormOnSubmitted;\n"],"names":["useResetFormOnSubmitted","options","getValues","reset","useFormContext","useFormOnSubmitted","success","whichValues","_a","keepValues","values"],"mappings":";;AAyCM,MAAAA,IAA0B,CAACC,MAA4C;AAC3E,QAAM,EAAE,WAAAC,GAAW,OAAAC,EAAM,IAAIC,EAAe;AAE5C,EAAAC,EAAmB,CAACC,MAAY;;AAC9B,QAAI,CAACL,EAAS;AAEd,UAAMM,KAAcC,IAAAP,EAAQK,IAAU,YAAY,OAAO,MAArC,gBAAAE,EAAwC;AAE5D,QAAI,CAACD,EAAa;AAElB,UAAME,IAAaF,MAAgB,WAE7BG,IAASD,IACXP,EACA,IAAA;AAEJ,IAAAC,EAAMO,GAAQ;AAAA;AAAA,MAEZ,wBAAwB;AAAA,MACxB,iBAAiB;AAAA,MACjB,iBAAiB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,MAcjB,YAAAD;AAAA;AAAA,MAGA,YAAY;AAAA,IAAA,CACb;AAAA,EAAA,CACF;AACH;"}

package/dist/esm/submit/useSubmitFormOnChange.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"useSubmitFormOnChange.mjs","sources":["../../../src/submit/useSubmitFormOnChange.ts"],"sourcesContent":["import React from 'react';\n\nimport useFormRequestSubmit from '@/form/utils/useFormRequestSubmit';\n\nconst useSubmitFormOnChange = (\n  formRef: React.RefObject<HTMLFormElement>,\n  options?: {\n    /** Disable-able so that default behavior is enabled for sake of simplicity of usage. */\n    disabled?: boolean;\n  },\n) => {\n  const enabled = !options?.disabled;\n\n  const requestSubmit = useFormRequestSubmit(formRef);\n\n  // on mount, listen for event\n  React.useEffect(() => {\n    if (!enabled) return;\n\n    const form = formRef.current;\n\n    if (!form) throw new Error();\n\n    const onChange = () => {\n      requestSubmit();\n    };\n\n    form.addEventListener('change', onChange);\n\n    return () => {\n      form.removeEventListener('change', onChange);\n    };\n  }, []); // eslint-disable-line react-hooks/exhaustive-deps -- on mount\n};\n\nexport default useSubmitFormOnChange;\n"],"names":["useSubmitFormOnChange","formRef","options","enabled","requestSubmit","useFormRequestSubmit","React","form","onChange"],"mappings":";;AAIM,MAAAA,IAAwB,CAC5BC,GACAC,MAIG;AACG,QAAAC,IAAU,EAACD,KAAA,QAAAA,EAAS,WAEpBE,IAAgBC,EAAqBJ,CAAO;AAGlD,EAAAK,EAAM,UAAU,MAAM;AACpB,QAAI,CAACH,EAAS;AAEd,UAAMI,IAAON,EAAQ;AAErB,QAAI,CAACM,EAAY,OAAA,IAAI;AAErB,UAAMC,IAAW,MAAM;AACP,MAAAJ;IAAA;AAGX,WAAAG,EAAA,iBAAiB,UAAUC,CAAQ,GAEjC,MAAM;AACN,MAAAD,EAAA,oBAAoB,UAAUC,CAAQ;AAAA,IAAA;AAAA,EAE/C,GAAG,CAAE,CAAA;AACP;"}

package/dist/esm/utils/PassthroughChildren.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"PassthroughChildren.mjs","sources":["../../../src/utils/PassthroughChildren.tsx"],"sourcesContent":["/**\n * Component for simply passing through children.\n *\n * (Useful for conditional wrapping of children.)\n */\nconst PassthroughChildren: React.FC<React.PropsWithChildren> = ({\n  children,\n}) => <>{children}</>;\n\nexport default PassthroughChildren;\n"],"names":["PassthroughChildren","children"],"mappings":";AAKA,MAAMA,IAAyD,CAAC;AAAA,EAC9D,UAAAC;AACF,6BAAS,UAAAA,EAAS,CAAA;"}

package/dist/esm/utils/createContext.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"createContext.mjs","sources":["../../../src/utils/createContext.ts"],"sourcesContent":["import React from 'react';\n\n/**\n * Create a strictly-typed context that throws error if no provider is found.\n * @returns A tuple with a function to get the context and the context provider.\n */\nfunction createContext<T = unknown>() {\n  const context = React.createContext<T | undefined>(undefined);\n\n  const useMaybe = () => React.useContext(context);\n\n  const useRequired = () => {\n    const c = useMaybe();\n\n    // type guard\n    if (c === undefined) throw new Error();\n\n    return c;\n  };\n\n  return {\n    Provider: context.Provider,\n    useMaybe,\n    useRequired,\n  } as const;\n}\n\nexport default createContext;\n"],"names":["createContext","context","React","useMaybe","useRequired","c"],"mappings":";AAMA,SAASA,IAA6B;AAC9B,QAAAC,IAAUC,EAAM,cAA6B,MAAS,GAEtDC,IAAW,MAAMD,EAAM,WAAWD,CAAO,GAEzCG,IAAc,MAAM;AACxB,UAAMC,IAAIF;AAGV,QAAIE,MAAM,OAAiB,OAAA,IAAI,MAAM;AAE9B,WAAAA;AAAA,EAAA;AAGF,SAAA;AAAA,IACL,UAAUJ,EAAQ;AAAA,IAClB,UAAAE;AAAA,IACA,aAAAC;AAAA,EAAA;AAEJ;"}

package/dist/esm/utils/isEmptyObject.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"isEmptyObject.mjs","sources":["../../../src/utils/isEmptyObject.ts"],"sourcesContent":["const isEmptyObject = (obj: Record<string, unknown>) =>\n  Object.keys(obj).length === 0;\n\nexport default isEmptyObject;\n"],"names":["isEmptyObject","obj"],"mappings":"AAAA,MAAMA,IAAgB,CAACC,MACrB,OAAO,KAAKA,CAAG,EAAE,WAAW;"}

package/dist/esm/utils/useRefIfValueWasTrue.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"useRefIfValueWasTrue.mjs","sources":["../../../src/utils/useRefIfValueWasTrue.ts"],"sourcesContent":["import React from 'react';\n\nconst useRefIfValueWasTrue = (value: boolean) => {\n  const hasBooleanChanged = React.useRef(false);\n\n  // when value is true, set ref to true\n  React.useEffect(() => {\n    if (!value) return;\n\n    hasBooleanChanged.current = true;\n  }, [value]);\n\n  const reset = () => {\n    hasBooleanChanged.current = false;\n  };\n\n  return [hasBooleanChanged.current, reset] as const;\n};\n\nexport default useRefIfValueWasTrue;\n"],"names":["useRefIfValueWasTrue","value","hasBooleanChanged","React","reset"],"mappings":";AAEM,MAAAA,IAAuB,CAACC,MAAmB;AACzC,QAAAC,IAAoBC,EAAM,OAAO,EAAK;AAG5C,EAAAA,EAAM,UAAU,MAAM;AACpB,IAAKF,MAELC,EAAkB,UAAU;AAAA,EAAA,GAC3B,CAACD,CAAK,CAAC;AAEV,QAAMG,IAAQ,MAAM;AAClB,IAAAF,EAAkB,UAAU;AAAA,EAAA;AAGvB,SAAA,CAACA,EAAkB,SAASE,CAAK;AAC1C;"}

package/dist/types/errors/trpc/trpcClientErrorToFormSubmitErrorsSchemaTransformer.d.ts

@@ -1,28 +0,0 @@
-import { TRPCClientErrorLike } from '@trpc/client';
-import { AnyRouter } from '@trpc/server';
-import { z } from 'zod';
-import { FormSubmitErrors } from '../../submit/error/FormSubmitErrors';
-
-/**
- * Schema that transforms {@link TRPCClientError} to RHF {@link FormSubmitErrors}.
- */
-declare const trpcClientErrorToFormSubmitErrorsSchemaTransformer: z.ZodEffects<z.ZodEffects<z.ZodPipeline<z.ZodEffects<z.ZodEffects<z.ZodType<TRPCClientErrorLike<AnyRouter>, z.ZodTypeDef, TRPCClientErrorLike<AnyRouter>>, string, TRPCClientErrorLike<AnyRouter>>, unknown, TRPCClientErrorLike<AnyRouter>>, z.ZodArray<z.ZodObject<{
-    validation: z.ZodString;
-    code: z.ZodString;
-    message: z.ZodString;
-    path: z.ZodArray<z.ZodString, "many">;
-}, "strip", z.ZodTypeAny, {
-    message: string;
-    code: string;
-    path: string[];
-    validation: string;
-}, {
-    message: string;
-    code: string;
-    path: string[];
-    validation: string;
-}>, "many">>, (readonly [string, {
-    type: string;
-    message: string;
-}])[], TRPCClientErrorLike<AnyRouter>>, FormSubmitErrors, TRPCClientErrorLike<AnyRouter>>;
-export default trpcClientErrorToFormSubmitErrorsSchemaTransformer;

package/dist/types/submit/error/setCtxErrorsByFormSubmitErrors.d.ts

@@ -1,10 +0,0 @@
-import { UseFormReturn } from 'react-hook-form';
-import { SafeFieldValues } from '../../form/SafeFieldValues';
-import { FormSubmitErrors } from './FormSubmitErrors';
-
-/**
- * Handle thrown {@link FormSubmitError}.
- * Add key/values as name/message to RHF context errors.
- */
-declare const setCtxErrorsByFormSubmitErrors: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>(ctx: UseFormReturn<TFieldValues, unknown, TTransformedValues>, errors: FormSubmitErrors) => void;
-export default setCtxErrorsByFormSubmitErrors;