@mx-space/api-client 0.10.3 → 0.10.6

package/lib/controllers/base.d.ts

@@ -1,6 +1,10 @@
 import type { IRequestHandler, RequestProxyResult } from '../interfaces/request';
 import type { PaginateResult } from '../models/base';
 import type { HTTPClient } from '../core';
+export declare type SortOptions = {
+    sortBy?: string;
+    sortOrder?: 1 | -1 | 'asc' | 'desc';
+};
 export declare abstract class BaseCrudController<T, ResponseWrapper> {
     protected client: HTTPClient;
     base: string;
@@ -28,7 +32,7 @@ export declare abstract class BaseCrudController<T, ResponseWrapper> {
      * @param page
      * @param perPage
      */
-    getAllPaginated(page?: number, perPage?: number): RequestProxyResult<PaginateResult<T>, ResponseWrapper, ResponseWrapper extends unknown ? {
+    getAllPaginated(page?: number, perPage?: number, sortOption?: SortOptions): RequestProxyResult<PaginateResult<T>, ResponseWrapper, ResponseWrapper extends unknown ? {
         [key: string]: any;
         data: PaginateResult<T>;
     } : ResponseWrapper extends {

package/lib/controllers/base.js

@@ -21,9 +21,9 @@ class BaseCrudController {
      * @param page
      * @param perPage
      */
-    getAllPaginated(page, perPage) {
+    getAllPaginated(page, perPage, sortOption) {
         return this.proxy.get({
-            params: { page, size: perPage },
+            params: { page, size: perPage, ...sortOption },
         });
     }
 }

package/lib/controllers/base.js.map

@@ -1 +1 @@
-{"version":3,"file":"base.js","sourceRoot":"","sources":["../../controllers/base.ts"],"names":[],"mappings":";;;AAEA,iDAA4C;AAI5C,MAAsB,kBAAkB;IAEtC,YAAsB,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;QACtC,IAAA,oBAAQ,EAAC,IAAI,CAAC,CAAA;IAChB,CAAC;IACD,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACrC,CAAC;IAED,OAAO,CAAC,EAAU;QAChB,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,EAAK,CAAA;IAChC,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAiB,CAAA;IAC5C,CAAC;IACD;;;;OAIG;IACH,eAAe,CAAC,IAAa,EAAE,OAAgB;QAC7C,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAoB;YACvC,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE;SAChC,CAAC,CAAA;IACJ,CAAC;CACF;AA1BD,gDA0BC"}
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../controllers/base.ts"],"names":[],"mappings":";;;AAEA,iDAA4C;AAQ5C,MAAsB,kBAAkB;IAEtC,YAAsB,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;QACtC,IAAA,oBAAQ,EAAC,IAAI,CAAC,CAAA;IAChB,CAAC;IACD,IAAW,KAAK;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACrC,CAAC;IAED,OAAO,CAAC,EAAU;QAChB,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,EAAK,CAAA;IAChC,CAAC;IAED,MAAM;QACJ,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,EAAiB,CAAA;IAC5C,CAAC;IACD;;;;OAIG;IACH,eAAe,CAAC,IAAa,EAAE,OAAgB,EAAE,UAAwB;QACvE,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAoB;YACvC,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,UAAU,EAAE;SAC/C,CAAC,CAAA;IACJ,CAAC;CACF;AA1BD,gDA0BC"}

package/lib/controllers/note.d.ts

@@ -5,6 +5,7 @@ import type { SelectFields } from '../interfaces/types';
 import type { PaginateResult } from '../models/base';
 import type { NoteModel, NoteWrappedPayload } from '../models/note';
 import type { HTTPClient } from '../core/client';
+import type { SortOptions } from './base';
 declare module '../core/client' {
     interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
         note: NoteController<ResponseWrapper>;
@@ -91,7 +92,7 @@ export declare class NoteController<ResponseWrapper> implements IController {
     /**
      * 获取专栏内的所有日记
      */
-    getNoteByTopicId(topicId: string, page?: number, size?: number): RequestProxyResult<PaginateResult<NoteModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
+    getNoteByTopicId(topicId: string, page?: number, size?: number, sortOptions?: SortOptions): RequestProxyResult<PaginateResult<NoteModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
         [key: string]: any;
         data: PaginateResult<NoteModel>;
     } : ResponseWrapper extends {

package/lib/controllers/note.js

@@ -62,9 +62,9 @@ class NoteController {
     /**
      * 获取专栏内的所有日记
      */
-    getNoteByTopicId(topicId, page = 1, size = 10) {
+    getNoteByTopicId(topicId, page = 1, size = 10, sortOptions = {}) {
         return this.proxy.topics(topicId).get({
-            params: { page, size },
+            params: { page, size, ...sortOptions },
         });
     }
 }

package/lib/controllers/note.js.map

@@ -1 +1 @@
-{"version":3,"file":"note.js","sourceRoot":"","sources":["../../controllers/note.ts"],"names":[],"mappings":";;;AAMA,iDAA4C;AAoB5C,MAAa,cAAc;IAIzB,YAAoB,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;QAHtC,SAAI,GAAG,OAAO,CAAA;QACd,SAAI,GAAG,MAAM,CAAA;QAGX,IAAA,oBAAQ,EAAC,IAAI,CAAC,CAAA;IAChB,CAAC;IACD,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACrC,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,EAAsB,CAAA;IACpD,CAAC;IAuBD,WAAW,CAAC,GAAG,IAAW;QACxB,MAAM,CAAC,EAAE,EAAE,QAAQ,GAAG,SAAS,EAAE,YAAY,GAAG,KAAK,CAAC,GAAG,IAAI,CAAA;QAE7D,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAqB;gBAC3D,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE;aAC7D,CAAC,CAAA;SACH;aAAM;YACL,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,EAAa,CAAA;SACvC;IACH,CAAC;IAED;;OAEG;IAEH,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,OAAO,GAAG,EAAE,EAAE,UAA2B,EAAE;QAC3D,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,OAAO,CAAA;QACnD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAA4B;YAC/C,MAAM,EAAE;gBACN,IAAI;gBACJ,IAAI,EAAE,OAAO;gBACb,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC;gBACzB,MAAM;gBACN,SAAS;gBACT,IAAI;aACL;SACF,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,EAAU,EAAE,IAAI,GAAG,CAAC;QAChC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,CAG3B;YACD,MAAM,EAAE,EAAE,IAAI,EAAE;SACjB,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAmB;QACxB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,EAAS,CAAA;IACzC,CAAC;IAED;;OAEG;IACH,gBAAgB,CAAC,OAAe,EAAE,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,EAAE;QACnD,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAA4B;YAC/D,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;SACvB,CAAC,CAAA;IACJ,CAAC;CACF;AAhGD,wCAgGC"}
+{"version":3,"file":"note.js","sourceRoot":"","sources":["../../controllers/note.ts"],"names":[],"mappings":";;;AAMA,iDAA4C;AAqB5C,MAAa,cAAc;IAIzB,YAAoB,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;QAHtC,SAAI,GAAG,OAAO,CAAA;QACd,SAAI,GAAG,MAAM,CAAA;QAGX,IAAA,oBAAQ,EAAC,IAAI,CAAC,CAAA;IAChB,CAAC;IACD,IAAI,KAAK;QACP,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACrC,CAAC;IAED;;OAEG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,EAAsB,CAAA;IACpD,CAAC;IAuBD,WAAW,CAAC,GAAG,IAAW;QACxB,MAAM,CAAC,EAAE,EAAE,QAAQ,GAAG,SAAS,EAAE,YAAY,GAAG,KAAK,CAAC,GAAG,IAAI,CAAA;QAE7D,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE;YAC1B,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC,GAAG,CAAqB;gBAC3D,MAAM,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE;aAC7D,CAAC,CAAA;SACH;aAAM;YACL,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,GAAG,EAAa,CAAA;SACvC;IACH,CAAC;IAED;;OAEG;IAEH,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,OAAO,GAAG,EAAE,EAAE,UAA2B,EAAE;QAC3D,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,OAAO,CAAA;QACnD,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,CAA4B;YAC/C,MAAM,EAAE;gBACN,IAAI;gBACJ,IAAI,EAAE,OAAO;gBACb,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC;gBACzB,MAAM;gBACN,SAAS;gBACT,IAAI;aACL;SACF,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,aAAa,CAAC,EAAU,EAAE,IAAI,GAAG,CAAC;QAChC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,CAG3B;YACD,MAAM,EAAE,EAAE,IAAI,EAAE;SACjB,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAmB;QACxB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,GAAG,EAAS,CAAA;IACzC,CAAC;IAED;;OAEG;IACH,gBAAgB,CACd,OAAe,EACf,IAAI,GAAG,CAAC,EACR,IAAI,GAAG,EAAE,EACT,cAA2B,EAAE;QAE7B,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,GAAG,CAA4B;YAC/D,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,WAAW,EAAE;SACvC,CAAC,CAAA;IACJ,CAAC;CACF;AArGD,wCAqGC"}

package/lib/core/attach-request.js

@@ -7,7 +7,7 @@ function attachRequestMethod(target) {
             // HINT: method get only accept search params;
             const { params = {} } = options;
             const qs = handleSearchParams(params);
-            return target.instance.get(`${url}${qs ? `${`?${qs}`}` : ''}`);
+            return target.instance.get(`${url}${qs ? `${`?${qs}`}` : ''}`, options);
         },
     });
     ['put', 'post', 'patch', 'delete'].forEach((method) => {

package/lib/core/attach-request.js.map

@@ -1 +1 @@
-{"version":3,"file":"attach-request.js","sourceRoot":"","sources":["../../core/attach-request.ts"],"names":[],"mappings":";;;AAEA,SAAgB,mBAAmB,CAAiC,MAAS;IAC3E,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE;QACrC,KAAK,CAAC,GAAW,EAAE,OAAa;YAC9B,8CAA8C;YAC9C,MAAM,EAAE,MAAM,GAAG,EAAE,EAAE,GAAG,OAAO,CAAA;YAC/B,MAAM,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAA;YAErC,OAAO,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAA;QAChE,CAAC;KACF,CAAC,CACD;IAAC,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAW,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QAChE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,KAAK,MAAM,EAAE,EAAE;YAC3C,KAAK,CAAC,IAAY,EAAE,OAAa;gBAC/B,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;YAC/C,CAAC;SACF,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC;AAjBD,kDAiBC;AACD,mCAAmC;AACnC,SAAS,kBAAkB,CAAC,GAA6C;IACvE,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QACnC,MAAM,IAAI,SAAS,CAAC,wBAAwB,CAAC,CAAA;KAC9C;IAED,IAAI,GAAG,YAAY,eAAe,EAAE;QAClC,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAA;KACtB;IACD,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAA;IAEpC,MAAM,CAAC,OAAO,CAAM,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;QAC1C,IACE,OAAO,CAAC,KAAK,WAAW;YACxB,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,eAAe,EACrD;YACA,OAAM;SACP;QACD,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAClB,CAAC,CAAC,CAAA;IAEF,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAA;AAC1B,CAAC"}
+{"version":3,"file":"attach-request.js","sourceRoot":"","sources":["../../core/attach-request.ts"],"names":[],"mappings":";;;AAEA,SAAgB,mBAAmB,CAAiC,MAAS;IAC3E,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,EAAE;QACrC,KAAK,CAAC,GAAW,EAAE,OAAa;YAC9B,8CAA8C;YAC9C,MAAM,EAAE,MAAM,GAAG,EAAE,EAAE,GAAG,OAAO,CAAA;YAC/B,MAAM,EAAE,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAA;YAErC,OAAO,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,GAAG,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,CAAA;QACzE,CAAC;KACF,CAAC,CACD;IAAC,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAW,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;QAChE,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,KAAK,MAAM,EAAE,EAAE;YAC3C,KAAK,CAAC,IAAY,EAAE,OAAa;gBAC/B,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;YAC/C,CAAC;SACF,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;AACJ,CAAC;AAjBD,kDAiBC;AACD,mCAAmC;AACnC,SAAS,kBAAkB,CAAC,GAA6C;IACvE,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;QACnC,MAAM,IAAI,SAAS,CAAC,wBAAwB,CAAC,CAAA;KAC9C;IAED,IAAI,GAAG,YAAY,eAAe,EAAE;QAClC,OAAO,GAAG,CAAC,QAAQ,EAAE,CAAA;KACtB;IACD,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAA;IAEpC,MAAM,CAAC,OAAO,CAAM,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;QAC1C,IACE,OAAO,CAAC,KAAK,WAAW;YACxB,MAAM,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,eAAe,EACrD;YACA,OAAM;SACP;QACD,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAClB,CAAC,CAAC,CAAA;IAEF,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAA;AAC1B,CAAC"}

package/lib/models/comment.d.ts

@@ -7,8 +7,9 @@ export declare enum RefType {
 }
 export interface CommentModel extends BaseModel {
     refType: RefType;
+    ref: string;
     state: number;
-    comments_index: number;
+    commentsIndex: number;
     author: string;
     text: string;
     mail?: string;

package/lib/models/comment.js.map

@@ -1 +1 @@
-{"version":3,"file":"comment.js","sourceRoot":"","sources":["../../models/comment.ts"],"names":[],"mappings":";;;AAGA,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,wBAAa,CAAA;IACb,wBAAa,CAAA;IACb,wBAAa,CAAA;AACf,CAAC,EAJW,OAAO,GAAP,eAAO,KAAP,eAAO,QAIlB;AAyBD,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,mDAAM,CAAA;IACN,+CAAI,CAAA;IACJ,+CAAI,CAAA;AACN,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB"}
+{"version":3,"file":"comment.js","sourceRoot":"","sources":["../../models/comment.ts"],"names":[],"mappings":";;;AAGA,IAAY,OAIX;AAJD,WAAY,OAAO;IACjB,wBAAa,CAAA;IACb,wBAAa,CAAA;IACb,wBAAa,CAAA;AACf,CAAC,EAJW,OAAO,GAAP,eAAO,KAAP,eAAO,QAIlB;AA0BD,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,mDAAM,CAAA;IACN,+CAAI,CAAA;IACJ,+CAAI,CAAA;AACN,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB"}

package/lib/vitest.config.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("vitest/dist/config").UserConfig;
+declare const _default: import("vitest/dist/config").UserConfigExport;
 export default _default;

package/models/comment.ts

@@ -8,8 +8,9 @@ export enum RefType {
 }
 export interface CommentModel extends BaseModel {
   refType: RefType
+  ref: string
   state: number
-  comments_index: number
+  commentsIndex: number
   author: string
   text: string
   mail?: string

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mx-space/api-client",
-  "version": "0.10.3",
+  "version": "0.10.6",
   "description": "A api client for mx-space server@next",
   "author": "Innei",
   "license": "MIT",
@@ -51,9 +51,9 @@
     "@types/lodash": "4.14.182",
     "@types/node": "16.11.36",
     "axios": "0.27.2",
-    "gh-pages": "3.2.3",
+    "gh-pages": "4.0.0",
     "lodash": "4.17.21",
-    "rollup": "2.72.1",
+    "rollup": "2.74.1",
     "rollup-plugin-peer-deps-external": "2.2.4",
     "rollup-plugin-terser": "7.0.2",
     "tsconfig-replace-paths": "0.0.11",

package/readme.md

@@ -81,3 +81,19 @@ client.post.post.getList(page, 10, { year }).then((data) => {
 **如果不使用 axios，应该如何编写适配器**
 
 参考 `src/adaptors/axios.ts` 和 `src/adaptors/umi-request.ts`
+
+**如何使用 proxy 来访问 sdk 内未包含的请求**
+
+如请求 `GET /notes/something/other/123456/info`，可以使用
+
+```ts
+client.note.proxy.something.other('123456').info.get()
+```
+
+**从 proxy 获取请求地址但不发出**
+
+```ts
+client.note.proxy.something.other('123456').info.toString() // /notes/something/other/123456/info
+
+client.note.proxy.something.other('123456').info.toString(true) // http://localhost:2333/notes/something/other/123456/info
+```

package/types/controllers/base.d.ts

@@ -1,6 +1,10 @@
 import type { IRequestHandler, RequestProxyResult } from '../interfaces/request';
 import type { PaginateResult } from '../models/base';
 import type { HTTPClient } from '../core';
+export declare type SortOptions = {
+    sortBy?: string;
+    sortOrder?: 1 | -1 | 'asc' | 'desc';
+};
 export declare abstract class BaseCrudController<T, ResponseWrapper> {
     protected client: HTTPClient;
     base: string;
@@ -28,7 +32,7 @@ export declare abstract class BaseCrudController<T, ResponseWrapper> {
      * @param page
      * @param perPage
      */
-    getAllPaginated(page?: number, perPage?: number): RequestProxyResult<PaginateResult<T>, ResponseWrapper, ResponseWrapper extends unknown ? {
+    getAllPaginated(page?: number, perPage?: number, sortOption?: SortOptions): RequestProxyResult<PaginateResult<T>, ResponseWrapper, ResponseWrapper extends unknown ? {
         [key: string]: any;
         data: PaginateResult<T>;
     } : ResponseWrapper extends {

package/types/controllers/note.d.ts

@@ -5,6 +5,7 @@ import type { SelectFields } from '../interfaces/types';
 import type { PaginateResult } from '../models/base';
 import type { NoteModel, NoteWrappedPayload } from '../models/note';
 import type { HTTPClient } from '../core/client';
+import type { SortOptions } from './base';
 declare module '../core/client' {
     interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
         note: NoteController<ResponseWrapper>;
@@ -91,7 +92,7 @@ export declare class NoteController<ResponseWrapper> implements IController {
     /**
      * 获取专栏内的所有日记
      */
-    getNoteByTopicId(topicId: string, page?: number, size?: number): RequestProxyResult<PaginateResult<NoteModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
+    getNoteByTopicId(topicId: string, page?: number, size?: number, sortOptions?: SortOptions): RequestProxyResult<PaginateResult<NoteModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
         [key: string]: any;
         data: PaginateResult<NoteModel>;
     } : ResponseWrapper extends {

package/types/models/comment.d.ts

@@ -7,8 +7,9 @@ export declare enum RefType {
 }
 export interface CommentModel extends BaseModel {
     refType: RefType;
+    ref: string;
     state: number;
-    comments_index: number;
+    commentsIndex: number;
     author: string;
     text: string;
     mail?: string;

package/types/vitest.config.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("vitest/dist/config").UserConfig;
+declare const _default: import("vitest/dist/config").UserConfigExport;
 export default _default;