@panneau/data 4.1.0 → 5.0.0-alpha.0

package/dist/index.d.ts

@@ -1,456 +1,4 @@
-import * as _tanstack_react_query from '@tanstack/react-query';
-import { UseQueryOptions, UseMutationOptions, QueryClientConfig, QueryClient } from '@tanstack/react-query';
-import { Item, Pagination, Resource, ResourceItem, Media } from '@panneau/core';
-import * as react from 'react';
-import { ReactNode } from 'react';
-
-declare function useItem<T = Item>(scope: any, id: any, loader: (id: any) => Promise<T>, opts?: any): {
-    error: Error;
-    isError: true;
-    isPending: false;
-    isLoading: false;
-    isLoadingError: false;
-    isRefetchError: true;
-    isSuccess: false;
-    isPlaceholderData: false;
-    status: "error";
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    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<T, Error>>;
-    fetchStatus: _tanstack_react_query.FetchStatus;
-    item: T;
-} | {
-    error: null;
-    isError: false;
-    isPending: false;
-    isLoading: false;
-    isLoadingError: false;
-    isRefetchError: false;
-    isSuccess: true;
-    isPlaceholderData: false;
-    status: "success";
-    dataUpdatedAt: number;
-    errorUpdatedAt: number;
-    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<T, Error>>;
-    fetchStatus: _tanstack_react_query.FetchStatus;
-    item: T;
-};
-
-type UseItemsResponse<T> = {
-    data: T[];
-    pagination: Pagination;
-    meta?: Pagination;
-} | T[];
-type UseItemsKey = [string, Record<string, unknown> | null, number | null, number | null];
-type Query = {
-    page?: number | null;
-    count?: number | null;
-    [key: string]: unknown;
-};
-type UseItemsOptions<T> = Omit<UseQueryOptions<UseItemsResponse<T>, Error, UseItemsResponse<T>, UseItemsKey>, 'queryKey' | 'queryFn'> & {
-    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?: Query | null;
-    keepData?: boolean;
-};
-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;
-    isPlaceholderData: boolean;
-    items: any;
-    pages: {};
-    allItems: any;
-    loading: boolean;
-    loaded: boolean;
-    reload: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<UseItemsResponse<T>, Error>>;
-    updateItem: (item: any) => void;
-    pagination: {
-        page: number;
-        lastPage: number;
-        total: number;
-    };
-    error: Error;
-    isError: true;
-    isPending: false;
-    isLoadingError: false;
-    isRefetchError: true;
-    isSuccess: 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;
-} | {
-    isLoading: boolean;
-    isFetching: boolean;
-    isRefetching: boolean;
-    isFetched: boolean;
-    isPlaceholderData: boolean;
-    items: any;
-    pages: {};
-    allItems: any;
-    loading: boolean;
-    loaded: boolean;
-    reload: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<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;
-    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;
-} | {
-    isLoading: boolean;
-    isFetching: boolean;
-    isRefetching: boolean;
-    isFetched: boolean;
-    isPlaceholderData: boolean;
-    items: any;
-    pages: {};
-    allItems: any;
-    loading: boolean;
-    loaded: boolean;
-    reload: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<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;
-    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;
-} | {
-    isLoading: boolean;
-    isFetching: boolean;
-    isRefetching: boolean;
-    isFetched: boolean;
-    isPlaceholderData: boolean;
-    items: any;
-    pages: {};
-    allItems: any;
-    loading: boolean;
-    loaded: boolean;
-    reload: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<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;
-    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;
-} | {
-    isLoading: boolean;
-    isFetching: boolean;
-    isRefetching: boolean;
-    isFetched: boolean;
-    isPlaceholderData: boolean;
-    items: any;
-    pages: {};
-    allItems: any;
-    loading: boolean;
-    loaded: boolean;
-    reload: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<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;
-    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;
-} | {
-    isLoading: boolean;
-    isFetching: boolean;
-    isRefetching: boolean;
-    isFetched: boolean;
-    isPlaceholderData: boolean;
-    items: any;
-    pages: {};
-    allItems: any;
-    loading: boolean;
-    loaded: boolean;
-    reload: (options?: _tanstack_react_query.RefetchOptions) => Promise<_tanstack_react_query.QueryObserverResult<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;
-    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;
-};
-
-type MutationOptions$2 = UseMutationOptions<unknown, Error, string | void>;
-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(resource: Resource | string, options: MutationOptions$2): any;
-declare function useResourceDestroy(id: string | null, options: MutationOptions$2): any;
-declare function useResourceDestroy(resource: Resource | string, id: string | null, options: MutationOptions$2): 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(): 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(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 useResourceStore(resource: Resource | string, options: any): any;
-declare function useResourceStore(options: any): any;
-
-declare function useResourceUpdate(resource: Resource | string, id: string): any;
-declare function useResourceUpdate(resource: Resource | string, id: string, options: UseMutationOptions): any;
-declare function useResourceUpdate(id: string): any;
-declare function useResourceUpdate(id: string, options: UseMutationOptions): any;
-
-type MutationOptions$1 = UseMutationOptions<unknown, Error, string | void>;
-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(resource: Resource | string, options: MutationOptions$1): any;
-declare function useResourceClone(id: string | null, options: MutationOptions$1): any;
-declare function useResourceClone(resource: Resource | string, id: string | null, options: MutationOptions$1): any;
-
-type MutationOptions = UseMutationOptions<unknown, Error, string | void>;
-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(resource: Resource | string, options: MutationOptions): any;
-declare function useResourceRestore(id: string | null, options: MutationOptions): any;
-declare function useResourceRestore(resource: Resource | string, id: string | null, options: MutationOptions): 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 {
-    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 | null;
-    getFullUrl(path: string | null, query?: Record<string, unknown> | null): string;
-    onError(err: any): void;
-}
-
-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 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: string): Promise<Media>;
-    get(query?: Record<string, unknown>, page?: number | null, count?: number | null): Promise<UseItemsResponse<Media>>;
-    getTrashed(query?: Record<string, unknown>, page?: number | null, count?: number | null): Promise<UseItemsResponse<Media>>;
-    getTags(query?: Record<string, unknown>, count?: number | null): Promise<unknown>;
-    create(data: Record<string, unknown>): Promise<Media>;
-    update(id: string, data: Record<string, unknown>): Promise<Media>;
-    trash(id: string): Promise<unknown>;
-    restore(id: string): Promise<Media>;
-    destroy(id: string): Promise<unknown>;
-    replace(id: string, data: Record<string, unknown>): Promise<Media>;
-}
-
-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;
-    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 ApiProvider({ api: initialApi, baseUrl, onUnauthorized, routes: apiRoutes, children, }: ApiProviderProps): react.JSX.Element;
-
-type QueryInitialData = Record<string, unknown> | Array<Record<string, unknown>>;
-interface QueryProviderProps {
-    config?: QueryClientConfig | null;
-    initialKey?: string[] | null;
-    initialData?: QueryInitialData | null;
-    children: ReactNode;
-}
-declare function useQueryContext(): QueryClient;
-declare function QueryProvider({ config: initialConfig, initialKey, initialData, children, }: QueryProviderProps): react.JSX.Element;
-
-interface DataProviderProps {
-    api?: Api | null;
-    apiBaseUrl?: string;
-    routes?: Record<string, string> | null;
-    baseUrl?: string;
-    queryConfig?: QueryClientConfig | null;
-    initialQueryKey?: string[] | null;
-    initialQueryData?: Record<string, unknown> | Array<Record<string, unknown>> | null;
-    onUnauthorized?: (() => void) | null;
-    children?: ReactNode;
-}
-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, useResourceStore, useResourceUpdate };
-export type { UseItemsResponse };
+export type { ActionResponse, DataAdapter, LoginCredentials, MediaQuery, RequestOptions, UpdateOptions, Values, } from './adapter';
+export { ApiError, ConflictError, ForbiddenError, InvalidResponseError, NotFoundError, UnauthorizedError, ValidationError, createApiError, isApiError, } from './errors';
+export { type RestAdapterOptions, createRestAdapter } from './rest';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EACR,cAAc,EACd,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,cAAc,EACd,aAAa,EACb,MAAM,GACT,MAAM,WAAW,CAAC;AACnB,OAAO,EACH,QAAQ,EACR,aAAa,EACb,cAAc,EACd,oBAAoB,EACpB,aAAa,EACb,iBAAiB,EACjB,eAAe,EACf,cAAc,EACd,UAAU,GACb,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,KAAK,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,QAAQ,CAAC"}