File size: 4,253 Bytes
4e23b01 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 | import { z } from 'zod';
import { wsOperations, type WsOperationDefinition } from './ws-control';
const ASYNCAPI_VERSION = '3.1.0';
const DEFAULT_TITLE = 'Kimi Code WebSocket API';
const DEFAULT_VERSION = '0.1.0';
const DEFAULT_SERVER_HOST = 'localhost';
const DEFAULT_WS_PATH = '/api/v1/ws';
const CHANNEL_ID = 'kimiCodeWebSocket';
const ASYNCAPI_OPERATIONS: readonly WsOperationDefinition[] = wsOperations;
export interface AsyncApiDocumentOptions {
readonly title?: string;
readonly version?: string;
readonly serverHost?: string;
readonly serverProtocol?: 'ws' | 'wss';
readonly wsPath?: string;
}
export function createAsyncApiDocument(
options: AsyncApiDocumentOptions = {},
): Record<string, unknown> {
const title = options.title ?? DEFAULT_TITLE;
const version = options.version ?? DEFAULT_VERSION;
const serverHost = options.serverHost ?? DEFAULT_SERVER_HOST;
const serverProtocol = options.serverProtocol ?? 'ws';
const wsPath = options.wsPath ?? DEFAULT_WS_PATH;
const messages = buildMessages();
const channelMessages = Object.fromEntries(
Object.keys(messages).map((id) => [id, { $ref: `#/components/messages/${id}` }]),
);
return {
asyncapi: ASYNCAPI_VERSION,
info: {
title,
version,
description:
'WebSocket protocol for Kimi Code daemon control frames, acknowledgements, system frames, and session event streaming.',
},
defaultContentType: 'application/json',
servers: {
local: {
host: serverHost,
protocol: serverProtocol,
pathname: wsPath,
description: 'Kimi Code daemon WebSocket endpoint.',
},
},
channels: {
[CHANNEL_ID]: {
address: wsPath,
servers: [{ $ref: '#/servers/local' }],
messages: channelMessages,
},
},
operations: {
receiveClientMessages: {
action: 'receive',
channel: { $ref: `#/channels/${CHANNEL_ID}` },
messages: operationMessageRefs('client_to_server'),
},
sendServerMessages: {
action: 'send',
channel: { $ref: `#/channels/${CHANNEL_ID}` },
messages: [
...operationMessageRefs('server_to_client'),
...ackMessageRefs(),
],
},
},
components: {
messages,
},
};
}
function buildMessages(): Record<string, unknown> {
const messages: Record<string, unknown> = {};
for (const operation of ASYNCAPI_OPERATIONS) {
const id = messageId(operation.type);
messages[id] = asyncApiMessage(operation.type, operation.description, operation.messageSchema);
if (operation.ackSchema !== undefined) {
const ackId = `${id}_ack`;
messages[ackId] = asyncApiMessage(
`${operation.type}.ack`,
`Acknowledgement for ${operation.type}.`,
operation.ackSchema,
);
}
}
return messages;
}
function operationMessageRefs(
direction: WsOperationDefinition['direction'],
): Array<{ $ref: string }> {
return ASYNCAPI_OPERATIONS
.filter((operation) => operation.direction === direction)
.map((operation) => ({ $ref: `#/components/messages/${messageId(operation.type)}` }));
}
function ackMessageRefs(): Array<{ $ref: string }> {
return ASYNCAPI_OPERATIONS
.filter((operation) => operation.ackSchema !== undefined)
.map((operation) => ({ $ref: `#/components/messages/${messageId(operation.type)}_ack` }));
}
function asyncApiMessage(
name: string,
summary: string,
schema: z.ZodTypeAny,
): Record<string, unknown> {
return {
name,
title: titleFromName(name),
summary,
contentType: 'application/json',
payload: jsonSchema(schema),
};
}
function jsonSchema(schema: z.ZodTypeAny): Record<string, unknown> {
const converted = z.toJSONSchema(schema, {
target: 'draft-7',
io: 'input',
unrepresentable: 'any',
}) as Record<string, unknown>;
delete converted['$schema'];
return converted;
}
function messageId(type: string): string {
return type.replace(/[^A-Za-z0-9]+/g, '_').replace(/^_+|_+$/g, '');
}
function titleFromName(name: string): string {
return name
.split(/[^A-Za-z0-9]+/)
.filter((part) => part.length > 0)
.map((part) => `${part[0]!.toUpperCase()}${part.slice(1)}`)
.join(' ');
}
|