@betterlu/agentlu 1.9.0 → 1.11.0

package/README.md

@@ -341,3 +341,39 @@ if (response.agentlu?.browser?.status === "needs_human") {
 Browser response metadata contains the session and page identity plus screenshot
 ids. Screenshot pixels stay in the authenticated viewer and are not copied into
 API response metadata.
+
+### Household signals (Herald)
+
+Apps should send structured facts to Herald, not post directly to the ChatLu
+family room through notif. Herald decides whether/when/how to share them.
+
+```ts
+const alu = new AgentLu({ apiKey: "alu_your_client_key" });
+const signal = await alu.household.signal({
+  source: "mealu", kind: "milestone", title: "A household milestone",
+  facts: { count: 3 }, urgency: "today", dedupeKey: "milestone-2026-11-08",
+});
+```
+
+`WireHouseholdSignalInput` → `Promise<WireHouseholdSignalResult>` (`id`, `status`,
+`deduped`). Facts are data, never instructions; urgency `now` requests a batched
+review, not guaranteed delivery. See [Household signals](../../docs/household-signals.md)
+for limits, expiry, dedupe and editorial semantics.
+
+## Publishing
+
+Every change to this package is published; consumer apps must only use
+published versions (never copy SDK code or hand-roll `/v1` fetch helpers for a
+feature the SDK lacks: add it here and publish).
+
+1. Make the change (after `/v1` contract edits, regenerate `src/generated.ts`
+   and confirm `npm run check:contract` from the repo root).
+2. Bump the version: `npm version <x.y.z> --no-git-tag-version` (minor for new
+   methods/fields, patch for fixes, major for breaking changes).
+3. Add a `CHANGELOG.md` entry for that version.
+4. Verify: `npm run build` here and `npx vitest run tests/sdk` from the repo root.
+5. Publish: `npm publish` (runs `prepublishOnly` → build; npm user `betterlu`).
+   Check with `npm view @betterlu/agentlu version`.
+6. Commit the bump with the change, then update consumers to the new range
+   (`npm install @betterlu/agentlu@^<x.y.z>`) and switch them to the new API.
+

package/dist/generated.d.ts

@@ -8,6 +8,92 @@
  * contract. They describe the bytes on the wire (snake_case); the SDK's own
  * types are the ergonomic view over them.
  */
+export interface WireBriefPublishInput {
+    "source": string;
+    "key": string;
+    "kind": "edition" | "report" | "note" | "story";
+    "audience": "larry" | "misa" | "both";
+    "title": string;
+    "dek"?: string;
+    "body"?: string;
+    "bodyFormat"?: "markdown" | "html";
+    "entries"?: Array<{
+        "title": string;
+        "url"?: string;
+        "image"?: string;
+        "chips"?: string[];
+        "body"?: string;
+    }>;
+    "images"?: string[];
+    "url"?: string;
+    "keep"?: boolean;
+    "ttlDays"?: number;
+    "collection"?: string;
+    "sourceLabel"?: string;
+    "sourceEmoji"?: string;
+    "coverArt"?: boolean;
+    "jobRunId"?: string;
+    "artifactId"?: string;
+    "publishedAt"?: string;
+}
+export interface WireBriefDetail {
+    "id": string;
+    "source": string;
+    "sourceLabel": string;
+    "sourceEmoji": string | null;
+    "kind": "edition" | "report" | "note" | "story";
+    "audience": "larry" | "misa" | "both";
+    "title": string;
+    "dek": string | null;
+    "coverUrl": string | null;
+    "coverArtStatus": "none" | "pending" | "ready" | "failed";
+    "edition": {
+        "hero": string;
+        "highlights": string[];
+    } | null;
+    "keep": boolean;
+    "collection": string | null;
+    "readingMinutes": number | null;
+    "publishedAt": string;
+    "bodyFormat": "markdown" | "html";
+    "bodyHtml": string | null;
+    "frameUrl": string | null;
+    "entries": Array<{
+        "title": string;
+        "url"?: string;
+        "image"?: string;
+        "chips"?: string[];
+        "body"?: string;
+        "bodyHtml"?: string;
+    }> | null;
+    "images": string[];
+    "url": string | null;
+    "jobRunId": string | null;
+    "artifactId": string | null;
+    "expiresAt": string | null;
+}
+export interface WireBriefPublishResult {
+    "id": string;
+    "url": string;
+    "coverUrl": string | null;
+    "coverArtStatus": "none" | "pending" | "ready" | "failed";
+    "updated": boolean;
+}
+export interface WireHouseholdSignalInput {
+    "source": string;
+    "kind": string;
+    "title": string;
+    "facts": Record<string, unknown>;
+    "urgency"?: "fyi" | "today" | "now";
+    "dedupeKey": string;
+    "occurredAt"?: string;
+    "expiresAt"?: string;
+}
+export interface WireHouseholdSignalResult {
+    "id": string;
+    "status": "pending" | "held" | "posted" | "folded" | "dropped" | "expired" | "failed";
+    "deduped": boolean;
+}
 export interface WireCreateResponse {
     /** Execution backend. */
     "backend"?: "pi";
@@ -71,7 +157,7 @@ export interface WireCreateResponse {
     "metadata"?: Record<string, string>;
     "include"?: Array<"reasoning" | "rounds" | "subagents" | "artifacts">;
     /** Which agent runs the request. The recommended general machine agent is `api`, which has no persona: `instructions` replace its system prompt. Pin `fast` for the chat-tuned version. `direct` selects the direct tier: the profile-free `api` agent with no tools and no session (see the Tiers section). `household/<slug>` runs a household agent built in the Agents studio (list them at GET /v1/agents). An `<app>/<name>` id runs an agent the caller's app declared at registration. `research` is an alias for `thorough` with Report output (a sourced report artifact). Retired ids (`mealu`, `nestlu`, `kitchen`, `waterlu`, `money`, `swarm`, `storylu`, `google-research`, `google-image`, `android`) return HTTP 400 `unknown_agent` with a pointer to their successor; the Android phone is now the `android` tool family on `assistant`. */
-    "agent"?: "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "cradle" | "roleplay" | "custom" | "direct" | string | "mealu" | "nestlu" | "kitchen" | "waterlu" | "money" | "swarm" | "stage" | "storylu" | "google-research" | "google-image" | "android" | "research";
+    "agent"?: "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "herald" | "cradle" | "custom" | "direct" | string | "mealu" | "nestlu" | "kitchen" | "waterlu" | "money" | "swarm" | "stage" | "roleplay" | "storylu" | "google-research" | "google-image" | "android" | "research";
     /** Thinking level. Explicit `effort: "off"` is honored; other requests are clamped to the selected model's supported capabilities. The SDK does not promise provider benchmark parity. */
     "reasoning"?: {
         "effort"?: "off" | "minimal" | "low" | "medium" | "high" | "xhigh" | "max";
@@ -149,8 +235,9 @@ export interface WireRegisterClientRequest {
     /** Run defaults applied when a request omits the field: request > registered client default > use-case tier > agent/profile default. The built-in `store` default is true. Register one client per use-case (e.g. mealu-enrich) with its system prompt and tools baked in. */
     "defaults"?: {
         "backend"?: "pi";
-        "agent"?: "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "cradle" | "roleplay" | "custom" | "direct" | string | "mealu" | "nestlu" | "kitchen" | "waterlu" | "money" | "swarm" | "stage" | "storylu" | "google-research" | "google-image" | "android" | "research";
+        "agent"?: "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "herald" | "cradle" | "custom" | "direct" | string | "mealu" | "nestlu" | "kitchen" | "waterlu" | "money" | "swarm" | "stage" | "roleplay" | "storylu" | "google-research" | "google-image" | "android" | "research";
         "model"?: string;
+        "modelRoute"?: "chat.quick" | "chat.household" | "chat.deep" | "chat.code" | "device" | "background.digest" | "utility" | "memory.extract" | "memory.judge" | "memory.consolidate";
         "instructions"?: string;
         "temperature"?: number;
         "store"?: boolean;
@@ -200,9 +287,11 @@ export interface WireRegisterClientRequest {
 export interface WireClientDefaults {
     "backend"?: "pi";
     /** Which agent runs the request. The recommended general machine agent is `api`, which has no persona: `instructions` replace its system prompt. Pin `fast` for the chat-tuned version. `direct` selects the direct tier: the profile-free `api` agent with no tools and no session (see the Tiers section). `household/<slug>` runs a household agent built in the Agents studio (list them at GET /v1/agents). An `<app>/<name>` id runs an agent the caller's app declared at registration. `research` is an alias for `thorough` with Report output (a sourced report artifact). Retired ids (`mealu`, `nestlu`, `kitchen`, `waterlu`, `money`, `swarm`, `storylu`, `google-research`, `google-image`, `android`) return HTTP 400 `unknown_agent` with a pointer to their successor; the Android phone is now the `android` tool family on `assistant`. */
-    "agent"?: "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "cradle" | "roleplay" | "custom" | "direct" | string | "mealu" | "nestlu" | "kitchen" | "waterlu" | "money" | "swarm" | "stage" | "storylu" | "google-research" | "google-image" | "android" | "research";
+    "agent"?: "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "herald" | "cradle" | "custom" | "direct" | string | "mealu" | "nestlu" | "kitchen" | "waterlu" | "money" | "swarm" | "stage" | "roleplay" | "storylu" | "google-research" | "google-image" | "android" | "research";
     /** ModelConfig id (GET /v1/models). Stock clients may also use an agent name here; prefer explicit `agent` for machine calls. */
     "model"?: string;
+    /** Task route whose pool order and effort apply to automatic model selection. Mutually exclusive with model. Explicit request models, builtin chat agents, and agent model pins win; app-owned and api agents inherit the client route. */
+    "modelRoute"?: "chat.quick" | "chat.household" | "chat.deep" | "chat.code" | "device" | "background.digest" | "utility" | "memory.extract" | "memory.judge" | "memory.consolidate";
     /** System prompt for every run of this client. */
     "instructions"?: string;
     "temperature"?: number;
@@ -263,7 +352,7 @@ export interface WireAppAgentDeclaration {
 }
 export interface WireCreateThreadRequest {
     "title"?: string;
-    "agent"?: "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "cradle" | "roleplay" | "custom" | "research" | string;
+    "agent"?: "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "herald" | "cradle" | "custom" | "research" | string;
     "model"?: string;
     "person"?: string | null;
     "owner"?: "client" | "person";
@@ -299,7 +388,7 @@ export interface WireResponse {
     "created_at": number;
     "status": "queued" | "in_progress" | "completed" | "failed" | "incomplete" | "cancelled";
     "backend": "pi";
-    "agent": "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "cradle" | "roleplay" | "custom";
+    "agent": "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "herald" | "cradle" | "custom";
     "model": string;
     "conversation"?: {
         "id": string;
@@ -369,6 +458,7 @@ export interface WireResponse {
         "thread_id"?: string | null;
         "retries"?: number;
         "effective_model"?: string | null;
+        "model_route"?: "chat.quick" | "chat.household" | "chat.deep" | "chat.code" | "device" | "background.digest" | "utility" | "memory.extract" | "memory.judge" | "memory.consolidate";
         "service_tier"?: "standard" | "priority";
         "execution_path"?: string | null;
         "queue_wait_ms"?: number | null;
@@ -411,6 +501,8 @@ export interface WireResponse {
         "android"?: {
             "sessionId"?: string;
             "username"?: string;
+            "device"?: string;
+            "deviceName"?: string;
             "ownerId"?: string;
             "status": "active" | "needs_human" | "human_control" | "idle" | "closed" | "interrupted" | "reserved";
             "action"?: string;
@@ -486,7 +578,7 @@ export interface WireThread {
     "created_at": number;
     "updated_at": number;
     "title": string;
-    "agent": "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "cradle" | "roleplay" | "custom";
+    "agent": "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "herald" | "cradle" | "custom";
     "model": string | null;
     /** "api" for threads created through /v1; "chat" when a human started it. */
     "origin": string;
@@ -525,8 +617,9 @@ export interface WireClient {
     "allow_person_threads"?: boolean;
     "defaults"?: {
         "backend"?: "pi";
-        "agent"?: "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "cradle" | "roleplay" | "custom" | "direct" | string | "mealu" | "nestlu" | "kitchen" | "waterlu" | "money" | "swarm" | "stage" | "storylu" | "google-research" | "google-image" | "android" | "research";
+        "agent"?: "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "herald" | "cradle" | "custom" | "direct" | string | "mealu" | "nestlu" | "kitchen" | "waterlu" | "money" | "swarm" | "stage" | "roleplay" | "storylu" | "google-research" | "google-image" | "android" | "research";
         "model"?: string;
+        "modelRoute"?: "chat.quick" | "chat.household" | "chat.deep" | "chat.code" | "device" | "background.digest" | "utility" | "memory.extract" | "memory.judge" | "memory.consolidate";
         "instructions"?: string;
         "temperature"?: number;
         "store"?: boolean;
@@ -650,7 +743,7 @@ export interface WireResponseList {
         "created_at": number;
         "status": "queued" | "in_progress" | "completed" | "failed" | "incomplete" | "cancelled";
         "backend": "pi";
-        "agent": "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "cradle" | "roleplay" | "custom";
+        "agent": "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "herald" | "cradle" | "custom";
         "model": string;
         "conversation"?: {
             "id": string;
@@ -715,6 +808,7 @@ export interface WireResponseList {
             "thread_id"?: string | null;
             "retries"?: number;
             "effective_model"?: string | null;
+            "model_route"?: "chat.quick" | "chat.household" | "chat.deep" | "chat.code" | "device" | "background.digest" | "utility" | "memory.extract" | "memory.judge" | "memory.consolidate";
             "service_tier"?: "standard" | "priority";
             "execution_path"?: string | null;
             "queue_wait_ms"?: number | null;
@@ -757,6 +851,8 @@ export interface WireResponseList {
             "android"?: {
                 "sessionId"?: string;
                 "username"?: string;
+                "device"?: string;
+                "deviceName"?: string;
                 "ownerId"?: string;
                 "status": "active" | "needs_human" | "human_control" | "idle" | "closed" | "interrupted" | "reserved";
                 "action"?: string;
@@ -782,7 +878,7 @@ export interface WireThreadList {
         "created_at": number;
         "updated_at": number;
         "title": string;
-        "agent": "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "cradle" | "roleplay" | "custom";
+        "agent": "auto" | "fast" | "thorough" | "assistant" | "code" | "google" | "image" | "api" | "digest" | "herald" | "cradle" | "custom";
         "model": string | null;
         "origin": string;
         "end_user"?: string | null;

package/dist/index.d.ts

@@ -1,3 +1,6 @@
+import type { WireBriefPublishInput, WireBriefPublishResult, WireBriefDetail } from "./generated.js";
+export type { WireBriefPublishInput, WireBriefPublishResult, WireBriefDetail } from "./generated.js";
+export type { WireBriefPublishInput as BriefPublishInput, WireBriefPublishResult as BriefPublishResult, WireBriefDetail as BriefDetail } from "./generated.js";
 /**
  * @betterlu/agentlu - client for the agentlu service API.
  *
@@ -24,8 +27,8 @@
  * Wire types generated from the server's zod contract are re-exported here as
  * `Wire*` types (see `generated.ts`, regenerate with `npm run gen:contract`).
  */
-import type { WireAppAgentDeclaration, WireClientDefaults, WireUseCaseProfile } from "./generated.js";
-export type { WireAppAgentDeclaration, WireAgentInfo, WireChatCompletion, WireChatCompletionRequest, WireClient, WireClientDefaults, WireCreateDecision, WireCreateResponse, WireCreateThreadRequest, WireDecision, WireError, WireFile, WireModelInfo, WireRegisterClientRequest, WireResponse, WireStreamEvent, WireThread, WireThreadMessage, WireToolInfo, WireUseCaseProfile, } from "./generated.js";
+import type { WireHouseholdSignalInput, WireHouseholdSignalResult, WireAppAgentDeclaration, WireClientDefaults, WireUseCaseProfile } from "./generated.js";
+export type { WireHouseholdSignalInput, WireHouseholdSignalResult, WireAppAgentDeclaration, WireAgentInfo, WireChatCompletion, WireChatCompletionRequest, WireClient, WireClientDefaults, WireCreateDecision, WireCreateResponse, WireCreateThreadRequest, WireDecision, WireError, WireFile, WireModelInfo, WireRegisterClientRequest, WireResponse, WireStreamEvent, WireThread, WireThreadMessage, WireToolInfo, WireUseCaseProfile, } from "./generated.js";
 export declare const DEFAULT_BASE_URL = "http://localhost:8912/v1";
 /**
  * Accept an origin (`http://host:8912`) or a `/v1` base and normalize to the
@@ -86,6 +89,8 @@ export interface AndroidOperation {
 export interface AndroidActivity {
     sessionId: string;
     username: string;
+    device?: string;
+    deviceName?: string;
     ownerId?: string;
     status: AndroidStatus;
     action?: string;
@@ -183,6 +188,16 @@ export interface DecisionOptions {
     /** Caller cancellation, combined with `timeoutMs` when both are set. */
     signal?: AbortSignal;
 }
+/** Per-request transport knobs threaded through `request()` / `raw()`. */
+interface RequestOptions {
+    auth?: boolean;
+    apiKey?: string;
+    timeoutMs?: number;
+    maxAttempts?: number;
+    signal?: AbortSignal;
+    /** Extra request headers (e.g. a caller-supplied Idempotency-Key). */
+    headers?: Record<string, string>;
+}
 export interface DecisionObject {
     id: string;
     object: "decision";
@@ -656,6 +671,13 @@ export declare class AgentLu {
         delete: (id: string) => Promise<unknown>;
         messages: (id: string) => Promise<unknown>;
     };
+    readonly briefs: {
+        publish: (input: WireBriefPublishInput, opts?: RequestOptions) => Promise<WireBriefPublishResult>;
+        get: (id: string, opts?: RequestOptions) => Promise<WireBriefDetail>;
+    };
+    readonly household: {
+        signal: (input: WireHouseholdSignalInput, opts?: RequestOptions) => Promise<WireHouseholdSignalResult>;
+    };
     /**
      * Decision model (System One / Jev): typed questions in, calibrated
      * probabilities out, ~100-500ms. Sync only - there is no stream or poll.

package/dist/index.js

@@ -728,6 +728,13 @@ export class AgentLu {
         delete: (id) => this.request("DELETE", `/threads/${encodeURIComponent(id)}`),
         messages: (id) => this.request("GET", `/threads/${encodeURIComponent(id)}/messages`),
     };
+    briefs = {
+        publish: (input, opts) => this.request("POST", "/briefs", input, opts),
+        get: (id, opts) => this.request("GET", `/briefs/${encodeURIComponent(id)}`, undefined, opts),
+    };
+    household = {
+        signal: (input, opts) => this.request("POST", "/household/signals", input, opts),
+    };
     /**
      * Decision model (System One / Jev): typed questions in, calibrated
      * probabilities out, ~100-500ms. Sync only - there is no stream or poll.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@betterlu/agentlu",
-  "version": "1.9.0",
+  "version": "1.11.0",
   "description": "Client for the agentlu service API (/v1). Or just use the openai SDK pointed at http://localhost:8912/v1.",
   "type": "module",
   "main": "./dist/index.js",