@contextrail/assess 0.0.0-stage → 1.0.0-alpha.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.
- package/LICENSE +202 -0
- package/README.md +82 -2
- package/assets/brand/icon-dark.png +0 -0
- package/assets/brand/icon-light.png +0 -0
- package/dist/assess.d.ts +109 -0
- package/dist/assess.js +1548 -0
- package/dist/assessment.d.ts +566 -0
- package/dist/assessment.js +404 -0
- package/dist/budget.d.ts +24 -0
- package/dist/budget.js +52 -0
- package/dist/candidate.d.ts +147 -0
- package/dist/candidate.js +321 -0
- package/dist/change-summary.d.ts +33 -0
- package/dist/change-summary.js +26 -0
- package/dist/cli.d.ts +2 -0
- package/dist/cli.js +406 -0
- package/dist/contracts.d.ts +99 -0
- package/dist/contracts.js +62 -0
- package/dist/diagnostics.d.ts +44 -0
- package/dist/diagnostics.js +412 -0
- package/dist/evidence.d.ts +73 -0
- package/dist/evidence.js +297 -0
- package/dist/feedback.d.ts +21 -0
- package/dist/feedback.js +140 -0
- package/dist/git.d.ts +40 -0
- package/dist/git.js +207 -0
- package/dist/github.d.ts +90 -0
- package/dist/github.js +1342 -0
- package/dist/index.d.ts +14 -0
- package/dist/index.js +14 -0
- package/dist/mcp.d.ts +28 -0
- package/dist/mcp.js +173 -0
- package/dist/pack.d.ts +160 -0
- package/dist/pack.js +377 -0
- package/dist/phases.d.ts +65 -0
- package/dist/phases.js +63 -0
- package/dist/planning.d.ts +64 -0
- package/dist/planning.js +135 -0
- package/dist/pr-context.d.ts +316 -0
- package/dist/pr-context.js +198 -0
- package/dist/prepare.d.ts +71 -0
- package/dist/prepare.js +335 -0
- package/dist/presentation.d.ts +309 -0
- package/dist/presentation.js +1026 -0
- package/dist/provider-diagnostics.d.ts +93 -0
- package/dist/provider-diagnostics.js +233 -0
- package/dist/providers.d.ts +45 -0
- package/dist/providers.js +291 -0
- package/dist/report-contract.d.ts +132 -0
- package/dist/report-contract.js +240 -0
- package/dist/results.d.ts +90 -0
- package/dist/results.js +128 -0
- package/dist/resume.d.ts +25 -0
- package/dist/resume.js +116 -0
- package/dist/source.d.ts +167 -0
- package/dist/source.js +675 -0
- package/dist/verification.d.ts +386 -0
- package/dist/verification.js +168 -0
- package/dist/version.d.ts +2 -0
- package/dist/version.js +9 -0
- package/docs/README.md +24 -0
- package/docs/action-reference.md +85 -0
- package/docs/architecture.md +156 -0
- package/docs/configuration.md +83 -0
- package/docs/contributing.md +46 -0
- package/docs/getting-started.md +92 -0
- package/docs/github-actions.md +141 -0
- package/docs/operations.md +203 -0
- package/docs/review-results.md +173 -0
- package/docs/security.md +64 -0
- package/docs/standards.md +62 -0
- package/examples/assess-pull-request.yml +109 -0
- package/package.json +56 -5
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
CHANGED
|
@@ -1,3 +1,83 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ContextRail Assess
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[](https://www.npmjs.com/package/@contextrail/assess)
|
|
4
|
+
[](https://www.npmjs.com/package/@contextrail/assess?activeTab=versions)
|
|
5
|
+
|
|
6
|
+
**Your experts set the standards. Bring them into the work.**
|
|
7
|
+
|
|
8
|
+
ContextRail brings your experts’ guidance into the tools where teams work. Experts maintain and
|
|
9
|
+
publish that knowledge; people and AI agents retrieve it to inform their decisions.
|
|
10
|
+
|
|
11
|
+
**ContextRail Assess is the platform’s standards assessment tool.** It checks proposed code,
|
|
12
|
+
configuration and documentation against your organization’s selected published guidance. Developers
|
|
13
|
+
get findings they can act on. When runs report back, standards owners see in ContextRail which of
|
|
14
|
+
their standards were applied, at which version, and which outcomes stayed unresolved—a prompt to
|
|
15
|
+
check whether the guidance needs clarifying. Teams retain which standards were assessed, the exact
|
|
16
|
+
versions used, the evidence and any unanswered questions.
|
|
17
|
+
|
|
18
|
+
[Run your first assessment](docs/getting-started.md) · [Set up GitHub Actions](docs/github-actions.md) · [Explore ContextRail](https://contextrail.app/product)
|
|
19
|
+
|
|
20
|
+
## What a finding looks like
|
|
21
|
+
|
|
22
|
+
An illustrative example—not a captured assessment:
|
|
23
|
+
|
|
24
|
+
> **Standard:** Every release workflow must require the quality checks before deployment.
|
|
25
|
+
>
|
|
26
|
+
> **Proposed change:** The deploy job's dependency on the quality gate is removed.
|
|
27
|
+
>
|
|
28
|
+
> **Finding:** `deploy.yml:42` allows deployment without waiting for the required checks.
|
|
29
|
+
> Restore the dependency on the quality gate. Basis: the selected delivery standard, version 3.
|
|
30
|
+
|
|
31
|
+
Assess examines the proposed workflow. Whether today's CI run is green is a separate question.
|
|
32
|
+
It applies the standards you select, rather than treating every possible code improvement as a finding.
|
|
33
|
+
|
|
34
|
+
## From shared expertise to assessment feedback
|
|
35
|
+
|
|
36
|
+
1. **Experts publish the guidance in ContextRail.** A reviewer skill selects the contexts to consider.
|
|
37
|
+
Feedback can inform changes; ignored findings do not automatically switch standards off.
|
|
38
|
+
2. **Teams apply that guidance while doing the work.** Connected tools retrieve published guidance
|
|
39
|
+
and reusable skills through MCP. The same expert-owned knowledge can inform creation and assessment.
|
|
40
|
+
3. **Assess pins the code and guidance versions for the run.** It inspects the proposed changes and
|
|
41
|
+
can read supporting source. Nominated concerns receive independent model validation.
|
|
42
|
+
4. **Developers see what needs attention.** A compact PR comment shows findings, unresolved questions
|
|
43
|
+
and a change overview. Optional inline comments include eligible code suggestions.
|
|
44
|
+
5. **Teams keep the assessment record.** Every enumerated standard has a recorded outcome, including
|
|
45
|
+
unresolved or not evaluated. Detailed evidence stays in your run artifacts; structured outcome
|
|
46
|
+
metadata can return to ContextRail.
|
|
47
|
+
|
|
48
|
+
“No concern identified” is an observation, not independently verified compliance. Missing scope,
|
|
49
|
+
unfinished assessments and execution failures remain visible. Assess does not run your test suite
|
|
50
|
+
or certify deployment readiness.
|
|
51
|
+
|
|
52
|
+
## Start where you work
|
|
53
|
+
|
|
54
|
+
You need Node 22.18.0+, Git 2.45+, ContextRail MCP access, a published reviewer skill with selected
|
|
55
|
+
contexts, and an OpenAI or OpenRouter API key. [Standards setup](docs/standards.md) explains the
|
|
56
|
+
ContextRail side before you install anything.
|
|
57
|
+
|
|
58
|
+
| Your task | Start here |
|
|
59
|
+
| ------------------------------------------------- | -------------------------------------------------- |
|
|
60
|
+
| Try one Git comparison locally | [First assessment](docs/getting-started.md) |
|
|
61
|
+
| Add assessment to pull requests | [GitHub Actions](docs/github-actions.md) |
|
|
62
|
+
| Understand a finding or unresolved question | [Results and next actions](docs/review-results.md) |
|
|
63
|
+
| Choose models, logging and limits | [Configuration](docs/configuration.md) |
|
|
64
|
+
| Evaluate source access, retention and credentials | [Security and data handling](docs/security.md) |
|
|
65
|
+
| Diagnose an incomplete or failed run | [Operations](docs/operations.md) |
|
|
66
|
+
|
|
67
|
+
Start in **advisory** mode. Choose **required** to gate supported binding violations, or **strict**
|
|
68
|
+
to also gate unresolved evidence. Execution failures remain failures in every mode.
|
|
69
|
+
|
|
70
|
+
Source excerpts and selected guidance are sent to your chosen model provider. Detailed source,
|
|
71
|
+
quotes and conversations are not included in ContextRail's assessment-feedback payload.
|
|
72
|
+
See [where data goes](docs/security.md) before connecting a repository.
|
|
73
|
+
|
|
74
|
+
## Package and platform
|
|
75
|
+
|
|
76
|
+
Assess is an open-source execution tool for the ContextRail platform. Your organization maintains
|
|
77
|
+
and publishes guidance in ContextRail; this package retrieves it through MCP and assesses work in
|
|
78
|
+
your local or CI environment. The [documentation index](docs/README.md) routes to setup, reference
|
|
79
|
+
and architecture without requiring you to read the whole manual.
|
|
80
|
+
|
|
81
|
+
[Apache-2.0](LICENSE) covers the package, Action and documentation. ContextRail services and
|
|
82
|
+
retrieved organizational guidance have separate terms. The public [Assess repository](https://github.com/contextrail/assess)
|
|
83
|
+
is a distribution mirror; see [contributing and releases](docs/contributing.md).
|
|
Binary file
|
|
Binary file
|
package/dist/assess.d.ts
ADDED
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
import { type CandidateObservation, type ConcernDecision } from './candidate.js';
|
|
2
|
+
import { type ChangeSummaryState } from './change-summary.js';
|
|
3
|
+
import { type PrContext } from './pr-context.js';
|
|
4
|
+
import { type ReportingStatus, type AssessmentFeedbackSender } from './feedback.js';
|
|
5
|
+
import { type PreparedState } from './prepare.js';
|
|
6
|
+
import { decideExit, type AssessmentEntry, type AssessmentPolicy } from './results.js';
|
|
7
|
+
import { type ProviderConfiguration, type AssessmentProvider, type ProviderFailureCode } from './providers.js';
|
|
8
|
+
import { type SourceLimits } from './source.js';
|
|
9
|
+
import { type PhaseRecord } from './phases.js';
|
|
10
|
+
import { DEFAULT_EXECUTION_LIMITS, type ExecutionLimits, type ModelPhase } from './budget.js';
|
|
11
|
+
import { type LogLevel } from './diagnostics.js';
|
|
12
|
+
import { type AssessmentCheckpoint } from './resume.js';
|
|
13
|
+
import { type AssessmentProposal, type CheckAssessment, type AssessmentFinding } from './assessment.js';
|
|
14
|
+
export { DEFAULT_EXECUTION_LIMITS, type ExecutionLimits };
|
|
15
|
+
export type AssessmentState = Omit<PreparedState, 'schemaVersion' | 'entries' | 'assessmentStatus'> & {
|
|
16
|
+
schemaVersion: 2;
|
|
17
|
+
observations?: CandidateObservation[];
|
|
18
|
+
concernDecisions?: ConcernDecision[];
|
|
19
|
+
concernValidation?: {
|
|
20
|
+
expected: number;
|
|
21
|
+
validated: number;
|
|
22
|
+
complete: boolean;
|
|
23
|
+
scope: 'nominated_concerns';
|
|
24
|
+
};
|
|
25
|
+
entries: AssessmentEntry[];
|
|
26
|
+
assessmentStatus: 'running' | 'complete' | 'incomplete';
|
|
27
|
+
phases: PhaseRecord[];
|
|
28
|
+
checks: CheckAssessment[];
|
|
29
|
+
findings: AssessmentFinding[];
|
|
30
|
+
followUps?: NonNullable<AssessmentProposal['followUps']>;
|
|
31
|
+
changeSummary?: ChangeSummaryState;
|
|
32
|
+
verification: {
|
|
33
|
+
expected: number;
|
|
34
|
+
verified: number;
|
|
35
|
+
complete: boolean;
|
|
36
|
+
};
|
|
37
|
+
execution: {
|
|
38
|
+
requested: ProviderConfiguration;
|
|
39
|
+
phaseModels: Record<ModelPhase, ProviderConfiguration>;
|
|
40
|
+
limits: ExecutionLimits;
|
|
41
|
+
sourceLimits: Readonly<SourceLimits>;
|
|
42
|
+
policy: AssessmentPolicy;
|
|
43
|
+
rubric: {
|
|
44
|
+
adherence: 'adherence-v1';
|
|
45
|
+
confidence: 'model-confidence-v1';
|
|
46
|
+
};
|
|
47
|
+
purpose: string | null;
|
|
48
|
+
prContext: {
|
|
49
|
+
hash: string;
|
|
50
|
+
capturedAt: string;
|
|
51
|
+
discussion: string;
|
|
52
|
+
historyRuns: number;
|
|
53
|
+
previousHead: string | null;
|
|
54
|
+
} | null;
|
|
55
|
+
scope: string | null;
|
|
56
|
+
startedAt: string;
|
|
57
|
+
elapsedMs: number;
|
|
58
|
+
calls: number;
|
|
59
|
+
steps: number;
|
|
60
|
+
stopReason: string | null;
|
|
61
|
+
usage: Array<Record<string, unknown>>;
|
|
62
|
+
providerUsage: Array<{
|
|
63
|
+
call: number;
|
|
64
|
+
provider: AssessmentProvider;
|
|
65
|
+
phase: ModelPhase;
|
|
66
|
+
workUnitId: string;
|
|
67
|
+
usage: unknown;
|
|
68
|
+
missing: boolean;
|
|
69
|
+
httpStatus?: number;
|
|
70
|
+
failureCode?: ProviderFailureCode;
|
|
71
|
+
}>;
|
|
72
|
+
returnedIdentities: Array<{
|
|
73
|
+
provider: string | null;
|
|
74
|
+
model: string | null;
|
|
75
|
+
}>;
|
|
76
|
+
reporting: ReportingStatus;
|
|
77
|
+
capture: string;
|
|
78
|
+
logLevel: LogLevel;
|
|
79
|
+
};
|
|
80
|
+
decision: ReturnType<typeof decideExit> | null;
|
|
81
|
+
};
|
|
82
|
+
type AssessmentOptions = {
|
|
83
|
+
prepared: {
|
|
84
|
+
state: PreparedState;
|
|
85
|
+
statePath: string;
|
|
86
|
+
materialPath: string;
|
|
87
|
+
manifestPath?: string;
|
|
88
|
+
};
|
|
89
|
+
provider: ProviderConfiguration;
|
|
90
|
+
phaseModels?: Partial<Record<ModelPhase, ProviderConfiguration>>;
|
|
91
|
+
logLevel?: LogLevel;
|
|
92
|
+
policy?: Partial<AssessmentPolicy>;
|
|
93
|
+
limits?: Partial<ExecutionLimits>;
|
|
94
|
+
sourceLimits?: Partial<SourceLimits>;
|
|
95
|
+
purpose?: string;
|
|
96
|
+
prContext?: PrContext;
|
|
97
|
+
signal?: AbortSignal;
|
|
98
|
+
fetch?: typeof fetch;
|
|
99
|
+
feedback?: 'send' | 'off';
|
|
100
|
+
feedbackSender?: AssessmentFeedbackSender;
|
|
101
|
+
repositoryAttribution?: boolean;
|
|
102
|
+
resume?: AssessmentCheckpoint;
|
|
103
|
+
};
|
|
104
|
+
export declare function runAssessment(options: AssessmentOptions): Promise<{
|
|
105
|
+
state: AssessmentState;
|
|
106
|
+
statePath: string;
|
|
107
|
+
reportPath: string;
|
|
108
|
+
directory: string;
|
|
109
|
+
}>;
|