@serviceme/devtools-protocol 0.0.3

package/dist/index.d.ts

@@ -0,0 +1,358 @@
+type ServicemeErrorCode = "protocol_mismatch" | "cli_not_found" | "cli_start_failed" | "command_timeout" | "request_cancelled" | "invalid_params" | "opencode_not_installed" | "opencode_startup_timeout" | "opencode_request_failed" | "opencode_backend_not_running" | "opencode_session_not_found" | "json_invalid_input" | "env_tool_not_found" | "internal_error";
+declare const SERVICEME_ERROR_CODES: readonly ["protocol_mismatch", "cli_not_found", "cli_start_failed", "command_timeout", "request_cancelled", "invalid_params", "opencode_not_installed", "opencode_startup_timeout", "opencode_request_failed", "opencode_backend_not_running", "opencode_session_not_found", "json_invalid_input", "env_tool_not_found", "internal_error"];
+interface ServicemeErrorDetails {
+    code: ServicemeErrorCode;
+    message: string;
+    retryable: boolean;
+    details?: unknown;
+}
+declare function isServicemeErrorCode(value: unknown): value is ServicemeErrorCode;
+declare function isServicemeErrorDetails(value: unknown): value is ServicemeErrorDetails;
+declare function isRetryableErrorCode(code: ServicemeErrorCode): boolean;
+declare class ServicemeProtocolError extends Error {
+    readonly code: ServicemeErrorCode;
+    readonly retryable: boolean;
+    readonly details?: unknown;
+    constructor(input: {
+        code: ServicemeErrorCode;
+        message: string;
+        retryable?: boolean;
+        details?: unknown;
+    });
+    toJSON(): ServicemeErrorDetails;
+}
+declare function createServicemeError(code: ServicemeErrorCode, message: string, details?: unknown): ServicemeProtocolError;
+declare function normalizeServicemeError(error: unknown, fallbackCode?: ServicemeErrorCode): ServicemeErrorDetails;
+
+type AgentSessionStatus = "idle" | "running" | "needs-input" | "completed" | "failed" | "aborted";
+interface OpenCodeRuntimeOptions {
+    workspaceRoot?: string;
+    startupTimeoutMs?: number;
+}
+interface OpenCodeServerState {
+    available: boolean;
+    running: boolean;
+    healthy: boolean;
+    installUrl: string;
+    pid?: number;
+    port?: number;
+}
+interface OpenCodeSessionStatusEvent {
+    type: "status";
+    status: AgentSessionStatus;
+    metadata?: Record<string, unknown>;
+}
+interface OpenCodeSessionProgressEvent {
+    type: "progress";
+    text: string;
+    metadata?: Record<string, unknown>;
+}
+interface OpenCodeSessionMessageEvent {
+    type: "message";
+    text: string;
+    metadata?: Record<string, unknown>;
+}
+interface OpenCodeSessionErrorEvent {
+    type: "error";
+    text: string;
+    metadata?: Record<string, unknown>;
+}
+interface OpenCodeSessionCompletedEvent {
+    type: "completed";
+    metadata?: Record<string, unknown>;
+}
+type OpenCodeAgentEvent = OpenCodeSessionStatusEvent | OpenCodeSessionProgressEvent | OpenCodeSessionMessageEvent | OpenCodeSessionErrorEvent | OpenCodeSessionCompletedEvent;
+declare function isAgentSessionStatus(value: unknown): value is AgentSessionStatus;
+declare function isOpenCodeServerState(value: unknown): value is OpenCodeServerState;
+declare function isOpenCodeSessionStatusEvent(value: unknown): value is OpenCodeSessionStatusEvent;
+declare function isOpenCodeSessionProgressEvent(value: unknown): value is OpenCodeSessionProgressEvent;
+declare function isOpenCodeSessionMessageEvent(value: unknown): value is OpenCodeSessionMessageEvent;
+declare function isOpenCodeSessionErrorEvent(value: unknown): value is OpenCodeSessionErrorEvent;
+declare function isOpenCodeSessionCompletedEvent(value: unknown): value is OpenCodeSessionCompletedEvent;
+declare function isOpenCodeAgentEvent(value: unknown): value is OpenCodeAgentEvent;
+
+declare const SERVICEME_PROTOCOL_VERSION: 1;
+interface BridgeCapabilities {
+    bridge: true;
+    opencode: 1;
+    json: 1;
+    env: 1;
+}
+declare function isBridgeCapabilities(value: unknown): value is BridgeCapabilities;
+interface BridgeMethodMap {
+    "system.hello": {
+        params: {
+            clientName: string;
+            clientVersion: string;
+            wantedCapabilities?: string[];
+        };
+        result: {
+            cliVersion: string;
+            protocolVersion: typeof SERVICEME_PROTOCOL_VERSION;
+            capabilities: BridgeCapabilities;
+            pid: number;
+        };
+    };
+    "system.ping": {
+        params: Record<string, never>;
+        result: {
+            now: string;
+        };
+    };
+    "system.shutdown": {
+        params: Record<string, never>;
+        result: {
+            shuttingDown: true;
+        };
+    };
+    "opencode.server.ensure": {
+        params: OpenCodeRuntimeOptions;
+        result: OpenCodeServerState;
+    };
+    "opencode.server.status": {
+        params: OpenCodeRuntimeOptions;
+        result: OpenCodeServerState;
+    };
+    "opencode.session.create": {
+        params: {
+            chatSessionId: string;
+            workspaceRoot?: string;
+            runtime?: OpenCodeRuntimeOptions;
+        };
+        result: {
+            sessionId: string;
+            title?: string;
+            status: AgentSessionStatus;
+        };
+    };
+    "opencode.session.prompt": {
+        params: {
+            sessionId: string;
+            promptId: string;
+            prompt: string;
+            workspaceRoot?: string;
+            runtime?: OpenCodeRuntimeOptions;
+        };
+        result: {
+            accepted: true;
+            sessionId: string;
+            promptId: string;
+        };
+    };
+    "opencode.session.status": {
+        params: {
+            sessionId: string;
+            workspaceRoot?: string;
+        };
+        result: {
+            sessionId: string;
+            status: AgentSessionStatus;
+        };
+    };
+    "opencode.session.abort": {
+        params: {
+            sessionId: string;
+            workspaceRoot?: string;
+        };
+        result: {
+            aborted: true;
+            sessionId: string;
+        };
+    };
+    "opencode.session.dispose": {
+        params: {
+            sessionId: string;
+        };
+        result: {
+            disposed: true;
+            sessionId: string;
+        };
+    };
+}
+declare const BRIDGE_METHODS: readonly ["system.hello", "system.ping", "system.shutdown", "opencode.server.ensure", "opencode.server.status", "opencode.session.create", "opencode.session.prompt", "opencode.session.status", "opencode.session.abort", "opencode.session.dispose"];
+type BridgeMethod = keyof BridgeMethodMap;
+type BridgeParams<M extends BridgeMethod> = BridgeMethodMap[M]["params"];
+type BridgeResult<M extends BridgeMethod> = BridgeMethodMap[M]["result"];
+interface BridgeEventMap {
+    "opencode.session.event": {
+        sessionId: string;
+        promptId?: string;
+        payload: OpenCodeAgentEvent;
+    };
+}
+declare const BRIDGE_EVENTS: readonly ["opencode.session.event"];
+type BridgeEventName = keyof BridgeEventMap;
+type BridgeEventParams<E extends BridgeEventName> = BridgeEventMap[E];
+interface BridgeRequest<M extends BridgeMethod = BridgeMethod> {
+    protocolVersion: typeof SERVICEME_PROTOCOL_VERSION;
+    kind: "request";
+    id: string;
+    method: M;
+    params: BridgeParams<M>;
+}
+interface BridgeSuccessResponse<M extends BridgeMethod = BridgeMethod> {
+    protocolVersion: typeof SERVICEME_PROTOCOL_VERSION;
+    kind: "response";
+    id: string;
+    ok: true;
+    result: BridgeResult<M>;
+}
+interface BridgeErrorResponse {
+    protocolVersion: typeof SERVICEME_PROTOCOL_VERSION;
+    kind: "response";
+    id: string;
+    ok: false;
+    error: ServicemeErrorDetails;
+}
+type BridgeResponse<M extends BridgeMethod = BridgeMethod> = BridgeSuccessResponse<M> | BridgeErrorResponse;
+interface BridgeEvent<E extends BridgeEventName = BridgeEventName> {
+    protocolVersion: typeof SERVICEME_PROTOCOL_VERSION;
+    kind: "event";
+    event: E;
+    params: BridgeEventParams<E>;
+}
+type BridgeMessage = BridgeRequest | BridgeResponse | BridgeEvent;
+declare function isSystemHelloResult(value: unknown): value is BridgeResult<"system.hello">;
+declare function isSystemPingResult(value: unknown): value is BridgeResult<"system.ping">;
+declare function isSystemShutdownResult(value: unknown): value is BridgeResult<"system.shutdown">;
+declare function isOpenCodeSessionCreateResult(value: unknown): value is BridgeResult<"opencode.session.create">;
+declare function isOpenCodeSessionPromptResult(value: unknown): value is BridgeResult<"opencode.session.prompt">;
+declare function isOpenCodeSessionStatusResult(value: unknown): value is BridgeResult<"opencode.session.status">;
+declare function isOpenCodeSessionAbortResult(value: unknown): value is BridgeResult<"opencode.session.abort">;
+declare function isOpenCodeSessionDisposeResult(value: unknown): value is BridgeResult<"opencode.session.dispose">;
+declare function getBridgeResultValidator(method: BridgeMethod): ((value: unknown) => boolean) | undefined;
+declare function isOpenCodeSessionEventParams(value: unknown): value is BridgeEventParams<"opencode.session.event">;
+declare function getBridgeEventParamsValidator(event: BridgeEventName): ((value: unknown) => boolean) | undefined;
+declare function isBridgeMethod(value: unknown): value is BridgeMethod;
+declare function isBridgeEventName(value: unknown): value is BridgeEventName;
+declare function isBridgeRequest(value: unknown): value is BridgeRequest;
+declare function isBridgeResponse(value: unknown): value is BridgeResponse;
+declare function isBridgeEvent(value: unknown): value is BridgeEvent;
+
+declare const SERVICEME_CLI_SCHEMA_VERSION: 1;
+interface CliSuccess<T> {
+    schemaVersion: typeof SERVICEME_CLI_SCHEMA_VERSION;
+    ok: true;
+    data: T;
+}
+interface CliFailure {
+    schemaVersion: typeof SERVICEME_CLI_SCHEMA_VERSION;
+    ok: false;
+    error: ServicemeErrorDetails;
+}
+type CliEnvelope<T> = CliSuccess<T> | CliFailure;
+declare function createCliSuccess<T>(data: T): CliSuccess<T>;
+declare function createCliFailure(error: ServicemeErrorDetails): CliFailure;
+declare function isCliEnvelope(value: unknown): value is CliEnvelope<unknown>;
+
+declare const KNOWN_ENVIRONMENT_TOOLS: readonly ["git", "node", "npm", "pnpm", "nvm", "nrm", "dotnet", "nuget"];
+type KnownEnvironmentTool = (typeof KNOWN_ENVIRONMENT_TOOLS)[number];
+interface ToolCheckResult {
+    installed: boolean;
+    version?: string;
+    path?: string;
+    error?: string;
+}
+type EnvironmentCheckResult = Record<KnownEnvironmentTool, ToolCheckResult>;
+declare function isKnownEnvironmentTool(value: string): value is KnownEnvironmentTool;
+declare function isToolCheckResult(value: unknown): value is ToolCheckResult;
+declare function isEnvironmentCheckResult(value: unknown): value is EnvironmentCheckResult;
+
+type ServiceMeImageFormat = "jpeg" | "png" | "webp";
+declare const SERVICEME_IMAGE_FORMATS: readonly ["jpeg", "png", "webp"];
+interface ServiceMeImageCompressOptions {
+    quality: number;
+    replaceOriginImage: boolean;
+    outputPath?: string;
+    format?: ServiceMeImageFormat;
+    sharpModulePath?: string;
+    minimumCompressionRatio?: number;
+}
+interface ServiceMeImageCompressResult {
+    originalSize: number;
+    compressedSize: number;
+    compressionRatio: number;
+    outputPath: string;
+}
+interface ServiceMeImageInfo {
+    width: number;
+    height: number;
+    format: string;
+    size: number;
+    colorSpace?: string;
+}
+interface ServiceMeImageValidationResult {
+    valid: boolean;
+}
+declare function isServiceMeImageFormat(value: unknown): value is ServiceMeImageFormat;
+declare function isServiceMeImageCompressOptions(value: unknown): value is ServiceMeImageCompressOptions;
+declare function isServiceMeImageCompressResult(value: unknown): value is ServiceMeImageCompressResult;
+declare function isServiceMeImageInfo(value: unknown): value is ServiceMeImageInfo;
+declare function isServiceMeImageValidationResult(value: unknown): value is ServiceMeImageValidationResult;
+
+type JsonSortAlgorithm = "default" | "keyLength" | "alphaNum" | "values" | "type";
+type JsonSortOrder = "asc" | "desc";
+declare const JSON_SORT_ALGORITHMS: readonly ["default", "keyLength", "alphaNum", "values", "type"];
+declare const JSON_SORT_ORDERS: readonly ["asc", "desc"];
+interface JsonSortOptions {
+    sortOrder: JsonSortOrder;
+    sortAlgo: JsonSortAlgorithm;
+}
+interface JsonValidationResult {
+    valid: boolean;
+    error?: string;
+}
+declare const DEFAULT_JSON_SORT_OPTIONS: JsonSortOptions;
+declare function isJsonSortAlgorithm(value: unknown): value is JsonSortAlgorithm;
+declare function isJsonSortOrder(value: unknown): value is JsonSortOrder;
+declare function isJsonSortOptions(value: unknown): value is JsonSortOptions;
+declare function isJsonValidationResult(value: unknown): value is JsonValidationResult;
+declare function isJsonOutputResult(value: unknown): value is {
+    output: string;
+};
+
+declare const SERVICEME_CLI_NAME = "serviceme";
+declare const SERVICEME_CLI_VERSION = "0.0.1";
+declare const SERVICEME_CLI_CAPABILITIES: {
+    readonly bridge: true;
+    readonly opencode: 1;
+    readonly json: 1;
+    readonly env: 1;
+    readonly image: 1;
+    readonly project: 1;
+};
+
+interface ServiceMeProjectScaffoldPruneResult {
+    applied: boolean;
+    preset: string;
+    commands: string[];
+}
+interface ServiceMeProjectGitInitResult {
+    initialized: boolean;
+    command: string;
+}
+interface ServiceMeProjectMakeScriptsExecutableResult {
+    processedCount: number;
+    updatedCount: number;
+    platform: NodeJS.Platform;
+    scripts: string[];
+}
+interface ServiceMeProjectInstallDepsResult {
+    installed: boolean;
+    command: string;
+}
+interface ServiceMeProjectExtractTemplateInput {
+    extractedDirName: string;
+    projectFilePattern: string;
+}
+interface ServiceMeProjectExtractTemplateResult {
+    actualDirName: string;
+}
+declare function isServiceMeProjectScaffoldPruneResult(value: unknown): value is ServiceMeProjectScaffoldPruneResult;
+declare function isServiceMeProjectGitInitResult(value: unknown): value is ServiceMeProjectGitInitResult;
+declare function isServiceMeProjectMakeScriptsExecutableResult(value: unknown): value is ServiceMeProjectMakeScriptsExecutableResult;
+declare function isServiceMeProjectInstallDepsResult(value: unknown): value is ServiceMeProjectInstallDepsResult;
+declare function isServiceMeProjectExtractTemplateInput(value: unknown): value is ServiceMeProjectExtractTemplateInput;
+declare function isServiceMeProjectExtractTemplateResult(value: unknown): value is ServiceMeProjectExtractTemplateResult;
+
+export { type AgentSessionStatus, BRIDGE_EVENTS, BRIDGE_METHODS, type BridgeCapabilities, type BridgeErrorResponse, type BridgeEvent, type BridgeEventMap, type BridgeEventName, type BridgeEventParams, type BridgeMessage, type BridgeMethod, type BridgeMethodMap, type BridgeParams, type BridgeRequest, type BridgeResponse, type BridgeResult, type BridgeSuccessResponse, type CliEnvelope, type CliFailure, type CliSuccess, DEFAULT_JSON_SORT_OPTIONS, type EnvironmentCheckResult, JSON_SORT_ALGORITHMS, JSON_SORT_ORDERS, type JsonSortAlgorithm, type JsonSortOptions, type JsonSortOrder, type JsonValidationResult, KNOWN_ENVIRONMENT_TOOLS, type KnownEnvironmentTool, type OpenCodeAgentEvent, type OpenCodeRuntimeOptions, type OpenCodeServerState, type OpenCodeSessionCompletedEvent, type OpenCodeSessionErrorEvent, type OpenCodeSessionMessageEvent, type OpenCodeSessionProgressEvent, type OpenCodeSessionStatusEvent, SERVICEME_CLI_CAPABILITIES, SERVICEME_CLI_NAME, SERVICEME_CLI_SCHEMA_VERSION, SERVICEME_CLI_VERSION, SERVICEME_ERROR_CODES, SERVICEME_IMAGE_FORMATS, SERVICEME_PROTOCOL_VERSION, type ServiceMeImageCompressOptions, type ServiceMeImageCompressResult, type ServiceMeImageFormat, type ServiceMeImageInfo, type ServiceMeImageValidationResult, type ServiceMeProjectExtractTemplateInput, type ServiceMeProjectExtractTemplateResult, type ServiceMeProjectGitInitResult, type ServiceMeProjectInstallDepsResult, type ServiceMeProjectMakeScriptsExecutableResult, type ServiceMeProjectScaffoldPruneResult, type ServicemeErrorCode, type ServicemeErrorDetails, ServicemeProtocolError, type ToolCheckResult, createCliFailure, createCliSuccess, createServicemeError, getBridgeEventParamsValidator, getBridgeResultValidator, isAgentSessionStatus, isBridgeCapabilities, isBridgeEvent, isBridgeEventName, isBridgeMethod, isBridgeRequest, isBridgeResponse, isCliEnvelope, isEnvironmentCheckResult, isJsonOutputResult, isJsonSortAlgorithm, isJsonSortOptions, isJsonSortOrder, isJsonValidationResult, isKnownEnvironmentTool, isOpenCodeAgentEvent, isOpenCodeServerState, isOpenCodeSessionAbortResult, isOpenCodeSessionCompletedEvent, isOpenCodeSessionCreateResult, isOpenCodeSessionDisposeResult, isOpenCodeSessionErrorEvent, isOpenCodeSessionEventParams, isOpenCodeSessionMessageEvent, isOpenCodeSessionProgressEvent, isOpenCodeSessionPromptResult, isOpenCodeSessionStatusEvent, isOpenCodeSessionStatusResult, isRetryableErrorCode, isServiceMeImageCompressOptions, isServiceMeImageCompressResult, isServiceMeImageFormat, isServiceMeImageInfo, isServiceMeImageValidationResult, isServiceMeProjectExtractTemplateInput, isServiceMeProjectExtractTemplateResult, isServiceMeProjectGitInitResult, isServiceMeProjectInstallDepsResult, isServiceMeProjectMakeScriptsExecutableResult, isServiceMeProjectScaffoldPruneResult, isServicemeErrorCode, isServicemeErrorDetails, isSystemHelloResult, isSystemPingResult, isSystemShutdownResult, isToolCheckResult, normalizeServicemeError };