@mx-space/api-client 1.3.3 → 1.3.5

package/dist/index.cjs

@@ -173,9 +173,15 @@ var AggregateController = class {
   get proxy() {
     return this.client.proxy(this.base);
   }
+  /**
+   * 获取聚合数据
+   */
   getAggregateData() {
     return this.proxy.get();
   }
+  /**
+   * 获取最新发布的内容
+   */
   getTop(size = 5) {
     return this.proxy.top.get({ params: { size } });
   }
@@ -189,6 +195,9 @@ var AggregateController = class {
       }
     });
   }
+  /**
+   * 获取聚合数据统计
+   */
   getStat() {
     return this.proxy.stat.get();
   }
@@ -293,20 +302,33 @@ var CommentController = class {
   get proxy() {
     return this.client.proxy(this.base);
   }
+  /**
+   * 根据 comment id 获取评论, 包括子评论
+   */
   getById(id) {
     return this.proxy(id).get();
   }
+  /**
+   * 获取文章的评论列表
+   * @param refId 文章 Id
+   */
   getByRefId(refId, pagination = {}) {
     const { page, size } = pagination;
     return this.proxy.ref(refId).get({
       params: { page: page || 1, size: size || 10 }
     });
   }
+  /**
+   * 评论
+   */
   comment(refId, data) {
     return this.proxy(refId).post({
       data
     });
   }
+  /**
+   * 回复评论
+   */
   reply(commentId, data) {
     return this.proxy.reply(commentId).post({
       data
@@ -329,6 +351,11 @@ var BaseCrudController = class {
   getAll() {
     return this.proxy.all.get();
   }
+  /**
+   * 带分页的查询
+   * @param page
+   * @param perPage
+   */
   getAllPaginated(page, perPage, sortOption) {
     return this.proxy.get({
       params: { page, size: perPage, ...sortOption }
@@ -345,10 +372,12 @@ var LinkController = class extends BaseCrudController {
     this.base = "links";
     autoBind(this);
   }
+  // 是否可以申请友链
   async canApplyLink() {
     const { can } = await this.proxy.audit.get();
     return can;
   }
+  // 申请友链
   async applyLink(data) {
     return await this.proxy.audit.post({ data });
   }
@@ -365,6 +394,9 @@ var NoteController = class {
   get proxy() {
     return this.client.proxy(this.base);
   }
+  /**
+   * 最新日记
+   */
   getLatest() {
     return this.proxy.latest.get();
   }
@@ -378,6 +410,9 @@ var NoteController = class {
       return this.proxy(id).get();
     }
   }
+  /**
+   * 日记列表分页
+   */
   getList(page = 1, perPage = 10, options = {}) {
     const { select, sortBy, sortOrder, year } = options;
     return this.proxy.get({
@@ -391,14 +426,23 @@ var NoteController = class {
       }
     });
   }
+  /**
+   * 获取当前日记的上下各 n / 2 篇日记
+   */
   getMiddleList(id, size = 5) {
     return this.proxy.list(id).get({
       params: { size }
     });
   }
+  /**
+   * 喜欢这篇日记
+   */
   likeIt(id) {
     return this.proxy.like(id).get();
   }
+  /**
+   * 获取专栏内的所有日记
+   */
   getNoteByTopicId(topicId, page = 1, size = 10, sortOptions = {}) {
     return this.proxy.topics(topicId).get({
       params: { page, size, ...sortOptions }
@@ -417,6 +461,9 @@ var PageController = class {
   get proxy() {
     return this.client.proxy(this.base);
   }
+  /**
+   * 页面列表
+   */
   getList(page = 1, perPage = 10, options = {}) {
     const { select, sortBy, sortOrder } = options;
     return this.proxy.get({
@@ -429,9 +476,17 @@ var PageController = class {
       }
     });
   }
+  /**
+   * 页面详情
+   */
   getById(id) {
     return this.proxy(id).get();
   }
+  /**
+   * 根据路径获取页面
+   * @param slug 路径
+   * @returns
+   */
   getBySlug(slug) {
     return this.proxy.slug(slug).get({});
   }
@@ -448,6 +503,12 @@ var PostController = class {
   get proxy() {
     return this.client.proxy(this.base);
   }
+  /**
+   * 获取文章列表分页
+   * @param page
+   * @param perPage
+   * @returns
+   */
   getList(page = 1, perPage = 10, options = {}) {
     const { select, sortBy, sortOrder, year } = options;
     return this.proxy.get({
@@ -468,9 +529,15 @@ var PostController = class {
       return this.proxy(idOrCategoryName)(slug).get();
     }
   }
+  /**
+   * 获取最新的文章
+   */
   getLatest() {
     return this.proxy.latest.get();
   }
+  /**
+   * 点赞
+   */
   thumbsUp(id) {
     return this.proxy("_thumbs-up").get({ params: { id } });
   }
@@ -508,6 +575,9 @@ var RecentlyController = class {
   get proxy() {
     return this.client.proxy(this.base);
   }
+  /**
+   * 获取最新一条
+   */
   getLatestOne() {
     return this.proxy.latest.get();
   }
@@ -523,6 +593,7 @@ var RecentlyController = class {
       }
     });
   }
+  /**  表态：点赞，点踩 */
   attitude(id, attitude) {
     return this.proxy.attitude(id).get({
       params: {
@@ -544,6 +615,9 @@ var SayController = class extends BaseCrudController {
   get proxy() {
     return this.client.proxy(this.base);
   }
+  /**
+   * 获取随机一条
+   */
   getRandom() {
     return this.proxy.random.get();
   }
@@ -565,6 +639,13 @@ var SearchController = class {
       params: { keyword, ...options }
     });
   }
+  /**
+   * 从 algolya 搜索
+   * https://www.algolia.com/doc/api-reference/api-methods/search/
+   * @param keyword
+   * @param options
+   * @returns
+   */
   searchByAlgolia(keyword, options) {
     return this.proxy("algolia").get({ params: { keyword, ...options } });
   }
@@ -597,6 +678,9 @@ var SnippetController = class {
   get proxy() {
     return this.client.proxy(this.base);
   }
+  // getById(id: string) {
+  //   return this.proxy(id).get<Omit<SnippetModel, 'data'>>()
+  // }
   getByReferenceAndName(reference, name) {
     return this.proxy(reference)(name).get();
   }
@@ -613,12 +697,15 @@ var SubscribeController = class {
   get proxy() {
     return this.client.proxy(this.base);
   }
+  /**
+   * 检查开启状态
+   */
   check() {
     return this.proxy.status.get();
   }
   subscribe(email, types) {
     return this.proxy.post({
-      params: {
+      data: {
         email,
         types
       }
@@ -725,6 +812,7 @@ var allContollerNames = [
   "serverless",
   "subscribe",
   "user",
+  // alias,
   "friend",
   "master",
   "shorthand"
@@ -910,6 +998,7 @@ var HTTPClient = class {
           route.push(name);
           return new Proxy(noop, handler);
         },
+        // @ts-ignore
         apply(target, _, args) {
           route.push(...args.filter((x) => x !== null));
           return new Proxy(noop, handler);

package/dist/index.d.ts

@@ -566,6 +566,7 @@ interface CommentModel extends BaseModel {
     parent?: CommentModel | string;
     children: CommentModel[];
     isWhispers?: boolean;
+    location?: string;
 }
 interface CommentRef {
     id: string;

package/dist/index.global.js

@@ -110,9 +110,15 @@
     get proxy() {
       return this.client.proxy(this.base);
     }
+    /**
+     * 获取聚合数据
+     */
     getAggregateData() {
       return this.proxy.get();
     }
+    /**
+     * 获取最新发布的内容
+     */
     getTop(size = 5) {
       return this.proxy.top.get({ params: { size } });
     }
@@ -126,6 +132,9 @@
         }
       });
     }
+    /**
+     * 获取聚合数据统计
+     */
     getStat() {
       return this.proxy.stat.get();
     }
@@ -230,20 +239,33 @@
     get proxy() {
       return this.client.proxy(this.base);
     }
+    /**
+     * 根据 comment id 获取评论, 包括子评论
+     */
     getById(id) {
       return this.proxy(id).get();
     }
+    /**
+     * 获取文章的评论列表
+     * @param refId 文章 Id
+     */
     getByRefId(refId, pagination = {}) {
       const { page, size } = pagination;
       return this.proxy.ref(refId).get({
         params: { page: page || 1, size: size || 10 }
       });
     }
+    /**
+     * 评论
+     */
     comment(refId, data) {
       return this.proxy(refId).post({
         data
       });
     }
+    /**
+     * 回复评论
+     */
     reply(commentId, data) {
       return this.proxy.reply(commentId).post({
         data
@@ -266,6 +288,11 @@
     getAll() {
       return this.proxy.all.get();
     }
+    /**
+     * 带分页的查询
+     * @param page
+     * @param perPage
+     */
     getAllPaginated(page, perPage, sortOption) {
       return this.proxy.get({
         params: { page, size: perPage, ...sortOption }
@@ -282,10 +309,12 @@
       this.base = "links";
       autoBind(this);
     }
+    // 是否可以申请友链
     async canApplyLink() {
       const { can } = await this.proxy.audit.get();
       return can;
     }
+    // 申请友链
     async applyLink(data) {
       return await this.proxy.audit.post({ data });
     }
@@ -302,6 +331,9 @@
     get proxy() {
       return this.client.proxy(this.base);
     }
+    /**
+     * 最新日记
+     */
     getLatest() {
       return this.proxy.latest.get();
     }
@@ -315,6 +347,9 @@
         return this.proxy(id).get();
       }
     }
+    /**
+     * 日记列表分页
+     */
     getList(page = 1, perPage = 10, options = {}) {
       const { select, sortBy, sortOrder, year } = options;
       return this.proxy.get({
@@ -328,14 +363,23 @@
         }
       });
     }
+    /**
+     * 获取当前日记的上下各 n / 2 篇日记
+     */
     getMiddleList(id, size = 5) {
       return this.proxy.list(id).get({
         params: { size }
       });
     }
+    /**
+     * 喜欢这篇日记
+     */
     likeIt(id) {
       return this.proxy.like(id).get();
     }
+    /**
+     * 获取专栏内的所有日记
+     */
     getNoteByTopicId(topicId, page = 1, size = 10, sortOptions = {}) {
       return this.proxy.topics(topicId).get({
         params: { page, size, ...sortOptions }
@@ -354,6 +398,9 @@
     get proxy() {
       return this.client.proxy(this.base);
     }
+    /**
+     * 页面列表
+     */
     getList(page = 1, perPage = 10, options = {}) {
       const { select, sortBy, sortOrder } = options;
       return this.proxy.get({
@@ -366,9 +413,17 @@
         }
       });
     }
+    /**
+     * 页面详情
+     */
     getById(id) {
       return this.proxy(id).get();
     }
+    /**
+     * 根据路径获取页面
+     * @param slug 路径
+     * @returns
+     */
     getBySlug(slug) {
       return this.proxy.slug(slug).get({});
     }
@@ -385,6 +440,12 @@
     get proxy() {
       return this.client.proxy(this.base);
     }
+    /**
+     * 获取文章列表分页
+     * @param page
+     * @param perPage
+     * @returns
+     */
     getList(page = 1, perPage = 10, options = {}) {
       const { select, sortBy, sortOrder, year } = options;
       return this.proxy.get({
@@ -405,9 +466,15 @@
         return this.proxy(idOrCategoryName)(slug).get();
       }
     }
+    /**
+     * 获取最新的文章
+     */
     getLatest() {
       return this.proxy.latest.get();
     }
+    /**
+     * 点赞
+     */
     thumbsUp(id) {
       return this.proxy("_thumbs-up").get({ params: { id } });
     }
@@ -445,6 +512,9 @@
     get proxy() {
       return this.client.proxy(this.base);
     }
+    /**
+     * 获取最新一条
+     */
     getLatestOne() {
       return this.proxy.latest.get();
     }
@@ -460,6 +530,7 @@
         }
       });
     }
+    /**  表态：点赞，点踩 */
     attitude(id, attitude) {
       return this.proxy.attitude(id).get({
         params: {
@@ -481,6 +552,9 @@
     get proxy() {
       return this.client.proxy(this.base);
     }
+    /**
+     * 获取随机一条
+     */
     getRandom() {
       return this.proxy.random.get();
     }
@@ -502,6 +576,13 @@
         params: { keyword, ...options }
       });
     }
+    /**
+     * 从 algolya 搜索
+     * https://www.algolia.com/doc/api-reference/api-methods/search/
+     * @param keyword
+     * @param options
+     * @returns
+     */
     searchByAlgolia(keyword, options) {
       return this.proxy("algolia").get({ params: { keyword, ...options } });
     }
@@ -534,6 +615,9 @@
     get proxy() {
       return this.client.proxy(this.base);
     }
+    // getById(id: string) {
+    //   return this.proxy(id).get<Omit<SnippetModel, 'data'>>()
+    // }
     getByReferenceAndName(reference, name) {
       return this.proxy(reference)(name).get();
     }
@@ -550,12 +634,15 @@
     get proxy() {
       return this.client.proxy(this.base);
     }
+    /**
+     * 检查开启状态
+     */
     check() {
       return this.proxy.status.get();
     }
     subscribe(email, types) {
       return this.proxy.post({
-        params: {
+        data: {
           email,
           types
         }
@@ -662,6 +749,7 @@
     "serverless",
     "subscribe",
     "user",
+    // alias,
     "friend",
     "master",
     "shorthand"
@@ -847,6 +935,7 @@
             route.push(name);
             return new Proxy(noop, handler);
           },
+          // @ts-ignore
           apply(target, _, args) {
             route.push(...args.filter((x) => x !== null));
             return new Proxy(noop, handler);