@hs-x/checkpoint 0.1.0 → 0.1.3

package/README.md

@@ -1,8 +1,26 @@
 # @hs-x/checkpoint
 
-Checkpoint observability primitives for HS-X runtime instrumentation.
-
-This package defines fingerprinting, redaction, exemplar policy, fake writer behavior, and Cloudflare binding writers against the canonical schemas in `@hs-x/types`.
+`@hs-x/checkpoint` is HS-X's observability primitive layer — how a deployed app
+records what each capability invocation did (its outcome, duration, and an error
+fingerprint) without leaking sensitive values. It defines fingerprinting,
+redaction, exemplar sampling policy, fake/in-memory writers for tests, and the
+Cloudflare binding writers that persist the data, all against the canonical
+schemas in [`@hs-x/types`](https://www.npmjs.com/package/@hs-x/types).
+
+You normally do **not** install this directly. It is a transitive dependency of
+[`@hs-x/runtime`](https://www.npmjs.com/package/@hs-x/runtime), which calls it
+for you when you enable checkpointing in `createRuntime(...)`. A fake-writer
+surface for tests is published at the `@hs-x/checkpoint/test` subpath.
+
+## Recording an invocation
+
+`recordCheckpointInvocation(...)` (and its Effect form,
+`recordCheckpointInvocationEffect(...)`) emits a metric event plus, when the
+exemplar policy selects it, a redacted exemplar to the configured
+`CheckpointWriter`. `fingerprintError(...)` produces the stable error fingerprint
+used to group failures; `redactCheckpointValue(...)` strips sensitive fields
+before anything is stored. The sampling/budget rules come from
+`createExemplarPolicy(...)`.
 
 ## Cloudflare writer
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hs-x/checkpoint",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "description": "HS-X Checkpoint observability primitives — metrics, exemplars, fingerprinting, and redaction.",
   "type": "module",
   "main": "./dist/index.js",
@@ -34,5 +34,6 @@
   },
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "license": "Apache-2.0"
 }