@mx-space/api-client 1.3.2 → 1.3.4

package/dist/adaptors/umi-request.global.js

@@ -25,6 +25,10 @@
     return to;
   };
   var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+    // If the importer is in node compatibility mode or this is not an ESM
+    // file that has been converted to a CommonJS file using a Babel-
+    // compatible transform (i.e. "__esModule" has not been set), then set
+    // "default" to the CommonJS "module.exports" for node compatibility.
     isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
     mod
   ));
@@ -237,6 +241,7 @@
         "%encodeURIComponent%": encodeURIComponent,
         "%Error%": Error,
         "%eval%": eval,
+        // eslint-disable-line no-eval
         "%EvalError%": EvalError,
         "%Float32Array%": typeof Float32Array === "undefined" ? undefined2 : Float32Array,
         "%Float64Array%": typeof Float64Array === "undefined" ? undefined2 : Float64Array,
@@ -1076,6 +1081,7 @@
           node.value = value;
         } else {
           objects.next = {
+            // eslint-disable-line no-param-reassign
             key,
             next: objects.next,
             value
@@ -1414,6 +1420,7 @@
         encodeValuesOnly: false,
         format: defaultFormat,
         formatter: formats.formatters[defaultFormat],
+        // deprecated
         indices: false,
         serializeDate: function serializeDate(date) {
           return toISO.call(date);
@@ -1808,6 +1815,7 @@
           comma: typeof opts.comma === "boolean" ? opts.comma : defaults.comma,
           decoder: typeof opts.decoder === "function" ? opts.decoder : defaults.decoder,
           delimiter: typeof opts.delimiter === "string" || utils.isRegExp(opts.delimiter) ? opts.delimiter : defaults.delimiter,
+          // eslint-disable-next-line no-implicit-coercion, no-extra-parens
           depth: typeof opts.depth === "number" || opts.depth === false ? +opts.depth : defaults.depth,
           ignoreQueryPrefix: opts.ignoreQueryPrefix === true,
           interpretNumericEntities: typeof opts.interpretNumericEntities === "boolean" ? opts.interpretNumericEntities : defaults.interpretNumericEntities,
@@ -1975,6 +1983,7 @@
       "use strict";
       var Buffer2 = require_safer().Buffer;
       module.exports = {
+        // Encodings
         utf8: { type: "_internal", bomAware: true },
         cesu8: { type: "_internal", bomAware: true },
         unicode11utf8: "utf8",
@@ -1983,6 +1992,7 @@
         binary: { type: "_internal" },
         base64: { type: "_internal" },
         hex: { type: "_internal" },
+        // Codec.
         _internal: InternalCodec
       };
       function InternalCodec(codecOptions, iconv) {
@@ -2746,6 +2756,7 @@
     "../../node_modules/.pnpm/iconv-lite@0.6.3/node_modules/iconv-lite/encodings/sbcs-data.js"(exports, module) {
       "use strict";
       module.exports = {
+        // Not supported by iconv, not sure why.
         "10029": "maccenteuro",
         "maccenteuro": {
           "type": "_sbcs",
@@ -2765,6 +2776,7 @@
           "type": "_sbcs",
           "chars": "\x80\x81\xE9\xE2\x84\xE0\x86\xE7\xEA\xEB\xE8\xEF\xEE\x8D\x8E\x8F\x90\u0651\u0652\xF4\xA4\u0640\xFB\xF9\u0621\u0622\u0623\u0624\xA3\u0625\u0626\u0627\u0628\u0629\u062A\u062B\u062C\u062D\u062E\u062F\u0630\u0631\u0632\u0633\u0634\u0635\xAB\xBB\u2591\u2592\u2593\u2502\u2524\u2561\u2562\u2556\u2555\u2563\u2551\u2557\u255D\u255C\u255B\u2510\u2514\u2534\u252C\u251C\u2500\u253C\u255E\u255F\u255A\u2554\u2569\u2566\u2560\u2550\u256C\u2567\u2568\u2564\u2565\u2559\u2558\u2552\u2553\u256B\u256A\u2518\u250C\u2588\u2584\u258C\u2590\u2580\u0636\u0637\u0638\u0639\u063A\u0641\xB5\u0642\u0643\u0644\u0645\u0646\u0647\u0648\u0649\u064A\u2261\u064B\u064C\u064D\u064E\u064F\u0650\u2248\xB0\u2219\xB7\u221A\u207F\xB2\u25A0\xA0"
         },
+        // Aliases of generated encodings.
         "ascii8bit": "ascii",
         "usascii": "ascii",
         "ansix34": "ascii",
@@ -5021,6 +5033,36 @@
     "../../node_modules/.pnpm/iconv-lite@0.6.3/node_modules/iconv-lite/encodings/dbcs-data.js"(exports, module) {
       "use strict";
       module.exports = {
+        // == Japanese/ShiftJIS ====================================================
+        // All japanese encodings are based on JIS X set of standards:
+        // JIS X 0201 - Single-byte encoding of ASCII + ¥ + Kana chars at 0xA1-0xDF.
+        // JIS X 0208 - Main set of 6879 characters, placed in 94x94 plane, to be encoded by 2 bytes. 
+        //              Has several variations in 1978, 1983, 1990 and 1997.
+        // JIS X 0212 - Supplementary plane of 6067 chars in 94x94 plane. 1990. Effectively dead.
+        // JIS X 0213 - Extension and modern replacement of 0208 and 0212. Total chars: 11233.
+        //              2 planes, first is superset of 0208, second - revised 0212.
+        //              Introduced in 2000, revised 2004. Some characters are in Unicode Plane 2 (0x2xxxx)
+        // Byte encodings are:
+        //  * Shift_JIS: Compatible with 0201, uses not defined chars in top half as lead bytes for double-byte
+        //               encoding of 0208. Lead byte ranges: 0x81-0x9F, 0xE0-0xEF; Trail byte ranges: 0x40-0x7E, 0x80-0x9E, 0x9F-0xFC.
+        //               Windows CP932 is a superset of Shift_JIS. Some companies added more chars, notably KDDI.
+        //  * EUC-JP:    Up to 3 bytes per character. Used mostly on *nixes.
+        //               0x00-0x7F       - lower part of 0201
+        //               0x8E, 0xA1-0xDF - upper part of 0201
+        //               (0xA1-0xFE)x2   - 0208 plane (94x94).
+        //               0x8F, (0xA1-0xFE)x2 - 0212 plane (94x94).
+        //  * JIS X 208: 7-bit, direct encoding of 0208. Byte ranges: 0x21-0x7E (94 values). Uncommon.
+        //               Used as-is in ISO2022 family.
+        //  * ISO2022-JP: Stateful encoding, with escape sequences to switch between ASCII, 
+        //                0201-1976 Roman, 0208-1978, 0208-1983.
+        //  * ISO2022-JP-1: Adds esc seq for 0212-1990.
+        //  * ISO2022-JP-2: Adds esc seq for GB2313-1980, KSX1001-1992, ISO8859-1, ISO8859-7.
+        //  * ISO2022-JP-3: Adds esc seq for 0201-1976 Kana set, 0213-2000 Planes 1, 2.
+        //  * ISO2022-JP-2004: Adds 0213-2004 Plane 1.
+        //
+        // After JIS X 0213 appeared, Shift_JIS-2004, EUC-JISX0213 and ISO2022-JP-2004 followed, with just changing the planes.
+        //
+        // Overall, it seems that it's a mess :( http://www8.plala.or.jp/tkubota1/unicode-symbols-map2.html
         "shiftjis": {
           type: "_dbcs",
           table: function() {
@@ -5046,12 +5088,20 @@
           },
           encodeAdd: { "\xA5": 92, "\u203E": 126 }
         },
+        // TODO: KDDI extension to Shift_JIS
+        // TODO: IBM CCSID 942 = CP932, but F0-F9 custom chars and other char changes.
+        // TODO: IBM CCSID 943 = Shift_JIS = CP932 with original Shift_JIS lower 128 chars.
+        // == Chinese/GBK ==========================================================
+        // http://en.wikipedia.org/wiki/GBK
+        // We mostly implement W3C recommendation: https://www.w3.org/TR/encoding/#gbk-encoder
+        // Oldest GB2312 (1981, ~7600 chars) is a subset of CP936
         "gb2312": "cp936",
         "gb231280": "cp936",
         "gb23121980": "cp936",
         "csgb2312": "cp936",
         "csiso58gb231280": "cp936",
         "euccn": "cp936",
+        // Microsoft's CP936 is a subset and approximation of GBK.
         "windows936": "cp936",
         "ms936": "cp936",
         "936": "cp936",
@@ -5061,6 +5111,7 @@
             return require_cp936();
           }
         },
+        // GBK (~22000 chars) is an extension of CP936 that added user-mapped chars and some other.
         "gbk": {
           type: "_dbcs",
           table: function() {
@@ -5069,6 +5120,11 @@
         },
         "xgbk": "gbk",
         "isoir58": "gbk",
+        // GB18030 is an algorithmic extension of GBK.
+        // Main source: https://www.w3.org/TR/encoding/#gbk-encoder
+        // http://icu-project.org/docs/papers/gb18030.html
+        // http://source.icu-project.org/repos/icu/data/trunk/charset/data/xml/gb-18030-2000.xml
+        // http://www.khngai.com/chinese/charmap/tblgbk.php?page=0
         "gb18030": {
           type: "_dbcs",
           table: function() {
@@ -5081,6 +5137,8 @@
           encodeAdd: { "\u20AC": 41699 }
         },
         "chinese": "gb18030",
+        // == Korean ===============================================================
+        // EUC-KR, KS_C_5601 and KS X 1001 are exactly the same.
         "windows949": "cp949",
         "ms949": "cp949",
         "949": "cp949",
@@ -5098,6 +5156,28 @@
         "ksc56011987": "cp949",
         "ksc56011989": "cp949",
         "ksc5601": "cp949",
+        // == Big5/Taiwan/Hong Kong ================================================
+        // There are lots of tables for Big5 and cp950. Please see the following links for history:
+        // http://moztw.org/docs/big5/  http://www.haible.de/bruno/charsets/conversion-tables/Big5.html
+        // Variations, in roughly number of defined chars:
+        //  * Windows CP 950: Microsoft variant of Big5. Canonical: http://www.unicode.org/Public/MAPPINGS/VENDORS/MICSFT/WINDOWS/CP950.TXT
+        //  * Windows CP 951: Microsoft variant of Big5-HKSCS-2001. Seems to be never public. http://me.abelcheung.org/articles/research/what-is-cp951/
+        //  * Big5-2003 (Taiwan standard) almost superset of cp950.
+        //  * Unicode-at-on (UAO) / Mozilla 1.8. Falling out of use on the Web. Not supported by other browsers.
+        //  * Big5-HKSCS (-2001, -2004, -2008). Hong Kong standard. 
+        //    many unicode code points moved from PUA to Supplementary plane (U+2XXXX) over the years.
+        //    Plus, it has 4 combining sequences.
+        //    Seems that Mozilla refused to support it for 10 yrs. https://bugzilla.mozilla.org/show_bug.cgi?id=162431 https://bugzilla.mozilla.org/show_bug.cgi?id=310299
+        //    because big5-hkscs is the only encoding to include astral characters in non-algorithmic way.
+        //    Implementations are not consistent within browsers; sometimes labeled as just big5.
+        //    MS Internet Explorer switches from big5 to big5-hkscs when a patch applied.
+        //    Great discussion & recap of what's going on https://bugzilla.mozilla.org/show_bug.cgi?id=912470#c31
+        //    In the encoder, it might make sense to support encoding old PUA mappings to Big5 bytes seq-s.
+        //    Official spec: http://www.ogcio.gov.hk/en/business/tech_promotion/ccli/terms/doc/2003cmp_2008.txt
+        //                   http://www.ogcio.gov.hk/tc/business/tech_promotion/ccli/terms/doc/hkscs-2008-big5-iso.txt
+        // 
+        // Current understanding of how to deal with Big5(-HKSCS) is in the Encoding Standard, http://encoding.spec.whatwg.org/#big5-encoder
+        // Unicode mapping (http://www.unicode.org/Public/MAPPINGS/OBSOLETE/EASTASIA/OTHER/BIG5.TXT) is said to be wrong.
         "windows950": "cp950",
         "ms950": "cp950",
         "950": "cp950",
@@ -5107,6 +5187,7 @@
             return require_cp950();
           }
         },
+        // Big5 has many variations and is an extension of cp950. We use Encoding Standard's as a consensus.
         "big5": "big5hkscs",
         "big5hkscs": {
           type: "_dbcs",
@@ -5114,6 +5195,9 @@
             return require_cp950().concat(require_big5_added());
           },
           encodeSkipVals: [
+            // Although Encoding Standard says we should avoid encoding to HKSCS area (See Step 1 of
+            // https://encoding.spec.whatwg.org/#index-big5-pointer), we still do it to increase compatibility with ICU.
+            // But if a single unicode point can be encoded both as HKSCS and regular Big5, we prefer the latter.
             36457,
             36463,
             36478,
@@ -5175,6 +5259,7 @@
             37576,
             38468,
             38637,
+            // Step 2 of https://encoding.spec.whatwg.org/#index-big5-pointer: Use last pointer for U+2550, U+255E, U+2561, U+256A, U+5341, or U+5345
             41636,
             41637,
             41639,
@@ -6277,40 +6362,43 @@
     }
     _createClass(Onion2, [{
       key: "use",
-      value: function use(newMiddleware) {
-        var opts = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {
-          global: false,
-          core: false,
-          defaultInstance: false
-        };
-        var core = false;
-        var global2 = false;
-        var defaultInstance = false;
-        if (typeof opts === "number") {
-          if (process && process.env && process.env.NODE_ENV === "development") {
-            console.warn('use() options should be object, number property would be deprecated in future\uFF0Cplease update use() options to "{ core: true }".');
-          }
-          core = true;
-          global2 = false;
-        } else if (_typeof(opts) === "object" && opts) {
-          global2 = opts.global || false;
-          core = opts.core || false;
-          defaultInstance = opts.defaultInstance || false;
-        }
-        if (global2) {
-          Onion2.globalMiddlewares.splice(Onion2.globalMiddlewares.length - Onion2.defaultGlobalMiddlewaresLength, 0, newMiddleware);
-          return;
-        }
-        if (core) {
-          Onion2.coreMiddlewares.splice(Onion2.coreMiddlewares.length - Onion2.defaultCoreMiddlewaresLength, 0, newMiddleware);
-          return;
-        }
-        if (defaultInstance) {
-          this.defaultMiddlewares.push(newMiddleware);
-          return;
+      value: (
+        // 内置内核中间件长度
+        function use(newMiddleware) {
+          var opts = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {
+            global: false,
+            core: false,
+            defaultInstance: false
+          };
+          var core = false;
+          var global2 = false;
+          var defaultInstance = false;
+          if (typeof opts === "number") {
+            if (process && process.env && process.env.NODE_ENV === "development") {
+              console.warn('use() options should be object, number property would be deprecated in future\uFF0Cplease update use() options to "{ core: true }".');
+            }
+            core = true;
+            global2 = false;
+          } else if (_typeof(opts) === "object" && opts) {
+            global2 = opts.global || false;
+            core = opts.core || false;
+            defaultInstance = opts.defaultInstance || false;
+          }
+          if (global2) {
+            Onion2.globalMiddlewares.splice(Onion2.globalMiddlewares.length - Onion2.defaultGlobalMiddlewaresLength, 0, newMiddleware);
+            return;
+          }
+          if (core) {
+            Onion2.coreMiddlewares.splice(Onion2.coreMiddlewares.length - Onion2.defaultCoreMiddlewaresLength, 0, newMiddleware);
+            return;
+          }
+          if (defaultInstance) {
+            this.defaultMiddlewares.push(newMiddleware);
+            return;
+          }
+          this.middlewares.push(newMiddleware);
         }
-        this.middlewares.push(newMiddleware);
-      }
+      )
     }, {
       key: "execute",
       value: function execute() {
@@ -6795,6 +6883,7 @@
         this.initOptions = mergeRequestOptions(this.initOptions, options);
         this.mapCache.extendOptions(options);
       }
+      // 执行请求前拦截器
     }, {
       key: "dealRequestInterceptors",
       value: function dealRequestInterceptors(ctx) {
@@ -6855,18 +6944,22 @@
       }
     }], [{
       key: "requestUse",
-      value: function requestUse(handler) {
-        var opt = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {
-          global: true
-        };
-        if (typeof handler !== "function")
-          throw new TypeError("Interceptor must be function!");
-        if (opt.global) {
-          Core2.requestInterceptors.push(handler);
-        } else {
-          this.instanceRequestInterceptors.push(handler);
+      value: (
+        // 请求拦截器 默认 { global: true } 兼容旧版本拦截器
+        function requestUse(handler) {
+          var opt = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {
+            global: true
+          };
+          if (typeof handler !== "function")
+            throw new TypeError("Interceptor must be function!");
+          if (opt.global) {
+            Core2.requestInterceptors.push(handler);
+          } else {
+            this.instanceRequestInterceptors.push(handler);
+          }
         }
-      }
+      )
+      // 响应拦截器 默认 { global: true } 兼容旧版本拦截器
     }, {
       key: "responseUse",
       value: function responseUse(handler) {

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);