wardx 0.1.3 → 0.1.5

package/README.md

@@ -6,6 +6,41 @@ The SDK records logs, events, and metrics. The SDK also gets Remote Config and a
 
 A measure call changes local memory only. The SDK sends frames on a timer. The SDK uses HTTP `POST /v1/sync` with JSON and gzip.
 
+```text
+                         AGENT
+                  arisa.sh / Codex / Claude
+                             │
+                    MCP stdio
+                    tools + wardx://project/{name}
+                             ▼
+┌───────────────────────────────────────────────────┐
+│              wardx-server (one process)           │
+│              N isolated projects                  │
+│                                                   │
+│   MCP ──► ControlService                          │
+│              ├── Remote Config snapshot            │
+│              ├── Experiment definitions            │
+│              ├── Aggregates                       │
+│              ├── Recent logs                      │
+│              └── Catalog                          │
+│                                                   │
+│   HTTP POST /v1/sync                              │
+│        ├── envelope store (config.sink)            │
+│        │     null | memory | ndjson               │
+│        └── per-project ingest                     │
+│              aggregator, recent logs, clients     │
+│              config reply filtered by client.role   │
+└─────────────────────────▲─────────────────────────┘
+                          │
+             frames up / that role's config down
+          ┌───────────────┴───────────────┐
+          ▼                               ▼
+   Node SDK                          C# / Unity SDK
+   wardx / @wardx/core               clients/csharp
+   role: game-server                 role: mobile
+   metrics / config.get               same /v1/sync
+```
+
 ## Install
 
 ```bash
@@ -18,6 +53,13 @@ import { createWardx } from 'wardx';
 
 To receive frames, run an ingest server. Install `@wardx/server` and start it with a config file.
 
+> [!NOTE]
+> **Agent skill.** Teach the agent this Node SDK with the [Skills CLI](https://skills.sh):
+>
+> ```bash
+> npx skills add https://github.com/clasen/Wardx --skill wardx
+> ```
+
 ## Design rules
 
 - A measure call does not send network data.
@@ -333,7 +375,7 @@ function grantCoins(wardx, grant) {
 2. On the grant path, add the amount to `coins.awarded` and increment `coins.grants`. The dimension is `source`, not a user id.
 3. Observe the amount in `coins.award_size` with a lookup key (`grantId`). The histogram keeps those attrs only for the window max, as `exemplar`. Histogram `max` and the upper buckets are the inconsistency signal. The exemplar is the row to open in the database.
 4. Read `economy.maxAward` from Remote Config. Emit `coins.anomaly` only when a grant exceeds that bound. That event is rare.
-5. From MCP, compare `coins.awarded / coins.grants` (mean grant) and `coins.award_size` max against `economy.maxAward`. If max is high, read `exemplar.attrs.grantId`.
+5. From MCP, the overview ranks histogram outcomes by `max` and includes the exemplar. Compare that max and `coins.awarded / coins.grants` (mean grant) against `economy.maxAward`. If max is high, read `exemplar.attrs.grantId`, then `get_recent_logs` with `coins_anomaly` or that `grantId`. If the role has `path` or `git`, search that checkout for `source` / `reason`. See `@wardx/server` use case 9.
 
 Do not put `userId` on a counter or histogram dimension. The SDK and the server cap series. A unique id per player creates a series per player and then drops. An exemplar is one sample per series per window, so a lookup key there does not explode cardinality. Do not `event()` once per grant on a backend that serves many users. Use an event only for the anomaly.
 
@@ -530,8 +572,8 @@ On a process that serves many users, skip `identify()` and pass `{ subjectId }`
 1. Start a local clock when the play session starts. Do not use `sessionId`.
 2. When it ends, observe `session.duration` with minute-scale buckets. Default histogram buckets are for short durations in milliseconds.
 3. Add the same number to `session.time_ms`. Increment `session.ended`.
-4. Call `experiment.goal('session.duration', { value: durationMs })` with a subject. Emit that goal once per ended session. `analyze_experiment` then has `goalSum` and `goalMean` per variant. Mean session ms is `goalSum / goals`.
-5. From MCP, read `session.time_ms` in `get_aggregates` for fleet minutes. Compare variants with `analyze_experiment`, not with a counter dimension.
+4. Call `experiment.goal('session.duration', { value: durationMs })` with a subject. Emit that goal once per ended session. `analyze_experiment` then has `goalSum`, `goalMean`, and a `decision` per variant. Mean session ms is `goalSum / goals`.
+5. From MCP, read `session.time_ms` in `get_aggregates` for fleet minutes. Compare variants with `analyze_experiment`, not with a counter dimension. Ship a winner with `ship_experiment`.
 
 Do not put `userId` on the histogram. Do not emit `experiment.goal` on every heartbeat: that would count many goals for one session. The heartbeat only adds to `session.time_ms`.
 
@@ -570,7 +612,7 @@ The volume funnel `level.start` → `level.fail` / `level.complete` is the diffi
 
 Call `experiment.goal('session.duration', { value: durationMs })` when the play session ends (use case 14).
 
-From MCP, after onboarding: `upsert_experiment` on the existing keys (`level.3.enemyHp`, …) with a hypothesis such as "Lower HP on level 3 increases session duration", `primaryMetric: 'session.time_ms'`, and variants that only change those keys. Later `analyze_experiment`: compare `goalMean` for the duration goal. Compare the funnel counts with `get_aggregates`. See `@wardx/server` use case 7.
+From MCP, after onboarding: `upsert_experiment` on the existing keys (`level.3.enemyHp`, …) with a hypothesis such as "Lower HP on level 3 increases session duration", `primaryMetric: 'session.time_ms'`, `goalKind: 'mean'`, `control`, `minExposures`, `confidence`, and variants that only change those keys. Later `analyze_experiment`: follow `decision` and compare `goalMean` for the duration goal. `ship_experiment` when status is `winner`. Compare the funnel counts with `get_aggregates`. See `@wardx/server` use case 7.
 
 ## Use case 16: Surface an error so an agent can open the source
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wardx",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "Node.js SDK for Wardx telemetry, Remote Config, and experiments.",
   "keywords": [
     "wardx",
@@ -26,12 +26,17 @@
     "node": ">=20"
   },
   "exports": {
-    ".": "./src/index.js"
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.js",
+      "default": "./src/index.js"
+    }
   },
+  "types": "./src/index.d.ts",
   "files": [
     "src"
   ],
   "dependencies": {
-    "@wardx/core": "0.1.3"
+    "@wardx/core": "0.1.5"
   }
-}
+}

package/src/index.d.ts

@@ -0,0 +1,88 @@
+import type {
+  Attrs,
+  ConfigSnapshot,
+  ConfigValue,
+  CoreSettings,
+  CounterHandle,
+  CreateWardxOptions,
+  DimensionValue,
+  Dimensions,
+  EventTraceRecord,
+  Experiment,
+  ExperimentGoalContext,
+  ExperimentVariant,
+  FrameTraceRecord,
+  GaugeHandle,
+  HistogramHandle,
+  HistogramOptions,
+  LogApi,
+  LogLevel,
+  LogTraceRecord,
+  MeasureTraceRecord,
+  ResolvedSettings,
+  SdkDefaults,
+  StopTimer,
+  SubjectContext,
+  SyncTraceRecord,
+  Tracer
+} from '@wardx/core';
+
+export type {
+  Attrs,
+  ConfigSnapshot,
+  ConfigValue,
+  CoreSettings,
+  CounterHandle,
+  CreateWardxOptions,
+  DimensionValue,
+  Dimensions,
+  EventTraceRecord,
+  Experiment,
+  ExperimentGoalContext,
+  ExperimentVariant,
+  FrameTraceRecord,
+  GaugeHandle,
+  HistogramHandle,
+  HistogramOptions,
+  LogApi,
+  LogLevel,
+  LogTraceRecord,
+  MeasureTraceRecord,
+  ResolvedSettings,
+  SdkDefaults,
+  StopTimer,
+  SubjectContext,
+  SyncTraceRecord,
+  Tracer
+};
+
+export interface ConsoleTracerOptions {
+  stream?: { write(chunk: string): unknown };
+}
+
+export interface ConfigApi {
+  get<T>(key: string, fallback: T, context?: SubjectContext): T;
+}
+
+export interface ExperimentApi {
+  goal(name: string, context?: ExperimentGoalContext): void;
+}
+
+export class WardxNode {
+  settings: ResolvedSettings;
+  log: LogApi;
+  config: ConfigApi;
+  experiment: ExperimentApi;
+  constructor(settings: ResolvedSettings);
+  identify(subjectId: string | null | undefined): void;
+  counter(name: string, dims?: Dimensions | null): CounterHandle;
+  gauge(name: string, dims?: Dimensions | null): GaugeHandle;
+  histogram(name: string, a?: HistogramOptions | null, b?: HistogramOptions | null): HistogramHandle;
+  timer(name: string, dims?: Dimensions | null): StopTimer;
+  event(name: string, attrs?: Attrs | null): void;
+  flush(): Promise<void>;
+  shutdown(): Promise<void>;
+}
+
+export function createWardx(options: CreateWardxOptions): WardxNode;
+export function createConsoleTracer(options?: ConsoleTracerOptions): Tracer;