feat: expand some typings

openedx · Dec 18, 2023 · bdea28f · bdea28f
1 parent bd8ff73
commit bdea28f
Show file tree

Hide file tree

Showing 3 changed files with 22 additions and 0 deletions.
diff --git a/src/auth/interceptors/createProcessAxiosRequestErrorInterceptor.js b/src/auth/interceptors/createProcessAxiosRequestErrorInterceptor.js
@@ -1,3 +1,4 @@
+// @ts-check
 import { processAxiosError } from '../utils.js';
 
 const createProcessAxiosRequestErrorInterceptor = (options) => {

diff --git a/src/auth/interface.js b/src/auth/interface.js
@@ -256,6 +256,21 @@ export async function hydrateAuthenticatedUser() {
  * @typedef {import("axios").Axios} HttpClient
  */
 
+/**
+ * @typedef {Object} CustomErrorAttributes
+ * @property {number} [httpErrorStatus]
+ * @property {'unknown-api-request-error'|'api-response-error'|'api-request-error'|'api-request-config-error'
+ * } [httpErrorType]
+ * @property {string} [httpErrorMessage]
+ * @property {string} [httpErrorRequestUrl]
+ * @property {string} [httpErrorRequestMethod]
+ * @property {any} [httpErrorResponseData]
+ */
+
+/**
+ * @typedef {import("axios").AxiosError & {customAttributes: CustomErrorAttributes}} DetailedAxiosError
+ */
+
 /**
  * @typedef {Object} AuthService
  * @property {typeof getAuthenticatedHttpClient} getAuthenticatedHttpClient

diff --git a/src/auth/utils.js b/src/auth/utils.js
@@ -36,7 +36,13 @@ const logFrontendAuthError = (loggingService, error) => {
   loggingService.logError(prefixedMessageError, prefixedMessageError.customAttributes);
 };
 
+/**
+ * Handle an Axios error
+ * @param {import("axios").AxiosError} axiosErrorObject The error
+ * @returns {import("./interface").DetailedAxiosError}
+ */
 const processAxiosError = (axiosErrorObject) => {
+  /** @type {import("./interface").DetailedAxiosError} */
   const error = Object.create(axiosErrorObject);
   const { request, response, config } = error;