@hivemagnus/hive-common 0.0.0-stage → 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+All notable changes to `@hivemagnus/hive-common` are recorded here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project uses
+[Semantic Versioning](https://semver.org/).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-11-12
+
+First release: the shared server kit that replaces each product's own copy of the Oathweave
+verifier and its own error, health and request-ID conventions.
+
+### Added
+
+- `/oathweave`: Oathweave access-token verifier. RS256 only, JWKS with caching and refetch on an
+  unknown key ID, exact issuer (one or several) and audience, `exp`/`nbf`/`iat` with clock
+  tolerance, fifteen-minute lifetime limit, user and service principals (a service token's client
+  ID equals its subject), scopes, roles and permissions, optional online session check through
+  userinfo with a 10 s shared cache, stream re-check, identity links and permission helpers.
+  Refusals are `OathweaveError`s with a stable `reason` and 401, 403 or 503.
+- `/oathweave/conformance` and `test-vectors/oathweave/`: twelve pre-signed conformance vectors at
+  a fixed clock and `runOathweaveConformance()`, so every product can test its verifier.
+- `/errors`: `HiveError`, the `{ error: { code, message, requestId?, details? } }` envelope,
+  `toErrorResponse()`, and `parseHiveError()` for every legacy error shape in the suite.
+  Isomorphic.
+- `/health`: `/health/live` and `/health/ready` with named, time-limited dependency checks,
+  200/503, and optional legacy path aliases.
+- `/context`: request IDs (`x-request-id`, accepting `x-hive-request-id` and `x-correlation-id`),
+  W3C `traceparent`, idempotency keys, an AsyncLocalStorage request context and
+  `outboundHeaders()`.
+- `/registry`: typed Hive Registry client with custom CA or fetch injection.
+- `/log`: structured JSON logger with request IDs from the context, and `redact()`.
+- `/events`: HiveEvent feed helpers and `ChatterMostNotifier` (timeout, retries with backoff,
+  deduplication by event ID).
+- `/contracts`: isomorphic types and dependency-free validators for the envelope, HiveEvent v1,
+  pagination and agent identity.
+- `/hono` and `/node-http` adapters for auth, request context, the error envelope and health.
+
+[Unreleased]: https://github.com/ChefTaco/HiveCommon/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/ChefTaco/HiveCommon/releases/tag/v0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,11 @@
+HiveCommon (@hivemagnus/hive-common)
+Copyright 2026 ChefTaco and contributors
+
+This product includes software developed by ChefTaco and contributors
+(https://github.com/ChefTaco/HiveCommon).
+
+The Oathweave access-token verification consolidates the verifiers of the Oathweave SDK
+(https://github.com/ChefTaco/Oathweave), Magnus (https://github.com/ChefTaco/magnus) and the
+other Hive:Magnus products, licensed under the Apache License 2.0.
+
+JWT and JWKS handling uses jose (https://github.com/panva/jose), licensed under the MIT License.

package/README.md

@@ -1,3 +1,383 @@
-# Temporary Holding Version
+# HiveCommon
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+`@hivemagnus/hive-common` is the shared server kit of the Hive:Magnus suite. It gives every
+product one Oathweave token verifier, one error envelope, one way to serve health, propagate
+request IDs and trace context, read the Hive Registry, log safely and publish HiveEvents.
+
+- ESM only, TypeScript with `.d.ts` output, strict types.
+- One runtime dependency (`jose`); `hono` is an optional peer.
+- Each module is its own subpath, so a product loads only what it uses.
+- `/contracts` and `/errors` are isomorphic, so the browser UI can use them too.
+
+```bash
+npm install @hivemagnus/hive-common
+```
+
+| Subpath | What it is | Runs in |
+| --- | --- | --- |
+| [`/oathweave`](#oathweave) | Oathweave access-token verifier, identity links, permissions, stream re-check | Node |
+| [`/oathweave/conformance`](#conformance-vectors) | Runs the shipped test vectors against any verifier | Node |
+| [`/errors`](#errors) | `HiveError`, the envelope, `toErrorResponse()`, `parseHiveError()` | Node, browser |
+| [`/health`](#health) | `/health/live` and `/health/ready` with dependency checks | Node |
+| [`/context`](#context) | Request IDs, `traceparent`, idempotency keys, async request context | Node |
+| [`/registry`](#registry) | Typed Hive Registry client | Node |
+| [`/log`](#log) | Structured JSON logger and `redact()` | Node |
+| [`/events`](#events) | HiveEvent feed helpers and the ChatterMost notifier | Node |
+| [`/contracts`](#contracts) | Isomorphic types and validators | Node, browser |
+| [`/hono`](#hono) | Hono middleware | Node |
+| [`/node-http`](#node-http) | `node:http` helpers | Node |
+
+## Node support policy
+
+HiveCommon supports the active and maintenance LTS lines of Node.js at their latest security
+release: currently **Node.js 24.22.3+ and 26.13.1+** (`"engines": "^24.22.3 || ^26.13.1"`). When
+Node publishes a security release, the minimums move up in the next HiveCommon release. A Node
+line is dropped, in a minor release, when it reaches end of life. CI tests every supported line.
+
+## Standards
+
+### Error envelope
+
+Every error response in the suite has this body, `Content-Type: application/json` and
+`Cache-Control: no-store`:
+
+```json
+{ "error": { "code": "not_found", "message": "No such project", "requestId": "2f1c…", "details": { "id": "p1" } } }
+```
+
+- `code`: stable, machine-readable, `lower_snake_case` for new codes.
+- `message`: for people. Never contains secrets, stack traces or upstream bodies.
+- `requestId`: the request's `x-request-id`, when known.
+- `details`: optional structured data, such as validation `issues` or an auth `reason`.
+
+Statuses: 400 malformed, 401 missing or invalid credentials (with `WWW-Authenticate`), 403 known
+caller without access, 404, 409, 422 validation, 428 missing precondition (idempotency key), 429
+(with `Retry-After`), 500 internal (generic message only), 503 dependency unavailable.
+
+### Headers
+
+| Header | Rule |
+| --- | --- |
+| `x-request-id` | Read inbound; also accept `x-hive-request-id` and `x-correlation-id`. Generate a UUID when absent or unsafe (1-128 of `[A-Za-z0-9._:@/+=-]`). Echo it on the response and send it to peers. |
+| `traceparent`, `tracestate` | W3C Trace Context. Continue a valid inbound trace with a new span; otherwise start one. Send this service's span to peers. |
+| `Idempotency-Key` | Required on retried mutations; `x-idempotency-key` is accepted too. Both present and different is a 400. |
+| `Authorization: Bearer` | Oathweave access token, RS256. |
+
+### Health
+
+`GET /health/live` is 200 whenever the process can answer and never touches dependencies.
+`GET /health/ready` runs the named checks and is 200 (`ready` or `degraded`) or 503 (`not_ready`):
+
+```json
+{ "status": "not_ready", "service": "hivemem", "version": "1.4.0", "time": "2026-11-12T08:00:00.000Z",
+  "checks": { "database": { "status": "down", "critical": true, "latencyMs": 2001, "error": "timeout" } } }
+```
+
+## Modules
+
+### oathweave
+
+```ts
+import { createOathweaveVerifier, requireIdentityLink, parseIdentityLinks } from '@hivemagnus/hive-common/oathweave';
+
+const verifier = createOathweaveVerifier({
+  issuer: process.env.OATHWEAVE_ISSUER!,          // https only; an array accepts several issuers
+  audience: 'hivemem',                            // this product's resource audience, exact match
+  jwksUrl: process.env.OATHWEAVE_JWKS_URL!,
+  userinfoUrl: process.env.OATHWEAVE_USERINFO_URL, // online session check, recommended
+  accept: 'user',                                 // default; 'service' or 'any' per route
+});
+
+const principal = await verifier.verifyAuthorization(request.headers.get('authorization'));
+// principal.kind === 'user': subject, sessionId, clientId, roles, permissions, scopes, displayName, authTime…
+// principal.kind === 'service': a client-credentials token whose client ID equals its subject.
+
+const links = parseIdentityLinks(process.env.HIVEMEM_OATHWEAVE_IDENTITIES_JSON!, { roles: ['ADMIN', 'VIEWER'] });
+const link = requireIdentityLink(links, principal); // 403 not_linked unless exactly one link matches
+```
+
+What it checks, in order: a compact JWT of at most 16 KiB; header `alg` is `RS256` (so `none` and
+HMAC key confusion never reach a key); signature against the JWKS (cached for 10 minutes and
+refetched, at most every 30 s, when a token names an unknown `kid`); `iss` is one of the issuers;
+`aud` is exactly the audience; `sub`, `iat`, `exp`, `jti` present; `exp`, `nbf` and `iat` within
+30 s of clock tolerance; `exp - iat` and token age at most 900 s; then the principal rules:
+
+- **User:** `actorType: "USER"`, a `sessionId`, a `clientId` other than the subject, string-array
+  `permissions` and (optional) `roles`. With `userinfoUrl`, the session is confirmed online; the
+  answer is shared for 10 s from when the request started (failures for 2 s).
+- **Service:** `clientId` (or `client_id`) equals `sub`, `actorType: "SERVICE_ACCOUNT"`,
+  `token_type: "access"`, no session.
+
+Every refusal is an `OathweaveError` (a `HiveError`) with a stable `reason`:
+
+| Status | Code | Reasons |
+| --- | --- | --- |
+| 401 | `unauthorized` | `missing_token` |
+| 401 | `invalid_token` | `malformed_token`, `algorithm_not_allowed`, `unknown_key`, `invalid_signature`, `expired`, `not_yet_valid`, `invalid_issuer`, `invalid_audience`, `invalid_lifetime`, `invalid_claims`, `wrong_principal_kind`, `session_inactive`, `subject_mismatch` |
+| 403 | `forbidden` / `insufficient_permission` | `not_linked`, `insufficient_permission` |
+| 503 | `auth_unavailable` | `jwks_unavailable`, `identity_unavailable` |
+
+Also: `hasPermissions()` (with `*` segment wildcards, like the Oathweave SDK), `requirePermissions()`,
+`hasAnyRole()`, `hasScopes()`, `effectivePermissions()` (a link's ceiling), and
+`watchStreamAuthorization()` for SSE and WebSocket connections:
+
+```ts
+const watch = watchStreamAuthorization({
+  recheck: () => verifier.verify(token), // every 5 s; the session cache keeps it cheap
+  expiresAt: principal.expiresAt,        // ends the stream at token expiry
+  onEnd: () => stream.close(),           // sign-out takes effect within about 15 s
+});
+```
+
+Endpoints must be `https`. For tests against a loopback server, pass `allowInsecureLoopback: true`.
+
+### Conformance vectors
+
+`test-vectors/oathweave/vectors.json` ships a test JWKS and twelve pre-signed tokens (valid user,
+valid service, expired, not yet valid, wrong audience, wrong issuer, bad signature, unknown `kid`,
+`alg: none`, HS256 key confusion, overlong lifetime, user without session), evaluated at a fixed
+clock so they never expire. Run them against your product's verifier:
+
+```ts
+import { runOathweaveConformance } from '@hivemagnus/hive-common/oathweave/conformance';
+
+it('meets the Oathweave conformance vectors', async () => {
+  await runOathweaveConformance((token, ctx) => createProductVerifier({
+    issuer: ctx.issuer, audience: ctx.audience, jwksUrl: ctx.jwksUrl, userinfoUrl: ctx.userinfoUrl,
+    fetch: ctx.fetch,          // serves the vectors' JWKS and userinfo
+    now: () => ctx.nowMs,      // the fixed clock
+  })(token));
+});
+```
+
+It throws a readable error listing failed vectors. A refusal passes when the verifier rejects
+(and any numeric `status` on the error matches); `strictReasons: true` also compares `reason`.
+
+### errors
+
+```ts
+import { HiveError, toErrorResponse, parseHiveError, parseHiveErrorResponse } from '@hivemagnus/hive-common/errors';
+
+throw new HiveError('quota_exceeded', 'Monthly quota reached', { status: 429, details: { limit: 1000 } });
+throw HiveError.notFound('No such project');
+
+const { status, body, headers } = toErrorResponse(error, { requestId, onUnexpected: e => log.error('unhandled', { err: e }) });
+
+const error = await parseHiveErrorResponse(await fetch(url)); // any product, any legacy shape
+if (HiveError.is(error, 'not_found')) { /* … */ }
+```
+
+`parseHiveError(status, body)` accepts text, bytes or parsed JSON and recognises every shape the
+suite has used; `error.shape` says which. Remote codes are kept as sent (compare with
+`HiveError.is()`, case-insensitively); messages are bounded and cleaned; HTML error pages are
+replaced by the status's default message.
+
+| Shape | Body | Products |
+| --- | --- | --- |
+| `envelope` | `{error:{code,message,requestId?,details?}}` | Hive standard, Ardent, ArdentStudio, Registry |
+| `magnus` | `{success:false,error:{code,message}}` | Magnus |
+| `oathweave` | `{error:"CODE",message}` | Oathweave |
+| `string` | `{error:"human text"}` | Emberpath, HiveSkills, Cindertrace |
+| `code` | `{error:"CODE"}` | Embermend, OAuth without description |
+| `fastapi` / `fastapi-validation` | `{detail:"text"}` / `{detail:[{loc,msg,type}]}` | HiveMem |
+| `mattermost` | `{id,message,status_code,request_id}` | ChatterMost |
+| `oauth` | `{error,error_description}` | OAuth 2.0 endpoints |
+| `message`, `text`, `empty`, `unknown` | `{message}`, plain text, no body, anything else | proxies and others |
+
+### health
+
+```ts
+import { createHealth } from '@hivemagnus/hive-common/health';
+
+const health = createHealth({
+  service: 'hivemem', version: '1.4.0',
+  timeoutMs: 2000,
+  checks: [
+    { name: 'database', check: () => db.ping() },
+    { name: 'search', critical: false, check: signal => fetch(searchUrl, { signal }).then(r => r.ok) },
+  ],
+  aliases: true, // also serve /health, /healthz, /livez, /live, /api/health, /ready, /readyz
+});
+const response = await health.handle('/health/ready'); // { status: 200 | 503, body, headers } or undefined
+```
+
+A check is down when it throws, returns `false` or `{ ok: false }`, or exceeds its timeout (its
+`signal` aborts). Error text is hidden unless `exposeErrors: true`. Serve legacy aliases only
+while old clients still call them.
+
+### context
+
+```ts
+import { createRequestContext, runWithRequestContext, getRequestContext, outboundHeaders, readIdempotencyKey } from '@hivemagnus/hive-common/context';
+
+const context = createRequestContext(req.headers);          // { requestId, trace, parentTrace, tracestate, … }
+await runWithRequestContext(context, () => handle(req));
+// anywhere below:
+await fetch(peerUrl, { headers: { ...outboundHeaders(), authorization } });
+const key = readIdempotencyKey(req.headers);                // string | undefined; 400 on malformed or conflicting
+```
+
+Also `parseTraceparent()`, `formatTraceparent()`, `generateTraceparent()`, `childTraceparent()`,
+`readRequestId()`, `requireIdempotencyKey()` (428 when missing). On an edge service exposed to the
+internet, pass `trustInbound: false` so callers cannot choose IDs.
+
+### registry
+
+```ts
+import { createRegistryClient } from '@hivemagnus/hive-common/registry';
+
+const registry = createRegistryClient({
+  baseUrl: 'https://hive.example.com/api/registry', // or the native private-network URL with allowHttp
+  token: process.env.HIVE_REGISTRY_READ_TOKEN,       // omit for the public view
+  ca: process.env.HIVE_REGISTRY_CA_PEM,              // optional private CA; or pass fetch
+  trust: { emberpath: { ca: emberpathCaPem } },      // TLS trust per product, from local config
+});
+const installation = await registry.installation();
+const installed = await registry.installedProducts();
+const endpoint = await registry.endpoint('emberpath'); // { url, internal, trust } or undefined
+```
+
+`product()` and `connection()` return `undefined` for unknown products; other failures are
+`HiveError`s parsed from the registry's envelope. The registry stores no TLS material, so
+`endpoint()` returns the trust you configure. `createCaFetch({ ca })` is a small `node:https`
+fetch that trusts only the given CA.
+
+### log
+
+```ts
+import { createLogger, redact } from '@hivemagnus/hive-common/log';
+
+const log = createLogger({ bindings: { service: 'hivemem' } }); // level from LOG_LEVEL, default info
+log.info('memory stored', { memoryId, bytes });                 // adds requestId and traceId from the context
+const jobLog = log.child({ job: 'reindex' });
+log.error('upstream failed', { err, headers: req.headers });    // authorization and cookies masked
+```
+
+`redact()` masks values under secret-looking keys (authorization, cookie, password, secret, token,
+`*key`, credentials, webhook URLs, session IDs) and scrubs strings everywhere: bearer and basic
+credentials, JWTs, provider token formats, private keys, URL credentials and secret query
+parameters. Numbers and booleans under such keys are kept, so `inputTokens: 512` survives.
+
+### events
+
+```ts
+import { ChatterMostNotifier, parseFeedQuery, feedPage, encodeCursor } from '@hivemagnus/hive-common/events';
+
+// GET /v1/hive/events?after=<cursor>&limit=<n>
+const { after, limit } = parseFeedQuery(url.searchParams);       // limit 1-200, default 50
+const rows = store.eventsAfter(after, limit + 1);
+return Response.json(feedPage(rows.map(toHiveEvent), limit, event => encodeCursor({ id: event.id })));
+
+const notifier = new ChatterMostNotifier({
+  webhookUrl: process.env.CHATTERMOST_WEBHOOK_URL!, // a secret; never logged
+  linkBaseUrl: 'https://hive.example.com',
+});
+await notifier.notify(event); // { status: 'sent' | 'duplicate' | 'failed', attempts }
+```
+
+The notifier validates the event, posts a Mattermost incoming-webhook payload (Markdown and
+mentions in event text are neutralised), times out each attempt, retries 408, 429 (honouring
+`Retry-After`), 5xx and network errors with exponential backoff and jitter, and delivers each
+event ID once per 24 h. Pass a shared `DedupeStore` to deduplicate across replicas.
+
+### contracts
+
+```ts
+import { validateHiveEvent, type HiveEvent, type Page, type ErrorEnvelope } from '@hivemagnus/hive-common/contracts';
+
+const result = validateHiveEvent(json);           // { ok: true, value } | { ok: false, issues }
+```
+
+HiveEvent v1:
+
+```ts
+interface HiveEvent {
+  id: string; product: string; type: string; severity: 'info' | 'warning' | 'critical';
+  title: string; summary: string; occurredAt: string; // RFC 3339 UTC
+  subject?: { actorId?: string; agentRef?: string; nodeId?: string };
+  link: { product: string; path: string };            // same-origin console path
+  sourceRef?: string;
+}
+```
+
+Also `Page<T>` (`{ data, nextCursor }`), `AgentIdentity` (`{ agentRef: "<nodeId>~<profile>",
+actorId }`, segments `[a-z0-9_-]{2,32}`), `ErrorEnvelope`, `HIVE_HEADERS`. Validators drop unknown
+fields by default; producers should pass `{ strict: true }`. The validators are hand-written so
+the browser bundle gains no dependency.
+
+### hono
+
+```ts
+import { Hono } from 'hono';
+import { requestContext, oathweaveAuth, requirePermission, errorHandler, notFoundHandler, registerHealthRoutes, requirePrincipal, type HiveEnv } from '@hivemagnus/hive-common/hono';
+
+const app = new Hono<HiveEnv>();
+app.use(requestContext());
+registerHealthRoutes(app, { checks, aliases: true });
+app.use('/v1/*', oathweaveAuth(verifier, { authorize: principal => { requireIdentityLink(links, principal); } }));
+app.get('/v1/memories', requirePermission(['hivemem:read']), c => c.json(list(requirePrincipal(c))));
+app.onError(errorHandler({ logger: log }));
+app.notFound(notFoundHandler());
+```
+
+Requires `hono` 4.13.18 or later, the suite minimum since a recent Hono security advisory.
+
+### node-http
+
+```ts
+import http from 'node:http';
+import { hiveHandler, authenticate, sendJson } from '@hivemagnus/hive-common/node-http';
+
+http.createServer(hiveHandler(async (req, res) => {
+  const principal = await authenticate(req, verifier);
+  sendJson(res, 200, { subject: principal.subject });
+}, { health: { checks }, logger: log })).listen(8080);
+```
+
+`hiveHandler()` adds the request context, health routes and the error envelope; anything thrown
+becomes an envelope, and a handler that sends nothing gets a 404.
+
+## Adopting HiveCommon in a product
+
+1. **Install** `@hivemagnus/hive-common` (and `hono` ≥ 4.13.18 for Hono products).
+2. **Replace the verifier copy.** Delete `oathweave.ts` / `oathweave-verifier.ts` and build the
+   verifier with `createOathweaveVerifier()` from the same `OATHWEAVE_*` settings. Use
+   `accept: 'service'` (or `'any'`) on routes that took the separate service verifier. Map
+   principals through `parseIdentityLinks()` / `requireIdentityLink()`.
+3. **Add the conformance test** with `runOathweaveConformance()` and keep the old verifier tests
+   that cover product-specific rules.
+4. **Adopt the envelope.** Throw `HiveError`s and install `errorHandler()` / `hiveHandler()`.
+   Keep the old body shape only for clients that still parse it, and plan its removal.
+   Clients (including HiveXUI) parse peers with `parseHiveError()`.
+5. **Adopt request context.** Install `requestContext()`, log with `createLogger()`, and pass
+   `outboundHeaders()` on calls to peers.
+6. **Serve `/health/live` and `/health/ready`**, with `aliases` for paths current deployments probe.
+7. **Publish HiveEvents** at `GET /v1/hive/events` with `feedPage()`, and announce through
+   `ChatterMostNotifier` where the product posts to ChatterMost today.
+
+Behaviour that changes when a product adopts the shared verifier:
+
+- Clock tolerance is 30 s (the copies used 0).
+- An unreachable JWKS or userinfo is a 503 `auth_unavailable`, not a 401, so clients retry
+  instead of signing people out. Access is still refused.
+- A missing `roles` claim means no roles instead of a refusal (ArdentStudio already allowed it).
+- `authTime` is epoch seconds, `undefined` when absent or invalid (Magnus semantics; some copies
+  exposed `authenticatedAt` in milliseconds).
+- Duplicate identity links fail at startup by default (`duplicates: 'ignore'` keeps the old
+  Magnus behaviour of granting nothing to that identity).
+
+## Development
+
+```bash
+npm ci
+npm run hooks:install
+npm run verify        # privacy tests, scans, typecheck, lint, tests, build, package check
+npm run test:coverage
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) and [AGENTS.md](AGENTS.md). Security reports:
+[SECURITY.md](SECURITY.md).
+
+## License
+
+[Apache License 2.0](LICENSE). See [NOTICE](NOTICE).