@vibescope/mcp-server 0.4.4 → 0.4.6
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/CHANGELOG.md +84 -84
- package/README.md +194 -194
- package/dist/api-client/bodies-of-work.d.ts +125 -0
- package/dist/api-client/bodies-of-work.js +78 -0
- package/dist/api-client/chat.d.ts +26 -0
- package/dist/api-client/chat.js +20 -0
- package/dist/api-client/connectors.d.ts +104 -0
- package/dist/api-client/connectors.js +46 -0
- package/dist/api-client/deployment.d.ts +190 -0
- package/dist/api-client/deployment.js +113 -0
- package/dist/api-client/file-checkouts.d.ts +71 -0
- package/dist/api-client/file-checkouts.js +43 -0
- package/dist/api-client/git-issues.d.ts +55 -0
- package/dist/api-client/git-issues.js +34 -0
- package/dist/api-client/index.d.ts +619 -1
- package/dist/api-client/index.js +148 -0
- package/dist/api-client/organizations.d.ts +101 -0
- package/dist/api-client/organizations.js +86 -0
- package/dist/api-client/progress.d.ts +61 -0
- package/dist/api-client/progress.js +34 -0
- package/dist/api-client/project.d.ts +1 -0
- package/dist/api-client/requests.d.ts +28 -0
- package/dist/api-client/requests.js +28 -0
- package/dist/api-client/sprints.d.ts +153 -0
- package/dist/api-client/sprints.js +82 -0
- package/dist/api-client/subtasks.d.ts +37 -0
- package/dist/api-client/subtasks.js +23 -0
- package/dist/api-client.d.ts +23 -0
- package/dist/api-client.js +15 -0
- package/dist/cli-init.js +21 -21
- package/dist/cli.js +26 -26
- package/dist/handlers/blockers.js +4 -0
- package/dist/handlers/chat.d.ts +23 -0
- package/dist/handlers/chat.js +84 -0
- package/dist/handlers/deployment.d.ts +3 -0
- package/dist/handlers/deployment.js +23 -0
- package/dist/handlers/discovery.js +13 -0
- package/dist/handlers/index.d.ts +1 -0
- package/dist/handlers/index.js +3 -0
- package/dist/handlers/project.js +4 -2
- package/dist/handlers/session.js +7 -0
- package/dist/handlers/tasks.js +7 -0
- package/dist/handlers/tool-docs.js +1204 -1131
- package/dist/index.js +73 -73
- package/dist/templates/agent-guidelines.d.ts +1 -1
- package/dist/templates/agent-guidelines.js +205 -187
- package/dist/templates/help-content.js +1621 -1621
- package/dist/tools/bodies-of-work.js +6 -6
- package/dist/tools/chat.d.ts +1 -0
- package/dist/tools/chat.js +24 -0
- package/dist/tools/cloud-agents.js +22 -22
- package/dist/tools/deployment.js +13 -0
- package/dist/tools/features.d.ts +13 -0
- package/dist/tools/features.js +151 -0
- package/dist/tools/index.d.ts +3 -1
- package/dist/tools/index.js +4 -1
- package/dist/tools/milestones.js +2 -2
- package/dist/tools/project.js +4 -0
- package/dist/tools/requests.js +1 -1
- package/dist/tools/session.js +11 -11
- package/dist/tools/sprints.js +9 -9
- package/dist/tools/tasks.js +35 -35
- package/dist/tools/worktrees.js +14 -14
- package/dist/tools.d.ts +2 -0
- package/dist/tools.js +3602 -0
- package/dist/utils.js +11 -11
- package/docs/TOOLS.md +2663 -2545
- package/package.json +53 -53
- package/scripts/generate-docs.ts +212 -212
- package/scripts/version-bump.ts +203 -203
- package/src/api-client/blockers.ts +86 -86
- package/src/api-client/bodies-of-work.ts +194 -0
- package/src/api-client/chat.ts +50 -0
- package/src/api-client/connectors.ts +152 -0
- package/src/api-client/cost.ts +185 -185
- package/src/api-client/decisions.ts +87 -87
- package/src/api-client/deployment.ts +313 -0
- package/src/api-client/discovery.ts +81 -81
- package/src/api-client/fallback.ts +52 -52
- package/src/api-client/file-checkouts.ts +115 -0
- package/src/api-client/findings.ts +100 -100
- package/src/api-client/git-issues.ts +88 -0
- package/src/api-client/ideas.ts +112 -112
- package/src/api-client/index.ts +592 -426
- package/src/api-client/milestones.ts +83 -83
- package/src/api-client/organizations.ts +185 -0
- package/src/api-client/progress.ts +94 -0
- package/src/api-client/project.ts +180 -179
- package/src/api-client/requests.ts +54 -0
- package/src/api-client/session.ts +220 -220
- package/src/api-client/sprints.ts +227 -0
- package/src/api-client/subtasks.ts +57 -0
- package/src/api-client/tasks.ts +450 -450
- package/src/api-client/types.ts +32 -32
- package/src/api-client/validation.ts +60 -60
- package/src/api-client/worktrees.ts +53 -53
- package/src/api-client.test.ts +847 -850
- package/src/api-client.ts +2707 -2672
- package/src/cli-init.ts +557 -557
- package/src/cli.test.ts +284 -284
- package/src/cli.ts +204 -204
- package/src/handlers/__test-setup__.ts +240 -236
- package/src/handlers/__test-utils__.ts +89 -89
- package/src/handlers/blockers.test.ts +468 -468
- package/src/handlers/blockers.ts +172 -163
- package/src/handlers/bodies-of-work.test.ts +704 -704
- package/src/handlers/bodies-of-work.ts +526 -526
- package/src/handlers/chat.test.ts +185 -0
- package/src/handlers/chat.ts +101 -0
- package/src/handlers/cloud-agents.test.ts +438 -438
- package/src/handlers/cloud-agents.ts +156 -156
- package/src/handlers/connectors.test.ts +834 -834
- package/src/handlers/connectors.ts +229 -229
- package/src/handlers/cost.test.ts +462 -462
- package/src/handlers/cost.ts +285 -285
- package/src/handlers/decisions.test.ts +382 -382
- package/src/handlers/decisions.ts +153 -153
- package/src/handlers/deployment.test.ts +551 -551
- package/src/handlers/deployment.ts +570 -541
- package/src/handlers/discovery.test.ts +206 -206
- package/src/handlers/discovery.ts +427 -414
- package/src/handlers/fallback.test.ts +537 -537
- package/src/handlers/fallback.ts +194 -194
- package/src/handlers/file-checkouts.test.ts +750 -750
- package/src/handlers/file-checkouts.ts +185 -185
- package/src/handlers/findings.test.ts +633 -633
- package/src/handlers/findings.ts +239 -239
- package/src/handlers/git-issues.test.ts +631 -631
- package/src/handlers/git-issues.ts +136 -136
- package/src/handlers/ideas.test.ts +644 -644
- package/src/handlers/ideas.ts +207 -207
- package/src/handlers/index.ts +93 -90
- package/src/handlers/milestones.test.ts +475 -475
- package/src/handlers/milestones.ts +180 -180
- package/src/handlers/organizations.test.ts +826 -826
- package/src/handlers/organizations.ts +315 -315
- package/src/handlers/progress.test.ts +269 -269
- package/src/handlers/progress.ts +77 -77
- package/src/handlers/project.test.ts +546 -546
- package/src/handlers/project.ts +242 -239
- package/src/handlers/requests.test.ts +303 -303
- package/src/handlers/requests.ts +99 -99
- package/src/handlers/roles.test.ts +305 -305
- package/src/handlers/roles.ts +219 -219
- package/src/handlers/session.test.ts +998 -998
- package/src/handlers/session.ts +1105 -1093
- package/src/handlers/sprints.test.ts +732 -732
- package/src/handlers/sprints.ts +537 -537
- package/src/handlers/tasks.test.ts +931 -931
- package/src/handlers/tasks.ts +1133 -1121
- package/src/handlers/tool-categories.test.ts +66 -66
- package/src/handlers/tool-docs.test.ts +511 -511
- package/src/handlers/tool-docs.ts +1571 -1491
- package/src/handlers/types.test.ts +259 -259
- package/src/handlers/types.ts +176 -176
- package/src/handlers/validation.test.ts +582 -582
- package/src/handlers/validation.ts +164 -164
- package/src/handlers/version.ts +63 -63
- package/src/index.test.ts +674 -674
- package/src/index.ts +807 -807
- package/src/setup.test.ts +233 -233
- package/src/setup.ts +404 -404
- package/src/templates/agent-guidelines.ts +233 -215
- package/src/templates/help-content.ts +1751 -1751
- package/src/token-tracking.test.ts +463 -463
- package/src/token-tracking.ts +167 -167
- package/src/tools/blockers.ts +122 -122
- package/src/tools/bodies-of-work.ts +283 -283
- package/src/tools/chat.ts +72 -46
- package/src/tools/cloud-agents.ts +101 -101
- package/src/tools/connectors.ts +191 -191
- package/src/tools/cost.ts +111 -111
- package/src/tools/decisions.ts +111 -111
- package/src/tools/deployment.ts +455 -442
- package/src/tools/discovery.ts +76 -76
- package/src/tools/fallback.ts +111 -111
- package/src/tools/features.ts +154 -0
- package/src/tools/file-checkouts.ts +145 -145
- package/src/tools/findings.ts +101 -101
- package/src/tools/git-issues.ts +130 -130
- package/src/tools/ideas.ts +162 -162
- package/src/tools/index.ts +141 -137
- package/src/tools/milestones.ts +118 -118
- package/src/tools/organizations.ts +224 -224
- package/src/tools/progress.ts +73 -73
- package/src/tools/project.ts +206 -202
- package/src/tools/requests.ts +68 -68
- package/src/tools/roles.ts +112 -112
- package/src/tools/session.ts +181 -181
- package/src/tools/sprints.ts +298 -298
- package/src/tools/tasks.ts +550 -550
- package/src/tools/tools.test.ts +222 -222
- package/src/tools/types.ts +9 -9
- package/src/tools/validation.ts +75 -75
- package/src/tools/version.ts +34 -34
- package/src/tools/worktrees.ts +66 -66
- package/src/tools.test.ts +416 -416
- package/src/utils.test.ts +1014 -1014
- package/src/utils.ts +586 -586
- package/src/validators.test.ts +223 -223
- package/src/validators.ts +249 -249
- package/src/version.ts +109 -109
- package/tsconfig.json +16 -16
- package/vitest.config.ts +14 -14
|
@@ -1,259 +1,259 @@
|
|
|
1
|
-
import { describe, it, expect } from 'vitest';
|
|
2
|
-
import {
|
|
3
|
-
success,
|
|
4
|
-
error,
|
|
5
|
-
isSuccess,
|
|
6
|
-
isError,
|
|
7
|
-
type HandlerResult,
|
|
8
|
-
type SuccessResult,
|
|
9
|
-
type ErrorResult,
|
|
10
|
-
} from './types.js';
|
|
11
|
-
|
|
12
|
-
describe('success', () => {
|
|
13
|
-
it('should create a success result with simple data', () => {
|
|
14
|
-
const result = success({ message: 'hello' });
|
|
15
|
-
expect(result.result).toEqual({ message: 'hello' });
|
|
16
|
-
expect(result.isError).toBeUndefined();
|
|
17
|
-
});
|
|
18
|
-
|
|
19
|
-
it('should create a success result with string data', () => {
|
|
20
|
-
const result = success('test string');
|
|
21
|
-
expect(result.result).toBe('test string');
|
|
22
|
-
});
|
|
23
|
-
|
|
24
|
-
it('should create a success result with number data', () => {
|
|
25
|
-
const result = success(42);
|
|
26
|
-
expect(result.result).toBe(42);
|
|
27
|
-
});
|
|
28
|
-
|
|
29
|
-
it('should create a success result with boolean data', () => {
|
|
30
|
-
const result = success(true);
|
|
31
|
-
expect(result.result).toBe(true);
|
|
32
|
-
});
|
|
33
|
-
|
|
34
|
-
it('should create a success result with null data', () => {
|
|
35
|
-
const result = success(null);
|
|
36
|
-
expect(result.result).toBeNull();
|
|
37
|
-
});
|
|
38
|
-
|
|
39
|
-
it('should create a success result with undefined data', () => {
|
|
40
|
-
const result = success(undefined);
|
|
41
|
-
expect(result.result).toBeUndefined();
|
|
42
|
-
});
|
|
43
|
-
|
|
44
|
-
it('should create a success result with array data', () => {
|
|
45
|
-
const result = success([1, 2, 3]);
|
|
46
|
-
expect(result.result).toEqual([1, 2, 3]);
|
|
47
|
-
});
|
|
48
|
-
|
|
49
|
-
it('should create a success result with nested object data', () => {
|
|
50
|
-
const data = {
|
|
51
|
-
tasks: [{ id: '1', title: 'Task 1' }],
|
|
52
|
-
total_count: 1,
|
|
53
|
-
metadata: { page: 1, limit: 10 },
|
|
54
|
-
};
|
|
55
|
-
const result = success(data);
|
|
56
|
-
expect(result.result).toEqual(data);
|
|
57
|
-
});
|
|
58
|
-
|
|
59
|
-
it('should preserve type information', () => {
|
|
60
|
-
interface TaskData {
|
|
61
|
-
id: string;
|
|
62
|
-
title: string;
|
|
63
|
-
}
|
|
64
|
-
const result: SuccessResult<TaskData> = success({ id: '1', title: 'Test' });
|
|
65
|
-
expect(result.result.id).toBe('1');
|
|
66
|
-
expect(result.result.title).toBe('Test');
|
|
67
|
-
});
|
|
68
|
-
});
|
|
69
|
-
|
|
70
|
-
describe('error', () => {
|
|
71
|
-
it('should create an error result with message only', () => {
|
|
72
|
-
const result = error('Something went wrong');
|
|
73
|
-
expect(result.result.error).toBe('Something went wrong');
|
|
74
|
-
expect(result.isError).toBe(true);
|
|
75
|
-
});
|
|
76
|
-
|
|
77
|
-
it('should create an error result with message and details', () => {
|
|
78
|
-
const result = error('Validation failed', { field: 'title', reason: 'too long' });
|
|
79
|
-
expect(result.result.error).toBe('Validation failed');
|
|
80
|
-
expect(result.result.field).toBe('title');
|
|
81
|
-
expect(result.result.reason).toBe('too long');
|
|
82
|
-
expect(result.isError).toBe(true);
|
|
83
|
-
});
|
|
84
|
-
|
|
85
|
-
it('should handle empty details object', () => {
|
|
86
|
-
const result = error('Error message', {});
|
|
87
|
-
expect(result.result.error).toBe('Error message');
|
|
88
|
-
expect(result.isError).toBe(true);
|
|
89
|
-
});
|
|
90
|
-
|
|
91
|
-
it('should handle complex details', () => {
|
|
92
|
-
const result = error('Multiple errors', {
|
|
93
|
-
errors: ['error1', 'error2'],
|
|
94
|
-
count: 2,
|
|
95
|
-
nested: { key: 'value' },
|
|
96
|
-
});
|
|
97
|
-
expect(result.result.error).toBe('Multiple errors');
|
|
98
|
-
expect(result.result.errors).toEqual(['error1', 'error2']);
|
|
99
|
-
expect(result.result.count).toBe(2);
|
|
100
|
-
expect(result.result.nested).toEqual({ key: 'value' });
|
|
101
|
-
});
|
|
102
|
-
|
|
103
|
-
it('should always set isError to true', () => {
|
|
104
|
-
const result1 = error('error1');
|
|
105
|
-
const result2 = error('error2', { detail: 'info' });
|
|
106
|
-
expect(result1.isError).toBe(true);
|
|
107
|
-
expect(result2.isError).toBe(true);
|
|
108
|
-
});
|
|
109
|
-
});
|
|
110
|
-
|
|
111
|
-
describe('isSuccess', () => {
|
|
112
|
-
it('should return true for success results', () => {
|
|
113
|
-
const result = success({ data: 'test' });
|
|
114
|
-
expect(isSuccess(result)).toBe(true);
|
|
115
|
-
});
|
|
116
|
-
|
|
117
|
-
it('should return true for success results with various data types', () => {
|
|
118
|
-
expect(isSuccess(success('string'))).toBe(true);
|
|
119
|
-
expect(isSuccess(success(123))).toBe(true);
|
|
120
|
-
expect(isSuccess(success(null))).toBe(true);
|
|
121
|
-
expect(isSuccess(success([]))).toBe(true);
|
|
122
|
-
expect(isSuccess(success({}))).toBe(true);
|
|
123
|
-
});
|
|
124
|
-
|
|
125
|
-
it('should return false for error results', () => {
|
|
126
|
-
const result = error('Something failed');
|
|
127
|
-
expect(isSuccess(result)).toBe(false);
|
|
128
|
-
});
|
|
129
|
-
|
|
130
|
-
it('should return false for error results with details', () => {
|
|
131
|
-
const result = error('Validation error', { field: 'name' });
|
|
132
|
-
expect(isSuccess(result)).toBe(false);
|
|
133
|
-
});
|
|
134
|
-
|
|
135
|
-
it('should narrow type correctly for success', () => {
|
|
136
|
-
const result: HandlerResult<{ id: string }> = success({ id: '123' });
|
|
137
|
-
if (isSuccess(result)) {
|
|
138
|
-
// TypeScript should know result.result is { id: string }
|
|
139
|
-
expect(result.result.id).toBe('123');
|
|
140
|
-
}
|
|
141
|
-
});
|
|
142
|
-
|
|
143
|
-
it('should work with explicitly typed results', () => {
|
|
144
|
-
const successResult: SuccessResult<number> = { result: 42 };
|
|
145
|
-
const errorResult: ErrorResult = { result: { error: 'fail' }, isError: true };
|
|
146
|
-
|
|
147
|
-
expect(isSuccess(successResult)).toBe(true);
|
|
148
|
-
expect(isSuccess(errorResult)).toBe(false);
|
|
149
|
-
});
|
|
150
|
-
});
|
|
151
|
-
|
|
152
|
-
describe('isError', () => {
|
|
153
|
-
it('should return true for error results', () => {
|
|
154
|
-
const result = error('Something failed');
|
|
155
|
-
expect(isError(result)).toBe(true);
|
|
156
|
-
});
|
|
157
|
-
|
|
158
|
-
it('should return true for error results with details', () => {
|
|
159
|
-
const result = error('Validation error', { field: 'name', code: 'INVALID' });
|
|
160
|
-
expect(isError(result)).toBe(true);
|
|
161
|
-
});
|
|
162
|
-
|
|
163
|
-
it('should return false for success results', () => {
|
|
164
|
-
const result = success({ data: 'test' });
|
|
165
|
-
expect(isError(result)).toBe(false);
|
|
166
|
-
});
|
|
167
|
-
|
|
168
|
-
it('should return false for success results with various data types', () => {
|
|
169
|
-
expect(isError(success('string'))).toBe(false);
|
|
170
|
-
expect(isError(success(123))).toBe(false);
|
|
171
|
-
expect(isError(success(null))).toBe(false);
|
|
172
|
-
expect(isError(success([]))).toBe(false);
|
|
173
|
-
expect(isError(success({}))).toBe(false);
|
|
174
|
-
});
|
|
175
|
-
|
|
176
|
-
it('should narrow type correctly for error', () => {
|
|
177
|
-
const result: HandlerResult<unknown> = error('Task not found');
|
|
178
|
-
if (isError(result)) {
|
|
179
|
-
// TypeScript should know result.result.error is string
|
|
180
|
-
expect(result.result.error).toBe('Task not found');
|
|
181
|
-
}
|
|
182
|
-
});
|
|
183
|
-
|
|
184
|
-
it('should work with explicitly typed results', () => {
|
|
185
|
-
const successResult: SuccessResult<number> = { result: 42 };
|
|
186
|
-
const errorResult: ErrorResult = { result: { error: 'fail' }, isError: true };
|
|
187
|
-
|
|
188
|
-
expect(isError(successResult)).toBe(false);
|
|
189
|
-
expect(isError(errorResult)).toBe(true);
|
|
190
|
-
});
|
|
191
|
-
});
|
|
192
|
-
|
|
193
|
-
describe('HandlerResult type usage', () => {
|
|
194
|
-
it('should work with discriminated union pattern', () => {
|
|
195
|
-
function processResult(result: HandlerResult<string>): string {
|
|
196
|
-
if (isSuccess(result)) {
|
|
197
|
-
return `Success: ${result.result}`;
|
|
198
|
-
} else {
|
|
199
|
-
return `Error: ${result.result.error}`;
|
|
200
|
-
}
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
expect(processResult(success('hello'))).toBe('Success: hello');
|
|
204
|
-
expect(processResult(error('failed'))).toBe('Error: failed');
|
|
205
|
-
});
|
|
206
|
-
|
|
207
|
-
it('should handle async handler patterns', async () => {
|
|
208
|
-
async function mockHandler(): Promise<HandlerResult<{ id: string }>> {
|
|
209
|
-
return success({ id: '123' });
|
|
210
|
-
}
|
|
211
|
-
|
|
212
|
-
const result = await mockHandler();
|
|
213
|
-
expect(isSuccess(result)).toBe(true);
|
|
214
|
-
if (isSuccess(result)) {
|
|
215
|
-
expect(result.result.id).toBe('123');
|
|
216
|
-
}
|
|
217
|
-
});
|
|
218
|
-
|
|
219
|
-
it('should handle error handler patterns', async () => {
|
|
220
|
-
async function mockErrorHandler(): Promise<HandlerResult<{ id: string }>> {
|
|
221
|
-
return error('Not found', { id: '123' });
|
|
222
|
-
}
|
|
223
|
-
|
|
224
|
-
const result = await mockErrorHandler();
|
|
225
|
-
expect(isError(result)).toBe(true);
|
|
226
|
-
if (isError(result)) {
|
|
227
|
-
expect(result.result.error).toBe('Not found');
|
|
228
|
-
expect(result.result.id).toBe('123');
|
|
229
|
-
}
|
|
230
|
-
});
|
|
231
|
-
});
|
|
232
|
-
|
|
233
|
-
describe('edge cases', () => {
|
|
234
|
-
it('should handle result with isError explicitly set to false', () => {
|
|
235
|
-
const result: SuccessResult<string> = { result: 'data', isError: false };
|
|
236
|
-
expect(isSuccess(result)).toBe(true);
|
|
237
|
-
expect(isError(result)).toBe(false);
|
|
238
|
-
});
|
|
239
|
-
|
|
240
|
-
it('should handle result without isError property', () => {
|
|
241
|
-
const result: SuccessResult<string> = { result: 'data' };
|
|
242
|
-
expect(isSuccess(result)).toBe(true);
|
|
243
|
-
expect(isError(result)).toBe(false);
|
|
244
|
-
});
|
|
245
|
-
|
|
246
|
-
it('should handle success with error-like data', () => {
|
|
247
|
-
// A success result that happens to contain an error message in its data
|
|
248
|
-
const result = success({ error: 'This is not an error result', data: 'some data' });
|
|
249
|
-
expect(isSuccess(result)).toBe(true);
|
|
250
|
-
expect(isError(result)).toBe(false);
|
|
251
|
-
});
|
|
252
|
-
|
|
253
|
-
it('should handle empty string error message', () => {
|
|
254
|
-
const result = error('');
|
|
255
|
-
expect(result.result.error).toBe('');
|
|
256
|
-
expect(result.isError).toBe(true);
|
|
257
|
-
expect(isError(result)).toBe(true);
|
|
258
|
-
});
|
|
259
|
-
});
|
|
1
|
+
import { describe, it, expect } from 'vitest';
|
|
2
|
+
import {
|
|
3
|
+
success,
|
|
4
|
+
error,
|
|
5
|
+
isSuccess,
|
|
6
|
+
isError,
|
|
7
|
+
type HandlerResult,
|
|
8
|
+
type SuccessResult,
|
|
9
|
+
type ErrorResult,
|
|
10
|
+
} from './types.js';
|
|
11
|
+
|
|
12
|
+
describe('success', () => {
|
|
13
|
+
it('should create a success result with simple data', () => {
|
|
14
|
+
const result = success({ message: 'hello' });
|
|
15
|
+
expect(result.result).toEqual({ message: 'hello' });
|
|
16
|
+
expect(result.isError).toBeUndefined();
|
|
17
|
+
});
|
|
18
|
+
|
|
19
|
+
it('should create a success result with string data', () => {
|
|
20
|
+
const result = success('test string');
|
|
21
|
+
expect(result.result).toBe('test string');
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
it('should create a success result with number data', () => {
|
|
25
|
+
const result = success(42);
|
|
26
|
+
expect(result.result).toBe(42);
|
|
27
|
+
});
|
|
28
|
+
|
|
29
|
+
it('should create a success result with boolean data', () => {
|
|
30
|
+
const result = success(true);
|
|
31
|
+
expect(result.result).toBe(true);
|
|
32
|
+
});
|
|
33
|
+
|
|
34
|
+
it('should create a success result with null data', () => {
|
|
35
|
+
const result = success(null);
|
|
36
|
+
expect(result.result).toBeNull();
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
it('should create a success result with undefined data', () => {
|
|
40
|
+
const result = success(undefined);
|
|
41
|
+
expect(result.result).toBeUndefined();
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
it('should create a success result with array data', () => {
|
|
45
|
+
const result = success([1, 2, 3]);
|
|
46
|
+
expect(result.result).toEqual([1, 2, 3]);
|
|
47
|
+
});
|
|
48
|
+
|
|
49
|
+
it('should create a success result with nested object data', () => {
|
|
50
|
+
const data = {
|
|
51
|
+
tasks: [{ id: '1', title: 'Task 1' }],
|
|
52
|
+
total_count: 1,
|
|
53
|
+
metadata: { page: 1, limit: 10 },
|
|
54
|
+
};
|
|
55
|
+
const result = success(data);
|
|
56
|
+
expect(result.result).toEqual(data);
|
|
57
|
+
});
|
|
58
|
+
|
|
59
|
+
it('should preserve type information', () => {
|
|
60
|
+
interface TaskData {
|
|
61
|
+
id: string;
|
|
62
|
+
title: string;
|
|
63
|
+
}
|
|
64
|
+
const result: SuccessResult<TaskData> = success({ id: '1', title: 'Test' });
|
|
65
|
+
expect(result.result.id).toBe('1');
|
|
66
|
+
expect(result.result.title).toBe('Test');
|
|
67
|
+
});
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
describe('error', () => {
|
|
71
|
+
it('should create an error result with message only', () => {
|
|
72
|
+
const result = error('Something went wrong');
|
|
73
|
+
expect(result.result.error).toBe('Something went wrong');
|
|
74
|
+
expect(result.isError).toBe(true);
|
|
75
|
+
});
|
|
76
|
+
|
|
77
|
+
it('should create an error result with message and details', () => {
|
|
78
|
+
const result = error('Validation failed', { field: 'title', reason: 'too long' });
|
|
79
|
+
expect(result.result.error).toBe('Validation failed');
|
|
80
|
+
expect(result.result.field).toBe('title');
|
|
81
|
+
expect(result.result.reason).toBe('too long');
|
|
82
|
+
expect(result.isError).toBe(true);
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
it('should handle empty details object', () => {
|
|
86
|
+
const result = error('Error message', {});
|
|
87
|
+
expect(result.result.error).toBe('Error message');
|
|
88
|
+
expect(result.isError).toBe(true);
|
|
89
|
+
});
|
|
90
|
+
|
|
91
|
+
it('should handle complex details', () => {
|
|
92
|
+
const result = error('Multiple errors', {
|
|
93
|
+
errors: ['error1', 'error2'],
|
|
94
|
+
count: 2,
|
|
95
|
+
nested: { key: 'value' },
|
|
96
|
+
});
|
|
97
|
+
expect(result.result.error).toBe('Multiple errors');
|
|
98
|
+
expect(result.result.errors).toEqual(['error1', 'error2']);
|
|
99
|
+
expect(result.result.count).toBe(2);
|
|
100
|
+
expect(result.result.nested).toEqual({ key: 'value' });
|
|
101
|
+
});
|
|
102
|
+
|
|
103
|
+
it('should always set isError to true', () => {
|
|
104
|
+
const result1 = error('error1');
|
|
105
|
+
const result2 = error('error2', { detail: 'info' });
|
|
106
|
+
expect(result1.isError).toBe(true);
|
|
107
|
+
expect(result2.isError).toBe(true);
|
|
108
|
+
});
|
|
109
|
+
});
|
|
110
|
+
|
|
111
|
+
describe('isSuccess', () => {
|
|
112
|
+
it('should return true for success results', () => {
|
|
113
|
+
const result = success({ data: 'test' });
|
|
114
|
+
expect(isSuccess(result)).toBe(true);
|
|
115
|
+
});
|
|
116
|
+
|
|
117
|
+
it('should return true for success results with various data types', () => {
|
|
118
|
+
expect(isSuccess(success('string'))).toBe(true);
|
|
119
|
+
expect(isSuccess(success(123))).toBe(true);
|
|
120
|
+
expect(isSuccess(success(null))).toBe(true);
|
|
121
|
+
expect(isSuccess(success([]))).toBe(true);
|
|
122
|
+
expect(isSuccess(success({}))).toBe(true);
|
|
123
|
+
});
|
|
124
|
+
|
|
125
|
+
it('should return false for error results', () => {
|
|
126
|
+
const result = error('Something failed');
|
|
127
|
+
expect(isSuccess(result)).toBe(false);
|
|
128
|
+
});
|
|
129
|
+
|
|
130
|
+
it('should return false for error results with details', () => {
|
|
131
|
+
const result = error('Validation error', { field: 'name' });
|
|
132
|
+
expect(isSuccess(result)).toBe(false);
|
|
133
|
+
});
|
|
134
|
+
|
|
135
|
+
it('should narrow type correctly for success', () => {
|
|
136
|
+
const result: HandlerResult<{ id: string }> = success({ id: '123' });
|
|
137
|
+
if (isSuccess(result)) {
|
|
138
|
+
// TypeScript should know result.result is { id: string }
|
|
139
|
+
expect(result.result.id).toBe('123');
|
|
140
|
+
}
|
|
141
|
+
});
|
|
142
|
+
|
|
143
|
+
it('should work with explicitly typed results', () => {
|
|
144
|
+
const successResult: SuccessResult<number> = { result: 42 };
|
|
145
|
+
const errorResult: ErrorResult = { result: { error: 'fail' }, isError: true };
|
|
146
|
+
|
|
147
|
+
expect(isSuccess(successResult)).toBe(true);
|
|
148
|
+
expect(isSuccess(errorResult)).toBe(false);
|
|
149
|
+
});
|
|
150
|
+
});
|
|
151
|
+
|
|
152
|
+
describe('isError', () => {
|
|
153
|
+
it('should return true for error results', () => {
|
|
154
|
+
const result = error('Something failed');
|
|
155
|
+
expect(isError(result)).toBe(true);
|
|
156
|
+
});
|
|
157
|
+
|
|
158
|
+
it('should return true for error results with details', () => {
|
|
159
|
+
const result = error('Validation error', { field: 'name', code: 'INVALID' });
|
|
160
|
+
expect(isError(result)).toBe(true);
|
|
161
|
+
});
|
|
162
|
+
|
|
163
|
+
it('should return false for success results', () => {
|
|
164
|
+
const result = success({ data: 'test' });
|
|
165
|
+
expect(isError(result)).toBe(false);
|
|
166
|
+
});
|
|
167
|
+
|
|
168
|
+
it('should return false for success results with various data types', () => {
|
|
169
|
+
expect(isError(success('string'))).toBe(false);
|
|
170
|
+
expect(isError(success(123))).toBe(false);
|
|
171
|
+
expect(isError(success(null))).toBe(false);
|
|
172
|
+
expect(isError(success([]))).toBe(false);
|
|
173
|
+
expect(isError(success({}))).toBe(false);
|
|
174
|
+
});
|
|
175
|
+
|
|
176
|
+
it('should narrow type correctly for error', () => {
|
|
177
|
+
const result: HandlerResult<unknown> = error('Task not found');
|
|
178
|
+
if (isError(result)) {
|
|
179
|
+
// TypeScript should know result.result.error is string
|
|
180
|
+
expect(result.result.error).toBe('Task not found');
|
|
181
|
+
}
|
|
182
|
+
});
|
|
183
|
+
|
|
184
|
+
it('should work with explicitly typed results', () => {
|
|
185
|
+
const successResult: SuccessResult<number> = { result: 42 };
|
|
186
|
+
const errorResult: ErrorResult = { result: { error: 'fail' }, isError: true };
|
|
187
|
+
|
|
188
|
+
expect(isError(successResult)).toBe(false);
|
|
189
|
+
expect(isError(errorResult)).toBe(true);
|
|
190
|
+
});
|
|
191
|
+
});
|
|
192
|
+
|
|
193
|
+
describe('HandlerResult type usage', () => {
|
|
194
|
+
it('should work with discriminated union pattern', () => {
|
|
195
|
+
function processResult(result: HandlerResult<string>): string {
|
|
196
|
+
if (isSuccess(result)) {
|
|
197
|
+
return `Success: ${result.result}`;
|
|
198
|
+
} else {
|
|
199
|
+
return `Error: ${result.result.error}`;
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
expect(processResult(success('hello'))).toBe('Success: hello');
|
|
204
|
+
expect(processResult(error('failed'))).toBe('Error: failed');
|
|
205
|
+
});
|
|
206
|
+
|
|
207
|
+
it('should handle async handler patterns', async () => {
|
|
208
|
+
async function mockHandler(): Promise<HandlerResult<{ id: string }>> {
|
|
209
|
+
return success({ id: '123' });
|
|
210
|
+
}
|
|
211
|
+
|
|
212
|
+
const result = await mockHandler();
|
|
213
|
+
expect(isSuccess(result)).toBe(true);
|
|
214
|
+
if (isSuccess(result)) {
|
|
215
|
+
expect(result.result.id).toBe('123');
|
|
216
|
+
}
|
|
217
|
+
});
|
|
218
|
+
|
|
219
|
+
it('should handle error handler patterns', async () => {
|
|
220
|
+
async function mockErrorHandler(): Promise<HandlerResult<{ id: string }>> {
|
|
221
|
+
return error('Not found', { id: '123' });
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
const result = await mockErrorHandler();
|
|
225
|
+
expect(isError(result)).toBe(true);
|
|
226
|
+
if (isError(result)) {
|
|
227
|
+
expect(result.result.error).toBe('Not found');
|
|
228
|
+
expect(result.result.id).toBe('123');
|
|
229
|
+
}
|
|
230
|
+
});
|
|
231
|
+
});
|
|
232
|
+
|
|
233
|
+
describe('edge cases', () => {
|
|
234
|
+
it('should handle result with isError explicitly set to false', () => {
|
|
235
|
+
const result: SuccessResult<string> = { result: 'data', isError: false };
|
|
236
|
+
expect(isSuccess(result)).toBe(true);
|
|
237
|
+
expect(isError(result)).toBe(false);
|
|
238
|
+
});
|
|
239
|
+
|
|
240
|
+
it('should handle result without isError property', () => {
|
|
241
|
+
const result: SuccessResult<string> = { result: 'data' };
|
|
242
|
+
expect(isSuccess(result)).toBe(true);
|
|
243
|
+
expect(isError(result)).toBe(false);
|
|
244
|
+
});
|
|
245
|
+
|
|
246
|
+
it('should handle success with error-like data', () => {
|
|
247
|
+
// A success result that happens to contain an error message in its data
|
|
248
|
+
const result = success({ error: 'This is not an error result', data: 'some data' });
|
|
249
|
+
expect(isSuccess(result)).toBe(true);
|
|
250
|
+
expect(isError(result)).toBe(false);
|
|
251
|
+
});
|
|
252
|
+
|
|
253
|
+
it('should handle empty string error message', () => {
|
|
254
|
+
const result = error('');
|
|
255
|
+
expect(result.result.error).toBe('');
|
|
256
|
+
expect(result.isError).toBe(true);
|
|
257
|
+
expect(isError(result)).toBe(true);
|
|
258
|
+
});
|
|
259
|
+
});
|