@yorz/cli 0.11.2 → 0.12.0

package/dist/service/telemetry/types.d.ts

@@ -0,0 +1,109 @@
+/**
+ * Telemetry event model.
+ *
+ * The envelope is deliberately tiny and stable; everything domain-specific
+ * lives in a free-form payload that is flattened into the same JSON object so
+ * `jq` can query it without digging. Adding a new observation point means
+ * inventing a new `event` string — the recorder never needs to change.
+ */
+/** Schema version of the envelope. Bump on breaking field changes.
+ *
+ * `2` — `ts` became a numeric epoch and every project now shares one file. */
+export declare const TELEMETRY_SCHEMA_VERSION = 2;
+/**
+ * `<domain>.<action>`. The union documents the events shipped today while the
+ * trailing `(string & {})` keeps the namespace open for future ones.
+ *
+ * `git.op` and `spec.change` used to live here and were dropped: together they
+ * accounted for 99% of all recorded lines while feeding no metric.
+ */
+export type TelemetryEventName = 'agent.dispatch' | 'agent.turn' | 'agent.compact' | 'spec.stage' | 'cmd.exec' | 'lint.run' | (string & {});
+/**
+ * Normalized token usage. Every field is optional on purpose: a field left
+ * `undefined` means "this agent did not report it", which must stay
+ * distinguishable from a reported zero (otherwise cache-hit ratios lie).
+ */
+export interface UsageSnapshot {
+    /** Full-price input tokens (cache misses only). */
+    inputTokens?: number;
+    /** Tokens served from the prompt cache (~0.1x price). */
+    cacheReadTokens?: number;
+    /** Tokens written to the prompt cache (~1.25x price). */
+    cacheCreateTokens?: number;
+    outputTokens?: number;
+    /** Reasoning tokens, when the agent reports them separately. */
+    reasoningTokens?: number;
+    costUsd?: number;
+}
+/** Per-model usage buckets, kept verbatim from the agent that produced them. */
+export type ModelUsageMap = Record<string, unknown>;
+/**
+ * Usage accumulated up to some point inside a single turn.
+ *
+ * A turn reports one lump sum at the end, which cannot answer "how much of this
+ * dispatch was the planning phase?". Accumulating per-request usage as the
+ * stream arrives and snapshotting it at a phase boundary can.
+ */
+export interface PhaseUsageSnapshot {
+    /** Normalized tokens summed over every request counted so far. */
+    usage: UsageSnapshot;
+    /** Requests counted so far — one per assistant message, subagents included. */
+    requests: number;
+    /** Wall-clock milliseconds from the start of the turn to this snapshot. */
+    durationMs: number;
+}
+/** Metrics carried by a completed turn, produced at the adapter boundary. */
+export interface TurnMetrics {
+    usage?: UsageSnapshot;
+    modelUsage?: ModelUsageMap;
+    numTurns?: number;
+    stopReason?: string;
+    model?: string;
+    durationMs?: number;
+    apiDurationMs?: number;
+    /**
+     * Usage up to the first write of a `spec.md` — the plan→execute handover.
+     * Absent when the dispatch never touched a spec (git ops, explain, chat).
+     */
+    planPhase?: PhaseUsageSnapshot;
+    /**
+     * The same accumulator read at the end of the turn.
+     *
+     * `usage` above comes from the agent's own end-of-turn report, so dividing
+     * `planPhase` by it would mix two accounting bases and dress the difference
+     * up as a phase split. This field gives the ratio a matching denominator;
+     * `usage.costUsd` then converts that ratio into money.
+     */
+    observedTotal?: PhaseUsageSnapshot;
+}
+/** Metrics carried by an auto/manual context-compaction boundary. */
+export interface CompactMetrics {
+    trigger?: 'auto' | 'manual';
+    preTokens?: number;
+    postTokens?: number;
+    durationMs?: number;
+}
+/** Free-form event body. Flattened into the envelope on write. */
+export type TelemetryPayload = Record<string, unknown>;
+/** One JSONL line. */
+export interface TelemetryEnvelope extends TelemetryPayload {
+    /** Schema version — see {@link TELEMETRY_SCHEMA_VERSION}. */
+    v: number;
+    /** Epoch milliseconds (`Date.now()`), matching the `durMs` / `mtimeMs` unit. */
+    ts: number;
+    event: TelemetryEventName;
+    /** `generateProjectId(projectRoot)` — the only thing separating projects now
+     * that every one of them appends to the same file. */
+    projectId: string;
+    /** Correlates every event of one dispatch (reuses the existing `runId`). */
+    traceId?: string;
+    durMs?: number;
+}
+/** One entry of the `projects.json` index, mapping a short id back to a path. */
+export interface ProjectMetricsMeta {
+    path: string;
+    /** Epoch milliseconds of the first event recorded for this project. */
+    firstSeenAt: number;
+}
+/** `projects.json`: `projectId` → where that project lives on disk. */
+export type ProjectsIndex = Record<string, ProjectMetricsMeta>;

package/dist/service/telemetry/types.js

@@ -0,0 +1,12 @@
+/**
+ * Telemetry event model.
+ *
+ * The envelope is deliberately tiny and stable; everything domain-specific
+ * lives in a free-form payload that is flattened into the same JSON object so
+ * `jq` can query it without digging. Adding a new observation point means
+ * inventing a new `event` string — the recorder never needs to change.
+ */
+/** Schema version of the envelope. Bump on breaking field changes.
+ *
+ * `2` — `ts` became a numeric epoch and every project now shares one file. */
+export const TELEMETRY_SCHEMA_VERSION = 2;

package/package.json

@@ -1,11 +1,17 @@
 {
   "name": "@yorz/cli",
-  "version": "0.11.2",
+  "version": "0.12.0",
   "type": "module",
   "description": "",
   "bin": {
     "yorz": "./dist/cli/index.js"
   },
+  "exports": {
+    "./agent-sdk": {
+      "types": "./dist/agent-sdk/index.d.ts",
+      "import": "./dist/agent-sdk/index.js"
+    }
+  },
   "engines": {
     "node": ">=22.19.0"
   },
@@ -33,8 +39,9 @@
     "access": "public"
   },
   "scripts": {
-    "build": "pnpm run build:cli && pnpm run build:gui && pnpm run build:gui-mobile",
+    "build": "pnpm run build:cli && pnpm run build:types && pnpm run build:gui && pnpm run build:gui-mobile",
     "build:cli": "vite build",
+    "build:types": "tsc -p tsconfig.agent-sdk.json",
     "build:gui": "vite build --config vite.gui.config.ts",
     "build:gui-mobile": "vite build --config vite.gui-mobile.config.ts",
     "dev:cli": "pnpm run build:cli && node dist/cli/index.js serve --port 7424 --foreground",

package/dist/gui/assets/channel-fKfbKk-f.js

@@ -1 +0,0 @@
-import{ag as o,ah as n}from"./mermaid.core-DX3ME3Gu.js";const t=(a,r)=>o.lang.round(n.parse(a)[r]);export{t as c};

package/dist/gui/assets/classDiagram-OUVF2IWQ-CITnzF8D.js

@@ -1 +0,0 @@
-import{s as a,c as s,a as e,C as t}from"./chunk-V7JOEXUC-BA6VvJW7.js";import{_ as i}from"./mermaid.core-DX3ME3Gu.js";import"./chunk-5VM5RSS4-DtHH-RDR.js";import"./chunk-XXDRQBXY-BKC1-XCx.js";import"./chunk-VR4S4FIN-BAmGiVuz.js";import"./chunk-32BRIVSS-C1pdycmz.js";import"./index-CIhgEaUY.js";var n={parser:e,get db(){return new t},renderer:s,styles:a,init:i(r=>{r.class||(r.class={}),r.class.arrowMarkerAbsolute=r.arrowMarkerAbsolute},"init")};export{n as diagram};

package/dist/gui/assets/classDiagram-v2-EOCWNBFH-CITnzF8D.js

@@ -1 +0,0 @@
-import{s as a,c as s,a as e,C as t}from"./chunk-V7JOEXUC-BA6VvJW7.js";import{_ as i}from"./mermaid.core-DX3ME3Gu.js";import"./chunk-5VM5RSS4-DtHH-RDR.js";import"./chunk-XXDRQBXY-BKC1-XCx.js";import"./chunk-VR4S4FIN-BAmGiVuz.js";import"./chunk-32BRIVSS-C1pdycmz.js";import"./index-CIhgEaUY.js";var n={parser:e,get db(){return new t},renderer:s,styles:a,init:i(r=>{r.class||(r.class={}),r.class.arrowMarkerAbsolute=r.arrowMarkerAbsolute},"init")};export{n as diagram};