@critical-path/client 0.1.0
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/LICENSE +21 -0
- package/dist/index.d.ts +30 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +116 -0
- package/dist/index.js.map +1 -0
- package/dist/index.test.d.ts +2 -0
- package/dist/index.test.d.ts.map +1 -0
- package/dist/index.test.js +21 -0
- package/dist/index.test.js.map +1 -0
- package/package.json +32 -0
- package/src/index.test.ts +23 -0
- package/src/index.ts +136 -0
- package/tsconfig.json +8 -0
- package/tsconfig.tsbuildinfo +1 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Jack James
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import type { Project, Task, Activity, Comment, TimeEntry } from '@critical-path/core';
|
|
2
|
+
export interface ClientOptions {
|
|
3
|
+
baseUrl: string;
|
|
4
|
+
headers?: Record<string, string>;
|
|
5
|
+
fetch?: typeof fetch;
|
|
6
|
+
}
|
|
7
|
+
export declare class CriticalPathClient {
|
|
8
|
+
private baseUrl;
|
|
9
|
+
private headers;
|
|
10
|
+
private customFetch;
|
|
11
|
+
constructor(options: ClientOptions);
|
|
12
|
+
private request;
|
|
13
|
+
getProjects(): Promise<Project[]>;
|
|
14
|
+
getProject(id: string): Promise<Project>;
|
|
15
|
+
createProject(data: Omit<Project, 'id' | 'createdAt' | 'updatedAt'>): Promise<Project>;
|
|
16
|
+
getTasks(projectId?: string): Promise<Task[]>;
|
|
17
|
+
getTask(id: string): Promise<Task>;
|
|
18
|
+
createTask(data: Omit<Task, 'id' | 'createdAt' | 'updatedAt'>): Promise<Task>;
|
|
19
|
+
updateTask(id: string, updates: Partial<Task>): Promise<Task>;
|
|
20
|
+
deleteTask(id: string): Promise<boolean>;
|
|
21
|
+
getActivities(filter?: {
|
|
22
|
+
projectId?: string;
|
|
23
|
+
taskId?: string;
|
|
24
|
+
}): Promise<Activity[]>;
|
|
25
|
+
getComments(taskId: string): Promise<Comment[]>;
|
|
26
|
+
addComment(data: Omit<Comment, 'id' | 'createdAt' | 'updatedAt'>): Promise<Comment>;
|
|
27
|
+
getTimeEntries(taskId: string): Promise<TimeEntry[]>;
|
|
28
|
+
logTime(data: Omit<TimeEntry, 'id' | 'loggedAt'>): Promise<TimeEntry>;
|
|
29
|
+
}
|
|
30
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEvF,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;CACtB;AAED,qBAAa,kBAAkB;IAC7B,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAyB;IACxC,OAAO,CAAC,WAAW,CAAe;gBAEtB,OAAO,EAAE,aAAa;YAMpB,OAAO;IA0Bf,WAAW,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;IAKjC,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAKxC,aAAa,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,WAAW,GAAG,WAAW,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IAStF,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;IAM7C,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAKlC,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,GAAG,WAAW,GAAG,WAAW,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ7E,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAQ7D,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAQxC,aAAa,CAAC,MAAM,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAUpF,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;IAK/C,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,IAAI,GAAG,WAAW,GAAG,WAAW,CAAC,GAAG,OAAO,CAAC,OAAO,CAAC;IASnF,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAKpD,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,GAAG,UAAU,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;CAO5E"}
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
export class CriticalPathClient {
|
|
2
|
+
baseUrl;
|
|
3
|
+
headers;
|
|
4
|
+
customFetch;
|
|
5
|
+
constructor(options) {
|
|
6
|
+
this.baseUrl = options.baseUrl.replace(/\/+$/, '');
|
|
7
|
+
this.headers = options.headers || {};
|
|
8
|
+
this.customFetch = options.fetch || globalThis.fetch;
|
|
9
|
+
}
|
|
10
|
+
async request(endpoint, options = {}) {
|
|
11
|
+
const url = `${this.baseUrl}${endpoint.startsWith('/') ? endpoint : `/${endpoint}`}`;
|
|
12
|
+
const response = await this.customFetch(url, {
|
|
13
|
+
...options,
|
|
14
|
+
headers: {
|
|
15
|
+
'Content-Type': 'application/json',
|
|
16
|
+
...this.headers,
|
|
17
|
+
...options.headers
|
|
18
|
+
}
|
|
19
|
+
});
|
|
20
|
+
if (!response.ok) {
|
|
21
|
+
let errorMsg = `HTTP Error ${response.status}: ${response.statusText}`;
|
|
22
|
+
try {
|
|
23
|
+
const errJson = await response.json();
|
|
24
|
+
if (errJson.error)
|
|
25
|
+
errorMsg = errJson.error;
|
|
26
|
+
}
|
|
27
|
+
catch {
|
|
28
|
+
// Fallback to HTTP error
|
|
29
|
+
}
|
|
30
|
+
throw new Error(errorMsg);
|
|
31
|
+
}
|
|
32
|
+
return response.json();
|
|
33
|
+
}
|
|
34
|
+
// Projects
|
|
35
|
+
async getProjects() {
|
|
36
|
+
const res = await this.request('/projects');
|
|
37
|
+
return res.projects;
|
|
38
|
+
}
|
|
39
|
+
async getProject(id) {
|
|
40
|
+
const res = await this.request(`/projects/${id}`);
|
|
41
|
+
return res.project;
|
|
42
|
+
}
|
|
43
|
+
async createProject(data) {
|
|
44
|
+
const res = await this.request('/projects', {
|
|
45
|
+
method: 'POST',
|
|
46
|
+
body: JSON.stringify(data)
|
|
47
|
+
});
|
|
48
|
+
return res.project;
|
|
49
|
+
}
|
|
50
|
+
// Tasks
|
|
51
|
+
async getTasks(projectId) {
|
|
52
|
+
const query = projectId ? `?projectId=${encodeURIComponent(projectId)}` : '';
|
|
53
|
+
const res = await this.request(`/tasks${query}`);
|
|
54
|
+
return res.tasks;
|
|
55
|
+
}
|
|
56
|
+
async getTask(id) {
|
|
57
|
+
const res = await this.request(`/tasks/${id}`);
|
|
58
|
+
return res.task;
|
|
59
|
+
}
|
|
60
|
+
async createTask(data) {
|
|
61
|
+
const res = await this.request('/tasks', {
|
|
62
|
+
method: 'POST',
|
|
63
|
+
body: JSON.stringify(data)
|
|
64
|
+
});
|
|
65
|
+
return res.task;
|
|
66
|
+
}
|
|
67
|
+
async updateTask(id, updates) {
|
|
68
|
+
const res = await this.request(`/tasks/${id}`, {
|
|
69
|
+
method: 'PATCH',
|
|
70
|
+
body: JSON.stringify(updates)
|
|
71
|
+
});
|
|
72
|
+
return res.task;
|
|
73
|
+
}
|
|
74
|
+
async deleteTask(id) {
|
|
75
|
+
const res = await this.request(`/tasks/${id}`, {
|
|
76
|
+
method: 'DELETE'
|
|
77
|
+
});
|
|
78
|
+
return res.success;
|
|
79
|
+
}
|
|
80
|
+
// Activity Stream
|
|
81
|
+
async getActivities(filter) {
|
|
82
|
+
const params = new URLSearchParams();
|
|
83
|
+
if (filter?.projectId)
|
|
84
|
+
params.set('projectId', filter.projectId);
|
|
85
|
+
if (filter?.taskId)
|
|
86
|
+
params.set('taskId', filter.taskId);
|
|
87
|
+
const query = params.toString() ? `?${params.toString()}` : '';
|
|
88
|
+
const res = await this.request(`/activities${query}`);
|
|
89
|
+
return res.activities;
|
|
90
|
+
}
|
|
91
|
+
// Comments
|
|
92
|
+
async getComments(taskId) {
|
|
93
|
+
const res = await this.request(`/comments?taskId=${encodeURIComponent(taskId)}`);
|
|
94
|
+
return res.comments;
|
|
95
|
+
}
|
|
96
|
+
async addComment(data) {
|
|
97
|
+
const res = await this.request('/comments', {
|
|
98
|
+
method: 'POST',
|
|
99
|
+
body: JSON.stringify(data)
|
|
100
|
+
});
|
|
101
|
+
return res.comment;
|
|
102
|
+
}
|
|
103
|
+
// Time Entries
|
|
104
|
+
async getTimeEntries(taskId) {
|
|
105
|
+
const res = await this.request(`/time-entries?taskId=${encodeURIComponent(taskId)}`);
|
|
106
|
+
return res.timeEntries;
|
|
107
|
+
}
|
|
108
|
+
async logTime(data) {
|
|
109
|
+
const res = await this.request('/time-entries', {
|
|
110
|
+
method: 'POST',
|
|
111
|
+
body: JSON.stringify(data)
|
|
112
|
+
});
|
|
113
|
+
return res.timeEntry;
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,MAAM,OAAO,kBAAkB;IACrB,OAAO,CAAS;IAChB,OAAO,CAAyB;IAChC,WAAW,CAAe;IAElC,YAAY,OAAsB;QAChC,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;QACnD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC;QACrC,IAAI,CAAC,WAAW,GAAG,OAAO,CAAC,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC;IACvD,CAAC;IAEO,KAAK,CAAC,OAAO,CAAI,QAAgB,EAAE,UAAuB,EAAE;QAClE,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,QAAQ,EAAE,EAAE,CAAC;QACrF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE;YAC3C,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,GAAG,IAAI,CAAC,OAAO;gBACf,GAAG,OAAO,CAAC,OAAO;aACnB;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,IAAI,QAAQ,GAAG,cAAc,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC;YACvE,IAAI,CAAC;gBACH,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;gBACtC,IAAI,OAAO,CAAC,KAAK;oBAAE,QAAQ,GAAG,OAAO,CAAC,KAAK,CAAC;YAC9C,CAAC;YAAC,MAAM,CAAC;gBACP,yBAAyB;YAC3B,CAAC;YACD,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,CAAC;QAC5B,CAAC;QAED,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IAED,WAAW;IACX,KAAK,CAAC,WAAW;QACf,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAA0B,WAAW,CAAC,CAAC;QACrE,OAAO,GAAG,CAAC,QAAQ,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU;QACzB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,aAAa,EAAE,EAAE,CAAC,CAAC;QACxE,OAAO,GAAG,CAAC,OAAO,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,IAAqD;QACvE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,WAAW,EAAE;YAChE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,OAAO,CAAC;IACrB,CAAC;IAED,QAAQ;IACR,KAAK,CAAC,QAAQ,CAAC,SAAkB;QAC/B,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,cAAc,kBAAkB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC7E,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAoB,SAAS,KAAK,EAAE,CAAC,CAAC;QACpE,OAAO,GAAG,CAAC,KAAK,CAAC;IACnB,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,EAAU;QACtB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAiB,UAAU,EAAE,EAAE,CAAC,CAAC;QAC/D,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,IAAkD;QACjE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAiB,QAAQ,EAAE;YACvD,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU,EAAE,OAAsB;QACjD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAiB,UAAU,EAAE,EAAE,EAAE;YAC7D,MAAM,EAAE,OAAO;YACf,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;SAC9B,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,EAAU;QACzB,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,UAAU,EAAE,EAAE,EAAE;YACnE,MAAM,EAAE,QAAQ;SACjB,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,OAAO,CAAC;IACrB,CAAC;IAED,kBAAkB;IAClB,KAAK,CAAC,aAAa,CAAC,MAAgD;QAClE,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,IAAI,MAAM,EAAE,SAAS;YAAE,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;QACjE,IAAI,MAAM,EAAE,MAAM;YAAE,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QACxD,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC/D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAA6B,cAAc,KAAK,EAAE,CAAC,CAAC;QAClF,OAAO,GAAG,CAAC,UAAU,CAAC;IACxB,CAAC;IAED,WAAW;IACX,KAAK,CAAC,WAAW,CAAC,MAAc;QAC9B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAA0B,oBAAoB,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QAC1G,OAAO,GAAG,CAAC,QAAQ,CAAC;IACtB,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,IAAqD;QACpE,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAAuB,WAAW,EAAE;YAChE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,OAAO,CAAC;IACrB,CAAC;IAED,eAAe;IACf,KAAK,CAAC,cAAc,CAAC,MAAc;QACjC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAA+B,wBAAwB,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;QACnH,OAAO,GAAG,CAAC,WAAW,CAAC;IACzB,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,IAAwC;QACpD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,OAAO,CAA2B,eAAe,EAAE;YACxE,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;SAC3B,CAAC,CAAC;QACH,OAAO,GAAG,CAAC,SAAS,CAAC;IACvB,CAAC;CACF"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.test.d.ts","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { describe, it, expect } from 'vitest';
|
|
2
|
+
import { CriticalPathClient } from './index.js';
|
|
3
|
+
describe('@critical-path/client Tests', () => {
|
|
4
|
+
it('instantiates client and accepts custom mock fetch', async () => {
|
|
5
|
+
const mockFetch = async (url, init) => {
|
|
6
|
+
const urlStr = url.toString();
|
|
7
|
+
if (urlStr.endsWith('/projects') && (!init?.method || init.method.toUpperCase() === 'GET')) {
|
|
8
|
+
return new Response(JSON.stringify({ projects: [{ id: 'p1', key: 'TEST', name: 'Mock Proj' }] }), { status: 200 });
|
|
9
|
+
}
|
|
10
|
+
return new Response(JSON.stringify({ error: 'Not found' }), { status: 404 });
|
|
11
|
+
};
|
|
12
|
+
const client = new CriticalPathClient({
|
|
13
|
+
baseUrl: 'http://localhost:3000/api/critical-path',
|
|
14
|
+
fetch: mockFetch
|
|
15
|
+
});
|
|
16
|
+
const projects = await client.getProjects();
|
|
17
|
+
expect(projects.length).toBe(1);
|
|
18
|
+
expect(projects[0].name).toBe('Mock Proj');
|
|
19
|
+
});
|
|
20
|
+
});
|
|
21
|
+
//# sourceMappingURL=index.test.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEhD,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;IAC3C,EAAE,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;QACjE,MAAM,SAAS,GAAG,KAAK,EAAE,GAA2B,EAAE,IAAkB,EAAE,EAAE;YAC1E,MAAM,MAAM,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;YAC9B,IAAI,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,KAAK,KAAK,CAAC,EAAE,CAAC;gBAC3F,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;YACrH,CAAC;YACD,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC,EAAE,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,CAAC;QAC/E,CAAC,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,kBAAkB,CAAC;YACpC,OAAO,EAAE,yCAAyC;YAClD,KAAK,EAAE,SAAyB;SACjC,CAAC,CAAC;QAEH,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,WAAW,EAAE,CAAC;QAC5C,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAChC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC7C,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
|
package/package.json
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@critical-path/client",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Type-safe JavaScript/TypeScript client SDK for consuming Critical Path API endpoints",
|
|
5
|
+
"author": "Jack James",
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"type": "module",
|
|
8
|
+
"main": "./dist/index.js",
|
|
9
|
+
"types": "./dist/index.d.ts",
|
|
10
|
+
"exports": {
|
|
11
|
+
".": {
|
|
12
|
+
"import": "./dist/index.js",
|
|
13
|
+
"types": "./dist/index.d.ts"
|
|
14
|
+
}
|
|
15
|
+
},
|
|
16
|
+
"dependencies": {
|
|
17
|
+
"@critical-path/core": "0.1.0"
|
|
18
|
+
},
|
|
19
|
+
"devDependencies": {
|
|
20
|
+
"@types/node": "^24.0.0",
|
|
21
|
+
"typescript": "^5.7.0",
|
|
22
|
+
"vitest": "^3.0.0"
|
|
23
|
+
},
|
|
24
|
+
"engines": {
|
|
25
|
+
"node": ">=24.0.0"
|
|
26
|
+
},
|
|
27
|
+
"scripts": {
|
|
28
|
+
"build": "tsc --build",
|
|
29
|
+
"test": "vitest run",
|
|
30
|
+
"clean": "rm -rf dist *.tsbuildinfo"
|
|
31
|
+
}
|
|
32
|
+
}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import { describe, it, expect } from 'vitest';
|
|
2
|
+
import { CriticalPathClient } from './index.js';
|
|
3
|
+
|
|
4
|
+
describe('@critical-path/client Tests', () => {
|
|
5
|
+
it('instantiates client and accepts custom mock fetch', async () => {
|
|
6
|
+
const mockFetch = async (url: string | URL | Request, init?: RequestInit) => {
|
|
7
|
+
const urlStr = url.toString();
|
|
8
|
+
if (urlStr.endsWith('/projects') && (!init?.method || init.method.toUpperCase() === 'GET')) {
|
|
9
|
+
return new Response(JSON.stringify({ projects: [{ id: 'p1', key: 'TEST', name: 'Mock Proj' }] }), { status: 200 });
|
|
10
|
+
}
|
|
11
|
+
return new Response(JSON.stringify({ error: 'Not found' }), { status: 404 });
|
|
12
|
+
};
|
|
13
|
+
|
|
14
|
+
const client = new CriticalPathClient({
|
|
15
|
+
baseUrl: 'http://localhost:3000/api/critical-path',
|
|
16
|
+
fetch: mockFetch as typeof fetch
|
|
17
|
+
});
|
|
18
|
+
|
|
19
|
+
const projects = await client.getProjects();
|
|
20
|
+
expect(projects.length).toBe(1);
|
|
21
|
+
expect(projects[0].name).toBe('Mock Proj');
|
|
22
|
+
});
|
|
23
|
+
});
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
import type { Project, Task, Activity, Comment, TimeEntry } from '@critical-path/core';
|
|
2
|
+
|
|
3
|
+
export interface ClientOptions {
|
|
4
|
+
baseUrl: string; // e.g. "http://localhost:3000/api/critical-path"
|
|
5
|
+
headers?: Record<string, string>;
|
|
6
|
+
fetch?: typeof fetch;
|
|
7
|
+
}
|
|
8
|
+
|
|
9
|
+
export class CriticalPathClient {
|
|
10
|
+
private baseUrl: string;
|
|
11
|
+
private headers: Record<string, string>;
|
|
12
|
+
private customFetch: typeof fetch;
|
|
13
|
+
|
|
14
|
+
constructor(options: ClientOptions) {
|
|
15
|
+
this.baseUrl = options.baseUrl.replace(/\/+$/, '');
|
|
16
|
+
this.headers = options.headers || {};
|
|
17
|
+
this.customFetch = options.fetch || globalThis.fetch;
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
private async request<T>(endpoint: string, options: RequestInit = {}): Promise<T> {
|
|
21
|
+
const url = `${this.baseUrl}${endpoint.startsWith('/') ? endpoint : `/${endpoint}`}`;
|
|
22
|
+
const response = await this.customFetch(url, {
|
|
23
|
+
...options,
|
|
24
|
+
headers: {
|
|
25
|
+
'Content-Type': 'application/json',
|
|
26
|
+
...this.headers,
|
|
27
|
+
...options.headers
|
|
28
|
+
}
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
if (!response.ok) {
|
|
32
|
+
let errorMsg = `HTTP Error ${response.status}: ${response.statusText}`;
|
|
33
|
+
try {
|
|
34
|
+
const errJson = await response.json();
|
|
35
|
+
if (errJson.error) errorMsg = errJson.error;
|
|
36
|
+
} catch {
|
|
37
|
+
// Fallback to HTTP error
|
|
38
|
+
}
|
|
39
|
+
throw new Error(errorMsg);
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
return response.json();
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
// Projects
|
|
46
|
+
async getProjects(): Promise<Project[]> {
|
|
47
|
+
const res = await this.request<{ projects: Project[] }>('/projects');
|
|
48
|
+
return res.projects;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
async getProject(id: string): Promise<Project> {
|
|
52
|
+
const res = await this.request<{ project: Project }>(`/projects/${id}`);
|
|
53
|
+
return res.project;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
async createProject(data: Omit<Project, 'id' | 'createdAt' | 'updatedAt'>): Promise<Project> {
|
|
57
|
+
const res = await this.request<{ project: Project }>('/projects', {
|
|
58
|
+
method: 'POST',
|
|
59
|
+
body: JSON.stringify(data)
|
|
60
|
+
});
|
|
61
|
+
return res.project;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
// Tasks
|
|
65
|
+
async getTasks(projectId?: string): Promise<Task[]> {
|
|
66
|
+
const query = projectId ? `?projectId=${encodeURIComponent(projectId)}` : '';
|
|
67
|
+
const res = await this.request<{ tasks: Task[] }>(`/tasks${query}`);
|
|
68
|
+
return res.tasks;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
async getTask(id: string): Promise<Task> {
|
|
72
|
+
const res = await this.request<{ task: Task }>(`/tasks/${id}`);
|
|
73
|
+
return res.task;
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
async createTask(data: Omit<Task, 'id' | 'createdAt' | 'updatedAt'>): Promise<Task> {
|
|
77
|
+
const res = await this.request<{ task: Task }>('/tasks', {
|
|
78
|
+
method: 'POST',
|
|
79
|
+
body: JSON.stringify(data)
|
|
80
|
+
});
|
|
81
|
+
return res.task;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
async updateTask(id: string, updates: Partial<Task>): Promise<Task> {
|
|
85
|
+
const res = await this.request<{ task: Task }>(`/tasks/${id}`, {
|
|
86
|
+
method: 'PATCH',
|
|
87
|
+
body: JSON.stringify(updates)
|
|
88
|
+
});
|
|
89
|
+
return res.task;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
async deleteTask(id: string): Promise<boolean> {
|
|
93
|
+
const res = await this.request<{ success: boolean }>(`/tasks/${id}`, {
|
|
94
|
+
method: 'DELETE'
|
|
95
|
+
});
|
|
96
|
+
return res.success;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
// Activity Stream
|
|
100
|
+
async getActivities(filter?: { projectId?: string; taskId?: string }): Promise<Activity[]> {
|
|
101
|
+
const params = new URLSearchParams();
|
|
102
|
+
if (filter?.projectId) params.set('projectId', filter.projectId);
|
|
103
|
+
if (filter?.taskId) params.set('taskId', filter.taskId);
|
|
104
|
+
const query = params.toString() ? `?${params.toString()}` : '';
|
|
105
|
+
const res = await this.request<{ activities: Activity[] }>(`/activities${query}`);
|
|
106
|
+
return res.activities;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
// Comments
|
|
110
|
+
async getComments(taskId: string): Promise<Comment[]> {
|
|
111
|
+
const res = await this.request<{ comments: Comment[] }>(`/comments?taskId=${encodeURIComponent(taskId)}`);
|
|
112
|
+
return res.comments;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
async addComment(data: Omit<Comment, 'id' | 'createdAt' | 'updatedAt'>): Promise<Comment> {
|
|
116
|
+
const res = await this.request<{ comment: Comment }>('/comments', {
|
|
117
|
+
method: 'POST',
|
|
118
|
+
body: JSON.stringify(data)
|
|
119
|
+
});
|
|
120
|
+
return res.comment;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
// Time Entries
|
|
124
|
+
async getTimeEntries(taskId: string): Promise<TimeEntry[]> {
|
|
125
|
+
const res = await this.request<{ timeEntries: TimeEntry[] }>(`/time-entries?taskId=${encodeURIComponent(taskId)}`);
|
|
126
|
+
return res.timeEntries;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
async logTime(data: Omit<TimeEntry, 'id' | 'loggedAt'>): Promise<TimeEntry> {
|
|
130
|
+
const res = await this.request<{ timeEntry: TimeEntry }>('/time-entries', {
|
|
131
|
+
method: 'POST',
|
|
132
|
+
body: JSON.stringify(data)
|
|
133
|
+
});
|
|
134
|
+
return res.timeEntry;
|
|
135
|
+
}
|
|
136
|
+
}
|
package/tsconfig.json
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"root":["./src/index.test.ts","./src/index.ts"],"version":"5.9.3"}
|