@panneau/data 4.0.73 → 4.0.74

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as _tanstack_react_query from '@tanstack/react-query';
-import { UseQueryOptions, UseQueryResult, UseMutationResult, UseMutationOptions, QueryClientConfig, QueryClient } from '@tanstack/react-query';
+import { UseQueryOptions, UseMutationOptions, QueryClientConfig, QueryClient } from '@tanstack/react-query';
 import { Item, Pagination, Resource, ResourceItem } from '@panneau/core';
 import * as react from 'react';
 import { ReactNode } from 'react';
@@ -79,157 +79,355 @@ type UseItemsOptions<T> = Omit<UseQueryOptions<UseItemsResponse<T>, Error, UseIt
     query?: Query | null;
     keepData?: boolean;
 };
-type UseItemsResult<T> = {
-    items: T[];
-    allItems: T[];
-    pages: Record<string, UseItemsResponse<T>>;
+declare function useItems<T = Item>(scope: string, { url, getItems, page: initialPage, count: initialCount, query, keepData, ...queryConfig }: UseItemsOptions<T>): {
+    isLoading: boolean;
+    isFetching: boolean;
+    isRefetching: boolean;
+    isFetched: boolean;
+    items: any;
+    pages: {};
+    allItems: any;
+    loading: boolean;
+    loaded: boolean;
+    reload: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<NoInfer<UseItemsResponse<T>>, Error>>;
+    updateItem: (item: any) => void;
     pagination: {
         page: number;
         lastPage: number;
         total: number;
-    } | null;
+    };
+    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_react_query.FetchStatus;
+    promise: Promise<NoInfer<UseItemsResponse<T>>>;
+} | {
+    isLoading: boolean;
+    isFetching: boolean;
+    isRefetching: boolean;
+    isFetched: boolean;
+    items: any;
+    pages: {};
+    allItems: any;
     loading: boolean;
     loaded: boolean;
-    reload: () => void;
-    updateItem: (item: T) => void;
-} & UseQueryResult<UseItemsResponse<T>, Error>;
-declare function useItems<T = Item>(scope: string, { 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>;
+    reload: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<NoInfer<UseItemsResponse<T>>, Error>>;
+    updateItem: (item: any) => void;
+    pagination: {
+        page: number;
+        lastPage: number;
+        total: number;
+    };
+    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_react_query.FetchStatus;
+    promise: Promise<NoInfer<UseItemsResponse<T>>>;
+} | {
+    isLoading: boolean;
+    isFetching: boolean;
+    isRefetching: boolean;
+    isFetched: boolean;
+    items: any;
+    pages: {};
+    allItems: any;
+    loading: boolean;
+    loaded: boolean;
+    reload: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<NoInfer<UseItemsResponse<T>>, Error>>;
+    updateItem: (item: any) => void;
+    pagination: {
+        page: number;
+        lastPage: number;
+        total: number;
+    };
+    error: Error;
+    isError: true;
+    isPending: false;
+    isLoadingError: true;
+    isRefetchError: false;
+    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_react_query.FetchStatus;
+    promise: Promise<NoInfer<UseItemsResponse<T>>>;
+} | {
+    isLoading: boolean;
+    isFetching: boolean;
+    isRefetching: boolean;
+    isFetched: boolean;
+    items: any;
+    pages: {};
+    allItems: any;
+    loading: boolean;
+    loaded: boolean;
+    reload: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<NoInfer<UseItemsResponse<T>>, Error>>;
+    updateItem: (item: any) => void;
+    pagination: {
+        page: number;
+        lastPage: number;
+        total: number;
+    };
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    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<NoInfer<UseItemsResponse<T>>>;
+} | {
+    isLoading: boolean;
+    isFetching: boolean;
+    isRefetching: boolean;
+    isFetched: boolean;
+    items: any;
+    pages: {};
+    allItems: any;
+    loading: boolean;
+    loaded: boolean;
+    reload: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<NoInfer<UseItemsResponse<T>>, Error>>;
+    updateItem: (item: any) => void;
+    pagination: {
+        page: number;
+        lastPage: number;
+        total: number;
+    };
+    error: null;
+    isError: false;
+    isPending: true;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: false;
+    isPlaceholderData: false;
+    status: "pending";
+    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<NoInfer<UseItemsResponse<T>>>;
+} | {
+    isLoading: boolean;
+    isFetching: boolean;
+    isRefetching: boolean;
+    isFetched: boolean;
+    items: any;
+    pages: {};
+    allItems: any;
     loading: boolean;
+    loaded: boolean;
+    reload: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<NoInfer<UseItemsResponse<T>>, Error>>;
+    updateItem: (item: any) => void;
+    pagination: {
+        page: number;
+        lastPage: number;
+        total: number;
+    };
+    isError: false;
+    error: null;
+    isPending: false;
+    isLoadingError: false;
+    isRefetchError: false;
+    isSuccess: true;
+    isPlaceholderData: true;
+    status: "success";
+    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<NoInfer<UseItemsResponse<T>>>;
 };
-declare function useResourceDestroy(resource: Resource | string): UseResourceDestroyResult;
-declare function useResourceDestroy(id: string | null): UseResourceDestroyResult;
-declare function useResourceDestroy(resource: Resource | string, id: string | null): UseResourceDestroyResult;
-declare function useResourceDestroy(id: string | null, options: UseMutationOptions): 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 useResourceDestroy(resource: Resource | string): any;
+declare function useResourceDestroy(id: string | null): any;
+declare function useResourceDestroy(resource: Resource | string, id: string | null): any;
+declare function useResourceDestroy(id: string | null, options: UseMutationOptions): any;
+declare function useResourceDestroy(resource: Resource | string, id: string | null, options: UseMutationOptions): any;
+
+declare function useResourceItem(id: string | null): any;
+declare function useResourceItem(id: string | null, opts: any): any;
+declare function useResourceItem(resource: Resource | string | null, id: string | null): any;
+declare function useResourceItem(resource: Resource | string | null, id: string | null, opts: any): any;
 
-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(): any;
+declare function useResourceItems(resource: Resource | string): any;
+declare function useResourceItems(resource: Resource | string, query: Record<string, unknown> | null): any;
+declare function useResourceItems(resource: Resource | string, query: Record<string, unknown> | null, page: number | null): any;
+declare function useResourceItems(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(query: Record<string, unknown> | null): any;
+declare function useResourceItems(query: Record<string, unknown> | null, page: number | null): any;
+declare function useResourceItems(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;
-    loading: boolean;
-};
+declare function useResourceStore(resource: Resource | string, options: any): any;
+declare function useResourceStore(options: any): any;
 
-declare function useResourceUpdate(resource: any, id: any): {
-    update: (data: any) => any;
-    loading: boolean;
-};
+declare function useResourceUpdate(resource: Resource | string, id: string, options: any): any;
+declare function useResourceUpdate(id: string, options: any): any;
 
-declare function useResourceClone(resource: any, id?: any): {
-    clone: (providedId: any) => any;
-    loading: boolean;
-};
+declare function useResourceClone(resource: Resource | string): any;
+declare function useResourceClone(id: string | null): any;
+declare function useResourceClone(resource: Resource | string, id: string | null): any;
+declare function useResourceClone(id: string | null, options: UseMutationOptions): any;
+declare function useResourceClone(resource: Resource | string, id: string | null, options: UseMutationOptions): any;
 
-declare function useResourceRestore(resource: any, id?: any): {
-    restore: (providedId: any) => any;
-    loading: boolean;
-};
+declare function useResourceRestore(resource: Resource | string): any;
+declare function useResourceRestore(id: string | null): any;
+declare function useResourceRestore(resource: Resource | string, id: string | null): any;
+declare function useResourceRestore(id: string | null, options: UseMutationOptions): any;
+declare function useResourceRestore(resource: Resource | string, id: string | null, options: UseMutationOptions): any;
 
+interface ApiOptions {
+    baseUrl?: string | null;
+    routes?: Record<string, string>;
+    generateUrl?: ((routeName: string, params?: Record<string, unknown>) => string | null) | null;
+    onUnauthorized?: (() => void) | null;
+}
 declare class Base {
-    constructor(opts?: {});
-    options: {
-        baseUrl: any;
-        onUnauthorized: any;
-        routes: {};
-        generateUrl: any;
-    };
-    requestGet(path: any, query?: any, opts?: any): Promise<unknown>;
-    requestPost(path: any, data: any, opts?: any): Promise<unknown>;
-    requestPut(path: any, data: any, opts?: any): Promise<unknown>;
-    requestPatch(path: any, data: any, opts?: any): Promise<unknown>;
-    requestDelete(path: any): Promise<unknown>;
-    hasRoute(route: any): boolean;
-    route(route: any, params: any): any;
-    getFullUrl(path: any): any;
-    onError(err: any): any;
+    options: ApiOptions;
+    constructor(opts: ApiOptions);
+    requestGet<T = unknown>(path: string, query?: Record<string, unknown> | null, opts?: Record<string, unknown> | null): Promise<T | null>;
+    requestPost<T = unknown>(path: string, data?: Record<string, unknown> | null, opts?: Record<string, unknown> | null): Promise<T | null>;
+    requestPut<T = unknown>(path: string, data: Record<string, unknown>, opts?: Record<string, unknown> | null): Promise<T>;
+    requestPatch<T = unknown>(path: string, data: Record<string, unknown>, opts?: Record<string, unknown> | null): Promise<T | null>;
+    requestDelete<T = unknown>(path: string, opts?: Record<string, unknown> | null): Promise<T | null>;
+    hasRoute(route: string): boolean;
+    route(route: string, params?: Record<string, unknown> | null): string;
+    getFullUrl(path: string, query?: Record<string, unknown> | null): string;
+    onError(err: any): void;
 }
 
-declare class AuthApi {
-    constructor(api: any, opts: any);
-    api: any;
-    options: any;
-    check(): any;
-    login(email: any, password: any): any;
-    register(data: any): any;
-    logout(): Promise<Response>;
-    requestPassword(email: any): any;
-    resetPassword(data: any): any;
+declare class AccountApi extends Base {
+    constructor(opts: any);
+    update(data: any): Promise<unknown>;
+    updatePassword(data: any): Promise<unknown>;
+    delete(data: any): Promise<unknown>;
 }
 
-declare class AccountApi {
-    constructor(api: any, opts: any);
-    api: any;
-    options: any;
-    update(data: any): any;
-    updatePassword(data: any): any;
-    updateTaxes(data: any): any;
-    delete(data: any): any;
+declare class AuthApi extends Base {
+    constructor(opts: any);
+    check(): Promise<unknown>;
+    login(email: any, password: any): Promise<unknown>;
+    register(data: any): Promise<unknown>;
+    logout(): Promise<unknown>;
+    requestPassword(email: any): Promise<unknown>;
+    resetPassword(data: any): Promise<unknown>;
 }
 
 declare class MediasApi extends Base {
+    constructor(opts: any);
     find(id: any): Promise<unknown>;
-    get(query?: {}, page?: number, count?: number): Promise<unknown>;
-    getTrashed(query?: {}, page?: number, count?: number): Promise<unknown>;
-    getTags(query?: {}, count?: number): Promise<unknown>;
-    create(data: any): Promise<unknown>;
-    update(id: any, data: any): Promise<unknown>;
-    trash(id: any): Promise<unknown>;
-    restore(id: any): Promise<unknown>;
-    destroy(id: any): Promise<unknown>;
-    replace(id: any, data: any): Promise<unknown>;
+    get(query?: Record<string, unknown>, page?: number | null, count?: number | null): Promise<unknown>;
+    getTrashed(query?: Record<string, unknown>, page?: number | null, count?: number | null): Promise<unknown>;
+    getTags(query?: Record<string, unknown>, count?: number | null): Promise<unknown>;
+    create(data: Record<string, unknown>): Promise<unknown>;
+    update(id: string, data: Record<string, unknown>): Promise<unknown>;
+    trash(id: string): Promise<unknown>;
+    restore(id: string): Promise<unknown>;
+    destroy(id: string): Promise<unknown>;
+    replace(id: string, data: Record<string, unknown>): Promise<unknown>;
 }
 
-declare class ResourcesApi {
-    constructor(api: any);
-    api: any;
-    resourceRoute({ id, has_routes: hasRoutes }: {
-        id: any;
-        has_routes?: boolean;
-    }, route: any, params: any): any;
-    find(resource: any, id: any): any;
-    get(resource: any, query?: {}, page?: number, count?: number): any;
-    store(resource: any, data: any): any;
-    update(resource: any, id: any, data: any): any;
-    destroy(resource: any, id: any): any;
-    clone(resource: any, id: any, data?: any): any;
-    restore(resource: any, id: any, data?: any): any;
+type ItemsResponse<T> = {
+    data: T[];
+    pagination: Pagination;
+    meta?: Pagination;
+} | T[];
+declare class ResourcesApi extends Base {
+    constructor(opts: any);
+    find<T = ResourceItem>(resource: Resource, id: string, opts?: Record<string, unknown> | null): Promise<T>;
+    get<T = ResourceItem, TResponse = ItemsResponse<T>>(resource: Resource, query: Record<string, unknown>, page?: number, count?: number, opts?: Record<string, unknown> | null): Promise<TResponse>;
+    store<T = ResourceItem>(resource: Resource, data: Record<string, unknown>, opts?: Record<string, unknown> | null): Promise<T>;
+    update<T = ResourceItem>(resource: Resource, id: string, data: Record<string, unknown>, opts?: Record<string, unknown> | null): Promise<T>;
+    destroy<T = unknown>(resource: Resource, id: string, opts?: Record<string, unknown> | null): Promise<T>;
+    clone<T = ResourceItem>(resource: Resource, id: string, data?: Record<string, unknown> | null, opts?: Record<string, unknown> | null): Promise<T>;
+    restore<T = ResourceItem>(resource: Resource, id: string, data?: Record<string, unknown> | null, opts?: Record<string, unknown> | null): Promise<T>;
+    resourceRoute({ id }: Resource, route: string, params?: Record<string, unknown> | null): string | null;
 }
 
 declare class Api extends Base {
+    resources: ResourcesApi;
+    medias: MediasApi;
     auth: AuthApi;
     account: AccountApi;
-    medias: MediasApi;
-    resources: ResourcesApi;
+    constructor(opts: any);
 }
 
+declare function useApi(): Api;
 interface ApiProviderProps {
     api?: Api | null;
     baseUrl?: string;
     onUnauthorized?: (() => void) | null;
+    routes?: Record<string, string> | null;
     children: ReactNode;
 }
-declare function useApi(): Api;
-declare function ApiProvider({ api: initialApi, baseUrl, onUnauthorized, children, }: ApiProviderProps): react.JSX.Element;
+declare function ApiProvider({ api: initialApi, baseUrl, onUnauthorized, routes: apiRoutes, children, }: ApiProviderProps): react.JSX.Element;
 
 type QueryInitialData = Record<string, unknown> | Array<Record<string, unknown>>;
 interface QueryProviderProps {
@@ -244,6 +442,7 @@ declare function QueryProvider({ config: initialConfig, initialKey, initialData,
 interface DataProviderProps {
     api?: Api | null;
     apiBaseUrl?: string;
+    routes?: Record<string, string> | null;
     baseUrl?: string;
     queryConfig?: QueryClientConfig | null;
     initialQueryKey?: string[] | null;
@@ -251,7 +450,7 @@ interface DataProviderProps {
     onUnauthorized?: (() => void) | null;
     children?: ReactNode;
 }
-declare function DataProvider({ api, apiBaseUrl, baseUrl, children, queryConfig, initialQueryKey, initialQueryData, onUnauthorized, }: DataProviderProps): react.JSX.Element;
+declare function DataProvider({ api, apiBaseUrl, routes, baseUrl, children, queryConfig, initialQueryKey, initialQueryData, onUnauthorized, }: DataProviderProps): react.JSX.Element;
 
-export { Api, ApiProvider, Base as BaseApi, DataProvider, QueryProvider, useApi, useItem, useItems, 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, useResourceStore, useResourceUpdate };
 export type { UseItemsResponse };