rotacloud 1.0.30 → 1.0.32

package/src/services/leave-request.service.ts

@@ -35,27 +35,23 @@ export class LeaveRequestService extends Service {
     );
   }
 
-  async *list(query: LeaveQueryParams, options?: Options) {
+  async *list(query?: LeaveQueryParams, options?: Options) {
     for await (const res of super.iterator<ApiLeaveRequest>({ url: this.apiPath, params: query }, options)) {
       yield new LeaveRequest(res);
     }
   }
 
-  listAll(query: LeaveQueryParams, options?: Options): Promise<LeaveRequest[]>;
+  listAll(query?: LeaveQueryParams, options?: Options): Promise<LeaveRequest[]>;
   async listAll(query: LeaveQueryParams, options?: Options) {
-    try {
-      const leave = [] as LeaveRequest[];
-      for await (const leaveRequestRecord of this.list(query, options)) {
-        leave.push(leaveRequestRecord);
-      }
-      return leave;
-    } catch (err) {
-      return err;
+    const leave = [] as LeaveRequest[];
+    for await (const leaveRequestRecord of this.list(query, options)) {
+      leave.push(leaveRequestRecord);
     }
+    return leave;
   }
 
-  listByPage(options?: Options) {
-    return super.iterator<ApiLeaveRequest>({ url: `${this.apiPath}` }, options).byPage();
+  listByPage(query?: LeaveQueryParams, options?: Options) {
+    return super.iterator<ApiLeaveRequest>({ url: `${this.apiPath}`, params: query }, options).byPage();
   }
 
   update(id: number, data: Partial<ApiLeaveRequest>): Promise<LeaveRequest>;

package/src/services/leave.service.ts

@@ -44,15 +44,11 @@ export class LeaveService extends Service {
 
   listAll(query: LeaveQueryParams, options?: Options): Promise<Leave[]>;
   async listAll(query: LeaveQueryParams, options?: Options) {
-    try {
-      const leave = [] as Leave[];
-      for await (const leaveRecord of this.list(query, options)) {
-        leave.push(leaveRecord);
-      }
-      return leave;
-    } catch (err) {
-      return err;
+    const leave = [] as Leave[];
+    for await (const leaveRecord of this.list(query, options)) {
+      leave.push(leaveRecord);
     }
+    return leave;
   }
 
   async *listLeaveTypes(query: LeaveQueryParams, options?: Options) {

package/src/services/locations.service.ts

@@ -34,26 +34,22 @@ export class LocationsService extends Service {
     );
   }
 
-  async *list(query: LocationsQueryParams, options?: Options) {
+  async *list(query?: LocationsQueryParams, options?: Options) {
     for await (const res of super.iterator<ApiLocation>({ url: this.apiPath, params: query }, options)) {
       yield new Location(res);
     }
   }
 
-  listAll(query: LocationsQueryParams, options?: Options): Promise<Location[]>;
+  listAll(query?: LocationsQueryParams, options?: Options): Promise<Location[]>;
   async listAll(query: LocationsQueryParams, options?: Options) {
-    try {
-      const locations = [] as Location[];
-      for await (const location of this.list(query, options)) {
-        locations.push(location);
-      }
-      return locations;
-    } catch (err) {
-      return err;
+    const locations = [] as Location[];
+    for await (const location of this.list(query, options)) {
+      locations.push(location);
     }
+    return locations;
   }
 
-  listByPage(query: LocationsQueryParams, options?: Options) {
+  listByPage(query?: LocationsQueryParams, options?: Options) {
     return super.iterator<ApiLocation>({ url: this.apiPath, params: query }, options).byPage();
   }
 

package/src/services/roles.service.ts

@@ -34,26 +34,22 @@ export class RolesService extends Service {
     );
   }
 
-  async *list(query: RolesQueryParams, options?: Options) {
+  async *list(query?: RolesQueryParams, options?: Options) {
     for await (const res of super.iterator<ApiRole>({ url: this.apiPath, params: query }, options)) {
       yield new Role(res);
     }
   }
 
-  listAll(query: RolesQueryParams, options?: Options): Promise<Role[]>;
+  listAll(query?: RolesQueryParams, options?: Options): Promise<Role[]>;
   async listAll(query: RolesQueryParams, options?: Options) {
-    try {
-      const roles = [] as Role[];
-      for await (const role of this.list(query, options)) {
-        roles.push(role);
-      }
-      return roles;
-    } catch (err) {
-      return err;
+    const roles = [] as Role[];
+    for await (const role of this.list(query, options)) {
+      roles.push(role);
     }
+    return roles;
   }
 
-  listByPage(query: RolesQueryParams, options?: Options) {
+  listByPage(query?: RolesQueryParams, options?: Options) {
     return super.iterator<ApiRole>({ url: this.apiPath, params: query }, options).byPage();
   }
   update(id: number, data: Partial<ApiRole>): Promise<Role>;

package/src/services/service.ts

@@ -1,9 +1,46 @@
-import axios, { AxiosRequestConfig, AxiosRequestHeaders, AxiosResponse } from 'axios';
+import axios, { AxiosInstance, AxiosRequestConfig, AxiosRequestHeaders, AxiosResponse } from 'axios';
+import axiosRetry from 'axios-retry';
 import { RotaCloud } from '../rotacloud.js';
 import { Version } from '../version.js';
 
 export type RequirementsOf<T, K extends keyof T> = Required<Pick<T, K>> & Partial<T>;
 
+export enum RetryStrategy {
+  Exponential = 'expo',
+  Static = 'static',
+}
+
+export type RetryOptions =
+  | {
+      /** Use exponential back-off */
+      exponential?: false;
+      /** The maximum number of retries before erroring */
+      maxRetries: number;
+      /** Delay in milliseconds between retry attempts - not used in exponential back-off */
+      delay: number;
+    }
+  | {
+      /** Use exponential back-off */
+      exponential: true;
+      /** The maximum number of retries before erroring */
+      maxRetries: number;
+    };
+
+const DEFAULT_RETRIES = 3;
+const DEFAULT_RETRY_DELAY = 2000;
+
+const DEFAULT_RETRY_STRATEGY_OPTIONS: Record<RetryStrategy, RetryOptions> = {
+  [RetryStrategy.Exponential]: {
+    exponential: true,
+    maxRetries: DEFAULT_RETRIES,
+  },
+  [RetryStrategy.Static]: {
+    exponential: false,
+    maxRetries: DEFAULT_RETRIES,
+    delay: DEFAULT_RETRY_DELAY,
+  },
+};
+
 export interface Options {
   rawResponse?: boolean;
   expand?: string[];
@@ -22,7 +59,7 @@ type ParameterPrimitive = string | boolean | number | null;
 type ParameterValue = ParameterPrimitive | ParameterPrimitive[] | undefined;
 
 export abstract class Service<ApiResponse = any> {
-  // rate limit tracking could be implemented here statically
+  protected client: AxiosInstance = axios.create();
 
   public isLeaveRequest(endpoint?: string): boolean {
     return endpoint === '/leave_requests';
@@ -80,7 +117,24 @@ export abstract class Service<ApiResponse = any> {
       },
     };
 
-    const response = await axios.request<T>(reqObject);
+    if (RotaCloud.config.retry) {
+      const retryConfig =
+        typeof RotaCloud.config.retry === 'string'
+          ? DEFAULT_RETRY_STRATEGY_OPTIONS[RotaCloud.config.retry]
+          : RotaCloud.config.retry;
+
+      axiosRetry(this.client, {
+        retries: retryConfig.maxRetries,
+        retryDelay: (retryCount) => {
+          if (retryConfig.exponential) {
+            return axiosRetry.exponentialDelay(retryCount);
+          }
+          return retryConfig.delay;
+        },
+      });
+    }
+
+    const response = await this.client.request<T>(reqObject);
     return response;
   }
 

package/src/services/settings.service.ts

@@ -0,0 +1,23 @@
+import { AxiosResponse } from 'axios';
+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 {
+  private apiPath = '/settings';
+
+  get(query: SettingsQueryParams): Promise<Settings>;
+  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))
+    );
+  }
+}
+
+export { SettingsService };

package/src/services/shifts.service.ts

@@ -42,15 +42,11 @@ export class ShiftsService extends Service {
 
   listAll(query: ShiftsQueryParams, options?: Options): Promise<Shift[]>;
   async listAll(query: ShiftsQueryParams, options?: Options) {
-    try {
-      const shifts = [] as Shift[];
-      for await (const shift of this.list(query, options)) {
-        shifts.push(shift);
-      }
-      return shifts;
-    } catch (err) {
-      return err;
+    const shifts = [] as Shift[];
+    for await (const shift of this.list(query, options)) {
+      shifts.push(shift);
     }
+    return shifts;
   }
 
   listByPage(query: ShiftsQueryParams, options?: Options) {

package/src/services/users.service.ts

@@ -42,15 +42,11 @@ class UsersService extends Service {
 
   listAll(query: UsersQueryParams, options?: Options): Promise<User[]>;
   async listAll(query: UsersQueryParams, options?: Options) {
-    try {
-      const users = [] as User[];
-      for await (const user of this.list(query, options)) {
-        users.push(user);
-      }
-      return users;
-    } catch (err) {
-      return err;
+    const users = [] as User[];
+    for await (const user of this.list(query, options)) {
+      users.push(user);
     }
+    return users;
   }
 
   listByPage(query: UsersQueryParams, options?: Options) {

package/src/version.ts

@@ -1 +1 @@
-export const Version = { version: '1.0.30' };
+export const Version = { version: '1.0.32' };

package/dist/cjs/models/day-notes.model.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DayNotes = void 0;
-class DayNotes {
-    constructor(dayNotes) {
-        this.id = dayNotes.id;
-    }
-}
-exports.DayNotes = DayNotes;

package/dist/mjs/models/day-notes.model.js

@@ -1,5 +0,0 @@
-export class DayNotes {
-    constructor(dayNotes) {
-        this.id = dayNotes.id;
-    }
-}

package/src/models/day-notes.model.ts

@@ -1,14 +0,0 @@
-import { ApiDayNotes } from '../interfaces/index.js';
-
-export class DayNotes {
-  public id: number;
-  public start_date: string;
-  public end_date: string;
-  public locations: number[];
-  public title: string;
-  public message: string;
-
-  constructor(dayNotes: ApiDayNotes) {
-    this.id = dayNotes.id;
-  }
-}