@agent-inspect/adapter-sdk 3.4.0 → 3.5.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/README.md +60 -0
- package/package.json +4 -3
package/README.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# @agent-inspect/adapter-sdk
|
|
2
|
+
|
|
3
|
+
Author third-party AgentInspect framework adapters with conformance helpers.
|
|
4
|
+
|
|
5
|
+
## When to use
|
|
6
|
+
|
|
7
|
+
- Building a community or internal adapter package
|
|
8
|
+
- Validating metadata-only capture and privacy contracts
|
|
9
|
+
|
|
10
|
+
## When not to use
|
|
11
|
+
|
|
12
|
+
- Application tracing (use `agent-inspect` or an existing adapter)
|
|
13
|
+
|
|
14
|
+
## Install
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
npm install @agent-inspect/adapter-sdk agent-inspect
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```ts
|
|
23
|
+
import { createAdapterRegistration, runAdapterConformance } from "@agent-inspect/adapter-sdk";
|
|
24
|
+
|
|
25
|
+
export const registration = createAdapterRegistration({
|
|
26
|
+
id: "my-framework",
|
|
27
|
+
// ...
|
|
28
|
+
});
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Privacy
|
|
32
|
+
|
|
33
|
+
- SDK helpers enforce local-first patterns; adapters must not upload by default
|
|
34
|
+
|
|
35
|
+
## API
|
|
36
|
+
|
|
37
|
+
| Export | Purpose |
|
|
38
|
+
| ------ | ------- |
|
|
39
|
+
| `createAdapterRegistration` | Register adapter metadata |
|
|
40
|
+
| `runAdapterConformance` | Conformance test runner |
|
|
41
|
+
|
|
42
|
+
## Docs
|
|
43
|
+
|
|
44
|
+
- [Adapter conformance](https://github.com/rajudandigam/agent-inspect/blob/main/docs/ADAPTER-CONFORMANCE.md)
|
|
45
|
+
- [Adapters](https://github.com/rajudandigam/agent-inspect/blob/main/docs/ADAPTERS.md)
|
|
46
|
+
|
|
47
|
+
## Checklist for package authors
|
|
48
|
+
|
|
49
|
+
1. Metadata-only default
|
|
50
|
+
2. Document peer dependencies
|
|
51
|
+
3. No network in adapter code path
|
|
52
|
+
4. Add conformance tests
|
|
53
|
+
|
|
54
|
+
## Version
|
|
55
|
+
|
|
56
|
+
`3.5.x`
|
|
57
|
+
|
|
58
|
+
## License
|
|
59
|
+
|
|
60
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@agent-inspect/adapter-sdk",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.5.1",
|
|
4
4
|
"license": "MIT",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"description": "Adapter authoring toolkit with conformance and privacy helpers",
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
"bugs": {
|
|
13
13
|
"url": "https://github.com/rajudandigam/agent-inspect/issues"
|
|
14
14
|
},
|
|
15
|
-
"homepage": "https://github.com/rajudandigam/agent-inspect
|
|
15
|
+
"homepage": "https://github.com/rajudandigam/agent-inspect/tree/main/packages/adapter-sdk",
|
|
16
16
|
"sideEffects": false,
|
|
17
17
|
"main": "./dist/index.cjs",
|
|
18
18
|
"module": "./dist/index.mjs",
|
|
@@ -30,10 +30,11 @@
|
|
|
30
30
|
}
|
|
31
31
|
},
|
|
32
32
|
"files": [
|
|
33
|
+
"README.md",
|
|
33
34
|
"dist"
|
|
34
35
|
],
|
|
35
36
|
"dependencies": {
|
|
36
|
-
"agent-inspect": "3.
|
|
37
|
+
"agent-inspect": "3.5.1"
|
|
37
38
|
},
|
|
38
39
|
"peerDependencies": {},
|
|
39
40
|
"publishConfig": {
|