@xyo-network/xl1-system-status 4.0.12 → 4.0.14

package/README.md

@@ -1,16 +1,116 @@
+[![logo][]](https://xyo.network)
+
 # @xyo-network/xl1-system-status
 
-System status publishers for XYO Layer One.
+[![npm-badge][]][npm-link]
+[![license-badge][]][license-link]
+
+> Console and HTTP system-status publishers for XL1 services.
+
+## Description
+
+XL1 is the XYO Layer One blockchain protocol. This package publishes
+`SystemStatusRunner` state to operational sinks: console logs and HTTP health
+endpoints.
+
+It does not own the status model itself. The runner, viewer, and protocol
+interfaces live in `@xyo-network/xl1-protocol/protocol-lib`.
+
+## Install
+
+Using npm:
+
+```sh
+npm i --save @xyo-network/xl1-system-status
+```
+
+Using yarn:
+
+```sh
+yarn add @xyo-network/xl1-system-status
+```
+
+Using pnpm:
+
+```sh
+pnpm add @xyo-network/xl1-system-status
+```
+
+Using bun:
+
+```sh
+bun add @xyo-network/xl1-system-status
+```
+
+## Usage
+
+Publish status to Kubernetes-style HTTP probes:
+
+```ts
+import { HttpSystemStatusPublisher } from '@xyo-network/xl1-system-status'
+
+const publisher = new HttpSystemStatusPublisher(statusRunner, { port: 8081 })
+
+await publisher.start()
+```
+
+Available HTTP endpoints:
+
+- `/healthz` - 200 when global status is `started`.
+- `/livez` - 200 while the process is running.
+- `/readyz` - 200 when ready, 503 during startup or shutdown.
+- `/status` - JSON status snapshot.
+
+## Documentation
+
+Exports include:
+
+- `ConsoleSystemStatusPublisher` - logs global status transitions.
+- `HttpSystemStatusPublisher` - serves health endpoints and logs transitions.
+- `resolveStatusProbe` - pure probe routing helper for tests and alternate servers.
+
+Publishers are plain start/stop observers. They do not report their own
+lifecycle into the runner, so they cannot make `/healthz` pass before the real
+service stack has started.
+
+## AI Agent Skills
+
+Install the recommended XL1/XYO skills with [Skills.sh](https://skills.sh):
+
+```sh
+npx skills add XYOracleNetwork/xyo-skills --all
+```
+
+In XY toolchain repos, the equivalent convenience command is:
+
+```sh
+pnpm xy skills defaults
+pnpm xy skills lint --fix
+```
+
+For XL1 work, ask your agent to use `xyo-knowledge`, `xl1-knowledge`, and
+`xl1-patterns`. These skills cover XYO primitives, XL1 chain and gateway APIs,
+and application patterns for XL1 dApps.
+
+## Building Locally
+
+```sh
+pnpm xy build @xyo-network/xl1-system-status
+pnpm xy test @xyo-network/xl1-system-status
+pnpm xy lint @xyo-network/xl1-system-status
+```
+
+## License
+
+See the [LICENSE](./LICENSE) file for license rights and limitations
+(LGPL-3.0-only).
 
-The status model itself — the `SystemStatusRunner` hub, the `SystemStatusViewer`
-read facade, and their interfaces — lives in `@xyo-network/xl1-protocol-lib` and
-`@xyo-network/xl1-protocol-sdk`. This package provides the **publishers** that
-emit that status outward:
+## Credits
 
-- `ConsoleSystemStatusPublisher` — logs global status transitions via a logger.
-- `HttpSystemStatusPublisher` — serves Kubernetes-style probes (`/healthz`,
-  `/livez`, `/readyz`) plus a `/status` JSON snapshot over `node:http`.
+[Made with 🔥 and ❄️ by XYO Foundation](https://xyo.network)
 
-Both are plain start/stop observers (not creatable providers): they read the
-Runner and never report their own lifecycle into it, so they cannot skew the
-aggregate status (no false `/healthz` 200).
+[npm-badge]: https://img.shields.io/npm/v/@xyo-network/xl1-system-status.svg
+[npm-link]: https://www.npmjs.com/package/@xyo-network/xl1-system-status
+[license-badge]: https://img.shields.io/npm/l/@xyo-network/xl1-system-status.svg
+[license-link]: ./LICENSE
+[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png

package/package.json

@@ -1,7 +1,7 @@
 {
   "$schema": "http://json.schemastore.org/package.json",
   "name": "@xyo-network/xl1-system-status",
-  "version": "4.0.12",
+  "version": "4.0.14",
   "description": "XYO Layer One system status publishers (console + HTTP health endpoints)",
   "homepage": "https://xylabs.com",
   "bugs": {
@@ -35,11 +35,13 @@
     "README.md"
   ],
   "dependencies": {
-    "@xyo-network/xl1-protocol": "~4.0.12"
+    "@xyo-network/xl1-protocol": "~4.0.14"
   },
   "devDependencies": {
     "@ariestools/sdk": "~8.0.3",
     "@ariestools/threads": "~8.0.3",
+    "@ariestools/toolchain": "~8.6.12",
+    "@ariestools/tsconfig": "~8.6.12",
     "@bitauth/libauth": "~3.0.0",
     "@metamask/json-rpc-engine": "~10.5.0",
     "@metamask/providers": "~22.1.1",
@@ -48,8 +50,6 @@
     "@opentelemetry/sdk-trace-base": "~2.9.0",
     "@scure/base": "~2.2.0",
     "@scure/bip39": "~2.2.0",
-    "@xylabs/toolchain": "~8.6.10",
-    "@xylabs/tsconfig": "~8.6.10",
     "@xyo-network/sdk": "~7.0.11",
     "@xyo-network/sdk-protocol": "~7.0.15",
     "ajv": "~8.20.0",
@@ -65,7 +65,7 @@
     "vitest": "~4.1.10",
     "webextension-polyfill": "~0.12.0",
     "zod": "~4.4.3",
-    "@xyo-network/xl1-sdk": "~4.0.12"
+    "@xyo-network/xl1-sdk": "~4.0.14"
   },
   "peerDependencies": {
     "@ariestools/sdk": "^8.0.3",