@bapp/auto-api-client/dist/react-query.d.ts

Client to consume BAPP auto API, based on content types with type inference

import { QueryFunction, QueryKey } from '@tanstack/react-query';
import { RequestOptions } from './service';
import { HookRequestConfig } from './context';
import { PagedData, RegisteredMapping } from './types';
export type QueryRequestOptions = Omit<RequestOptions, "config"> & {
    config: HookRequestConfig<true>;
};
export declare const getQueryKey: (extraParts: unknown[], options: {
    options: QueryRequestOptions;
    useTenant?: boolean;
    useAppSlug?: boolean;
    useFilter?: boolean;
}) => unknown[];
export declare const getQueryFn: <TData = any, TFunc extends (...args: any[]) => Promise<TData> = any>(func: TFunc, ...args: Parameters<TFunc>) => QueryFunction<TData, QueryKey, unknown>;
export declare const getMeQueryOptions: <TData = any>(options: QueryRequestOptions) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<TData, Error, TData, readonly unknown[]>, "queryFn"> & {
    queryFn?: QueryFunction<TData, readonly unknown[], never> | undefined;
} & {
    queryKey: readonly unknown[] & {
        [dataTagSymbol]: TData;
        [dataTagErrorSymbol]: Error;
    };
};
export declare const getAppQueryOptions: <TData = any>(appSlug: string, options: QueryRequestOptions) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<TData, Error, TData, readonly unknown[]>, "queryFn"> & {
    queryFn?: QueryFunction<TData, readonly unknown[], never> | undefined;
} & {
    queryKey: readonly unknown[] & {
        [dataTagSymbol]: TData;
        [dataTagErrorSymbol]: Error;
    };
};
export declare const getEntityListIntrospectQueryOptions: <TData = any>(contentType: RegisteredMapping["ContentType"], options: QueryRequestOptions) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<TData, Error, TData, readonly unknown[]>, "queryFn"> & {
    queryFn?: QueryFunction<TData, readonly unknown[], never> | undefined;
} & {
    queryKey: readonly unknown[] & {
        [dataTagSymbol]: TData;
        [dataTagErrorSymbol]: Error;
    };
};
export declare const getEntityDetailIntrospectQueryOptions: <TData = any>(contentType: RegisteredMapping["ContentType"], pk: string | undefined, options: QueryRequestOptions) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<TData, Error, TData, readonly unknown[]>, "queryFn"> & {
    queryFn?: QueryFunction<TData, readonly unknown[], never> | undefined;
} & {
    queryKey: readonly unknown[] & {
        [dataTagSymbol]: TData;
        [dataTagErrorSymbol]: Error;
    };
};
export declare const getEntityListQueryOptions: <TData = any>(contentType: RegisteredMapping["ContentType"], options: QueryRequestOptions) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<PagedData<TData>, Error, PagedData<TData>, readonly unknown[]>, "queryFn"> & {
    queryFn?: QueryFunction<PagedData<TData>, readonly unknown[], never> | undefined;
} & {
    queryKey: readonly unknown[] & {
        [dataTagSymbol]: PagedData<TData>;
        [dataTagErrorSymbol]: Error;
    };
};
export declare const getEntityInfiniteListQueryOptions: <TData = any>(contentType: RegisteredMapping["ContentType"], options: QueryRequestOptions) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseInfiniteQueryOptions<PagedData<TData>, Error, import('@tanstack/react-query').InfiniteData<PagedData<TData>, unknown>, PagedData<TData>, readonly unknown[], unknown>, "queryFn"> & {
    queryFn?: QueryFunction<PagedData<TData>, readonly unknown[], unknown> | undefined;
} & {
    queryKey: readonly unknown[] & {
        [dataTagSymbol]: import('@tanstack/react-query').InfiniteData<PagedData<TData>, unknown>;
        [dataTagErrorSymbol]: Error;
    };
};
export declare const getEntityDetailQueryOptions: <TData = any>(contentType: RegisteredMapping["ContentType"], pk: string, options: QueryRequestOptions) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<TData, Error, TData, readonly unknown[]>, "queryFn"> & {
    queryFn?: QueryFunction<TData, readonly unknown[], never> | undefined;
} & {
    queryKey: readonly unknown[] & {
        [dataTagSymbol]: TData;
        [dataTagErrorSymbol]: Error;
    };
};
export declare const getTaskListQueryOptions: <TData = any>(options: QueryRequestOptions) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<TData, Error, TData, readonly unknown[]>, "queryFn"> & {
    queryFn?: QueryFunction<TData, readonly unknown[], never> | undefined;
} & {
    queryKey: readonly unknown[] & {
        [dataTagSymbol]: TData;
        [dataTagErrorSymbol]: Error;
    };
};
export declare const getTaskDetailQueryOptions: <TData = any>(code: RegisteredMapping["TaskCode"], options: QueryRequestOptions) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<TData, Error, TData, readonly unknown[]>, "queryFn"> & {
    queryFn?: QueryFunction<TData, readonly unknown[], never> | undefined;
} & {
    queryKey: readonly unknown[] & {
        [dataTagSymbol]: TData;
        [dataTagErrorSymbol]: Error;
    };
};
export declare const getTaskRunQueryOptions: <TData = any>(code: RegisteredMapping["TaskCode"], payload: unknown | undefined, options: QueryRequestOptions) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<TData, Error, TData, readonly unknown[]>, "queryFn"> & {
    queryFn?: QueryFunction<TData, readonly unknown[], never> | undefined;
} & {
    queryKey: readonly unknown[] & {
        [dataTagSymbol]: TData;
        [dataTagErrorSymbol]: Error;
    };
};
export declare const getWidgetListQueryOptions: <TData = any>(options: QueryRequestOptions) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<TData, Error, TData, readonly unknown[]>, "queryFn"> & {
    queryFn?: QueryFunction<TData, readonly unknown[], never> | undefined;
} & {
    queryKey: readonly unknown[] & {
        [dataTagSymbol]: TData;
        [dataTagErrorSymbol]: Error;
    };
};
export declare const getWidgetDetailQueryOptions: <TData = any>(code: string, options: QueryRequestOptions) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<TData, Error, TData, readonly unknown[]>, "queryFn"> & {
    queryFn?: QueryFunction<TData, readonly unknown[], never> | undefined;
} & {
    queryKey: readonly unknown[] & {
        [dataTagSymbol]: TData;
        [dataTagErrorSymbol]: Error;
    };
};
export declare const getWidgetRenderQueryOptions: <TData = any>(code: string, payload: unknown | undefined, options: QueryRequestOptions) => import('@tanstack/react-query').OmitKeyof<import('@tanstack/react-query').UseQueryOptions<TData, Error, TData, readonly unknown[]>, "queryFn"> & {
    queryFn?: QueryFunction<TData, readonly unknown[], never> | undefined;
} & {
    queryKey: readonly unknown[] & {
        [dataTagSymbol]: TData;
        [dataTagErrorSymbol]: Error;
    };
};