Variable: ClientSchemas

Makaio Framework

---

Makaio Framework / contracts/client / ClientSchemas

Variable: ClientSchemas

const ClientSchemas: object

Defined in: ../../../packages/contracts/src/client/schemas.ts:54

Client namespace schemas.

Type Declaration

account.observe

account.observe: object = ClientAccountObserveSchema

account.observe.request

request: ZodObject<{ clientId: ZodString; displayLabel: ZodOptional<ZodString>; identifiers: ZodArray<ZodObject<{ scheme: ZodString; strength: ZodEnum<{ alias: "alias"; strong: "strong"; }>; value: ZodString; }, $strip>>; metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; observedAt: ZodOptional<ZodNumber>; }, $strip>

account.observe.response

response: ZodObject<{ clientAccountId: ZodString; displayLabel: ZodOptional<ZodString>; }, $strip>

install

install: object = ClientInstallSchema

install.request

request: ZodObject<{ clientId: ZodString; version: ZodOptional<ZodString>; }, $strip>

install.response

response: ZodObject<{ jobId: ZodString; requestedVersion: ZodNullable<ZodString>; resolvedVersion: ZodNullable<ZodString>; }, $strip>

installJob.completed

installJob.completed: ZodObject<{ activeVersion: ZodNullable<ZodString>; clientId: ZodString; error: ZodOptional<ZodObject<{ code: ZodOptional<ZodString>; message: ZodString; }, $strip>>; installPath: ZodOptional<ZodString>; jobId: ZodString; metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; status: ZodEnum<{ error: "error"; success: "success"; }>; strategy: ZodEnum<{ github-release: "github-release"; manifest-bucket: "manifest-bucket"; npm: "npm"; }>; version: ZodOptional<ZodString>; }, $strip> = ClientInstallCompletedSchema

installJob.progress

installJob.progress: ZodObject<{ activeAfterCompletion: ZodOptional<ZodBoolean>; clientId: ZodString; installPath: ZodOptional<ZodString>; jobId: ZodString; metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; progress: ZodNullable<ZodNumber>; stage: ZodEnum<{ activating: "activating"; downloading: "downloading"; extracting: "extracting"; installing: "installing"; post-install: "post-install"; resolving: "resolving"; verifying: "verifying"; }>; strategy: ZodEnum<{ github-release: "github-release"; manifest-bucket: "manifest-bucket"; npm: "npm"; }>; version: ZodOptional<ZodString>; }, $strip> = ClientInstallProgressSchema

list

list: object = ClientListSchema

list.request

request: ZodObject<{ forceRefresh: ZodOptional<ZodBoolean>; }, $strip>

list.response

response: ZodObject<{ clients: ZodArray<ZodObject<{ activeVersion: ZodNullable<ZodString>; clientId: ZodString; installedVersions: ZodArray<ZodObject<{ installedAt: ZodNumber; installPath: ZodString; isActive: ZodBoolean; version: ZodString; }, $strip>>; latestAvailableVersion: ZodNullable<ZodString>; latestVersionLastCheckedAt: ZodNullable<ZodNumber>; latestVersionSourceStatus: ZodEnum<{ cached: "cached"; error: "error"; fresh: "fresh"; }>; updateAvailable: ZodBoolean; }, $strip>>; }, $strip>

resolveBinary

resolveBinary: object = ClientResolveBinarySchema

resolveBinary.request

request: ZodObject<{ clientId: ZodString; harnessId: ZodOptional<ZodString>; preferSource: ZodOptional<ZodEnum<{ global: "global"; managed: "managed"; }>>; projectDir: ZodOptional<ZodString>; sessionId: ZodOptional<ZodString>; }, $strip>

resolveBinary.response

response: ZodObject<{ binaryPath: ZodNullable<ZodString>; configDir: ZodNullable<ZodString>; env: ZodRecord<ZodString, ZodString>; source: ZodEnum<{ global: "global"; managed: "managed"; }>; version: ZodNullable<ZodString>; }, $strip> = ClientExecutionContextSchema

runtime.observe

runtime.observe: object = ClientRuntimeObserveSchema

runtime.observe.request

request: ZodObject<{ adapterSessionId: ZodOptional<ZodString>; argv: ZodOptional<ZodArray<ZodString>>; clientId: ZodString; cwd: ZodOptional<ZodString>; metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; observedAt: ZodNumber; parentPid: ZodOptional<ZodNumber>; pid: ZodOptional<ZodNumber>; sessionId: ZodOptional<ZodString>; source: ZodObject<{ layer: ZodEnum<{ adapter: "adapter"; cli-wrapper: "cli-wrapper"; client-hook: "client-hook"; statusline: "statusline"; supervisor: "supervisor"; }>; producer: ZodString; }, $strip>; supervisorSessionId: ZodOptional<ZodString>; }, $strip>

runtime.observe.response

response: ZodObject<{ clientRuntimeId: ZodString; created: ZodBoolean; promoted: ZodBoolean; }, $strip>

runtime.started

runtime.started: ZodObject<{ adapterSessionId: ZodOptional<ZodString>; argv: ZodOptional<ZodArray<ZodString>>; clientId: ZodString; clientRuntimeId: ZodString; cwd: ZodOptional<ZodString>; metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; observedAt: ZodNumber; parentPid: ZodOptional<ZodNumber>; pid: ZodOptional<ZodNumber>; sessionId: ZodOptional<ZodString>; source: ZodObject<{ layer: ZodEnum<{ adapter: "adapter"; cli-wrapper: "cli-wrapper"; client-hook: "client-hook"; statusline: "statusline"; supervisor: "supervisor"; }>; producer: ZodString; }, $strip>; status: ZodEnum<{ observed: "observed"; started: "started"; }>; supervisorSessionId: ZodOptional<ZodString>; }, $strip> = ClientRuntimeStartedSchema

scan

scan: object

scan.request

request: ZodObject<{ targets: ZodOptional<ZodArray<ZodObject<{ binaryName: ZodString; clientId: ZodString; minimumVersion: ZodOptional<ZodString>; }, $strip>>>; }, $strip>

scan.response

response: ZodObject<{ results: ZodArray<ZodObject<{ clientId: ZodString; found: ZodBoolean; version: ZodOptional<ZodString>; warningMessage: ZodOptional<ZodString>; }, $strip>>; }, $strip>

session.account.observe

session.account.observe: object = ClientSessionAccountObserveSchema

session.account.observe.request

request: ZodObject<{ clientId: ZodString; kind: ZodString; locator: ZodDiscriminatedUnion<[ZodObject<{ kind: ZodLiteral<"session">; sessionId: ZodString; }, $strip>, ZodObject<{ adapterSessionId: ZodString; kind: ZodLiteral<"adapter-session">; }, $strip>, ZodObject<{ adapterSessionId: ZodString; kind: ZodLiteral<"both">; sessionId: ZodString; }, $strip>], "kind">; observedAt: ZodNumber; payload: ZodType<Record<string, unknown>, unknown, $ZodTypeInternals<Record<string, unknown>, unknown>>; source: ZodString; }, $strip>

session.account.observe.response

response: ZodObject<{ changed: ZodBoolean; clientAccountId: ZodNullable<ZodString>; handled: ZodBoolean; sessionId: ZodNullable<ZodString>; }, $strip>

session.started

session.started: ZodObject<{ adapterSessionId: ZodOptional<ZodString>; clientId: ZodString; metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; observedAt: ZodNumber; sessionId: ZodOptional<ZodString>; source: ZodString; }, $strip> = ClientSessionStartedSchema

session.tool.post

session.tool.post: ZodObject<{ adapterSessionId: ZodOptional<ZodString>; clientId: ZodString; metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; observedAt: ZodNumber; sessionId: ZodOptional<ZodString>; source: ZodString; success: ZodOptional<ZodBoolean>; toolCallId: ZodOptional<ZodString>; toolName: ZodOptional<ZodString>; }, $strip> = ClientSessionToolPostSchema

session.tool.pre

session.tool.pre: ZodObject<{ adapterSessionId: ZodOptional<ZodString>; clientId: ZodString; metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; observedAt: ZodNumber; sessionId: ZodOptional<ZodString>; source: ZodString; toolCallId: ZodOptional<ZodString>; toolName: ZodOptional<ZodString>; }, $strip> = ClientSessionToolPreSchema

session.turn.completed

session.turn.completed: ZodObject<{ adapterSessionId: ZodOptional<ZodString>; clientId: ZodString; metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; observedAt: ZodNumber; sessionId: ZodOptional<ZodString>; source: ZodString; }, $strip> = ClientSessionTurnCompletedSchema

session.turn.started

session.turn.started: ZodObject<{ adapterSessionId: ZodOptional<ZodString>; clientId: ZodString; metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; observedAt: ZodNumber; sessionId: ZodOptional<ZodString>; source: ZodString; }, $strip> = ClientSessionTurnStartedSchema

session.userPrompt.submitted

session.userPrompt.submitted: ZodObject<{ adapterSessionId: ZodOptional<ZodString>; clientId: ZodString; metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; observedAt: ZodNumber; prompt: ZodOptional<ZodString>; sessionId: ZodOptional<ZodString>; source: ZodString; }, $strip> = ClientSessionUserPromptSubmittedSchema

setActive

setActive: object = ClientSetActiveSchema

setActive.request

request: ZodObject<{ clientId: ZodString; version: ZodString; }, $strip>

setActive.response

response: ZodObject<{ activeVersion: ZodString; clientId: ZodString; }, $strip>

uninstall

uninstall: object = ClientUninstallSchema

uninstall.request

request: ZodObject<{ clientId: ZodString; version: ZodString; }, $strip>

uninstall.response

response: ZodObject<{ activeVersion: ZodNullable<ZodString>; clientId: ZodString; removedVersion: ZodString; }, $strip>

update

update: object = ClientUpdateSchema

update.request

request: ZodObject<{ clientId: ZodString; }, $strip>

update.response

response: ZodObject<{ jobId: ZodString; resolvedVersion: ZodNullable<ZodString>; }, $strip>

usage.ingest

usage.ingest: object = ClientUsageIngestSchema

usage.ingest.request

request: ZodObject<{ account: ZodObject<{ displayLabel: ZodOptional<ZodString>; identifiers: ZodArray<ZodObject<{ scheme: ZodString; strength: ZodEnum<{ alias: …; strong: …; }>; value: ZodString; }, $strip>>; }, $strip>; clientId: ZodString; metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; observedAt: ZodNumber; source: ZodString; usage: ZodObject<{ windows: ZodArray<ZodObject<{ key: ZodString; label: ZodString; resetsAt: ZodOptional<ZodNumber>; usedPercentage: ZodNumber; }, $strip>>; }, $strip>; }, $strip>

usage.ingest.response

response: ZodObject<{ clientAccountId: ZodString; snapshot: ZodObject<{ clientAccountId: ZodString; clientId: ZodString; displayLabel: ZodOptional<ZodString>; metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; observedAt: ZodNumber; source: ZodString; usage: ZodObject<{ windows: ZodArray<ZodObject<{ key: …; label: …; resetsAt: …; usedPercentage: …; }, $strip>>; }, $strip>; }, $strip>; }, $strip>

usage.snapshot

usage.snapshot: ZodObject<{ clientAccountId: ZodString; clientId: ZodString; displayLabel: ZodOptional<ZodString>; metadata: ZodOptional<ZodRecord<ZodString, ZodUnknown>>; observedAt: ZodNumber; source: ZodString; usage: ZodObject<{ windows: ZodArray<ZodObject<{ key: ZodString; label: ZodString; resetsAt: ZodOptional<ZodNumber>; usedPercentage: ZodNumber; }, $strip>>; }, $strip>; }, $strip> = ClientUsageSnapshotSchema

version.changed

version.changed: ZodObject<{ activeVersion: ZodNullable<ZodString>; clientId: ZodString; previousActiveVersion: ZodNullable<ZodString>; reason: ZodEnum<{ install: "install"; set-active: "set-active"; uninstall: "uninstall"; update: "update"; }>; }, $strip> = ClientVersionChangedSchema

wiring.list

wiring.list: object

wiring.list.request

request: ZodObject<{ clientId: ZodOptional<ZodString>; makaioCommand: ZodString; projectDir: ZodOptional<ZodString>; }, $strip>

wiring.list.response

response: ZodObject<{ results: ZodArray<ZodObject<{ clientId: ZodString; entries: ZodArray<ZodObject<{ command: ZodString; group: ZodString; installed: ZodBoolean; name: ZodString; }, $strip>>; }, $strip>>; }, $strip>