@panneau/data 4.0.38 → 4.0.40-alpha.1

package/dist/index.d.ts

@@ -1,190 +1,14 @@
 import * as _tanstack_react_query from '@tanstack/react-query';
-import { QueryClient } from '@tanstack/react-query';
-import * as _tanstack_query_core from '@tanstack/query-core';
+import { UseQueryOptions, UseQueryResult, UseMutationResult, UseMutationOptions, QueryClient } from '@tanstack/react-query';
+import { Item, Pagination, Resource, ResourceItem } from '@panneau/core';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { ReactNode } from 'react';
 
-declare function useData(loadData: any, { initialData, autoload }?: {
-    initialData?: any;
-    autoload?: boolean;
-}): {
-    data: any;
-    load: (...args: any[]) => any;
-    loading: boolean;
-    error: boolean;
-};
-
-declare function useItems$1({ store, url, paginated: initialPaginated, query: initialQuery, onQueryChange, queryConfig, keepData, ...oldProps }: {
-    [x: string]: any;
-    store: any;
-    url: any;
-    paginated?: boolean;
-    query?: any;
-    onQueryChange: any;
-    queryConfig?: any;
-    keepData?: boolean;
-}): {
-    items: any;
-    allItems: any;
-    pages: any;
-    pageItems: any;
-    pagination: {
-        page: any;
-        lastPage: any;
-        total: any;
-    };
-    total: any;
-    lastPage: any;
-    loaded: boolean;
-    allLoaded: boolean;
-    loading: boolean;
-    loadNextPage: () => void;
-    loadPage: (newPage: any) => void;
-    reloadPage: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<unknown, Error>>;
-    reload: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<unknown, Error>>;
-    reset: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<unknown, Error>>;
-    updateItem: (item: any) => void;
-    status: "error" | "success";
+declare function useItem<T = Item>(scope: any, id: any, loader: (id: any) => Promise<T>, opts?: any): {
     error: Error;
     isError: true;
     isPending: false;
-    isLoadingError: false;
-    isRefetchError: true;
-    isSuccess: false;
-    isPlaceholderData: false;
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: Error;
-    errorUpdateCount: number;
-    isFetchedAfterMount: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isStale: boolean;
-    isEnabled: boolean;
-    fetchStatus: _tanstack_react_query.FetchStatus;
-    promise: Promise<unknown>;
-} | {
-    items: any;
-    allItems: any;
-    pages: any;
-    pageItems: any;
-    pagination: {
-        page: any;
-        lastPage: any;
-        total: any;
-    };
-    total: any;
-    lastPage: any;
-    loaded: boolean;
-    allLoaded: boolean;
-    loading: boolean;
-    loadNextPage: () => void;
-    loadPage: (newPage: any) => void;
-    reloadPage: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<unknown, Error>>;
-    reload: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<unknown, Error>>;
-    reset: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<unknown, Error>>;
-    updateItem: (item: any) => void;
-    status: "error" | "success";
-    error: Error;
-    isError: false;
-    isPending: false;
-    isLoadingError: false;
-    isRefetchError: false;
-    isSuccess: true;
-    isPlaceholderData: false;
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: Error;
-    errorUpdateCount: number;
-    isFetchedAfterMount: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isStale: boolean;
-    isEnabled: boolean;
-    fetchStatus: _tanstack_react_query.FetchStatus;
-    promise: Promise<unknown>;
-};
-
-declare function useItems({ getPage, getItems, page, count, items: providedItems, pages: initialPages, getPageFromResponse, getItemsFromResponse, onItemsLoaded, onPageLoaded, onLoaded, onError, }: {
-    getPage?: any;
-    getItems?: any;
-    page?: any;
-    count?: number;
-    items?: any;
-    pages?: any;
-    getPageFromResponse?: ({ pagination: { page: currentPage, last_page: lastPage, total, per_page: perPage }, data: items, }: {
-        pagination: {
-            page: any;
-            last_page: any;
-            total: any;
-            per_page: any;
-        };
-        data: any;
-    }) => {
-        page: number;
-        lastPage: number;
-        total: number;
-        count: number;
-        items: any;
-    };
-    getItemsFromResponse?: (data: any) => any;
-    onItemsLoaded?: any;
-    onPageLoaded?: any;
-    onLoaded?: any;
-    onError?: any;
-}): {
-    items: any;
-    pages: any;
-    pageItems: any;
-    total: any;
-    lastPage: any;
-    loaded: boolean;
-    allLoaded: boolean;
-    loading: boolean;
-    loadNextPage: () => any;
-    loadPage: (pageToLoad: any) => any;
-    reloadPage: () => any;
-    reload: () => any;
-    reset: () => void;
-    updateItem: (newItem: any) => void;
-};
-
-declare function useItemsStore(store: any, { url, getPage, getItems, getPageFromResponse, getItemsFromResponse, page: initialPage, count: initialCount, query, onQueryChange, queryConfig, keepData, }: {
-    url?: any;
-    getPage?: any;
-    getItems?: any;
-    getPageFromResponse?: any;
-    getItemsFromResponse?: any;
-    page?: any;
-    count?: any;
-    query?: any;
-    onQueryChange?: any;
-    queryConfig?: any;
-    keepData?: boolean;
-}): {
     isLoading: false;
-    isFetching: boolean;
-    isRefetching: boolean;
-    isFetched: boolean;
-    items: any;
-    pages: any;
-    allItems: any;
-    loading: boolean;
-    loaded: boolean;
-    reload: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<unknown, Error>>;
-    loadPage: (newPage: any) => void;
-    loadNextPage: () => void;
-    updateItem: (item: any) => void;
-    pagination: {
-        page: any;
-        lastPage: any;
-        total: any;
-    };
-    error: Error;
-    isError: true;
-    isPending: false;
     isLoadingError: false;
     isRefetchError: true;
     isSuccess: false;
@@ -195,35 +19,23 @@ declare function useItemsStore(store: any, { url, getPage, getItems, getPageFrom
     failureCount: number;
     failureReason: Error;
     errorUpdateCount: number;
+    isFetched: boolean;
     isFetchedAfterMount: boolean;
+    isFetching: boolean;
     isInitialLoading: boolean;
     isPaused: boolean;
+    isRefetching: boolean;
     isStale: boolean;
     isEnabled: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<_tanstack_react_query.NoInfer<T>, Error>>;
     fetchStatus: _tanstack_react_query.FetchStatus;
-    promise: Promise<unknown>;
+    promise: Promise<_tanstack_react_query.NoInfer<T>>;
+    item: _tanstack_react_query.NoInfer<T>;
 } | {
-    isLoading: false;
-    isFetching: boolean;
-    isRefetching: boolean;
-    isFetched: boolean;
-    items: any;
-    pages: any;
-    allItems: any;
-    loading: boolean;
-    loaded: boolean;
-    reload: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<unknown, Error>>;
-    loadPage: (newPage: any) => void;
-    loadNextPage: () => void;
-    updateItem: (item: any) => void;
-    pagination: {
-        page: any;
-        lastPage: any;
-        total: any;
-    };
     error: null;
     isError: false;
     isPending: false;
+    isLoading: false;
     isLoadingError: false;
     isRefetchError: false;
     isSuccess: true;
@@ -234,106 +46,77 @@ declare function useItemsStore(store: any, { url, getPage, getItems, getPageFrom
     failureCount: number;
     failureReason: Error;
     errorUpdateCount: number;
+    isFetched: boolean;
     isFetchedAfterMount: boolean;
+    isFetching: boolean;
     isInitialLoading: boolean;
     isPaused: boolean;
+    isRefetching: boolean;
     isStale: boolean;
     isEnabled: boolean;
+    refetch: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<_tanstack_react_query.NoInfer<T>, Error>>;
     fetchStatus: _tanstack_react_query.FetchStatus;
-    promise: Promise<unknown>;
+    promise: Promise<_tanstack_react_query.NoInfer<T>>;
+    item: _tanstack_react_query.NoInfer<T>;
 };
 
-declare function useResourceDestroy(resource: any, id?: any): {
-    destroy: (providedId: any) => any;
-    loading: boolean;
-};
-
-declare function useResourceItem(resource: any, id: any, opts: any): {
-    load: (...args: any[]) => any;
-    loading: boolean;
-    error: boolean;
-    item: any;
+type UseItemsResponse<T> = {
+    data: T[];
+    pagination: Pagination;
+    meta?: Pagination;
+} | T[];
+type UseItemsKey = [string, Record<string, unknown> | null, number | null, number | null];
+type UseItemsOptions<T> = UseQueryOptions<UseItemsResponse<T>, Error, UseItemsResponse<T>, UseItemsKey> & {
+    url?: string | null;
+    getItems?: ((query: Record<string, unknown> | null, page: number | null, count: number | null) => Promise<UseItemsResponse<T>>) | null;
+    page?: number | null;
+    count?: number | null;
+    query?: Record<string, unknown> | null;
+    keepData?: boolean;
 };
-
-declare function useResourceItems(resource: any, query?: any, page?: any, count?: any, opts?: any): {
-    isLoading: false;
-    isFetching: boolean;
-    isRefetching: boolean;
-    isFetched: boolean;
-    pages: any;
-    allItems: any;
-    loading: boolean;
-    loaded: boolean;
-    reload: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<unknown, Error>>;
-    loadPage: (newPage: any) => void;
-    loadNextPage: () => void;
-    updateItem: (item: any) => void;
+type UseItemsResult<T> = {
+    items: T[];
+    allItems: T[];
     pagination: {
-        page: any;
-        lastPage: any;
-        total: any;
-    };
-    error: Error;
-    isError: true;
-    isPending: false;
-    isLoadingError: false;
-    isRefetchError: true;
-    isSuccess: false;
-    isPlaceholderData: false;
-    status: "error";
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: Error;
-    errorUpdateCount: number;
-    isFetchedAfterMount: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isStale: boolean;
-    isEnabled: boolean;
-    fetchStatus: _tanstack_query_core.FetchStatus;
-    promise: Promise<unknown>;
-    items: any;
-} | {
-    isLoading: false;
-    isFetching: boolean;
-    isRefetching: boolean;
-    isFetched: boolean;
-    pages: any;
-    allItems: any;
+        page: number;
+        lastPage: number;
+        total: number;
+    } | null;
     loading: boolean;
     loaded: boolean;
-    reload: (options?: _tanstack_query_core.RefetchOptions) => Promise<_tanstack_query_core.QueryObserverResult<unknown, Error>>;
-    loadPage: (newPage: any) => void;
-    loadNextPage: () => void;
-    updateItem: (item: any) => void;
-    pagination: {
-        page: any;
-        lastPage: any;
-        total: any;
-    };
-    error: null;
-    isError: false;
-    isPending: false;
-    isLoadingError: false;
-    isRefetchError: false;
-    isSuccess: true;
-    isPlaceholderData: false;
-    status: "success";
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    failureCount: number;
-    failureReason: Error;
-    errorUpdateCount: number;
-    isFetchedAfterMount: boolean;
-    isInitialLoading: boolean;
-    isPaused: boolean;
-    isStale: boolean;
-    isEnabled: boolean;
-    fetchStatus: _tanstack_query_core.FetchStatus;
-    promise: Promise<unknown>;
-    items: any;
+    reload: () => void;
+    updateItem: (item: T) => void;
+} & UseQueryResult<UseItemsResponse<T>, Error>;
+declare function useItems<T = Item>(scope: any, { url, getItems, page: initialPage, count: initialCount, query, keepData, ...queryConfig }: UseItemsOptions<T>): UseItemsResult<T>;
+
+type UseResourceDestroyResult = UseMutationResult & {
+    destroy: (id?: string) => void;
+    destroyAsync: (id?: string) => Promise<unknown>;
+    loading: boolean;
+};
+declare function useResourceDestroy(id: string | null): UseResourceDestroyResult;
+declare function useResourceDestroy(id: string | null, options: UseMutationOptions): UseResourceDestroyResult;
+declare function useResourceDestroy(resource: Resource | string, id: string | null): UseResourceDestroyResult;
+declare function useResourceDestroy(resource: Resource | string, id: string | null, options: UseMutationOptions): UseResourceDestroyResult;
+
+type UseResourceItem<T> = UseQueryResult<T> & {
+    item: T | null;
 };
+declare function useResourceItem<T = ResourceItem>(id: string | null): UseResourceItem<T>;
+declare function useResourceItem<T = ResourceItem>(id: string | null, opts: any): UseResourceItem<T>;
+declare function useResourceItem<T = ResourceItem>(resource: Resource | string | null, id: string | null): UseResourceItem<T>;
+declare function useResourceItem<T = ResourceItem>(resource: Resource | string | null, id: string | null, opts: any): UseResourceItem<T>;
+
+declare function useResourceItems<T = ResourceItem>(): any;
+declare function useResourceItems<T = ResourceItem>(resource: Resource | string): any;
+declare function useResourceItems<T = ResourceItem>(resource: Resource | string, query: Record<string, unknown> | null): any;
+declare function useResourceItems<T = ResourceItem>(resource: Resource | string, query: Record<string, unknown> | null, page: number | null): any;
+declare function useResourceItems<T = ResourceItem>(resource: Resource | string, query: Record<string, unknown> | null, page: number | null, count: number | null): any;
+declare function useResourceItems<T = ResourceItem>(resource: Resource | string, query: Record<string, unknown> | null, page: number | null, count: number | null, opts: UseItemsOptions<T>): any;
+declare function useResourceItems<T = ResourceItem>(query: Record<string, unknown> | null): any;
+declare function useResourceItems<T = ResourceItem>(query: Record<string, unknown> | null, page: number | null): any;
+declare function useResourceItems<T = ResourceItem>(query: Record<string, unknown> | null, page: number | null, count: number | null): any;
+declare function useResourceItems<T = ResourceItem>(query: Record<string, unknown> | null, page: number | null, count: number | null, opts: UseItemsOptions<T>): any;
 
 declare function useResourceCreate(resource: any): {
     store: (data: any) => any;
@@ -457,4 +240,4 @@ interface DataProviderProps {
 }
 declare function DataProvider({ api, apiBaseUrl, children }: DataProviderProps): react_jsx_runtime.JSX.Element;
 
-export { Api, ApiProvider, Base as BaseApi, DataProvider, QueryProvider, useApi, useData, useItems$1 as useItems, useItems as useItemsLegacy, useItemsStore, useQueryContext, useResourceClone, useResourceDestroy, useResourceItem, useResourceItems, useResourceRestore, useResourceCreate as useResourceStore, useResourceUpdate };
+export { Api, ApiProvider, Base as BaseApi, DataProvider, QueryProvider, useApi, useItem, useItems, useQueryContext, useResourceClone, useResourceDestroy, useResourceItem, useResourceItems, useResourceRestore, useResourceCreate as useResourceStore, useResourceUpdate };