borgmcp-shared 0.2.2

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 (83) hide show
  1. package/CONTRIBUTING.md +40 -0
  2. package/LICENSE +201 -0
  3. package/NOTICE +2 -0
  4. package/README.md +159 -0
  5. package/SECURITY.md +25 -0
  6. package/dist/conformance/adapter.d.ts +112 -0
  7. package/dist/conformance/adapter.d.ts.map +1 -0
  8. package/dist/conformance/adapter.js +417 -0
  9. package/dist/conformance/adapter.js.map +1 -0
  10. package/dist/conformance/index.d.ts +15 -0
  11. package/dist/conformance/index.d.ts.map +1 -0
  12. package/dist/conformance/index.js +49 -0
  13. package/dist/conformance/index.js.map +1 -0
  14. package/dist/domain/index.d.ts +5 -0
  15. package/dist/domain/index.d.ts.map +1 -0
  16. package/dist/domain/index.js +4 -0
  17. package/dist/domain/index.js.map +1 -0
  18. package/dist/drone-address.d.ts +3 -0
  19. package/dist/drone-address.d.ts.map +1 -0
  20. package/dist/drone-address.js +7 -0
  21. package/dist/drone-address.js.map +1 -0
  22. package/dist/index.d.ts +5 -0
  23. package/dist/index.d.ts.map +1 -0
  24. package/dist/index.js +5 -0
  25. package/dist/index.js.map +1 -0
  26. package/dist/log-stream-hwm.d.ts +6 -0
  27. package/dist/log-stream-hwm.d.ts.map +1 -0
  28. package/dist/log-stream-hwm.js +12 -0
  29. package/dist/log-stream-hwm.js.map +1 -0
  30. package/dist/protocol/contract.d.ts +127 -0
  31. package/dist/protocol/contract.d.ts.map +1 -0
  32. package/dist/protocol/contract.js +434 -0
  33. package/dist/protocol/contract.js.map +1 -0
  34. package/dist/protocol/coordination.d.ts +38 -0
  35. package/dist/protocol/coordination.d.ts.map +1 -0
  36. package/dist/protocol/coordination.js +176 -0
  37. package/dist/protocol/coordination.js.map +1 -0
  38. package/dist/protocol/errors.d.ts +33 -0
  39. package/dist/protocol/errors.d.ts.map +1 -0
  40. package/dist/protocol/errors.js +26 -0
  41. package/dist/protocol/errors.js.map +1 -0
  42. package/dist/protocol/index.d.ts +8 -0
  43. package/dist/protocol/index.d.ts.map +1 -0
  44. package/dist/protocol/index.js +7 -0
  45. package/dist/protocol/index.js.map +1 -0
  46. package/dist/protocol/sse.d.ts +44 -0
  47. package/dist/protocol/sse.d.ts.map +1 -0
  48. package/dist/protocol/sse.js +246 -0
  49. package/dist/protocol/sse.js.map +1 -0
  50. package/dist/protocol/types.d.ts +174 -0
  51. package/dist/protocol/types.d.ts.map +1 -0
  52. package/dist/protocol/types.js +2 -0
  53. package/dist/protocol/types.js.map +1 -0
  54. package/dist/protocol/version.d.ts +11 -0
  55. package/dist/protocol/version.d.ts.map +1 -0
  56. package/dist/protocol/version.js +14 -0
  57. package/dist/protocol/version.js.map +1 -0
  58. package/dist/role-section.d.ts +24 -0
  59. package/dist/role-section.d.ts.map +1 -0
  60. package/dist/role-section.js +114 -0
  61. package/dist/role-section.js.map +1 -0
  62. package/dist/templates.d.ts +44 -0
  63. package/dist/templates.d.ts.map +1 -0
  64. package/dist/templates.js +771 -0
  65. package/dist/templates.js.map +1 -0
  66. package/docs/compatibility.md +38 -0
  67. package/docs/releasing.md +220 -0
  68. package/package.json +89 -0
  69. package/src/conformance/adapter.ts +717 -0
  70. package/src/conformance/index.ts +68 -0
  71. package/src/domain/index.ts +9 -0
  72. package/src/drone-address.ts +25 -0
  73. package/src/index.ts +4 -0
  74. package/src/log-stream-hwm.ts +16 -0
  75. package/src/protocol/contract.ts +608 -0
  76. package/src/protocol/coordination.ts +249 -0
  77. package/src/protocol/errors.ts +36 -0
  78. package/src/protocol/index.ts +7 -0
  79. package/src/protocol/sse.ts +295 -0
  80. package/src/protocol/types.ts +201 -0
  81. package/src/protocol/version.ts +31 -0
  82. package/src/role-section.ts +270 -0
  83. package/src/templates.ts +953 -0
@@ -0,0 +1,40 @@
1
+ # Contributing
2
+
3
+ Thank you for helping improve the shared Borg MCP contract.
4
+
5
+ ## Before Opening a Change
6
+
7
+ Open an issue for behavioral or wire-contract changes before implementing them.
8
+ Describe the affected consumers, the rollout order, and whether existing
9
+ clients or servers require a compatibility window. Small documentation and test
10
+ corrections can proceed directly to a pull request.
11
+
12
+ Keep this package implementation-neutral. Contributions should extend portable
13
+ contracts, pure helpers, canonical templates, or synthetic conformance data.
14
+ Runtime dependency changes require explicit justification and a security review.
15
+
16
+ ## Development Workflow
17
+
18
+ Use Node.js 20 or newer, then run:
19
+
20
+ ```sh
21
+ npm install
22
+ npm test
23
+ npm run check
24
+ npm run build
25
+ npm pack --dry-run
26
+ ```
27
+
28
+ Pull requests should include tests for changed behavior and update the public
29
+ API or compatibility documentation when applicable. Wire behavior must be
30
+ represented by implementation-neutral vectors in `src/conformance` so every
31
+ server implementation can run the same cases.
32
+
33
+ Do not include secrets, access tokens, private URLs, customer data, or copied
34
+ production payloads in source, tests, commits, issues, or pull requests. Use
35
+ synthetic fixtures.
36
+
37
+ ## Reporting Security Issues
38
+
39
+ Do not open a public issue for a suspected vulnerability. Follow the private
40
+ reporting process in [SECURITY.md](SECURITY.md).
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1,2 @@
1
+ Borg MCP Shared
2
+ Copyright 2026 Byte Ventures IO AB
package/README.md ADDED
@@ -0,0 +1,159 @@
1
+ # borgmcp-shared
2
+
3
+ `borgmcp-shared` is the implementation-neutral contract package for Borg MCP.
4
+ It contains protocol types, domain helpers, built-in cube templates, and
5
+ portable conformance vectors used by Borg MCP clients and server implementations.
6
+ Its pure ESM helpers and generated TypeScript declarations run consistently
7
+ across host environments with zero runtime dependencies.
8
+
9
+ ## Installation
10
+
11
+ ```sh
12
+ npm install borgmcp-shared
13
+ ```
14
+
15
+ The package is ESM-only and supports Node.js 20 or newer.
16
+
17
+ ## Public API
18
+
19
+ The root entry point exports the complete supported API:
20
+
21
+ ```ts
22
+ import {
23
+ PROTOCOL_VERSION,
24
+ TEMPLATES,
25
+ compareBroadcastHwm,
26
+ parseRoleSections,
27
+ } from 'borgmcp-shared';
28
+ ```
29
+
30
+ Focused subpath exports let consumers keep their dependency boundary explicit:
31
+
32
+ ```ts
33
+ import { TEMPLATES } from 'borgmcp-shared/templates';
34
+ import { patchRoleSectionText } from 'borgmcp-shared/role-section';
35
+ import { compareBroadcastHwm } from 'borgmcp-shared/log-stream-hwm';
36
+ import { formatDroneAddressToken } from 'borgmcp-shared/drone-address';
37
+ import type { AppendLogRequest } from 'borgmcp-shared/protocol';
38
+ import { ADAPTER_CONFORMANCE_FIXTURES } from 'borgmcp-shared/conformance';
39
+ ```
40
+
41
+ The supported subpaths are:
42
+
43
+ - `borgmcp-shared/protocol`: wire entities, requests, responses, errors, and
44
+ protocol compatibility metadata.
45
+ - `borgmcp-shared/domain`: pure role-section, address, and high-water-mark
46
+ helpers plus shared domain types.
47
+ - `borgmcp-shared/conformance`: test-runner-independent behavior vectors and
48
+ the adapter conformance runner.
49
+ - `borgmcp-shared/templates`: built-in cube templates, template schemas, and helpers.
50
+ - `borgmcp-shared/role-section`: lossless role-text parsing and patching.
51
+ - `borgmcp-shared/log-stream-hwm`: broadcast cursor ordering.
52
+ - `borgmcp-shared/drone-address`: stable short drone-address rendering.
53
+
54
+ Generated declaration files are included in every published package. Public
55
+ functions and contracts include API documentation in their TypeScript sources.
56
+
57
+ ## Handshake
58
+
59
+ The first-slice HTTP contract has three shared paths:
60
+
61
+ - `GET /healthz` is the only unauthenticated liveness probe. Success is `204`
62
+ with no body or identifying metadata.
63
+ - `POST /api/enrollment/exchange` accepts a single-use invitation in a bounded
64
+ JSON body over verified TLS and returns the client credential once. Secrets
65
+ never belong in a URL, query string, command-line argument, diagnostic, or
66
+ serializable domain entity.
67
+ - `GET /api/protocol` requires authentication and returns the protocol version,
68
+ package version, capabilities, and bounded limits in the shared envelope.
69
+
70
+ `negotiateProtocol` requires bearer authentication, revocation, cube isolation,
71
+ verified TLS, and no-cloud-fallback capabilities. Missing security capabilities
72
+ fail closed before an operation begins.
73
+
74
+ Every JSON coordination request and successful JSON response is carried inside
75
+ `ProtocolEnvelope<T>`. Failures use `ProtocolErrorEnvelope`. The only bodyless
76
+ exceptions are the `204` liveness and acknowledgement responses. Payload codecs
77
+ are exported separately so adapters can validate the envelope first and then
78
+ validate the operation-specific payload without accepting ambiguous fields.
79
+
80
+ ## Conformance
81
+
82
+ Server and client implementations should run the vectors exported from
83
+ `borgmcp-shared/conformance` against their adapters. The vectors and runner are
84
+ readonly data rather than Vitest-specific helpers, so they work with any test
85
+ runner and in any JavaScript runtime. Cases cover HTTP and canonical errors,
86
+ credential misuse, isolation and revocation, SSE framing/replay/cursor ordering,
87
+ acks, claims, decisions, and unsupported-capability failures.
88
+
89
+ Implement `AdapterConformanceDriver` with raw responses from the target adapter,
90
+ then call `runAdapterConformance`. The runner creates and decodes envelopes,
91
+ drives state transitions, and decides pass/fail; adapters do not submit expected
92
+ results. `runEquivalentAdapterConformance(cloud, local)` executes the identical
93
+ sequence against both implementations and fails when either implementation or
94
+ their normalized observable transcripts diverge.
95
+
96
+ The package's own suite covers built-in templates, role-section patching,
97
+ broadcast high-water-mark ordering, drone-address formatting, and current public
98
+ response shapes.
99
+
100
+ ## Compatibility
101
+
102
+ `PROTOCOL_VERSION`, `SUPPORTED_PROTOCOL_VERSIONS`, and `COMPATIBILITY_MATRIX`
103
+ describe the compatibility contract. During the pre-1.0 package series, new
104
+ contracts may be added, but an existing wire shape will not change without a
105
+ documented migration path and corresponding conformance coverage. Consumers pin
106
+ `^0.2.0` (`>=0.2.0 <0.3.0`): before 1.0, breaking wire changes increment the
107
+ minor version while compatible additions and corrections increment the patch.
108
+
109
+ See [docs/compatibility.md](docs/compatibility.md) for the current matrix and
110
+ the policy for introducing protocol changes.
111
+
112
+ ## Distribution
113
+
114
+ After the final source, security, conformance, and packed-artifact gates pass,
115
+ `borgmcp-shared@0.2.2` is published publicly from the npm account that owns the
116
+ existing `borgmcp` client package. Consumers then pin `borgmcp-shared@^0.2.0`
117
+ and commit registry lockfiles. No registry token belongs in this repository,
118
+ package metadata, lockfiles, or a committed `.npmrc`; publishing uses protected
119
+ external credentials and provenance.
120
+
121
+ Before that publication, consumers may temporarily pin an audited, immutable
122
+ full commit SHA, using
123
+ `git+ssh://git@github.com/Byte-Ventures/borg-mcp-shared.git#<40-hex-SHA>`.
124
+ Tag, range, and local-path pins are prohibited. This exception is replaced with
125
+ the registry dependency `borgmcp-shared@^0.2.0` after publication. Public release
126
+ requires the packed-artifact sensitivity audit, name ownership, account recovery
127
+ and 2FA, provenance verification, and explicit release approval.
128
+
129
+ ## Security Posture
130
+
131
+ The package publishes portable wire contracts, deterministic helpers, canonical
132
+ templates, and conformance data as dependency-free ESM.
133
+
134
+ Protocol types describe untrusted wire data; they do not replace runtime input
135
+ validation at a server boundary. Implementations remain responsible for
136
+ authenticating callers, authorizing every operation, enforcing resource limits,
137
+ and validating request bodies before using them.
138
+
139
+ The exported codecs reject unknown security fields, unsafe identifiers,
140
+ oversized payloads, and terminal control characters. Network adapters must also
141
+ enforce the published SSE and request byte limits while reading from the socket;
142
+ calling a decoder only after an unbounded response has been buffered is unsafe.
143
+
144
+ Please report vulnerabilities through the private process in
145
+ [SECURITY.md](SECURITY.md), not through a public issue.
146
+
147
+ ## Development
148
+
149
+ ```sh
150
+ npm install
151
+ npm test
152
+ npm run check
153
+ npm run build
154
+ npm pack --dry-run
155
+ ```
156
+
157
+ See [CONTRIBUTING.md](CONTRIBUTING.md) before proposing a change.
158
+ Release operators must follow the protected [publishing runbook](docs/releasing.md);
159
+ the runbook does not authorize a release.
package/SECURITY.md ADDED
@@ -0,0 +1,25 @@
1
+ # Security Policy
2
+
3
+ ## Reporting a Vulnerability
4
+
5
+ Please report suspected vulnerabilities privately through GitHub Security
6
+ Advisories for this repository. Open the repository's **Security** tab, select
7
+ **Advisories**, and choose **Report a vulnerability**.
8
+
9
+ If GitHub's private reporting interface is unavailable, email
10
+ `queen@borgmcp.ai`. Do not include credentials, access tokens, customer data,
11
+ or other secrets unless the maintainers explicitly request them through an
12
+ encrypted channel.
13
+
14
+ Do not disclose the issue publicly until the maintainers confirm that a fix is
15
+ available and coordinated disclosure is appropriate.
16
+
17
+ ## Scope
18
+
19
+ Security reports may concern this package's published artifacts, protocol
20
+ contracts, conformance data, dependency chain, or documentation. Vulnerabilities
21
+ in hosted Borg MCP services can be reported through the same channels.
22
+
23
+ Only supported package versions receive security fixes. The latest published
24
+ version is always supported; older versions may receive fixes when a safe
25
+ upgrade path requires a transition period.
@@ -0,0 +1,112 @@
1
+ import { type LogCursor } from '../protocol/index.js';
2
+ export interface ConformanceHttpResponse {
3
+ status: number;
4
+ body: unknown;
5
+ }
6
+ export interface ConformancePrincipal {
7
+ readonly id: string;
8
+ }
9
+ export interface ConformanceCube {
10
+ readonly id: string;
11
+ }
12
+ export interface ConformanceReplayBarrier {
13
+ readonly reached: Promise<void>;
14
+ release(): void;
15
+ }
16
+ export interface ConformanceStreamResponse extends ConformanceHttpResponse {
17
+ stream: AsyncIterable<string> | null;
18
+ }
19
+ export interface ConformanceAdmin {
20
+ reset(): Promise<void>;
21
+ createPrincipal(name: string): Promise<ConformancePrincipal>;
22
+ createCube(name: string): Promise<ConformanceCube>;
23
+ grantCube(principal: ConformancePrincipal, cube: ConformanceCube): Promise<void>;
24
+ issueSingleUseInvitation(principal: ConformancePrincipal): Promise<string>;
25
+ revokePrincipal(principal: ConformancePrincipal): Promise<void>;
26
+ expireCursor(cube: ConformanceCube, cursor: LogCursor): Promise<void>;
27
+ armReplayTransition(): ConformanceReplayBarrier;
28
+ }
29
+ export interface ConformanceOperations {
30
+ health(): Promise<ConformanceHttpResponse>;
31
+ protocol(credential: string | null): Promise<ConformanceHttpResponse>;
32
+ enroll(request: unknown): Promise<ConformanceHttpResponse>;
33
+ append(credential: string, cube: ConformanceCube, request: unknown): Promise<ConformanceHttpResponse>;
34
+ appendRaw(credential: string, cube: ConformanceCube, body: string): Promise<ConformanceHttpResponse>;
35
+ read(credential: string, cube: ConformanceCube, request: unknown): Promise<ConformanceHttpResponse>;
36
+ ack(credential: string, cube: ConformanceCube, request: unknown): Promise<ConformanceHttpResponse>;
37
+ recordDecision(credential: string, cube: ConformanceCube, request: unknown): Promise<ConformanceHttpResponse>;
38
+ listDecisions(credential: string, cube: ConformanceCube, request: unknown): Promise<ConformanceHttpResponse>;
39
+ openStream(credential: string, cube: ConformanceCube, cursor: LogCursor | null): Promise<ConformanceStreamResponse>;
40
+ }
41
+ export interface ConformanceEnvironment {
42
+ readonly admin: ConformanceAdmin;
43
+ readonly operations: ConformanceOperations;
44
+ }
45
+ export declare const ADAPTER_CONFORMANCE_FIXTURES: readonly [{
46
+ readonly id: "http.unauthenticated-liveness";
47
+ readonly area: "http";
48
+ }, {
49
+ readonly id: "protocol.enrollment-auth";
50
+ readonly area: "protocol";
51
+ }, {
52
+ readonly id: "security.adapter-boundary-injection";
53
+ readonly area: "security";
54
+ }, {
55
+ readonly id: "security.oversize-request";
56
+ readonly area: "security";
57
+ }, {
58
+ readonly id: "security.cross-cube-isolation";
59
+ readonly area: "security";
60
+ }, {
61
+ readonly id: "log.read-cursor-tuple";
62
+ readonly area: "cursor";
63
+ }, {
64
+ readonly id: "sse.replay-live-transition";
65
+ readonly area: "sse";
66
+ }, {
67
+ readonly id: "cursor.explicit-expiry";
68
+ readonly area: "cursor";
69
+ }, {
70
+ readonly id: "acks.idempotent";
71
+ readonly area: "acks";
72
+ }, {
73
+ readonly id: "claims.durable-noncursor";
74
+ readonly area: "claims";
75
+ }, {
76
+ readonly id: "decisions.topic-supersession";
77
+ readonly area: "decisions";
78
+ }, {
79
+ readonly id: "capabilities.unsupported-fails-closed";
80
+ readonly area: "capabilities";
81
+ }, {
82
+ readonly id: "security.active-stream-revocation";
83
+ readonly area: "security";
84
+ }];
85
+ export type AdapterConformanceFixtureId = (typeof ADAPTER_CONFORMANCE_FIXTURES)[number]['id'];
86
+ export interface AdapterConformanceResult {
87
+ id: AdapterConformanceFixtureId;
88
+ ok: boolean;
89
+ observations: Record<string, unknown>;
90
+ error?: string;
91
+ }
92
+ export interface AdapterConformanceReport {
93
+ ok: boolean;
94
+ results: AdapterConformanceResult[];
95
+ normalizedTranscript: ReadonlyArray<{
96
+ id: AdapterConformanceFixtureId;
97
+ observations: Record<string, unknown>;
98
+ }>;
99
+ }
100
+ export interface EquivalentAdapterConformanceReport {
101
+ ok: boolean;
102
+ cloud: AdapterConformanceReport;
103
+ local: AdapterConformanceReport;
104
+ equivalent: boolean;
105
+ }
106
+ export interface AdapterConformanceOptions {
107
+ streamDeadlineMs?: number;
108
+ pendingProbeMs?: number;
109
+ }
110
+ export declare function runAdapterConformance(environment: ConformanceEnvironment, options?: AdapterConformanceOptions): Promise<AdapterConformanceReport>;
111
+ export declare function runEquivalentAdapterConformance(cloud: ConformanceEnvironment, local: ConformanceEnvironment, options?: AdapterConformanceOptions): Promise<EquivalentAdapterConformanceReport>;
112
+ //# sourceMappingURL=adapter.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"adapter.d.ts","sourceRoot":"","sources":["../../src/conformance/adapter.ts"],"names":[],"mappings":"AAAA,OAAO,EAgBL,KAAK,SAAS,EAGf,MAAM,sBAAsB,CAAC;AAE9B,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,OAAO,CAAC;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IAEvC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAChC,OAAO,IAAI,IAAI,CAAC;CACjB;AAED,MAAM,WAAW,yBAA0B,SAAQ,uBAAuB;IAExE,MAAM,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACtC;AAMD,MAAM,WAAW,gBAAgB;IAC/B,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAC7D,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACnD,SAAS,CAAC,SAAS,EAAE,oBAAoB,EAAE,IAAI,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjF,wBAAwB,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAC3E,eAAe,CAAC,SAAS,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChE,YAAY,CAAC,IAAI,EAAE,eAAe,EAAE,MAAM,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtE,mBAAmB,IAAI,wBAAwB,CAAC;CACjD;AAGD,MAAM,WAAW,qBAAqB;IACpC,MAAM,IAAI,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAC3C,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACtE,MAAM,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAC3D,MAAM,CACJ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,eAAe,EACrB,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,uBAAuB,CAAC,CAAC;IAEpC,SAAS,CACP,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,eAAe,EACrB,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACpC,IAAI,CACF,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,eAAe,EACrB,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACpC,GAAG,CACD,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,eAAe,EACrB,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACpC,cAAc,CACZ,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,eAAe,EACrB,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACpC,aAAa,CACX,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,eAAe,EACrB,OAAO,EAAE,OAAO,GACf,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACpC,UAAU,CACR,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,eAAe,EACrB,MAAM,EAAE,SAAS,GAAG,IAAI,GACvB,OAAO,CAAC,yBAAyB,CAAC,CAAC;CACvC;AAED,MAAM,WAAW,sBAAsB;IACrC,QAAQ,CAAC,KAAK,EAAE,gBAAgB,CAAC;IACjC,QAAQ,CAAC,UAAU,EAAE,qBAAqB,CAAC;CAC5C;AAED,eAAO,MAAM,4BAA4B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAc/B,CAAC;AAEX,MAAM,MAAM,2BAA2B,GACrC,CAAC,OAAO,4BAA4B,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC;AAEtD,MAAM,WAAW,wBAAwB;IACvC,EAAE,EAAE,2BAA2B,CAAC;IAChC,EAAE,EAAE,OAAO,CAAC;IACZ,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,wBAAwB;IACvC,EAAE,EAAE,OAAO,CAAC;IACZ,OAAO,EAAE,wBAAwB,EAAE,CAAC;IAEpC,oBAAoB,EAAE,aAAa,CAAC;QAClC,EAAE,EAAE,2BAA2B,CAAC;QAChC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACvC,CAAC,CAAC;CACJ;AAED,MAAM,WAAW,kCAAkC;IACjD,EAAE,EAAE,OAAO,CAAC;IACZ,KAAK,EAAE,wBAAwB,CAAC;IAChC,KAAK,EAAE,wBAAwB,CAAC;IAChC,UAAU,EAAE,OAAO,CAAC;CACrB;AAED,MAAM,WAAW,yBAAyB;IAExC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AA4ID,wBAAsB,qBAAqB,CACzC,WAAW,EAAE,sBAAsB,EACnC,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,wBAAwB,CAAC,CA+YnC;AAED,wBAAsB,+BAA+B,CACnD,KAAK,EAAE,sBAAsB,EAC7B,KAAK,EAAE,sBAAsB,EAC7B,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,kCAAkC,CAAC,CAY7C"}