@bernierllc/braingrid-cli-wrapper 0.1.1 → 0.3.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.
Files changed (57) hide show
  1. package/CHANGELOG.md +43 -0
  2. package/README.md +102 -11
  3. package/dist/commands/createProject.d.ts +8 -0
  4. package/dist/commands/createProject.js +31 -0
  5. package/dist/commands/listRequirements.d.ts +7 -0
  6. package/dist/commands/listRequirements.js +32 -0
  7. package/dist/commands/updateRequirementStatus.d.ts +8 -0
  8. package/dist/commands/updateRequirementStatus.js +29 -0
  9. package/dist/index.d.ts +3 -0
  10. package/dist/index.js +7 -1
  11. package/jest.config.cjs +0 -1
  12. package/package.json +5 -1
  13. package/src/__tests__/index.test.ts +77 -0
  14. package/src/commands/createProject.test.ts +75 -0
  15. package/src/commands/createProject.ts +37 -0
  16. package/src/commands/listRequirements.test.ts +89 -0
  17. package/src/commands/listRequirements.ts +37 -0
  18. package/src/commands/updateRequirementStatus.test.ts +85 -0
  19. package/src/commands/updateRequirementStatus.ts +33 -0
  20. package/src/index.ts +3 -0
  21. package/coverage/base.css +0 -224
  22. package/coverage/block-navigation.js +0 -87
  23. package/coverage/favicon.png +0 -0
  24. package/coverage/index.html +0 -131
  25. package/coverage/lcov-report/base.css +0 -224
  26. package/coverage/lcov-report/block-navigation.js +0 -87
  27. package/coverage/lcov-report/favicon.png +0 -0
  28. package/coverage/lcov-report/index.html +0 -131
  29. package/coverage/lcov-report/prettify.css +0 -1
  30. package/coverage/lcov-report/prettify.js +0 -2
  31. package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
  32. package/coverage/lcov-report/sorter.js +0 -210
  33. package/coverage/lcov-report/src/cli.ts.html +0 -298
  34. package/coverage/lcov-report/src/commands/createIdea.ts.html +0 -193
  35. package/coverage/lcov-report/src/commands/createTask.ts.html +0 -235
  36. package/coverage/lcov-report/src/commands/index.html +0 -176
  37. package/coverage/lcov-report/src/commands/listProjects.ts.html +0 -160
  38. package/coverage/lcov-report/src/commands/listTasks.ts.html +0 -226
  39. package/coverage/lcov-report/src/commands/updateTaskStatus.ts.html +0 -205
  40. package/coverage/lcov-report/src/index.html +0 -146
  41. package/coverage/lcov-report/src/index.ts.html +0 -172
  42. package/coverage/lcov-report/src/models.ts.html +0 -364
  43. package/coverage/lcov.info +0 -240
  44. package/coverage/prettify.css +0 -1
  45. package/coverage/prettify.js +0 -2
  46. package/coverage/sort-arrow-sprite.png +0 -0
  47. package/coverage/sorter.js +0 -210
  48. package/coverage/src/cli.ts.html +0 -298
  49. package/coverage/src/commands/createIdea.ts.html +0 -193
  50. package/coverage/src/commands/createTask.ts.html +0 -235
  51. package/coverage/src/commands/index.html +0 -176
  52. package/coverage/src/commands/listProjects.ts.html +0 -160
  53. package/coverage/src/commands/listTasks.ts.html +0 -226
  54. package/coverage/src/commands/updateTaskStatus.ts.html +0 -205
  55. package/coverage/src/index.html +0 -146
  56. package/coverage/src/index.ts.html +0 -172
  57. package/coverage/src/models.ts.html +0 -364
@@ -0,0 +1,89 @@
1
+ /*
2
+ Copyright (c) 2025 Bernier LLC
3
+
4
+ This file is licensed to the client under a limited-use license.
5
+ The client may use and modify this code *only within the scope of the project it was delivered for*.
6
+ Redistribution or use in other products or commercial offerings is not permitted without written consent from Bernier LLC.
7
+ */
8
+
9
+ import { listRequirements } from './listRequirements';
10
+
11
+ jest.mock('../cli', () => ({
12
+ runBrainGridCommand: jest.fn()
13
+ }));
14
+
15
+ import { runBrainGridCommand } from '../cli';
16
+
17
+ describe('listRequirements', () => {
18
+ beforeEach(() => {
19
+ jest.clearAllMocks();
20
+ });
21
+
22
+ it('should list all requirements', async () => {
23
+ const mockRequirements = [
24
+ {
25
+ id: 'req-1',
26
+ projectId: 'proj-1',
27
+ title: 'Requirement 1',
28
+ status: 'IDEA'
29
+ },
30
+ {
31
+ id: 'req-2',
32
+ projectId: 'proj-1',
33
+ title: 'Requirement 2',
34
+ status: 'PLANNED'
35
+ }
36
+ ];
37
+
38
+ (runBrainGridCommand as jest.MockedFunction<typeof runBrainGridCommand>).mockResolvedValue(mockRequirements);
39
+
40
+ const result = await listRequirements();
41
+
42
+ expect(runBrainGridCommand).toHaveBeenCalledWith([
43
+ 'requirement',
44
+ 'list',
45
+ '--format',
46
+ 'json'
47
+ ]);
48
+ expect(result).toEqual(mockRequirements);
49
+ });
50
+
51
+ it('should list requirements for a specific project', async () => {
52
+ const mockRequirements = [
53
+ {
54
+ id: 'req-1',
55
+ projectId: 'proj-123',
56
+ title: 'Requirement 1',
57
+ status: 'IDEA'
58
+ }
59
+ ];
60
+
61
+ (runBrainGridCommand as jest.MockedFunction<typeof runBrainGridCommand>).mockResolvedValue(mockRequirements);
62
+
63
+ const result = await listRequirements('proj-123');
64
+
65
+ expect(runBrainGridCommand).toHaveBeenCalledWith([
66
+ 'requirement',
67
+ 'list',
68
+ '--format',
69
+ 'json',
70
+ '--project',
71
+ 'proj-123'
72
+ ]);
73
+ expect(result).toEqual(mockRequirements);
74
+ });
75
+
76
+ it('should return empty array when no requirements exist', async () => {
77
+ (runBrainGridCommand as jest.MockedFunction<typeof runBrainGridCommand>).mockResolvedValue([]);
78
+
79
+ const result = await listRequirements();
80
+
81
+ expect(result).toEqual([]);
82
+ });
83
+
84
+ it('should throw on invalid response', async () => {
85
+ (runBrainGridCommand as jest.MockedFunction<typeof runBrainGridCommand>).mockResolvedValue([{ invalid: 'data' }]);
86
+
87
+ await expect(listRequirements()).rejects.toThrow();
88
+ });
89
+ });
@@ -0,0 +1,37 @@
1
+ /*
2
+ Copyright (c) 2025 Bernier LLC
3
+
4
+ This file is licensed to the client under a limited-use license.
5
+ The client may use and modify this code *only within the scope of the project it was delivered for*.
6
+ Redistribution or use in other products or commercial offerings is not permitted without written consent from Bernier LLC.
7
+ */
8
+
9
+ import { runBrainGridCommand } from '../cli';
10
+ import { BrainGridRequirement, BrainGridRequirementSchema } from '../models';
11
+ import { z } from 'zod';
12
+
13
+ /**
14
+ * Lists BrainGrid requirements
15
+ * @param projectId - Optional project ID to filter requirements
16
+ * @returns Promise resolving to array of requirements
17
+ */
18
+ export async function listRequirements(
19
+ projectId?: string
20
+ ): Promise<BrainGridRequirement[]> {
21
+ const args = ['requirement', 'list', '--format', 'json'];
22
+
23
+ if (projectId) {
24
+ args.push('--project', projectId);
25
+ }
26
+
27
+ const result = await runBrainGridCommand(args);
28
+
29
+ // Validate response
30
+ const schema = z.array(BrainGridRequirementSchema);
31
+ const parsed = schema.safeParse(result);
32
+ if (!parsed.success) {
33
+ throw new Error(`Invalid BrainGrid response: ${parsed.error.message}`);
34
+ }
35
+
36
+ return parsed.data;
37
+ }
@@ -0,0 +1,85 @@
1
+ /*
2
+ Copyright (c) 2025 Bernier LLC
3
+
4
+ This file is licensed to the client under a limited-use license.
5
+ The client may use and modify this code *only within the scope of the project it was delivered for*.
6
+ Redistribution or use in other products or commercial offerings is not permitted without written consent from Bernier LLC.
7
+ */
8
+
9
+ import { updateRequirementStatus } from './updateRequirementStatus';
10
+
11
+ jest.mock('../cli', () => ({
12
+ runBrainGridCommand: jest.fn()
13
+ }));
14
+
15
+ import { runBrainGridCommand } from '../cli';
16
+
17
+ describe('updateRequirementStatus', () => {
18
+ beforeEach(() => {
19
+ jest.clearAllMocks();
20
+ });
21
+
22
+ it('should update requirement status to PLANNED', async () => {
23
+ (runBrainGridCommand as jest.MockedFunction<typeof runBrainGridCommand>).mockResolvedValue({});
24
+
25
+ await updateRequirementStatus('req-123', 'PLANNED');
26
+
27
+ expect(runBrainGridCommand).toHaveBeenCalledWith([
28
+ 'requirement',
29
+ 'update',
30
+ 'req-123',
31
+ '--status',
32
+ 'PLANNED',
33
+ '--format',
34
+ 'json'
35
+ ]);
36
+ });
37
+
38
+ it('should update requirement status to IN_PROGRESS', async () => {
39
+ (runBrainGridCommand as jest.MockedFunction<typeof runBrainGridCommand>).mockResolvedValue({});
40
+
41
+ await updateRequirementStatus('req-456', 'IN_PROGRESS');
42
+
43
+ expect(runBrainGridCommand).toHaveBeenCalledWith([
44
+ 'requirement',
45
+ 'update',
46
+ 'req-456',
47
+ '--status',
48
+ 'IN_PROGRESS',
49
+ '--format',
50
+ 'json'
51
+ ]);
52
+ });
53
+
54
+ it('should update requirement status to COMPLETED', async () => {
55
+ (runBrainGridCommand as jest.MockedFunction<typeof runBrainGridCommand>).mockResolvedValue({});
56
+
57
+ await updateRequirementStatus('req-789', 'COMPLETED');
58
+
59
+ expect(runBrainGridCommand).toHaveBeenCalledWith([
60
+ 'requirement',
61
+ 'update',
62
+ 'req-789',
63
+ '--status',
64
+ 'COMPLETED',
65
+ '--format',
66
+ 'json'
67
+ ]);
68
+ });
69
+
70
+ it('should update requirement status to CANCELLED', async () => {
71
+ (runBrainGridCommand as jest.MockedFunction<typeof runBrainGridCommand>).mockResolvedValue({});
72
+
73
+ await updateRequirementStatus('req-999', 'CANCELLED');
74
+
75
+ expect(runBrainGridCommand).toHaveBeenCalledWith([
76
+ 'requirement',
77
+ 'update',
78
+ 'req-999',
79
+ '--status',
80
+ 'CANCELLED',
81
+ '--format',
82
+ 'json'
83
+ ]);
84
+ });
85
+ });
@@ -0,0 +1,33 @@
1
+ /*
2
+ Copyright (c) 2025 Bernier LLC
3
+
4
+ This file is licensed to the client under a limited-use license.
5
+ The client may use and modify this code *only within the scope of the project it was delivered for*.
6
+ Redistribution or use in other products or commercial offerings is not permitted without written consent from Bernier LLC.
7
+ */
8
+
9
+ import { runBrainGridCommand } from '../cli';
10
+ import { RequirementStatus } from '../models';
11
+
12
+ /**
13
+ * Updates a requirement's status
14
+ * @param requirementId - Requirement ID to update
15
+ * @param status - New status to set
16
+ * @returns Promise resolving when update is complete
17
+ */
18
+ export async function updateRequirementStatus(
19
+ requirementId: string,
20
+ status: RequirementStatus
21
+ ): Promise<void> {
22
+ const args = [
23
+ 'requirement',
24
+ 'update',
25
+ requirementId,
26
+ '--status',
27
+ status,
28
+ '--format',
29
+ 'json'
30
+ ];
31
+
32
+ await runBrainGridCommand(args);
33
+ }
package/src/index.ts CHANGED
@@ -24,6 +24,9 @@ export {
24
24
  // Export commands
25
25
  export { createIdea } from './commands/createIdea';
26
26
  export { listProjects } from './commands/listProjects';
27
+ export { createProject } from './commands/createProject';
28
+ export { listRequirements } from './commands/listRequirements';
29
+ export { updateRequirementStatus } from './commands/updateRequirementStatus';
27
30
  export { createTask, CreateTaskOptions } from './commands/createTask';
28
31
  export { updateTaskStatus, UpdateTaskOptions } from './commands/updateTaskStatus';
29
32
  export { listTasks, ListTasksOptions } from './commands/listTasks';
package/coverage/base.css DELETED
@@ -1,224 +0,0 @@
1
- body, html {
2
- margin:0; padding: 0;
3
- height: 100%;
4
- }
5
- body {
6
- font-family: Helvetica Neue, Helvetica, Arial;
7
- font-size: 14px;
8
- color:#333;
9
- }
10
- .small { font-size: 12px; }
11
- *, *:after, *:before {
12
- -webkit-box-sizing:border-box;
13
- -moz-box-sizing:border-box;
14
- box-sizing:border-box;
15
- }
16
- h1 { font-size: 20px; margin: 0;}
17
- h2 { font-size: 14px; }
18
- pre {
19
- font: 12px/1.4 Consolas, "Liberation Mono", Menlo, Courier, monospace;
20
- margin: 0;
21
- padding: 0;
22
- -moz-tab-size: 2;
23
- -o-tab-size: 2;
24
- tab-size: 2;
25
- }
26
- a { color:#0074D9; text-decoration:none; }
27
- a:hover { text-decoration:underline; }
28
- .strong { font-weight: bold; }
29
- .space-top1 { padding: 10px 0 0 0; }
30
- .pad2y { padding: 20px 0; }
31
- .pad1y { padding: 10px 0; }
32
- .pad2x { padding: 0 20px; }
33
- .pad2 { padding: 20px; }
34
- .pad1 { padding: 10px; }
35
- .space-left2 { padding-left:55px; }
36
- .space-right2 { padding-right:20px; }
37
- .center { text-align:center; }
38
- .clearfix { display:block; }
39
- .clearfix:after {
40
- content:'';
41
- display:block;
42
- height:0;
43
- clear:both;
44
- visibility:hidden;
45
- }
46
- .fl { float: left; }
47
- @media only screen and (max-width:640px) {
48
- .col3 { width:100%; max-width:100%; }
49
- .hide-mobile { display:none!important; }
50
- }
51
-
52
- .quiet {
53
- color: #7f7f7f;
54
- color: rgba(0,0,0,0.5);
55
- }
56
- .quiet a { opacity: 0.7; }
57
-
58
- .fraction {
59
- font-family: Consolas, 'Liberation Mono', Menlo, Courier, monospace;
60
- font-size: 10px;
61
- color: #555;
62
- background: #E8E8E8;
63
- padding: 4px 5px;
64
- border-radius: 3px;
65
- vertical-align: middle;
66
- }
67
-
68
- div.path a:link, div.path a:visited { color: #333; }
69
- table.coverage {
70
- border-collapse: collapse;
71
- margin: 10px 0 0 0;
72
- padding: 0;
73
- }
74
-
75
- table.coverage td {
76
- margin: 0;
77
- padding: 0;
78
- vertical-align: top;
79
- }
80
- table.coverage td.line-count {
81
- text-align: right;
82
- padding: 0 5px 0 20px;
83
- }
84
- table.coverage td.line-coverage {
85
- text-align: right;
86
- padding-right: 10px;
87
- min-width:20px;
88
- }
89
-
90
- table.coverage td span.cline-any {
91
- display: inline-block;
92
- padding: 0 5px;
93
- width: 100%;
94
- }
95
- .missing-if-branch {
96
- display: inline-block;
97
- margin-right: 5px;
98
- border-radius: 3px;
99
- position: relative;
100
- padding: 0 4px;
101
- background: #333;
102
- color: yellow;
103
- }
104
-
105
- .skip-if-branch {
106
- display: none;
107
- margin-right: 10px;
108
- position: relative;
109
- padding: 0 4px;
110
- background: #ccc;
111
- color: white;
112
- }
113
- .missing-if-branch .typ, .skip-if-branch .typ {
114
- color: inherit !important;
115
- }
116
- .coverage-summary {
117
- border-collapse: collapse;
118
- width: 100%;
119
- }
120
- .coverage-summary tr { border-bottom: 1px solid #bbb; }
121
- .keyline-all { border: 1px solid #ddd; }
122
- .coverage-summary td, .coverage-summary th { padding: 10px; }
123
- .coverage-summary tbody { border: 1px solid #bbb; }
124
- .coverage-summary td { border-right: 1px solid #bbb; }
125
- .coverage-summary td:last-child { border-right: none; }
126
- .coverage-summary th {
127
- text-align: left;
128
- font-weight: normal;
129
- white-space: nowrap;
130
- }
131
- .coverage-summary th.file { border-right: none !important; }
132
- .coverage-summary th.pct { }
133
- .coverage-summary th.pic,
134
- .coverage-summary th.abs,
135
- .coverage-summary td.pct,
136
- .coverage-summary td.abs { text-align: right; }
137
- .coverage-summary td.file { white-space: nowrap; }
138
- .coverage-summary td.pic { min-width: 120px !important; }
139
- .coverage-summary tfoot td { }
140
-
141
- .coverage-summary .sorter {
142
- height: 10px;
143
- width: 7px;
144
- display: inline-block;
145
- margin-left: 0.5em;
146
- background: url(sort-arrow-sprite.png) no-repeat scroll 0 0 transparent;
147
- }
148
- .coverage-summary .sorted .sorter {
149
- background-position: 0 -20px;
150
- }
151
- .coverage-summary .sorted-desc .sorter {
152
- background-position: 0 -10px;
153
- }
154
- .status-line { height: 10px; }
155
- /* yellow */
156
- .cbranch-no { background: yellow !important; color: #111; }
157
- /* dark red */
158
- .red.solid, .status-line.low, .low .cover-fill { background:#C21F39 }
159
- .low .chart { border:1px solid #C21F39 }
160
- .highlighted,
161
- .highlighted .cstat-no, .highlighted .fstat-no, .highlighted .cbranch-no{
162
- background: #C21F39 !important;
163
- }
164
- /* medium red */
165
- .cstat-no, .fstat-no, .cbranch-no, .cbranch-no { background:#F6C6CE }
166
- /* light red */
167
- .low, .cline-no { background:#FCE1E5 }
168
- /* light green */
169
- .high, .cline-yes { background:rgb(230,245,208) }
170
- /* medium green */
171
- .cstat-yes { background:rgb(161,215,106) }
172
- /* dark green */
173
- .status-line.high, .high .cover-fill { background:rgb(77,146,33) }
174
- .high .chart { border:1px solid rgb(77,146,33) }
175
- /* dark yellow (gold) */
176
- .status-line.medium, .medium .cover-fill { background: #f9cd0b; }
177
- .medium .chart { border:1px solid #f9cd0b; }
178
- /* light yellow */
179
- .medium { background: #fff4c2; }
180
-
181
- .cstat-skip { background: #ddd; color: #111; }
182
- .fstat-skip { background: #ddd; color: #111 !important; }
183
- .cbranch-skip { background: #ddd !important; color: #111; }
184
-
185
- span.cline-neutral { background: #eaeaea; }
186
-
187
- .coverage-summary td.empty {
188
- opacity: .5;
189
- padding-top: 4px;
190
- padding-bottom: 4px;
191
- line-height: 1;
192
- color: #888;
193
- }
194
-
195
- .cover-fill, .cover-empty {
196
- display:inline-block;
197
- height: 12px;
198
- }
199
- .chart {
200
- line-height: 0;
201
- }
202
- .cover-empty {
203
- background: white;
204
- }
205
- .cover-full {
206
- border-right: none !important;
207
- }
208
- pre.prettyprint {
209
- border: none !important;
210
- padding: 0 !important;
211
- margin: 0 !important;
212
- }
213
- .com { color: #999 !important; }
214
- .ignore-none { color: #999; font-weight: normal; }
215
-
216
- .wrapper {
217
- min-height: 100%;
218
- height: auto !important;
219
- height: 100%;
220
- margin: 0 auto -48px;
221
- }
222
- .footer, .push {
223
- height: 48px;
224
- }
@@ -1,87 +0,0 @@
1
- /* eslint-disable */
2
- var jumpToCode = (function init() {
3
- // Classes of code we would like to highlight in the file view
4
- var missingCoverageClasses = ['.cbranch-no', '.cstat-no', '.fstat-no'];
5
-
6
- // Elements to highlight in the file listing view
7
- var fileListingElements = ['td.pct.low'];
8
-
9
- // We don't want to select elements that are direct descendants of another match
10
- var notSelector = ':not(' + missingCoverageClasses.join('):not(') + ') > '; // becomes `:not(a):not(b) > `
11
-
12
- // Selector that finds elements on the page to which we can jump
13
- var selector =
14
- fileListingElements.join(', ') +
15
- ', ' +
16
- notSelector +
17
- missingCoverageClasses.join(', ' + notSelector); // becomes `:not(a):not(b) > a, :not(a):not(b) > b`
18
-
19
- // The NodeList of matching elements
20
- var missingCoverageElements = document.querySelectorAll(selector);
21
-
22
- var currentIndex;
23
-
24
- function toggleClass(index) {
25
- missingCoverageElements
26
- .item(currentIndex)
27
- .classList.remove('highlighted');
28
- missingCoverageElements.item(index).classList.add('highlighted');
29
- }
30
-
31
- function makeCurrent(index) {
32
- toggleClass(index);
33
- currentIndex = index;
34
- missingCoverageElements.item(index).scrollIntoView({
35
- behavior: 'smooth',
36
- block: 'center',
37
- inline: 'center'
38
- });
39
- }
40
-
41
- function goToPrevious() {
42
- var nextIndex = 0;
43
- if (typeof currentIndex !== 'number' || currentIndex === 0) {
44
- nextIndex = missingCoverageElements.length - 1;
45
- } else if (missingCoverageElements.length > 1) {
46
- nextIndex = currentIndex - 1;
47
- }
48
-
49
- makeCurrent(nextIndex);
50
- }
51
-
52
- function goToNext() {
53
- var nextIndex = 0;
54
-
55
- if (
56
- typeof currentIndex === 'number' &&
57
- currentIndex < missingCoverageElements.length - 1
58
- ) {
59
- nextIndex = currentIndex + 1;
60
- }
61
-
62
- makeCurrent(nextIndex);
63
- }
64
-
65
- return function jump(event) {
66
- if (
67
- document.getElementById('fileSearch') === document.activeElement &&
68
- document.activeElement != null
69
- ) {
70
- // if we're currently focused on the search input, we don't want to navigate
71
- return;
72
- }
73
-
74
- switch (event.which) {
75
- case 78: // n
76
- case 74: // j
77
- goToNext();
78
- break;
79
- case 66: // b
80
- case 75: // k
81
- case 80: // p
82
- goToPrevious();
83
- break;
84
- }
85
- };
86
- })();
87
- window.addEventListener('keydown', jumpToCode);
Binary file