chore: types

Author: felipeva

package.json

@@ -1,7 +1,8 @@
 {
   "name": "@lifespikes/laravel-precognition-react",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Laravel Precognition React Hooks",
+  "source": "./src/index.ts",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
   "types": "./dist/esm/index.d.ts",

src/hooks/useInertiaPrecognitionForm.ts

@@ -1,16 +1,16 @@
 import { useForm } from '@inertiajs/inertia-react';
 import { useMemo } from 'react';
 import {
-  UseInertiaPrecognitionForm,
-  UsePrecognitionFormOptions,
+  UseInertiaPrecognitionFormReturn,
+  UsePrecognitionFormProps,
 } from '../types';
 import { usePrecognition } from './usePrecognition';
 import { patchInertiaForm } from '../helpers/patchInertiaForm';
 
-export const useInertiaPrecognitionForm = <TForm = Record<string, any>>({
+export function useInertiaPrecognitionForm<TForm = Record<string, any>>({
   precognition: { method, url, config },
   form: { initialValues },
-}: UsePrecognitionFormOptions<TForm>): UseInertiaPrecognitionForm<TForm> => {
+}: UsePrecognitionFormProps<TForm>): UseInertiaPrecognitionFormReturn<TForm> {
   const inertia = useForm<TForm>(initialValues);
   const { touched, validator, setLastTouched, ...rest } =
     usePrecognition<TForm>(method, url, inertia.data, config);
@@ -37,4 +37,4 @@ export const useInertiaPrecognitionForm = <TForm = Record<string, any>>({
     passed,
     setLastTouched,
   });
-};
+}

src/hooks/usePrecognition.ts

@@ -9,14 +9,14 @@ import {
   RequestMethods,
   Timeout,
 } from 'laravel-precognition/dist/types';
-import { UsePrecognition } from '../types';
+import { UsePrecognitionReturn } from '../types';
 
-export const usePrecognition = <TForm = Record<string, any>>(
+export function usePrecognition<TForm = Record<string, any>>(
   method: RequestMethods,
   url: string,
   data: TForm,
   config?: Config
-): UsePrecognition<TForm> => {
+): UsePrecognitionReturn<TForm> {
   const [isValidating, setIsValidating] = useState<string | null>(null);
   const [isProcessingValidation, setIsProcessingValidation] = useState(false);
   const [touched, setTouched] = useState<Array<keyof TForm>>([]);
@@ -76,4 +76,4 @@ export const usePrecognition = <TForm = Record<string, any>>(
       return this;
     },
   };
-};
+}

src/hooks/usePrecognitionForm.ts

@@ -1,12 +1,12 @@
 import { useMemo, useState } from 'react';
 import { toSimpleValidationErrors } from 'laravel-precognition';
-import { UsePrecognitionForm, UsePrecognitionFormOptions } from '../types';
+import { UsePrecognitionFormReturn, UsePrecognitionFormProps } from '../types';
 import { usePrecognition } from './usePrecognition';
 
-export const usePrecognitionForm = <TForm = Record<string, any>>({
+export function usePrecognitionForm<TForm = Record<string, any>>({
   precognition: { method, url, config },
   form: { initialValues },
-}: UsePrecognitionFormOptions<TForm>): UsePrecognitionForm<TForm> => {
+}: UsePrecognitionFormProps<TForm>): UsePrecognitionFormReturn<TForm> {
   const [data, setData] = useState<TForm>(initialValues);
   const [errors, setErrors] = useState<Record<keyof TForm, string> | null>(
     null
@@ -59,4 +59,4 @@ export const usePrecognitionForm = <TForm = Record<string, any>>({
     },
     passed,
   };
-};
+}

src/index.ts

@@ -1,5 +1,4 @@
-import { usePrecognition } from './hooks/usePrecognition';
-import { useInertiaPrecognitionForm } from './hooks/useInertiaPrecognitionForm';
-import { usePrecognitionForm } from './hooks/usePrecognitionForm';
-
-export { usePrecognition, useInertiaPrecognitionForm, usePrecognitionForm };
+export * from './hooks/useInertiaPrecognitionForm';
+export * from './hooks/usePrecognition';
+export * from './hooks/usePrecognitionForm';
+export * from './types';

src/types/hooks.ts

@@ -0,0 +1,60 @@
+import {
+  Config,
+  RequestMethods,
+  Timeout,
+  Validator,
+} from 'laravel-precognition/dist/types';
+import React from 'react';
+import { InertiaFormProps } from '@inertiajs/inertia-react';
+
+export type UsePrecognitionFormProps<TForm = Record<string, any>> = {
+  precognition: {
+    method: RequestMethods;
+    url: string;
+    config?: Config;
+  };
+
+  form: {
+    initialValues: TForm;
+  };
+};
+
+export type UsePrecognitionReturn<TForm = Record<string, any>> = {
+  validator: Validator;
+  validate(name: keyof TForm): UsePrecognitionReturn<TForm>;
+  isValidating: string | null;
+  isProcessingValidation: boolean;
+  lastTouched: keyof TForm | null;
+  setLastTouched: React.Dispatch<React.SetStateAction<keyof TForm | null>>;
+  touched: Array<keyof TForm>;
+
+  setValidatorTimeout(duration: Timeout): UsePrecognitionReturn<TForm>;
+};
+
+export type InertiaPrecognitionFormProps<TForm = Record<string, any>> =
+  InertiaFormProps<TForm> & UsePrecognitionReturn<TForm>;
+
+export interface UseInertiaPrecognitionFormReturn<TForm = Record<string, any>>
+  extends InertiaPrecognitionFormProps<TForm> {
+  validateAndSetDataByKeyValuePair(
+    name: keyof TForm,
+    value: any
+  ): UsePrecognitionReturn<TForm>;
+  passed: Array<keyof TForm>;
+}
+
+export type UsePrecognitionFormReturn<TForm = Record<string, any>> =
+  UsePrecognitionReturn<TForm> & {
+    data: TForm;
+    setData: React.Dispatch<React.SetStateAction<TForm>>;
+    errors: Record<keyof TForm, string> | null;
+    setErrors: React.Dispatch<
+      React.SetStateAction<Record<keyof TForm, string> | null>
+    >;
+    clearErrors: () => void;
+    validateAndSetDataByKeyValuePair(
+      key: keyof TForm,
+      value: any
+    ): UsePrecognitionFormReturn<TForm>;
+    passed: Array<keyof TForm>;
+  };

src/types/index.ts

@@ -1,60 +1 @@
-import {
-  Config,
-  RequestMethods,
-  Timeout,
-  Validator,
-} from 'laravel-precognition/dist/types';
-import React from 'react';
-import { InertiaFormProps } from '@inertiajs/inertia-react';
-
-export type UsePrecognitionFormOptions<TForm = Record<string, any>> = {
-  precognition: {
-    method: RequestMethods;
-    url: string;
-    config?: Config;
-  };
-
-  form: {
-    initialValues: TForm;
-  };
-};
-
-export type UsePrecognition<TForm = Record<string, any>> = {
-  validator: Validator;
-  validate(name: keyof TForm): UsePrecognition<TForm>;
-  isValidating: string | null;
-  isProcessingValidation: boolean;
-  lastTouched: keyof TForm | null;
-  setLastTouched: React.Dispatch<React.SetStateAction<keyof TForm | null>>;
-  touched: Array<keyof TForm>;
-
-  setValidatorTimeout(duration: Timeout): UsePrecognition<TForm>;
-};
-
-export type InertiaPrecognitionFormProps<TForm = Record<string, any>> =
-  InertiaFormProps<TForm> & UsePrecognition<TForm>;
-
-export interface UseInertiaPrecognitionForm<TForm = Record<string, any>>
-  extends InertiaPrecognitionFormProps<TForm> {
-  validateAndSetDataByKeyValuePair(
-    name: keyof TForm,
-    value: any
-  ): UsePrecognition<TForm>;
-  passed: Array<keyof TForm>;
-}
-
-export type UsePrecognitionForm<TForm = Record<string, any>> =
-  UsePrecognition<TForm> & {
-    data: TForm;
-    setData: React.Dispatch<React.SetStateAction<TForm>>;
-    errors: Record<keyof TForm, string> | null;
-    setErrors: React.Dispatch<
-      React.SetStateAction<Record<keyof TForm, string> | null>
-    >;
-    clearErrors: () => void;
-    validateAndSetDataByKeyValuePair(
-      key: keyof TForm,
-      value: any
-    ): UsePrecognitionForm<TForm>;
-    passed: Array<keyof TForm>;
-  };
+export * from './hooks';