@web-ts-toolkit/access-router-client 0.3.0 → 0.5.0

package/README.md

@@ -1,27 +1,36 @@
-# @web-ts-toolkit/access-router-client
+# `@web-ts-toolkit/access-router-client`
 
-`@web-ts-toolkit/access-router-client` is a TypeScript/JavaScript client for `@web-ts-toolkit/access-router` APIs.
+Typed client utilities for `@web-ts-toolkit/access-router` APIs.
 
 ## Installation
 
-```sh
-npm install @web-ts-toolkit/access-router-client
-```
-
 ```sh
 pnpm add @web-ts-toolkit/access-router-client
 ```
 
-## Usage
+## Highlights
+
+- typed model and data services
+- lazy requests that can be grouped into one batch call
+- `Model<T>` wrappers with dirty tracking and `save()`
+- normalized response and error handling around Axios
+
+## Quick Start
 
 ```ts
 import { createAdapter } from '@web-ts-toolkit/access-router-client';
 
+type User = {
+  _id?: string;
+  name: string;
+  role: string;
+};
+
 const adapter = createAdapter({
   baseURL: 'http://localhost:3000/api',
 });
 
-const userService = adapter.createModelService<{ _id?: string; name: string; role: string }>({
+const userService = adapter.createModelService<User>({
   modelName: 'User',
   basePath: 'users',
 });
@@ -32,14 +41,32 @@ const listResponse = await userService.listAdvanced(
   { includeCount: true },
 );
 
+const user = await userService.read('user-id-1');
+
+user.data.role = 'owner';
+await user.data.save();
+
 const grouped = await adapter.group(
   userService.readAdvanced('user-id-1', { select: ['name'] }),
   userService.countAdvanced({ role: 'admin' }),
 );
 ```
 
-Notes:
+## Main Exports
+
+- `createAdapter(...)`
+- `ModelService`
+- `DataService`
+- `Model`
+- response and query helper types
+
+## Documentation
+
+Full package documentation lives in `website/docs/packages/access-router-client/`.
 
-- model and data service requests use the router paths you configure in `basePath`
-- grouped `adapter.group(...)` requests target the root router path, which defaults to `root`
-- if your root router uses another path, pass `rootRouterPath` as the second `createAdapter(...)` argument
+- live docs: https://web-ts-toolkit.pages.dev/docs/packages/access-router-client
+- overview: `website/docs/packages/access-router-client/index.md`
+- adapter: `website/docs/packages/access-router-client/adapter.mdx`
+- services: `website/docs/packages/access-router-client/services.mdx`
+- model wrapper: `website/docs/packages/access-router-client/model.mdx`
+- typing and errors: `website/docs/packages/access-router-client/typescript-and-errors.mdx`

package/index.d.mts

@@ -1,34 +1,5 @@
 import * as axios from 'axios';
-import { AxiosRequestConfig, AxiosInstance, AxiosResponse, AxiosHeaders } from 'axios';
-
-declare class Model<T extends Document, TData extends Partial<T> = T> {
-    private _data;
-    private _snapshot;
-    private readonly _service;
-    private modifiedPaths;
-    constructor(data: TData, adapter: ModelService<T>);
-    static create<T, TData extends Partial<T> = T>(data: TData, adapter: ModelService<T>): Model<T, TData> & TData;
-    save(reqConfig?: AxiosRequestConfig): Promise<any>;
-    isDirty(path?: keyof TData | string): boolean;
-    markModified(path: keyof TData | string): this;
-    get<TKey extends keyof TData>(path: TKey): TData[TKey];
-    get(path: string): unknown;
-    set<TKey extends keyof TData>(path: TKey, value: TData[TKey]): this;
-    set(path: string, value: unknown): this;
-    assign(partial: Partial<TData>): this;
-    reset(): this;
-    toObject(): TData;
-    toJSON(): TData;
-    private updateModel;
-    private replaceData;
-    private initializeDirtyState;
-    private prepareData;
-    private defineHiddenDataProp;
-    private defineHiddenAdapterProp;
-    private definePublicDataProps;
-    private trackModified;
-    private normalizePath;
-}
+import { AxiosInstance, AxiosResponse, AxiosRequestConfig, AxiosHeaders } from 'axios';
 
 interface SubQueryOptions {
     path?: string;
@@ -186,6 +157,195 @@ interface AdditionalReqConfig {
     throwOnError?: boolean;
 }
 
+interface ResultError {
+    success: boolean;
+    raw: unknown;
+    data: unknown;
+    message: string;
+    status: number;
+    headers: Record<string, unknown>;
+}
+declare class Service {
+    protected _axios: AxiosInstance;
+    protected _basePath: string;
+    private _wrap;
+    constructor(axios: AxiosInstance, basePath: string);
+    protected handleSuccess(res: AxiosResponse<unknown, unknown>, extra?: {}): Response<unknown>;
+    protected handleError<T extends ResultError>(error: {
+        response?: {
+            status: number;
+            headers: Record<string, unknown>;
+            data: unknown;
+        };
+        request?: unknown;
+        message?: string;
+    }): T;
+    wrapGet<T = unknown>(url: string, defaultAxiosRequestConfig?: AxiosRequestConfig): (options?: WrapOptions, requestConfig?: AxiosRequestConfig) => Promise<AxiosResponse<T, any, {}>>;
+    wrapPost<T = unknown>(url: string, defaultAxiosRequestConfig?: AxiosRequestConfig): (data?: unknown, options?: WrapOptions, requestConfig?: AxiosRequestConfig) => Promise<AxiosResponse<T, any, {}>>;
+    wrapPut<T = unknown>(url: string, defaultAxiosRequestConfig?: AxiosRequestConfig): (data?: unknown, options?: WrapOptions, requestConfig?: AxiosRequestConfig) => Promise<AxiosResponse<T, any, {}>>;
+    wrapPatch<T = unknown>(url: string, defaultAxiosRequestConfig?: AxiosRequestConfig): (data?: unknown, options?: WrapOptions, requestConfig?: AxiosRequestConfig) => Promise<AxiosResponse<T, any, {}>>;
+    wrapDelete<T = unknown>(url: string, defaultAxiosRequestConfig?: AxiosRequestConfig): (options?: WrapOptions, requestConfig?: AxiosRequestConfig) => Promise<AxiosResponse<T, any, {}>>;
+    updateHeaders(headers: AxiosRequestConfig['headers'], { ignoreCache }: {
+        ignoreCache?: boolean;
+    }): AxiosHeaders | (Partial<axios.RawAxiosHeaders & {
+        Accept: axios.AxiosHeaderValue;
+        "Content-Length": axios.AxiosHeaderValue;
+        "User-Agent": axios.AxiosHeaderValue;
+        "Content-Encoding": axios.AxiosHeaderValue;
+        Authorization: axios.AxiosHeaderValue;
+        Location: axios.AxiosHeaderValue;
+    } & {
+        'Content-Type': axios.AxiosHeaderValue;
+    }> & Partial<{
+        get: AxiosHeaders;
+        delete: AxiosHeaders;
+        head: AxiosHeaders;
+        options: AxiosHeaders;
+        post: AxiosHeaders;
+        put: AxiosHeaders;
+        patch: AxiosHeaders;
+        purge: AxiosHeaders;
+        link: AxiosHeaders;
+        unlink: AxiosHeaders;
+        query: AxiosHeaders;
+    } & {
+        common: AxiosHeaders;
+    }>);
+}
+declare class ServiceError extends Error {
+    success: boolean;
+    raw: unknown;
+    data: unknown;
+    status: number;
+    headers: Record<string, unknown>;
+    constructor(result: ResultError);
+}
+
+type RequestConfig$1 = AxiosRequestConfig & AdditionalReqConfig;
+interface Props$1 {
+    axios: AxiosInstance;
+    modelName: string;
+    basePath: string;
+    queryPath: string;
+    mutationPath: string;
+    onSuccess: ResponseCallback;
+    onFailure: ResponseCallback;
+    throwOnError: boolean;
+}
+declare class ModelService<T extends Document> extends Service {
+    private _modelName;
+    private _queryPath;
+    private _mutationPath;
+    private _handleCallbacks;
+    private _defaults;
+    constructor({ axios, modelName, basePath, queryPath, mutationPath, onSuccess, onFailure, throwOnError }: Props$1, defaults?: Defaults);
+    list<TData extends Partial<T> = T>(args?: ListArgs, options?: ListOptions, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & LazyRequest<ListModelResponse<T, TData>>;
+    listAdvanced<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(filter: FilterQuery<T>, args?: ListAdvancedArgs<TSelect>, options?: ListAdvancedOptions, axiosRequestConfig?: RequestConfig$1): ModelRequest<ListModelResponse<T, ResolvedSelectedShape<T, TSelect, TData>>>;
+    create<TData extends Partial<T> = T>(data: object, options?: CreateOptions, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & LazyRequest<ModelResponse<T, TData>>;
+    createAdvanced<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(data: object, args?: CreateAdvancedArgs<TSelect>, options?: CreateAdvancedOptions, axiosRequestConfig?: RequestConfig$1): ModelRequest<ModelResponse<T, ResolvedSelectedShape<T, TSelect, TData>>>;
+    upsert<TData extends Partial<T> = T>(data: object, options?: UpsertOptions, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & LazyRequest<ModelResponse<T, TData>>;
+    upsertAdvanced<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(data: object, args?: UpsertAdvancedArgs<TSelect>, options?: UpsertAdvancedOptions, axiosRequestConfig?: RequestConfig$1): ModelRequest<ModelResponse<T, ResolvedSelectedShape<T, TSelect, TData>>>;
+    delete(identifier: string, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & LazyRequest<Response<string, string>>;
+    new<TData extends Partial<T> = T>(axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & LazyRequest<ModelResponse<T, TData>>;
+    distinct(field: string, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & LazyRequest<Response<string[], string[]>>;
+    distinctAdvanced(field: string, conditions: FilterQuery<T>, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & LazyRequest<Response<string[], string[]>>;
+    count(axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & LazyRequest<Response<number, number>>;
+    countAdvanced(filter: FilterQuery<T>, args?: {
+        access?: 'list' | 'read';
+    }, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & LazyRequest<Response<number, number>>;
+    read<TData extends Partial<T> = T>(identifier: string, options?: ReadOptions, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & LazyRequest<ModelResponse<T, TData>>;
+    readAdvanced<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(identifier: string, args?: ReadAdvancedArgs<TSelect>, options?: ReadAdvancedOptions, axiosRequestConfig?: RequestConfig$1): ModelRequest<ModelResponse<T, ResolvedSelectedShape<T, TSelect, TData>>>;
+    readAdvancedFilter<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(filter: FilterQuery<T>, args?: ReadAdvancedArgs<TSelect>, options?: ReadAdvancedOptions, axiosRequestConfig?: RequestConfig$1): ModelRequest<ModelResponse<T, ResolvedSelectedShape<T, TSelect, TData>>>;
+    update<TData extends Partial<T> = T>(identifier: string, data: object, options?: UpdateOptions, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & LazyRequest<ModelResponse<T, TData>>;
+    updateAdvanced<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(identifier: string, data: object, args?: UpdateAdvancedArgs<TSelect>, options?: UpdateAdvancedOptions, axiosRequestConfig?: RequestConfig$1): ModelRequest<ModelResponse<T, ResolvedSelectedShape<T, TSelect, TData>>>;
+    id(id: string): {
+        subs: <S = T>(field: keyof T) => {
+            list: (axiosRequestConfig?: AxiosRequestConfig<any> & {
+                throwOnError?: boolean;
+            }) => ModelPromiseMeta & LazyRequest<ListModelResponse<S>>;
+            listAdvanced: <TData extends Partial<S> = never, TSelect extends readonly string[] = readonly string[]>(filter?: FilterQuery<S>, args?: {
+                select?: TSelect;
+            }, axiosRequestConfig?: AxiosRequestConfig<any> & {
+                throwOnError?: boolean;
+            }) => ModelPromiseMeta & LazyRequest<ListModelResponse<S, ResolvedSelectedShape<S, TSelect, TData>>>;
+            read: (subId: string, axiosRequestConfig?: AxiosRequestConfig<any> & {
+                throwOnError?: boolean;
+            }) => ModelPromiseMeta & LazyRequest<ModelResponse<S>>;
+            readAdvanced: <TData extends Partial<S> = never, TSelect_1 extends readonly string[] = readonly string[]>(subId: string, args?: {
+                select?: TSelect_1;
+                populate?: unknown;
+            }, axiosRequestConfig?: AxiosRequestConfig<any> & {
+                throwOnError?: boolean;
+            }) => ModelPromiseMeta & LazyRequest<ModelResponse<S, ResolvedSelectedShape<S, TSelect_1, TData>>>;
+            update: (subId: string, data: object, axiosRequestConfig?: AxiosRequestConfig<any> & {
+                throwOnError?: boolean;
+            }) => ModelPromiseMeta & LazyRequest<ModelResponse<S>>;
+            bulkUpdate: (data: object[], axiosRequestConfig?: AxiosRequestConfig<any> & {
+                throwOnError?: boolean;
+            }) => ModelPromiseMeta & LazyRequest<ListModelResponse<S>>;
+            create: (data: object, axiosRequestConfig?: AxiosRequestConfig<any> & {
+                throwOnError?: boolean;
+            }) => ModelPromiseMeta & LazyRequest<ModelResponse<S>>;
+            delete: (subId: string, axiosRequestConfig?: AxiosRequestConfig<any> & {
+                throwOnError?: boolean;
+            }) => ModelPromiseMeta & LazyRequest<Response<string, string>>;
+        };
+        fetch: (args?: ReadAdvancedArgs, options?: ReadAdvancedOptions, axiosRequestConfig?: RequestConfig$1) => ModelRequest<ModelResponse<T, Partial<T>>>;
+    };
+}
+
+type RequestConfig = AxiosRequestConfig & AdditionalReqConfig;
+interface Props {
+    axios: AxiosInstance;
+    dataName: string;
+    basePath: string;
+    queryPath: string;
+    onSuccess: ResponseCallback;
+    onFailure: ResponseCallback;
+    throwOnError: boolean;
+}
+declare class DataService<T> extends Service {
+    private _dataName;
+    private _queryPath;
+    private _handleCallbacks;
+    private _defaults;
+    constructor({ axios, dataName, basePath, queryPath, onSuccess, onFailure, throwOnError }: Props, defaults?: DataDefaults);
+    list<TData extends Partial<T> = T>(args?: DataListArgs, options?: DataListOptions, axiosRequestConfig?: RequestConfig): DataPromiseMeta & LazyRequest<ListDataResponse<TData>>;
+    listAdvanced<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(filter: FilterQuery<T>, args?: DataListAdvancedArgs<TSelect>, options?: DataListAdvancedOptions, axiosRequestConfig?: RequestConfig): DataRequest<ListDataResponse<ResolvedSelectedShape<T, TSelect, TData>>>;
+    read<TData extends Partial<T> = T>(identifier: string, options?: DataReadOptions, axiosRequestConfig?: RequestConfig): DataPromiseMeta & LazyRequest<DataResponse<TData>>;
+    readAdvanced<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(identifier: string, args?: DataReadAdvancedArgs<TSelect>, options?: DataReadAdvancedOptions, axiosRequestConfig?: RequestConfig): DataRequest<DataResponse<ResolvedSelectedShape<T, TSelect, TData>>>;
+    readAdvancedFilter<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(filter: FilterQuery<T>, args?: DataReadAdvancedArgs<TSelect>, options?: DataReadAdvancedOptions, axiosRequestConfig?: RequestConfig): DataRequest<DataResponse<ResolvedSelectedShape<T, TSelect, TData>>>;
+}
+
+declare class Model<T extends Document, TData extends Partial<T> = T> {
+    private _data;
+    private _snapshot;
+    private readonly _service;
+    private modifiedPaths;
+    constructor(data: TData, adapter: ModelService<T>);
+    static create<T, TData extends Partial<T> = T>(data: TData, adapter: ModelService<T>): Model<T, TData> & TData;
+    save(reqConfig?: AxiosRequestConfig): Promise<any>;
+    isDirty(path?: keyof TData | string): boolean;
+    markModified(path: keyof TData | string): this;
+    get<TKey extends keyof TData>(path: TKey): TData[TKey];
+    get(path: string): unknown;
+    set<TKey extends keyof TData>(path: TKey, value: TData[TKey]): this;
+    set(path: string, value: unknown): this;
+    assign(partial: Partial<TData>): this;
+    reset(): this;
+    toObject(): TData;
+    toJSON(): TData;
+    private updateModel;
+    private replaceData;
+    private initializeDirtyState;
+    private prepareData;
+    private defineHiddenDataProp;
+    private defineHiddenAdapterProp;
+    private definePublicDataProps;
+    private trackModified;
+    private normalizePath;
+}
+
 type AnyArray<T> = T[] | ReadonlyArray<T>;
 type Unpacked<T> = T extends (infer U)[] ? U : T extends ReadonlyArray<infer U> ? U : T;
 type ApplyBasicQueryCasting<T> = T | T[] | (T extends (infer U)[] ? U : unknown) | unknown;
@@ -236,6 +396,13 @@ type QuerySelector<T> = {
     $options?: T extends string ? string : never;
 };
 
+/**
+ * Wraps a lazy promise function with optional metadata.
+ * The promise is only created when `.then()`, `.catch()`, `.finally()`, or `.exec()` is called.
+ * Metadata properties are merged onto the returned object via `Object.assign`.
+ */
+declare const wrapLazyPromise: <T, M = undefined>(promiseFn: () => Promise<T>, meta?: M) => M & LazyRequest<T>;
+
 type KeyValueProjection<TKey extends string = string> = Partial<Record<TKey, 1 | -1>>;
 type Projection = readonly string[] | string | KeyValueProjection;
 type SelectableKey<T> = Extract<keyof T, string>;
@@ -306,6 +473,7 @@ interface RootModelQueryMeta {
     data?: unknown;
     args?: Record<string, unknown>;
     options?: Record<string, unknown>;
+    order?: number;
     sqOptions?: SubQueryOptions;
 }
 interface RootDataQueryMeta {
@@ -317,17 +485,9 @@ interface RootDataQueryMeta {
     data?: unknown;
     args?: Record<string, unknown>;
     options?: Record<string, unknown>;
+    order?: number;
 }
 type RootQueryMeta = RootModelQueryMeta | RootDataQueryMeta;
-interface SubQueryMeta {
-    model: string;
-    op: 'list' | 'read';
-    id?: string;
-    filter?: unknown;
-    args?: Record<string, unknown>;
-    options?: Record<string, unknown>;
-    sqOptions?: SubQueryOptions;
-}
 interface ModelPromiseMeta {
     __op: string;
     __query: RootModelQueryMeta;
@@ -337,6 +497,7 @@ interface ModelPromiseMeta {
 interface LazyRequest<T> extends Promise<T> {
     exec(): Promise<T>;
 }
+type ModelRequest<T> = ModelPromiseMeta & LazyRequest<T>;
 type DataResponse<T> = Response<T, T>;
 type ArrayDataResponse<T> = Response<T[], T[]>;
 type ListDataResponse<T> = ArrayDataResponse<T> & {
@@ -348,158 +509,14 @@ interface DataPromiseMeta {
     __requestConfig?: AxiosRequestConfig;
     __service?: DataService<unknown>;
 }
-declare const wrapLazyPromise: <T, M = undefined>(promiseFn: () => Promise<T>, meta?: M) => M & LazyRequest<T>;
+type DataRequest<T> = DataPromiseMeta & LazyRequest<T>;
+
 type ResponseCallback = (res: unknown) => void;
 interface WrapOptions {
     queryParams?: Record<string, unknown>;
     pathParams?: Record<string, string | number>;
 }
 
-interface ResultError {
-    success: boolean;
-    raw: unknown;
-    data: unknown;
-    message: string;
-    status: number;
-    headers: Record<string, unknown>;
-}
-declare class Service {
-    protected _axios: AxiosInstance;
-    protected _basePath: string;
-    constructor(axios: AxiosInstance, basePath: string);
-    protected handleSuccess(res: AxiosResponse<unknown, unknown>, extra?: {}): Response<unknown>;
-    protected handleError<T extends ResultError>(error: {
-        response?: {
-            status: number;
-            headers: Record<string, unknown>;
-            data: unknown;
-        };
-        request?: unknown;
-        message?: string;
-    }): T;
-    wrapGet<T = unknown>(url: string, defaultAxiosRequestConfig?: AxiosRequestConfig): (options?: WrapOptions, axiosRequestConfig?: AxiosRequestConfig) => Promise<AxiosResponse<T, any, {}>>;
-    wrapPost<T = unknown>(url: string, defaultAxiosRequestConfig?: AxiosRequestConfig): (data?: unknown, options?: WrapOptions, axiosRequestConfig?: AxiosRequestConfig) => Promise<AxiosResponse<T, any, {}>>;
-    wrapPut<T = unknown>(url: string, defaultAxiosRequestConfig?: AxiosRequestConfig): (data?: unknown, options?: WrapOptions, axiosRequestConfig?: AxiosRequestConfig) => Promise<AxiosResponse<T, any, {}>>;
-    wrapPatch<T = unknown>(url: string, defaultAxiosRequestConfig?: AxiosRequestConfig): (data?: unknown, options?: WrapOptions, axiosRequestConfig?: AxiosRequestConfig) => Promise<AxiosResponse<T, any, {}>>;
-    wrapDelete<T = unknown>(url: string, defaultAxiosRequestConfig?: AxiosRequestConfig): (options?: WrapOptions, axiosRequestConfig?: AxiosRequestConfig) => Promise<AxiosResponse<T, any, {}>>;
-    updateHeaders(headers: AxiosRequestConfig['headers'], { ignoreCache }: {
-        ignoreCache?: boolean;
-    }): AxiosHeaders | (Partial<axios.RawAxiosHeaders & {
-        Accept: axios.AxiosHeaderValue;
-        "Content-Length": axios.AxiosHeaderValue;
-        "User-Agent": axios.AxiosHeaderValue;
-        "Content-Encoding": axios.AxiosHeaderValue;
-        Authorization: axios.AxiosHeaderValue;
-        Location: axios.AxiosHeaderValue;
-    } & {
-        'Content-Type': axios.AxiosHeaderValue;
-    }> & Partial<{
-        get: AxiosHeaders;
-        delete: AxiosHeaders;
-        head: AxiosHeaders;
-        options: AxiosHeaders;
-        post: AxiosHeaders;
-        put: AxiosHeaders;
-        patch: AxiosHeaders;
-        purge: AxiosHeaders;
-        link: AxiosHeaders;
-        unlink: AxiosHeaders;
-        query: AxiosHeaders;
-    } & {
-        common: AxiosHeaders;
-    }>);
-}
-declare class ServiceError extends Error {
-    success: boolean;
-    raw: unknown;
-    data: unknown;
-    status: number;
-    headers: Record<string, unknown>;
-    constructor(result: ResultError);
-}
-
-type RequestConfig$1 = AxiosRequestConfig & AdditionalReqConfig;
-interface Props$1 {
-    axios: AxiosInstance;
-    modelName: string;
-    basePath: string;
-    queryPath: string;
-    mutationPath: string;
-    onSuccess: ResponseCallback;
-    onFailure: ResponseCallback;
-    throwOnError: boolean;
-}
-declare class ModelService<T extends Document> extends Service {
-    private _modelName;
-    private _queryPath;
-    private _mutationPath;
-    private _handleCallbacks;
-    private _defaults;
-    constructor({ axios, modelName, basePath, queryPath, mutationPath, onSuccess, onFailure, throwOnError }: Props$1, defaults?: Defaults);
-    list<TData extends Partial<T> = T>(args?: ListArgs, options?: ListOptions, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & Promise<ListModelResponse<T, TData>>;
-    listAdvanced<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(filter: FilterQuery<T>, args?: ListAdvancedArgs<TSelect>, options?: ListAdvancedOptions, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & Promise<ListModelResponse<T, ResolvedSelectedShape<T, TSelect, TData>>>;
-    read<TData extends Partial<T> = T>(identifier: string, options?: ReadOptions, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & Promise<ModelResponse<T, TData>>;
-    readAdvanced<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(identifier: string, args?: ReadAdvancedArgs<TSelect>, options?: ReadAdvancedOptions, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & Promise<ModelResponse<T, ResolvedSelectedShape<T, TSelect, TData>>>;
-    readAdvancedFilter<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(filter: FilterQuery<T>, args?: ReadAdvancedArgs<TSelect>, options?: ReadAdvancedOptions, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & Promise<ModelResponse<T, ResolvedSelectedShape<T, TSelect, TData>>>;
-    new<TData extends Partial<T> = T>(axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & Promise<ModelResponse<T, TData>>;
-    create<TData extends Partial<T> = T>(data: object, options?: CreateOptions, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & Promise<ModelResponse<T, TData>>;
-    createAdvanced<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(data: object, args?: CreateAdvancedArgs<TSelect>, options?: CreateAdvancedOptions, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & Promise<ModelResponse<T, ResolvedSelectedShape<T, TSelect, TData>>>;
-    update<TData extends Partial<T> = T>(identifier: string, data: object, options?: UpdateOptions, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & Promise<ModelResponse<T, TData>>;
-    updateAdvanced<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(identifier: string, data: object, args?: UpdateAdvancedArgs<TSelect>, options?: UpdateAdvancedOptions, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & Promise<ModelResponse<T, ResolvedSelectedShape<T, TSelect, TData>>>;
-    upsert<TData extends Partial<T> = T>(data: object, options?: UpsertOptions, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & Promise<ModelResponse<T, TData>>;
-    upsertAdvanced<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(data: object, args?: UpsertAdvancedArgs<TSelect>, options?: UpsertAdvancedOptions, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & Promise<ModelResponse<T, ResolvedSelectedShape<T, TSelect, TData>>>;
-    delete(identifier: string, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & Promise<Response<string, string>>;
-    distinct(field: string, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & Promise<Response<string[], string[]>>;
-    distinctAdvanced(field: string, conditions: FilterQuery<T>, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & Promise<Response<string[], string[]>>;
-    count(axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & Promise<Response<number, number>>;
-    countAdvanced(filter: FilterQuery<T>, args?: {
-        access?: string;
-    }, axiosRequestConfig?: RequestConfig$1): ModelPromiseMeta & Promise<Response<number, number>>;
-    id(id: string): {
-        subs: <S = T>(field: keyof T) => {
-            list: (axiosRequestConfig?: RequestConfig$1) => ModelPromiseMeta & Promise<ListModelResponse<S>>;
-            listAdvanced: <TData extends Partial<S> | never = never, TSelect extends readonly string[] = readonly string[]>(filter?: FilterQuery<S>, args?: {
-                select?: TSelect;
-            }, axiosRequestConfig?: RequestConfig$1) => ModelPromiseMeta & Promise<ListModelResponse<S, ResolvedSelectedShape<S, TSelect, TData>>>;
-            read: (subId: string, axiosRequestConfig?: RequestConfig$1) => ModelPromiseMeta & Promise<ModelResponse<S>>;
-            readAdvanced: <TData extends Partial<S> | never = never, TSelect_1 extends readonly string[] = readonly string[]>(subId: string, args?: {
-                select?: TSelect_1;
-                populate?: unknown;
-            }, axiosRequestConfig?: RequestConfig$1) => ModelPromiseMeta & Promise<ModelResponse<S, ResolvedSelectedShape<S, TSelect_1, TData>>>;
-            update: (subId: string, data: object, axiosRequestConfig?: RequestConfig$1) => ModelPromiseMeta & Promise<ModelResponse<S>>;
-            bulkUpdate: (data: object[], _options?: object, axiosRequestConfig?: RequestConfig$1) => ModelPromiseMeta & Promise<ListModelResponse<S>>;
-            create: (data: object, axiosRequestConfig?: RequestConfig$1) => ModelPromiseMeta & Promise<ModelResponse<S>>;
-            delete: (subId: string, axiosRequestConfig?: RequestConfig$1) => ModelPromiseMeta & Promise<Response<string, string>>;
-        };
-        fetch: (args?: ReadAdvancedArgs, options?: ReadAdvancedOptions, axiosRequestConfig?: RequestConfig$1) => ModelPromiseMeta & Promise<ModelResponse<T, Partial<T>>>;
-    };
-    private processListResult;
-}
-
-type RequestConfig = AxiosRequestConfig & AdditionalReqConfig;
-interface Props {
-    axios: AxiosInstance;
-    dataName: string;
-    basePath: string;
-    queryPath: string;
-    onSuccess: ResponseCallback;
-    onFailure: ResponseCallback;
-    throwOnError: boolean;
-}
-declare class DataService<T> extends Service {
-    private _dataName;
-    private _queryPath;
-    private _handleCallbacks;
-    private _defaults;
-    constructor({ axios, dataName, basePath, queryPath, onSuccess, onFailure, throwOnError }: Props, defaults?: DataDefaults);
-    list<TData extends Partial<T> = T>(args?: DataListArgs, options?: DataListOptions, axiosRequestConfig?: RequestConfig): DataPromiseMeta & Promise<ListDataResponse<TData>>;
-    listAdvanced<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(filter: FilterQuery<T>, args?: DataListAdvancedArgs<TSelect>, options?: DataListAdvancedOptions, axiosRequestConfig?: RequestConfig): DataPromiseMeta & Promise<ListDataResponse<ResolvedSelectedShape<T, TSelect, TData>>>;
-    read<TData extends Partial<T> = T>(identifier: string, options?: DataReadOptions, axiosRequestConfig?: RequestConfig): DataPromiseMeta & Promise<DataResponse<TData>>;
-    readAdvanced<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(identifier: string, args?: DataReadAdvancedArgs<TSelect>, options?: DataReadAdvancedOptions, axiosRequestConfig?: RequestConfig): DataPromiseMeta & Promise<DataResponse<ResolvedSelectedShape<T, TSelect, TData>>>;
-    readAdvancedFilter<TData extends Partial<T> | never = never, TSelect extends Projection = Projection>(filter: FilterQuery<T>, args?: DataReadAdvancedArgs<TSelect>, options?: DataReadAdvancedOptions, axiosRequestConfig?: RequestConfig): DataPromiseMeta & Promise<DataResponse<ResolvedSelectedShape<T, TSelect, TData>>>;
-    private processListResult;
-}
-
 interface AdapterOptions {
     rootRouterPath?: string;
     onSuccess?: ResponseCallback;
@@ -528,25 +545,35 @@ declare function createAdapter(axiosConfig?: AxiosRequestConfig, adapterOptions?
     axios: axios.AxiosInstance;
     createModelService: <T>({ modelName, basePath, queryPath, mutationPath, onSuccess, onFailure, throwOnError, }: ModelServiceOptions, defaults?: Defaults) => ModelService<T>;
     createDataService: <T>({ dataName, basePath, queryPath, onSuccess, onFailure, throwOnError }: DataServiceOptions, defaults?: DataDefaults) => DataService<T>;
-    wrapGet: <T = unknown>(url: string, defaultAxiosRequestConfig?: AxiosRequestConfig) => (options?: WrapOptions, axiosRequestConfig?: AxiosRequestConfig) => Promise<axios.AxiosResponse<T, any, {}>>;
-    wrapPost: <T = unknown>(url: string, defaultAxiosRequestConfig?: AxiosRequestConfig) => (data?: unknown, options?: WrapOptions, axiosRequestConfig?: AxiosRequestConfig) => Promise<axios.AxiosResponse<T, any, {}>>;
-    wrapPut: <T = unknown>(url: string, defaultAxiosRequestConfig?: AxiosRequestConfig) => (data?: unknown, options?: WrapOptions, axiosRequestConfig?: AxiosRequestConfig) => Promise<axios.AxiosResponse<T, any, {}>>;
-    wrapPatch: <T = unknown>(url: string, defaultAxiosRequestConfig?: AxiosRequestConfig) => (data?: unknown, options?: WrapOptions, axiosRequestConfig?: AxiosRequestConfig) => Promise<axios.AxiosResponse<T, any, {}>>;
-    wrapDelete: <T = unknown>(url: string, defaultAxiosRequestConfig?: AxiosRequestConfig) => (options?: WrapOptions, axiosRequestConfig?: AxiosRequestConfig) => Promise<axios.AxiosResponse<T, any, {}>>;
-    group: <T extends ((ModelPromiseMeta | DataPromiseMeta) & LazyRequest<unknown>)[]>(...proms: T) => Promise<{ [K in keyof T]: T[K] extends Promise<infer U> ? U : never; }>;
+    wrapGet: <T = unknown>(url: string, defaultConfig?: AxiosRequestConfig) => (options?: WrapOptions, requestConfig?: AxiosRequestConfig) => Promise<axios.AxiosResponse<T, any, {}>>;
+    wrapPost: <T = unknown>(url: string, defaultConfig?: AxiosRequestConfig) => (data?: unknown, options?: WrapOptions, requestConfig?: AxiosRequestConfig) => Promise<axios.AxiosResponse<T, any, {}>>;
+    wrapPut: <T = unknown>(url: string, defaultConfig?: AxiosRequestConfig) => (data?: unknown, options?: WrapOptions, requestConfig?: AxiosRequestConfig) => Promise<axios.AxiosResponse<T, any, {}>>;
+    wrapPatch: <T = unknown>(url: string, defaultConfig?: AxiosRequestConfig) => (data?: unknown, options?: WrapOptions, requestConfig?: AxiosRequestConfig) => Promise<axios.AxiosResponse<T, any, {}>>;
+    wrapDelete: <T = unknown>(url: string, defaultConfig?: AxiosRequestConfig) => (options?: WrapOptions, requestConfig?: AxiosRequestConfig) => Promise<axios.AxiosResponse<T, any, {}>>;
+    group: <T extends readonly (ModelRequest<unknown> | DataRequest<unknown>)[]>(...proms: T) => Promise<{ [K in keyof T]: Awaited<T[K]>; }>;
 }>;
 
+declare enum CustomHeaders {
+    TotalCount = "wtt-total-count",
+    ReturnedCount = "wtt-returned-count",
+    Page = "wtt-page",
+    PageSize = "wtt-page-size",
+    TotalPages = "wtt-total-pages",
+    HasNextPage = "wtt-has-next-page",
+    HasPreviousPage = "wtt-has-previous-page"
+}
+
 declare function replaceItemById<T extends {
     _id: string;
-}>(items: T[], newItem: T, options?: {
+}>(items: T[], targetItem: T, options?: {
     merge: boolean;
 }): T[];
 declare function removeItemById<T extends {
     _id: string;
-}>(items: T[], newItem: T): T[];
+}>(items: T[], targetItem: T): T[];
 
 declare const _default: {
     createAdapter: typeof createAdapter;
 };
 
-export { type ArrayDataResponse, type ArrayModelResponse, type DataPromiseMeta, type DataResponse, DataService, type Document, type FilterQuery, type Include, type KeyValueProjection, type LazyRequest, type ListDataResponse, type ListModelResponse, Model, type ModelPromiseMeta, type ModelResponse, ModelService, type Populate, type PopulateAccess, type Projection, type ResolvedSelectedShape, type Response, type ResponseCallback, type ResultError, type RootDataQueryMeta, type RootModelQueryMeta, type RootQueryMeta, type SelectedKeys, type SelectedShape, Service, ServiceError, type Sort, type SortOrder, type SubQueryMeta, type Task, type WrapOptions, createAdapter, _default as default, removeItemById, replaceItemById, wrapLazyPromise };
+export { type AdditionalReqConfig, type ArrayDataResponse, type ArrayModelResponse, type CreateAdvancedArgs, type CreateAdvancedOptions, type CreateOptions, CustomHeaders, type DataDefaults, type DataListAdvancedArgs, type DataListAdvancedOptions, type DataListArgs, type DataListOptions, type DataPromiseMeta, type DataReadAdvancedArgs, type DataReadAdvancedOptions, type DataReadOptions, type DataRequest, type DataResponse, DataService, type Defaults, type Document, type FilterQuery, type Include, type KeyValueProjection, type LazyRequest, type ListAdvancedArgs, type ListAdvancedOptions, type ListArgs, type ListDataResponse, type ListModelResponse, type ListOptions, Model, type ModelPromiseMeta, type ModelRequest, type ModelResponse, ModelService, type Populate, type PopulateAccess, type Projection, type ReadAdvancedArgs, type ReadAdvancedOptions, type ReadOptions, type ResolvedSelectedShape, type Response, type ResponseCallback, type ResultError, type RootDataQueryMeta, type RootModelQueryMeta, type RootQueryMeta, type SelectedKeys, type SelectedShape, Service, ServiceError, type Sort, type SortOrder, type SubQueryOptions, type Task, type UpdateAdvancedArgs, type UpdateAdvancedOptions, type UpdateOptions, type UpsertAdvancedArgs, type UpsertAdvancedOptions, type UpsertOptions, type WrapOptions, createAdapter, _default as default, removeItemById, replaceItemById, wrapLazyPromise };