rotacloud 1.0.33 → 1.0.34

package/dist/cjs/interfaces/query-params/users-query-params.interface.d.ts

@@ -8,7 +8,6 @@ export interface UsersQueryParams {
     search?: string;
     order?: string;
     period?: string;
-    location?: number;
     start_time?: number;
     end_time?: number;
     start_date?: string;

package/dist/cjs/services/service.d.ts

@@ -27,11 +27,11 @@ export declare abstract class Service<ApiResponse = any> {
     protected client: AxiosInstance;
     isLeaveRequest(endpoint?: string): boolean;
     private buildQueryStr;
-    private getPagingObject;
+    private parsePageLinkHeader;
     fetch<T = ApiResponse>(httpOptions: AxiosRequestConfig, options?: Options): Promise<AxiosResponse<T>>;
     private listFetch;
     private listResponses;
-    iterator<T = ApiResponse>(reqObject: any, options?: Options): {
+    iterator<T = ApiResponse>(reqObject: AxiosRequestConfig<T[]>, options?: Options): {
         [Symbol.asyncIterator](): {
             next(): Promise<IteratorResult<T, void>>;
         };

package/dist/cjs/services/service.js

@@ -1,13 +1,4 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
 var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
     if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
@@ -67,6 +58,8 @@ class Service {
         return endpoint === '/leave_requests';
     }
     buildQueryStr(queryParams) {
+        if (!queryParams)
+            return '';
         const reducedParams = Object.entries(queryParams).reduce((params, [key, val]) => {
             if (val !== undefined && val !== '') {
                 if (Array.isArray(val))
@@ -78,70 +71,63 @@ class Service {
         }, []);
         return new URLSearchParams(reducedParams).toString();
     }
-    getPagingObject(res) {
-        const links = res.headers.link.split(',');
-        const keyVal = {};
-        links.forEach((link) => {
-            const exp = link.split(';');
-            const key = exp[1].replace(' rel="', '').replace('"', '').trim();
-            const value = exp[0].replace('<', '').replace('>', '').trim();
-            keyVal[key] = value;
-        });
-        return keyVal;
+    parsePageLinkHeader(linkHeader) {
+        var _a, _b;
+        const pageData = {};
+        for (const link of linkHeader.split(',')) {
+            const { rel, url } = (_b = (_a = link.match(/<(?<url>.*)>; rel="(?<rel>\w*)"/)) === null || _a === void 0 ? void 0 : _a.groups) !== null && _b !== void 0 ? _b : {};
+            pageData[rel] = url;
+        }
+        return pageData;
     }
     fetch(httpOptions, options) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const headers = {
-                Authorization: `Bearer ${rotacloud_js_1.RotaCloud.config.apiKey}`,
-                'SDK-Version': version_js_1.Version.version,
-            };
-            if (rotacloud_js_1.RotaCloud.config.accountId) {
-                headers.Account = String(rotacloud_js_1.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;
-            }
-            const reqObject = Object.assign(Object.assign({}, httpOptions), { baseURL: rotacloud_js_1.RotaCloud.config.baseUri, headers, params: Object.assign({ expand: options === null || options === void 0 ? void 0 : options.expand, fields: options === null || options === void 0 ? void 0 : options.fields, limit: options === null || options === void 0 ? void 0 : options.limit }, httpOptions === null || httpOptions === void 0 ? void 0 : httpOptions.params), paramsSerializer: (params) => {
-                    return params ? this.buildQueryStr(params) : '';
-                } });
-            if (rotacloud_js_1.RotaCloud.config.retry) {
-                const retryConfig = typeof rotacloud_js_1.RotaCloud.config.retry === 'string'
-                    ? DEFAULT_RETRY_STRATEGY_OPTIONS[rotacloud_js_1.RotaCloud.config.retry]
-                    : rotacloud_js_1.RotaCloud.config.retry;
-                (0, axios_retry_1.default)(this.client, {
-                    retries: retryConfig.maxRetries,
-                    retryDelay: (retryCount) => {
-                        if (retryConfig.exponential) {
-                            return axios_retry_1.default.exponentialDelay(retryCount);
-                        }
-                        return retryConfig.delay;
-                    },
-                });
-            }
-            const response = yield this.client.request(reqObject);
-            return response;
-        });
+        const headers = {
+            Authorization: `Bearer ${rotacloud_js_1.RotaCloud.config.apiKey}`,
+            'SDK-Version': version_js_1.Version.version,
+        };
+        if (rotacloud_js_1.RotaCloud.config.accountId) {
+            headers.Account = String(rotacloud_js_1.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;
+        }
+        const reqObject = Object.assign(Object.assign({}, httpOptions), { baseURL: rotacloud_js_1.RotaCloud.config.baseUri, headers, params: Object.assign({ expand: options === null || options === void 0 ? void 0 : options.expand, fields: options === null || options === void 0 ? void 0 : options.fields, limit: options === null || options === void 0 ? void 0 : options.limit }, httpOptions === null || httpOptions === void 0 ? void 0 : httpOptions.params), paramsSerializer: this.buildQueryStr });
+        if (rotacloud_js_1.RotaCloud.config.retry) {
+            const retryConfig = typeof rotacloud_js_1.RotaCloud.config.retry === 'string'
+                ? DEFAULT_RETRY_STRATEGY_OPTIONS[rotacloud_js_1.RotaCloud.config.retry]
+                : rotacloud_js_1.RotaCloud.config.retry;
+            (0, axios_retry_1.default)(this.client, {
+                retries: retryConfig.maxRetries,
+                retryDelay: (retryCount) => {
+                    if (retryConfig.exponential) {
+                        return axios_retry_1.default.exponentialDelay(retryCount);
+                    }
+                    return retryConfig.delay;
+                },
+            });
+        }
+        return this.client.request(reqObject);
     }
     listFetch(reqObject, options) {
+        var _a;
         return __asyncGenerator(this, arguments, function* listFetch_1() {
-            let running = true;
-            do {
-                const res = yield __await(this.fetch(reqObject, options));
-                if (res.headers.link) {
-                    const pagingObject = this.getPagingObject(res);
-                    if (pagingObject.last) {
-                        reqObject.url = pagingObject.next;
-                    }
-                    else {
-                        running = false;
-                    }
-                }
-                else {
-                    running = false;
-                }
+            let pageRequestObject = reqObject;
+            let currentPageUrl = pageRequestObject.url;
+            let pageRemaining = true;
+            while (pageRemaining) {
+                const res = yield __await(this.fetch(pageRequestObject, options));
+                const pageLinkMap = this.parsePageLinkHeader((_a = res.headers.link) !== null && _a !== void 0 ? _a : '');
+                pageRemaining = Boolean(pageLinkMap.next);
+                // NOTE: query params including paging options are included in the "next" link
+                pageRequestObject = { url: pageLinkMap.next };
                 yield yield __await(res);
-            } while (running);
+                // Failsafe incase the page does not change
+                if (currentPageUrl === pageRequestObject.url) {
+                    throw new Error('Next page link did not change');
+                }
+                currentPageUrl = pageRequestObject.url;
+            }
         });
     }
     listResponses(reqObject, options) {

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Version = void 0;
-exports.Version = { version: '1.0.33' };
+exports.Version = { version: '1.0.34' };

package/dist/mjs/interfaces/query-params/users-query-params.interface.d.ts

@@ -8,7 +8,6 @@ export interface UsersQueryParams {
     search?: string;
     order?: string;
     period?: string;
-    location?: number;
     start_time?: number;
     end_time?: number;
     start_date?: string;

package/dist/mjs/services/service.d.ts

@@ -27,11 +27,11 @@ export declare abstract class Service<ApiResponse = any> {
     protected client: AxiosInstance;
     isLeaveRequest(endpoint?: string): boolean;
     private buildQueryStr;
-    private getPagingObject;
+    private parsePageLinkHeader;
     fetch<T = ApiResponse>(httpOptions: AxiosRequestConfig, options?: Options): Promise<AxiosResponse<T>>;
     private listFetch;
     private listResponses;
-    iterator<T = ApiResponse>(reqObject: any, options?: Options): {
+    iterator<T = ApiResponse>(reqObject: AxiosRequestConfig<T[]>, options?: Options): {
         [Symbol.asyncIterator](): {
             next(): Promise<IteratorResult<T, void>>;
         };

package/dist/mjs/services/service.js

@@ -28,6 +28,8 @@ export class Service {
         return endpoint === '/leave_requests';
     }
     buildQueryStr(queryParams) {
+        if (!queryParams)
+            return '';
         const reducedParams = Object.entries(queryParams).reduce((params, [key, val]) => {
             if (val !== undefined && val !== '') {
                 if (Array.isArray(val))
@@ -39,18 +41,15 @@ export class Service {
         }, []);
         return new URLSearchParams(reducedParams).toString();
     }
-    getPagingObject(res) {
-        const links = res.headers.link.split(',');
-        const keyVal = {};
-        links.forEach((link) => {
-            const exp = link.split(';');
-            const key = exp[1].replace(' rel="', '').replace('"', '').trim();
-            const value = exp[0].replace('<', '').replace('>', '').trim();
-            keyVal[key] = value;
-        });
-        return keyVal;
+    parsePageLinkHeader(linkHeader) {
+        const pageData = {};
+        for (const link of linkHeader.split(',')) {
+            const { rel, url } = link.match(/<(?<url>.*)>; rel="(?<rel>\w*)"/)?.groups ?? {};
+            pageData[rel] = url;
+        }
+        return pageData;
     }
-    async fetch(httpOptions, options) {
+    fetch(httpOptions, options) {
         const headers = {
             Authorization: `Bearer ${RotaCloud.config.apiKey}`,
             'SDK-Version': Version.version,
@@ -72,9 +71,7 @@ export class Service {
                 limit: options?.limit,
                 ...httpOptions?.params,
             },
-            paramsSerializer: (params) => {
-                return params ? this.buildQueryStr(params) : '';
-            },
+            paramsSerializer: this.buildQueryStr,
         };
         if (RotaCloud.config.retry) {
             const retryConfig = typeof RotaCloud.config.retry === 'string'
@@ -90,27 +87,25 @@ export class Service {
                 },
             });
         }
-        const response = await this.client.request(reqObject);
-        return response;
+        return this.client.request(reqObject);
     }
     async *listFetch(reqObject, options) {
-        let running = true;
-        do {
-            const res = await this.fetch(reqObject, options);
-            if (res.headers.link) {
-                const pagingObject = this.getPagingObject(res);
-                if (pagingObject.last) {
-                    reqObject.url = pagingObject.next;
-                }
-                else {
-                    running = false;
-                }
-            }
-            else {
-                running = false;
-            }
+        let pageRequestObject = reqObject;
+        let currentPageUrl = pageRequestObject.url;
+        let pageRemaining = true;
+        while (pageRemaining) {
+            const res = await this.fetch(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;
-        } while (running);
+            // Failsafe incase the page does not change
+            if (currentPageUrl === pageRequestObject.url) {
+                throw new Error('Next page link did not change');
+            }
+            currentPageUrl = pageRequestObject.url;
+        }
     }
     async *listResponses(reqObject, options) {
         for await (const res of this.listFetch(reqObject, options)) {

package/dist/mjs/version.js

@@ -1 +1 @@
-export const Version = { version: '1.0.33' };
+export const Version = { version: '1.0.34' };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rotacloud",
-  "version": "1.0.33",
+  "version": "1.0.34",
   "description": "The RotaCloud SDK for the RotaCloud API",
   "engines": {
     "node": ">=14.17.0"

package/src/interfaces/query-params/users-query-params.interface.ts

@@ -8,7 +8,6 @@ export interface UsersQueryParams {
   search?: string;
   order?: string;
   period?: string;
-  location?: number;
   start_time?: number;
   end_time?: number;
   start_date?: string;

package/src/services/service.ts

@@ -65,7 +65,8 @@ export abstract class Service<ApiResponse = any> {
     return endpoint === '/leave_requests';
   }
 
-  private buildQueryStr(queryParams: Record<string, ParameterValue>) {
+  private buildQueryStr(queryParams: Record<string, ParameterValue> | undefined) {
+    if (!queryParams) return '';
     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)]));
@@ -77,20 +78,17 @@ export abstract class Service<ApiResponse = any> {
     return new URLSearchParams(reducedParams).toString();
   }
 
-  private getPagingObject(res): Partial<PagingObject> {
-    const links = res.headers.link.split(',');
-    const keyVal = {};
-
-    links.forEach((link) => {
-      const exp = link.split(';');
-      const key = exp[1].replace(' rel="', '').replace('"', '').trim();
-      const value = exp[0].replace('<', '').replace('>', '').trim();
-      keyVal[key] = value;
-    });
-    return keyVal;
+  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;
   }
 
-  public async fetch<T = ApiResponse>(httpOptions: AxiosRequestConfig, options?: Options): Promise<AxiosResponse<T>> {
+  public fetch<T = ApiResponse>(httpOptions: AxiosRequestConfig, options?: Options): Promise<AxiosResponse<T>> {
     const headers: AxiosRequestHeaders = {
       Authorization: `Bearer ${RotaCloud.config.apiKey}`,
       'SDK-Version': Version.version,
@@ -112,9 +110,7 @@ export abstract class Service<ApiResponse = any> {
         limit: options?.limit,
         ...httpOptions?.params,
       },
-      paramsSerializer: (params) => {
-        return params ? this.buildQueryStr(params) : '';
-      },
+      paramsSerializer: this.buildQueryStr,
     };
 
     if (RotaCloud.config.retry) {
@@ -134,38 +130,40 @@ export abstract class Service<ApiResponse = any> {
       });
     }
 
-    const response = await this.client.request<T>(reqObject);
-    return response;
+    return this.client.request<T>(reqObject);
   }
 
   private async *listFetch<T = ApiResponse>(
     reqObject: AxiosRequestConfig<T[]>,
     options?: Options
   ): AsyncGenerator<AxiosResponse<T[], any>> {
-    let running = true;
-    do {
-      const res = await this.fetch<T[]>(reqObject, options);
-      if (res.headers.link) {
-        const pagingObject = this.getPagingObject(res);
-        if (pagingObject.last) {
-          reqObject.url = pagingObject.next;
-        } else {
-          running = false;
-        }
-      } else {
-        running = false;
-      }
+    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;
-    } while (running);
+
+      // Failsafe incase the page does not change
+      if (currentPageUrl === pageRequestObject.url) {
+        throw new Error('Next page link did not change');
+      }
+      currentPageUrl = pageRequestObject.url;
+    }
   }
 
-  private async *listResponses<T = ApiResponse>(reqObject, options?: Options) {
+  private async *listResponses<T = ApiResponse>(reqObject: AxiosRequestConfig<T[]>, options?: Options) {
     for await (const res of this.listFetch<T>(reqObject, options)) {
       yield* res.data;
     }
   }
 
-  public iterator<T = ApiResponse>(reqObject, options?: Options) {
+  public iterator<T = ApiResponse>(reqObject: AxiosRequestConfig<T[]>, options?: Options) {
     const iterator = this.listResponses<T>(reqObject, options);
     return {
       [Symbol.asyncIterator]() {

package/src/version.ts

@@ -1 +1 @@
-export const Version = { version: '1.0.33' };
+export const Version = { version: '1.0.34' };