@mx-space/api-client 0.0.5 → 0.3.1

package/build/index.esm.js

@@ -360,6 +360,44 @@ var camelcaseKeys = (input, options) => {
 
 const isPlainObject = (obj) => typeof obj === 'object' &&
     Object.prototype.toString.call(obj) === '[object Object]';
+const sortOrderToNumber = (order) => {
+    return ({
+        asc: 1,
+        desc: -1,
+    }[order] || 1);
+};
+const destructureData = (payload) => {
+    if (typeof payload !== 'object') {
+        return payload;
+    }
+    if (payload === null) {
+        return payload;
+    }
+    const data = payload.data;
+    const dataIsPlainObject = Object.prototype.toString.call(data) === '[object Object]';
+    if (dataIsPlainObject && Object.keys(payload).length === 1) {
+        const d = Object.assign({}, data);
+        // attach raw onto new data
+        attachRawFromOneToAnthor(payload, d);
+        return d;
+    }
+    return payload;
+};
+const attachRawFromOneToAnthor = (from, to) => {
+    if (!from) {
+        return;
+    }
+    from.$raw &&
+        Object.defineProperty(to, '$raw', {
+            value: Object.assign({}, from.$raw),
+            enumerable: false,
+        });
+    from.$request &&
+        Object.defineProperty(to, '$request', {
+            value: Object.assign({}, from.$request),
+            enumerable: false,
+        });
+};
 
 function attachRequestMethod(target) {
     Object.defineProperty(target, '$$get', {
@@ -386,11 +424,200 @@ function handleSearchParams(obj) {
     }
     const search = new URLSearchParams();
     Object.entries(obj).forEach(([k, v]) => {
+        if (typeof v === 'undefined' ||
+            Object.prototype.toString.call(v) === '[object Null]') {
+            return;
+        }
         search.set(k, v);
     });
     return search.toString();
 }
 
+class AggregateController {
+    constructor(client) {
+        this.client = client;
+        this.base = 'aggregate';
+        this.name = 'aggregate';
+    }
+    get proxy() {
+        return this.client.proxy(this.base);
+    }
+    /**
+     * 获取聚合数据
+     */
+    getAggregateData() {
+        return this.proxy.get();
+    }
+    /**
+     * 获取最新发布的内容
+     */
+    getTop(size = 5) {
+        return this.proxy.top.get({ params: { size } });
+    }
+    getTimeline(options) {
+        const { sort, type, year } = options || {};
+        return this.proxy.timeline.get({
+            params: {
+                sort: sort && sortOrderToNumber(sort),
+                type,
+                year,
+            },
+        });
+    }
+    /**
+     * 获取聚合数据统计
+     */
+    getStat() {
+        return this.proxy.stat.get();
+    }
+}
+
+var CategoryType;
+(function (CategoryType) {
+    CategoryType[CategoryType["Category"] = 0] = "Category";
+    CategoryType[CategoryType["Tag"] = 1] = "Tag";
+})(CategoryType || (CategoryType = {}));
+
+class CategoryController {
+    constructor(client) {
+        this.client = client;
+        this.name = 'category';
+        this.base = 'categories';
+    }
+    get proxy() {
+        return this.client.proxy(this.base);
+    }
+    getAllCategories() {
+        return this.proxy.get({
+            params: {
+                type: CategoryType.Category,
+            },
+        });
+    }
+    getAllTags() {
+        return this.proxy.get({
+            params: {
+                type: CategoryType.Tag,
+            },
+        });
+    }
+    async getCategoryDetail(ids) {
+        if (typeof ids === 'string') {
+            const data = await this.proxy.get({
+                params: {
+                    ids: ids,
+                },
+            });
+            const result = Object.values(data.entries)[0];
+            attachRawFromOneToAnthor(data, result);
+            return result;
+        }
+        else if (Array.isArray(ids)) {
+            const data = await this.proxy.get({
+                params: {
+                    ids: ids.join(','),
+                },
+            });
+            const entries = data === null || data === void 0 ? void 0 : data.entries;
+            if (!entries) {
+                throw new RequestError('data structure error', 500, data.$request.path, data);
+            }
+            const map = new Map(Object.entries(entries).map(([id, value]) => [id.toLowerCase(), value]));
+            attachRawFromOneToAnthor(data, map);
+            return map;
+        }
+    }
+    async getCategoryByIdOrSlug(idOrSlug) {
+        const res = await this.proxy(idOrSlug).get();
+        return destructureData(res);
+    }
+    async getTagByName(name) {
+        const res = await this.proxy(name).get({
+            params: {
+                tag: 1,
+            },
+        });
+        return res;
+    }
+}
+
+class CommentController {
+    constructor(client) {
+        this.client = client;
+        this.base = 'comments';
+        this.name = 'comment';
+    }
+    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,
+        });
+    }
+}
+
+class BaseCrudController {
+    constructor(client) {
+        this.client = client;
+    }
+    get proxy() {
+        return this.client.proxy(this.base);
+    }
+    getById(id) {
+        return this.proxy(id).get();
+    }
+    getAll() {
+        return this.proxy.all.get();
+    }
+    /**
+     * 带分页的查询
+     * @param page
+     * @param perPage
+     */
+    getAllPaginated(page, perPage) {
+        return this.proxy.get({
+            params: { page, size: perPage },
+        });
+    }
+}
+
+class LinkController extends BaseCrudController {
+    constructor(client) {
+        super(client);
+        this.client = client;
+        this.name = 'link';
+        this.base = 'links';
+    }
+}
+
 class NoteController {
     constructor(client) {
         this.client = client;
@@ -445,6 +672,39 @@ class NoteController {
     }
 }
 
+class PageController {
+    constructor(client) {
+        this.client = client;
+        this.base = 'pages';
+        this.name = 'page';
+    }
+    get proxy() {
+        return this.client.proxy(this.base);
+    }
+    /**
+     * 页面列表
+     */
+    getList(page = 1, perPage = 10) {
+        return this.proxy.get({
+            params: { page, size: perPage },
+        });
+    }
+    /**
+     * 页面详情
+     */
+    getById(id) {
+        return this.proxy(id).get();
+    }
+    /**
+     * 根据路径获取页面
+     * @param slug 路径
+     * @returns
+     */
+    getBySlug(slug) {
+        return this.proxy.slug(slug).get({});
+    }
+}
+
 class PostController {
     constructor(client) {
         this.client = client;
@@ -487,94 +747,179 @@ class PostController {
     }
 }
 
-class CommentController {
+class ProjectController extends BaseCrudController {
     constructor(client) {
+        super(client);
         this.client = client;
-        this.base = 'comments';
-        this.name = 'comment';
+        this.base = 'projects';
+        this.name = 'project';
+    }
+}
+
+class RecentlyController {
+    constructor(client) {
+        this.client = client;
+        this.base = 'recently';
+        this.name = 'recently';
     }
     get proxy() {
         return this.client.proxy(this.base);
     }
     /**
-     * 根据 comment id 获取评论, 包括子评论
+     * 获取最新一条
      */
-    getById(id) {
-        return this.proxy(id).get();
+    getLatestOne() {
+        return this.proxy.latest.get();
     }
-    /**
-     * 获取文章的评论列表
-     * @param refId 文章 Id
-     */
-    getByRefId(refId, pagination = {}) {
-        const { page, size } = pagination;
-        return this.proxy.ref(refId).get({
-            params: { page: page || 1, size: size || 10 },
-        });
+    getAll() {
+        return this.proxy.all.get();
     }
-    /**
-     * 评论
-     */
-    comment(refId, data) {
-        return this.proxy(refId).post({
-            data,
+    getList(before, after, size) {
+        if (!before && !after) {
+            throw new Error('you can only choose `before` or `after`');
+        }
+        return this.proxy.get({
+            params: {
+                before,
+                after,
+                size,
+            },
         });
     }
+}
+
+class SayController extends BaseCrudController {
+    constructor(client) {
+        super(client);
+        this.client = client;
+        this.base = 'says';
+        this.name = 'say';
+    }
+    get proxy() {
+        return this.client.proxy(this.base);
+    }
     /**
-     * 回复评论
+     * 获取随机一条
      */
-    reply(commentId, data) {
-        return this.proxy.reply(commentId).post({
-            data,
-        });
+    getRandom() {
+        return this.proxy.random.get();
     }
 }
 
-class PageController {
+class SearchController {
     constructor(client) {
         this.client = client;
-        this.base = 'pages';
-        this.name = 'page';
+        this.base = 'search';
+        this.name = 'search';
     }
     get proxy() {
         return this.client.proxy(this.base);
     }
-    /**
-     * 页面列表
-     */
-    getList(page = 1, perPage = 10) {
-        return this.proxy.get({
-            params: { page, size: perPage },
+    search(type, keyword, options = {}) {
+        return this.proxy(type).get({
+            params: Object.assign({ 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: Object.assign({ keyword }, options) });
+    }
+}
+
+class SnippetController {
+    constructor(client) {
+        this.client = client;
+        this.base = 'snippets';
+        this.name = 'snippet';
+    }
+    get proxy() {
+        return this.client.proxy(this.base);
+    }
     getById(id) {
         return this.proxy(id).get();
     }
-    /**
-     * 根据路径获取页面
-     * @param slug 路径
-     * @returns
-     */
-    getBySlug(slug) {
-        return this.proxy.slug(slug).get({});
+    getByReferenceAndName(reference, name) {
+        return this.proxy(reference)(name).get();
+    }
+}
+
+class UserController {
+    constructor(client) {
+        this.client = client;
+        this.base = 'master';
+        this.name = 'user';
+    }
+    get proxy() {
+        return this.client.proxy(this.base);
+    }
+    getMasterInfo() {
+        return this.proxy.get();
+    }
+    login(username, password) {
+        return this.proxy.login.post({
+            data: {
+                username,
+                password,
+            },
+        });
+    }
+    checkTokenValid(token) {
+        return this.proxy.check_logged.get({
+            params: {
+                token,
+            },
+        });
     }
 }
 
 const allControllers = [
+    AggregateController,
+    CategoryController,
+    CommentController,
+    LinkController,
     NoteController,
-    PostController,
     PageController,
-    CommentController,
+    PostController,
+    ProjectController,
+    RecentlyController,
+    SayController,
+    SearchController,
+    SnippetController,
+    UserController,
+];
+const allContollerNames = [
+    'aggregate',
+    'category',
+    'comment',
+    'link',
+    'note',
+    'page',
+    'post',
+    'project',
+    'recently',
+    'say',
+    'search',
+    'snippet',
+    'user',
 ];
-// export const allClientName = allClients.map((c) =>
-//   c.name.replace('Client', '').toLowerCase(),
-// )
-// Why not code like before
-// In order to tree shake unnecessary client
-const allContollerNames = ['note', 'post', 'page', 'comment'];
+
+class HTTPControllerDefine {
+    get master() {
+        return this.user;
+    }
+    get friend() {
+        return this.link;
+    }
+    get shorthand() {
+        return this.recently;
+    }
+}
 
 class RequestError extends Error {
     constructor(message, status, path, raw) {
@@ -585,8 +930,10 @@ class RequestError extends Error {
     }
 }
 
-class HTTPClient {
+class HTTPClient extends HTTPControllerDefine {
+    // define all clients
     constructor(_endpoint, _instance) {
+        super();
         this._endpoint = _endpoint;
         this._instance = _instance;
         this._endpoint = _endpoint
@@ -688,13 +1035,24 @@ class HTTPClient {
                             const transform = Array.isArray(data) || isPlainObject(data)
                                 ? camelcaseKeys(data, { deep: true })
                                 : data;
-                            Object.defineProperty(transform, 'raw', {
+                            Object.defineProperty(transform, '$raw', {
                                 get() {
                                     return res;
                                 },
                                 enumerable: false,
                                 configurable: false,
                             });
+                            // attach request config onto response
+                            Object.defineProperty(transform, '$request', {
+                                get() {
+                                    return {
+                                        url,
+                                        method: name,
+                                        options,
+                                    };
+                                },
+                                enumerable: false,
+                            });
                             return transform;
                         };
                     }