@ego-z/contracts 0.15.6 → 0.15.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ego-z/contracts",
-  "version": "0.15.6",
+  "version": "0.15.8",
   "description": "Wire-format type contracts shared between EgoZ backend, SDK, MCP and console. Type-only — no runtime artifacts.",
   "types": "./src/index.d.ts",
   "exports": {

package/src/ask.d.ts

@@ -6,6 +6,7 @@
  */
 
 import type { Intent, JsonSchemaDefinition, ResponseFormat, TokenUsage } from './envelope';
+import type { InitContextUi } from './draft-conv';
 
 // ============================================================================
 // /ask — request
@@ -158,6 +159,36 @@ export interface AskRequestBody {
      *   4. `Authorization` injected by `authType: 'FORWARD'`
      */
     toolHeaders?: Record<string, string>;
+
+    /**
+     * What the user has on screen RIGHT NOW — sent on every turn, not just
+     * when the conversation started.
+     *
+     * ── Why per-turn ─────────────────────────────────────────────────────
+     *
+     * `POST /conversations/draft` captures an `initContext` once, when the
+     * chat panel opens. That snapshot is frozen for the life of the
+     * conversation, so a window the user opens mid-chat is invisible to the
+     * agent by construction — "do that one as well" has no referent to
+     * resolve, and it reads as the model being obtuse when in fact it was
+     * never told.
+     *
+     * Send the CURRENT snapshot here and EgoZ works out what changed since
+     * the user's previous message. Deixis — "as well", "this one too", "the
+     * other one", "go back to the first" — then resolves from ordering and
+     * recency, with no phrase anyone has to enumerate.
+     *
+     * ── Send the full snapshot, never a delta ────────────────────────────
+     *
+     * Do not compute "what's new" client-side. A client delta needs a
+     * client-held baseline, and that baseline is wrong after a reload, a
+     * retry, or a reconnect. EgoZ holds the previous turn, so it can diff
+     * reliably; the client's job is only to report what it sees.
+     *
+     * Optional and additive: omit it and behaviour is exactly as before,
+     * with the stored `initContext` used for the whole conversation.
+     */
+    ui?: InitContextUi;
 }
 
 /**

package/src/draft-conv.d.ts

@@ -60,14 +60,76 @@ export type InitContextAudience = 'operator' | 'customer';
 
 /** One open window in the caller's UI. */
 export interface InitContextOpenWindow {
-    /** Epoch millis the window was opened. */
+    /**
+     * Epoch millis this window was FIRST SEEN by the client, on the CLIENT'S
+     * clock. Not when it was opened — most window systems have no true open
+     * time, and this is the honest name for what is actually knowable.
+     *
+     * ⚠️ Valid ONLY for ordering windows against each other **within a single
+     * snapshot**, where the values share one clock and one instant.
+     *
+     * It is NOT valid across snapshots and NOT valid against server time:
+     *   - It is a browser clock. Comparing it to a server timestamp compares
+     *     two clocks, so a client a few minutes off gets a silently wrong
+     *     answer that differs per end user.
+     *   - It is memory-only and RESETS ON PAGE RELOAD. After a refresh every
+     *     open window carries the moment of boot, so a "what's new" rule
+     *     built on it doesn't weaken — it inverts, and the window the user
+     *     has been discussing since turn one becomes the newest.
+     *
+     * To detect what changed between turns, diff window IDS instead. That
+     * asks only "was this seen before", which no clock can corrupt.
+     */
+    firstSeenAt?: number;
+
+    /**
+     * @deprecated Use `firstSeenAt`. Same value, honest name — this one
+     * asserts an open time that the client cannot know, and that reading
+     * caused a real design error. Emitted alongside `firstSeenAt` for one
+     * minor; readers should prefer `firstSeenAt` and fall back to this.
+     */
     openedAt?: number;
     /**
      * Human-readable window label, e.g. `"Blue Hoodie"`. Safe to render
      * verbatim — unlike the window KEY, which embeds entity ids and is
      * rendered only for the focused window.
+     *
+     * OMIT IT when `withheld` is true — see below.
      */
     title?: string;
+
+    /**
+     * The user removed this window from the chat's context chips: it is on
+     * their screen, but they have asked that it NOT be sent to the agent.
+     *
+     * ── Send the id and the flag. Never the title. ───────────────────────
+     *
+     * The agent needs the ID so it can stay quiet: EgoZ derives "what changed
+     * since your last message" by diffing window ids, and a window that
+     * simply vanishes from the payload is indistinguishable from one the user
+     * CLOSED — so the agent would tell them a window is gone while they are
+     * looking at it.
+     *
+     * The TITLE is the part the user was removing. It is the field that
+     * carries `"Acme Corp — Overdue Invoice #4471"` into a prompt and into
+     * storage. Send it anyway and the control is theatre: the gesture would
+     * change nothing about what leaves the browser. Ids are structural
+     * (`ecommerce:productDetail:prod-4471`) and leak a record id, not a
+     * person's name.
+     *
+     * ── What it does and does not do ─────────────────────────────────────
+     *
+     * A withheld window is not rendered anywhere: not in the open-window
+     * list, not as the focused window, not in the change summary, and it
+     * never anchors a greeting.
+     *
+     * It stops FUTURE transmission only. A title sent on an earlier turn is
+     * already stored, and anything the agent has already SAID about that
+     * window remains in the transcript. Withdrawing a window does not
+     * withdraw the conversation about it — so describe this to users as
+     * "not shared from now on", never as though it were erased.
+     */
+    withheld?: boolean;
     isFocused?: boolean;
 }