@band-ai/band-sdk-core 0.4.0-dev.1 → 0.4.0-dev.2

package/README.md

@@ -0,0 +1,53 @@
+# band-sdk-core-wasm
+
+JavaScript package for [`band-sdk-core-core`](../core), published as
+`@band-ai/band-sdk-core` for Node.
+
+## Public surface
+
+`validateEventPayload(eventType, raw, traceContext?)`. `eventType` is the
+platform event name (`"message_created"`, `"agent.control"`, …). `raw` is a
+plain JS value. Success returns the normalized payload (`event_created`
+returns the input unchanged). Failure throws a native `Error` with
+`.issues` (`{path, code, message}` objects) and `.traceContext` — not a
+message-only error. There is no custom exception class.
+
+`ClaimRegistry`, `RetryTracker`, and `ParticipantRoster` are the
+inbound-delivery runtime state classes -- lifecycle and design decisions:
+[`../core/docs/runtime-state-policy.md`](../core/docs/runtime-state-policy.md).
+A participant is any plain object; `add`/`setAll` read `id`, `name`,
+`type`, `handle`, `description` from it and `list()` returns objects with
+exactly those five keys. `id` is required and must be a string; the other
+four are each a string or `null`/absent. `setAll` takes an optional
+`traceContext` and throws -- leaving the roster unchanged, with `.issues`
+and `.traceContext` attached like `validateEventPayload`'s error -- if its
+snapshot names the same `id` twice. `RetryTracker`'s `maxTracked` must be
+at least `1`; `0` throws. `ClaimRegistry`'s `maxCompleted` must be at
+least `1` too -- `0` also throws.
+
+`validateMemoryTypeForSystem(system, type, traceContext?)` validates the
+canonical memory taxonomy -- design decisions:
+[`../core/docs/memory-taxonomy-policy.md`](../core/docs/memory-taxonomy-policy.md).
+`system` and `type` are wire-name strings (`MemorySystem`/`MemoryType` in
+`index.d.ts` are string-literal types, not classes -- there is no runtime
+enum on this boundary, matching how `EventType` stays a plain string in
+`validateEventPayload`). Returns `void` on success. Failure throws a
+native `Error` with the same `.issues`/`.traceContext` contract as
+`validateEventPayload` -- an unrecognized `system` and an unrecognized
+`type` are independent issues, both reported when both strings are
+invalid.
+
+The package is Node CommonJS with an eager WASM load. There is no default
+`init`. The public declaration is `index.d.ts`:
+`validateEventPayload(...): unknown`. Node `require()` and ESM `import()`
+both resolve `@band-ai/band-sdk-core` at the package root.
+
+## Build / test
+
+`just check` compiles and lints this crate for the host.
+
+```bash
+just test-wasm   # suite in Node
+just pack-npm    # Node tarball + require/import consumers
+just build-wasm  # Node package output
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@band-ai/band-sdk-core",
-  "version": "0.4.0-dev.1",
+  "version": "0.4.0-dev.2",
   "description": "Shared Band event-payload validation",
   "license": "MIT",
   "repository": {
@@ -10,7 +10,8 @@
   "files": [
     "band_sdk_core.js",
     "band_sdk_core_bg.wasm",
-    "index.d.ts"
+    "index.d.ts",
+    "README.md"
   ],
   "main": "./band_sdk_core.js",
   "types": "./index.d.ts",