rotacloud 1.0.39 → 1.0.41

package/src/services/service.ts

@@ -1,7 +1,8 @@
-import axios, { AxiosInstance, AxiosRequestConfig, AxiosRequestHeaders, AxiosResponse } from 'axios';
+import axios, { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosRequestHeaders, AxiosResponse } from 'axios';
 import axiosRetry from 'axios-retry';
 import { RotaCloud } from '../rotacloud.js';
 import { Version } from '../version.js';
+import { SDKErrorConfig, SDKError } from '../models/SDKError.model.js';
 
 export type RequirementsOf<T, K extends keyof T> = Required<Pick<T, K>> & Partial<T>;
 
@@ -59,7 +60,33 @@ type ParameterPrimitive = string | boolean | number | null;
 type ParameterValue = ParameterPrimitive | ParameterPrimitive[] | undefined;
 
 export abstract class Service<ApiResponse = any> {
-  protected client: AxiosInstance = axios.create();
+  protected client: AxiosInstance = this.initialiseAxios();
+
+  private initialiseAxios(): AxiosInstance {
+    const client = axios.create();
+    client.interceptors.response.use(
+      (response) => response,
+      (error) => {
+        const parsedError = this.parseClientError(error);
+
+        return Promise.reject(parsedError);
+      }
+    );
+    return client;
+  }
+
+  private parseClientError(error: unknown | AxiosError): SDKError | unknown {
+    if (!axios.isAxiosError(error)) return error;
+    const axiosErrorLocation = error.response || error.request;
+    const apiErrorMessage = axiosErrorLocation.data?.error;
+    const sdkErrorParams: SDKErrorConfig = {
+      code: axiosErrorLocation.status,
+      message: apiErrorMessage || error.message,
+      data: axiosErrorLocation.data,
+    };
+
+    return new SDKError(sdkErrorParams);
+  }
 
   public isLeaveRequest(endpoint?: string): boolean {
     return endpoint === '/leave_requests';

package/src/services/settings.service.ts

@@ -3,7 +3,7 @@ import { Settings } from '../models/settings.model.js';
 import { Service, Options } from './index.js';
 
 import { ApiSettings } from '../interfaces/index.js';
-import { ErrorResponse } from '../models/error-response.model.js';
+
 import { SettingsQueryParams } from '../rotacloud.js';
 
 class SettingsService extends Service {
@@ -13,10 +13,9 @@ class SettingsService extends Service {
   get(query: SettingsQueryParams, options: { rawResponse: true } & Options): Promise<AxiosResponse<ApiSettings, any>>;
   get(query: SettingsQueryParams, options: Options): Promise<Settings>;
   get(query: SettingsQueryParams, options?: Options) {
-    return super.fetch<ApiSettings>({ url: `${this.apiPath}`, params: query }, options).then(
-      (res) => Promise.resolve(options?.rawResponse ? res : new Settings(res.data)),
-      (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
-    );
+    return super
+      .fetch<ApiSettings>({ url: `${this.apiPath}`, params: query }, options)
+      .then((res) => Promise.resolve(options?.rawResponse ? res : new Settings(res.data)));
   }
 }
 

package/src/services/shifts.service.ts

@@ -1,9 +1,9 @@
-import { AxiosResponse } from 'axios';
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
 import { ApiShift } from '../interfaces/index.js';
 import { Service, Options, RequirementsOf } from './index.js';
 
 import { Shift } from '../models/shift.model.js';
-import { ErrorResponse } from '../models/error-response.model.js';
+
 import { ShiftsQueryParams } from '../interfaces/query-params/shifts-query-params.interface.js';
 
 type RequiredProps = 'end_time' | 'start_time' | 'location';
@@ -18,20 +18,18 @@ export class ShiftsService extends Service {
   ): Promise<AxiosResponse<ApiShift, any>>;
   create(data: RequirementsOf<ApiShift, RequiredProps>, options: Options): Promise<Shift>;
   create(data: RequirementsOf<ApiShift, RequiredProps>, options?: Options) {
-    return super.fetch<ApiShift>({ url: this.apiPath, data, method: 'POST' }).then(
-      (res) => Promise.resolve(options?.rawResponse ? res : new Shift(res.data)),
-      (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
-    );
+    return super
+      .fetch<ApiShift>({ url: this.apiPath, data, method: 'POST' })
+      .then((res) => Promise.resolve(options?.rawResponse ? res : new Shift(res.data)));
   }
 
   get(id: number): Promise<Shift>;
   get(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<ApiShift, any>>;
   get(id: number, options: Options): Promise<Shift>;
   get(id: number, options?: Options) {
-    return super.fetch<ApiShift>({ url: `${this.apiPath}/${id}` }, options).then(
-      (res) => Promise.resolve(options?.rawResponse ? res : new Shift(res.data)),
-      (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
-    );
+    return super
+      .fetch<ApiShift>({ url: `${this.apiPath}/${id}` }, options)
+      .then((res) => Promise.resolve(options?.rawResponse ? res : new Shift(res.data)));
   }
 
   async *list(query: ShiftsQueryParams, options?: Options) {
@@ -67,49 +65,45 @@ export class ShiftsService extends Service {
         data,
         method: 'POST',
       })
-      .then(
-        (res) => Promise.resolve(options?.rawResponse ? res : new Shift(res.data)),
-        (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
-      );
+      .then((res) => Promise.resolve(options?.rawResponse ? res : new Shift(res.data)));
   }
 
-  delete(id: number): Promise<number>;
-  delete(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<any, any>>;
-  delete(id: number, options: Options): Promise<number>;
-  delete(id: number, options?: Options) {
-    return super.fetch<ApiShift>({ url: `${this.apiPath}/${id}`, method: 'DELETE' }).then(
-      (res) => Promise.resolve(options?.rawResponse ? res : res.status),
-      (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
-    );
+  delete(ids: number | number[]): Promise<number>;
+  delete(ids: number | number[], options: { rawResponse: true } & Options): Promise<AxiosResponse<any, any>>;
+  delete(ids: number | number[], options: Options): Promise<number>;
+  delete(ids: number | number[], options?: Options) {
+    const params: AxiosRequestConfig =
+      typeof ids !== 'number'
+        ? { url: this.apiPath, data: ids, method: 'DELETE' }
+        : { url: `${this.apiPath}/${ids}`, method: 'DELETE' };
+
+    return super.fetch<ApiShift>(params).then((res) => Promise.resolve(options?.rawResponse ? res : res.status));
   }
 
   acknowledge(data: number[]): Promise<number>;
   acknowledge(data: number[], options: { rawResponse: true } & Options): Promise<AxiosResponse<any, any>>;
   acknowledge(data: number[], options: Options): Promise<number>;
   acknowledge(data: number[], options?: Options) {
-    return super.fetch<ApiShift>({ url: '/shifts_acknowledged', data, method: 'POST' }).then(
-      (res) => Promise.resolve(options?.rawResponse ? res : res.status),
-      (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
-    );
+    return super
+      .fetch<ApiShift>({ url: '/shifts_acknowledged', data, method: 'POST' })
+      .then((res) => Promise.resolve(options?.rawResponse ? res : res.status));
   }
 
   publish(data: { shifts: number[] }): Promise<number>;
   publish(data: { shifts: number[] }, options: { rawResponse: true } & Options): Promise<AxiosResponse<any, any>>;
   publish(data: { shifts: number[] }, options: Options): Promise<number>;
   publish(data: { shifts: number[] }, options?: Options) {
-    return super.fetch<ApiShift>({ url: '/shifts_published', data, method: 'POST' }).then(
-      (res) => Promise.resolve(options?.rawResponse ? res : res.status),
-      (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
-    );
+    return super
+      .fetch<ApiShift>({ url: '/shifts_published', data, method: 'POST' })
+      .then((res) => Promise.resolve(options?.rawResponse ? res : res.status));
   }
 
   unpublish(data: { shifts: number[] }): Promise<number>;
   unpublish(data: { shifts: number[] }, options: { rawResponse: true } & Options): Promise<AxiosResponse<any, any>>;
   unpublish(data: { shifts: number[] }, options: Options): Promise<number>;
   unpublish(data: { shifts: number[] }, options?: Options) {
-    return super.fetch<ApiShift>({ url: '/shifts_published', data, method: 'DELETE' }).then(
-      (res) => Promise.resolve(options?.rawResponse ? res : res.status),
-      (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
-    );
+    return super
+      .fetch<ApiShift>({ url: '/shifts_published', data, method: 'DELETE' })
+      .then((res) => Promise.resolve(options?.rawResponse ? res : res.status));
   }
 }

package/src/services/users.service.ts

@@ -3,7 +3,7 @@ import { ApiUser } from '../interfaces/index.js';
 import { Service, Options, RequirementsOf } from './index.js';
 
 import { User } from '../models/user.model.js';
-import { ErrorResponse } from '../models/error-response.model.js';
+
 import { UsersQueryParams } from '../interfaces/query-params/users-query-params.interface.js';
 
 type RequiredProps = 'first_name' | 'last_name';
@@ -18,20 +18,18 @@ class UsersService extends Service {
   ): Promise<AxiosResponse<ApiUser, any>>;
   create(data: RequirementsOf<ApiUser, RequiredProps>, options: Options): Promise<User>;
   create(data: RequirementsOf<ApiUser, RequiredProps>, options?: Options) {
-    return super.fetch<ApiUser>({ url: this.apiPath, data, method: 'POST' }).then(
-      (res) => Promise.resolve(options?.rawResponse ? res : new User(res.data)),
-      (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
-    );
+    return super
+      .fetch<ApiUser>({ url: this.apiPath, data, method: 'POST' })
+      .then((res) => Promise.resolve(options?.rawResponse ? res : new User(res.data)));
   }
 
   get(id: number): Promise<User>;
   get(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<ApiUser, any>>;
   get(id: number, options: Options): Promise<User>;
   get(id: number, options?: Options) {
-    return super.fetch<ApiUser>({ url: `${this.apiPath}/${id}` }, options).then(
-      (res) => Promise.resolve(options?.rawResponse ? res : new User(res.data)),
-      (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
-    );
+    return super
+      .fetch<ApiUser>({ url: `${this.apiPath}/${id}` }, options)
+      .then((res) => Promise.resolve(options?.rawResponse ? res : new User(res.data)));
   }
 
   async *list(query: UsersQueryParams, options?: Options) {
@@ -67,20 +65,16 @@ class UsersService extends Service {
         data,
         method: 'POST',
       })
-      .then(
-        (res) => Promise.resolve(options?.rawResponse ? res : new User(res.data)),
-        (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
-      );
+      .then((res) => Promise.resolve(options?.rawResponse ? res : new User(res.data)));
   }
 
   delete(id: number): Promise<number>;
   delete(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<any, any>>;
   delete(id: number, options: Options): Promise<number>;
   delete(id: number, options?: Options) {
-    return super.fetch<ApiUser>({ url: `${this.apiPath}/${id}`, method: 'DELETE' }).then(
-      (res) => Promise.resolve(options?.rawResponse ? res : res.status),
-      (err) => Promise.reject(options?.rawResponse ? err : new ErrorResponse(err))
-    );
+    return super
+      .fetch<ApiUser>({ url: `${this.apiPath}/${id}`, method: 'DELETE' })
+      .then((res) => Promise.resolve(options?.rawResponse ? res : res.status));
   }
 }
 

package/src/version.ts

@@ -1 +1 @@
-export const Version = { version: '1.0.39' };
+export const Version = { version: '1.0.41' };

package/dist/cjs/models/error-response.model.d.ts

@@ -1,8 +0,0 @@
-import { AxiosError } from 'axios';
-export declare class ErrorResponse {
-    status: number | undefined;
-    statusText: string | undefined;
-    message: string;
-    data: any;
-    constructor(err: AxiosError<any, any>);
-}

package/dist/cjs/models/error-response.model.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorResponse = void 0;
-class ErrorResponse {
-    constructor(err) {
-        var _a, _b, _c;
-        this.status = (_a = err.response) === null || _a === void 0 ? void 0 : _a.status;
-        this.statusText = (_b = err.response) === null || _b === void 0 ? void 0 : _b.statusText;
-        this.message = err.message;
-        this.data = (_c = err.response) === null || _c === void 0 ? void 0 : _c.data;
-    }
-}
-exports.ErrorResponse = ErrorResponse;

package/dist/mjs/models/error-response.model.d.ts

@@ -1,8 +0,0 @@
-import { AxiosError } from 'axios';
-export declare class ErrorResponse {
-    status: number | undefined;
-    statusText: string | undefined;
-    message: string;
-    data: any;
-    constructor(err: AxiosError<any, any>);
-}

package/dist/mjs/models/error-response.model.js

@@ -1,8 +0,0 @@
-export class ErrorResponse {
-    constructor(err) {
-        this.status = err.response?.status;
-        this.statusText = err.response?.statusText;
-        this.message = err.message;
-        this.data = err.response?.data;
-    }
-}

package/src/models/error-response.model.ts

@@ -1,14 +0,0 @@
-import { AxiosError } from 'axios';
-
-export class ErrorResponse {
-  public status: number | undefined;
-  public statusText: string | undefined;
-  public message: string;
-  public data: any;
-  constructor(err: AxiosError<any, any>) {
-    this.status = err.response?.status;
-    this.statusText = err.response?.statusText;
-    this.message = err.message;
-    this.data = err.response?.data;
-  }
-}