{"_id":"@danielasaboro/reef-sdk","_rev":"3-d154138d628f863388bfe06419cddeaf","name":"@danielasaboro/reef-sdk","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"name":"@danielasaboro/reef-sdk","version":"0.1.0","keywords":["fiber-network","observability","diagnostics","ckb","nervos"],"license":"MIT","_id":"@danielasaboro/reef-sdk@0.1.0","maintainers":[{"name":"danielasaboro","email":"asaborodaniel@gmail.com"}],"homepage":"https://docs.usereef.xyz/reference/typescript-sdk","bugs":{"url":"https://github.com/danielAsaboro/reef-fiber/issues"},"bin":{"reef":"dist/cli.js"},"dist":{"shasum":"feee27879b2e58d4bf79336038b79b6654365b96","tarball":"https://registry.npmjs.org/@danielasaboro/reef-sdk/-/reef-sdk-0.1.0.tgz","fileCount":39,"integrity":"sha512-1QEKvzQxKeHaf8SiveTnqBJD+lKIhJZzyLDrIloy8bX6xfHwsTch8iToBW6bcrUCI3UGC0P0nVxb1R8GkBxUAw==","signatures":[{"sig":"MEYCIQDDwjWLZASS4s1cTIluTmJlit1Kq/st0OFB/pwMqRru6wIhAJipDOKtGDTzvnJHLngF9aO+v0pre19+Bfp3heFCuwwS","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":262766},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=20"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist-cjs/index.js"}},"gitHead":"887309e4c345391f28dc936c3e915c3151718597","scripts":{"build":"npm run clean && tsc -p tsconfig.json && tsc -p tsconfig.cjs.json && node -e \"const fs = require('node:fs'); fs.copyFileSync('cjs-package.json', 'dist-cjs/package.json'); fs.chmodSync('dist/cli.js', 0o755)\"","clean":"node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true }); require('node:fs').rmSync('dist-cjs', { recursive: true, force: true })\"","prepack":"npm run build"},"_npmUser":{"name":"danielasaboro","email":"asaborodaniel@gmail.com"},"repository":{"url":"git+https://github.com/danielAsaboro/reef-fiber.git","type":"git","directory":"packages/sdk"},"_npmVersion":"11.9.0","description":"Read-only TypeScript client and CLI for Reef Fiber diagnostics reports.","directories":{},"sideEffects":false,"_nodeVersion":"24.14.0","publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/reef-sdk_0.1.0_1784157546615_0.9239229201595516","host":"s3://npm-registry-packages-npm-production"},"deprecated":"CLI entrypoint does not execute through npm's symlink; use 0.1.1 or later."},"0.1.1":{"name":"@danielasaboro/reef-sdk","version":"0.1.1","keywords":["fiber-network","observability","diagnostics","ckb","nervos"],"license":"MIT","_id":"@danielasaboro/reef-sdk@0.1.1","maintainers":[{"name":"danielasaboro","email":"asaborodaniel@gmail.com"}],"homepage":"https://docs.usereef.xyz/reference/typescript-sdk","bugs":{"url":"https://github.com/danielAsaboro/reef-fiber/issues"},"bin":{"reef":"dist/cli.js"},"dist":{"shasum":"9bf5411690f8ed3e1c6ac23f03b4a724a43dca2c","tarball":"https://registry.npmjs.org/@danielasaboro/reef-sdk/-/reef-sdk-0.1.1.tgz","fileCount":39,"integrity":"sha512-YpfUdU6t4AXeCDS743VIg48JxHG/g17Su3Wu3/0kq2WfqgH5EcF5xiWFLp2cuI79VXnyGWaCzFL+06t9u5GHJA==","signatures":[{"sig":"MEUCIAMUmozhqXDscu5MlyxgqPhOMXP4y7fPCVwpZmGd3QpFAiEAg+oJN1Tpevf/N3vDW2UQweLZQnfnqFCVdGDW/iWqd1w=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":263791},"main":"./dist/index.js","type":"module","types":"./dist/index.d.ts","engines":{"node":">=20"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist-cjs/index.js"}},"gitHead":"887309e4c345391f28dc936c3e915c3151718597","scripts":{"build":"npm run clean && tsc -p tsconfig.json && tsc -p tsconfig.cjs.json && node -e \"const fs = require('node:fs'); fs.copyFileSync('cjs-package.json', 'dist-cjs/package.json'); fs.chmodSync('dist/cli.js', 0o755)\"","clean":"node -e \"require('node:fs').rmSync('dist', { recursive: true, force: true }); require('node:fs').rmSync('dist-cjs', { recursive: true, force: true })\"","prepack":"npm run build"},"_npmUser":{"name":"danielasaboro","email":"asaborodaniel@gmail.com"},"repository":{"url":"git+https://github.com/danielAsaboro/reef-fiber.git","type":"git","directory":"packages/sdk"},"_npmVersion":"11.9.0","description":"Read-only TypeScript client and CLI for Reef Fiber diagnostics reports.","directories":{},"sideEffects":false,"_nodeVersion":"24.14.0","publishConfig":{"access":"public","registry":"https://registry.npmjs.org/"},"_hasShrinkwrap":false,"_npmOperationalInternal":{"tmp":"tmp/reef-sdk_0.1.1_1784157747129_0.4941691768643277","host":"s3://npm-registry-packages-npm-production"}}},"time":{"created":"2026-07-15T23:19:06.483Z","modified":"2026-07-15T23:24:24.793Z","0.1.0":"2026-07-15T23:19:06.739Z","0.1.1":"2026-07-15T23:22:27.283Z"},"bugs":{"url":"https://github.com/danielAsaboro/reef-fiber/issues"},"license":"MIT","homepage":"https://docs.usereef.xyz/reference/typescript-sdk","keywords":["fiber-network","observability","diagnostics","ckb","nervos"],"repository":{"url":"git+https://github.com/danielAsaboro/reef-fiber.git","type":"git","directory":"packages/sdk"},"description":"Read-only TypeScript client and CLI for Reef Fiber diagnostics reports.","maintainers":[{"name":"danielasaboro","email":"asaborodaniel@gmail.com"}],"readme":"# Reef diagnostics SDK\n\n`@danielasaboro/reef-sdk` is a zero-runtime-dependency, read-only TypeScript client for\nReef's bounded report API. It validates every response before returning it and distinguishes HTTP,\ntimeout, network, configuration, and response-contract failures.\n\nThe package ships conditional ESM and CommonJS exports from the same strict TypeScript source.\n\nInstall the public package from npm:\n\n```sh\nnpm install @danielasaboro/reef-sdk\n```\n\n```ts\nimport { ReefClient } from \"@danielasaboro/reef-sdk\";\n\nconst reef = new ReefClient({\n  baseUrl: \"http://127.0.0.1:3000\",\n  timeoutMs: 5_000\n});\n\nconst health = await reef.health();\nconst activeAlerts = (await reef.alerts()).alerts.filter((alert) => alert.status === \"active\");\nconst diagnosis = await reef.diagnosePayment(\"0x…\");\nconst fleet = await reef.fleet();\nconst cch = await reef.cch();\nconst readiness = await reef.paymentReadiness({\n  target_pubkey: \"03…\",\n  amount: \"1000000\",\n  asset: \"ckb\"\n});\n```\n\nThe client exposes only Reef report routes. It cannot call Fiber write RPCs, refresh private source\nstate, mutate Reef settings, or deliver webhooks.\n\nRun the installed CLI with `npx reef`, or build and run it from the Reef repository:\n\n```sh\nnpx reef health --url http://127.0.0.1:3000\nnpm run sdk:build\nnpm run reef -- health\nnpm run reef -- alerts --json\nnpm run reef -- diagnose 0x…\nnpm run reef -- compatibility\nnpm run reef -- fleet\nnpm run reef -- cch\nnpm run smoke:sdk\n```\n\nSet `REEF_URL` or pass `--url` to target a different Reef deployment. A hosted deployment may\nredact endpoint identities and operational details by design.\n","readmeFilename":"README.md"}