@snail-js/api 0.1.20 → 0.1.21

package/README.md

@@ -171,6 +171,13 @@ const data = await send();
     <td>Get</td>
     <td>要启用缓存的方法，默认仅开启Get缓存</td>
   </tr>
+  <tr>
+    <td>serverStatusCodeRule</td>
+    <td><a href="#SnailServerStatusCodeRuleOptions">SnailServerStatusCodeRuleOptions</a></td>
+    <td>否</td>
+    <td>undefined</td>
+    <td>服务端状态码规则，若配置此项，rule函数返回false时会触发错误</td>
+  </tr>
   <tr>
     <td>enableLog</td>
     <td>boolean</td>
@@ -426,6 +433,19 @@ export type VersioningOption =
   | VersioningCustomOption;
 ```
 
+### <a id="SnailServerStatusCodeRuleOptions">SnailServerStatusCodeRuleOptions</a> 类型
+
+```typescript
+export class SnailServerStatusCodeRuleOptions {
+  // 通常服务端会返回一个状态码，当状态码不符合预期时，会抛出错误
+  // 可以使用此选项来定义服务端状态码的规则
+  // 当rule函数返回false时，会触发错误
+  rule: (statusCode: number) => boolean;
+  // response.data中服务端状态码的key，默认为code
+  key?: string;
+}
+```
+
 ### 临时版本修改器`@Version`
 
 - 临时改变方法请求的版本

package/dist/core/snailServer.d.ts

@@ -1,6 +1,6 @@
 import "reflect-metadata";
 import { AxiosInstance } from "axios";
-import { Strategy, ApiInstanceOptions, VersioningOption, CacheStorage, ApiProxy, ResponseData, StandardResponseData, CacheForType } from "../typings";
+import { Strategy, ApiInstanceOptions, VersioningOption, CacheStorage, ApiProxy, ResponseData, StandardResponseData, CacheForType, SnailServerStatusCodeRuleOptions } from "../typings";
 import { SnailApi } from "./snailApi";
 import { SnailSse } from "./snailSse";
 export declare const CacheStorageMap: Map<string, CacheStorage>;
@@ -10,6 +10,7 @@ export declare const ExpireSourceMap: Map<string, Set<string>>;
 export declare const AxiosInstanceMap: Map<string, AxiosInstance>;
 export declare const StrategyMap: Map<string, (new () => Strategy)[]>;
 export declare const VersioningMap: Map<string, VersioningOption>;
+export declare const ServerStatusCodeRuleMap: Map<string, SnailServerStatusCodeRuleOptions>;
 export declare class SnailServer<RT extends ResponseData = Omit<StandardResponseData, "data">, DK extends string = "data"> {
     private Name;
     private BaseURL;
@@ -17,6 +18,7 @@ export declare class SnailServer<RT extends ResponseData = Omit<StandardResponse
     private EnableLog;
     constructor();
     private init;
+    private initServerStatusCodeRule;
     private initLog;
     private initStrategy;
     private initVersioning;

package/dist/snail-api.js

@@ -3727,6 +3727,12 @@ var RequestMethodEnum = /* @__PURE__ */ ((RequestMethodEnum2) => {
   RequestMethodEnum2["OPTIONS"] = "Options";
   return RequestMethodEnum2;
 })(RequestMethodEnum || {});
+class SnailServerStatusCodeRuleOptions {
+  constructor() {
+    __publicField(this, "key");
+    __publicField(this, "rule");
+  }
+}
 var VersioningType = /* @__PURE__ */ ((VersioningType2) => {
   VersioningType2[VersioningType2["Uri"] = 0] = "Uri";
   VersioningType2[VersioningType2["Header"] = 1] = "Header";
@@ -4036,6 +4042,7 @@ class SnailMethod {
       const [serverName] = this.apiInstance.name.split(".");
       const axios2 = AxiosInstanceMap.get(serverName);
       if (!axios2) throw new Error("AxiosInstance not created");
+      const serverStatusCodeRule = ServerStatusCodeRuleMap.get(serverName);
       const strategies = this.getStrategies();
       this.Request = await applyStrategies(this.Request, strategies, "request");
       this.Request = this.applyProgress(this.Request);
@@ -4083,11 +4090,23 @@ class SnailMethod {
         }
         this.Response = response;
         this.applyHitSource(serverName);
-        this.emit("success", response.data);
-        this.emit("finish", response.data);
         isSpecial && console.log("isSpecial:", isSpecial);
-        if (isSpecial) return response;
+        if (isSpecial) {
+          this.emit("success", response.data);
+          this.emit("finish", response.data);
+          return response;
+        }
         !isSpecial && console.log("isSpecial:", isSpecial);
+        if (serverStatusCodeRule) {
+          const { key, rule } = serverStatusCodeRule;
+          const statuCodeKey = key ?? "code";
+          const data2 = response.data;
+          if (rule(data2[statuCodeKey])) {
+            this.emit("success", response.data);
+          } else {
+            this.emit("error", response.data);
+          }
+        }
         return response.data;
       } catch (error) {
         this.emit("error", error);
@@ -4378,6 +4397,7 @@ const ExpireSourceMap = /* @__PURE__ */ new Map();
 const AxiosInstanceMap = /* @__PURE__ */ new Map();
 const StrategyMap = /* @__PURE__ */ new Map();
 const VersioningMap = /* @__PURE__ */ new Map();
+const ServerStatusCodeRuleMap = /* @__PURE__ */ new Map();
 const defaultCacheManageOptions = {
   type: CacheType.Memory,
   ttl: 500
@@ -4406,9 +4426,19 @@ class SnailServer {
   }
   init() {
     const options = this.getServerOptions();
-    const { baseURL, timeout, cacheManage, enableLog, cacheFor } = options;
+    const {
+      baseURL,
+      timeout,
+      cacheManage,
+      enableLog,
+      cacheFor,
+      serverStatusCodeRule
+    } = options;
     this.BaseURL = baseURL ?? resolveUrl("");
     this.initAxios({ baseURL, timeout });
+    if (serverStatusCodeRule) {
+      this.initServerStatusCodeRule(serverStatusCodeRule);
+    }
     this.initStrategy();
     this.initCacheManage(cacheManage, cacheFor);
     this.initVersioning();
@@ -4416,6 +4446,9 @@ class SnailServer {
     this.EnableLog = enableLog ?? false;
     this.initLog(enableLog);
   }
+  initServerStatusCodeRule(ruleOptions) {
+    ServerStatusCodeRuleMap.set(this.name, ruleOptions);
+  }
   initLog(enableLog) {
     if (enableLog) {
       const axiosInstance = AxiosInstanceMap.get(this.Name);
@@ -4806,6 +4839,7 @@ export {
   SnailMethod,
   SnailPass,
   SnailServer,
+  SnailServerStatusCodeRuleOptions,
   SnailSse,
   Sse,
   SseEvent,

package/dist/snail-api.umd.cjs

@@ -3731,6 +3731,12 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     RequestMethodEnum2["OPTIONS"] = "Options";
     return RequestMethodEnum2;
   })(RequestMethodEnum || {});
+  class SnailServerStatusCodeRuleOptions {
+    constructor() {
+      __publicField(this, "key");
+      __publicField(this, "rule");
+    }
+  }
   var VersioningType = /* @__PURE__ */ ((VersioningType2) => {
     VersioningType2[VersioningType2["Uri"] = 0] = "Uri";
     VersioningType2[VersioningType2["Header"] = 1] = "Header";
@@ -4040,6 +4046,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
         const [serverName] = this.apiInstance.name.split(".");
         const axios2 = AxiosInstanceMap.get(serverName);
         if (!axios2) throw new Error("AxiosInstance not created");
+        const serverStatusCodeRule = ServerStatusCodeRuleMap.get(serverName);
         const strategies = this.getStrategies();
         this.Request = await applyStrategies(this.Request, strategies, "request");
         this.Request = this.applyProgress(this.Request);
@@ -4087,11 +4094,23 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
           }
           this.Response = response;
           this.applyHitSource(serverName);
-          this.emit("success", response.data);
-          this.emit("finish", response.data);
           isSpecial && console.log("isSpecial:", isSpecial);
-          if (isSpecial) return response;
+          if (isSpecial) {
+            this.emit("success", response.data);
+            this.emit("finish", response.data);
+            return response;
+          }
           !isSpecial && console.log("isSpecial:", isSpecial);
+          if (serverStatusCodeRule) {
+            const { key, rule } = serverStatusCodeRule;
+            const statuCodeKey = key ?? "code";
+            const data2 = response.data;
+            if (rule(data2[statuCodeKey])) {
+              this.emit("success", response.data);
+            } else {
+              this.emit("error", response.data);
+            }
+          }
           return response.data;
         } catch (error) {
           this.emit("error", error);
@@ -4382,6 +4401,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
   const AxiosInstanceMap = /* @__PURE__ */ new Map();
   const StrategyMap = /* @__PURE__ */ new Map();
   const VersioningMap = /* @__PURE__ */ new Map();
+  const ServerStatusCodeRuleMap = /* @__PURE__ */ new Map();
   const defaultCacheManageOptions = {
     type: CacheType.Memory,
     ttl: 500
@@ -4410,9 +4430,19 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
     }
     init() {
       const options = this.getServerOptions();
-      const { baseURL, timeout, cacheManage, enableLog, cacheFor } = options;
+      const {
+        baseURL,
+        timeout,
+        cacheManage,
+        enableLog,
+        cacheFor,
+        serverStatusCodeRule
+      } = options;
       this.BaseURL = baseURL ?? resolveUrl("");
       this.initAxios({ baseURL, timeout });
+      if (serverStatusCodeRule) {
+        this.initServerStatusCodeRule(serverStatusCodeRule);
+      }
       this.initStrategy();
       this.initCacheManage(cacheManage, cacheFor);
       this.initVersioning();
@@ -4420,6 +4450,9 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
       this.EnableLog = enableLog ?? false;
       this.initLog(enableLog);
     }
+    initServerStatusCodeRule(ruleOptions) {
+      ServerStatusCodeRuleMap.set(this.name, ruleOptions);
+    }
     initLog(enableLog) {
       if (enableLog) {
         const axiosInstance = AxiosInstanceMap.get(this.Name);
@@ -4809,6 +4842,7 @@ var __publicField = (obj, key, value) => __defNormalProp(obj, typeof key !== "sy
   exports2.SnailMethod = SnailMethod;
   exports2.SnailPass = SnailPass;
   exports2.SnailServer = SnailServer;
+  exports2.SnailServerStatusCodeRuleOptions = SnailServerStatusCodeRuleOptions;
   exports2.SnailSse = SnailSse;
   exports2.Sse = Sse;
   exports2.SseEvent = SseEvent;

package/dist/typings/snail.option.d.ts

@@ -1,6 +1,10 @@
 import { CacheManagementOption } from "./cache.management.option";
 import { RequestMethod } from "./request.method";
 export type CacheForType = "All" | "all" | RequestMethod | RequestMethod[];
+export declare class SnailServerStatusCodeRuleOptions {
+    key?: string;
+    rule: (status: number) => boolean;
+}
 export interface SnailOption {
     name?: string;
     baseURL?: string;
@@ -8,4 +12,5 @@ export interface SnailOption {
     cacheFor?: CacheForType;
     enableLog?: boolean;
     timeout?: number;
+    serverStatusCodeRule?: SnailServerStatusCodeRuleOptions;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@snail-js/api",
-  "version": "0.1.20",
+  "version": "0.1.21",
   "description": "Http Request with Decorators Api, build on axios",
   "type": "module",
   "main": "./src/index.ts",