@noxickon/onyx 0.0.4-dev.8 → 1.0.0

package/dist/hooks.d.ts

@@ -1,10 +1,9 @@
-import { ApolloQueryResult } from '@apollo/client';
 import { AxiosProgressEvent } from 'axios';
 import { AxiosResponse } from 'axios';
 import { DocumentNode } from 'graphql';
-import { FetchResult } from '@apollo/client';
-import { MutationHookOptions } from '@apollo/client';
-import { QueryHookOptions } from '@apollo/client';
+import { RefObject } from 'react';
+import { useLazyQuery } from '@apollo/client/react';
+import { useMutation } from '@apollo/client/react';
 import * as z from 'zod/v4';
 
 export declare type BuiltInRule = 'nullable' | 'required' | 'string' | 'email' | 'url' | 'number' | 'integer' | 'positive' | 'negative' | 'ipv4' | 'boolean' | 'date' | 'array' | 'object' | `min:${number}` | `max:${number}` | `minLength:${number}` | `maxLength:${number}` | `pattern:${string}` | 'file' | `fileSize:${string}` | `fileType:${string}` | `arrayMinLength:${number}` | `arrayMaxLength:${number}` | 'arrayEach:string' | 'arrayEach:number' | 'arrayEach:email' | 'arrayEach:url' | 'arrayEach:file' | `arrayEach:fileSize:${string}` | `arrayEach:fileType:${string}`;
@@ -14,23 +13,27 @@ export declare interface CustomValidatorWithMessage {
     message: string;
 }
 
-declare type GetNestedValue<T, P extends string> = P extends keyof T ? T[P] : P extends `${infer K}.${infer Rest}` ? K extends keyof T ? GetNestedValue<T[K], Rest> : never : never;
+declare type FormDataWithoutRoot<T> = T & {
+    root?: never;
+};
+
+export declare type GetNestedValue<T, P extends string> = P extends keyof T ? T[P] : P extends `${infer K}.${infer Rest}` ? K extends keyof T ? GetNestedValue<T[K], Rest> : never : never;
 
 export declare const handleRules: (rules: ValidationRule[]) => z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
 
-export declare interface QueryOptions {
+export declare interface QueryOptions<TResponse = unknown> {
     onBefore?: () => void;
     onError?: (error: unknown) => void;
     onFinish?: () => void;
-    onSuccess?: (response: ApolloQueryResult<unknown>) => void;
+    onSuccess?: (response: Awaited<ReturnType<ReturnType<typeof useLazyQuery<TResponse>>[0]>>) => void;
     skipValidation?: boolean;
 }
 
-export declare interface SubmitOptions {
+export declare interface SubmitOptions<TResponse = unknown> {
     onBefore?: () => void;
     onError?: (error: unknown) => void;
     onFinish?: () => void;
-    onSuccess?: (response: FetchResult) => void;
+    onSuccess?: (response: Awaited<ReturnType<ReturnType<typeof useMutation<TResponse>>[0]>>) => void;
     skipValidation?: boolean;
 }
 
@@ -44,6 +47,20 @@ export declare interface UploadOptions {
     skipValidation?: boolean;
 }
 
+export declare function useControllableState<T>({ defaultValue, name, onChange, value: controlledValue, }: UseControllableStateParams<T>): UseControllableStateReturn<T>;
+
+export declare interface UseControllableStateParams<T> {
+    defaultValue?: T;
+    name?: string;
+    onChange?: (value: T | undefined) => void;
+    value?: T;
+}
+
+export declare type UseControllableStateReturn<T> = [
+T | undefined,
+(value: T | undefined | ((prev: T | undefined) => T | undefined)) => void
+];
+
 export declare const useFileUpload: <T extends Record<string, unknown>>({ endpoint, headers, initialData, validationRules, }: UseFileUploadOptions<T>) => UseFileUploadReturn<T>;
 
 export declare interface UseFileUploadOptions<T extends Record<string, unknown>> extends UseFormStateOptions<T> {
@@ -57,42 +74,63 @@ export declare interface UseFileUploadReturn<T extends Record<string, unknown>>
     upload: (options?: UploadOptions) => void;
 }
 
-export declare const useFilter: <T extends Record<string, unknown>>({ headers, initialData, options, query: queryDocument, validationRules, }: UseFilterOptions<T>) => UseFilterReturn<T>;
+export declare const useFilter: <T extends Record<string, any>, TResponse = unknown>({ headers, initialData, options, query: queryDocument, validationRules, }: UseFilterOptions<T, TResponse>) => UseFilterReturn<T, TResponse>;
 
-export declare interface UseFilterOptions<T extends Record<string, unknown>> extends UseFormStateOptions<T> {
+export declare interface UseFilterOptions<T extends Record<string, any>, TResponse = unknown> extends UseFormStateOptions<T> {
     headers?: Record<string, string>;
-    options?: QueryHookOptions;
+    options?: Parameters<typeof useLazyQuery<TResponse>>[1];
     query: DocumentNode;
 }
 
-export declare interface UseFilterReturn<T extends Record<string, unknown>> extends Omit<UseFormStateReturn<T>, 'data' | 'setData'> {
-    data: unknown;
+export declare interface UseFilterReturn<T extends Record<string, any>, TResponse = unknown> extends Omit<UseFormStateReturn<T>, 'data' | 'setData'> {
+    data: TResponse | undefined;
     error: unknown;
     filter: T;
     isLoading: boolean;
-    query: (options?: QueryOptions) => void;
+    query: (options?: QueryOptions<TResponse>) => void;
     refetch: () => void;
     setFilter: UseFormStateReturn<T>['setData'];
 }
 
-export declare const useForm: <T extends Record<string, unknown>>({ headers, initialData, operation, options, validationRules, }: UseFormOptions<T>) => UseFormReturn<T>;
+export declare const useFocus: ({ containerRef, options }: UseFocusParams) => UseFocusReturn;
 
-export declare interface UseFormOptions<T extends Record<string, unknown>> extends UseFormStateOptions<T> {
+export declare interface UseFocusOptions {
+    autoFocus?: boolean;
+    enabled?: boolean;
+    restoreFocus?: boolean;
+    trapFocus?: boolean;
+}
+
+export declare interface UseFocusParams {
+    containerRef: RefObject<HTMLElement | null>;
+    options?: UseFocusOptions;
+}
+
+export declare interface UseFocusReturn {
+    focusFirst: () => void;
+    focusLast: () => void;
+    getCurrentFocus: () => HTMLElement | null;
+    getFocusableElements: () => HTMLElement[];
+}
+
+export declare const useForm: <T extends Record<string, any>, TResponse = unknown>({ headers, initialData, operation, options, validationRules, }: UseFormOptions<T, TResponse>) => UseFormReturn<T, TResponse>;
+
+export declare interface UseFormOptions<T extends Record<string, any>, TResponse = unknown> extends UseFormStateOptions<T> {
     headers?: Record<string, string>;
     operation: DocumentNode;
-    options?: MutationHookOptions;
+    options?: Parameters<typeof useMutation<TResponse>>[1];
 }
 
-export declare interface UseFormReturn<T extends Record<string, unknown>> extends UseFormStateReturn<T> {
+export declare interface UseFormReturn<T extends Record<string, any>, TResponse = unknown> extends UseFormStateReturn<T> {
     isLoading: boolean;
-    submit: (options?: SubmitOptions) => void;
-    transform: (transformFn: (data: T) => unknown) => Omit<UseFormReturn<T>, 'transform'>;
+    submit: (options?: SubmitOptions<TResponse>) => void;
+    transform: (transformFn: (data: T) => unknown) => Omit<UseFormReturn<T, TResponse>, 'transform'>;
 }
 
 export declare const useFormState: <T extends Record<string, unknown>>({ initialData, validationRules, }: UseFormStateOptions<T>) => UseFormStateReturn<T>;
 
 export declare interface UseFormStateOptions<T extends Record<string, unknown> = Record<string, unknown>> {
-    initialData: T;
+    initialData: FormDataWithoutRoot<T>;
     validationRules?: ValidatorConfig;
 }
 
@@ -113,6 +151,30 @@ export declare interface UseFormStateReturn<T = Record<string, unknown>> {
     validate: () => boolean;
 }
 
+export declare const useKeyboard: ({ allowRepeat, enabled, onArrowDown, onArrowUp, onEnter, onEscape, onTab, }: UseKeyboardOptions) => void;
+
+export declare interface UseKeyboardOptions {
+    allowRepeat?: boolean;
+    enabled?: boolean;
+    onArrowDown?: () => void;
+    onArrowUp?: () => void;
+    onEnter?: () => void;
+    onEscape?: () => void;
+    onTab?: () => void;
+}
+
+export declare const useOverflowDetection: ({ selector, }?: UseOverflowDetectionOptions) => UseOverflowDetectionReturn;
+
+export declare interface UseOverflowDetectionOptions {
+    selector?: string;
+}
+
+export declare interface UseOverflowDetectionReturn {
+    checkOverflow: () => void;
+    handleResize: (node: HTMLDivElement | null) => () => void;
+    overflowAmount: number;
+}
+
 export declare type ValidationError = string | string[];
 
 export declare type ValidationErrors = Record<string, ValidationError>;