@svatah/yam-contract
The surface operation catalogue and the contract fingerprint every client agrees on
- Source:
packages/contract· README:packages/contract/README.md - Install:
npm install @svatah/yam-contract - Version 0.1.0 · Apache-2.0
Exports
| Export | Kind | Signature | |
|---|---|---|---|
actInputSchema | variable | actInputSchema = z.object( | |
actOutputSchema | variable | actOutputSchema = resultEnvelopeSchema.extend( | |
capabilitiesInputSchema | variable | capabilitiesInputSchema = z.object( | |
capabilitiesOutputSchema | variable | capabilitiesOutputSchema = resultEnvelopeSchema.extend( | |
catalogueFingerprint | function | export function catalogueFingerprint(): string | A fingerprint of the contract this build serves (T18, SF-03). |
checkInputSchema | variable | checkInputSchema = z.object( | |
checkOutputSchema | variable | checkOutputSchema = resultEnvelopeSchema.extend( | |
CLI_EXIT_CODES | variable | CLI_EXIT_CODES | |
CliFlag | interface | export interface CliFlag | |
closeInputSchema | variable | closeInputSchema = z.object( | |
closeOutputSchema | variable | closeOutputSchema = resultEnvelopeSchema.extend( | |
connectInputSchema | variable | connectInputSchema = z | What connect may be pointed at (SF-04, T18). |
connectOutputSchema | variable | connectOutputSchema = resultEnvelopeSchema.extend( | |
controlInputSchema | variable | controlInputSchema = z.object( | Take, release, or ask who holds a target (SF-13, T16). |
controlOutputSchema | variable | controlOutputSchema = resultEnvelopeSchema.extend( | |
describeInputSchema | variable | describeInputSchema = z.object( | |
describeOutputSchema | variable | describeOutputSchema = resultEnvelopeSchema.extend( | |
ERROR_CODES | variable | ERROR_CODES = [ | |
ErrorCode | typealias | export type ErrorCode = (typeof ERROR_CODES)[number]; | |
eventsInputSchema | variable | eventsInputSchema = z.object( | What a session did (T17, SF-19, SF-21). |
eventsOutputSchema | variable | eventsOutputSchema = resultEnvelopeSchema.extend( | |
operationByCliSubcommand | function | export function operationByCliSubcommand(sub: string): OperationDescriptor | undefined | |
operationByMcpTool | function | export function operationByMcpTool(toolName: string): OperationDescriptor | undefined | |
operationByName | function | export function operationByName(name: string): OperationDescriptor | undefined | |
operationByServicePath | function | export function operationByServicePath(method: string, path: string): OperationDescriptor | undefined | |
OperationDescriptor | interface | export interface OperationDescriptor | |
OPERATIONS | variable | OPERATIONS: readonly OperationDescriptor[] = [ | |
readInputSchema | variable | readInputSchema = z.object( | |
readOutputSchema | variable | readOutputSchema = resultEnvelopeSchema.extend( | |
requestInputSchema | variable | requestInputSchema = z.object( | An HTTP request, on a surface that is one (T15, SF-04). |
requestOutputSchema | variable | requestOutputSchema = resultEnvelopeSchema.extend( | |
ResultEnvelope | typealias | export type ResultEnvelope = z.infer<typeof resultEnvelopeSchema>; | |
resultEnvelopeSchema | variable | resultEnvelopeSchema = z.object( | |
screenshotInputSchema | variable | screenshotInputSchema = z.object( | |
screenshotOutputSchema | variable | screenshotOutputSchema = resultEnvelopeSchema.extend( | |
sessionsInputSchema | variable | sessionsInputSchema = z.object({}) | |
sessionsOutputSchema | variable | sessionsOutputSchema = resultEnvelopeSchema.extend( | |
snapshotInputSchema | variable | snapshotInputSchema = z.object( | |
snapshotOutputSchema | variable | snapshotOutputSchema = resultEnvelopeSchema.extend( | |
SURFACE_CLI_SUBCOMMANDS | variable | SURFACE_CLI_SUBCOMMANDS = OPERATIONS.map((op) => op.cli.subcommand) | |
SURFACE_TOOL_NAMES | variable | SURFACE_TOOL_NAMES = OPERATIONS.map((op) => op.mcp.toolName) | |
targetsInputSchema | variable | targetsInputSchema = z.object( | |
targetsOutputSchema | variable | targetsOutputSchema = resultEnvelopeSchema.extend( |