@markwharton/liquidplanner 2.1.2 → 2.2.0

package/README.md

@@ -200,6 +200,7 @@ const client = new LPClient({
   baseUrl: '...',              // Optional: override API base URL
   onRequest: ({ method, url, description }) => { ... },  // Optional: debug callback
   cache: {},                   // Optional: enable TTL caching (defaults below)
+  cacheInstance: cache,        // Optional: custom cache backend (e.g., LayeredCache)
   retry: {                     // Optional: retry on 429/503
     maxRetries: 3,
     initialDelayMs: 1000,
@@ -208,7 +209,7 @@ const client = new LPClient({
 });
 ```
 
-`LPConfig` extends `ClientConfig` from api-core, which provides the `baseUrl`, `onRequest`, and `retry` fields. `apiToken`, `workspaceId`, and `cache` are LP-specific.
+`LPConfig` extends `ClientConfig` from api-core, which provides the `baseUrl`, `onRequest`, `retry`, and `cacheInstance` fields. `apiToken`, `workspaceId`, and `cache` are LP-specific. Pass `cacheInstance` to use a custom cache backend (e.g., `LayeredCache` with persistent stores); otherwise `cache: {}` creates an in-memory `TTLCache`.
 
 ### Cache TTLs
 
@@ -223,6 +224,8 @@ const client = new LPClient({
 
 Write operations (`createTimesheetEntry`, `updateTimesheetEntry`) automatically invalidate timesheet cache entries. Call `client.invalidateTreeCache()` to refresh the workspace tree, or `client.clearCache()` to clear all cached data.
 
+Failed API results (`ok: false`) are never cached — transient errors won't persist for the full TTL. See the [root README Cache System section](../../README.md#cache-system) for the full cache architecture (layered stores, PII handling, request coalescing).
+
 ### Retry
 
 Automatically retries on HTTP 429 (Too Many Requests) and 503 (Service Unavailable) with exponential backoff. Respects the `Retry-After` header when present.

package/dist/client.d.ts

@@ -41,6 +41,8 @@ export declare class LPClient {
     constructor(config: LPConfig);
     /**
      * Route through cache if enabled, otherwise call factory directly.
+     * Failed Results (ok === false) are never cached — transient errors
+     * shouldn't persist for the full TTL.
      */
     private cached;
     /**

package/dist/client.js

@@ -114,8 +114,8 @@ export class LPClient {
         this.baseUrl = config.baseUrl ?? LP_API_BASE;
         this.onRequest = config.onRequest;
         // Initialize cache if configured
-        if (config.cache) {
-            this.cache = new TTLCache();
+        if (config.cache || config.cacheInstance) {
+            this.cache = config.cacheInstance ?? new TTLCache();
         }
         this.cacheTtl = {
             membersTtl: config.cache?.membersTtl ?? 300000,
@@ -130,12 +130,16 @@ export class LPClient {
     }
     /**
      * Route through cache if enabled, otherwise call factory directly.
+     * Failed Results (ok === false) are never cached — transient errors
+     * shouldn't persist for the full TTL.
      */
-    async cached(key, ttlMs, factory) {
-        if (this.cache) {
-            return this.cache.get(key, ttlMs, factory);
-        }
-        return factory();
+    async cached(key, ttlMs, factory, options) {
+        if (!this.cache)
+            return factory();
+        return this.cache.get(key, ttlMs, factory, {
+            ...options,
+            shouldCache: (data) => data.ok !== false,
+        });
     }
     /**
      * Clear all cached API responses.

package/dist/index.d.ts

@@ -31,8 +31,8 @@
 export { LPClient } from './client.js';
 export { resolveTaskToAssignment } from './workflows.js';
 export type { LPConfig, LPCacheConfig, LPRetryConfig, LPItemType, HierarchyItem, LPItem, LPAncestor, LPWorkspace, LPMember, LPCostCode, LPSyncResult, LPTimesheetEntry, LPTimesheetEntryWithId, LPTaskResolution, LPUpsertOptions, LPAssignmentWithContext, LPFindItemsOptions, LPTreeNode, LPWorkspaceTree, } from './types.js';
-export { ok, err, getErrorMessage } from '@markwharton/api-core';
-export type { Result, RetryConfig, OnRequestCallback, ClientConfig } from '@markwharton/api-core';
+export { ok, err, getErrorMessage, TTLCache, MemoryCacheStore, LayeredCache } from '@markwharton/api-core';
+export type { Result, RetryConfig, OnRequestCallback, ClientConfig, Cache, CacheStore, CacheGetOptions } from '@markwharton/api-core';
 export { hoursToMinutes, normalizeItemType, buildAuthHeader, filterIs, filterIsNot, filterIn, filterGt, filterLt, filterAfter, filterBefore, joinFilters, paginatedFetch, } from './utils.js';
 export type { PaginateOptions } from './utils.js';
 export { buildTree, getTreeAncestors, getTreeHierarchyPath, findInTree, } from './tree.js';

package/dist/index.js

@@ -33,7 +33,7 @@ export { LPClient } from './client.js';
 // Workflows
 export { resolveTaskToAssignment } from './workflows.js';
 // Re-exported from @markwharton/api-core
-export { ok, err, getErrorMessage } from '@markwharton/api-core';
+export { ok, err, getErrorMessage, TTLCache, MemoryCacheStore, LayeredCache } from '@markwharton/api-core';
 // Utilities
 export { hoursToMinutes, normalizeItemType, buildAuthHeader, filterIs, filterIsNot, filterIn, filterGt, filterLt, filterAfter, filterBefore, joinFilters, paginatedFetch, } from './utils.js';
 // Tree utilities

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markwharton/liquidplanner",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "description": "LiquidPlanner API client for timesheet integration",
   "type": "module",
   "main": "dist/index.js",
@@ -16,7 +16,7 @@
     "clean": "rm -rf dist"
   },
   "dependencies": {
-    "@markwharton/api-core": "^1.2.0"
+    "@markwharton/api-core": "^1.3.0"
   },
   "devDependencies": {
     "@types/node": "^20.10.0",