@xtrape/capsule-contracts-node 0.5.1 → 0.6.0
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 +22 -23
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -41,8 +41,8 @@ import { ServiceManifestSchema, CE_CONTRACT_VERSION } from "@xtrape/capsule-cont
|
|
|
41
41
|
|
|
42
42
|
const manifest = ServiceManifestSchema.parse({
|
|
43
43
|
contractVersion: CE_CONTRACT_VERSION,
|
|
44
|
-
service: { id: "demo-echo-service", name: "Demo Echo Service", version: "0.
|
|
45
|
-
runtime: { language: "node", agent: "xtrape-agent-
|
|
44
|
+
service: { id: "demo-echo-service", name: "Demo Echo Service", version: "0.6.0" },
|
|
45
|
+
runtime: { language: "node", agent: "xtrape-agent-nodejs" },
|
|
46
46
|
capabilities: ["status.query"],
|
|
47
47
|
message: { supportedTypes: ["QUERY"] },
|
|
48
48
|
});
|
|
@@ -53,29 +53,27 @@ change that must bump `CE_CONTRACT_VERSION` and update the surface guard. See th
|
|
|
53
53
|
matching examples in `xtrape-docs/docs/runtime-platform/01-phase-0-runtime-mvp.md`.
|
|
54
54
|
|
|
55
55
|
[](./LICENSE)
|
|
56
|
-
[](https://forgejo.xtrape.com/xtrape/xtrape-docs)
|
|
57
|
+
[](https://forgejo.xtrape.com/xtrape/xtrape-docs)
|
|
58
58
|
|
|
59
59
|
`@xtrape/capsule-contracts-node` is the current published TypeScript contract
|
|
60
60
|
package for Panel CE, Agent SDKs, and Worker integrations. It exports Zod
|
|
61
61
|
schemas, inferred TypeScript types, enum values, ID helpers, pagination helpers,
|
|
62
62
|
and protocol error helpers for the Agent/Admin/System wire contracts.
|
|
63
63
|
|
|
64
|
-
> **Package status:**
|
|
65
|
-
>
|
|
66
|
-
>
|
|
67
|
-
> interfaces may still change.
|
|
64
|
+
> **Package status:** This package follows the unified Xtrape `0.6.0` release
|
|
65
|
+
> train. The npm package name remains a compatibility identifier, but release
|
|
66
|
+
> versioning now follows the shared Xtrape train version.
|
|
68
67
|
|
|
69
68
|
## Install
|
|
70
69
|
|
|
71
|
-
|
|
70
|
+
This repository tracks the `0.6.0` snapshot train. Until the `0.6.0` npm cut is
|
|
71
|
+
published, install the latest published compatibility package:
|
|
72
72
|
|
|
73
73
|
```bash
|
|
74
|
-
pnpm add @xtrape/capsule-contracts-node
|
|
74
|
+
pnpm add @xtrape/capsule-contracts-node@^0.5.1
|
|
75
75
|
```
|
|
76
76
|
|
|
77
|
-
The current Public Review version may change before `v0.1.0`.
|
|
78
|
-
|
|
79
77
|
For this repository itself:
|
|
80
78
|
|
|
81
79
|
```bash
|
|
@@ -396,11 +394,11 @@ const response = paginate(items, query.page, query.pageSize, total);
|
|
|
396
394
|
|
|
397
395
|
## Used By
|
|
398
396
|
|
|
399
|
-
- [`xtrape-
|
|
397
|
+
- [`xtrape-panel-ce`](https://forgejo.xtrape.com/xtrape/xtrape-panel-ce) —
|
|
400
398
|
Xtrape Panel CE backend validation and protocol handling.
|
|
401
|
-
- [`xtrape-
|
|
399
|
+
- [`xtrape-agent-nodejs`](https://forgejo.xtrape.com/xtrape/xtrape-agent-nodejs)
|
|
402
400
|
— Node embedded Agent SDK request/response types.
|
|
403
|
-
- [`xtrape-
|
|
401
|
+
- [`xtrape-demo`](https://forgejo.xtrape.com/xtrape/xtrape-demo)
|
|
404
402
|
— End-to-end runnable Worker that imports these schemas through
|
|
405
403
|
the Agent SDK.
|
|
406
404
|
- Worker implementations that want local validation before reporting to
|
|
@@ -431,8 +429,8 @@ existing `0.1.x` agents continue to validate against a `0.2.x` backend.
|
|
|
431
429
|
|
|
432
430
|
## Schema Stability
|
|
433
431
|
|
|
434
|
-
The package follows semver.
|
|
435
|
-
guarantees per schema group are:
|
|
432
|
+
The package follows semver. During the current pre-`1.0` release-train phase,
|
|
433
|
+
the guarantees per schema group are:
|
|
436
434
|
|
|
437
435
|
| Group | Stability | Notes |
|
|
438
436
|
| ---------------------------------------------------------------------------------------------------------------- | :---------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
@@ -450,12 +448,13 @@ Breaking changes will be called out in `CHANGELOG.md`.
|
|
|
450
448
|
|
|
451
449
|
## Documentation
|
|
452
450
|
|
|
453
|
-
-
|
|
454
|
-
-
|
|
455
|
-
-
|
|
456
|
-
-
|
|
457
|
-
-
|
|
458
|
-
-
|
|
451
|
+
- Public docs repo: https://forgejo.xtrape.com/xtrape/xtrape-site
|
|
452
|
+
- Contracts overview: https://forgejo.xtrape.com/xtrape/xtrape-site/src/branch/main/docs/contracts/overview.md
|
|
453
|
+
- Manifest contract: https://forgejo.xtrape.com/xtrape/xtrape-site/src/branch/main/docs/contracts/manifest.md
|
|
454
|
+
- Health contract: https://forgejo.xtrape.com/xtrape/xtrape-site/src/branch/main/docs/contracts/health.md
|
|
455
|
+
- Actions contract: https://forgejo.xtrape.com/xtrape/xtrape-site/src/branch/main/docs/contracts/actions.md
|
|
456
|
+
- Errors: https://forgejo.xtrape.com/xtrape/xtrape-site/src/branch/main/docs/contracts/errors.md
|
|
457
|
+
- Xtrape Panel CE docs: https://forgejo.xtrape.com/xtrape/xtrape-site/src/branch/main/docs/opstage-ce/overview.md
|
|
459
458
|
|
|
460
459
|
## Contributing
|
|
461
460
|
|