rotacloud 1.4.9 → 1.5.1

package/dist/cjs/interfaces/drop-request.interface.d.ts

@@ -0,0 +1,13 @@
+export type RequestStatus = 'expired' | 'shift_changed' | 'approved' | 'denied' | 'requested';
+export interface ShiftDropRequest {
+    id: number;
+    deleted: boolean;
+    status: RequestStatus;
+    requested_at: number;
+    shift: number;
+    user: number;
+    user_message: string;
+    admin?: number;
+    admin_message?: string;
+    replied_at?: number;
+}

package/dist/cjs/interfaces/drop-request.interface.js

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

package/dist/cjs/interfaces/swap-request.interface.d.ts

@@ -0,0 +1,16 @@
+export type RequestStatus = 'expired' | 'shift_changed' | 'approved' | 'denied' | 'requested';
+export interface ShiftSwapRequest {
+    id: number;
+    deleted: boolean;
+    status: RequestStatus;
+    requested_at: number;
+    old_user: number;
+    new_user: number;
+    admin: number | null;
+    user_approved: boolean | null;
+    user_replied_at: number | null;
+    admin_approved: boolean | null;
+    admin_replied_at: number | null;
+    shift: number;
+    swapped_shift: number;
+}

package/dist/cjs/interfaces/swap-request.interface.js

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

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

@@ -1,12 +1,20 @@
 import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
-import { SDKConfig } from "../interfaces";
+import { SDKConfig } from '../interfaces';
 export type RequirementsOf<T, K extends keyof T> = Required<Pick<T, K>> & Partial<T>;
-export interface Options {
+export type Options = {
     rawResponse?: boolean;
+    maxResults?: number;
+    limit?: never;
+    offset?: number;
+    dryRun?: boolean;
+} | {
+    rawResponse?: boolean;
+    maxResults?: never;
+    /** @deprecated use `maxResults` instead */
     limit?: number;
     offset?: number;
     dryRun?: boolean;
-}
+};
 export type OptionsExtended<T = unknown> = Options & {
     fields?: (keyof T)[];
 };

package/dist/cjs/services/service.js

@@ -42,7 +42,8 @@ class Service {
         return endpoint === '/leave_requests';
     }
     buildQueryParams(options, extraParams) {
-        const queryParams = Object.assign(Object.assign({ fields: options === null || options === void 0 ? void 0 : options.fields, limit: options === null || options === void 0 ? void 0 : options.limit, offset: options === null || options === void 0 ? void 0 : options.offset, dry_run: options === null || options === void 0 ? void 0 : options.dryRun }, extraParams), { 
+        var _a;
+        const queryParams = Object.assign(Object.assign({ fields: options === null || options === void 0 ? void 0 : options.fields, limit: (_a = options === null || options === void 0 ? void 0 : options.maxResults) !== null && _a !== void 0 ? _a : options === null || options === void 0 ? void 0 : options.limit, offset: options === null || options === void 0 ? void 0 : options.offset, dry_run: options === null || options === void 0 ? void 0 : options.dryRun }, extraParams), { 
             // NOTE: Should not overridable so must come after spread of params
             exclude_link_header: true });
         const reducedParams = Object.entries(queryParams !== null && queryParams !== void 0 ? queryParams : {}).reduce((params, [key, val]) => {
@@ -96,21 +97,45 @@ class Service {
     }
     listResponses(reqConfig, options) {
         return __asyncGenerator(this, arguments, function* listResponses_1() {
-            var _a, e_1, _b, _c;
+            var _a, e_1, _b, _c, _d, e_2, _e, _f;
+            if (!(options === null || options === void 0 ? void 0 : options.maxResults)) {
+                try {
+                    for (var _g = true, _h = __asyncValues(this.fetchPages(reqConfig, options)), _j; _j = yield __await(_h.next()), _a = _j.done, !_a; _g = true) {
+                        _c = _j.value;
+                        _g = false;
+                        const res = _c;
+                        yield __await(yield* __asyncDelegator(__asyncValues(res.data)));
+                    }
+                }
+                catch (e_1_1) { e_1 = { error: e_1_1 }; }
+                finally {
+                    try {
+                        if (!_g && !_a && (_b = _h.return)) yield __await(_b.call(_h));
+                    }
+                    finally { if (e_1) throw e_1.error; }
+                }
+                return yield __await(void 0);
+            }
+            let entityCount = 0;
             try {
-                for (var _d = true, _e = __asyncValues(this.fetchPages(reqConfig, options)), _f; _f = yield __await(_e.next()), _a = _f.done, !_a; _d = true) {
-                    _c = _f.value;
-                    _d = false;
-                    const res = _c;
-                    yield __await(yield* __asyncDelegator(__asyncValues(res.data)));
+                for (var _k = true, _l = __asyncValues(this.fetchPages(reqConfig, options)), _m; _m = yield __await(_l.next()), _d = _m.done, !_d; _k = true) {
+                    _f = _m.value;
+                    _k = false;
+                    const res = _f;
+                    for (const entity of res.data) {
+                        yield yield __await(entity);
+                        entityCount += 1;
+                        if (entityCount >= options.maxResults)
+                            return yield __await(void 0);
+                    }
                 }
             }
-            catch (e_1_1) { e_1 = { error: e_1_1 }; }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
             finally {
                 try {
-                    if (!_d && !_a && (_b = _e.return)) yield __await(_b.call(_e));
+                    if (!_k && !_d && (_e = _l.return)) yield __await(_e.call(_l));
                 }
-                finally { if (e_1) throw e_1.error; }
+                finally { if (e_2) throw e_2.error; }
             }
         });
     }

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

@@ -1,7 +1,9 @@
 import { AxiosResponse } from 'axios';
 import { Shift } from '../interfaces/index.js';
 import { Options, OptionsExtended, RequirementsOf, Service } from './index.js';
+import { ShiftDropRequest } from '../interfaces/drop-request.interface.js';
 import { ShiftsQueryParams } from '../interfaces/query-params/shifts-query-params.interface.js';
+import { ShiftSwapRequest } from '../interfaces/swap-request.interface.js';
 type RequiredProps = 'end_time' | 'start_time' | 'location';
 export declare class ShiftsService extends Service<Shift> {
     private apiPath;
@@ -49,7 +51,6 @@ export declare class ShiftsService extends Service<Shift> {
             error: string;
         }[];
     }>;
-    update(shift: RequirementsOf<Shift, 'id'>, options: Options): Promise<Shift>;
     update(shifts: RequirementsOf<Shift, 'id'>[], options: {
         rawResponse: true;
     } & Options): Promise<AxiosResponse<{
@@ -96,5 +97,24 @@ export declare class ShiftsService extends Service<Shift> {
     unpublish(data: {
         shifts: number[];
     }, options: Options): Promise<number>;
+    updateSwap(data: ShiftSwapRequest): Promise<ShiftSwapRequest>;
+    updateSwap(data: ShiftSwapRequest, options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<ShiftSwapRequest>>;
+    updateSwap(data: ShiftSwapRequest, options: Options): Promise<ShiftSwapRequest>;
+    updateDrop(data: {
+        request: RequirementsOf<ShiftDropRequest, 'id' | 'user_message'>;
+        approved: boolean;
+    }): Promise<ShiftDropRequest>;
+    updateDrop(data: {
+        request: RequirementsOf<ShiftDropRequest, 'id' | 'user_message'>;
+        approved: boolean;
+    }, options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<ShiftDropRequest>>;
+    updateDrop(data: {
+        request: RequirementsOf<ShiftDropRequest, 'id' | 'user_message'>;
+        approved: boolean;
+    }, options: Options): Promise<ShiftDropRequest>;
 }
 export {};

package/dist/cjs/services/shifts.service.js

@@ -136,5 +136,19 @@ class ShiftsService extends index_js_1.Service {
             .fetch({ url: '/shifts_published', data, method: 'DELETE' }, options)
             .then((res) => ((options === null || options === void 0 ? void 0 : options.rawResponse) ? res : res.status));
     }
+    updateSwap(data, options) {
+        return super
+            .fetch({ url: `/swap_requests/${data.id}`, data, method: 'POST' }, options)
+            .then((res) => ((options === null || options === void 0 ? void 0 : options.rawResponse) ? res : res.data));
+    }
+    updateDrop(data, options) {
+        return super
+            .fetch({
+            url: `/unavailability_requests/${data.request.id}/${data.approved ? 'approve' : 'deny'}`,
+            data: { message: data.request.user_message },
+            method: 'POST',
+        }, options)
+            .then((res) => ((options === null || options === void 0 ? void 0 : options.rawResponse) ? res : res.data));
+    }
 }
 exports.ShiftsService = ShiftsService;

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.4.9' };
+exports.Version = { version: '1.5.1' };

package/dist/mjs/interfaces/drop-request.interface.d.ts

@@ -0,0 +1,13 @@
+export type RequestStatus = 'expired' | 'shift_changed' | 'approved' | 'denied' | 'requested';
+export interface ShiftDropRequest {
+    id: number;
+    deleted: boolean;
+    status: RequestStatus;
+    requested_at: number;
+    shift: number;
+    user: number;
+    user_message: string;
+    admin?: number;
+    admin_message?: string;
+    replied_at?: number;
+}

package/dist/mjs/interfaces/drop-request.interface.js

@@ -0,0 +1 @@
+export {};

package/dist/mjs/interfaces/swap-request.interface.d.ts

@@ -0,0 +1,16 @@
+export type RequestStatus = 'expired' | 'shift_changed' | 'approved' | 'denied' | 'requested';
+export interface ShiftSwapRequest {
+    id: number;
+    deleted: boolean;
+    status: RequestStatus;
+    requested_at: number;
+    old_user: number;
+    new_user: number;
+    admin: number | null;
+    user_approved: boolean | null;
+    user_replied_at: number | null;
+    admin_approved: boolean | null;
+    admin_replied_at: number | null;
+    shift: number;
+    swapped_shift: number;
+}

package/dist/mjs/interfaces/swap-request.interface.js

@@ -0,0 +1 @@
+export {};

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

@@ -1,12 +1,20 @@
 import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
-import { SDKConfig } from "../interfaces";
+import { SDKConfig } from '../interfaces';
 export type RequirementsOf<T, K extends keyof T> = Required<Pick<T, K>> & Partial<T>;
-export interface Options {
+export type Options = {
     rawResponse?: boolean;
+    maxResults?: number;
+    limit?: never;
+    offset?: number;
+    dryRun?: boolean;
+} | {
+    rawResponse?: boolean;
+    maxResults?: never;
+    /** @deprecated use `maxResults` instead */
     limit?: number;
     offset?: number;
     dryRun?: boolean;
-}
+};
 export type OptionsExtended<T = unknown> = Options & {
     fields?: (keyof T)[];
 };

package/dist/mjs/services/service.js

@@ -16,7 +16,7 @@ export class Service {
     buildQueryParams(options, extraParams) {
         const queryParams = {
             fields: options?.fields,
-            limit: options?.limit,
+            limit: options?.maxResults ?? options?.limit,
             offset: options?.offset,
             dry_run: options?.dryRun,
             ...extraParams,
@@ -76,8 +76,20 @@ export class Service {
         }
     }
     async *listResponses(reqConfig, options) {
+        if (!options?.maxResults) {
+            for await (const res of this.fetchPages(reqConfig, options)) {
+                yield* res.data;
+            }
+            return;
+        }
+        let entityCount = 0;
         for await (const res of this.fetchPages(reqConfig, options)) {
-            yield* res.data;
+            for (const entity of res.data) {
+                yield entity;
+                entityCount += 1;
+                if (entityCount >= options.maxResults)
+                    return;
+            }
         }
     }
     iterator(reqConfig, options) {

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

@@ -1,7 +1,9 @@
 import { AxiosResponse } from 'axios';
 import { Shift } from '../interfaces/index.js';
 import { Options, OptionsExtended, RequirementsOf, Service } from './index.js';
+import { ShiftDropRequest } from '../interfaces/drop-request.interface.js';
 import { ShiftsQueryParams } from '../interfaces/query-params/shifts-query-params.interface.js';
+import { ShiftSwapRequest } from '../interfaces/swap-request.interface.js';
 type RequiredProps = 'end_time' | 'start_time' | 'location';
 export declare class ShiftsService extends Service<Shift> {
     private apiPath;
@@ -49,7 +51,6 @@ export declare class ShiftsService extends Service<Shift> {
             error: string;
         }[];
     }>;
-    update(shift: RequirementsOf<Shift, 'id'>, options: Options): Promise<Shift>;
     update(shifts: RequirementsOf<Shift, 'id'>[], options: {
         rawResponse: true;
     } & Options): Promise<AxiosResponse<{
@@ -96,5 +97,24 @@ export declare class ShiftsService extends Service<Shift> {
     unpublish(data: {
         shifts: number[];
     }, options: Options): Promise<number>;
+    updateSwap(data: ShiftSwapRequest): Promise<ShiftSwapRequest>;
+    updateSwap(data: ShiftSwapRequest, options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<ShiftSwapRequest>>;
+    updateSwap(data: ShiftSwapRequest, options: Options): Promise<ShiftSwapRequest>;
+    updateDrop(data: {
+        request: RequirementsOf<ShiftDropRequest, 'id' | 'user_message'>;
+        approved: boolean;
+    }): Promise<ShiftDropRequest>;
+    updateDrop(data: {
+        request: RequirementsOf<ShiftDropRequest, 'id' | 'user_message'>;
+        approved: boolean;
+    }, options: {
+        rawResponse: true;
+    } & Options): Promise<AxiosResponse<ShiftDropRequest>>;
+    updateDrop(data: {
+        request: RequirementsOf<ShiftDropRequest, 'id' | 'user_message'>;
+        approved: boolean;
+    }, options: Options): Promise<ShiftDropRequest>;
 }
 export {};

package/dist/mjs/services/shifts.service.js

@@ -79,4 +79,18 @@ export class ShiftsService extends Service {
             .fetch({ url: '/shifts_published', data, method: 'DELETE' }, options)
             .then((res) => (options?.rawResponse ? res : res.status));
     }
+    updateSwap(data, options) {
+        return super
+            .fetch({ url: `/swap_requests/${data.id}`, data, method: 'POST' }, options)
+            .then((res) => (options?.rawResponse ? res : res.data));
+    }
+    updateDrop(data, options) {
+        return super
+            .fetch({
+            url: `/unavailability_requests/${data.request.id}/${data.approved ? 'approve' : 'deny'}`,
+            data: { message: data.request.user_message },
+            method: 'POST',
+        }, options)
+            .then((res) => (options?.rawResponse ? res : res.data));
+    }
 }

package/dist/mjs/version.js

@@ -1 +1 @@
-export const Version = { version: '1.4.9' };
+export const Version = { version: '1.5.1' };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rotacloud",
-  "version": "1.4.9",
+  "version": "1.5.1",
   "description": "The RotaCloud SDK for the RotaCloud API",
   "engines": {
     "node": ">=16.10.0"

package/src/interfaces/drop-request.interface.ts

@@ -0,0 +1,14 @@
+export type RequestStatus = 'expired' | 'shift_changed' | 'approved' | 'denied' | 'requested';
+
+export interface ShiftDropRequest {
+  id: number;
+  deleted: boolean;
+  status: RequestStatus;
+  requested_at: number;
+  shift: number;
+  user: number;
+  user_message: string;
+  admin?: number;
+  admin_message?: string;
+  replied_at?: number;
+}

package/src/interfaces/swap-request.interface.ts

@@ -0,0 +1,17 @@
+export type RequestStatus = 'expired' | 'shift_changed' | 'approved' | 'denied' | 'requested';
+
+export interface ShiftSwapRequest {
+  id: number;
+  deleted: boolean;
+  status: RequestStatus;
+  requested_at: number;
+  old_user: number;
+  new_user: number;
+  admin: number | null;
+  user_approved: boolean | null;
+  user_replied_at: number | null;
+  admin_approved: boolean | null;
+  admin_replied_at: number | null;
+  shift: number;
+  swapped_shift: number;
+}

package/src/services/service.ts

@@ -1,15 +1,25 @@
 import { AxiosInstance, AxiosRequestConfig, AxiosResponse } from 'axios';
 import { Version } from '../version.js';
-import { SDKConfig } from "../interfaces";
+import { SDKConfig } from '../interfaces';
 
 export type RequirementsOf<T, K extends keyof T> = Required<Pick<T, K>> & Partial<T>;
 
-export interface Options {
-  rawResponse?: boolean;
-  limit?: number;
-  offset?: number;
-  dryRun?: boolean;
-}
+export type Options =
+  | {
+      rawResponse?: boolean;
+      maxResults?: number;
+      limit?: never;
+      offset?: number;
+      dryRun?: boolean;
+    }
+  | {
+      rawResponse?: boolean;
+      maxResults?: never;
+      /** @deprecated use `maxResults` instead */
+      limit?: number;
+      offset?: number;
+      dryRun?: boolean;
+    };
 
 export type OptionsExtended<T = unknown> = Options & {
   fields?: (keyof T)[];
@@ -20,13 +30,13 @@ type ParameterValue = ParameterPrimitive | ParameterPrimitive[] | undefined;
 
 export abstract class Service<ApiResponse = any> {
   constructor(
-      protected client: AxiosInstance,
-      // opt to use options object here, so we could
-      // define the config property as a getter
-      // in RotaCloud class. With this change config in
-      // this class will always be up-to-date with
-      // RotaCloud client config
-      protected readonly options: { config: SDKConfig }
+    protected client: AxiosInstance,
+    // opt to use options object here, so we could
+    // define the config property as a getter
+    // in RotaCloud class. With this change config in
+    // this class will always be up-to-date with
+    // RotaCloud client config
+    protected readonly options: { config: SDKConfig },
   ) {}
 
   private isLeaveRequest(endpoint?: string): boolean {
@@ -39,7 +49,7 @@ export abstract class Service<ApiResponse = any> {
   ) {
     const queryParams: Record<string, ParameterValue> = {
       fields: options?.fields,
-      limit: options?.limit,
+      limit: options?.maxResults ?? options?.limit,
       offset: options?.offset,
       dry_run: options?.dryRun,
       ...extraParams,
@@ -132,8 +142,20 @@ export abstract class Service<ApiResponse = any> {
   }
 
   private async *listResponses<T = ApiResponse>(reqConfig: AxiosRequestConfig<T[]>, options?: Options) {
+    if (!options?.maxResults) {
+      for await (const res of this.fetchPages<T>(reqConfig, options)) {
+        yield* res.data;
+      }
+      return;
+    }
+
+    let entityCount = 0;
     for await (const res of this.fetchPages<T>(reqConfig, options)) {
-      yield* res.data;
+      for (const entity of res.data) {
+        yield entity;
+        entityCount += 1;
+        if (entityCount >= options.maxResults) return;
+      }
     }
   }
 

package/src/services/shifts.service.ts

@@ -2,7 +2,9 @@ import { AxiosRequestConfig, AxiosResponse } from 'axios';
 import { Shift } from '../interfaces/index.js';
 import { Options, OptionsExtended, RequirementsOf, Service } from './index.js';
 
+import { ShiftDropRequest } from '../interfaces/drop-request.interface.js';
 import { ShiftsQueryParams } from '../interfaces/query-params/shifts-query-params.interface.js';
+import { ShiftSwapRequest } from '../interfaces/swap-request.interface.js';
 
 type RequiredProps = 'end_time' | 'start_time' | 'location';
 
@@ -73,7 +75,6 @@ export class ShiftsService extends Service<Shift> {
   update(shift: RequirementsOf<Shift, 'id'>, options: { rawResponse: true } & Options): Promise<AxiosResponse<Shift>>;
   update(shift: RequirementsOf<Shift, 'id'>, options: Options): Promise<Shift>;
   update(shifts: RequirementsOf<Shift, 'id'>[]): Promise<{ success: Shift[]; failed: { id: number; error: string }[] }>;
-  update(shift: RequirementsOf<Shift, 'id'>, options: Options): Promise<Shift>;
   update(
     shifts: RequirementsOf<Shift, 'id'>[],
     options: { rawResponse: true } & Options,
@@ -135,7 +136,7 @@ export class ShiftsService extends Service<Shift> {
   acknowledge(shifts: number[], options: Options): Promise<number>;
   acknowledge(shifts: number[], options?: Options) {
     return super
-      .fetch<Shift>({ url: '/shifts_acknowledged', data: {shifts}, method: 'POST' }, options)
+      .fetch<Shift>({ url: '/shifts_acknowledged', data: { shifts }, method: 'POST' }, options)
       .then((res) => (options?.rawResponse ? res : res.status));
   }
 
@@ -156,4 +157,44 @@ export class ShiftsService extends Service<Shift> {
       .fetch<Shift>({ url: '/shifts_published', data, method: 'DELETE' }, options)
       .then((res) => (options?.rawResponse ? res : res.status));
   }
+
+  updateSwap(data: ShiftSwapRequest): Promise<ShiftSwapRequest>;
+  updateSwap(
+    data: ShiftSwapRequest,
+    options: { rawResponse: true } & Options,
+  ): Promise<AxiosResponse<ShiftSwapRequest>>;
+  updateSwap(data: ShiftSwapRequest, options: Options): Promise<ShiftSwapRequest>;
+  updateSwap(data: ShiftSwapRequest, options?: Options) {
+    return super
+      .fetch<Shift>({ url: `/swap_requests/${data.id}`, data, method: 'POST' }, options)
+      .then((res) => (options?.rawResponse ? res : res.data));
+  }
+
+  updateDrop(data: {
+    request: RequirementsOf<ShiftDropRequest, 'id' | 'user_message'>;
+    approved: boolean;
+  }): Promise<ShiftDropRequest>;
+  updateDrop(
+    data: { request: RequirementsOf<ShiftDropRequest, 'id' | 'user_message'>; approved: boolean },
+    options: { rawResponse: true } & Options,
+  ): Promise<AxiosResponse<ShiftDropRequest>>;
+  updateDrop(
+    data: { request: RequirementsOf<ShiftDropRequest, 'id' | 'user_message'>; approved: boolean },
+    options: Options,
+  ): Promise<ShiftDropRequest>;
+  updateDrop(
+    data: { request: RequirementsOf<ShiftDropRequest, 'id' | 'user_message'>; approved: boolean },
+    options?: Options,
+  ) {
+    return super
+      .fetch<Shift>(
+        {
+          url: `/unavailability_requests/${data.request.id}/${data.approved ? 'approve' : 'deny'}`,
+          data: { message: data.request.user_message },
+          method: 'POST',
+        },
+        options,
+      )
+      .then((res) => (options?.rawResponse ? res : res.data));
+  }
 }

package/src/version.ts

@@ -1 +1 @@
-export const Version = { version: '1.4.9' };
+export const Version = { version: '1.5.1' };