Merge pull request #18 from HubSpot/update-hubspotautherror-definition

Update `HubSpotAuthError` definition and usage

errors/HubSpotAuthError.ts

@@ -1,20 +1,21 @@
-type ErrorResponse = {
-  statusCode: number;
-  body: { category: string; subCategory: string };
-};
+import { StatusCodeError } from '../types/Error';
 
 export class HubSpotAuthError extends Error {
-  statusCode: number;
+  statusCode?: number;
   category?: string;
   subCategory?: string;
-
-  constructor(message: string, errorResponse: ErrorResponse) {
+  constructor(
+    message: string,
+    { cause = {} }: { cause?: Partial<StatusCodeError> }
+  ) {
     super(message);
     this.name = 'HubSpotAuthError';
-    this.statusCode = errorResponse.statusCode;
-    this.category =
-      (errorResponse.body && errorResponse.body.category) || undefined;
+    this.statusCode = cause.statusCode;
+    this.category = cause?.response?.body?.category || undefined;
     this.subCategory =
-      (errorResponse.body && errorResponse.body.subCategory) || undefined;
+      (cause.response &&
+        cause.response.body &&
+        cause.response.body.subCategory) ||
+      undefined;
   }
 }

errors/standardErrors.ts

@@ -53,7 +53,7 @@ export function throwTypeErrorWithMessage(
 export function throwAuthErrorWithMessage(
   identifier: string,
   interpolation?: { [key: string]: string | number },
-  cause?: BaseError
+  cause?: StatusCodeError
 ): never {
   genericThrowErrorWithMessage(
     // @ts-expect-error HubSpotAuthError is not callable

lang/en.lyaml

@@ -181,7 +181,6 @@ en:
     personalAccessKey:
       accountNotFound: "Account with id {{ accountId }} does not exist."
       invalidPersonalAccessKey: "Error while retrieving new access token: {{ errorMessage }}"
-      invalidPersonalAccessKey401: 'Error while retrieving new access token: {{ errorMessage }}. Your personal access key is invalid. Please run "hs auth personalaccesskey" to reauthenticate. See https://designers.hubspot.com/docs/personal-access-keys for more information.'
     templates:
       fileAnnotations: "Error reading file annotations {{ file }}"
       pathExists: "The {{ path }} path already exists"
@@ -219,7 +218,7 @@ en:
       functions:
         updateExistingConfig:
           configIsNotObjectError: "The existing {{ configFilePath }} is not an object"
-          endpointAreadyExistsError:  "The endpoint {{ endpointPath }} already exists in {{ configFilePath }}"
+          endpointAreadyExistsError: "The endpoint {{ endpointPath }} already exists in {{ configFilePath }}"
         createFunction:
           nestedConfigError: "Cannot create a functions directory inside '{{ ancestorConfigPath }}'"
           jsFileConflictError: "The JavaScript file at '{{ functionFilePath }}'' already exists"

lib/personalAccessKey.ts

@@ -44,21 +44,11 @@ export async function getAccessToken(
   } catch (e) {
     const error = e as StatusCodeError;
     if (error.response) {
-      if (error.response.statusCode === 401) {
-        // Before adjusting the error message below, please verify that changes do not break regex match in cli/commands/sandbox/delete.js
-        // For future changes: if response.statusCode is passed into the new error below, sandboxes can skip the regex check and pull the statusCode instead
-        throwAuthErrorWithMessage(
-          'personalAccessKey.invalidPersonalAccessKey401',
-          { errorMessage: error.response.body.message || '' },
-          error
-        );
-      } else {
-        throwAuthErrorWithMessage(
-          'personalAccessKey.invalidPersonalAccessKey',
-          { errorMessage: error.response.body.message || '' },
-          error
-        );
-      }
+      throwAuthErrorWithMessage(
+        'personalAccessKey.invalidPersonalAccessKey',
+        { errorMessage: error.response.body.message || '' },
+        error
+      );
     } else {
       throwError(e as BaseError);
     }

types/Error.ts

@@ -27,6 +27,8 @@ export interface StatusCodeError extends BaseError {
     body: {
       message?: string;
       errors?: Array<StatusCodeError>;
+      category?: string;
+      subCategory?: string;
     };
     headers: {
       [key: string]: string;