@markwharton/liquidplanner 2.6.0 → 2.7.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -32,7 +32,7 @@ export { LPClient } from './client.js';
32
32
  export { resolveTaskToAssignment } from './workflows.js';
33
33
  export type { LPConfig, LPCacheConfig, LPRetryConfig, LPItemType, LPHierarchyItem, LPItem, LPAncestor, LPWorkspace, LPMember, LPCostCode, LPSyncResult, LPTimesheetEntry, LPTaskResolution, LPUpsertOptions, LPAssignment, LPFindItemsOptions, LPTreeNode, LPWorkspaceTree, } from './types.js';
34
34
  export type { AccessTier } from './types.js';
35
- export { METHOD_TIERS } from './types.js';
35
+ export { METHOD_TIERS, ENTITIES } from './types.js';
36
36
  export { ok, err, getErrorMessage, TTLCache, MemoryCacheStore, LayeredCache } from '@markwharton/api-core';
37
37
  export type { Result, RetryConfig, OnRequestCallback, ClientConfig, Cache, CacheStore, CacheGetOptions } from '@markwharton/api-core';
38
38
  export { hoursToMinutes, normalizeItemType, buildAuthHeader, filterIs, filterIsNot, filterIn, filterGt, filterLt, filterAfter, filterBefore, joinFilters, paginatedFetch, } from './utils.js';
package/dist/index.js CHANGED
@@ -32,7 +32,7 @@
32
32
  export { LPClient } from './client.js';
33
33
  // Workflows
34
34
  export { resolveTaskToAssignment } from './workflows.js';
35
- export { METHOD_TIERS } from './types.js';
35
+ export { METHOD_TIERS, ENTITIES } from './types.js';
36
36
  // Re-exported from @markwharton/api-core
37
37
  export { ok, err, getErrorMessage, TTLCache, MemoryCacheStore, LayeredCache } from '@markwharton/api-core';
38
38
  // Utilities
package/dist/types.d.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * These types define the data structures used when interacting with
5
5
  * the LiquidPlanner API.
6
6
  */
7
- import type { Result, RetryConfig, ClientConfig } from '@markwharton/api-core';
7
+ import type { Result, RetryConfig, ClientConfig, EntityDef } from '@markwharton/api-core';
8
8
  /**
9
9
  * LiquidPlanner item types in the hierarchy
10
10
  */
@@ -348,3 +348,10 @@ export type AccessTier = 'standard' | 'restricted';
348
348
  * Utility methods (validate, clear, invalidate) are not included.
349
349
  */
350
350
  export declare const METHOD_TIERS: Record<string, AccessTier>;
351
+ /**
352
+ * Entity registry — maps interface names to API path segments and documentation refs.
353
+ *
354
+ * LP entities do not use field filtering (all properties are always included),
355
+ * so `fields` is omitted. The `apiRef` links to api-docs.liquidplanner.com.
356
+ */
357
+ export declare const ENTITIES: Record<string, EntityDef>;
package/dist/types.js CHANGED
@@ -27,3 +27,19 @@ export const METHOD_TIERS = {
27
27
  updateTimesheetEntry: 'standard',
28
28
  upsertTimesheetEntry: 'standard',
29
29
  };
30
+ // ============================================================================
31
+ // Entity Registry
32
+ // ============================================================================
33
+ /**
34
+ * Entity registry — maps interface names to API path segments and documentation refs.
35
+ *
36
+ * LP entities do not use field filtering (all properties are always included),
37
+ * so `fields` is omitted. The `apiRef` links to api-docs.liquidplanner.com.
38
+ */
39
+ export const ENTITIES = {
40
+ LPMember: { path: 'users/v1', apiRef: 'docs/users-1' },
41
+ LPItem: { path: 'items/v1', apiRef: 'docs/plan-items' },
42
+ LPAncestor: { path: 'items/v1/{id}/ancestors', apiRef: 'docs/plan-items' },
43
+ LPCostCode: { path: 'cost-codes/v1', apiRef: 'docs/cost-codes-1' },
44
+ LPTimesheetEntry: { path: 'logged-time-entries/v1', apiRef: 'docs/task-status-1' },
45
+ };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@markwharton/liquidplanner",
3
- "version": "2.6.0",
3
+ "version": "2.7.1",
4
4
  "description": "LiquidPlanner API client for timesheet integration",
5
5
  "type": "module",
6
6
  "main": "dist/index.js",
@@ -16,7 +16,7 @@
16
16
  "clean": "rm -rf dist"
17
17
  },
18
18
  "dependencies": {
19
- "@markwharton/api-core": "^1.3.0"
19
+ "@markwharton/api-core": "^1.5.0"
20
20
  },
21
21
  "devDependencies": {
22
22
  "@types/node": "^20.10.0",