@markwharton/eh-payroll 1.1.1 → 1.2.0

package/README.md

@@ -29,10 +29,10 @@ const { employees } = await client.getEmployees();
 const { employees: filtered } = await client.getEmployees({ locationId: 5 });
 
 // Get roster shifts for a date range (auto-paginates)
-const { shifts } = await client.getRosterShifts('2026-02-03', '2026-02-09');
+const { rosterShifts } = await client.getRosterShifts('2026-02-03', '2026-02-09');
 
 // Get roster shifts with filters
-const { shifts: published } = await client.getRosterShifts('2026-02-03', '2026-02-09', {
+const { rosterShifts: published } = await client.getRosterShifts('2026-02-03', '2026-02-09', {
   employeeId: 42,
   shiftStatus: 'Published',
   selectAllRoles: true
@@ -42,7 +42,7 @@ const { shifts: published } = await client.getRosterShifts('2026-02-03', '2026-0
 const { staff } = await client.getKioskStaff(kioskId);
 
 // Get employee groups
-const { groups } = await client.getEmployeeGroups();
+const { employeeGroups } = await client.getEmployeeGroups();
 
 // Get standard hours for an employee (includes FTE value)
 const { standardHours } = await client.getStandardHours(employeeId);
@@ -66,15 +66,15 @@ All methods return `{ data?, error? }` result objects rather than throwing excep
 | `getEmployees(options?)` | `EHEmployeeOptions?` | `{ employees?, error? }` |
 | `getEmployee(employeeId)` | `number` | `{ employee?, error? }` |
 | `getStandardHours(employeeId)` | `number` | `{ standardHours?, error? }` |
-| `getEmployeeGroups()` | — | `{ groups?, error? }` |
-| `getRosterShifts(from, to, options?)` | `string, string, EHRosterShiftOptions?` | `{ shifts?, error? }` |
+| `getEmployeeGroups()` | — | `{ employeeGroups?, error? }` |
+| `getRosterShifts(from, to, options?)` | `string, string, EHRosterShiftOptions?` | `{ rosterShifts?, error? }` |
 | `getKioskStaff(kioskId, options?)` | `number, EHKioskStaffOptions?` | `{ staff?, error? }` |
 | `getReportFields()` | — | `{ fields?, error? }` |
 | `getEmployeeDetailsReport(options?)` | `EHEmployeeDetailsReportOptions?` | `{ records?, error? }` |
 
 ### `getRosterShifts()`
 
-Automatically paginates through all results (100 per page). Returns the complete set of shifts for the requested date range. All filter options are applied server-side, reducing the number of results and pages fetched.
+Automatically paginates through all results (100 per page). Returns the complete set of roster shifts for the requested date range. All filter options are applied server-side, reducing the number of results and pages fetched.
 
 ### Query Parameter Casing
 

package/dist/client.d.ts

@@ -83,7 +83,7 @@ export declare class EHClient {
      * Get all employee groups
      */
     getEmployeeGroups(): Promise<{
-        groups?: EHEmployeeGroup[];
+        employeeGroups?: EHEmployeeGroup[];
         error?: EHErrorInfo;
     }>;
     /**
@@ -94,7 +94,7 @@ export declare class EHClient {
      * @param options - Optional filters
      */
     getRosterShifts(fromDate: string, toDate: string, options?: EHRosterShiftOptions): Promise<{
-        shifts?: EHRosterShift[];
+        rosterShifts?: EHRosterShift[];
         error?: EHErrorInfo;
     }>;
     /**

package/dist/client.js

@@ -46,6 +46,7 @@ export class EHClient {
             groupsTtl: config.cache?.groupsTtl ?? 300000,
             standardHoursTtl: config.cache?.standardHoursTtl ?? 300000,
             rosterShiftsTtl: config.cache?.rosterShiftsTtl ?? 120000,
+            kioskStaffTtl: config.cache?.kioskStaffTtl ?? 60000,
             reportFieldsTtl: config.cache?.reportFieldsTtl ?? 600000,
         };
         // Initialize retry config with defaults if provided
@@ -234,7 +235,7 @@ export class EHClient {
      * Get all employee groups
      */
     async getEmployeeGroups() {
-        return this.cached('groups', this.cacheTtl.groupsTtl, async () => {
+        return this.cached('employeeGroups', this.cacheTtl.groupsTtl, async () => {
             const params = new URLSearchParams({
                 '$top': String(DEFAULT_PAGE_SIZE),
             });
@@ -257,7 +258,7 @@ export class EHClient {
                         break;
                     skip += DEFAULT_PAGE_SIZE;
                 }
-                return { groups: allGroups };
+                return { employeeGroups: allGroups };
             }
             catch (error) {
                 return { error: { message: getErrorMessage(error), statusCode: 0 } };
@@ -361,7 +362,7 @@ export class EHClient {
                         break;
                     currentPage++;
                 }
-                return { shifts: allShifts };
+                return { rosterShifts: allShifts };
             }
             catch (error) {
                 return { error: { message: getErrorMessage(error), statusCode: 0 } };
@@ -378,19 +379,24 @@ export class EHClient {
      * @param options - Optional query parameters
      */
     async getKioskStaff(kioskId, options) {
-        const params = new URLSearchParams();
-        if (options?.restrictCurrentShiftsToCurrentKioskLocation) {
-            params.set('restrictCurrentShiftsToCurrentKioskLocation', 'true');
-        }
-        const queryString = params.toString();
-        const url = queryString
-            ? `${this.baseUrl}/business/${this.businessId}/kiosk/${kioskId}/staff?${queryString}`
-            : `${this.baseUrl}/business/${this.businessId}/kiosk/${kioskId}/staff`;
-        const { data, error } = await this.fetchAndParse(url, async (r) => {
-            return (await r.json())
-                .map(item => pickFields(item, KIOSK_EMPLOYEE_FIELDS));
+        const cacheKey = options?.restrictCurrentShiftsToCurrentKioskLocation
+            ? `kiosk:${kioskId}:rcs`
+            : `kiosk:${kioskId}`;
+        return this.cached(cacheKey, this.cacheTtl.kioskStaffTtl, async () => {
+            const params = new URLSearchParams();
+            if (options?.restrictCurrentShiftsToCurrentKioskLocation) {
+                params.set('restrictCurrentShiftsToCurrentKioskLocation', 'true');
+            }
+            const queryString = params.toString();
+            const url = queryString
+                ? `${this.baseUrl}/business/${this.businessId}/kiosk/${kioskId}/staff?${queryString}`
+                : `${this.baseUrl}/business/${this.businessId}/kiosk/${kioskId}/staff`;
+            const { data, error } = await this.fetchAndParse(url, async (r) => {
+                return (await r.json())
+                    .map(item => pickFields(item, KIOSK_EMPLOYEE_FIELDS));
+            });
+            return error ? { error } : { staff: data };
         });
-        return error ? { error } : { staff: data };
     }
     // ============================================================================
     // Employee Details Report

package/dist/index.d.ts

@@ -16,7 +16,7 @@
  * const { employees } = await client.getEmployees();
  *
  * // Get roster shifts
- * const { shifts } = await client.getRosterShifts('2026-02-03', '2026-02-09');
+ * const { rosterShifts } = await client.getRosterShifts('2026-02-03', '2026-02-09');
  * ```
  */
 export { EHClient } from './client.js';

package/dist/index.js

@@ -16,7 +16,7 @@
  * const { employees } = await client.getEmployees();
  *
  * // Get roster shifts
- * const { shifts } = await client.getRosterShifts('2026-02-03', '2026-02-09');
+ * const { rosterShifts } = await client.getRosterShifts('2026-02-03', '2026-02-09');
  * ```
  */
 // Main client

package/dist/types.d.ts

@@ -20,6 +20,8 @@ export interface EHCacheConfig {
     standardHoursTtl?: number;
     /** TTL for roster shifts (default: 120000 = 2 min) */
     rosterShiftsTtl?: number;
+    /** TTL for kiosk staff (default: 60000 = 1 min) */
+    kioskStaffTtl?: number;
     /** TTL for report fields (default: 600000 = 10 min) */
     reportFieldsTtl?: number;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markwharton/eh-payroll",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "Employment Hero Payroll API client",
   "type": "module",
   "main": "dist/index.js",