@mx-space/api-client 0.7.2 → 0.8.0

package/readme.md

@@ -0,0 +1,84 @@
+# MApi Client
+
+这是一个适用于 MServer v3 的 JS SDK，封装了常用接口请求方法以及返回类型的声明，以快速开发前端应用。
+
+## 如何使用
+
+此 SDK 框架无关，不捆绑任何一个网络请求库，只需要提供适配器。你需要手动传入符合接口标准的适配器。
+
+此项目提供 `axios` 和 `umi-request` 两个适配器。
+
+以 `axios` 为例。
+
+```ts
+// esm format (spa recommend)
+import { axiosAdaptor } from '@mx-space/api-client/esm/adaptors/axios'
+// cjs format (ssr recommend)
+// import { axiosAdaptor } from '@mx-space/api-client/lib/adaptors/axios'
+import {
+  AggregateController,
+  CategoryController,
+  createClient,
+  NoteController,
+  PostController,
+  allControllers,
+  // ...
+} from '@mx-space/api-client'
+
+const endpoint = 'https://api.innei.dev/v2'
+const client = createClient(axiosAdaptor)(endpoint)
+
+// `default` is AxiosInstance
+// you can do anything else on this
+// interceptor or re-configure
+const $axios = axiosAdaptor.default
+// re-config (optional)
+$axios.defaults.timeout = 10000
+// set interceptors (optional)
+$axios.interceptors.request.use(
+  (config) => {
+    const token = getToken()
+    if (token) {
+      config.headers!['Authorization'] = 'bearer ' + getToken()
+    }
+
+    return config
+  },
+  (error) => {
+    if (__DEV__) {
+      console.log(error.message)
+    }
+
+    return Promise.reject(error)
+  },
+)
+
+// inject controller first.
+client.injectControllers([
+  PostController,
+  NoteController,
+  AggregateController,
+  CategoryController,
+])
+
+// or you can inject allControllers
+client.injectControllers(allControllers)
+
+// then you can request `post` `note` and `aggregate` controller
+
+client.post.post.getList(page, 10, { year }).then((data) => {
+  // do anything
+})
+```
+
+**为什么要手动注入控制器**
+
+按需加载，可以减少打包体积 (Tree Shake)
+
+**为什么不依赖请求库**
+
+可以防止项目中出现两个请求库，减少打包体积
+
+**如果不使用 axios，应该如何编写适配器**
+
+参考 `src/adaptors/axios.ts` 和 `src/adaptors/umi-request.ts`

package/types/controllers/aggregate.d.ts

@@ -1,9 +1,9 @@
+import { HTTPClient } from '../core';
 import { IRequestAdapter } from '../interfaces/adapter';
 import { IController } from '../interfaces/controller';
 import { SortOrder } from '../interfaces/options';
 import { IRequestHandler, RequestProxyResult } from '../interfaces/request';
 import { AggregateRoot, AggregateStat, AggregateTop, TimelineData, TimelineType } from '../models/aggregate';
-import { HTTPClient } from '../core';
 declare module '../core/client' {
     interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
         aggregate: AggregateController<ResponseWrapper>;

package/types/controllers/base.d.ts

@@ -1,6 +1,6 @@
+import { HTTPClient } from '../core';
 import { IRequestHandler, RequestProxyResult } from '../interfaces/request';
 import { PaginateResult } from '../models/base';
-import { HTTPClient } from '../core';
 export declare abstract class BaseCrudController<T, ResponseWrapper> {
     protected client: HTTPClient;
     base: string;

package/types/controllers/category.d.ts

@@ -1,9 +1,9 @@
-import { IRequestAdapter } from '../interfaces/adapter';
-import { IController } from '../interfaces/controller';
-import { IRequestHandler, RequestProxyResult, ResponseProxyExtraRaw } from '../interfaces/request';
 import { HTTPClient } from '../core/client';
 import { CategoryModel, CategoryType, CategoryWithChildrenModel, TagModel } from '../models/category';
 import { PostModel } from '../models/post';
+import { IRequestAdapter } from '../interfaces/adapter';
+import { IController } from '../interfaces/controller';
+import { IRequestHandler, RequestProxyResult, ResponseProxyExtraRaw } from '../interfaces/request';
 declare module '../core/client' {
     interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
         category: CategoryController<ResponseWrapper>;
@@ -24,7 +24,7 @@ export declare class CategoryController<ResponseWrapper> implements IController
     getCategoryDetail(id: string): Promise<ResponseProxyExtraRaw<CategoryWithChildrenModel>>;
     getCategoryDetail(ids: string[]): Promise<ResponseProxyExtraRaw<Map<string, CategoryWithChildrenModel>>>;
     getCategoryByIdOrSlug(idOrSlug: string): Promise<CategoryModel & {
-        children: Pick<PostModel, "id" | "title" | "slug" | "modified" | "created">[];
+        children: Pick<PostModel, "id" | "title" | "slug" | "created" | "modified">[];
     } & {
         $raw: ResponseWrapper extends {
             data: infer T;
@@ -44,7 +44,7 @@ export declare class CategoryController<ResponseWrapper> implements IController
                 name: string;
                 created: string;
                 id: string;
-                children: Pick<PostModel, "id" | "title" | "slug" | "modified" | "created">[];
+                children: Pick<PostModel, "id" | "title" | "slug" | "created" | "modified">[];
             } : ResponseWrapper extends unknown ? {
                 [key: string]: any;
                 data: CategoryWithChildrenModel;
@@ -86,7 +86,7 @@ export declare class CategoryController<ResponseWrapper> implements IController
                 };
             }) extends unknown ? {
                 tag: string;
-                data: Pick<PostModel, "id" | "title" | "slug" | "created" | "category">[];
+                data: Pick<PostModel, "category" | "id" | "title" | "slug" | "created">[];
             } : ResponseWrapper extends unknown ? {
                 [key: string]: any;
                 data: {

package/types/controllers/comment.d.ts

@@ -1,11 +1,11 @@
+import { HTTPClient } from '../core';
+import { CommentDto } from '../dtos/comment';
 import { IRequestAdapter } from '../interfaces/adapter';
 import { IController } from '../interfaces/controller';
 import { PaginationParams } from '../interfaces/params';
 import { IRequestHandler } from '../interfaces/request';
 import { PaginateResult } from '../models/base';
 import { CommentModel } from '../models/comment';
-import { HTTPClient } from '../core';
-import { CommentDto } from '../dtos/comment';
 declare module '../core/client' {
     interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
         comment: CommentController<ResponseWrapper>;

package/types/controllers/index.d.ts

@@ -9,8 +9,9 @@ import { ProjectController } from './project';
 import { RecentlyController } from './recently';
 import { SayController } from './say';
 import { SearchController } from './search';
+import { ServerlessController } from './severless';
 import { SnippetController } from './snippet';
 import { UserController } from './user';
-export declare const allControllers: (typeof AggregateController | typeof CategoryController | typeof CommentController | typeof LinkController | typeof NoteController | typeof PageController | typeof PostController | typeof ProjectController | typeof RecentlyController | typeof SayController | typeof SearchController | typeof SnippetController | typeof UserController)[];
-export declare const allContollerNames: readonly ["aggregate", "category", "comment", "link", "note", "page", "post", "project", "recently", "say", "search", "snippet", "user", "friend", "master", "shorthand"];
-export { AggregateController, CategoryController, CommentController, LinkController, NoteController, PageController, PostController, ProjectController, RecentlyController, SayController, SearchController, SnippetController, UserController, };
+export declare const allControllers: (typeof AggregateController | typeof CategoryController | typeof CommentController | typeof LinkController | typeof NoteController | typeof PageController | typeof PostController | typeof ProjectController | typeof RecentlyController | typeof SayController | typeof SearchController | typeof ServerlessController | typeof SnippetController | typeof UserController)[];
+export declare const allContollerNames: readonly ["aggregate", "category", "comment", "link", "note", "page", "post", "project", "recently", "say", "search", "snippet", "serverless", "user", "friend", "master", "shorthand"];
+export { AggregateController, CategoryController, CommentController, LinkController, NoteController, PageController, PostController, ProjectController, RecentlyController, SayController, SearchController, SnippetController, ServerlessController, UserController, };

package/types/controllers/link.d.ts

@@ -1,7 +1,7 @@
-import { IRequestAdapter } from '../interfaces/adapter';
-import { LinkModel } from '../models/link';
 import { HTTPClient } from '../core';
 import { BaseCrudController } from './base';
+import { IRequestAdapter } from '../interfaces/adapter';
+import { LinkModel } from '../models/link';
 declare module '../core/client' {
     interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
         link: LinkController<ResponseWrapper>;
@@ -11,6 +11,10 @@ declare module '../core/client' {
 export declare class LinkController<ResponseWrapper> extends BaseCrudController<LinkModel, ResponseWrapper> {
     protected readonly client: HTTPClient;
     constructor(client: HTTPClient);
+    canApplyLink(): Promise<boolean>;
+    applyLink(data: Pick<LinkModel, 'avatar' | 'name' | 'description' | 'url'> & {
+        author: string;
+    }): Promise<never>;
     name: string[];
     base: string;
 }

package/types/controllers/note.d.ts

@@ -1,10 +1,10 @@
+import { HTTPClient } from '../core/client';
 import { IRequestAdapter } from '../interfaces/adapter';
 import { IController } from '../interfaces/controller';
 import { IRequestHandler } from '../interfaces/request';
 import { SelectFields } from '../interfaces/types';
 import { PaginateResult } from '../models/base';
 import { NoteModel, NoteWrappedPayload } from '../models/note';
-import { HTTPClient } from '../core/client';
 declare module '../core/client' {
     interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
         note: NoteController<ResponseWrapper>;

package/types/controllers/page.d.ts

@@ -1,10 +1,10 @@
+import { HTTPClient } from '../core';
 import { IRequestAdapter } from '../interfaces/adapter';
 import { IController } from '../interfaces/controller';
 import { IRequestHandler } from '../interfaces/request';
 import { SelectFields } from '../interfaces/types';
 import { PaginateResult } from '../models/base';
 import { PageModel } from '../models/page';
-import { HTTPClient } from '../core';
 declare module '../core/client' {
     interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
         page: PageController<ResponseWrapper>;

package/types/controllers/post.d.ts

@@ -1,10 +1,10 @@
+import { HTTPClient } from '../core/client';
 import { IRequestAdapter } from '../interfaces/adapter';
 import { IController } from '../interfaces/controller';
 import { IRequestHandler, RequestProxyResult } from '../interfaces/request';
 import { SelectFields } from '../interfaces/types';
 import { PaginateResult } from '../models/base';
 import { PostModel } from '../models/post';
-import { HTTPClient } from '../core/client';
 declare module '../core/client' {
     interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
         post: PostController<ResponseWrapper>;

package/types/controllers/project.d.ts

@@ -1,7 +1,7 @@
-import { IRequestAdapter } from '../interfaces/adapter';
-import { ProjectModel } from '../models/project';
 import { HTTPClient } from '../core';
 import { BaseCrudController } from './base';
+import { IRequestAdapter } from '../interfaces/adapter';
+import { ProjectModel } from '../models/project';
 declare module '../core/client' {
     interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
         project: ProjectController<ResponseWrapper>;

package/types/controllers/recently.d.ts

@@ -1,8 +1,8 @@
+import { HTTPClient } from '../core';
 import { IRequestAdapter } from '../interfaces/adapter';
 import { IController } from '../interfaces/controller';
 import { IRequestHandler } from '../interfaces/request';
 import { RecentlyModel } from '../models/recently';
-import { HTTPClient } from '../core';
 declare module '../core/client' {
     interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
         recently: RecentlyController<ResponseWrapper>;

package/types/controllers/say.d.ts

@@ -1,9 +1,9 @@
+import { HTTPClient } from '../core';
+import { BaseCrudController } from './base';
 import { IRequestAdapter } from '../interfaces/adapter';
 import { IController } from '../interfaces/controller';
 import { IRequestHandler } from '../interfaces/request';
 import { SayModel } from '../models/say';
-import { HTTPClient } from '../core';
-import { BaseCrudController } from './base';
 declare module '../core/client' {
     interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
         say: SayController<ResponseWrapper>;

package/types/controllers/search.d.ts

@@ -1,11 +1,11 @@
+import { PageModel } from '..';
+import { HTTPClient } from '../core';
 import { IRequestAdapter } from '../interfaces/adapter';
 import { IController } from '../interfaces/controller';
 import { IRequestHandler, RequestProxyResult } from '../interfaces/request';
 import { PaginateResult } from '../models/base';
 import { NoteModel } from '../models/note';
 import { PostModel } from '../models/post';
-import { PageModel } from '..';
-import { HTTPClient } from '../core';
 declare module '../core/client' {
     interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
         search: SearchController<ResponseWrapper>;
@@ -32,11 +32,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
      * @param options
      * @returns
      */
-    searchByAlgolia(keyword: string, options?: SearchOption): RequestProxyResult<RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+    searchByAlgolia(keyword: string, options?: SearchOption): RequestProxyResult<RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "created" | "modified"> & {
         type: 'post';
-    }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+    }) | (Pick<NoteModel, "id" | "title" | "created" | "modified" | "nid"> & {
         type: 'note';
-    }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+    }) | (Pick<PageModel, "id" | "title" | "slug" | "created" | "modified"> & {
         type: 'page';
     })> & {
         /**
@@ -45,11 +45,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
         raw?: any;
     }, ResponseWrapper, ResponseWrapper extends unknown ? {
         [key: string]: any;
-        data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+        data: PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "created" | "modified"> & {
             type: 'post';
-        }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+        }) | (Pick<NoteModel, "id" | "title" | "created" | "modified" | "nid"> & {
             type: 'note';
-        }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+        }) | (Pick<PageModel, "id" | "title" | "slug" | "created" | "modified"> & {
             type: 'page';
         })> & {
             /**
@@ -58,11 +58,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
             raw?: any;
         };
     } : ResponseWrapper extends {
-        data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+        data: PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "created" | "modified"> & {
             type: 'post';
-        }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+        }) | (Pick<NoteModel, "id" | "title" | "created" | "modified" | "nid"> & {
             type: 'note';
-        }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+        }) | (Pick<PageModel, "id" | "title" | "slug" | "created" | "modified"> & {
             type: 'page';
         })> & {
             /**
@@ -71,11 +71,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
             raw?: any;
         };
     } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
-        data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+        data: PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "created" | "modified"> & {
             type: 'post';
-        }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+        }) | (Pick<NoteModel, "id" | "title" | "created" | "modified" | "nid"> & {
             type: 'note';
-        }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+        }) | (Pick<PageModel, "id" | "title" | "slug" | "created" | "modified"> & {
             type: 'page';
         })> & {
             /**
@@ -85,11 +85,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
         };
     }>, ResponseWrapper, ResponseWrapper extends unknown ? {
         [key: string]: any;
-        data: RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+        data: RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "created" | "modified"> & {
             type: 'post';
-        }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+        }) | (Pick<NoteModel, "id" | "title" | "created" | "modified" | "nid"> & {
             type: 'note';
-        }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+        }) | (Pick<PageModel, "id" | "title" | "slug" | "created" | "modified"> & {
             type: 'page';
         })> & {
             /**
@@ -98,11 +98,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
             raw?: any;
         }, ResponseWrapper, ResponseWrapper extends unknown ? {
             [key: string]: any;
-            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+            data: PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'post';
-            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+            }) | (Pick<NoteModel, "id" | "title" | "created" | "modified" | "nid"> & {
                 type: 'note';
-            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'page';
             })> & {
                 /**
@@ -111,11 +111,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
                 raw?: any;
             };
         } : ResponseWrapper extends {
-            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+            data: PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'post';
-            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+            }) | (Pick<NoteModel, "id" | "title" | "created" | "modified" | "nid"> & {
                 type: 'note';
-            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'page';
             })> & {
                 /**
@@ -124,11 +124,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
                 raw?: any;
             };
         } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
-            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+            data: PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'post';
-            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+            }) | (Pick<NoteModel, "id" | "title" | "created" | "modified" | "nid"> & {
                 type: 'note';
-            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'page';
             })> & {
                 /**
@@ -138,11 +138,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
             };
         }>;
     } : ResponseWrapper extends {
-        data: RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+        data: RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "created" | "modified"> & {
             type: 'post';
-        }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+        }) | (Pick<NoteModel, "id" | "title" | "created" | "modified" | "nid"> & {
             type: 'note';
-        }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+        }) | (Pick<PageModel, "id" | "title" | "slug" | "created" | "modified"> & {
             type: 'page';
         })> & {
             /**
@@ -151,11 +151,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
             raw?: any;
         }, ResponseWrapper, ResponseWrapper extends unknown ? {
             [key: string]: any;
-            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+            data: PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'post';
-            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+            }) | (Pick<NoteModel, "id" | "title" | "created" | "modified" | "nid"> & {
                 type: 'note';
-            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'page';
             })> & {
                 /**
@@ -164,11 +164,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
                 raw?: any;
             };
         } : ResponseWrapper extends {
-            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+            data: PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'post';
-            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+            }) | (Pick<NoteModel, "id" | "title" | "created" | "modified" | "nid"> & {
                 type: 'note';
-            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'page';
             })> & {
                 /**
@@ -177,11 +177,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
                 raw?: any;
             };
         } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
-            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+            data: PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'post';
-            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+            }) | (Pick<NoteModel, "id" | "title" | "created" | "modified" | "nid"> & {
                 type: 'note';
-            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'page';
             })> & {
                 /**
@@ -191,11 +191,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
             };
         }>;
     } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
-        data: RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+        data: RequestProxyResult<PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "created" | "modified"> & {
             type: 'post';
-        }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+        }) | (Pick<NoteModel, "id" | "title" | "created" | "modified" | "nid"> & {
             type: 'note';
-        }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+        }) | (Pick<PageModel, "id" | "title" | "slug" | "created" | "modified"> & {
             type: 'page';
         })> & {
             /**
@@ -204,11 +204,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
             raw?: any;
         }, ResponseWrapper, ResponseWrapper extends unknown ? {
             [key: string]: any;
-            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+            data: PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'post';
-            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+            }) | (Pick<NoteModel, "id" | "title" | "created" | "modified" | "nid"> & {
                 type: 'note';
-            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'page';
             })> & {
                 /**
@@ -217,11 +217,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
                 raw?: any;
             };
         } : ResponseWrapper extends {
-            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+            data: PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'post';
-            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+            }) | (Pick<NoteModel, "id" | "title" | "created" | "modified" | "nid"> & {
                 type: 'note';
-            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'page';
             })> & {
                 /**
@@ -230,11 +230,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
                 raw?: any;
             };
         } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
-            data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
+            data: PaginateResult<(Pick<PostModel, "category" | "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'post';
-            }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
+            }) | (Pick<NoteModel, "id" | "title" | "created" | "modified" | "nid"> & {
                 type: 'note';
-            }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
+            }) | (Pick<PageModel, "id" | "title" | "slug" | "created" | "modified"> & {
                 type: 'page';
             })> & {
                 /**

package/types/controllers/severless.d.ts

@@ -0,0 +1,24 @@
+import { HTTPClient } from '../core';
+import { IRequestAdapter } from '../interfaces/adapter';
+import { IController } from '../interfaces/controller';
+import { IRequestHandler } from '../interfaces/request';
+declare module '../core/client' {
+    interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
+        serverless: ServerlessController<ResponseWrapper>;
+    }
+}
+export declare class ServerlessController<ResponseWrapper> implements IController {
+    protected client: HTTPClient;
+    base: string;
+    name: string;
+    constructor(client: HTTPClient);
+    get proxy(): IRequestHandler<ResponseWrapper>;
+    getByReferenceAndName<T = unknown>(reference: string, name: string): import("../interfaces/request").RequestProxyResult<T, ResponseWrapper, ResponseWrapper extends unknown ? {
+        [key: string]: any;
+        data: T;
+    } : ResponseWrapper extends {
+        data: T;
+    } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
+        data: T;
+    }>;
+}

package/types/controllers/snippet.d.ts

@@ -1,8 +1,8 @@
+import { HTTPClient } from '../core';
 import { IRequestAdapter } from '../interfaces/adapter';
 import { IController } from '../interfaces/controller';
 import { IRequestHandler } from '../interfaces/request';
 import { SnippetModel } from '../models/snippet';
-import { HTTPClient } from '../core';
 declare module '../core/client' {
     interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
         snippet: SnippetController<ResponseWrapper>;
@@ -14,13 +14,13 @@ export declare class SnippetController<ResponseWrapper> implements IController {
     name: string;
     constructor(client: HTTPClient);
     get proxy(): IRequestHandler<ResponseWrapper>;
-    getById<T = unknown>(id: string): import("../interfaces/request").RequestProxyResult<SnippetModel<T>, ResponseWrapper, ResponseWrapper extends unknown ? {
+    getById(id: string): import("../interfaces/request").RequestProxyResult<Omit<SnippetModel<unknown>, "data">, ResponseWrapper, ResponseWrapper extends unknown ? {
         [key: string]: any;
-        data: SnippetModel<T>;
+        data: Omit<SnippetModel<unknown>, "data">;
     } : ResponseWrapper extends {
-        data: SnippetModel<T>;
+        data: Omit<SnippetModel<unknown>, "data">;
     } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
-        data: SnippetModel<T>;
+        data: Omit<SnippetModel<unknown>, "data">;
     }>;
     getByReferenceAndName<T = unknown>(reference: string, name: string): import("../interfaces/request").RequestProxyResult<T, ResponseWrapper, ResponseWrapper extends unknown ? {
         [key: string]: any;

package/types/controllers/user.d.ts

@@ -1,8 +1,8 @@
+import { HTTPClient } from '../core';
 import { IRequestAdapter } from '../interfaces/adapter';
 import { IController } from '../interfaces/controller';
 import { IRequestHandler } from '../interfaces/request';
 import { TLogin, UserModel } from '../models/user';
-import { HTTPClient } from '../core';
 declare module '../core/client' {
     interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
         user: UserController<ResponseWrapper>;

package/types/core/client.d.ts

@@ -21,7 +21,6 @@ declare class HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWr
         params?: any;
     }): Promise<IAdaptorRequestResponseType<any>>;
     get proxy(): IRequestHandler<ResponseWrapper>;
-    private resolveFullPath;
     private buildRoute;
 }
 export declare function createClient<T extends IRequestAdapter>(adapter: T): <ResponseWrapper = T extends {

package/types/models/link.d.ts

@@ -17,4 +17,5 @@ export interface LinkModel extends BaseModel {
     type: LinkType;
     state: LinkState;
     hide: boolean;
+    email: string;
 }

package/types/models/snippet.d.ts

@@ -12,5 +12,6 @@ export interface SnippetModel<T = unknown> extends BaseModel {
     reference: string;
     comment?: string;
     metatype?: string;
+    schema?: string;
     data: T;
 }

package/types/utils/path.d.ts

@@ -0,0 +1 @@
+export declare const resolveFullPath: (endpoint: string, path: string) => string;