@mx-space/api-client 0.9.3 → 0.9.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (21) hide show
  1. package/build/index.cjs.js +4 -8
  2. package/build/index.cjs.js.map +1 -1
  3. package/build/index.cjs.min.js +1 -1
  4. package/build/index.cjs.min.js.map +1 -1
  5. package/build/index.esm.js +4 -8
  6. package/build/index.esm.js.map +1 -1
  7. package/build/index.esm.min.js +1 -1
  8. package/build/index.esm.min.js.map +1 -1
  9. package/build/index.umd.js +4 -8
  10. package/build/index.umd.js.map +1 -1
  11. package/build/index.umd.min.js +1 -1
  12. package/build/index.umd.min.js.map +1 -1
  13. package/controllers/note.ts +28 -11
  14. package/esm/controllers/note.d.ts +17 -20
  15. package/esm/controllers/note.js +4 -8
  16. package/esm/controllers/note.js.map +1 -1
  17. package/lib/controllers/note.d.ts +17 -20
  18. package/lib/controllers/note.js +4 -8
  19. package/lib/controllers/note.js.map +1 -1
  20. package/package.json +2 -2
  21. package/types/controllers/note.d.ts +17 -20
package/types/controllers/note.d.ts CHANGED
@@ -1,10 +1,10 @@
1
- import { IRequestAdapter } from '../interfaces/adapter';
2
- import { IController } from '../interfaces/controller';
3
- import { IRequestHandler } from '../interfaces/request';
4
- import { SelectFields } from '../interfaces/types';
5
- import { PaginateResult } from '../models/base';
6
- import { NoteModel, NoteWrappedPayload } from '../models/note';
7
- import { HTTPClient } from '../core/client';
1
+ import type { IRequestAdapter } from '../interfaces/adapter';
2
+ import type { IController } from '../interfaces/controller';
3
+ import type { IRequestHandler, RequestProxyResult } from '../interfaces/request';
4
+ import type { SelectFields } from '../interfaces/types';
5
+ import type { PaginateResult } from '../models/base';
6
+ import type { NoteModel, NoteWrappedPayload } from '../models/note';
7
+ import type { HTTPClient } from '../core/client';
8
8
  declare module '../core/client' {
9
9
  interface HTTPClient<T extends IRequestAdapter = IRequestAdapter, ResponseWrapper = unknown> {
10
10
  note: NoteController<ResponseWrapper>;
@@ -25,7 +25,7 @@ export declare class NoteController<ResponseWrapper> implements IController {
25
25
  /**
26
26
  * 最新日记
27
27
  */
28
- getLatest(): import("../interfaces/request").RequestProxyResult<NoteWrappedPayload, ResponseWrapper, ResponseWrapper extends unknown ? {
28
+ getLatest(): RequestProxyResult<NoteWrappedPayload, ResponseWrapper, ResponseWrapper extends unknown ? {
29
29
  [key: string]: any;
30
30
  data: NoteWrappedPayload;
31
31
  } : ResponseWrapper extends {
@@ -34,22 +34,19 @@ export declare class NoteController<ResponseWrapper> implements IController {
34
34
  data: NoteWrappedPayload;
35
35
  }>;
36
36
  /**
37
- * 获取一篇日记
37
+ * 获取一篇日记, 根据 Id 查询需要鉴权
38
38
  * @param id id | nid
39
39
  * @param password 访问密码
40
40
  */
41
- getNoteById(id: string | number, password?: string): import("../interfaces/request").RequestProxyResult<NoteWrappedPayload, ResponseWrapper, ResponseWrapper extends unknown ? {
42
- [key: string]: any;
43
- data: NoteWrappedPayload;
44
- } : ResponseWrapper extends {
45
- data: NoteWrappedPayload;
46
- } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
47
- data: NoteWrappedPayload;
48
- }>;
41
+ getNoteById(id: string): Promise<RequestProxyResult<NoteModel, ResponseWrapper>>;
42
+ getNoteById(id: number): Promise<NoteWrappedPayload>;
43
+ getNoteById(id: number, password: string): Promise<NoteWrappedPayload>;
44
+ getNoteById(id: number, password: undefined, singleResult: true): Promise<RequestProxyResult<NoteModel, ResponseWrapper>>;
45
+ getNoteById(id: number, password: string, singleResult: true): Promise<RequestProxyResult<NoteModel, ResponseWrapper>>;
49
46
  /**
50
47
  * 日记列表分页
51
48
  */
52
- getList(page?: number, perPage?: number, options?: NoteListOptions): import("../interfaces/request").RequestProxyResult<PaginateResult<NoteModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
49
+ getList(page?: number, perPage?: number, options?: NoteListOptions): RequestProxyResult<PaginateResult<NoteModel>, ResponseWrapper, ResponseWrapper extends unknown ? {
53
50
  [key: string]: any;
54
51
  data: PaginateResult<NoteModel>;
55
52
  } : ResponseWrapper extends {
@@ -60,7 +57,7 @@ export declare class NoteController<ResponseWrapper> implements IController {
60
57
  /**
61
58
  * 获取当前日记的上下各 n / 2 篇日记
62
59
  */
63
- getMiddleList(id: string, size?: number): import("../interfaces/request").RequestProxyResult<{
60
+ getMiddleList(id: string, size?: number): RequestProxyResult<{
64
61
  data: Pick<NoteModel, 'id' | 'title' | 'nid' | 'created'>[];
65
62
  size: number;
66
63
  }, ResponseWrapper, ResponseWrapper extends unknown ? {
@@ -83,7 +80,7 @@ export declare class NoteController<ResponseWrapper> implements IController {
83
80
  /**
84
81
  * 喜欢这篇日记
85
82
  */
86
- likeIt(id: string | number): import("../interfaces/request").RequestProxyResult<never, ResponseWrapper, ResponseWrapper extends unknown ? {
83
+ likeIt(id: string | number): RequestProxyResult<never, ResponseWrapper, ResponseWrapper extends unknown ? {
87
84
  [key: string]: any;
88
85
  data: never;
89
86
  } : ResponseWrapper extends {