rotacloud 1.0.52 → 1.0.55

package/.eslintrc.json

@@ -3,14 +3,14 @@
     "es2021": true,
     "node": true
   },
-  "extends": ["airbnb-base", "airbnb-typescript/base", "plugin:prettier/recommended"],
+  "extends": ["airbnb-base", "airbnb-typescript/base", "prettier"],
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "ecmaVersion": 13,
     "sourceType": "module",
     "project": "./tsconfig.json"
   },
-  "plugins": ["@typescript-eslint", "prettier"],
+  "plugins": ["@typescript-eslint"],
   "rules": {
     "@typescript-eslint/no-useless-constructor": ["off"],
     "@typescript-eslint/no-unused-vars": ["warn"],

package/.github/workflows/check.yml

@@ -0,0 +1,36 @@
+name: Check
+on:
+  workflow_call:
+    inputs:
+      NODE_VERSION:
+        type: string
+        description: 'The version of Node to run the checks with'
+        default: 16.10
+  pull_request:
+    branches: [develop]
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Use Node.js ${{ inputs.NODE_VERSION }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ inputs.NODE_VERSION }}
+          cache: 'npm'
+          registry-url: https://registry.npmjs.org/
+
+      - name: npm install
+        run: npm ci
+
+      - name: Lint
+        run: npm run lint
+
+      - name: Build
+        run: npm run build --if-present
+
+      - name: Publishable
+        run: npm publish --dry-run

package/.github/workflows/publish.yml

@@ -2,40 +2,39 @@
 # For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
 
 name: Publish
-
 on:
   push:
     branches: [main]
 
 jobs:
+  check:
+    uses: ./.github/workflows/check.yml
+
   publish:
     runs-on: ubuntu-latest
-
+    needs: [check]
     strategy:
       matrix:
-        node-version: [14.17]
+        node-version: [16.10]
         # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+
       - name: Use Node.js ${{ matrix.node-version }}
         uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
           registry-url: https://registry.npmjs.org/
+
       - name: Add version number to package
         run: |
           version=$(node -pe "require('./package.json').version")
           echo "Version is $version"
           echo "export const Version = { version: '$version' };" > ./src/version.ts
-      - name: Run CI
-        run: npm ci
-      - name: Lint
-        run: npm run lint
-      - name: Build
-        run: npm run build --if-present
+
       - name: Publish
         run: npm publish
         env:

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "rotacloud",
-  "version": "1.0.52",
+  "version": "1.0.55",
   "description": "The RotaCloud SDK for the RotaCloud API",
   "engines": {
-    "node": ">=14.17.0"
+    "node": ">=16.10.0"
   },
   "main": "./dist/cjs/rotacloud.js",
   "module": "./dist/mjs/rotacloud.js",
@@ -31,22 +31,21 @@
   },
   "homepage": "https://github.com/rotacloud/rotacloud-node#readme",
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.4.0",
-    "@typescript-eslint/parser": "^5.4.0",
-    "concurrently": "^7.2.2",
-    "eslint": "^8.2.0",
+    "@typescript-eslint/eslint-plugin": "^6.2.1",
+    "@typescript-eslint/parser": "^6.3.0",
+    "concurrently": "^8.2.0",
+    "eslint": "^8.46.0",
     "eslint-config-airbnb": "^19.0.0",
     "eslint-config-airbnb-base": "^15.0.0",
-    "eslint-config-airbnb-typescript": "^16.0.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-prettier": "^4.0.0",
-    "prettier": "2.4.1",
-    "typescript": "^4.4.4"
+    "eslint-config-airbnb-typescript": "^17.1.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-plugin-import": "^2.28.0",
+    "prettier": "~3.0.1",
+    "typescript": "^5.1.6"
   },
   "dependencies": {
-    "@types/node": "^16.11.6",
-    "axios": "^0.23.0",
-    "axios-retry": "^3.3.1"
+    "@types/node": "^16.11.7",
+    "axios": "^1.4.0",
+    "axios-retry": "^3.6.0"
   }
 }

package/src/services/attendance.service.ts

@@ -26,9 +26,7 @@ export class AttendanceService extends Service {
   get(id: number, options: { rawResponse: true } & Options): Promise<AxiosResponse<ApiAttendance, any>>;
   get(id: number, options: Options): Promise<Attendance>;
   get(id: number, options?: Options) {
-    return super.fetch<ApiAttendance>({ url: `${this.apiPath}/${id}` }, options).then((res) => {
-      return Promise.resolve(options?.rawResponse ? res : new Attendance(res.data));
-    });
+    return super.fetch<ApiAttendance>({ url: `${this.apiPath}/${id}` }, options).then((res) => Promise.resolve(options?.rawResponse ? res : new Attendance(res.data)));
   }
 
   async *list(query: AttendanceQueryParams, options?: Options) {

package/src/services/availability.service.ts

@@ -40,13 +40,11 @@ export class AvailabilityService extends Service {
     return this.update(
       {
         user,
-        dates: dates.map((date) => {
-          return {
+        dates: dates.map((date) => ({
             date,
             available: [],
             unavailable: [],
-          };
-        }),
+          })),
       },
       options
     );

package/src/services/service.ts

@@ -1,4 +1,4 @@
-import axios, { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosRequestHeaders, AxiosResponse } from 'axios';
+import axios, { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
 import axiosRetry from 'axios-retry';
 import { RotaCloud } from '../rotacloud.js';
 import { Version } from '../version.js';
@@ -27,6 +27,15 @@ export type RetryOptions =
       maxRetries: number;
     };
 
+export interface Options {
+  rawResponse?: boolean;
+  expand?: string[];
+  fields?: string[];
+  limit?: number;
+  offset?: number;
+  dryRun?: boolean;
+}
+
 const DEFAULT_RETRIES = 3;
 const DEFAULT_RETRY_DELAY = 2000;
 
@@ -42,21 +51,6 @@ const DEFAULT_RETRY_STRATEGY_OPTIONS: Record<RetryStrategy, RetryOptions> = {
   },
 };
 
-export interface Options {
-  rawResponse?: boolean;
-  expand?: string[];
-  fields?: string[];
-  limit?: number;
-  dryRun?: boolean;
-}
-
-interface PagingObject {
-  first: string;
-  prev: string;
-  next: string;
-  last: string;
-}
-
 type ParameterPrimitive = string | boolean | number | null;
 type ParameterValue = ParameterPrimitive | ParameterPrimitive[] | undefined;
 
@@ -89,13 +83,22 @@ export abstract class Service<ApiResponse = any> {
     return new SDKError(sdkErrorParams);
   }
 
-  public isLeaveRequest(endpoint?: string): boolean {
+  private isLeaveRequest(endpoint?: string): boolean {
     return endpoint === '/leave_requests';
   }
 
-  private buildQueryStr(queryParams: Record<string, ParameterValue> | undefined) {
-    if (!queryParams) return '';
-    const reducedParams = Object.entries(queryParams).reduce((params, [key, val]) => {
+  private buildQueryParams(options?: Options, extraParams?: Record<string, ParameterValue>) {
+    const queryParams: Record<string, ParameterValue> = {
+      expand: options?.expand,
+      fields: options?.fields,
+      limit: options?.limit,
+      offset: options?.offset,
+      dry_run: options?.dryRun,
+      ...extraParams,
+      // NOTE: Should not overridable so must come after spread of params
+      exclude_link_header: true,
+    };
+    const reducedParams = Object.entries(queryParams ?? {}).reduce((params, [key, val]) => {
       if (val !== undefined && val !== '') {
         if (Array.isArray(val)) params.push(...val.map((item) => [`${key}[]`, String(item)]));
         else params.push([key, String(val)]);
@@ -103,21 +106,11 @@ export abstract class Service<ApiResponse = any> {
       return params;
     }, [] as string[][]);
 
-    return new URLSearchParams(reducedParams).toString();
-  }
-
-  private parsePageLinkHeader(linkHeader: string): Partial<PagingObject> {
-    const pageData = {};
-    for (const link of linkHeader.split(',')) {
-      const { rel, url } = link.match(/<(?<url>.*)>; rel="(?<rel>\w*)"/)?.groups ?? {};
-      pageData[rel] = url;
-    }
-
-    return pageData;
+    return new URLSearchParams(reducedParams);
   }
 
-  public fetch<T = ApiResponse>(httpOptions: AxiosRequestConfig, options?: Options): Promise<AxiosResponse<T>> {
-    const headers: AxiosRequestHeaders = {
+  fetch<T = ApiResponse>(reqConfig: AxiosRequestConfig, options?: Options): Promise<AxiosResponse<T>> {
+    const headers: Record<string, string> = {
       Authorization: `Bearer ${RotaCloud.config.apiKey}`,
       'SDK-Version': Version.version,
     };
@@ -135,21 +128,14 @@ export abstract class Service<ApiResponse = any> {
       headers.Account = String(RotaCloud.config.accountId);
     } else {
       // need to convert user field in payload to a header for creating leave_requests when using an API key
-      this.isLeaveRequest(httpOptions.url) ? (headers.User = `${httpOptions.data.user}`) : undefined;
+      this.isLeaveRequest(reqConfig.url) ? (headers.User = `${reqConfig.data.user}`) : undefined;
     }
 
-    const reqObject: AxiosRequestConfig<T> = {
-      ...httpOptions,
+    const finalReqConfig: AxiosRequestConfig<T> = {
+      ...reqConfig,
       baseURL: RotaCloud.config.baseUri,
       headers,
-      params: {
-        expand: options?.expand,
-        fields: options?.fields,
-        limit: options?.limit,
-        dry_run: options?.dryRun,
-        ...httpOptions?.params,
-      },
-      paramsSerializer: this.buildQueryStr,
+      params: this.buildQueryParams(options, reqConfig.params),
     };
 
     if (RotaCloud.config.retry) {
@@ -169,52 +155,37 @@ export abstract class Service<ApiResponse = any> {
       });
     }
 
-    return this.client.request<T>(reqObject);
+    return this.client.request<T>(finalReqConfig);
   }
 
-  private async *listFetch<T = ApiResponse>(
-    reqObject: AxiosRequestConfig<T[]>,
-    options?: Options
-  ): AsyncGenerator<AxiosResponse<T[], any>> {
-    let pageRequestObject = reqObject;
-    let currentPageUrl = pageRequestObject.url;
-
-    let pageRemaining = true;
-    while (pageRemaining) {
-      const res = await this.fetch<T[]>(pageRequestObject, options);
-      const pageLinkMap = this.parsePageLinkHeader(res.headers.link ?? '');
-      pageRemaining = Boolean(pageLinkMap.next);
-      // NOTE: query params including paging options are included in the "next" link
-      pageRequestObject = { url: pageLinkMap.next };
-      yield res;
-
-      // Failsafe incase the page does not change
-      if (currentPageUrl === pageRequestObject.url) {
-        throw new Error('Next page link did not change');
-      }
-      currentPageUrl = pageRequestObject.url;
+  /** Iterates through every page for a potentially paginated request */
+  private async *fetchPages<T>(
+    reqConfig: AxiosRequestConfig<T[]>,
+    options: Options | undefined
+  ): AsyncGenerator<AxiosResponse<T[]>> {
+    const fallbackLimit = 20;
+    const res = await this.fetch<T[]>(reqConfig, options);
+    yield res;
+
+    const limit = Number(res.headers['x-limit']) || fallbackLimit;
+    const entityCount = Number(res.headers['x-total-count']) || 0;
+    const requestOffset = Number(res.headers['x-offset']) || 0;
+
+    for (let offset = requestOffset + limit; offset < entityCount; offset += limit) {
+      yield this.fetch<T[]>(reqConfig, { ...options, offset });
     }
   }
 
-  private async *listResponses<T = ApiResponse>(reqObject: AxiosRequestConfig<T[]>, options?: Options) {
-    for await (const res of this.listFetch<T>(reqObject, options)) {
+  private async *listResponses<T = ApiResponse>(reqConfig: AxiosRequestConfig<T[]>, options?: Options) {
+    for await (const res of this.fetchPages<T>(reqConfig, options)) {
       yield* res.data;
     }
   }
 
-  public iterator<T = ApiResponse>(reqObject: AxiosRequestConfig<T[]>, options?: Options) {
-    const iterator = this.listResponses<T>(reqObject, options);
+  iterator<T = ApiResponse>(reqConfig: AxiosRequestConfig<T[]>, options?: Options) {
     return {
-      [Symbol.asyncIterator]() {
-        return {
-          next() {
-            return iterator.next();
-          },
-        };
-      },
-      byPage: () => {
-        return this.listFetch<T>(reqObject, options);
-      },
+      [Symbol.asyncIterator]: () => this.listResponses<T>(reqConfig, options),
+      byPage: () => this.fetchPages<T>(reqConfig, options),
     };
   }
 }

package/src/services/shifts.service.ts

@@ -51,31 +51,62 @@ export class ShiftsService extends Service {
     return super.iterator<ApiShift>({ url: this.apiPath, params: query }, options).byPage();
   }
 
-  update(id: number, data: Partial<ApiShift>): Promise<Shift>;
+  update(shift: RequirementsOf<ApiShift, 'id'>): Promise<Shift>;
   update(
-    id: number,
-    data: Partial<ApiShift>,
+    shift: RequirementsOf<ApiShift, 'id'>,
     options: { rawResponse: true } & Options
-  ): Promise<AxiosResponse<ApiShift, any>>;
-  update(id: number, data: Partial<ApiShift>, options: Options): Promise<Shift>;
-  update(id: number, data: Partial<ApiShift>, options?: Options) {
+  ): Promise<AxiosResponse<ApiShift>>;
+  update(shift: RequirementsOf<ApiShift, 'id'>, options: Options): Promise<Shift>;
+  update(
+    shifts: RequirementsOf<ApiShift, 'id'>[]
+  ): Promise<{ success: Shift[]; failed: { id: number; error: string }[] }>;
+  update(shift: RequirementsOf<ApiShift, 'id'>, options: Options): Promise<Shift>;
+  update(
+    shifts: RequirementsOf<ApiShift, 'id'>[],
+    options: { rawResponse: true } & Options
+  ): Promise<AxiosResponse<{ code: number; data?: ApiShift; error?: string }[]>>;
+  update(
+    shifts: RequirementsOf<ApiShift, 'id'>[],
+    options: Options
+  ): Promise<{ success: Shift[]; failed: { id: number; error: string }[] }>;
+  update(shifts: RequirementsOf<ApiShift, 'id'> | RequirementsOf<ApiShift, 'id'>[], options?: Options) {
+    if (!Array.isArray(shifts)) {
+      return super
+        .fetch<ApiShift>({
+          url: `${this.apiPath}/${shifts.id}`,
+          data: shifts,
+          method: 'POST',
+        })
+        .then((res) => (options?.rawResponse ? res : new Shift(res.data)));
+    }
+
     return super
-      .fetch<ApiShift>({
-        url: `${this.apiPath}/${id}`,
-        data,
+      .fetch<{ code: number; data?: ApiShift; error?: string }[]>({
+        url: this.apiPath,
+        data: shifts,
         method: 'POST',
       })
-      .then((res) => Promise.resolve(options?.rawResponse ? res : new Shift(res.data)));
+      .then((res) => {
+        if (options?.rawResponse) return res;
+
+        const success: Shift[] = [];
+        const failed: { id: number; error: string }[] = [];
+        for (let shiftIdx = 0; shiftIdx < res.data.length; shiftIdx += 1) {
+          const { data, error } = res.data[shiftIdx];
+          if (data) success.push(new Shift(data));
+          if (error) failed.push({ id: shifts[shiftIdx].id, error });
+        }
+        return { success, failed };
+      });
   }
 
   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' };
+    const params: AxiosRequestConfig = Array.isArray(ids)
+      ? { 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));
   }

package/src/version.ts

@@ -1 +1 @@
-export const Version = { version: '1.0.52' };
+export const Version = { version: '1.0.55' };

package/dist/cjs/interfaces/account-service.interface.d.ts

@@ -1,6 +0,0 @@
-export interface ApiAccountService {
-    active: boolean;
-    billed: boolean;
-    hidden: boolean;
-    trial_expires?: string;
-}

package/dist/cjs/interfaces/account-service.interface.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/interfaces/account-services.interface.d.ts

@@ -1,6 +0,0 @@
-import { ApiAccountService } from './index.js';
-export interface ApiAccountServices {
-    time_attendance: ApiAccountService;
-    sms: ApiAccountService;
-    pro: ApiAccountService;
-}

package/dist/cjs/interfaces/account-services.interface.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/interfaces/account.interface.d.ts

@@ -1,40 +0,0 @@
-import { ApiAccountServices } from './index.js';
-export interface ApiAccount {
-    id: number;
-    name: string;
-    level: string;
-    created: number;
-    expired: boolean;
-    owner: number;
-    timezone: number;
-    industry: number;
-    phone: string;
-    address_1: string;
-    address_2: string;
-    city: string;
-    county: string;
-    postcode: string;
-    country: number;
-    services: ApiAccountServices[];
-    total_price: number;
-    pricing: object;
-    expires_in: number;
-    features_disabled: string[];
-    first_billed: string;
-    owed: number;
-    trial: boolean;
-    can_restart_trial: boolean;
-    next_billed: string;
-    hide_billing: boolean;
-    total_employees: number;
-    payment_card: string;
-    billing_type: string;
-    billing_term: string;
-    billing_email: string;
-    billing_address: string;
-    grouped_billing_parent: number;
-    grouped_billing_children: number[];
-    vat_number: string;
-    suspended: boolean;
-    suspended_message: string;
-}

package/dist/cjs/interfaces/account.interface.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/interfaces/attendance.interface.d.ts

@@ -1,31 +0,0 @@
-import { ApiShift } from './index.js';
-export interface ApiAttendanceLocation {
-    lat: number;
-    lng: number;
-    accuracy: number;
-}
-export interface ApiAttendance {
-    id: number;
-    deleted: boolean;
-    approved: boolean;
-    in_time: number;
-    out_time: number;
-    minutes_break: number;
-    user: number;
-    location: number;
-    role: number;
-    minutes_late: number;
-    hours: number;
-    hours_auto: number;
-    hours_is_auto: boolean;
-    notes: string | null;
-    shift: ApiShift | null;
-    in_method: string;
-    out_method: string;
-    in_location: ApiAttendanceLocation;
-    out_location: ApiAttendanceLocation;
-    in_device: number;
-    out_device: number;
-    in_terminal: null;
-    out_terminal: null;
-}

package/dist/cjs/interfaces/attendance.interface.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/interfaces/auth.interface.d.ts

@@ -1,8 +0,0 @@
-export interface ApiAuthAccount {
-    id: number;
-    name: string;
-}
-export interface ApiAuth {
-    two_factor_enabled: boolean;
-    accounts: ApiAuthAccount[];
-}

package/dist/cjs/interfaces/auth.interface.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/interfaces/availability-pattern.interface.d.ts

@@ -1,20 +0,0 @@
-import { ApiAvailabilityPeriod } from './index.js';
-export interface ApiAvailabilityPatternAvailability {
-    available: ApiAvailabilityPeriod[];
-    unavailable: ApiAvailabilityPeriod[];
-}
-export interface ApiAvailabilityPattern {
-    id: number;
-    user: number;
-    name: string;
-    start_date: string;
-    end_date: string;
-    repeat_weeks: number;
-    mon: ApiAvailabilityPatternAvailability;
-    tue: ApiAvailabilityPatternAvailability;
-    wed: ApiAvailabilityPatternAvailability;
-    thu: ApiAvailabilityPatternAvailability;
-    fri: ApiAvailabilityPatternAvailability;
-    sat: ApiAvailabilityPatternAvailability;
-    sun: ApiAvailabilityPatternAvailability;
-}

package/dist/cjs/interfaces/availability-pattern.interface.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/interfaces/availability.interface.d.ts

@@ -1,13 +0,0 @@
-export interface ApiAvailabilityPeriod {
-    start_time: string;
-    end_time: string;
-}
-export interface ApiAvailabilityDate {
-    date: string;
-    available: ApiAvailabilityPeriod[];
-    unavailable: ApiAvailabilityPeriod[];
-}
-export interface ApiAvailability {
-    user: number;
-    dates: ApiAvailabilityDate[];
-}

package/dist/cjs/interfaces/availability.interface.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/interfaces/daily-budgets.interface.d.ts

@@ -1,6 +0,0 @@
-export interface ApiDailyBudgets {
-    date: string;
-    location: number;
-    hours_budget: number;
-    salary_budget: number;
-}

package/dist/cjs/interfaces/daily-budgets.interface.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/interfaces/daily-revenue.interface.d.ts

@@ -1,7 +0,0 @@
-export interface ApiDailyRevenue {
-    date: string;
-    location: number;
-    labour_percentage: number;
-    revenue_target: number;
-    revenue_actual: number;
-}

package/dist/cjs/interfaces/daily-revenue.interface.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/interfaces/day-note.interface.d.ts

@@ -1,9 +0,0 @@
-export interface ApiDayNote {
-    id: number;
-    start_date: string;
-    end_date: string;
-    locations: number[];
-    title: string;
-    message: string;
-    visible_employees: boolean;
-}

package/dist/cjs/interfaces/day-note.interface.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });