@up42/up-components 8.3.0 → 9.1.0

package/dist/esm/types/utils/hooks/useCursorPagination.d.ts

@@ -1,37 +0,0 @@
-export interface CursorPaginatedResponse<T> {
-    content: T[];
-    nextCursor: number | null;
-    prevCursor: number | null;
-}
-export interface UseCursorPaginationOptions {
-    defaultPageSize?: number;
-}
-type UseCursorPaginationResponse = {
-    pageSize: number;
-    page: number;
-    data: any[];
-    isLoading: boolean;
-    refetch: () => Promise<any>;
-    isRefetching: boolean;
-    setPage: (page: number) => void;
-    setPageSize: (pageSize: number) => void;
-    handlePageChange: (page: number, pageSize: number) => void;
-    cursor: number;
-    setCursor: (cursor: number) => void;
-};
-/**
- * Returns cursor-based pagination data and and helper functions.
- *
- * Documentation: https://up-components.up42.com/?path=/docs/utils--docs#usecursorpagination
- */
-export declare const useCursorPagination: (fetchingHook: ({ params }: {
-    params: string;
-}) => {
-    data: CursorPaginatedResponse<any> | undefined;
-    isLoading: boolean;
-    refetch: () => Promise<any>;
-    isRefetching: boolean;
-}, searchParams?: {
-    [paramName: string]: string;
-} | undefined, options?: UseCursorPaginationOptions) => UseCursorPaginationResponse;
-export {};

package/dist/esm/types/utils/hooks/useCursorPagination.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/utils/hooks/useDebounce.d.ts

@@ -1,8 +0,0 @@
-/**
- * useDebounce is a generic React Hook that returns a debounced version of a given value.
- * @param {T} value - The value to debounce.
- * @param {number} [delay=500] - The debouncing delay in milliseconds.
- * @returns {T} The debounced value.
- * Documentation: https://up-components.up42.com/?path=/docs/utils--docs#usedebounce
- */
-export declare const useDebounce: <T>(value: T, delay?: number) => T;

package/dist/esm/types/utils/hooks/useDebounce.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/utils/hooks/useQueryParams.d.ts

@@ -1,7 +0,0 @@
-/**
- * Returns query parameter values from a string or an array of strings.
- *
- * Documentation: https://up-components.up42.com/?path=/docs/utils--docs#usequeryparams
- */
-export declare function useQueryParams(paramName: string): string;
-export declare function useQueryParams(paramNames: string[]): Array<string>;

package/dist/esm/types/utils/hooks/useQueryParams.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/utils/hooks/useRemotePagination.d.ts

@@ -1,39 +0,0 @@
-export interface PaginatedResponse<T> {
-    totalElements: number;
-    content: T[];
-}
-type OrderDirection = 'asc' | 'desc' | null;
-export interface UseRemotePaginationOptions {
-    defaultPageSize?: number;
-}
-type UseRemotePaginationResponse = {
-    pageSize: number;
-    page: number;
-    count: number;
-    data: any[];
-    isLoading: boolean;
-    refetch: () => Promise<any>;
-    isRefetching: boolean;
-    setPage: (page: number) => void;
-    setPageSize: (page: number) => void;
-    columnsSort: any[];
-    handleOrderChange: (orderId: number, orderDirection: OrderDirection) => void;
-    orderBy: string | null;
-    orderDirection: OrderDirection;
-};
-/**
- * Returns pagination data and and helper functions.
- *
- * Documentation: https://up-components.up42.com/?path=/docs/utils--docs#useremotepagination
- */
-export declare const useRemotePagination: (fetchingHook: ({ params }: {
-    params: string;
-}) => {
-    data: PaginatedResponse<any> | undefined;
-    isLoading: boolean;
-    refetch: () => Promise<any>;
-    isRefetching: boolean;
-}, columns: any[], searchParams?: {
-    [paramName: string]: string;
-} | undefined, options?: UseRemotePaginationOptions) => UseRemotePaginationResponse;
-export {};

package/dist/esm/types/utils/hooks/useRemotePagination.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/utils/hooks/useToggle.d.ts

@@ -1,24 +0,0 @@
-export type UseToggleResult = [
-    boolean,
-    {
-        on: () => void;
-        off: () => void;
-        flip: () => void;
-    }
-];
-/**
- * A custom hook that provides a boolean state with convenient toggle actions.
- *
- * This hook returns a boolean value and an object with three methods to control the state:
- * - `on`: Sets the value to `true`
- * - `off`: Sets the value to `false`
- * - `flip`: Toggles the current value (true becomes false, false becomes true)
- *
- * @param initialState - The initial boolean value. Can be a boolean or a function that returns a boolean.
- * @returns A tuple containing:
- *   - The current boolean value
- *   - An object with `on`, `off`, and `flip` methods to control the state
- *
- * Documentation: https://up-components.up42.com/?path=/docs/utils--docs#usetoggle
- */
-export declare function useToggle(initialState: boolean | (() => boolean)): UseToggleResult;

package/dist/esm/types/utils/hooks/useToggle.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/utils/hooks/useUrlParams/index.d.ts

@@ -1,3 +0,0 @@
-export * from './useUrlParams';
-export * from './types';
-export * from './utils';

package/dist/esm/types/utils/hooks/useUrlParams/types.d.ts

@@ -1,22 +0,0 @@
-export type SearchParamObject = Record<string, string>;
-export type ParamsObject = Record<string, unknown>;
-export type RemoveParamRules<T extends ParamsObject = ParamsObject> = {
-    [K in keyof T]?: (value: T[K]) => boolean;
-};
-export type Options<T extends ParamsObject> = {
-    cast: (search: SearchParamObject) => T;
-    parse: (searchParam: URLSearchParams) => SearchParamObject;
-    stringify: (searchParamsObject: T) => ReturnType<URLSearchParams['toString']>;
-    removeParams: RemoveParamRules<T>;
-};
-export type PartialOptions<T extends ParamsObject> = Partial<Options<T>>;
-export type UseUrlParamsReturn<T extends ParamsObject> = {
-    /** Search params object literal. */
-    params: T;
-    /** Navigate using given search params object literal. */
-    setParams: (params: ParamsObject) => void;
-    /** Stringified search params for use when navigating to other paths. */
-    stringParams: string;
-    /** Default params obtained by running the cast function with an empty object. Useful for resetting filters to their initial state. */
-    defaultParams: T;
-};

package/dist/esm/types/utils/hooks/useUrlParams/useUrlParams.d.ts

@@ -1,11 +0,0 @@
-import type { ParamsObject, PartialOptions, UseUrlParamsReturn } from './types';
-/**
- * Parses URLSearchParams into an object and supports navigating with updated search params.
- * Supports custom parsing (e.g. arrays, dates) and serialization back to a search string.
- *
- * @param options.cast - How to turn Record<string, string> into the params object (required when using typed params).
- * @param options.parse - How to turn URLSearchParams into Record<string, string>. Default: entries as-is.
- * @param options.stringify - How to stringify the params object. Default: arrays as comma-separated, dates as YYYY-MM-DD.
- * @param options.removeParams - Map of param keys to predicate functions; when setParams runs, params whose predicate returns true are removed from the URL.
- */
-export declare function useUrlParams<TParams extends ParamsObject>(options?: PartialOptions<TParams>): UseUrlParamsReturn<TParams>;

package/dist/esm/types/utils/hooks/useUrlParams/useUrlParams.test.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/esm/types/utils/hooks/useUrlParams/utils.d.ts

@@ -1,19 +0,0 @@
-import { ParamsObject, SearchParamObject } from './types';
-/**
- * There could be many ways to parse URLSearchParams to an object.
- * For example, how should `a` be treated in `a=1&b=2&a=3`?
- * This implementation is a choice.
- */
-export declare function searchParamsToObject(searchParam: URLSearchParams): SearchParamObject;
-/**
- * Stringify a value to a string.
- * @param value - The value to stringify.
- * @returns The stringified value.
- */
-export declare function valueToString(value: unknown): string;
-/**
- * There could be many ways to serialize an object to URLSearchParams.
- * For example, how should `d` be treated in `{ d: new Date() }`? How should arrays behave?
- * This implementation is a choice.
- */
-export declare function objectToSearchParams<T extends ParamsObject = ParamsObject>(object: T): string;

package/dist/esm/types/utils/hooks/useUrlParams/utils.test.d.ts

@@ -1 +0,0 @@
-export {};