// Generated by scripts/sync-shared.mjs from shared/client/settings/settings-form.ts. Do not edit this copy; edit the shared source and run "node scripts/sync-shared.mjs". /** * Staged form model behind the plugin settings card. A card stages what the * user types and writes it only when they save — the settings write is a * durable, revision-fenced document mutation, so staging keeps what is on * screen exactly what a save would store. Family-shared slice inlined into * each plugin's client bundle; mirrors the official ui-plugin-config * card-store pattern. */ import type { SettingsScope, SettingsScopeSnapshot, SnapshotStore } from '@deepseek-ai/dsh-client-runtime/client' import { createSnapshotStore } from '@deepseek-ai/dsh-client-runtime/client' /** The write one field's staged text performs when the card is saved. */ export type FieldWrite = | { kind: 'set'; value: unknown } | { kind: 'clear' } /** How one field converts between its stored value and its draft text. */ export interface FieldSpec { /** Field name inside the namespace section. */ field: string /** * Whether the Host treats this field as a secret and redacts its value from * the read-back (role('secret') in the section schema). Redacted secrets are * never compared against the draft on save; the field lands when the scope * reports the write succeeded (its secret-set marker under the bridge), so * a successful secret save is not misreported as failed. */ secret?: boolean /** Render a stored value as draft text; the empty string when the section carries none. */ format: (value: unknown) => string /** * The write this draft text stages, or undefined when the text is not a * value this field accepts — which blocks the save rather than discarding it. */ parse: (text: string) => FieldWrite | undefined } /** One field as the card renders it. */ export interface FieldState { /** Draft text the control renders. */ text: string /** Whether saving would leave a user-layer entry for this field. */ overridden: boolean /** Whether the draft is not a value this field accepts, which blocks saving. */ invalid: boolean } /** Form state every plugin settings card shares. */ export interface CardShell { /** False while the namespace is still loading; the card renders nothing. */ available: boolean /** * Whether the namespace is actually served to this client. False when the * Host deployment does not expose it (e.g. the official apiproxy settings * allowlist omits third-party namespaces): the card renders an explanation * instead of its form, so a missing namespace never looks like a missing * plugin. */ exposed: boolean /** Whether the Host document accepts writes. */ writable: boolean /** Whether the form holds edits that a save would write. */ dirty: boolean /** Whether any staged draft is invalid, which blocks the save. */ invalid: boolean /** Whether a save is crossing the wire. */ saving: boolean /** Whether the last save did not land as staged; cleared by the next edit or save. */ failed: boolean /** * The rejection code/message the Host returned for the last failed save, * surfaced next to the generic failure text. Undefined while no save has * failed (or the failure carried no server reason). */ failedReason?: string } /** The write actions the card's slot entry injects. */ export interface CardActions { /** Stage draft text for one field. */ edit: (field: string, text: string) => void /** Stage a clear, so saving lets the field re-inherit the composition layer. */ resetField: (field: string) => void /** Write every staged edit, then re-seed from what the Host accepted. */ save: () => void /** Drop every staged edit. */ discard: () => void } /** One field's staged edit. */ interface StagedEdit { /** Draft text the control renders. */ text: string /** True when this edit clears the field whatever text it shows. */ clear: boolean } /** One staged edit resolved into the write a save performs. */ interface PlannedWrite { /** Field this entry writes. */ field: string /** The durable write this entry performs, described for a batched scope. */ op: BatchedWrite /** Perform the write and report whether the Host holds the staged value afterwards. */ run: (() => Promise) | undefined } /** One durable write a batched settings scope performs. */ export interface BatchedWrite { /** Field this entry writes. */ field: string /** set stores a value; unset drops the leaf. */ op: 'set' | 'unset' /** Value for op set (absent for unset). */ value?: unknown } /** Per-field outcome of one batched scope write. */ export interface BatchedFieldResult { /** Field this entry writes. */ field: string /** Whether the Host accepted this field's write (per the read-back view). */ landed: boolean } /** * Result of a batched scope write. The bridge scope posts every planned write * in one /mutate so the Host validate hook judges baseURL+model together; a * batched refusal fails the whole save rather than per-field. */ export interface BatchResult { /** Whether the whole mutate was accepted. */ ok: boolean /** Per-field success, in the request order (always present when ok). */ fields: BatchedFieldResult[] /** Host rejection code (mutate refused). */ code?: string /** Host rejection message (mutate refused). */ message?: string } /** The optional batch surface the bridge scope adds over the SettingsScope contract. */ interface BatchedSettingsScope { /** Write every operation in one scope mutation, reporting per-field success. */ mutate: (writes: BatchedWrite[]) => Promise } /** Constraints a numeric field's accepted drafts must satisfy, mirroring the host schema. */ export interface NumberConstraints { /** The accepted value must be a whole number. */ integer?: boolean /** The accepted value must be at least this. */ min?: number } /** A whole- or decimal-number field. An empty draft clears the field; any other draft that is not a finite number within the constraints blocks the save. */ export function numberField(field: string, constraints: NumberConstraints = {}): FieldSpec { const { integer = false, min } = constraints return { field, format: value => typeof value === 'number' ? String(value) : '', parse: (text) => { const trimmed = text.trim() if (trimmed === '') return { kind: 'clear' } const parsed = Number(trimmed) if (!Number.isFinite(parsed)) return undefined if (integer && !Number.isInteger(parsed)) return undefined if (min !== undefined && parsed < min) return undefined return { kind: 'set', value: parsed } }, } } /** A free-text field. An empty draft clears the field. */ export function textField(field: string): FieldSpec { return { field, format: value => typeof value === 'string' ? value : '', parse: (text) => { const trimmed = text.trim() return trimmed === '' ? { kind: 'clear' } : { kind: 'set', value: trimmed } }, } } /** * A free-text field the Host treats as a secret and redacts from the read-back * (role('secret') in the section schema). The card still edits it like text, * but a save never compares the redacted value back and relies on the scope * reporting the write landed. */ export function secretField(field: string): FieldSpec { return { ...textField(field), secret: true } } /** A boolean field, edited through true/false draft text. */ export function booleanField(field: string): FieldSpec { return { field, format: value => typeof value === 'boolean' ? String(value) : '', parse: (text) => { const trimmed = text.trim() if (trimmed === '') return { kind: 'clear' } if (trimmed === 'true') return { kind: 'set', value: true } if (trimmed === 'false') return { kind: 'set', value: false } return undefined }, } } /** An enumerated string field; only the listed choices are accepted. An empty draft clears the field. */ export function choiceField(field: string, choices: readonly string[]): FieldSpec { return { field, format: value => typeof value === 'string' && choices.includes(value) ? value : '', parse: (text) => { if (text === '') return { kind: 'clear' } return choices.includes(text) ? { kind: 'set', value: text } : undefined }, } } /** * Stages one card's edits over one settings namespace and writes them on save. * * The Host is the only authority on whether a value was accepted — its * validators own the constraints no schema can express — so the outcome is * read back from the section rather than predicted here. A save that did not * land keeps its drafts, so the user can correct them instead of retyping. */ export class CardForm { private readonly specs: Map private readonly staged = new Map() private readonly listeners = new Set<() => void>() /** The scope subscription installed in the constructor; released by dispose(). */ private readonly disposeScope: () => void private disposed = false private saving = false private failed = false private failedReason: string | undefined /** @param scope - the bound settings scope for this card's namespace. */ constructor( private readonly scope: SettingsScope, specs: FieldSpec[], ) { this.specs = new Map(specs.map(spec => [spec.field, spec])) this.disposeScope = scope.subscribe(() => { this.publish() }) } /** * Release the scope subscription and every bound store listener. The card * must call this on teardown; later calls are no-ops. */ dispose(): void { if (this.disposed) return this.disposed = true this.disposeScope() this.listeners.clear() } /** Publish a projection of this form, rebuilt whenever the scope or a draft changes. */ bind(project: () => S): SnapshotStore { const store = createSnapshotStore(project()) this.listeners.add(() => { store.set(project()) }) return store } /** Read the card-level state: what the Host serves, and what a save would do. */ shell(): CardShell { const snapshot = this.scope.getSnapshot() const plan = this.plan() return { available: snapshot.status !== 'loading', exposed: snapshot.status === 'ready', writable: snapshot.writable, dirty: plan.length > 0, invalid: plan.some(item => item.run === undefined), saving: this.saving, failed: this.failed, ...this.failedReason === undefined ? {} : { failedReason: this.failedReason }, } } /** Read one field's state from the effective section and its staged draft. */ field(field: string): FieldState { const spec = this.specOf(field) const staged = this.staged.get(field) if (staged === undefined) { return { text: spec.format(this.sectionValue(field)), overridden: this.stored(field), invalid: false } } const write = staged.clear ? { kind: 'clear' as const } : spec.parse(staged.text) return { text: staged.text, overridden: write?.kind === 'set', invalid: write === undefined, } } /** The actions the card's slot registration injects. */ actions(): CardActions { return { edit: (field, text) => { this.stage(field, { text, clear: false }) }, resetField: (field) => { this.stage(field, { text: this.specOf(field).format(this.baseValue(field)), clear: true }) }, save: () => { void this.save() }, discard: () => { if (this.staged.size === 0 && !this.failed) return this.staged.clear() this.failed = false this.failedReason = undefined this.publish() }, } } /** * Write every staged edit, then re-seed from what the Host accepted. * * When the scope carries the optional batch surface (the dsh-web-ui * bridge scope), every planned write rides one mutation so cross-field * validate hooks (baseURL+model) judge the batch as a unit instead of * deadlocking on per-field writes. Otherwise the per-field loop runs. * A field lands only when the Host reports it held the staged value; a * landed field's draft is dropped, a failed one stays staged for the user. * @returns settlement after every write and the read-back. */ async save(): Promise { const plan = this.plan() const valid = plan.filter(item => item.run !== undefined) if (plan.length === 0 || this.saving || valid.length !== plan.length) return const plannedWrites = valid.map(item => item.op) // Snapshot the fields this save writes, so edits staged while it is in // flight survive: only the staged keys this save actually wrote are cleared. const fields = new Set(plan.map(item => item.field)) this.saving = true this.failed = false this.failedReason = undefined this.publish() const landed = new Set() const batch = this.batchedScope() if (batch !== undefined) { const result = await batch.mutate(plannedWrites) if (result.ok) { for (const field of result.fields) { if (field.landed) landed.add(field.field) } } else { this.failedReason = result.message } } else { for (const item of valid) { if (await item.run!()) landed.add(item.field) } } for (const field of fields) { if (landed.has(field)) this.staged.delete(field) } this.saving = false this.failed = landed.size !== fields.size this.publish() } /** The scope's batch surface when it supports one; undefined conservatively otherwise. */ private batchedScope(): BatchedSettingsScope | undefined { const candidate = this.scope as unknown as BatchedSettingsScope | undefined return typeof candidate?.mutate === 'function' ? candidate : undefined } /** * Every staged edit a save would write. An entry whose draft is not a value * its field accepts carries no write: the form is still dirty, and the save * refuses rather than dropping the edit. A staged edit that matches the * effective section is not a write at all. * @returns the planned writes, in the order the fields were staged. */ private plan(): PlannedWrite[] { const plan: PlannedWrite[] = [] for (const [field, staged] of this.staged) { const spec = this.specOf(field) if (staged.clear) { if (this.stored(field)) plan.push({ field, op: { field, op: 'unset' }, run: () => this.clear(field) }) continue } if (staged.text === spec.format(this.sectionValue(field))) continue const write = spec.parse(staged.text) if (write === undefined) plan.push({ field, op: { field, op: 'unset' }, run: undefined }) else if (write.kind === 'clear') plan.push({ field, op: { field, op: 'unset' }, run: () => this.clear(field) }) else plan.push({ field, op: { field, op: 'set', value: write.value }, run: () => this.store(field, write.value) }) } return plan } private async clear(field: string): Promise { await this.scope.unset(field) return !this.stored(field) } private async store(field: string, value: unknown): Promise { await this.scope.set(field, value) // A redacted secret never appears in the user layer read-back; judging it // by value would misreport a successful secret save as failed. The bridge // reports secret writes through its secret-set markers (batch path); on // the per-field path the scope resolved, so the write is landed. if (this.specOf(field).secret) return true return this.userLayer()?.[field] === value } private stage(field: string, edit: StagedEdit): void { this.staged.set(field, edit) this.failed = false this.failedReason = undefined this.publish() } private specOf(field: string): FieldSpec { const spec = this.specs.get(field) // Every call site names a field this card declared; a missing one is a // wiring mistake that must not degrade into a silently inert control. if (spec === undefined) throw new Error(`settings card has no field ${field}`) return spec } private snapshotOf(): SettingsScopeSnapshot { return this.scope.getSnapshot() } private sectionValue(field: string): unknown { return (this.snapshotOf().value as Record | undefined)?.[field] } private baseValue(field: string): unknown { return (this.snapshotOf().base as Record | undefined)?.[field] } private userLayer(): Record | undefined { return this.snapshotOf().user as Record | undefined } private stored(field: string): boolean { const user = this.userLayer() return user !== undefined && Object.hasOwn(user, field) } private publish(): void { for (const listener of this.listeners) listener() } }