dsh-connect-workbuddy 5.6.3 → 5.8.0

package/lib/index.d.ts

@@ -433,9 +433,21 @@ declare class WorkBuddyCredentialStore {
    * refuses to use is what made the dropdown look healthy while every request
    * failed with 401.
    *
+   * THE POOL'S RUNTIME OVERRIDE IS PART OF `current()`, SO IT IS PART OF THIS.
+   * `current()` consults `rotatedAccountId` FIRST; this method used to ignore it
+   * and answer from `accountId` alone. With the pool on, the two therefore
+   * disagreed on every rotation: the shim billed account B while the card marked
+   * account A — the reporter's screenshot showed 「当前选用」 on a rate-limited
+   * account while the pill's total belonged to the one actually serving. Worse,
+   * the usage document takes its `credential` from `current()` and its
+   * `account.accountId` from this list, so one document could name two accounts.
+   *
    * So an explicit selection that matches NO local account marks nothing as
    * selected (no silent fallback to a different account — see {@link current}).
    * The implicit default is marked only when nothing was explicitly chosen.
+   * A live rotation marker wins over both, mirroring `current()`'s precedence,
+   * and only while it still names a local account — `current()` falls through in
+   * that case, and so does this.
    */
   accounts(): Promise<WorkBuddyAccountChoice[]>;
   /**
@@ -954,6 +966,17 @@ type UpstreamErrorKind = 'hard_credit' |
  * user; the second one is the actual remedy.
  */
 'model_busy' | 'session_dead' | 'policy_reject' |
+/**
+ * The upstream restricted THIS account for unusual activity (issue #127).
+ *
+ * Kept separate from {@link policy_reject}, even though both arrive as the
+ * `11140` family with the same `msg: "request illegal"`: that one is a CONTENT
+ * decision and switching accounts cannot help, while this is a CREDENTIAL
+ * decision and switching is exactly the remedy. `displayMsg` is the only
+ * discriminator upstream provides ("账号存在异常行为，已被限制使用" / "restricted
+ * due to unusual activity").
+ */
+'account_restricted' |
 /**
  * The gateway's channel gate refused the request itself (business code
  * 11128, "Illegal API invocation from an unapproved channel").
@@ -1310,6 +1333,31 @@ declare function regionOf(domain: string): WorkBuddyRegion;
  * the same decision as admitting `workbuddy.cn`.
  */
 declare function knownRegionOf(domain: string): WorkBuddyRegion | undefined;
+/**
+ * How the plugin should identify itself where the upstream only RECORDS the
+ * request (issue #132). One switch, because the two halves are one decision.
+ */
+interface WorkBuddyWireIdentity {
+  /**
+   * Adopt the official client's usage-page identity on chat requests.
+   *
+   * ON adds `X-IDE-Type` / `X-IDE-Name` / `X-IDE-Version` and switches the
+   * conversation-identity triple to the 32-hex UUIDv7 shape the official client
+   * uses (plus `X-Request-ID`, which mirrors the message id there).
+   *
+   * OFF by default, and the reason is the evidence tier, not the mechanism: the
+   * reporter measured HTTP 200 on their own build of this PLUGIN at 5.3.1
+   * (the WorkBuddy client itself was 5.8.3), and this plugin has not
+   * reproduced that against the live gateway. Nothing in either gate is documented
+   * as reading these headers — `11128`'s three doors are the message openings,
+   * the missing conversation id and a non-system first message, none of which a
+   * header can change — but this gateway has repeatedly refused requests for
+   * reasons visible only in the answer, so a display-only alignment ships behind a
+   * switch rather than as a silent upgrade for every account. `User-Agent` and the
+   * request BODY are untouched either way.
+   */
+  usageIdentity?: boolean;
+}
 /**
  * The model id a prepared body asks for, when it carries one (issue #61).
  *
@@ -1319,6 +1367,43 @@ declare function knownRegionOf(domain: string): WorkBuddyRegion | undefined;
  * measurement that this id is needed for.
  */
 declare function modelIdOfBody(bodyJson: string): string | undefined;
+/**
+ * How a body should be prepared beyond the rules every request needs (issue #132).
+ *
+ * Both switches default to OFF, and that default is the point: each one changes
+ * bytes the upstream counts, so it must be a deliberate opt-in rather than a
+ * silent behaviour change on upgrade.
+ */
+interface PrepareChatBodyOptions {
+  /**
+   * Move the harness's injected `user` messages above the real prompt.
+   *
+   * WHY. The usage page's 请求 column is filled from the LAST `user` message in
+   * the body. The DSH harness appends its runtime context (time samples,
+   * `Current runtime context.`, `<system-reminder>` blocks) AFTER the user's real
+   * prompt, as extra `user` messages — so the model reads the real prompt but the
+   * usage page records only the injected tail, and a user comparing their usage
+   * history with what they typed sees rows that look like noise.
+   *
+   * The move is ORDER-ONLY and only within the trailing run: the injected
+   * messages are lifted out and re-inserted immediately BEFORE the real prompt,
+   * which keeps every message, its text and every tool result intact (the one
+   * textual edit is the recorded prompt's leading marker, documented at
+   * {@link ACP_LEADING_TAG}). It is
+   * therefore invisible to the model's instruction order (a runtime-context block
+   * is context wherever it sits) and it is what makes the usage column show what
+   * the user actually typed.
+   *
+   * It also removes the leading `<acp …>mNNNNN</acp>` marker from THAT prompt and no
+   * other message, because otherwise the recorded row still opens with the marker
+   * instead of the user's sentence. Marker only — no text is touched.
+   *
+   * Only messages that MATCH the harness's own injected prefixes are moved. A
+   * body from any other client is untouched: this must never reorder a
+   * conversation whose trailing user messages are real turns.
+   */
+  keepPromptLast?: boolean;
+}
 /**
  * Normalize an OpenAI chat-completions body for the WorkBuddy upstream: force
  * `stream: true` (the upstream rejects non-streaming), flatten `tool_choice`
@@ -1336,7 +1421,7 @@ declare function modelIdOfBody(bodyJson: string): string | undefined;
  * upstream already answers keeps its prompt as close to byte-for-byte as these
  * rules allow.
  */
-declare function prepareChatBody(source: string): string;
+declare function prepareChatBody(source: string, options?: PrepareChatBodyOptions): string;
 /** Marker carried by {@link WorkBuddyCredentialRejectedError}; survives bundling. */
 declare const CREDENTIAL_REJECTED_CODE = "WORKBUDDY_CREDENTIAL_REJECTED";
 /**
@@ -1381,6 +1466,7 @@ declare function parseUpstreamModel(value: unknown): WorkBuddyUpstreamModel | un
  */
 declare class WorkBuddyUpstreamClient {
   private readonly onFallback?;
+  private readonly identity;
   /**
    * Reports a fallback the catalog reader had to take.
    *
@@ -1390,7 +1476,7 @@ declare class WorkBuddyUpstreamClient {
    * `ctx.logger.warn` in; without a host the event is dropped, which is the
    * same silence the previous single-source reader had.
    */
-  constructor(onFallback?: ((message: string) => void) | undefined);
+  constructor(onFallback?: ((message: string) => void) | undefined, identity?: WorkBuddyWireIdentity);
   /** POST the chat endpoint; a successful answer is the raw SSE response. */
   chatStream(credential: WorkBuddyCredential, bodyJson: string, signal?: AbortSignal): Promise<WorkBuddyChatResult>;
   /**
@@ -1864,6 +1950,29 @@ interface WorkBuddyShimOptions {
   client: Pick<WorkBuddyUpstreamClient, 'chatStream'>;
   catalog: WorkBuddyCatalog;
   logger?: ShimLogger;
+  /**
+   * When to perturb scanned messages with invisible characters.
+   *
+   * `off` keeps the ordinary fail-then-rescue ladder; `failure` (the default)
+   * remembers a successful rescue and starts later requests with it; `always`
+   * starts every request with the dense rescue. `always` is for users whose
+   * gateway has already made the plain attempt a guaranteed 11128 — it trades a
+   * little prompt byte-level purity for avoiding that doomed round trip.
+   */
+  channelPerturbation?: 'off' | 'failure' | 'always';
+  /**
+   * Move the harness's injected `user` blocks above the real prompt (issue #132).
+   *
+   * The WorkBuddy usage page records the LAST `user` message as the request
+   * text, and the harness appends its runtime context after the user's real
+   * prompt — so the usage column shows injected noise instead of what was typed.
+   * The reorder is order-only (every message and its text survive), and it only
+   * ever moves messages that MATCH the harness's own injected prefixes; the single
+   * textual edit is stripping the recorded prompt's own leading marker.
+   *
+   * Default false: it changes bytes the upstream counts, so it is opt-in.
+   */
+  keepPromptLast?: boolean;
   /**
    * Pool failover for chat requests. Absent means no failover at all — the
    * pre-pool behaviour, where the selected account serves and its failure is
@@ -2587,7 +2696,15 @@ declare function probeRequestBody(modelId: string, inputTokens?: number): string
  * instead of what it is — the gateway objecting to the PROMPT, not the account
  * (issues #87–#90).
  */
-type WorkBuddyProbeOutcome = 'ok' | 'rate-limited' | 'model-busy' | 'out-of-credit' | 'credential-rejected' | 'policy-rejected' | 'channel-rejected' | 'unavailable' | 'not-found' | 'failed';
+type WorkBuddyProbeOutcome = 'ok' | 'rate-limited' | 'model-busy' | 'out-of-credit' | 'credential-rejected' | 'policy-rejected' |
+/**
+ * The upstream restricted this credential for unusual activity (issue #127).
+ *
+ * Split from `policy-rejected` because the pool's response differs: this is
+ * an account-level exclusion, while a content-policy refusal is about the
+ * request and must not teach the pool that the credential is unusable.
+ */
+'account-restricted' | 'channel-rejected' | 'unavailable' | 'not-found' | 'failed';
 /**
  * One probe result, as the card renders it.
  *
@@ -2781,6 +2898,15 @@ interface WorkBuddyPoolAccount {
   id: string;
   /** Human name, or `''` when the desktop app recorded none. */
   accountName: string;
+  /**
+   * This account belongs to an enterprise/education tenant (issue #124/#129).
+   *
+   * A projection fact, carried from the credential's `enterpriseId` rather than
+   * inferred from any benefit or check-in response: upstream can advertise
+   * campaigns and `active:false` for enterprise members while refusing every
+   * write with `10001`.
+   */
+  enterprise?: boolean;
 }
 /**
  * What the pool knows about ONE account's last test of the target model.
@@ -3357,6 +3483,31 @@ type WorkBuddyWebUsage =
    * must not be read as consent.
    */
   cliBridgeEnabled?: boolean;
+  /**
+   * The model the OPTIONAL CodeBuddy CLI route runs on, or `''` for
+   * "nothing is pinned, the CLI uses its own default".
+   *
+   * GLOBAL like `cliBridgeEnabled`. Travels on the Host's answer for the
+   * same measured reason: on the stale-mirror 0.1.7 deployment a picker that
+   * read the settings mirror alone would keep showing a pin that had just
+   * been cleared (or had not landed yet).
+   */
+  cliBridgeModel?: string;
+  /**
+   * The reasoning effort the OPTIONAL CodeBuddy CLI route runs on, or `''`
+   * for "nothing is pinned, the CLI uses its own default".
+   *
+   * GLOBAL and Host-carried for the same reasons as `cliBridgeModel`.
+   */
+  cliBridgeEffort?: string;
+  /**
+   * The order the OPTIONAL CodeBuddy CLI route walks the credential
+   * regions in — a comma-separated region list such as `'cn,global'` — or
+   * `''` for "nothing is pinned, the CLI walks its own default order".
+   *
+   * GLOBAL and Host-carried for the same reasons as `cliBridgeModel`.
+   */
+  cliBridgeRegionOrder?: string;
   /**
    * The LIVE load level per model id, for the card's icon.
    *
@@ -3421,6 +3572,31 @@ type WorkBuddyWebUsage =
    * must not be read as consent.
    */
   cliBridgeEnabled?: boolean;
+  /**
+   * The model the OPTIONAL CodeBuddy CLI route runs on, or `''` for
+   * "nothing is pinned, the CLI uses its own default".
+   *
+   * GLOBAL like `cliBridgeEnabled`. Travels on the Host's answer for the
+   * same measured reason: on the stale-mirror 0.1.7 deployment a picker that
+   * read the settings mirror alone would keep showing a pin that had just
+   * been cleared (or had not landed yet).
+   */
+  cliBridgeModel?: string;
+  /**
+   * The reasoning effort the OPTIONAL CodeBuddy CLI route runs on, or `''`
+   * for "nothing is pinned, the CLI uses its own default".
+   *
+   * GLOBAL and Host-carried for the same reasons as `cliBridgeModel`.
+   */
+  cliBridgeEffort?: string;
+  /**
+   * The order the OPTIONAL CodeBuddy CLI route walks the credential
+   * regions in — a comma-separated region list such as `'cn,global'` — or
+   * `''` for "nothing is pinned, the CLI walks its own default order".
+   *
+   * GLOBAL and Host-carried for the same reasons as `cliBridgeModel`.
+   */
+  cliBridgeRegionOrder?: string;
   /**
    * The LIVE load level per model id, for the card's icon.
    *
@@ -3444,6 +3620,24 @@ type WorkBuddyWebUsage =
    * selection, seeded from the built-in rule the first time it is read.
    */
   offModelIds: readonly string[];
+  /**
+   * Ids of THIS region's roster that this machine first saw inside the
+   * new-model window, oldest first — the data behind the composer pill's
+   * "· N 新模型" segment.
+   *
+   * "新" means "this machine first recorded the id in its catalog", NOT "the
+   * gateway added it": the upstream list carries no listed-since field, so
+   * claiming an upstream fact would be fabricating one. Absent means "nothing
+   * is new right now" or "this Host predates the feature" — never "0".
+   */
+  newModelIds?: readonly string[];
+  /**
+   * A sentence explaining why no new-model readout is shown, present only
+   * when the on-disk first-sighting history is in a version this build cannot
+   * read. Kept separate from the field above so "no new models" is never the
+   * story for a file that simply was not read.
+   */
+  rosterSeenVersionNote?: string;
   credits?: WorkBuddyWebCredits;
   creditsError?: string;
   /**
@@ -3520,6 +3714,13 @@ type WorkBuddyWebProbeOutcome = 'ok' | 'rate-limited' |
  * wait about a minute, or switch to a less busy model.
  */
 'model-busy' | 'out-of-credit' | 'credential-rejected' | 'policy-rejected' |
+/**
+ * The upstream restricted this credential for unusual activity (issue #127).
+ *
+ * Separate from `policy-rejected`: a content refusal is about the request,
+ * while this is about the credential and needs re-authentication or an appeal.
+ */
+'account-restricted' |
 /**
  * The gateway's channel gate refused the request itself (upstream code 11128).
  *
@@ -3595,7 +3796,12 @@ type WorkBuddyWebPoolExclusion = 'unusable' | 'rate-limited' |
  * showing "被限流" next to an ACCOUNT name asserts something the measurement
  * does not say (issue #56).
  */
-'model-busy' | 'out-of-credit' | 'credential-rejected' | 'not-found' | 'unavailable' | 'failed';
+'model-busy' | 'out-of-credit' | 'credential-rejected' |
+/**
+ * The upstream restricted this account (issue #127); unlike a request policy
+ * refusal, another account can serve and this one should be benched.
+ */
+'account-restricted' | 'not-found' | 'unavailable' | 'failed';
 /** One claimable benefit, as the card renders it (issue #79). */
 interface WorkBuddyWebBenefit {
   /** Which campaign: compensation (crash补偿) or gift (新人首月赠送). */
@@ -3624,6 +3830,14 @@ interface WorkBuddyWebBenefit {
 interface WorkBuddyWebPoolAccount {
   accountId: string;
   accountName: string;
+  /**
+   * The credential belongs to an enterprise/education tenant (issues #124/#129).
+   *
+   * Carried through the pool row so the card can render the two actions the
+   * upstream does not support for those accounts (daily check-in and benefit
+   * claiming) as explicitly unavailable rather than as pending work.
+   */
+  enterprise?: boolean;
   /** Total remaining credits, absent when the credits route failed. */
   credits?: number;
   /** Credits expiring within 3 days. */
@@ -3852,6 +4066,14 @@ declare function unwrapVolatileDeep<T>(value: T): T;
  */
 declare const WORKBUDDY_SETTINGS_NS: "workbuddy";
 //#endregion
+//#region src/roster-seen-store.d.ts
+/** A first-sighting readout, assembled read-only by the usage route. */
+interface RosterSeenReadout {
+  newModelIds: readonly string[];
+  /** A sentence when the on-disk history is in a version this build cannot read. */
+  versionNote?: string;
+}
+//#endregion
 //#region src/web-status.d.ts
 /** Constructor dependencies. */
 interface WorkBuddyStatusRouteOptions {
@@ -3875,6 +4097,20 @@ interface WorkBuddyStatusRouteOptions {
   contextBudgets(region: WorkBuddyRegion): Readonly<Record<string, number | undefined>>;
   /** Re-read the live catalog of one region from the upstream. */
   discoverModels?(region: WorkBuddyRegion, signal?: AbortSignal): Promise<readonly WorkBuddyModelInfo[]>;
+  /**
+   * Which ids of the requested region's roster THIS machine first saw inside the
+   * new-model window (the "· N 新模型" segment), plus a note when the on-disk
+   * first-sighting history is in a version this build cannot read.
+   *
+   * READ-ONLY: the usage route never writes first-sighting history — only the
+   * catalog reconciler does (`src/index.ts`), so a panel poll can never change
+   * "who is new". Region-scoped because the two regions keep separate catalogs
+   * and therefore separate first-sighting tables.
+   *
+   * Optional, and absent means the Host predates the feature: the pill then
+   * renders no segment at all rather than a made-up "0 新模型".
+   */
+  rosterSeen?(region: WorkBuddyRegion): Promise<RosterSeenReadout>;
   /**
    * Whether the requested region's provider is currently offered to DSH. The
    * card renders this as the tab's on/off checkbox, so the switch reflects the
@@ -3922,6 +4158,31 @@ interface WorkBuddyStatusRouteOptions {
    * deployments, and a stale `true` here would claim a spending capability is on.
    */
   cliBridgeEnabled?(): boolean;
+  /**
+   * The model the OPTIONAL CodeBuddy CLI route runs on, or `''` for "the CLI's
+   * own default".
+   *
+   * GLOBAL like `cliBridgeEnabled` — one route, one pin, so no argument.
+   * Optional, and absent is the same as `''`: the route then runs on the CLI's
+   * default. The card carries it on the Host's answer for the same measured
+   * reason as `cliBridgeEnabled` — the browser's settings mirror is stale for
+   * this namespace on the affected 0.1.7 deployments, so a picker reading the
+   * mirror alone would keep showing a pin that had just been cleared.
+   */
+  cliBridgeModel?(): string;
+  /**
+   * The reasoning effort the OPTIONAL CodeBuddy CLI route runs on, or `''` for
+   * "the CLI's own default". GLOBAL, optional, and absent-as-`''` for the same
+   * reasons as {@link cliBridgeModel}.
+   */
+  cliBridgeEffort?(): string;
+  /**
+   * The order the OPTIONAL CodeBuddy CLI route walks the credential regions in
+   * (a comma-separated list such as `'cn,global'`), or `''` for "the CLI's own
+   * default order". GLOBAL, optional, and absent-as-`''` for the same reasons
+   * as {@link cliBridgeModel}.
+   */
+  cliBridgeRegionOrder?(): string;
   /**
    * The LIVE load level per model id, for the card's icon.
    *
@@ -4235,6 +4496,7 @@ interface WorkBuddyPoolDeps {
   otherAccounts?(region: WorkBuddyRegion): Promise<readonly {
     id: string;
     accountName: string;
+    enterprise?: boolean;
   }[]>;
   /** The account currently billing traffic for the region, when known. */
   currentAccountId?(region: WorkBuddyRegion): Promise<string | undefined>;
@@ -4532,6 +4794,37 @@ interface Config {
    * client-fingerprint workaround, not an account one — see `cli-bridge/runner`.
    */
   cliBridge?: CliBridgeSettings;
+  /**
+   * When scanned messages are perturbed with invisible characters.
+   *
+   * `failure` (default) learns from a successful channel-gate rescue and starts
+   * later requests with the learned form; `always` starts every request with
+   * the dense form for a gateway whose plain attempt is a guaranteed refusal;
+   * `off` keeps only the post-failure rescue ladder.
+   */
+  channelPerturbation?: 'off' | 'failure' | 'always';
+  /**
+   * Adopt the official client's usage-page identity on chat requests (issue #132).
+   *
+   * Adds `X-IDE-Name: WorkBuddy` (which is what fills the upstream's 使用端
+   * column) and sends the conversation-identity triple in the 32-hex UUIDv7
+   * shape the official client uses. Off by default: the reporter measured it at
+   * HTTP 200, this plugin has not reproduced that against the live gateway, and a
+   * display-only change should not be the reason an account starts failing.
+   */
+  usageIdentity?: boolean;
+  /**
+   * Move the harness's injected context above the real prompt (issue #132).
+   *
+   * The WorkBuddy usage page records the last `user` message as the request
+   * text, and DSH appends its runtime context after the user's prompt — so the
+   * usage column shows the injected block instead of what the user typed. The
+   * reorder is order-only and matches only the harness's own injected prefixes.
+   *
+   * Off by default: it changes the message order the upstream counts, so it is
+   * an explicit opt-in rather than a silent change on upgrade.
+   */
+  keepPromptLast?: boolean;
 }
 /**
  * Mark a schema's field as volatile on the DSH lines that support it.