Files
mesh-contracts/ts/seats/meshconfig/index.d.ts
T
jschoubben e529c372d0 C14: the generated Go and TypeScript of every seat follow the definitions
Written by seatgen at c62650e4 (GEN3) with mesh-sdk b19fc7fa (reader release): the seat mesh-grants new,
every TypeScript contract as index.js with index.d.ts, events with subject and stream. mesh-watchdogs gains
its family, which a definition with events needs. Written with the reader as it is: the field needs-approval
(node-login-shell) and the section bodies (mesh-conditions) are unknown to it, so they were laid aside for
the run; nothing generated carries either.

Builds: design 47 G §339, §341, §261, §389

Claude-Session: https://claude.ai/code/session_01JG73KEq4zoDfM9WtYpcQgZ
2026-11-11 10:45:30 +01:00

169 lines
5.2 KiB
TypeScript

// Code generated by seatgen from the seat definitions; DO NOT EDIT.
// The contract of the seat "mesh-config", defined whole (seats/mesh-config/seat.json): The mesh's config values: read and set one, and the renames still open. mesh-config's own events stay under its own subjects (ADR 0620 §2).
export declare const seat: "mesh-config";
export declare const verbs: {
readonly config: "config";
readonly renames: "renames";
};
export declare const holderEvents: {
readonly configChanged: "config-changed";
readonly renamed: "renamed";
readonly retiring: "retiring";
readonly retired: "retired";
};
export declare function configChangedHolderSubject(holder: string): string;
export declare function renamedHolderSubject(holder: string): string;
export declare function retiringHolderSubject(holder: string): string;
export declare function retiredHolderSubject(holder: string): string;
export declare const states: {
readonly resolved: "resolved";
readonly kept: "kept";
};
/** The key of one value of the state resolved under the form "<node>.<module>.<key>". */
export declare function resolvedByNodeModuleKeyKey(node: string, module: string, key: string): string;
/** The parts of a key of the form "<node>.<module>.<key>", or undefined for a key of another form. */
export declare function parseResolvedByNodeModuleKeyKey(_key: string): { node: string; module: string; key: string } | undefined;
/** The key of one value of the state kept under the form "<owner>.<repository>.<number>.<node>.<module>.<key>". */
export declare function keptByOwnerRepositoryNumberNodeModuleKeyKey(owner: string, repository: string, number: string, node: string, module: string, key: string): string;
/** The parts of a key of the form "<owner>.<repository>.<number>.<node>.<module>.<key>", or undefined for a key of another form. */
export declare function parseKeptByOwnerRepositoryNumberNodeModuleKeyKey(_key: string): { owner: string; repository: string; number: string; node: string; module: string; key: string } | undefined;
/** is what config takes. */
export interface ConfigInput {
/** list (when not given), set, clear or history */
"action"?: string;
/** who gave the value at the controller's terminal */
"by"?: string;
/** the config key */
"key"?: string;
/** for history: at most this many, newest */
"limit"?: number;
/** a module: its own value, with node */
"module"?: string;
/** a node */
"node"?: string;
/** for set: the value, of the key's type: a number, a string, a boolean, or for a trusted key an object or a list */
"value"?: unknown;
/** for set and clear: why */
"why"?: string;
}
/** is what config answers. */
export type ConfigAnswer = Record<string, unknown>;
/** is what renames takes. */
export interface RenamesInput {
/** one module (optional) */
"module"?: string;
}
export interface RenamesAnswerRenamesItem {
/** when it moved, RFC 3339 */
"at"?: string;
/** the old name */
"from": string;
/** the module */
"module": string;
/** the nodes still holding the old name open */
"open"?: string[];
/** the new name */
"to": string;
}
/** is what renames answers. */
export interface RenamesAnswer {
/** every open rename */
"renames": RenamesAnswerRenamesItem[];
}
/** is the body of the holder's event renamed. */
export interface RenamedHolderEvent {
/** when, RFC 3339 */
"at": string;
/** the old name */
"from": string;
/** the module */
"module": string;
/** the new name */
"to": string;
}
/** is the body of the holder's event retiring. */
export interface RetiringHolderEvent {
/** the ask's id */
"ask"?: string;
/** the value's or secret's name */
"key": string;
"kind": "value" | "secret";
/** the module */
"module": string;
/** since when, RFC 3339 */
"since": string;
}
/** is the body of the holder's event retired. */
export interface RetiredHolderEvent {
/** the ask's id */
"ask"?: string;
/** the module */
"module": string;
/** the name */
"name": string;
/** the node */
"node"?: string;
}
/** is one value of the state resolved under the key <node>.<module>.<key>. */
export interface ResolvedByNodeModuleKeyValue {
"key": string;
"module": string;
"node": string;
/** the predefined key the value falls back to */
"predefined"?: string;
/** an unset value is the operator's own to set */
"required"?: boolean;
"source": string;
"trusted"?: boolean;
"value"?: unknown;
}
/** is one value of the state kept under the key <owner>.<repository>.<number>.<node>.<module>.<key>. */
export interface KeptByOwnerRepositoryNumberNodeModuleKeyValue {
/** who approved it, as the proposal kept it */
"approved"?: string;
/** when it was kept */
"at"?: string;
"by"?: string;
/** the digest of what the declaration holds the value to; the value stays only while it is the same */
"declaration": string;
/** the head the declaration was read at */
"head": string;
/** the config key */
"key": string;
"module": string;
"node": string;
/** the proposal's id */
"proposal"?: string;
/** the pull request, owner/repository#number */
"pull": string;
/** the value held, as the operator approved it */
"value": unknown;
/** where the value was proposed from */
"via"?: string;
"why"?: string;
}