-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapi.ts
More file actions
483 lines (441 loc) · 16 KB
/
api.ts
File metadata and controls
483 lines (441 loc) · 16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
/**
* REST API for the Worklog system
*/
import express, { Request, Response, NextFunction } from 'express';
import { WorklogDatabase } from './database.js';
import { CreateWorkItemInput, UpdateWorkItemInput, WorkItemQuery, WorkItemStatus, WorkItemPriority, CreateCommentInput, UpdateCommentInput } from './types.js';
import { exportToJsonl, importFromJsonl, getDefaultDataPath } from './jsonl.js';
import { loadConfig } from './config.js';
import { buildAuditEntry } from './audit.js';
function parseNeedsProducerReview(value: unknown): boolean | undefined {
if (value === undefined || value === null) return undefined;
const raw = String(value).toLowerCase();
if (['true', 'yes', '1'].includes(raw)) return true;
if (['false', 'no', '0'].includes(raw)) return false;
return undefined;
}
function normalizeCreateInputWithAudit(input: CreateWorkItemInput): CreateWorkItemInput {
const rawAudit = (input as any).audit;
if (typeof rawAudit === 'string') {
return {
...input,
audit: buildAuditEntry(rawAudit),
};
}
return input;
}
function normalizeUpdateInputWithAudit(input: UpdateWorkItemInput): UpdateWorkItemInput {
const rawAudit = (input as any).audit;
if (typeof rawAudit === 'string') {
return {
...input,
audit: buildAuditEntry(rawAudit),
};
}
return input;
}
function hasAuditField(input: unknown): boolean {
if (!input || typeof input !== 'object') return false;
return Object.prototype.hasOwnProperty.call(input as object, 'audit') && (input as any).audit !== undefined;
}
export function createAPI(db: WorklogDatabase) {
const app = express();
app.use(express.json());
// Load configuration to get default prefix
const config = loadConfig();
const defaultPrefix = config?.prefix || 'WI';
const auditWriteEnabled = config?.auditWriteEnabled !== false;
// Middleware to set the database prefix based on the route
function setPrefixMiddleware(req: Request, res: Response, next: NextFunction) {
const prefix = req.params.prefix || defaultPrefix;
db.setPrefix(prefix.toUpperCase());
next();
}
// Health check
app.get('/health', (req: Request, res: Response) => {
res.json({ status: 'ok', prefix: defaultPrefix });
});
// Routes without prefix (for backward compatibility)
// Create a work item
app.post('/items', (req: Request, res: Response) => {
try {
db.setPrefix(defaultPrefix);
if (!auditWriteEnabled && hasAuditField(req.body)) {
res.status(400).json({ error: 'Audit writes are disabled by config (auditWriteEnabled: false)' });
return;
}
const input: CreateWorkItemInput = normalizeCreateInputWithAudit(req.body);
const item = db.create(input);
res.status(201).json(item);
} catch (error) {
const message = (error as Error).message || 'Invalid request';
res.status(400).json({ error: message });
}
});
// Get a work item by ID
app.get('/items/:id', (req: Request, res: Response) => {
db.setPrefix(defaultPrefix);
const item = db.get(req.params.id);
if (!item) {
res.status(404).json({ error: 'Work item not found' });
return;
}
res.json(item);
});
// Update a work item
app.put('/items/:id', (req: Request, res: Response) => {
try {
db.setPrefix(defaultPrefix);
if (!auditWriteEnabled && hasAuditField(req.body)) {
res.status(400).json({ error: 'Audit writes are disabled by config (auditWriteEnabled: false)' });
return;
}
const current = db.get(req.params.id);
if (!current) {
res.status(404).json({ error: 'Work item not found' });
return;
}
const input: UpdateWorkItemInput = normalizeUpdateInputWithAudit(req.body);
const item = db.update(req.params.id, input);
if (!item) {
res.status(404).json({ error: 'Work item not found' });
return;
}
res.json(item);
} catch (error) {
const message = (error as Error).message || 'Invalid request';
res.status(400).json({ error: message });
}
});
// Delete a work item
app.delete('/items/:id', (req: Request, res: Response) => {
db.setPrefix(defaultPrefix);
const deleted = db.delete(req.params.id);
if (!deleted) {
res.status(404).json({ error: 'Work item not found' });
return;
}
res.status(204).send();
});
// List work items with optional filters
app.get('/items', (req: Request, res: Response) => {
db.setPrefix(defaultPrefix);
const query: WorkItemQuery = {};
if (req.query.status) {
query.status = req.query.status as WorkItemStatus;
}
if (req.query.priority) {
query.priority = req.query.priority as WorkItemPriority;
}
if (req.query.parentId !== undefined) {
query.parentId = req.query.parentId === 'null' ? null : req.query.parentId as string;
}
if (req.query.tags) {
query.tags = Array.isArray(req.query.tags) ? req.query.tags as string[] : [req.query.tags as string];
}
if (req.query.assignee) {
query.assignee = req.query.assignee as string;
}
if (req.query.stage) {
query.stage = req.query.stage as string;
}
if (req.query.needsProducerReview !== undefined) {
const parsed = parseNeedsProducerReview(req.query.needsProducerReview);
if (parsed === undefined) {
res.status(400).json({ error: 'Invalid needsProducerReview value' });
return;
}
query.needsProducerReview = parsed;
}
// Interoperability metadata filters
if (req.query.issueType) {
(query as any).issueType = req.query.issueType as string;
}
if (req.query.createdBy) {
(query as any).createdBy = req.query.createdBy as string;
}
if (req.query.deletedBy) {
(query as any).deletedBy = req.query.deletedBy as string;
}
if (req.query.deleteReason) {
(query as any).deleteReason = req.query.deleteReason as string;
}
const items = db.list(query);
res.json(items);
});
// Get children of a work item
app.get('/items/:id/children', (req: Request, res: Response) => {
db.setPrefix(defaultPrefix);
const children = db.getChildren(req.params.id);
res.json(children);
});
// Get descendants of a work item
app.get('/items/:id/descendants', (req: Request, res: Response) => {
db.setPrefix(defaultPrefix);
const descendants = db.getDescendants(req.params.id);
res.json(descendants);
});
// Comment routes without prefix
// Create a comment for a work item
app.post('/items/:id/comments', (req: Request, res: Response) => {
try {
db.setPrefix(defaultPrefix);
const input: CreateCommentInput = {
workItemId: req.params.id,
author: req.body.author,
comment: req.body.comment,
references: req.body.references,
};
const comment = db.createComment(input);
if (!comment) {
res.status(404).json({ error: 'Work item not found' });
return;
}
res.status(201).json(comment);
} catch (error) {
res.status(400).json({ error: (error as Error).message });
}
});
// Get all comments for a work item
app.get('/items/:id/comments', (req: Request, res: Response) => {
db.setPrefix(defaultPrefix);
const comments = db.getCommentsForWorkItem(req.params.id);
res.json(comments);
});
// Get a specific comment by ID
app.get('/comments/:commentId', (req: Request, res: Response) => {
db.setPrefix(defaultPrefix);
const comment = db.getComment(req.params.commentId);
if (!comment) {
res.status(404).json({ error: 'Comment not found' });
return;
}
res.json(comment);
});
// Update a comment
app.put('/comments/:commentId', (req: Request, res: Response) => {
try {
db.setPrefix(defaultPrefix);
const input: UpdateCommentInput = req.body;
const comment = db.updateComment(req.params.commentId, input);
if (!comment) {
res.status(404).json({ error: 'Comment not found' });
return;
}
res.json(comment);
} catch (error) {
res.status(400).json({ error: (error as Error).message });
}
});
// Delete a comment
app.delete('/comments/:commentId', (req: Request, res: Response) => {
db.setPrefix(defaultPrefix);
const deleted = db.deleteComment(req.params.commentId);
if (!deleted) {
res.status(404).json({ error: 'Comment not found' });
return;
}
res.status(204).send();
});
// Routes with prefix
// Create a work item with prefix
app.post('/projects/:prefix/items', setPrefixMiddleware, (req: Request, res: Response) => {
try {
if (!auditWriteEnabled && hasAuditField(req.body)) {
res.status(400).json({ error: 'Audit writes are disabled by config (auditWriteEnabled: false)' });
return;
}
const input: CreateWorkItemInput = normalizeCreateInputWithAudit(req.body);
const item = db.create(input);
res.status(201).json(item);
} catch (error) {
const message = (error as Error).message || 'Invalid request';
res.status(400).json({ error: message });
}
});
// Get a work item by ID with prefix
app.get('/projects/:prefix/items/:id', setPrefixMiddleware, (req: Request, res: Response) => {
const item = db.get(req.params.id);
if (!item) {
res.status(404).json({ error: 'Work item not found' });
return;
}
res.json(item);
});
// Update a work item with prefix
app.put('/projects/:prefix/items/:id', setPrefixMiddleware, (req: Request, res: Response) => {
try {
if (!auditWriteEnabled && hasAuditField(req.body)) {
res.status(400).json({ error: 'Audit writes are disabled by config (auditWriteEnabled: false)' });
return;
}
const current = db.get(req.params.id);
if (!current) {
res.status(404).json({ error: 'Work item not found' });
return;
}
const input: UpdateWorkItemInput = normalizeUpdateInputWithAudit(req.body);
const item = db.update(req.params.id, input);
if (!item) {
res.status(404).json({ error: 'Work item not found' });
return;
}
res.json(item);
} catch (error) {
const message = (error as Error).message || 'Invalid request';
res.status(400).json({ error: message });
}
});
// Delete a work item with prefix
app.delete('/projects/:prefix/items/:id', setPrefixMiddleware, (req: Request, res: Response) => {
const deleted = db.delete(req.params.id);
if (!deleted) {
res.status(404).json({ error: 'Work item not found' });
return;
}
res.status(204).send();
});
// List work items with prefix
app.get('/projects/:prefix/items', setPrefixMiddleware, (req: Request, res: Response) => {
const query: WorkItemQuery = {};
if (req.query.status) {
query.status = req.query.status as WorkItemStatus;
}
if (req.query.priority) {
query.priority = req.query.priority as WorkItemPriority;
}
if (req.query.parentId !== undefined) {
query.parentId = req.query.parentId === 'null' ? null : req.query.parentId as string;
}
if (req.query.tags) {
query.tags = Array.isArray(req.query.tags) ? req.query.tags as string[] : [req.query.tags as string];
}
if (req.query.assignee) {
query.assignee = req.query.assignee as string;
}
if (req.query.stage) {
query.stage = req.query.stage as string;
}
if (req.query.needsProducerReview !== undefined) {
const parsed = parseNeedsProducerReview(req.query.needsProducerReview);
if (parsed === undefined) {
res.status(400).json({ error: 'Invalid needsProducerReview value' });
return;
}
query.needsProducerReview = parsed;
}
// Interoperability metadata filters
if (req.query.issueType) {
(query as any).issueType = req.query.issueType as string;
}
if (req.query.createdBy) {
(query as any).createdBy = req.query.createdBy as string;
}
if (req.query.deletedBy) {
(query as any).deletedBy = req.query.deletedBy as string;
}
if (req.query.deleteReason) {
(query as any).deleteReason = req.query.deleteReason as string;
}
const items = db.list(query);
res.json(items);
});
// Get children of a work item with prefix
app.get('/projects/:prefix/items/:id/children', setPrefixMiddleware, (req: Request, res: Response) => {
const children = db.getChildren(req.params.id);
res.json(children);
});
// Get descendants of a work item with prefix
app.get('/projects/:prefix/items/:id/descendants', setPrefixMiddleware, (req: Request, res: Response) => {
const descendants = db.getDescendants(req.params.id);
res.json(descendants);
});
// Comment routes with prefix
// Create a comment for a work item with prefix
app.post('/projects/:prefix/items/:id/comments', setPrefixMiddleware, (req: Request, res: Response) => {
try {
const input: CreateCommentInput = {
workItemId: req.params.id,
author: req.body.author,
comment: req.body.comment,
references: req.body.references,
};
const comment = db.createComment(input);
if (!comment) {
res.status(404).json({ error: 'Work item not found' });
return;
}
res.status(201).json(comment);
} catch (error) {
res.status(400).json({ error: (error as Error).message });
}
});
// Get all comments for a work item with prefix
app.get('/projects/:prefix/items/:id/comments', setPrefixMiddleware, (req: Request, res: Response) => {
const comments = db.getCommentsForWorkItem(req.params.id);
res.json(comments);
});
// Get a specific comment by ID with prefix
app.get('/projects/:prefix/comments/:commentId', setPrefixMiddleware, (req: Request, res: Response) => {
const comment = db.getComment(req.params.commentId);
if (!comment) {
res.status(404).json({ error: 'Comment not found' });
return;
}
res.json(comment);
});
// Update a comment with prefix
app.put('/projects/:prefix/comments/:commentId', setPrefixMiddleware, (req: Request, res: Response) => {
try {
const input: UpdateCommentInput = req.body;
const comment = db.updateComment(req.params.commentId, input);
if (!comment) {
res.status(404).json({ error: 'Comment not found' });
return;
}
res.json(comment);
} catch (error) {
res.status(400).json({ error: (error as Error).message });
}
});
// Delete a comment with prefix
app.delete('/projects/:prefix/comments/:commentId', setPrefixMiddleware, (req: Request, res: Response) => {
const deleted = db.deleteComment(req.params.commentId);
if (!deleted) {
res.status(404).json({ error: 'Comment not found' });
return;
}
res.status(204).send();
});
// Export to JSONL
app.post('/export', (req: Request, res: Response) => {
try {
db.setPrefix(defaultPrefix);
const filepath = req.body.filepath || getDefaultDataPath();
const items = db.getAll();
const comments = db.getAllComments();
const dependencyEdges = db.getAllDependencyEdges();
exportToJsonl(items, comments, filepath, dependencyEdges);
res.json({ message: 'Export successful', filepath, count: items.length, commentCount: comments.length });
} catch (error) {
res.status(500).json({ error: (error as Error).message });
}
});
// Import from JSONL
app.post('/import', (req: Request, res: Response) => {
try {
db.setPrefix(defaultPrefix);
const filepath = req.body.filepath || getDefaultDataPath();
const { items, comments, dependencyEdges } = importFromJsonl(filepath);
// SAFETY: db.import() is destructive (clears all items before inserting).
// This is intentional here — the API import endpoint replaces the entire
// database with the contents of the JSONL file.
db.import(items, dependencyEdges);
db.importComments(comments);
res.json({ message: 'Import successful', count: items.length, commentCount: comments.length });
} catch (error) {
res.status(500).json({ error: (error as Error).message });
}
});
return app;
}