@markwharton/eh-payroll 2.1.0 → 2.1.1

package/README.md

@@ -139,6 +139,8 @@ const client = new EHClient({
 });
 ```
 
+`EHConfig` extends `ClientConfig` from api-core, which provides the `baseUrl`, `onRequest`, and `retry` fields. `apiKey`, `businessId`, `region`, `cache`, and `rateLimitPerSecond` are EH-specific.
+
 ### Cache TTLs
 
 | Cache Key | Default TTL |
@@ -154,7 +156,7 @@ const client = new EHClient({
 
 ### Rate Limiting
 
-The client enforces a sliding-window rate limit of 5 requests per second (the [API limit](https://api.keypay.com.au/australia/guides/Usage.html)). All outbound requests pass through the rate limiter automatically. Set `rateLimitPerSecond: 0` in config to disable (useful for tests).
+The client enforces a sliding-window rate limit of 5 requests per second (the [API limit](https://api.keypay.com.au/australia/guides/Usage.html)). All outbound requests pass through the rate limiter automatically. Set `rateLimitPerSecond: 0` in config to disable (useful for tests). The `RateLimiter` class is provided by api-core and operates per-instance (see Known Limitations in the root README).
 
 ### Retry
 

package/dist/index.d.ts

@@ -25,7 +25,7 @@ export { AU_EMPLOYEE_OPERATIONAL_FIELDS, AU_EMPLOYEE_PII_FIELDS, AU_EMPLOYEE_FIE
 export type { EHAuEmployee } from './employee-types.generated.js';
 export { buildBasicAuthHeader } from './utils.js';
 export { ok, err, getErrorMessage, pickFields, RateLimiter } from '@markwharton/api-core';
-export type { Result, RetryConfig, OnRequestCallback, BaseClientConfig } from '@markwharton/api-core';
+export type { Result, RetryConfig, OnRequestCallback, ClientConfig } from '@markwharton/api-core';
 export { EH_API_BASE, EH_REGION_URLS } from './constants.js';
 export type { EHRegion } from './constants.js';
 export { EHError, parseEHErrorResponse } from './errors.js';

package/dist/types.d.ts

@@ -5,7 +5,7 @@
  * Based on the API reference and KeyPay .NET SDK models.
  */
 import type { EHRegion } from './constants.js';
-import type { RetryConfig, BaseClientConfig } from '@markwharton/api-core';
+import type { RetryConfig, ClientConfig } from '@markwharton/api-core';
 /**
  * Cache configuration for EHClient
  *
@@ -35,7 +35,7 @@ export type EHRetryConfig = RetryConfig;
 /**
  * Employment Hero Payroll configuration for API access
  */
-export interface EHConfig extends BaseClientConfig {
+export interface EHConfig extends ClientConfig {
     /** API key for authentication (used as Basic Auth username) */
     apiKey: string;
     /** Business ID to operate on */

package/package.json

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