mirror of
https://github.com/deepseek-ai/deepseek-harness
synced 2026-08-15 21:04:50 +00:00
f7323354bb
Rebuild of the region machinery (PR3) on the post-#904 Typert projection: renderPageRegion/renderInheritedPage live in dsh-typert-generator beside the projection; scripts/gen-cordis-catalog.ts owns the curated SERVICE_PAGE / EVENT_SCOPE_PAGE / SERVICE_WALK_EXEMPTIONS / LINK_MAP partition (fail-loud in both directions, with the independent Context-merge scan backstopping the projection's blind spot), spliceRegion, and the guarded pair auto-record. docs/cordis-catalog/ is deleted: the flat events/services catalogs dissolve into per-page regions and docs/cordis-catalog/core moves to docs/cordis-api/ with the inherited tier as its own generated page. The partition absorbs the post-regrouping surface: ctx.typert → invariants.md, ctx.directoryPicker → workspace.md, skills/* events → skills.md, and the four launcher-provided tui accessor values join the named exemptions.
134 lines
6.8 KiB
Markdown
134 lines
6.8 KiB
Markdown
# 用户凭据
|
||
|
||
[English](credentials.md) | 中文
|
||
|
||
[dsh-credentials](../../packages/credentials/credentials) 的凭据 seam 把机密挡在配置之外：settings 分节与 `cordis.yml` 条目携带的是*引用*（环境变量名），值归 [dsh-credentials-local](../../packages/credentials/credentials-local) 这类 provider 所有，消费方每个操作解析一次引用——LLM 适配器每次模型请求解析一次，因此轮换后的凭据无需任何重启即可作用于紧随其后的下一次请求。一条 seam 级规则约束每个 provider：空的存储值在任何地方都视为不存在。
|
||
|
||
Source: [`packages/credentials/credentials/src/index.ts`](../../packages/credentials/credentials/src/index.ts)
|
||
|
||
## 标识
|
||
|
||
引用以 POSIX 风格环境变量名命名一条凭据。brand 使引用不与其他跨边界字符串混用；构造时校验 shell 标识符形态。
|
||
|
||
```ts type-equiv
|
||
/** Nominal reference to one credential: a POSIX-style environment-variable name. */
|
||
type CredentialRef = Branded<'CredentialRef'>
|
||
```
|
||
|
||
## 解析
|
||
|
||
`resolve(ref)` 返回值，连同供出该值、由 provider 定义的来源层；未配置期间返回 `undefined`。消费方在每个操作中重新解析，绝不跨操作缓存——这次按操作进行的读取正是热更新机制。
|
||
|
||
```ts type-equiv
|
||
/** One resolved credential value and the source layer that supplied it. */
|
||
interface ResolvedCredential {
|
||
/** The non-empty secret value. */
|
||
value: string
|
||
/** Provider-defined source layer id (the local provider uses `env`, `file`, `project-env`, and `user-env`). */
|
||
source: string
|
||
}
|
||
```
|
||
|
||
## 描述
|
||
|
||
`describe(ref)` 在绝不暴露值的前提下回应配置界面：引用当前是否可解析、来自哪一层、`set` 当前能否成功。本地 provider 把由活跃进程环境供值的引用报告为 `writable: false`——那样的写入会表面成功而解析持续返回遮蔽值，因此 seam 直接拒绝，界面也得以提前把该引用渲染为只读。
|
||
|
||
```ts type-equiv
|
||
/** Source and writability facts for one reference, safe for configuration UIs — never the value. */
|
||
interface CredentialInfo {
|
||
/** Whether {@link Credentials.resolve} would currently return a value. */
|
||
configured: boolean
|
||
/** Source layer currently supplying the value; absent while unconfigured. */
|
||
source?: string
|
||
/** Whether {@link Credentials.set} would currently succeed for this reference. */
|
||
writable: boolean
|
||
}
|
||
```
|
||
|
||
## 变更提交
|
||
|
||
`credentials/updated (ref)` 在 provider 管理的来源发生已提交变更后触发——`set`、`unset` 或在存储中观察到的外部编辑。进程环境自身的变化不可观测，永不发出事件。消费方不需要该事件（它们按操作重新解析）；它服务于配置界面刷新「已配置」徽标。
|
||
|
||
<!-- BEGIN GENERATED cordis-surface (gen-cordis-catalog.ts) — do not edit between markers -->
|
||
|
||
<a id="cordis-surface"></a>
|
||
|
||
## Cordis surface
|
||
|
||
Generated from source by `scripts/gen-cordis-catalog.ts` (verified fresh by `pnpm run verify-cordis-catalog` in doc-sync; regenerate with `pnpm run gen-cordis-catalog`) — this section is byte-identical in both language sides of the page. Signature blocks use a `ts cordis-catalog` fence and keep the original source JSDoc; dispatch modes are defined in the [primer](../cordis-primer.md#dispatch-modes), and the framework-inherited `ctx` surface lives in [cordis-api/inherited.md](../cordis-api/inherited.md).
|
||
|
||
<a id="ctxcredentials--credentials-abstract-seam"></a>
|
||
|
||
### `ctx.credentials` — `Credentials` (abstract seam)
|
||
|
||
Abstract credential service. Providers implement the four operations over their source layers; one seam-wide rule binds them all: an empty stored value is absent everywhere — `resolve` skips it, `describe` reports it unconfigured — so a blank never masquerades as a configured secret.
|
||
|
||
```ts cordis-catalog
|
||
/**
|
||
* Resolve one reference to its current value. Resolution is per call:
|
||
* consumers re-resolve at each operation and must not cache across
|
||
* operations — that per-operation read is what makes a changed credential
|
||
* reach the next operation without a restart.
|
||
* @param ref - the reference to resolve.
|
||
* @returns the value and its source, or `undefined` while unconfigured.
|
||
*/
|
||
abstract resolve(ref: CredentialRef): Promise<ResolvedCredential | undefined>
|
||
|
||
/**
|
||
* Describe one reference for configuration surfaces without exposing the
|
||
* value.
|
||
* @param ref - the reference to describe.
|
||
* @returns configured state, supplying source, and writability.
|
||
*/
|
||
abstract describe(ref: CredentialRef): Promise<CredentialInfo>
|
||
|
||
/**
|
||
* Durably store one value in the provider-managed writable source. Rejects
|
||
* while a read-only source shadows the reference — the write would appear
|
||
* to succeed while resolution keeps returning the shadowing value — and
|
||
* rejects an empty value (use {@link unset}).
|
||
* @param ref - the reference to store.
|
||
* @param value - the non-empty secret value.
|
||
*/
|
||
abstract set(ref: CredentialRef, value: string): Promise<void>
|
||
|
||
/**
|
||
* Remove one reference from the provider-managed writable source; removing
|
||
* an absent reference is a no-op. Rejects while a read-only source shadows
|
||
* the reference, like {@link set}.
|
||
* @param ref - the reference to remove.
|
||
*/
|
||
abstract unset(ref: CredentialRef): Promise<void>
|
||
```
|
||
|
||
Source: [`packages/credentials/credentials/src/index.ts:77`](../../packages/credentials/credentials/src/index.ts)
|
||
|
||
<a id="credentials-events"></a>
|
||
|
||
### `credentials/*` events
|
||
|
||
<a id="credentialsupdated--emit"></a>
|
||
|
||
#### `credentials/updated` — emit
|
||
|
||
Committed change to a provider-managed credential source: a `set`, an `unset`, or an external edit observed in storage. Ambient process-environment changes are not observable and never emit. Listener failures are contained and logged — a sync throw and an async rejection alike — without changing the committed operation's outcome, except `INVARIANT`-coded failures, which rethrow after every listener ran; that rethrow reaches the emitter only from synchronous listeners, so invariant checks on this event must not be async functions.
|
||
|
||
```ts cordis-catalog
|
||
/**
|
||
* Committed change to a provider-managed credential source: a `set`, an
|
||
* `unset`, or an external edit observed in storage. Ambient
|
||
* process-environment changes are not observable and never emit. Listener
|
||
* failures are contained and logged — a sync throw and an async rejection
|
||
* alike — without changing the committed operation's outcome, except
|
||
* `INVARIANT`-coded failures, which rethrow after every listener ran;
|
||
* that rethrow reaches the emitter only from synchronous listeners, so
|
||
* invariant checks on this event must not be async functions.
|
||
* @param ref - the reference whose stored value changed.
|
||
* @mode emit
|
||
*/
|
||
'credentials/updated'(ref: CredentialRef): void
|
||
```
|
||
|
||
Source: [`packages/credentials/credentials/src/index.ts:67`](../../packages/credentials/credentials/src/index.ts)
|
||
<!-- END GENERATED cordis-surface -->
|