@mx-space/api-client 0.10.10 → 0.10.13

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 (45) hide show
  1. package/build/index.cjs.js +16 -0
  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 +17 -1
  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 +16 -0
  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/user.ts +10 -0
  14. package/esm/controllers/category.d.ts +3 -3
  15. package/esm/controllers/search.d.ts +48 -48
  16. package/esm/controllers/user.d.ts +16 -0
  17. package/esm/controllers/user.js +9 -0
  18. package/esm/controllers/user.js.map +1 -1
  19. package/esm/models/comment.d.ts +1 -0
  20. package/esm/models/comment.js.map +1 -1
  21. package/esm/models/post.d.ts +1 -0
  22. package/esm/models/recently.d.ts +20 -0
  23. package/esm/models/recently.js +6 -1
  24. package/esm/models/recently.js.map +1 -1
  25. package/lib/controllers/category.d.ts +3 -3
  26. package/lib/controllers/search.d.ts +48 -48
  27. package/lib/controllers/user.d.ts +16 -0
  28. package/lib/controllers/user.js +9 -0
  29. package/lib/controllers/user.js.map +1 -1
  30. package/lib/models/comment.d.ts +1 -0
  31. package/lib/models/comment.js.map +1 -1
  32. package/lib/models/post.d.ts +1 -0
  33. package/lib/models/recently.d.ts +20 -0
  34. package/lib/models/recently.js +7 -0
  35. package/lib/models/recently.js.map +1 -1
  36. package/models/comment.ts +2 -0
  37. package/models/post.ts +11 -0
  38. package/models/recently.ts +20 -0
  39. package/package.json +1 -1
  40. package/types/controllers/category.d.ts +3 -3
  41. package/types/controllers/search.d.ts +48 -48
  42. package/types/controllers/user.d.ts +16 -0
  43. package/types/models/comment.d.ts +1 -0
  44. package/types/models/post.d.ts +1 -0
  45. package/types/models/recently.d.ts +20 -0
package/types/controllers/search.d.ts CHANGED
@@ -32,11 +32,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
32
32
  * @param options
33
33
  * @returns
34
34
  */
35
- searchByAlgolia(keyword: string, options?: SearchOption): RequestProxyResult<RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
35
+ searchByAlgolia(keyword: string, options?: SearchOption): RequestProxyResult<RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
36
36
  type: 'post';
37
- }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
37
+ }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
38
38
  type: 'note';
39
- }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
39
+ }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
40
40
  type: 'page';
41
41
  })> & {
42
42
  /**
@@ -45,11 +45,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
45
45
  raw?: any;
46
46
  }, ResponseWrapper, ResponseWrapper extends unknown ? {
47
47
  [key: string]: any;
48
- data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
48
+ data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
49
49
  type: 'post';
50
- }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
50
+ }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
51
51
  type: 'note';
52
- }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
52
+ }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
53
53
  type: 'page';
54
54
  })> & {
55
55
  /**
@@ -58,11 +58,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
58
58
  raw?: any;
59
59
  };
60
60
  } : ResponseWrapper extends {
61
- data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
61
+ data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
62
62
  type: 'post';
63
- }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
63
+ }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
64
64
  type: 'note';
65
- }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
65
+ }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
66
66
  type: 'page';
67
67
  })> & {
68
68
  /**
@@ -71,11 +71,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
71
71
  raw?: any;
72
72
  };
73
73
  } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
74
- data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
74
+ data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
75
75
  type: 'post';
76
- }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
76
+ }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
77
77
  type: 'note';
78
- }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
78
+ }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
79
79
  type: 'page';
80
80
  })> & {
81
81
  /**
@@ -85,11 +85,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
85
85
  };
86
86
  }>, ResponseWrapper, ResponseWrapper extends unknown ? {
87
87
  [key: string]: any;
88
- data: RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
88
+ data: RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
89
89
  type: 'post';
90
- }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
90
+ }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
91
91
  type: 'note';
92
- }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
92
+ }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
93
93
  type: 'page';
94
94
  })> & {
95
95
  /**
@@ -98,11 +98,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
98
98
  raw?: any;
99
99
  }, ResponseWrapper, ResponseWrapper extends unknown ? {
100
100
  [key: string]: any;
101
- data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
101
+ data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
102
102
  type: 'post';
103
- }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
103
+ }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
104
104
  type: 'note';
105
- }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
105
+ }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
106
106
  type: 'page';
107
107
  })> & {
108
108
  /**
@@ -111,11 +111,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
111
111
  raw?: any;
112
112
  };
113
113
  } : ResponseWrapper extends {
114
- data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
114
+ data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
115
115
  type: 'post';
116
- }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
116
+ }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
117
117
  type: 'note';
118
- }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
118
+ }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
119
119
  type: 'page';
120
120
  })> & {
121
121
  /**
@@ -124,11 +124,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
124
124
  raw?: any;
125
125
  };
126
126
  } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
127
- data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
127
+ data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
128
128
  type: 'post';
129
- }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
129
+ }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
130
130
  type: 'note';
131
- }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
131
+ }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
132
132
  type: 'page';
133
133
  })> & {
134
134
  /**
@@ -138,11 +138,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
138
138
  };
139
139
  }>;
140
140
  } : ResponseWrapper extends {
141
- data: RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
141
+ data: RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
142
142
  type: 'post';
143
- }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
143
+ }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
144
144
  type: 'note';
145
- }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
145
+ }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
146
146
  type: 'page';
147
147
  })> & {
148
148
  /**
@@ -151,11 +151,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
151
151
  raw?: any;
152
152
  }, ResponseWrapper, ResponseWrapper extends unknown ? {
153
153
  [key: string]: any;
154
- data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
154
+ data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
155
155
  type: 'post';
156
- }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
156
+ }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
157
157
  type: 'note';
158
- }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
158
+ }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
159
159
  type: 'page';
160
160
  })> & {
161
161
  /**
@@ -164,11 +164,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
164
164
  raw?: any;
165
165
  };
166
166
  } : ResponseWrapper extends {
167
- data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
167
+ data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
168
168
  type: 'post';
169
- }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
169
+ }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
170
170
  type: 'note';
171
- }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
171
+ }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
172
172
  type: 'page';
173
173
  })> & {
174
174
  /**
@@ -177,11 +177,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
177
177
  raw?: any;
178
178
  };
179
179
  } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
180
- data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
180
+ data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
181
181
  type: 'post';
182
- }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
182
+ }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
183
183
  type: 'note';
184
- }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
184
+ }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
185
185
  type: 'page';
186
186
  })> & {
187
187
  /**
@@ -191,11 +191,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
191
191
  };
192
192
  }>;
193
193
  } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
194
- data: RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
194
+ data: RequestProxyResult<PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
195
195
  type: 'post';
196
- }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
196
+ }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
197
197
  type: 'note';
198
- }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
198
+ }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
199
199
  type: 'page';
200
200
  })> & {
201
201
  /**
@@ -204,11 +204,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
204
204
  raw?: any;
205
205
  }, ResponseWrapper, ResponseWrapper extends unknown ? {
206
206
  [key: string]: any;
207
- data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
207
+ data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
208
208
  type: 'post';
209
- }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
209
+ }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
210
210
  type: 'note';
211
- }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
211
+ }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
212
212
  type: 'page';
213
213
  })> & {
214
214
  /**
@@ -217,11 +217,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
217
217
  raw?: any;
218
218
  };
219
219
  } : ResponseWrapper extends {
220
- data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
220
+ data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
221
221
  type: 'post';
222
- }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
222
+ }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
223
223
  type: 'note';
224
- }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
224
+ }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
225
225
  type: 'page';
226
226
  })> & {
227
227
  /**
@@ -230,11 +230,11 @@ export declare class SearchController<ResponseWrapper> implements IController {
230
230
  raw?: any;
231
231
  };
232
232
  } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
233
- data: PaginateResult<(Pick<PostModel, "id" | "title" | "slug" | "modified" | "created" | "category"> & {
233
+ data: PaginateResult<(Pick<PostModel, "id" | "category" | "created" | "modified" | "title" | "slug"> & {
234
234
  type: 'post';
235
- }) | (Pick<NoteModel, "id" | "title" | "modified" | "created" | "nid"> & {
235
+ }) | (Pick<NoteModel, "id" | "created" | "modified" | "title" | "nid"> & {
236
236
  type: 'note';
237
- }) | (Pick<PageModel, "id" | "title" | "slug" | "modified" | "created"> & {
237
+ }) | (Pick<PageModel, "id" | "created" | "modified" | "title" | "slug"> & {
238
238
  type: 'page';
239
239
  })> & {
240
240
  /**
package/types/controllers/user.d.ts CHANGED
@@ -31,6 +31,22 @@ export declare class UserController<ResponseWrapper> implements IController {
31
31
  } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
32
32
  data: TLogin;
33
33
  }>;
34
+ loginWithToken(token?: string): import("../interfaces/request").RequestProxyResult<{
35
+ token: string;
36
+ }, ResponseWrapper, ResponseWrapper extends unknown ? {
37
+ [key: string]: any;
38
+ data: {
39
+ token: string;
40
+ };
41
+ } : ResponseWrapper extends {
42
+ data: {
43
+ token: string;
44
+ };
45
+ } ? ResponseWrapper : Omit<ResponseWrapper, "data"> & {
46
+ data: {
47
+ token: string;
48
+ };
49
+ }>;
34
50
  checkTokenValid(token: string): import("../interfaces/request").RequestProxyResult<{
35
51
  ok: number;
36
52
  isGuest: boolean;
package/types/models/comment.d.ts CHANGED
@@ -21,6 +21,7 @@ export interface CommentModel extends BaseModel {
21
21
  avatar: string;
22
22
  parent?: CommentModel | string;
23
23
  children: CommentModel[];
24
+ isWhispers?: boolean;
24
25
  }
25
26
  export interface CommentRef {
26
27
  id: string;
package/types/models/post.d.ts CHANGED
@@ -13,4 +13,5 @@ export interface PostModel extends TextBaseModel {
13
13
  category: CategoryModel;
14
14
  pin?: string | null;
15
15
  pinOrder?: number;
16
+ related?: Pick<PostModel, 'id' | 'category' | 'categoryId' | 'created' | 'modified' | 'title' | 'slug' | 'summary'>[];
16
17
  }
package/types/models/recently.d.ts CHANGED
@@ -1,6 +1,26 @@
1
1
  import type { BaseModel } from './base';
2
+ export declare enum RecentlyRefTypes {
3
+ Post = "Post",
4
+ Note = "Note",
5
+ Page = "Page"
6
+ }
7
+ export declare type RecentlyRefType = {
8
+ title: string;
9
+ url: string;
10
+ };
2
11
  export interface RecentlyModel extends BaseModel {
3
12
  content: string;
13
+ ref?: RecentlyRefType & {
14
+ [key: string]: any;
15
+ };
16
+ refId?: string;
17
+ refType?: RecentlyRefTypes;
18
+ /**
19
+ * @deprecated
20
+ */
4
21
  project?: string;
22
+ /**
23
+ * @deprecated
24
+ */
5
25
  language?: string;
6
26
  }