@mx-space/api-client 0.7.0 → 0.7.3

package/controllers/aggregate.ts

@@ -1,3 +1,4 @@
+import { IRequestAdapter } from '~/interfaces/adapter'
 import { IController } from '~/interfaces/controller'
 import { SortOrder } from '~/interfaces/options'
 import { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
@@ -13,25 +14,28 @@ import { autoBind } from '~/utils/auto-bind'
 import { HTTPClient } from '../core'
 
 declare module '../core/client' {
-  interface HTTPClient {
-    aggregate: AggregateController
+  interface HTTPClient<
+    T extends IRequestAdapter = IRequestAdapter,
+    ResponseWrapper = unknown,
+  > {
+    aggregate: AggregateController<ResponseWrapper>
   }
 }
 
-export class AggregateController implements IController {
+export class AggregateController<ResponseWrapper> implements IController {
   base = 'aggregate'
   name = 'aggregate'
   constructor(private client: HTTPClient) {
     autoBind(this)
   }
-  public get proxy(): IRequestHandler {
+  public get proxy(): IRequestHandler<ResponseWrapper> {
     return this.client.proxy(this.base)
   }
 
   /**
    * 获取聚合数据
    */
-  getAggregateData(): RequestProxyResult<AggregateRoot> {
+  getAggregateData(): RequestProxyResult<AggregateRoot, ResponseWrapper> {
     return this.proxy.get<AggregateRoot>()
   }
 

package/controllers/base.ts

@@ -3,16 +3,16 @@ import { PaginateResult } from '~/models/base'
 import { autoBind } from '~/utils/auto-bind'
 import { HTTPClient } from '../core'
 
-export abstract class BaseCrudController<T> {
+export abstract class BaseCrudController<T, ResponseWrapper> {
   base!: string
   constructor(protected client: HTTPClient) {
     autoBind(this)
   }
-  public get proxy(): IRequestHandler {
+  public get proxy(): IRequestHandler<ResponseWrapper> {
     return this.client.proxy(this.base)
   }
 
-  getById(id: string): RequestProxyResult<T> {
+  getById(id: string): RequestProxyResult<T, ResponseWrapper> {
     return this.proxy(id).get<T>()
   }
 

package/controllers/category.ts

@@ -1,5 +1,10 @@
+import { IRequestAdapter } from '~/interfaces/adapter'
 import { IController } from '~/interfaces/controller'
-import { RequestProxyResult, ResponseProxyExtraRaw } from '~/interfaces/request'
+import {
+  IRequestHandler,
+  RequestProxyResult,
+  ResponseProxyExtraRaw,
+} from '~/interfaces/request'
 import { attachRawFromOneToAnthor, destructureData } from '~/utils'
 import { autoBind } from '~/utils/auto-bind'
 import { HTTPClient } from '../core/client'
@@ -14,23 +19,29 @@ import {
 import { PostModel } from '../models/post'
 
 declare module '../core/client' {
-  interface HTTPClient {
-    category: CategoryController
+  interface HTTPClient<
+    T extends IRequestAdapter = IRequestAdapter,
+    ResponseWrapper = unknown,
+  > {
+    category: CategoryController<ResponseWrapper>
   }
 }
 
-export class CategoryController implements IController {
+export class CategoryController<ResponseWrapper> implements IController {
   name = 'category'
   base = 'categories'
   constructor(private client: HTTPClient) {
     autoBind(this)
   }
 
-  public get proxy() {
+  public get proxy(): IRequestHandler<ResponseWrapper> {
     return this.client.proxy(this.base)
   }
 
-  getAllCategories(): RequestProxyResult<{ data: CategoryModel[] }> {
+  getAllCategories(): RequestProxyResult<
+    { data: CategoryModel[] },
+    ResponseWrapper
+  > {
     return this.proxy.get({
       params: {
         type: CategoryType.Category,
@@ -38,7 +49,7 @@ export class CategoryController implements IController {
     })
   }
 
-  getAllTags(): RequestProxyResult<{ data: TagModel[] }> {
+  getAllTags(): RequestProxyResult<{ data: TagModel[] }, ResponseWrapper> {
     return this.proxy.get<{ data: TagModel[] }>({
       params: {
         type: CategoryType.Tag,

package/controllers/comment.ts

@@ -1,6 +1,7 @@
+import { IRequestAdapter } from '~/interfaces/adapter'
 import { IController } from '~/interfaces/controller'
 import { PaginationParams } from '~/interfaces/params'
-import { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
+import { IRequestHandler } from '~/interfaces/request'
 import { PaginateResult } from '~/models/base'
 import { CommentModel } from '~/models/comment'
 import { autoBind } from '~/utils/auto-bind'
@@ -8,12 +9,15 @@ import { HTTPClient } from '../core'
 import { CommentDto } from '../dtos/comment'
 
 declare module '../core/client' {
-  interface HTTPClient {
-    comment: CommentController
+  interface HTTPClient<
+    T extends IRequestAdapter = IRequestAdapter,
+    ResponseWrapper = unknown,
+  > {
+    comment: CommentController<ResponseWrapper>
   }
 }
 
-export class CommentController implements IController {
+export class CommentController<ResponseWrapper> implements IController {
   base = 'comments'
   name = 'comment'
 
@@ -21,14 +25,14 @@ export class CommentController implements IController {
     autoBind(this)
   }
 
-  get proxy(): IRequestHandler {
+  get proxy(): IRequestHandler<ResponseWrapper> {
     return this.client.proxy(this.base)
   }
 
   /**
    * 根据 comment id 获取评论, 包括子评论
    */
-  getById(id: string): RequestProxyResult<CommentModel> {
+  getById(id: string) {
     return this.proxy(id).get<CommentModel & { ref: string }>()
   }
 

package/controllers/index.ts

@@ -9,6 +9,7 @@ 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'
 
@@ -25,6 +26,7 @@ export const allControllers = [
   SayController,
   SearchController,
   SnippetController,
+  ServerlessController,
   UserController,
 ]
 
@@ -41,6 +43,7 @@ export const allContollerNames = [
   'say',
   'search',
   'snippet',
+  'serverless',
   'user',
 
   // alias,
@@ -62,5 +65,6 @@ export {
   SayController,
   SearchController,
   SnippetController,
+  ServerlessController,
   UserController,
 }

package/controllers/link.ts

@@ -1,16 +1,23 @@
+import { IRequestAdapter } from '~/interfaces/adapter'
 import { LinkModel } from '~/models/link'
 import { autoBind } from '~/utils/auto-bind'
 import { HTTPClient } from '../core'
 import { BaseCrudController } from './base'
 
 declare module '../core/client' {
-  interface HTTPClient {
-    link: LinkController
-    friend: LinkController
+  interface HTTPClient<
+    T extends IRequestAdapter = IRequestAdapter,
+    ResponseWrapper = unknown,
+  > {
+    link: LinkController<ResponseWrapper>
+    friend: LinkController<ResponseWrapper>
   }
 }
 
-export class LinkController extends BaseCrudController<LinkModel> {
+export class LinkController<ResponseWrapper> extends BaseCrudController<
+  LinkModel,
+  ResponseWrapper
+> {
   constructor(protected readonly client: HTTPClient) {
     super(client)
     autoBind(this)

package/controllers/note.ts

@@ -1,14 +1,18 @@
+import { IRequestAdapter } from '~/interfaces/adapter'
 import { IController } from '~/interfaces/controller'
-import { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
+import { IRequestHandler } from '~/interfaces/request'
+import { SelectFields } from '~/interfaces/types'
 import { PaginateResult } from '~/models/base'
 import { NoteModel, NoteWrappedPayload } from '~/models/note'
-import { SelectFields } from '~/types/helper'
 import { autoBind } from '~/utils/auto-bind'
 import { HTTPClient } from '../core/client'
 
 declare module '../core/client' {
-  interface HTTPClient {
-    note: NoteController
+  interface HTTPClient<
+    T extends IRequestAdapter = IRequestAdapter,
+    ResponseWrapper = unknown,
+  > {
+    note: NoteController<ResponseWrapper>
   }
 }
 
@@ -19,21 +23,21 @@ export type NoteListOptions = {
   sortOrder?: 1 | -1
 }
 
-export class NoteController implements IController {
+export class NoteController<ResponseWrapper> implements IController {
   base = 'notes'
   name = 'note'
 
   constructor(private client: HTTPClient) {
     autoBind(this)
   }
-  get proxy(): IRequestHandler {
+  get proxy(): IRequestHandler<ResponseWrapper> {
     return this.client.proxy(this.base)
   }
 
   /**
    * 最新日记
    */
-  getLatest(): RequestProxyResult<NoteWrappedPayload> {
+  getLatest() {
     return this.proxy.latest.get<NoteWrappedPayload>()
   }
 

package/controllers/page.ts

@@ -1,13 +1,18 @@
+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 { SelectFields } from '~/types/helper'
 import { autoBind } from '~/utils/auto-bind'
 import { HTTPClient } from '../core'
 
 declare module '../core/client' {
-  interface HTTPClient {
-    page: PageController
+  interface HTTPClient<
+    T extends IRequestAdapter = IRequestAdapter,
+    ResponseWrapper = unknown,
+  > {
+    page: PageController<ResponseWrapper>
   }
 }
 
@@ -17,13 +22,13 @@ export type PageListOptions = {
   sortOrder?: 1 | -1
 }
 
-export class PageController implements IController {
+export class PageController<ResponseWrapper> implements IController {
   constructor(private readonly client: HTTPClient) {
     autoBind(this)
   }
   base = 'pages'
   name = 'page'
-  get proxy() {
+  get proxy(): IRequestHandler<ResponseWrapper> {
     return this.client.proxy(this.base)
   }
   /**

package/controllers/post.ts

@@ -1,14 +1,18 @@
+import { IRequestAdapter } from '~/interfaces/adapter'
 import { IController } from '~/interfaces/controller'
-import { RequestProxyResult } from '~/interfaces/request'
+import { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
+import { SelectFields } from '~/interfaces/types'
 import { PaginateResult } from '~/models/base'
 import { PostModel } from '~/models/post'
-import { SelectFields } from '~/types/helper'
 import { autoBind } from '~/utils/auto-bind'
 import { HTTPClient } from '../core/client'
 
 declare module '../core/client' {
-  interface HTTPClient {
-    post: PostController
+  interface HTTPClient<
+    T extends IRequestAdapter = IRequestAdapter,
+    ResponseWrapper = unknown,
+  > {
+    post: PostController<ResponseWrapper>
   }
 }
 
@@ -19,7 +23,7 @@ export type PostListOptions = {
   sortOrder?: 1 | -1
 }
 
-export class PostController implements IController {
+export class PostController<ResponseWrapper> implements IController {
   constructor(private client: HTTPClient) {
     autoBind(this)
   }
@@ -28,7 +32,7 @@ export class PostController implements IController {
 
   name = 'post'
 
-  public get proxy() {
+  public get proxy(): IRequestHandler<ResponseWrapper> {
     return this.client.proxy(this.base)
   }
 
@@ -57,12 +61,15 @@ export class PostController implements IController {
    * @param categoryName
    * @param slug
    */
-  getPost(categoryName: string, slug: string): RequestProxyResult<PostModel>
+  getPost(
+    categoryName: string,
+    slug: string,
+  ): RequestProxyResult<PostModel, ResponseWrapper>
   /**
    * 根据 ID 查找文章
    * @param id
    */
-  getPost(id: string): RequestProxyResult<PostModel>
+  getPost(id: string): RequestProxyResult<PostModel, ResponseWrapper>
   getPost(idOrCategoryName: string, slug?: string): any {
     if (arguments.length == 1) {
       return this.proxy(idOrCategoryName).get<PostModel>()

package/controllers/project.ts

@@ -1,15 +1,22 @@
+import { IRequestAdapter } from '~/interfaces/adapter'
 import { ProjectModel } from '~/models/project'
 import { autoBind } from '~/utils/auto-bind'
 import { HTTPClient } from '../core'
 import { BaseCrudController } from './base'
 
 declare module '../core/client' {
-  interface HTTPClient {
-    project: ProjectController
+  interface HTTPClient<
+    T extends IRequestAdapter = IRequestAdapter,
+    ResponseWrapper = unknown,
+  > {
+    project: ProjectController<ResponseWrapper>
   }
 }
 
-export class ProjectController extends BaseCrudController<ProjectModel> {
+export class ProjectController<ResponseWrapper> extends BaseCrudController<
+  ProjectModel,
+  ResponseWrapper
+> {
   constructor(protected readonly client: HTTPClient) {
     super(client)
     autoBind(this)

package/controllers/recently.ts

@@ -1,16 +1,21 @@
+import { IRequestAdapter } from '~/interfaces/adapter'
 import { IController } from '~/interfaces/controller'
+import { IRequestHandler } from '~/interfaces/request'
 import { RecentlyModel } from '~/models/recently'
 import { autoBind } from '~/utils/auto-bind'
 import { HTTPClient } from '../core'
 
 declare module '../core/client' {
-  interface HTTPClient {
-    recently: RecentlyController
-    shorthand: RecentlyController
+  interface HTTPClient<
+    T extends IRequestAdapter = IRequestAdapter,
+    ResponseWrapper = unknown,
+  > {
+    recently: RecentlyController<ResponseWrapper>
+    shorthand: RecentlyController<ResponseWrapper>
   }
 }
 
-export class RecentlyController implements IController {
+export class RecentlyController<ResponseWrapper> implements IController {
   base = 'recently'
   name = ['recently', 'shorthand']
 
@@ -18,7 +23,7 @@ export class RecentlyController implements IController {
     autoBind(this)
   }
 
-  get proxy() {
+  get proxy(): IRequestHandler<ResponseWrapper> {
     return this.client.proxy(this.base)
   }
   /**

package/controllers/say.ts

@@ -1,17 +1,22 @@
+import { IRequestAdapter } from '~/interfaces/adapter'
 import { IController } from '~/interfaces/controller'
+import { IRequestHandler } from '~/interfaces/request'
 import { SayModel } from '~/models/say'
 import { autoBind } from '~/utils/auto-bind'
 import { HTTPClient } from '../core'
 import { BaseCrudController } from './base'
 
 declare module '../core/client' {
-  interface HTTPClient {
-    say: SayController
+  interface HTTPClient<
+    T extends IRequestAdapter = IRequestAdapter,
+    ResponseWrapper = unknown,
+  > {
+    say: SayController<ResponseWrapper>
   }
 }
 
-export class SayController
-  extends BaseCrudController<SayModel>
+export class SayController<ResponseWrapper>
+  extends BaseCrudController<SayModel, ResponseWrapper>
   implements IController
 {
   base = 'says'
@@ -22,7 +27,7 @@ export class SayController
     autoBind(this)
   }
 
-  public get proxy() {
+  public get proxy(): IRequestHandler<ResponseWrapper> {
     return this.client.proxy(this.base)
   }
 

package/controllers/search.ts

@@ -1,3 +1,4 @@
+import { IRequestAdapter } from '~/interfaces/adapter'
 import { IController } from '~/interfaces/controller'
 import { IRequestHandler, RequestProxyResult } from '~/interfaces/request'
 import { PaginateResult } from '~/models/base'
@@ -8,8 +9,11 @@ import { PageModel } from '..'
 import { HTTPClient } from '../core'
 
 declare module '../core/client' {
-  interface HTTPClient {
-    search: SearchController
+  interface HTTPClient<
+    T extends IRequestAdapter = IRequestAdapter,
+    ResponseWrapper = unknown,
+  > {
+    search: SearchController<ResponseWrapper>
   }
 }
 
@@ -20,7 +24,7 @@ export type SearchOption = {
   order?: number
   rawAlgolia?: boolean
 }
-export class SearchController implements IController {
+export class SearchController<ResponseWrapper> implements IController {
   base = 'search'
   name = 'search'
 
@@ -28,7 +32,7 @@ export class SearchController implements IController {
     autoBind(this)
   }
 
-  get proxy(): IRequestHandler {
+  get proxy(): IRequestHandler<ResponseWrapper> {
     return this.client.proxy(this.base)
   }
 
@@ -40,7 +44,8 @@ export class SearchController implements IController {
     RequestProxyResult<
       PaginateResult<
         Pick<NoteModel, 'modified' | 'id' | 'title' | 'created' | 'nid'>
-      >
+      >,
+      ResponseWrapper
     >
   >
   search(
@@ -54,7 +59,8 @@ export class SearchController implements IController {
           PostModel,
           'modified' | 'id' | 'title' | 'created' | 'slug' | 'category'
         >
-      >
+      >,
+      ResponseWrapper
     >
   >
   search(
@@ -94,7 +100,8 @@ export class SearchController implements IController {
            * @see: algoliasearch <https://www.algolia.com/doc/api-reference/api-methods/search/>
            */
           raw?: any
-        }
+        },
+        ResponseWrapper
       >
     >({ params: { keyword, ...options } })
   }

package/controllers/severless.ts

@@ -0,0 +1,31 @@
+import { IRequestAdapter } from '~/interfaces/adapter'
+import { IController } from '~/interfaces/controller'
+import { IRequestHandler } from '~/interfaces/request'
+import { autoBind } from '~/utils/auto-bind'
+import { HTTPClient } from '../core'
+
+declare module '../core/client' {
+  interface HTTPClient<
+    T extends IRequestAdapter = IRequestAdapter,
+    ResponseWrapper = unknown,
+  > {
+    serverless: ServerlessController<ResponseWrapper>
+  }
+}
+
+export class ServerlessController<ResponseWrapper> implements IController {
+  base = 'serverless'
+  name = 'serverless'
+
+  constructor(protected client: HTTPClient) {
+    autoBind(this)
+  }
+
+  get proxy(): IRequestHandler<ResponseWrapper> {
+    return this.client.proxy(this.base)
+  }
+
+  getByReferenceAndName<T = unknown>(reference: string, name: string) {
+    return this.proxy(reference)(name).get<T>()
+  }
+}

package/controllers/snippet.ts

@@ -1,15 +1,20 @@
+import { IRequestAdapter } from '~/interfaces/adapter'
 import { IController } from '~/interfaces/controller'
+import { IRequestHandler } from '~/interfaces/request'
 import { SnippetModel } from '~/models/snippet'
 import { autoBind } from '~/utils/auto-bind'
 import { HTTPClient } from '../core'
 
 declare module '../core/client' {
-  interface HTTPClient {
-    snippet: SnippetController
+  interface HTTPClient<
+    T extends IRequestAdapter = IRequestAdapter,
+    ResponseWrapper = unknown,
+  > {
+    snippet: SnippetController<ResponseWrapper>
   }
 }
 
-export class SnippetController implements IController {
+export class SnippetController<ResponseWrapper> implements IController {
   base = 'snippets'
   name = 'snippet'
 
@@ -17,12 +22,12 @@ export class SnippetController implements IController {
     autoBind(this)
   }
 
-  get proxy() {
+  get proxy(): IRequestHandler<ResponseWrapper> {
     return this.client.proxy(this.base)
   }
 
-  getById<T = unknown>(id: string) {
-    return this.proxy(id).get<SnippetModel<T>>()
+  getById(id: string) {
+    return this.proxy(id).get<Omit<SnippetModel, 'data'>>()
   }
 
   getByReferenceAndName<T = unknown>(reference: string, name: string) {

package/controllers/user.ts

@@ -1,16 +1,21 @@
+import { IRequestAdapter } from '~/interfaces/adapter'
 import { IController } from '~/interfaces/controller'
+import { IRequestHandler } from '~/interfaces/request'
 import { TLogin, UserModel } from '~/models/user'
 import { autoBind } from '~/utils/auto-bind'
 import { HTTPClient } from '../core'
 
 declare module '../core/client' {
-  interface HTTPClient {
-    user: UserController
-    master: UserController
+  interface HTTPClient<
+    T extends IRequestAdapter = IRequestAdapter,
+    ResponseWrapper = unknown,
+  > {
+    user: UserController<ResponseWrapper>
+    master: UserController<ResponseWrapper>
   }
 }
 
-export class UserController implements IController {
+export class UserController<ResponseWrapper> implements IController {
   constructor(private readonly client: HTTPClient) {
     autoBind(this)
   }
@@ -19,7 +24,7 @@ export class UserController implements IController {
 
   name = ['user', 'master']
 
-  public get proxy() {
+  public get proxy(): IRequestHandler<ResponseWrapper> {
     return this.client.proxy(this.base)
   }
 

package/core/attach-request.ts

@@ -1,6 +1,6 @@
 import type { HTTPClient } from '.'
 
-export function attachRequestMethod<T extends HTTPClient>(target: T) {
+export function attachRequestMethod<T extends HTTPClient<any, any>>(target: T) {
   Object.defineProperty(target, '$$get', {
     value: function (url: string, options?: any) {
       // HINT: method get only accept search params;