@markwharton/liquidplanner 2.1.0 → 2.1.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/README.md +2 -0
- package/dist/index.d.ts +1 -1
- package/dist/types.d.ts +2 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -208,6 +208,8 @@ const client = new LPClient({
|
|
|
208
208
|
});
|
|
209
209
|
```
|
|
210
210
|
|
|
211
|
+
`LPConfig` extends `ClientConfig` from api-core, which provides the `baseUrl`, `onRequest`, and `retry` fields. `apiToken`, `workspaceId`, and `cache` are LP-specific.
|
|
212
|
+
|
|
211
213
|
### Cache TTLs
|
|
212
214
|
|
|
213
215
|
| Cache Key | Default TTL |
|
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, HierarchyItem, LPItem, LPAncestor, LPWorkspace, LPMember, LPCostCode, LPSyncResult, LPTimesheetEntry, LPTimesheetEntryWithId, LPTaskResolution, LPUpsertOptions, LPAssignmentWithContext, LPFindItemsOptions, LPTreeNode, LPWorkspaceTree, } from './types.js';
|
|
34
34
|
export { ok, err, getErrorMessage } from '@markwharton/api-core';
|
|
35
|
-
export type { Result, RetryConfig, OnRequestCallback,
|
|
35
|
+
export type { Result, RetryConfig, OnRequestCallback, ClientConfig } from '@markwharton/api-core';
|
|
36
36
|
export { hoursToMinutes, normalizeItemType, buildAuthHeader, filterIs, filterIsNot, filterIn, filterGt, filterLt, filterAfter, filterBefore, joinFilters, paginatedFetch, } from './utils.js';
|
|
37
37
|
export type { PaginateOptions } from './utils.js';
|
|
38
38
|
export { buildTree, getTreeAncestors, getTreeHierarchyPath, findInTree, } from './tree.js';
|
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,
|
|
7
|
+
import type { Result, RetryConfig, ClientConfig } from '@markwharton/api-core';
|
|
8
8
|
/**
|
|
9
9
|
* LiquidPlanner item types in the hierarchy
|
|
10
10
|
*/
|
|
@@ -199,7 +199,7 @@ export type LPRetryConfig = RetryConfig;
|
|
|
199
199
|
/**
|
|
200
200
|
* LiquidPlanner configuration for API access
|
|
201
201
|
*/
|
|
202
|
-
export interface LPConfig extends
|
|
202
|
+
export interface LPConfig extends ClientConfig {
|
|
203
203
|
/** Workspace ID to operate on */
|
|
204
204
|
workspaceId: number;
|
|
205
205
|
/** API token for authentication */
|