dsh-connect-workbuddy 4.4.5 → 4.5.0

package/lib/index.d.ts

@@ -798,6 +798,15 @@ declare function knownRegionOf(domain: string): WorkBuddyRegion | undefined;
  * `tool_choice` (the upstream's field is a string; object forms return 400),
  * and guarantee a leading system message.
  */
+/**
+ * The model id a prepared body asks for, when it carries one (issue #61).
+ *
+ * Lives beside {@link prepareChatBody} because it reads the same shape: the
+ * serialized OpenAI body, after this plugin's rewrites. Never throws — a
+ * malformed body is the upstream's to reject, not a reason to lose the failure
+ * measurement that this id is needed for.
+ */
+declare function modelIdOfBody(bodyJson: string): string | undefined;
 declare function prepareChatBody(source: string): string;
 /** Marker carried by {@link WorkBuddyCredentialRejectedError}; survives bundling. */
 declare const CREDENTIAL_REJECTED_CODE = "WORKBUDDY_CREDENTIAL_REJECTED";
@@ -1107,7 +1116,29 @@ interface WorkBuddyShimOptions {
     status: number;
     kind: UpstreamErrorKind;
     message: string;
+    /**
+     * The model that request asked for (issue #61).
+     *
+     * Carried because the failure is remembered against the ACCOUNT, and `6004`
+     * is an account × model condition: without this the record cannot say which
+     * model the measurement belongs to, so the card has to present a
+     * single-model result as account-level availability.
+     */
+    modelId?: string;
   }) => void;
+  /**
+   * Called with the FINAL serialized body of every chat request, just before it
+   * goes upstream (issue #59).
+   *
+   * It exists so the plugin can record what was actually sent without the shim
+   * having to know where that record goes: the region belongs to whoever wires
+   * this up, and the report is a plugin concern. The body handed over is the
+   * post-`prepareChatBody` one, because THAT is what the upstream counts.
+   *
+   * Fired without awaiting: a request must never wait on a diagnostic. The
+   * callee must treat the string as read-only.
+   */
+  onRequestBody?: (bodyJson: string) => void;
 }
 /**
  * Start the loopback endpoint. Requests must carry the shim's shared secret;
@@ -1944,6 +1975,31 @@ interface WorkBuddyPoolProbe {
    * old probe files stay readable rather than being discarded.
    */
   message?: string;
+  /**
+   * WHICH MODEL this measurement is about (issue #61).
+   *
+   * The pool's "test all accounts" action probes ONE model — the region's
+   * `targetModelId` — while `6004` is an ACCOUNT × MODEL condition: the reporter
+   * measured two accounts where `hy4-preview-f` answered and `step-5-preview`
+   * returned `429 / 6004` at the same moment. A row rendered as plain "可用"
+   * therefore claims more than the measurement says, and the pool's own routing
+   * reads that `ok` as an account-level fact.
+   *
+   * Storing the model id is what makes the claim checkable: the card can say
+   * WHICH model an `ok` came from, and a reader can see that a different model
+   * was never tested at all. `probeModel()` has always returned this field; the
+   * write simply dropped it.
+   *
+   * Deliberately NOT inherited by {@link mergePoolProbe} when an update omits it
+   * — the opposite of `accountName` and `retryAtMs`. Those two describe the
+   * ACCOUNT (a name that a later writer could not see is still true, and a
+   * future refresh time is still in the future), whereas the model describes
+   * THIS measurement. Carrying an older model id forward would relabel a fresh
+   * measurement with a model it was not taken on, which is exactly the confusion
+   * this field exists to end. ABSENT therefore means "unknown scope", never a
+   * guess.
+   */
+  modelId?: string;
   /**
    * The account's display name AT THE MOMENT IT WAS MEASURED (issue #60).
    *
@@ -2117,6 +2173,16 @@ declare function regionEnabledOf(value: unknown, region: WorkBuddyWebRegion): bo
 /** Build the next `regions` settings value for a signed-in tab's save. */
 declare function nextRegionSlots<Slot extends object>(regions: unknown, region: WorkBuddyWebRegion, slot: Slot): Record<string, unknown>;
 declare function nextRegionEnabled(value: unknown, region: WorkBuddyWebRegion, enabled: boolean): Record<string, unknown>;
+/**
+ * The two seats the credit readout can occupy (issue #62).
+ *
+ * `composer` is the composer tool row (`conversation.input.left`); `stats` is
+ * the ambient dock below the composer card (`conversation.composer.dock`),
+ * beside the shell's own round/step/token pills. Named as a union rather than a
+ * boolean because a third seat is plausible and `showAtTop: boolean` would have
+ * to be migrated rather than extended.
+ */
+type WorkBuddyCreditPosition = 'composer' | 'stats';
 /** One credit package as the upstream returns it, node-free. */
 interface WorkBuddyWebCreditPackage {
   packageName: string;
@@ -2305,6 +2371,8 @@ type WorkBuddyWebUsage =
    * "关闭不了" report.
    */
   showCreditsInMainUi?: boolean;
+  /** WHERE this region's readout sits (issue #62); absent means `composer`. */
+  creditPosition?: WorkBuddyCreditPosition;
   message?: string;
   /** The persisted account id matches no local account. */
   selectionLost?: boolean;
@@ -2339,6 +2407,8 @@ type WorkBuddyWebUsage =
    * settings mirror.
    */
   showCreditsInMainUi?: boolean;
+  /** WHERE this region's readout sits (issue #62); absent means `composer`. */
+  creditPosition?: WorkBuddyCreditPosition;
   source?: 'desktop' | 'dsh';
   tokenExpiresAtMs: number;
   /** A saved per-region choice is in effect (false = following the app). */
@@ -2483,7 +2553,13 @@ interface WorkBuddyWebPoolAccount {
   expiringSoon?: number;
   /** When the nearest package expires, in ms. */
   nearestExpiryMs?: number;
-  /** The last test of the target model, absent when never tested. */
+  /**
+   * The last test of this account's target model, absent when never tested.
+   *
+   * The model is recorded INSIDE the probe (issue #61) rather than assumed from
+   * the row's current setting: the setting can be changed after the test, and a
+   * result must keep naming what it actually measured.
+   */
   probe?: {
     outcome: WorkBuddyWebProbeOutcome;
     atMs: number;
@@ -2495,6 +2571,16 @@ interface WorkBuddyWebPoolAccount {
      * guess which of the two it was.
      */
     source?: 'test-batch' | 'live-request';
+    /**
+     * WHICH model this measurement is about (issue #61).
+     *
+     * `6004` is an account × model condition, so an `ok` without a model reads as
+     * account-level availability — which is exactly the false positive the
+     * reporter hit: the card said 可用 for two accounts whose actual model
+     * returned `429 / 6004`. ABSENT for records written before the field existed;
+     * the card must then say the scope is unknown rather than assume it.
+     */
+    modelId?: string;
     /** Only when the upstream named a time; never invented locally. */
     retryAtMs?: number;
     /**
@@ -2527,6 +2613,17 @@ interface WorkBuddyWebPoolAccount {
    * result the user just watched succeed.
    */
   checkedInToday?: boolean;
+  /**
+   * The model a TEST of this row would use (issue #61).
+   *
+   * Per row, because a test model can be chosen per account: the card shows it
+   * beside the row it applies to rather than implying one model for the table.
+   */
+  testModelId?: string;
+  /** Where this row's test target came from (see {@link WorkBuddyWebPool.targetModelSource}). */
+  testModelSource?: 'preferred' | 'free' | 'none' | 'stale';
+  /** This row's saved override that the region no longer offers. */
+  staleTestModelId?: string;
 }
 /**
  * The pool's state for one region.
@@ -2556,6 +2653,14 @@ interface WorkBuddyWebPool {
    * would run against a model the upstream does not offer.
    */
   staleTargetModelId?: string;
+  /**
+   * The SAVED per-account test models, keyed by account id (issue #61).
+   *
+   * Sent verbatim rather than as the effective set: the card edits this map, and
+   * an id whose model has left the catalog must survive a save so the user's
+   * record of what they chose is not silently destroyed.
+   */
+  targetModelIdByAccount?: Readonly<Record<string, string>>;
   /**
    * Where the target came from. `'stale'` means the SAVED id is no longer in
    * the catalog — a distinct state from `'none'` (no free model exists),
@@ -2693,6 +2798,13 @@ interface WorkBuddyStatusRouteOptions {
    * absent reads as ON, matching the schema's `default(true)`.
    */
   showCreditsInMainUi?(region: WorkBuddyRegion): boolean;
+  /**
+   * WHERE this region's credit readout sits (issue #62).
+   *
+   * Optional, and absent reads as `composer` — the only seat before the setting
+   * existed, so a Host that predates it renders exactly as it used to.
+   */
+  creditPosition?(region: WorkBuddyRegion): WorkBuddyCreditPosition;
   /**
    * Send one real-volume request to each named model of a region and report what
    * came back.
@@ -2840,6 +2952,8 @@ interface WorkBuddyPoolDeps {
   preferences(region: WorkBuddyRegion): {
     enabled: boolean;
     targetModelId: string;
+    /** Per-account override of `targetModelId` (issue #61). */
+    targetModelIdByAccount?: Readonly<Record<string, string>>;
     /**
      * Tokens each test probe sends as saved; `0` when the user never chose.
      *
@@ -2935,7 +3049,18 @@ interface WorkBuddyPoolDeps {
    * the route handles both, because a missing reporter must degrade to the
    * previous behaviour rather than to no rows at all.
    */
-  test?(region: WorkBuddyRegion, modelId: string, onRow?: (row: WorkBuddyPoolTestRow) => void): Promise<readonly WorkBuddyPoolTestRow[]>;
+  test?(region: WorkBuddyRegion,
+  /**
+   * One model for the whole batch, or a per-account resolver (issue #61).
+   *
+   * The resolver form is what lets a batch honour a per-account test model; a
+   * resolver that names no model yields an `unavailable` row for that account
+   * rather than silently testing the region default.
+   */
+  modelId: string | ((accountId: string) => {
+    modelId?: string;
+    staleModelId?: string;
+  }), onRow?: (row: WorkBuddyPoolTestRow) => void): Promise<readonly WorkBuddyPoolTestRow[]>;
   /** The region's live catalog, used to resolve the free target model. */
   catalog?(region: WorkBuddyRegion): readonly WorkBuddyModelInfo[];
 }
@@ -3003,6 +3128,25 @@ interface WorkBuddyRegionState {
    * written before this switch existed keeps whatever the default was.
    */
   showCreditsInMainUi?: boolean;
+  /**
+   * WHERE this region's credit readout sits (issue #62).
+   *
+   * Two seats, because the first one is not always available:
+   *
+   *   - `composer` — the composer tool row (`conversation.input.left`), shared
+   *     with the shell's own controls. It is the closer, more glanceable seat,
+   *     and it is the default so nothing moves for anyone who does not choose.
+   *   - `stats` — the ambient dock below the composer card
+   *     (`conversation.composer.dock`), where the shell renders its own
+   *     round/step/token pills. That row is a LIST seat whose shipped occupant
+   *     registers separately, so a third-party plugin that ALSO parks something
+   *     in the composer row cannot crowd this readout out of existence.
+   *
+   * The report behind this (issue #62) was exactly that: with another plugin
+   * installed, the readout vanished from the composer row. Making the seat a
+   * choice is what keeps one plugin's presence from deciding another's.
+   */
+  creditPosition?: WorkBuddyCreditPosition;
   /** The last-refreshed directory for this region; what the card displays. */
   lastCatalog?: WorkBuddyModelInfo[];
   /** The user's selection in this region, as model ids. */
@@ -3045,6 +3189,18 @@ interface WorkBuddyPoolPreferences {
   enabled?: boolean;
   /** Model id to test; `''` means auto-pick a free model from this region. */
   targetModelId?: string;
+  /**
+   * Per-account override of {@link targetModelId}, keyed by account id (#61).
+   *
+   * `6004` is an ACCOUNT × MODEL condition, so "can this account serve" has no
+   * single answer: the reporter measured two accounts where one model answered
+   * and another returned `429 / 6004` in the same second. The region-wide target
+   * stays the default — this map only says "for THIS account, test THAT model",
+   * which is what makes the pool's verdict match the model the user is actually
+   * chatting with. An id that is no longer in the catalog is reported as stale
+   * rather than replaced, so no credits are spent on a model nobody chose.
+   */
+  targetModelIdByAccount?: Record<string, string>;
   /**
    * How much input a probe sends, in tokens — the pool's biggest single knob.
    *
@@ -3216,4 +3372,4 @@ declare function legacyAttributionRegion(value: Config, accountsFor: (region: Wo
  */
 declare function apply(ctx: Context, config: Config): void;
 //#endregion
-export { CREDENTIAL_REJECTED_CODE, Config, DEFAULT_PROBE_INPUT_TOKENS, ENCRYPTED_CREDENTIAL_CODE, FALLBACK_WORKBUDDY_MODELS, FALLBACK_WORKBUDDY_MODELS_GLOBAL, NATIVE_MODALITY_BY_MODEL_ID, PROBE_INPUT_TOKEN_CHOICES, PROBE_MAX_TOKENS, PROBE_SYSTEM_PROMPT, REFUSES_OFF_MODEL_IDS, type UpstreamErrorKind, WORKBUDDY_ACCOUNTS_REFRESH_PATH, WORKBUDDY_APP_EXECUTABLE_ENV, WORKBUDDY_AUTH_FILENAME, WORKBUDDY_AUTH_FILE_ENV, WORKBUDDY_CHECKIN_PATH, WORKBUDDY_CONNECT_VERSION, WORKBUDDY_GLOBAL_PROVIDER, WORKBUDDY_HOST_HEARTBEAT_FILENAME, WORKBUDDY_MODELS_REFRESH_PATH, WORKBUDDY_PROBE_PATH, WORKBUDDY_PROVIDER, WORKBUDDY_PROVIDERS, WORKBUDDY_PROVIDER_DISPLAY_NAMES, WORKBUDDY_REGIONS, WORKBUDDY_REGION_PARAM, WORKBUDDY_SETTINGS_NS, WORKBUDDY_STREAM_IDLE_TIMEOUT_MS, WORKBUDDY_USAGE_PATH, type WorkBuddyAccountChoice, type WorkBuddyAdapter, type WorkBuddyAuthStatus, type WorkBuddyCandidateFailure, WorkBuddyCatalog, type WorkBuddyChatResult, type WorkBuddyCredential, type WorkBuddyCredentialRecovery, WorkBuddyCredentialRejectedError, WorkBuddyCredentialStore, type WorkBuddyCreditPackage, type WorkBuddyCredits, WorkBuddyEncryptedCredentialError, type WorkBuddyEncryptedField, type WorkBuddyHostHeartbeat, type WorkBuddyModelInfo, type WorkBuddyNativeModality, WorkBuddyPoolPreferences, type WorkBuddyProbeClient, type WorkBuddyProbeOutcome, type WorkBuddyProbeResult, type WorkBuddyProbeStore, type WorkBuddyReasoning, type WorkBuddyRecoveryCandidate, type WorkBuddyRefreshOutcome, WorkBuddyRegionState, type WorkBuddyShim, type WorkBuddyStatusRouteOptions, type WorkBuddyStoreOptions, WorkBuddyUpstreamClient, type WorkBuddyUpstreamModel, type WorkBuddyUsabilityProbeOptions, apply, asVolatile, authFileName, classifyUpstreamError, clearAtRestKeyCache, clearHostHeartbeat, cooldownOf, createAccountUsabilityProbe, createWorkBuddyAdapter, createWorkBuddyShim, creditOfStream, defaultDesktopAuthCandidates, defaultDesktopAuthDirs, defaultDesktopAuthPath, defaultOffModelIds, deriveAtRestKey, deriveAtRestKeyId, deriveCatalog, fallbackModelsFor, fetchAtRestKeyPayload, findWorkbuddyAppExecutable, hasEncryptedCredentialFields, imageDefaultFor, inject, isCredentialRejectedError, isEncryptedCredentialError, isEncryptedFieldWrapper, isHeartbeatProcessAlive, isWorkbuddyBundle, knownRegionOf, legacyAttributionRegion, legacyWorkbuddyOwnAuthPath, macosBundleExecutable, macosNestedAppBundles, name, nativeModalityOf, nextRegionEnabled, nextRegionSlots, offDefaultFor, openEncryptedField, outcomeOfFailure, parseCreditMultiplier, parseReasoning, parseRetryAfter, parseUpstreamModel, parseWorkBuddyAuth, prepareChatBody, probeModel, probeRequestBody, probeSucceeded, processStartTimeMs, readAtRestKey, readHostHeartbeat, regionCleared, regionEnabled, regionEnabledOf, regionOf, regionOfProvider, regionOfStatusUrl, regionStateOf, registerWorkBuddyStatusRoute, resolveCredentialRecovery, selectAccountFor, settingsNamespaceOf, toPersistedWorkBuddyModel, unwrapVolatileDeep, withEffectiveOff, withWorkBuddyRegion, workBuddyDisplayName, workBuddyModelInput, workBuddyThinkingLevelMap, workBuddyWebStatus, workbuddyAccountId, workbuddyAppExecutableCandidates, workbuddyHostHeartbeatPath, workbuddyOwnAuthPath, writeHostHeartbeat };
+export { CREDENTIAL_REJECTED_CODE, Config, DEFAULT_PROBE_INPUT_TOKENS, ENCRYPTED_CREDENTIAL_CODE, FALLBACK_WORKBUDDY_MODELS, FALLBACK_WORKBUDDY_MODELS_GLOBAL, NATIVE_MODALITY_BY_MODEL_ID, PROBE_INPUT_TOKEN_CHOICES, PROBE_MAX_TOKENS, PROBE_SYSTEM_PROMPT, REFUSES_OFF_MODEL_IDS, type UpstreamErrorKind, WORKBUDDY_ACCOUNTS_REFRESH_PATH, WORKBUDDY_APP_EXECUTABLE_ENV, WORKBUDDY_AUTH_FILENAME, WORKBUDDY_AUTH_FILE_ENV, WORKBUDDY_CHECKIN_PATH, WORKBUDDY_CONNECT_VERSION, WORKBUDDY_GLOBAL_PROVIDER, WORKBUDDY_HOST_HEARTBEAT_FILENAME, WORKBUDDY_MODELS_REFRESH_PATH, WORKBUDDY_PROBE_PATH, WORKBUDDY_PROVIDER, WORKBUDDY_PROVIDERS, WORKBUDDY_PROVIDER_DISPLAY_NAMES, WORKBUDDY_REGIONS, WORKBUDDY_REGION_PARAM, WORKBUDDY_SETTINGS_NS, WORKBUDDY_STREAM_IDLE_TIMEOUT_MS, WORKBUDDY_USAGE_PATH, type WorkBuddyAccountChoice, type WorkBuddyAdapter, type WorkBuddyAuthStatus, type WorkBuddyCandidateFailure, WorkBuddyCatalog, type WorkBuddyChatResult, type WorkBuddyCredential, type WorkBuddyCredentialRecovery, WorkBuddyCredentialRejectedError, WorkBuddyCredentialStore, type WorkBuddyCreditPackage, type WorkBuddyCredits, WorkBuddyEncryptedCredentialError, type WorkBuddyEncryptedField, type WorkBuddyHostHeartbeat, type WorkBuddyModelInfo, type WorkBuddyNativeModality, WorkBuddyPoolPreferences, type WorkBuddyProbeClient, type WorkBuddyProbeOutcome, type WorkBuddyProbeResult, type WorkBuddyProbeStore, type WorkBuddyReasoning, type WorkBuddyRecoveryCandidate, type WorkBuddyRefreshOutcome, WorkBuddyRegionState, type WorkBuddyShim, type WorkBuddyStatusRouteOptions, type WorkBuddyStoreOptions, WorkBuddyUpstreamClient, type WorkBuddyUpstreamModel, type WorkBuddyUsabilityProbeOptions, apply, asVolatile, authFileName, classifyUpstreamError, clearAtRestKeyCache, clearHostHeartbeat, cooldownOf, createAccountUsabilityProbe, createWorkBuddyAdapter, createWorkBuddyShim, creditOfStream, defaultDesktopAuthCandidates, defaultDesktopAuthDirs, defaultDesktopAuthPath, defaultOffModelIds, deriveAtRestKey, deriveAtRestKeyId, deriveCatalog, fallbackModelsFor, fetchAtRestKeyPayload, findWorkbuddyAppExecutable, hasEncryptedCredentialFields, imageDefaultFor, inject, isCredentialRejectedError, isEncryptedCredentialError, isEncryptedFieldWrapper, isHeartbeatProcessAlive, isWorkbuddyBundle, knownRegionOf, legacyAttributionRegion, legacyWorkbuddyOwnAuthPath, macosBundleExecutable, macosNestedAppBundles, modelIdOfBody, name, nativeModalityOf, nextRegionEnabled, nextRegionSlots, offDefaultFor, openEncryptedField, outcomeOfFailure, parseCreditMultiplier, parseReasoning, parseRetryAfter, parseUpstreamModel, parseWorkBuddyAuth, prepareChatBody, probeModel, probeRequestBody, probeSucceeded, processStartTimeMs, readAtRestKey, readHostHeartbeat, regionCleared, regionEnabled, regionEnabledOf, regionOf, regionOfProvider, regionOfStatusUrl, regionStateOf, registerWorkBuddyStatusRoute, resolveCredentialRecovery, selectAccountFor, settingsNamespaceOf, toPersistedWorkBuddyModel, unwrapVolatileDeep, withEffectiveOff, withWorkBuddyRegion, workBuddyDisplayName, workBuddyModelInput, workBuddyThinkingLevelMap, workBuddyWebStatus, workbuddyAccountId, workbuddyAppExecutableCandidates, workbuddyHostHeartbeatPath, workbuddyOwnAuthPath, writeHostHeartbeat };