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

package/index.d.mts

@@ -232,6 +232,14 @@ interface Props$1 {
     onFailure: ResponseCallback;
     throwOnError: boolean;
 }
+/**
+ * Typed client for `access-router` model CRUD routes. Created by
+ * `adapter.createModelService<T>(...)`.
+ *
+ * @example
+ * const userService = adapter.createModelService<User>({ modelName: 'User', basePath: 'users' });
+ * const user = await userService.read('user-id-1');
+ */
 declare class ModelService<T extends Document> extends Service {
     private _modelName;
     private _queryPath;
@@ -304,6 +312,13 @@ interface Props {
     onFailure: ResponseCallback;
     throwOnError: boolean;
 }
+/**
+ * Typed client for `access-router` in-memory data routes. Created by
+ * `adapter.createDataService<T>(...)`.
+ *
+ * @example
+ * const fruitService = adapter.createDataService<Fruit>({ dataName: 'fruit', basePath: 'fruit' });
+ */
 declare class DataService<T> extends Service {
     private _dataName;
     private _queryPath;
@@ -541,6 +556,13 @@ interface DataServiceOptions {
     onFailure?: ResponseCallback;
     throwOnError?: boolean;
 }
+/**
+ * Creates a typed API adapter for `@web-ts-toolkit/access-router` model and data routes.
+ *
+ * @example
+ * const adapter = createAdapter({ baseURL: 'http://localhost:3000/api' });
+ * const userService = adapter.createModelService<User>({ modelName: 'User', basePath: 'users' });
+ */
 declare function createAdapter(axiosConfig?: AxiosRequestConfig, adapterOptions?: AdapterOptions): Readonly<{
     axios: axios.AxiosInstance;
     createModelService: <T>({ modelName, basePath, queryPath, mutationPath, onSuccess, onFailure, throwOnError, }: ModelServiceOptions, defaults?: Defaults) => ModelService<T>;
@@ -572,8 +594,4 @@ declare function removeItemById<T extends {
     _id: string;
 }>(items: T[], targetItem: T): T[];
 
-declare const _default: {
-    createAdapter: typeof createAdapter;
-};
-
-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 };
+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, removeItemById, replaceItemById, wrapLazyPromise };

package/index.d.ts

@@ -232,6 +232,14 @@ interface Props$1 {
     onFailure: ResponseCallback;
     throwOnError: boolean;
 }
+/**
+ * Typed client for `access-router` model CRUD routes. Created by
+ * `adapter.createModelService<T>(...)`.
+ *
+ * @example
+ * const userService = adapter.createModelService<User>({ modelName: 'User', basePath: 'users' });
+ * const user = await userService.read('user-id-1');
+ */
 declare class ModelService<T extends Document> extends Service {
     private _modelName;
     private _queryPath;
@@ -304,6 +312,13 @@ interface Props {
     onFailure: ResponseCallback;
     throwOnError: boolean;
 }
+/**
+ * Typed client for `access-router` in-memory data routes. Created by
+ * `adapter.createDataService<T>(...)`.
+ *
+ * @example
+ * const fruitService = adapter.createDataService<Fruit>({ dataName: 'fruit', basePath: 'fruit' });
+ */
 declare class DataService<T> extends Service {
     private _dataName;
     private _queryPath;
@@ -541,6 +556,13 @@ interface DataServiceOptions {
     onFailure?: ResponseCallback;
     throwOnError?: boolean;
 }
+/**
+ * Creates a typed API adapter for `@web-ts-toolkit/access-router` model and data routes.
+ *
+ * @example
+ * const adapter = createAdapter({ baseURL: 'http://localhost:3000/api' });
+ * const userService = adapter.createModelService<User>({ modelName: 'User', basePath: 'users' });
+ */
 declare function createAdapter(axiosConfig?: AxiosRequestConfig, adapterOptions?: AdapterOptions): Readonly<{
     axios: axios.AxiosInstance;
     createModelService: <T>({ modelName, basePath, queryPath, mutationPath, onSuccess, onFailure, throwOnError, }: ModelServiceOptions, defaults?: Defaults) => ModelService<T>;
@@ -572,8 +594,4 @@ declare function removeItemById<T extends {
     _id: string;
 }>(items: T[], targetItem: T): T[];
 
-declare const _default: {
-    createAdapter: typeof createAdapter;
-};
-
-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 };
+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, removeItemById, replaceItemById, wrapLazyPromise };

package/index.js

@@ -36,7 +36,6 @@ __export(index_exports, {
   Service: () => Service,
   ServiceError: () => ServiceError,
   createAdapter: () => createAdapter,
-  default: () => index_default,
   removeItemById: () => removeItemById,
   replaceItemById: () => replaceItemById,
   wrapLazyPromise: () => wrapLazyPromise
@@ -1878,9 +1877,6 @@ function removeItemById(items, targetItem) {
     return item._id !== targetItem._id;
   });
 }
-
-// src/index.ts
-var index_default = { createAdapter };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   CustomHeaders,

package/index.mjs

@@ -1833,9 +1833,6 @@ function removeItemById(items, targetItem) {
     return item._id !== targetItem._id;
   });
 }
-
-// src/index.ts
-var index_default = { createAdapter };
 export {
   CustomHeaders,
   DataService,
@@ -1844,7 +1841,6 @@ export {
   Service,
   ServiceError,
   createAdapter,
-  index_default as default,
   removeItemById,
   replaceItemById,
   wrapLazyPromise

package/llms.txt

@@ -0,0 +1,53 @@
+# @web-ts-toolkit/access-router-client
+
+Typed Axios-based client utilities for `@web-ts-toolkit/access-router` model routers, data routers, and root batch routes.
+
+## Main Patterns
+
+```ts
+import { createAdapter } from '@web-ts-toolkit/access-router-client';
+
+const adapter = createAdapter({ baseURL: 'http://localhost:3000/api' });
+
+const userService = adapter.createModelService<User>({
+  modelName: 'User',
+  basePath: 'users',
+});
+
+const user = await userService.read('user-id-1');
+user.data.role = 'owner';
+await user.data.save();
+```
+
+Data service for in-memory `access-router` data routes:
+
+```ts
+const fruitService = adapter.createDataService<Fruit>({
+  dataName: 'fruit',
+  basePath: 'fruit',
+});
+```
+
+Batch grouped lazy requests into one root round trip:
+
+```ts
+const grouped = await adapter.group(
+  userService.readAdvanced('user-id-1', { select: ['name'] }),
+  userService.countAdvanced({ role: 'admin' }),
+);
+```
+
+## Gotchas
+
+- depends on `axios`; bring your own `axios`-compatible runtime
+- service methods return lazy requests; they do not execute until `await`, `.then()`, `.exec()`, etc.
+- `adapter.group(...)` only batches lazy requests from this client, not raw Axios calls
+- the client `basePath` is relative to the adapter `baseURL`, not the full server path
+- match `queryPath`/`mutationPath` to the server-side `queryRouteSegment` and mutation route configuration
+- this package targets `@web-ts-toolkit/access-router` servers; plain Axios is simpler for non-access-router APIs
+- imports are named-only (`import { createAdapter }`); there is no default export
+
+## Pointers
+
+- README: installation, quickstart, main exports
+- website/docs/packages/access-router-client/: full documentation (adapter, services, model, typing and errors)

package/package.json

@@ -2,7 +2,7 @@
   "name": "@web-ts-toolkit/access-router-client",
   "description": "Typed client utilities for @web-ts-toolkit/access-router APIs",
   "homepage": "https://web-ts-toolkit.pages.dev/docs/packages/access-router-client",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "sideEffects": false,
   "keywords": [
     "axios",
@@ -26,7 +26,7 @@
     "node": ">=20"
   },
   "dependencies": {
-    "@web-ts-toolkit/utils": "0.5.0",
+    "@web-ts-toolkit/utils": "0.6.0",
     "axios": "^1.7.9"
   },
   "author": "Junmin Ahn",