@godspeedai/cognate-proto 0.8.0 → 0.9.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 (2) hide show
  1. package/package.json +1 -1
  2. package/src/EGM.md +28 -0
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@godspeedai/cognate-proto",
3
- "version": "0.8.0",
3
+ "version": "0.9.1",
4
4
  "description": "Generated TypeScript bindings for the canonical proto/ sources. Generated files are never edited by hand (spec §21).",
5
5
  "type": "module",
6
6
  "license": "Apache-2.0",
package/src/EGM.md ADDED
@@ -0,0 +1,28 @@
1
+ # proto / src — generated protobuf bindings
2
+
3
+ ## Overview
4
+
5
+ `index.ts` re-exports the generated TypeScript bindings for the canonical `proto/` sources and nothing else `[index.ts:1]`. `src/gen/cognate/v1/` holds the generated modules (`identity_pb`, `artifact_pb`, `capability_pb`, `continuation_pb`, `event_pb`, `execution_pb`, `component_pb`, `cognitive_pb`, `trace_pb`, `runtime_pb`), which are never edited by hand `[index.ts:3]`. Regeneration runs the pinned `protoc-gen-es` plugin via `bun scripts/generate.ts` into `src/gen` `[index.ts:2]`.
6
+
7
+ ## Interface
8
+
9
+ - `./gen/cognate/v1/identity_pb.js` — identity messages `[index.ts:3]`
10
+ - `./gen/cognate/v1/artifact_pb.js` / `capability_pb.js` / `continuation_pb.js` — artifact, capability, and continuation messages `[index.ts:4]`
11
+ - `./gen/cognate/v1/event_pb.js` / `execution_pb.js` — event and execution messages `[index.ts:7]`
12
+ - `./gen/cognate/v1/component_pb.js` / `cognitive_pb.js` / `trace_pb.js` — component, cognitive, and trace messages `[index.ts:9]`
13
+ - `./gen/cognate/v1/runtime_pb.js` — the `RuntimeService` service descriptor the Connect adapter binds `[index.ts:12]`
14
+
15
+ ## Invariants
16
+
17
+ - Files under `src/gen` are generated output and must never be edited by hand `[index.ts:1]`
18
+ - The only runtime dependency is `@bufbuild/protobuf`; `buf` and `protoc-gen-es` are dev-only
19
+ - `bun scripts/generate.ts` writes into `src/gen` by default and exits with the `buf` process code on failure
20
+ - Consumers import enums and service descriptors from this package rather than regenerating: `protocol-connect` binds `RuntimeServiceDesc` from `@godspeedai/cognate-proto` `[index.ts:12]`
21
+
22
+ ## Side Effects
23
+
24
+ - None at import time. The `generate` script spawns `node_modules/.bin/buf` and writes files under `src/gen`
25
+
26
+ ## Verification
27
+
28
+ - Run: `bun test ./packages/proto/test/codegen.test.ts`