@shipengine/js-api 0.52.2 → 0.53.0

package/client.d.ts

@@ -1,9 +1,10 @@
-import { AxiosRequestHeaders } from "axios";
+import { AxiosError, AxiosRequestHeaders } from "axios";
 import { AccountBillingPlanAPI } from "./account-billing-plan";
 import { AccountSettingsAPI } from "./account-settings";
 import { AddressesAPI } from "./addresses";
 import { CarriersAPI } from "./carriers";
 import { CustomPackagesAPI } from "./custom-packages";
+import { CodedError } from "./errors";
 import { FundingSourcesAPI } from "./funding-sources";
 import { InsuranceAPI } from "./insurance";
 import { LabelsAPI } from "./labels";
@@ -20,6 +21,12 @@ import { WarehousesAPI } from "./warehouses";
  * # ShipEngine API Client Headers
  */
 export type ShipEngineAPIHeaders = AxiosRequestHeaders;
+/**
+ * # ShipEngine API axios error response
+ */
+export type ApiError = AxiosError<{
+    errors: CodedError[];
+} | CodedError[] | CodedError | string>;
 /**
  * # ShipEngine API Client Configuration
  */
@@ -36,6 +43,10 @@ export interface ShipEngineAPIConfig {
      * `headers` are optional HTTP headers to be sent with all requests.
      */
     headers?: ShipEngineAPIHeaders;
+    /**
+     * `onApiError` is an optional callback function that will be executed whenever there is an error.
+     */
+    onApiError?: (errors: CodedError[], error: ApiError) => void;
 }
 /**
  * # ShipEngine API Client
@@ -45,7 +56,7 @@ export interface ShipEngineAPIConfig {
  */
 export declare class ShipEngineAPI {
     private client;
-    constructor(token: string, { baseURL, headers, getToken }: ShipEngineAPIConfig);
+    constructor(token: string, { baseURL, headers, getToken, onApiError }: ShipEngineAPIConfig);
     /**
      * The `token` method takes in a string and sets it as the Authorization header for all requests.
      */

package/errors/utils.d.ts

@@ -1,3 +1,7 @@
 import { CodedError } from "./types";
 export declare const isCodedErrors: (errs: any) => errs is CodedError[];
 export declare const isCodedError: (err: any) => err is CodedError;
+export declare const isDataCodedErrors: (data: any) => data is {
+    errors: CodedError[];
+};
+export declare const parseError: (err: any) => CodedError[];

package/index.js

@@ -229,6 +229,21 @@ class AddressesAPI {
 
 const isCodedErrors = (errs) => Array.isArray(errs) && errs.every((err) => isCodedError(err));
 const isCodedError = (err) => !!err.errorCode;
+const isDataCodedErrors = (data) => !!data.errors && isCodedErrors(data.errors);
+const parseError = (err) => {
+  var _a;
+  if (!((_a = err.response) == null ? void 0 : _a.data))
+    return [new CodedError(err.message)];
+  if (isDataCodedErrors(err.response.data)) {
+    return err.response.data.errors.map((err2) => CodedError.fromObject(err2));
+  } else if (isCodedErrors(err.response.data)) {
+    return err.response.data.map((err2) => CodedError.fromObject(err2));
+  } else if (isCodedError(err.response.data)) {
+    return [CodedError.fromObject(err.response.data)];
+  } else {
+    return [new CodedError(err.message)];
+  }
+};
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
@@ -3864,6 +3879,7 @@ var __async = (__this, __arguments, generator) => {
   });
 };
 const logger = E({
+  level: process.env.NODE_ENV === "production" ? "fatal" : "info",
   name: "shipengine-api",
   serializers: __spreadProps(__spreadValues({}, k), {
     req: (req) => ({
@@ -3885,9 +3901,8 @@ const logger = E({
     }
   ]
 });
-const isDataCodedErrors = (data) => !!data.errors && isCodedErrors(data.errors);
 class ShipEngineAPI {
-  constructor(token, { baseURL, headers, getToken }) {
+  constructor(token, { baseURL, headers, getToken, onApiError }) {
     const client = axios.create({
       baseURL,
       headers: __spreadProps(__spreadValues({}, headers), {
@@ -3938,7 +3953,7 @@ class ShipEngineAPI {
         return res;
       },
       (err) => __async(this, null, function* () {
-        var _a, _b, _c, _d, _e, _f, _g;
+        var _a, _b, _c, _d, _e, _f;
         logger.error(
           { err, req: err.config, res: err.response },
           "%s %s: %s %s - %s",
@@ -3957,22 +3972,9 @@ class ShipEngineAPI {
           }
           return axios(config);
         }
-        if ((_g = err.response) == null ? void 0 : _g.data) {
-          if (isDataCodedErrors(err.response.data)) {
-            return Promise.reject(
-              err.response.data.errors.map((err2) => CodedError.fromObject(err2))
-            );
-          }
-          if (isCodedErrors(err.response.data)) {
-            return Promise.reject(err.response.data.map((err2) => CodedError.fromObject(err2)));
-          }
-          if (isCodedError(err.response.data)) {
-            return Promise.reject([CodedError.fromObject(err.response.data)]);
-          }
-          return Promise.reject([new CodedError(err.response.data)]);
-        } else {
-          return Promise.reject([new CodedError(err.message)]);
-        }
+        const codedErrors = parseError(err);
+        onApiError == null ? void 0 : onApiError(codedErrors, err);
+        return Promise.reject(codedErrors);
       })
     );
     this.client = client;
@@ -4167,3 +4169,5 @@ exports.WarehousesAPI = WarehousesAPI;
 exports.getEndUserIpAddress = getEndUserIpAddress;
 exports.isCodedError = isCodedError;
 exports.isCodedErrors = isCodedErrors;
+exports.isDataCodedErrors = isDataCodedErrors;
+exports.parseError = parseError;

package/index.mjs

@@ -225,6 +225,21 @@ class AddressesAPI {
 
 const isCodedErrors = (errs) => Array.isArray(errs) && errs.every((err) => isCodedError(err));
 const isCodedError = (err) => !!err.errorCode;
+const isDataCodedErrors = (data) => !!data.errors && isCodedErrors(data.errors);
+const parseError = (err) => {
+  var _a;
+  if (!((_a = err.response) == null ? void 0 : _a.data))
+    return [new CodedError(err.message)];
+  if (isDataCodedErrors(err.response.data)) {
+    return err.response.data.errors.map((err2) => CodedError.fromObject(err2));
+  } else if (isCodedErrors(err.response.data)) {
+    return err.response.data.map((err2) => CodedError.fromObject(err2));
+  } else if (isCodedError(err.response.data)) {
+    return [CodedError.fromObject(err.response.data)];
+  } else {
+    return [new CodedError(err.message)];
+  }
+};
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
@@ -3860,6 +3875,7 @@ var __async = (__this, __arguments, generator) => {
   });
 };
 const logger = E({
+  level: process.env.NODE_ENV === "production" ? "fatal" : "info",
   name: "shipengine-api",
   serializers: __spreadProps(__spreadValues({}, k), {
     req: (req) => ({
@@ -3881,9 +3897,8 @@ const logger = E({
     }
   ]
 });
-const isDataCodedErrors = (data) => !!data.errors && isCodedErrors(data.errors);
 class ShipEngineAPI {
-  constructor(token, { baseURL, headers, getToken }) {
+  constructor(token, { baseURL, headers, getToken, onApiError }) {
     const client = axios.create({
       baseURL,
       headers: __spreadProps(__spreadValues({}, headers), {
@@ -3934,7 +3949,7 @@ class ShipEngineAPI {
         return res;
       },
       (err) => __async(this, null, function* () {
-        var _a, _b, _c, _d, _e, _f, _g;
+        var _a, _b, _c, _d, _e, _f;
         logger.error(
           { err, req: err.config, res: err.response },
           "%s %s: %s %s - %s",
@@ -3953,22 +3968,9 @@ class ShipEngineAPI {
           }
           return axios(config);
         }
-        if ((_g = err.response) == null ? void 0 : _g.data) {
-          if (isDataCodedErrors(err.response.data)) {
-            return Promise.reject(
-              err.response.data.errors.map((err2) => CodedError.fromObject(err2))
-            );
-          }
-          if (isCodedErrors(err.response.data)) {
-            return Promise.reject(err.response.data.map((err2) => CodedError.fromObject(err2)));
-          }
-          if (isCodedError(err.response.data)) {
-            return Promise.reject([CodedError.fromObject(err.response.data)]);
-          }
-          return Promise.reject([new CodedError(err.response.data)]);
-        } else {
-          return Promise.reject([new CodedError(err.message)]);
-        }
+        const codedErrors = parseError(err);
+        onApiError == null ? void 0 : onApiError(codedErrors, err);
+        return Promise.reject(codedErrors);
       })
     );
     this.client = client;
@@ -4131,4 +4133,4 @@ class ShipEngineAPI {
   }
 }
 
-export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, getEndUserIpAddress, isCodedError, isCodedErrors };
+export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, parseError };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/js-api",
-  "version": "0.52.2",
+  "version": "0.53.0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {