@markwharton/liquidplanner 2.5.0 → 2.7.0

package/dist/client.d.ts

@@ -96,6 +96,10 @@ export declare class LPClient {
     getWorkspaces(): Promise<Result<LPWorkspace[]>>;
     /**
      * Get all members in the workspace
+     *
+     * Returns only users with userType "member" — excludes resources and
+     * placeholders. The full user list is cached; member filtering is applied
+     * post-cache per the cache-then-filter convention.
      */
     getWorkspaceMembers(): Promise<Result<LPMember[]>>;
     /**

package/dist/client.js

@@ -263,9 +263,13 @@ export class LPClient {
     // ============================================================================
     /**
      * Get all members in the workspace
+     *
+     * Returns only users with userType "member" — excludes resources and
+     * placeholders. The full user list is cached; member filtering is applied
+     * post-cache per the cache-then-filter convention.
      */
     async getWorkspaceMembers() {
-        return this.cached('members', this.cacheTtl.membersTtl, async () => {
+        const result = await this.cached('members', this.cacheTtl.membersTtl, async () => {
             const baseUrl = this.workspaceUrl('users/v1');
             return paginatedFetch({
                 fetchFn: (url) => this.fetch(url),
@@ -280,6 +284,9 @@ export class LPClient {
                 })),
             });
         });
+        if (!result.ok)
+            return result;
+        return ok(result.data.filter(m => m.userType === 'member'));
     }
     // ============================================================================
     // Items

package/dist/index.d.ts

@@ -32,7 +32,7 @@ export { LPClient } from './client.js';
 export { resolveTaskToAssignment } from './workflows.js';
 export type { LPConfig, LPCacheConfig, LPRetryConfig, LPItemType, LPHierarchyItem, LPItem, LPAncestor, LPWorkspace, LPMember, LPCostCode, LPSyncResult, LPTimesheetEntry, LPTaskResolution, LPUpsertOptions, LPAssignment, LPFindItemsOptions, LPTreeNode, LPWorkspaceTree, } from './types.js';
 export type { AccessTier } from './types.js';
-export { METHOD_TIERS } from './types.js';
+export { METHOD_TIERS, ENTITIES } from './types.js';
 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';

package/dist/index.js

@@ -32,7 +32,7 @@
 export { LPClient } from './client.js';
 // Workflows
 export { resolveTaskToAssignment } from './workflows.js';
-export { METHOD_TIERS } from './types.js';
+export { METHOD_TIERS, ENTITIES } from './types.js';
 // Re-exported from @markwharton/api-core
 export { ok, err, getErrorMessage, TTLCache, MemoryCacheStore, LayeredCache } from '@markwharton/api-core';
 // Utilities

package/dist/types.d.ts

@@ -4,7 +4,7 @@
  * These types define the data structures used when interacting with
  * the LiquidPlanner API.
  */
-import type { Result, RetryConfig, ClientConfig } from '@markwharton/api-core';
+import type { Result, RetryConfig, ClientConfig, EntityDef } from '@markwharton/api-core';
 /**
  * LiquidPlanner item types in the hierarchy
  */
@@ -133,6 +133,14 @@ export interface LPWorkspace {
 }
 /**
  * A workspace member from LiquidPlanner
+ *
+ * Represents LP users with userType "member" only. Resources and placeholders
+ * are excluded by getWorkspaceMembers(). The LP API endpoint is /api/users/v1
+ * but this library filters to members — the active users who log time and
+ * are assigned to work.
+ *
+ * Roadmap: LPUser type and getUsers() method for all user types (member,
+ * resource, placeholder) when the need arises.
  */
 export interface LPMember {
     /** Unique identifier */
@@ -340,3 +348,10 @@ export type AccessTier = 'standard' | 'restricted';
  * Utility methods (validate, clear, invalidate) are not included.
  */
 export declare const METHOD_TIERS: Record<string, AccessTier>;
+/**
+ * Entity registry — maps interface names to API path segments and documentation refs.
+ *
+ * LP entities do not use field filtering (all properties are always included),
+ * so `fields` is omitted. The `apiRef` links to api-docs.liquidplanner.com.
+ */
+export declare const ENTITIES: Record<string, EntityDef>;

package/dist/types.js

@@ -27,3 +27,19 @@ export const METHOD_TIERS = {
     updateTimesheetEntry: 'standard',
     upsertTimesheetEntry: 'standard',
 };
+// ============================================================================
+// Entity Registry
+// ============================================================================
+/**
+ * Entity registry — maps interface names to API path segments and documentation refs.
+ *
+ * LP entities do not use field filtering (all properties are always included),
+ * so `fields` is omitted. The `apiRef` links to api-docs.liquidplanner.com.
+ */
+export const ENTITIES = {
+    LPMember: { path: 'users/v1', apiRef: 'users' },
+    LPItem: { path: 'items/v1', apiRef: 'item' },
+    LPAncestor: { path: 'items/v1/{id}/ancestors', apiRef: 'item' },
+    LPCostCode: { path: 'cost-codes/v1', apiRef: 'cost-codes' },
+    LPTimesheetEntry: { path: 'logged-time-entries/v1', apiRef: 'logged-time-entry' },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markwharton/liquidplanner",
-  "version": "2.5.0",
+  "version": "2.7.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.3.0"
+    "@markwharton/api-core": "^1.5.0"
   },
   "devDependencies": {
     "@types/node": "^20.10.0",