@shipengine/js-api 1.1.0 → 1.2.0

package/errors/utils.d.ts

@@ -1,7 +1,10 @@
+import { SE } from "..";
+import { ApiError } from "../client";
 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 isCodedErrors: (errs: any) => errs is SE.CodedError[];
+export declare const isCodedError: (err: any) => err is SE.CodedError;
 export declare const isDataCodedErrors: (data: any) => data is {
     errors: CodedError[];
 };
 export declare const parseError: (err: any) => CodedError[];
+export declare const isInvalidTokenError: (err: ApiError) => boolean;

package/index.js

@@ -244,6 +244,21 @@ const parseError = (err) => {
     return [new CodedError(err.message)];
   }
 };
+const nonTokenRelatedErrors = [
+  "The JWT `scope` claim is invalid.",
+  "Missing required scopes for this request.",
+  "Your Stamps.com username or password are invalid",
+  "Authorization has been denied for this request."
+];
+const isInvalidTokenError = (err) => {
+  var _a;
+  const response = err.response;
+  const responseData = (_a = err.response) == null ? void 0 : _a.data;
+  if ((response == null ? void 0 : response.status) === 401 && responseData.errorSource === "shipengine" && responseData.errorType === "security" && !nonTokenRelatedErrors.includes(responseData.message)) {
+    return true;
+  }
+  return false;
+};
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
@@ -3991,7 +4006,7 @@ class ShipEngineAPI {
         return res;
       },
       (err) => __async(this, null, function* () {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e;
         logger.error(
           { err, req: err.config, res: err.response },
           "%s %s: %s %s - %s",
@@ -4001,7 +4016,7 @@ class ShipEngineAPI {
           (_e = err.response) == null ? void 0 : _e.statusText,
           err.message
         );
-        if (((_f = err.response) == null ? void 0 : _f.status) === 401) {
+        if (isInvalidTokenError(err)) {
           const token2 = yield getToken();
           const config = err.config;
           if (config) {
@@ -4218,4 +4233,5 @@ exports.getEndUserIpAddress = getEndUserIpAddress;
 exports.isCodedError = isCodedError;
 exports.isCodedErrors = isCodedErrors;
 exports.isDataCodedErrors = isDataCodedErrors;
+exports.isInvalidTokenError = isInvalidTokenError;
 exports.parseError = parseError;

package/index.mjs

@@ -240,6 +240,21 @@ const parseError = (err) => {
     return [new CodedError(err.message)];
   }
 };
+const nonTokenRelatedErrors = [
+  "The JWT `scope` claim is invalid.",
+  "Missing required scopes for this request.",
+  "Your Stamps.com username or password are invalid",
+  "Authorization has been denied for this request."
+];
+const isInvalidTokenError = (err) => {
+  var _a;
+  const response = err.response;
+  const responseData = (_a = err.response) == null ? void 0 : _a.data;
+  if ((response == null ? void 0 : response.status) === 401 && responseData.errorSource === "shipengine" && responseData.errorType === "security" && !nonTokenRelatedErrors.includes(responseData.message)) {
+    return true;
+  }
+  return false;
+};
 
 var commonjsGlobal = typeof globalThis !== 'undefined' ? globalThis : typeof window !== 'undefined' ? window : typeof global !== 'undefined' ? global : typeof self !== 'undefined' ? self : {};
 
@@ -3987,7 +4002,7 @@ class ShipEngineAPI {
         return res;
       },
       (err) => __async(this, null, function* () {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e;
         logger.error(
           { err, req: err.config, res: err.response },
           "%s %s: %s %s - %s",
@@ -3997,7 +4012,7 @@ class ShipEngineAPI {
           (_e = err.response) == null ? void 0 : _e.statusText,
           err.message
         );
-        if (((_f = err.response) == null ? void 0 : _f.status) === 401) {
+        if (isInvalidTokenError(err)) {
           const token2 = yield getToken();
           const config = err.config;
           if (config) {
@@ -4180,4 +4195,4 @@ class ShipEngineAPI {
   }
 }
 
-export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, 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 };
+export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, 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, isInvalidTokenError, parseError };

package/package.json

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

package/themes/types.d.ts

@@ -4,6 +4,8 @@ export type PartnerThemeLogo = {
 };
 export type PartnerThemeOnboarding = {
     completeButtonText?: string;
+    completeCloseButton?: boolean;
+    completeCloseButtonText?: string;
     completeText?: string;
     completeTitle?: string;
     startText?: string;