-
Notifications
You must be signed in to change notification settings - Fork 146
Expand file tree
/
Copy pathcitations.test.ts
More file actions
385 lines (341 loc) Β· 15.6 KB
/
citations.test.ts
File metadata and controls
385 lines (341 loc) Β· 15.6 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
import { describe, it, expect, mock } from 'bun:test';
import { DocumentApiValidationError } from '../errors.js';
import {
executeCitationsList,
executeCitationsGet,
executeCitationsInsert,
executeCitationsUpdate,
executeCitationsRemove,
executeCitationSourcesList,
executeCitationSourcesGet,
executeCitationSourcesInsert,
executeCitationSourcesUpdate,
executeCitationSourcesRemove,
executeBibliographyGet,
executeBibliographyInsert,
executeBibliographyRebuild,
executeBibliographyConfigure,
executeBibliographyRemove,
type CitationsAdapter,
} from './citations.js';
function makeAdapter(): CitationsAdapter {
return {
list: mock().mockReturnValue({ items: [], total: 0 }),
get: mock().mockReturnValue({}),
insert: mock().mockReturnValue({ success: true }),
update: mock().mockReturnValue({ success: true }),
remove: mock().mockReturnValue({ success: true }),
sources: {
list: mock().mockReturnValue({ items: [], total: 0 }),
get: mock().mockReturnValue({}),
insert: mock().mockReturnValue({ success: true }),
update: mock().mockReturnValue({ success: true }),
remove: mock().mockReturnValue({ success: true }),
},
bibliography: {
get: mock().mockReturnValue({}),
insert: mock().mockReturnValue({ success: true }),
rebuild: mock().mockReturnValue({ success: true }),
configure: mock().mockReturnValue({ success: true }),
remove: mock().mockReturnValue({ success: true }),
},
};
}
const validCitationTarget = { kind: 'inline', nodeType: 'citation' };
const validSourceTarget = { kind: 'entity', entityType: 'citationSource', sourceId: 'src-1' };
const validBibTarget = { kind: 'block', nodeType: 'bibliography', nodeId: 'bib-1' };
describe('citations validation', () => {
// ββ Citation target validation ββββββββββββββββββββββββββββββββββββββ
describe('validateCitationTarget', () => {
it('throws INVALID_TARGET for null target', () => {
const adapter = makeAdapter();
expect(() => executeCitationsGet(adapter, { target: null as any })).toThrow(DocumentApiValidationError);
try {
executeCitationsGet(adapter, { target: null as any });
} catch (e: any) {
expect(e.code).toBe('INVALID_TARGET');
}
});
it('throws INVALID_TARGET for undefined target', () => {
const adapter = makeAdapter();
expect(() => executeCitationsGet(adapter, { target: undefined as any })).toThrow(DocumentApiValidationError);
});
it('throws INVALID_TARGET for wrong kind', () => {
const adapter = makeAdapter();
expect(() => executeCitationsGet(adapter, { target: { kind: 'block', nodeType: 'citation' } as any })).toThrow(
DocumentApiValidationError,
);
});
it('throws INVALID_TARGET for wrong nodeType', () => {
const adapter = makeAdapter();
expect(() => executeCitationsGet(adapter, { target: { kind: 'inline', nodeType: 'hyperlink' } as any })).toThrow(
DocumentApiValidationError,
);
});
});
// ββ Citation source target validation βββββββββββββββββββββββββββββββ
describe('validateCitationSourceTarget', () => {
it('throws INVALID_TARGET for null target', () => {
const adapter = makeAdapter();
expect(() => executeCitationSourcesGet(adapter, { target: null as any })).toThrow(DocumentApiValidationError);
});
it('throws INVALID_TARGET for wrong kind', () => {
const adapter = makeAdapter();
expect(() =>
executeCitationSourcesGet(adapter, {
target: { kind: 'inline', entityType: 'citationSource', sourceId: 'x' } as any,
}),
).toThrow(DocumentApiValidationError);
});
it('throws INVALID_TARGET for wrong entityType', () => {
const adapter = makeAdapter();
expect(() =>
executeCitationSourcesGet(adapter, {
target: { kind: 'entity', entityType: 'bookmark', sourceId: 'x' } as any,
}),
).toThrow(DocumentApiValidationError);
});
it('throws INVALID_TARGET when sourceId is not a string', () => {
const adapter = makeAdapter();
expect(() =>
executeCitationSourcesGet(adapter, {
target: { kind: 'entity', entityType: 'citationSource', sourceId: 42 } as any,
}),
).toThrow(DocumentApiValidationError);
});
it('throws INVALID_TARGET when sourceId is missing', () => {
const adapter = makeAdapter();
expect(() =>
executeCitationSourcesGet(adapter, {
target: { kind: 'entity', entityType: 'citationSource' } as any,
}),
).toThrow(DocumentApiValidationError);
});
});
// ββ Bibliography target validation ββββββββββββββββββββββββββββββββββ
describe('validateBibliographyTarget', () => {
it('throws INVALID_TARGET for null target', () => {
const adapter = makeAdapter();
expect(() => executeBibliographyGet(adapter, { target: null as any })).toThrow(DocumentApiValidationError);
});
it('throws INVALID_TARGET for wrong kind', () => {
const adapter = makeAdapter();
expect(() =>
executeBibliographyGet(adapter, {
target: { kind: 'inline', nodeType: 'bibliography', nodeId: 'x' } as any,
}),
).toThrow(DocumentApiValidationError);
});
it('throws INVALID_TARGET for wrong nodeType', () => {
const adapter = makeAdapter();
expect(() =>
executeBibliographyGet(adapter, {
target: { kind: 'block', nodeType: 'index', nodeId: 'x' } as any,
}),
).toThrow(DocumentApiValidationError);
});
it('throws INVALID_TARGET when nodeId is not a string', () => {
const adapter = makeAdapter();
expect(() =>
executeBibliographyGet(adapter, {
target: { kind: 'block', nodeType: 'bibliography', nodeId: 42 } as any,
}),
).toThrow(DocumentApiValidationError);
});
});
// ββ Citation input validation βββββββββββββββββββββββββββββββββββββββ
describe('executeCitationsInsert', () => {
it('throws INVALID_INPUT when sourceIds is missing', () => {
const adapter = makeAdapter();
expect(() => executeCitationsInsert(adapter, {} as any)).toThrow(DocumentApiValidationError);
try {
executeCitationsInsert(adapter, {} as any);
} catch (e: any) {
expect(e.code).toBe('INVALID_INPUT');
}
});
it('throws INVALID_INPUT when sourceIds is empty array', () => {
const adapter = makeAdapter();
expect(() => executeCitationsInsert(adapter, { sourceIds: [] } as any)).toThrow(DocumentApiValidationError);
});
it('throws INVALID_INPUT when sourceIds is not an array', () => {
const adapter = makeAdapter();
expect(() => executeCitationsInsert(adapter, { sourceIds: 'src-1' } as any)).toThrow(DocumentApiValidationError);
});
it('delegates to adapter.insert for valid input', () => {
const adapter = makeAdapter();
const input = { sourceIds: ['src-1', 'src-2'] };
executeCitationsInsert(adapter, input as any);
expect(adapter.insert).toHaveBeenCalledWith(input, { changeMode: 'direct', dryRun: false });
});
});
// ββ Citation source input validation ββββββββββββββββββββββββββββββββ
describe('executeCitationSourcesInsert', () => {
it('throws INVALID_INPUT when type is missing', () => {
const adapter = makeAdapter();
expect(() => executeCitationSourcesInsert(adapter, {} as any)).toThrow(DocumentApiValidationError);
try {
executeCitationSourcesInsert(adapter, {} as any);
} catch (e: any) {
expect(e.code).toBe('INVALID_INPUT');
}
});
it('throws INVALID_INPUT when type is empty', () => {
const adapter = makeAdapter();
expect(() => executeCitationSourcesInsert(adapter, { type: '' } as any)).toThrow(DocumentApiValidationError);
});
it('delegates to adapter.sources.insert for valid input', () => {
const adapter = makeAdapter();
const input = { type: 'book', title: 'A Title' };
executeCitationSourcesInsert(adapter, input as any);
expect(adapter.sources.insert).toHaveBeenCalledWith(input, { changeMode: 'direct', dryRun: false });
});
});
// ββ Bibliography input validation βββββββββββββββββββββββββββββββββββ
describe('executeBibliographyConfigure', () => {
it('throws INVALID_INPUT when style is missing', () => {
const adapter = makeAdapter();
expect(() => executeBibliographyConfigure(adapter, {} as any)).toThrow(DocumentApiValidationError);
try {
executeBibliographyConfigure(adapter, {} as any);
} catch (e: any) {
expect(e.code).toBe('INVALID_INPUT');
}
});
it('throws INVALID_INPUT when style is empty', () => {
const adapter = makeAdapter();
expect(() => executeBibliographyConfigure(adapter, { style: '' } as any)).toThrow(DocumentApiValidationError);
});
it('throws INVALID_INPUT when style is not a string', () => {
const adapter = makeAdapter();
expect(() => executeBibliographyConfigure(adapter, { style: 42 } as any)).toThrow(DocumentApiValidationError);
});
it('delegates to adapter.bibliography.configure for valid input', () => {
const adapter = makeAdapter();
const input = { style: 'apa' };
executeBibliographyConfigure(adapter, input as any);
expect(adapter.bibliography.configure).toHaveBeenCalledWith(input, { changeMode: 'direct', dryRun: false });
});
});
// ββ Delegation tests β Citations ββββββββββββββββββββββββββββββββββββ
describe('executeCitationsList', () => {
it('delegates to adapter.list', () => {
const adapter = makeAdapter();
executeCitationsList(adapter);
expect(adapter.list).toHaveBeenCalledWith(undefined);
});
});
describe('executeCitationsGet', () => {
it('delegates to adapter.get for valid target', () => {
const adapter = makeAdapter();
const input = { target: validCitationTarget };
executeCitationsGet(adapter, input as any);
expect(adapter.get).toHaveBeenCalledWith(input);
});
});
describe('executeCitationsUpdate', () => {
it('throws INVALID_TARGET for invalid target', () => {
const adapter = makeAdapter();
expect(() => executeCitationsUpdate(adapter, { target: null as any })).toThrow(DocumentApiValidationError);
});
it('delegates to adapter.update with normalized options', () => {
const adapter = makeAdapter();
const input = { target: validCitationTarget };
executeCitationsUpdate(adapter, input as any);
expect(adapter.update).toHaveBeenCalledWith(input, { changeMode: 'direct', dryRun: false });
});
});
describe('executeCitationsRemove', () => {
it('throws INVALID_TARGET for invalid target', () => {
const adapter = makeAdapter();
expect(() => executeCitationsRemove(adapter, { target: null as any })).toThrow(DocumentApiValidationError);
});
it('delegates to adapter.remove with normalized options', () => {
const adapter = makeAdapter();
const input = { target: validCitationTarget };
executeCitationsRemove(adapter, input as any);
expect(adapter.remove).toHaveBeenCalledWith(input, { changeMode: 'direct', dryRun: false });
});
});
// ββ Delegation tests β Citation Sources βββββββββββββββββββββββββββββ
describe('executeCitationSourcesList', () => {
it('delegates to adapter.sources.list', () => {
const adapter = makeAdapter();
executeCitationSourcesList(adapter);
expect(adapter.sources.list).toHaveBeenCalledWith(undefined);
});
});
describe('executeCitationSourcesGet', () => {
it('delegates to adapter.sources.get for valid target', () => {
const adapter = makeAdapter();
const input = { target: validSourceTarget };
executeCitationSourcesGet(adapter, input as any);
expect(adapter.sources.get).toHaveBeenCalledWith(input);
});
});
describe('executeCitationSourcesUpdate', () => {
it('throws INVALID_TARGET for invalid target', () => {
const adapter = makeAdapter();
expect(() => executeCitationSourcesUpdate(adapter, { target: null as any })).toThrow(DocumentApiValidationError);
});
it('delegates to adapter.sources.update with normalized options', () => {
const adapter = makeAdapter();
const input = { target: validSourceTarget };
executeCitationSourcesUpdate(adapter, input as any);
expect(adapter.sources.update).toHaveBeenCalledWith(input, { changeMode: 'direct', dryRun: false });
});
});
describe('executeCitationSourcesRemove', () => {
it('throws INVALID_TARGET for invalid target', () => {
const adapter = makeAdapter();
expect(() => executeCitationSourcesRemove(adapter, { target: null as any })).toThrow(DocumentApiValidationError);
});
it('delegates to adapter.sources.remove with normalized options', () => {
const adapter = makeAdapter();
const input = { target: validSourceTarget };
executeCitationSourcesRemove(adapter, input as any);
expect(adapter.sources.remove).toHaveBeenCalledWith(input, { changeMode: 'direct', dryRun: false });
});
});
// ββ Delegation tests β Bibliography βββββββββββββββββββββββββββββββββ
describe('executeBibliographyGet', () => {
it('delegates to adapter.bibliography.get for valid target', () => {
const adapter = makeAdapter();
const input = { target: validBibTarget };
executeBibliographyGet(adapter, input as any);
expect(adapter.bibliography.get).toHaveBeenCalledWith(input);
});
});
describe('executeBibliographyInsert', () => {
it('delegates to adapter.bibliography.insert (no input validation)', () => {
const adapter = makeAdapter();
const input = { position: 'end' };
executeBibliographyInsert(adapter, input as any);
expect(adapter.bibliography.insert).toHaveBeenCalledWith(input, { changeMode: 'direct', dryRun: false });
});
});
describe('executeBibliographyRebuild', () => {
it('throws INVALID_TARGET for invalid target', () => {
const adapter = makeAdapter();
expect(() => executeBibliographyRebuild(adapter, { target: null as any })).toThrow(DocumentApiValidationError);
});
it('delegates to adapter.bibliography.rebuild with normalized options', () => {
const adapter = makeAdapter();
const input = { target: validBibTarget };
executeBibliographyRebuild(adapter, input as any, { dryRun: true });
expect(adapter.bibliography.rebuild).toHaveBeenCalledWith(input, { changeMode: 'direct', dryRun: true });
});
});
describe('executeBibliographyRemove', () => {
it('throws INVALID_TARGET for invalid target', () => {
const adapter = makeAdapter();
expect(() => executeBibliographyRemove(adapter, { target: null as any })).toThrow(DocumentApiValidationError);
});
it('delegates to adapter.bibliography.remove with normalized options', () => {
const adapter = makeAdapter();
const input = { target: validBibTarget };
executeBibliographyRemove(adapter, input as any);
expect(adapter.bibliography.remove).toHaveBeenCalledWith(input, { changeMode: 'direct', dryRun: false });
});
});
});