@markwharton/liquidplanner 2.5.0 → 2.6.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/types.d.ts

@@ -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 */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@markwharton/liquidplanner",
-  "version": "2.5.0",
+  "version": "2.6.0",
   "description": "LiquidPlanner API client for timesheet integration",
   "type": "module",
   "main": "dist/index.js",