@markwharton/eh-payroll 2.7.1 → 3.0.0

package/README.md

@@ -84,6 +84,7 @@ All methods return `Result<T>` — see [api-core Result Pattern](../../README.md
 | `validateApiKey()` | — | `Result<void>` |
 | `getEmployees(options?)` | `EHEmployeeOptions?` | `Result<EHAuEmployee[]>` |
 | `getEmployee(employeeId)` | `number` | `Result<EHAuEmployee>` |
+| `getEmployeeImage(employeeId)` | `number` | `Result<EHEmployeeImage>` |
 | `getStandardHours(employeeId)` | `number` | `Result<EHStandardHours>` |
 | `getLocations()` | — | `Result<EHLocation[]>` |
 | `getEmployeeGroups()` | — | `Result<EHEmployeeGroup[]>` |
@@ -115,6 +116,8 @@ Returns leave requests with all filters applied server-side. The business-level
 | `employeeId` | `number` | Filter by employee ID |
 | `leaveCategoryId` | `number` | Filter by leave category ID |
 | `locationId` | `number` | Filter by location ID |
+| `groupBy` | `'Employee' \| 'LeaveType'` | Group results by employee or leave type |
+| `restrictOverlappingLeave` | `boolean` | Restrict results to leave overlapping the date range |
 
 ### `getEmployeeLeaveRequests()`
 

package/dist/client.d.ts

@@ -6,8 +6,8 @@
  *
  * @see https://api.keypay.com.au/
  */
-import type { EHConfig, EHLeaveRequest, EHLeaveRequestOptions, EHEmployeeLeaveRequestOptions, EHEmployeeOptions, EHStandardHours, EHLocation, EHEmployeeGroup, EHRosterShift, EHRosterShiftOptions, EHKiosk, EHKioskEmployee, EHKioskStaffOptions } from './types.js';
-import type { EHAuEmployee } from './employee-types.generated.js';
+import type { EHConfig, EHLeaveRequest, EHLeaveRequestOptions, EHEmployeeLeaveRequestOptions, EHEmployeeOptions, EHStandardHours, EHLocation, EHEmployeeGroup, EHRosterShift, EHRosterShiftOptions, EHKiosk, EHKioskEmployee, EHKioskStaffOptions, EHEmployeeImage } from './types.js';
+import type { EHEmployee } from './employee-types.generated.js';
 import type { Result } from '@markwharton/api-core';
 /**
  * Employment Hero Payroll API Client
@@ -112,11 +112,19 @@ export declare class EHClient {
     /**
      * Get all employees
      */
-    getEmployees(options?: EHEmployeeOptions): Promise<Result<EHAuEmployee[]>>;
+    getEmployees(options?: EHEmployeeOptions): Promise<Result<EHEmployee[]>>;
     /**
      * Get a single employee by ID
      */
-    getEmployee(employeeId: number): Promise<Result<EHAuEmployee>>;
+    getEmployee(employeeId: number): Promise<Result<EHEmployee>>;
+    /**
+     * Get employee profile image
+     *
+     * Returns binary image data. Not cached (large binary blobs).
+     *
+     * @see https://api.keypay.com.au/australia/reference/employee/au-employee--get-employee-profile-image.html
+     */
+    getEmployeeImage(employeeId: number): Promise<Result<EHEmployeeImage>>;
     /**
      * Get standard hours for an employee (includes FTE value)
      */

package/dist/client.js

@@ -235,6 +235,10 @@ export class EHClient {
             parts.push(`lcid:${options.leaveCategoryId}`);
         if (options?.locationId != null)
             parts.push(`lid:${options.locationId}`);
+        if (options?.groupBy)
+            parts.push(`gb:${options.groupBy}`);
+        if (options?.restrictOverlappingLeave)
+            parts.push('rol');
         const cacheKey = parts.join(':');
         return this.cached(cacheKey, this.cacheTtl.leaveRequestsTtl, async () => {
             const params = new URLSearchParams();
@@ -250,6 +254,10 @@ export class EHClient {
                 params.set('LeaveCategoryId', String(options.leaveCategoryId));
             if (options?.locationId != null)
                 params.set('LocationId', String(options.locationId));
+            if (options?.groupBy)
+                params.set('GroupBy', options.groupBy);
+            if (options?.restrictOverlappingLeave)
+                params.set('RestrictOverlappingLeave', 'true');
             const url = this.businessUrl(ENTITIES.EHLeaveRequest.path, params);
             return this.fetchAndParse(url, async (r) => {
                 return (await r.json())
@@ -328,6 +336,20 @@ export class EHClient {
             });
         }, this.restrictedPersistOpt);
     }
+    /**
+     * Get employee profile image
+     *
+     * Returns binary image data. Not cached (large binary blobs).
+     *
+     * @see https://api.keypay.com.au/australia/reference/employee/au-employee--get-employee-profile-image.html
+     */
+    async getEmployeeImage(employeeId) {
+        const url = this.businessUrl(`employee/${employeeId}/image`);
+        return this.fetchAndParse(url, async (r) => ({
+            data: await r.arrayBuffer(),
+            contentType: r.headers.get('content-type') || 'application/octet-stream',
+        }));
+    }
     // ============================================================================
     // Standard Hours
     // ============================================================================

package/dist/employee-types.generated.d.ts

@@ -79,7 +79,7 @@ export interface EHEmployeeCommon {
     workTypes: string | null;
 }
 /** AU region employee (70 region-specific fields) */
-export interface EHAuEmployee extends EHEmployeeCommon {
+export interface EHEmployee extends EHEmployeeCommon {
     australianResident: boolean;
     automaticallyApplyPublicHolidayNotWorkedEarningsLines: boolean;
     awardId: number | null;

package/dist/index.d.ts

@@ -20,13 +20,12 @@
  * ```
  */
 export { EHClient } from './client.js';
-export type { EHConfig, EHCacheConfig, EHRetryConfig, EHLeaveRequest, EHEmployeeLeaveRequest, EHLeaveRequestOptions, EHEmployeeLeaveRequestOptions, EHLeaveRequestStatus, EHEmployee, EHEmployeeOptions, EHStandardHours, EHLocation, EHEmployeeGroup, EHRosterShift, EHRosterShiftOptions, EHAttendanceStatus, EHKiosk, EHKioskEmployee, EHKioskStaffOptions, } from './types.js';
-export { AU_EMPLOYEE_FIELDS, LEAVE_REQUEST_FIELDS, LOCATION_FIELDS, EMPLOYEE_GROUP_FIELDS, ROSTER_SHIFT_FIELDS, KIOSK_FIELDS, KIOSK_EMPLOYEE_FIELDS, ENTITIES, } from './types.js';
+export type { EHConfig, EHCacheConfig, EHRetryConfig, EHLeaveRequest, EHLeaveRequestOptions, EHEmployeeLeaveRequestOptions, EHLeaveRequestStatus, EHEmployee, EHEmployeeOptions, EHStandardHours, EHLocation, EHEmployeeGroup, EHRosterShift, EHRosterShiftOptions, EHAttendanceStatus, EHKiosk, EHKioskEmployee, EHKioskStaffOptions, EHEmployeeImage, } from './types.js';
+export { EMPLOYEE_FIELDS, LEAVE_REQUEST_FIELDS, LOCATION_FIELDS, EMPLOYEE_GROUP_FIELDS, ROSTER_SHIFT_FIELDS, KIOSK_FIELDS, KIOSK_EMPLOYEE_FIELDS, ENTITIES, } from './types.js';
 export type { AccessTier } from './types.js';
 export { METHOD_TIERS } from './types.js';
-export type { EHAuEmployee } from './employee-types.generated.js';
 export { buildBasicAuthHeader } from './utils.js';
-export { ok, err, getErrorMessage, pickFields, RateLimiter, TTLCache, MemoryCacheStore, LayeredCache } from '@markwharton/api-core';
+export { ok, err, getErrorMessage, pickFields, normalizeEnum, RateLimiter, TTLCache, MemoryCacheStore, LayeredCache } from '@markwharton/api-core';
 export type { Result, RetryConfig, OnRequestCallback, ClientConfig, Cache, CacheStore, CacheGetOptions } from '@markwharton/api-core';
 export { EH_API_BASE, EH_REGION_URLS } from './constants.js';
 export type { EHRegion } from './constants.js';

package/dist/index.js

@@ -22,12 +22,12 @@
 // Main client
 export { EHClient } from './client.js';
 // Field definitions (for pickFields)
-export { AU_EMPLOYEE_FIELDS, LEAVE_REQUEST_FIELDS, LOCATION_FIELDS, EMPLOYEE_GROUP_FIELDS, ROSTER_SHIFT_FIELDS, KIOSK_FIELDS, KIOSK_EMPLOYEE_FIELDS, ENTITIES, } from './types.js';
+export { EMPLOYEE_FIELDS, LEAVE_REQUEST_FIELDS, LOCATION_FIELDS, EMPLOYEE_GROUP_FIELDS, ROSTER_SHIFT_FIELDS, KIOSK_FIELDS, KIOSK_EMPLOYEE_FIELDS, ENTITIES, } from './types.js';
 export { METHOD_TIERS } from './types.js';
 // Utilities
 export { buildBasicAuthHeader } from './utils.js';
 // Re-exported from @markwharton/api-core
-export { ok, err, getErrorMessage, pickFields, RateLimiter, TTLCache, MemoryCacheStore, LayeredCache } from '@markwharton/api-core';
+export { ok, err, getErrorMessage, pickFields, normalizeEnum, RateLimiter, TTLCache, MemoryCacheStore, LayeredCache } from '@markwharton/api-core';
 // Constants
 export { EH_API_BASE, EH_REGION_URLS } from './constants.js';
 // Errors

package/dist/types.d.ts

@@ -53,11 +53,10 @@ export interface EHConfig extends ClientConfig {
  * Employee from unstructured endpoint
  *
  * Region-specific types are generated from Swagger specs.
- * EHEmployee is an alias for EHAuEmployee for backward compatibility.
  *
  * @see employee-types.generated.ts
  */
-export type { EHAuEmployee as EHEmployee } from './employee-types.generated.js';
+export type { EHEmployee } from './employee-types.generated.js';
 /**
  * Standard hours for an employee
  *
@@ -204,8 +203,17 @@ export interface EHLeaveRequest {
     /** Status: Approved, Pending, Rejected, Cancelled */
     status: string;
 }
-/** Employee-scoped leave request (same shape, different API operation). */
-export interface EHEmployeeLeaveRequest extends EHLeaveRequest {
+/**
+ * Employee profile image
+ *
+ * From GET /business/{id}/employee/{eid}/image
+ * Returns binary data with content type.
+ */
+export interface EHEmployeeImage {
+    /** Image data as ArrayBuffer */
+    data: ArrayBuffer;
+    /** Content type from response header (e.g., 'image/png') */
+    contentType: string;
 }
 /** Leave request status values */
 export type EHLeaveRequestStatus = 'Approved' | 'Pending' | 'Rejected' | 'Cancelled';
@@ -227,6 +235,10 @@ export interface EHLeaveRequestOptions {
     leaveCategoryId?: number;
     /** Filter by location ID (→ API LocationId) */
     locationId?: number;
+    /** Group results by 'Employee' or 'LeaveType' (→ API GroupBy) */
+    groupBy?: 'Employee' | 'LeaveType';
+    /** Restrict results to leave overlapping the date range (→ API RestrictOverlappingLeave) */
+    restrictOverlappingLeave?: boolean;
 }
 /**
  * Options for getEmployeeLeaveRequests
@@ -405,8 +417,8 @@ export declare const ROSTER_SHIFT_FIELDS: {
     readonly published: true;
     readonly accepted: true;
 };
-/** Fields for EHAuEmployee — set false to exclude from API responses */
-export declare const AU_EMPLOYEE_FIELDS: {
+/** Fields for EHEmployee — set false to exclude from API responses */
+export declare const EMPLOYEE_FIELDS: {
     readonly id: true;
     readonly externalId: true;
     readonly firstName: true;

package/dist/types.js

@@ -41,8 +41,8 @@ export const ROSTER_SHIFT_FIELDS = {
     workTypeId: true, workTypeName: true, startTime: true, endTime: true,
     notes: true, published: true, accepted: true,
 };
-/** Fields for EHAuEmployee — set false to exclude from API responses */
-export const AU_EMPLOYEE_FIELDS = {
+/** Fields for EHEmployee — set false to exclude from API responses */
+export const EMPLOYEE_FIELDS = {
     // Identity
     id: true, externalId: true, firstName: true, surname: true, status: true,
     // Dates
@@ -111,7 +111,7 @@ export const AU_EMPLOYEE_FIELDS = {
 };
 /** Entity registry — maps interface names to field specs and API path segments. */
 export const ENTITIES = {
-    EHAuEmployee: { fields: AU_EMPLOYEE_FIELDS, path: 'employee/unstructured', apiRef: 'employee/au-employee--get-employees', apiRefById: 'employee/au-employee--get-employee-by-id' },
+    EHAuEmployee: { fields: EMPLOYEE_FIELDS, path: 'employee/unstructured', apiRef: 'employee/au-employee--get-employees', apiRefById: 'employee/au-employee--get-employee-by-id' },
     EHLeaveRequest: { fields: LEAVE_REQUEST_FIELDS, path: 'leaverequest', apiRef: 'leave-requests/au-business-hours-leave-request--list-leave-requests' },
     EHEmployeeLeaveRequest: { fields: LEAVE_REQUEST_FIELDS, path: 'employee/{employeeId}/leaverequest', apiRef: 'leave-requests/au-hours-leave-request--get-leave-requests' },
     EHLocation: { fields: LOCATION_FIELDS, path: 'location', apiRef: 'location/au-location--get-locations' },
@@ -138,5 +138,6 @@ export const METHOD_TIERS = {
     getLeaveRequests: 'restricted',
     getEmployeeLeaveRequests: 'restricted',
     getEmployee: 'restricted',
+    getEmployeeImage: 'restricted',
     getStandardHours: 'restricted',
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markwharton/eh-payroll",
-  "version": "2.7.1",
+  "version": "3.0.0",
   "description": "Employment Hero Payroll API client",
   "type": "module",
   "main": "dist/index.js",
@@ -16,7 +16,7 @@
     "clean": "rm -rf dist"
   },
   "dependencies": {
-    "@markwharton/api-core": "^1.6.0"
+    "@markwharton/api-core": "^1.6.1"
   },
   "devDependencies": {
     "@types/node": "^20.10.0",