Private
Public Access
warkanumandClaude Sonnet 5
2590e404f5
CI / rust (push) Successful in 3m6s
CI / go (push) Successful in 33s
CI / js (push) Successful in 34s
Standalone clients that resolve a machine unique ID (OS machine ID first, falling back to a generated UUID persisted to disk), detect hostname/IP/ container/orchestrator, and register+re-ping origin.warky.dev's public service-checkin endpoint on a daily interval. Ported from icy2's internal origincheckin package but extended to the full check-in contract and made dependency-light for external reuse. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
48 lines
1.4 KiB
Markdown
48 lines
1.4 KiB
Markdown
# @warkanum/origin-client (JS/TS)
|
|
|
|
```
|
|
npm install @warkanum/origin-client
|
|
```
|
|
|
|
Node >=18, ESM only.
|
|
|
|
## Usage
|
|
|
|
```ts
|
|
import { OriginClient } from "@warkanum/origin-client";
|
|
|
|
const client = new OriginClient({
|
|
serviceKey: "...",
|
|
type: "myservice",
|
|
version: "1.2.3",
|
|
name: "myservice-nova",
|
|
});
|
|
|
|
client.start(); // immediate check-in, then every 24h until stop()
|
|
```
|
|
|
|
Call `client.checkinOnce()` directly instead of `start()` to send a single
|
|
check-in and observe the result/error.
|
|
|
|
## Config
|
|
|
|
| Field | Required | Default |
|
|
|---|---|---|
|
|
| `serviceKey` | yes | — |
|
|
| `type`, `version`, `name` | yes | — |
|
|
| `url` | no | `DEFAULT_URL` (`https://origin.warky.dev/api/public/service-checkin`) |
|
|
| `appType` | no | `"javascript"` |
|
|
| `hostname` | no | OS hostname |
|
|
| `containerId` | no | best-effort Docker/cgroup detection |
|
|
| `orchestrator` | no | best-effort Kubernetes/Docker detection |
|
|
| `installId` | no | OS machine ID, else a generated UUID persisted to `installIdPath` |
|
|
| `intervalHours` | no | `DEFAULT_INTERVAL_HOURS` (24) |
|
|
| `logger` | no | discards warnings |
|
|
|
|
`site`, `environment`, `databaseType`, `databaseName`, `port`, `baseUrl`,
|
|
`internalUrl`, `description` are optional metadata with no default.
|
|
|
|
`hostname()`, `outboundIp()`, `containerId()`, `orchestrator()`, and
|
|
`resolveMachineId()` are exported standalone for callers that want the
|
|
detection logic without the HTTP client.
|