mirror of
https://github.com/openclaw/openclaw.git
synced 2026-07-10 22:56:09 +00:00
* feat(crestodian): AI-first conversational onboarding with typed-op guardrails Interactive `openclaw onboard` (and bare `openclaw` on a fresh install) now opens the Crestodian conversation: detection-backed first-run proposal (Claude Code/Codex logins, API keys), persona AI turns for every free-form message (configless local-runtime fallback, 60s deadline, deterministic degradation), approval-gated typed operations, chat-hosted channel setup (`connect <channel>`), config get/schema read ops with secret redaction, and a post-write validation hook that feeds schema errors back for a self-fix turn. Adds the additive gateway `crestodian.chat` method so app clients run the same conversation. Classic wizard stays behind --classic/explicit flags; non-interactive automation unchanged; `--modern` becomes a deprecated alias for `openclaw crestodian`. * feat(macos): Crestodian chat onboarding and importance-ordered permissions Replace the gateway step-wizard page with a Crestodian chat over the new crestodian.chat method (works before any model auth exists), sort the permissions page by importance with no scrolling, drop the redundant manual refresh, and bump the onboarding version. * feat(crestodian): run the custodian on the real agent loop with a ring-zero tool Crestodian conversations now execute through the same embedded agent runner as regular agents: a persistent agent session with a single construction-gated `crestodian` tool wrapping the typed operations (read actions free; mutations require approved=true asserted from explicit user consent, audited, with post-write config validation fed back into the loop). The engine prefers the loop (configured models or the Codex app-server fallback) and degrades to the single-turn planner, then to deterministic commands. Setup approval seeds the crestodian exec approval so local model harnesses can run; the configless Codex backend config now enables exec and direct tool loading (it was dead-on-arrival behind tools.exec.mode=deny and the tool-search index). * test(crestodian): type the engine mock signatures for the core test lane * fix(crestodian): map the advertised create_agent tool action * fix(crestodian): host-verified approval arming and a macOS setup completion gate Review findings: the model-supplied approved flag alone could authorize ring-zero mutations (prompt injection / model error), and removing the macOS wizard gate let users Next past the Crestodian page with nothing configured. Mutating tool actions now also require host-verified consent (the engine arms approval only when the user's actual message is an explicit yes), and local macOS onboarding blocks advancing until setup authored the config, using the same signal the old step wizard checked. * fix(crestodian): bind approval to the exact proposed operation and gate dot navigation A generic yes no longer authorizes arbitrary mutations: denied mutating tool calls register a canonical operation fingerprint (host-owned, per session), and an armed turn executes only the identical call, once. The denial message is arming-aware so the approved turn self-heals in one roundtrip, and the agent protocol pre-registers proposals. macOS onboarding page dots now honor the same setup-completion gate as the Next button. * fix(crestodian): redact sensitive wizard answers, skip logged-out CLIs, gate programmatic advance Sensitive channel-wizard answers (tokens, passwords) are redacted from the AI-visible conversation history; setup and the onboarding welcome never pick or advertise a definitively logged-out CLI as the model; and macOS handleNext() honors the page gates for programmatic callers (chat handoff) just like the Next button. * fix(crestodian): align the onboarding welcome's configured predicate with the app gate A valid config carrying only a default model (partial/hand-written) now still gets the first-run proposal instead of the ready guide, so the macOS setup gate can always be satisfied from the conversation. * fix(crestodian): armed turns can never mint their own executable proposal An approval-mismatched call inside an armed turn no longer re-registers and invites a retry (which let the model swap the approved operation for another in the same turn); it voids the approval entirely and requires a fresh yes. Proposals register only in unarmed turns, which the agent protocol already does when proposing. * fix(onboard): route any explicit setup flag to the classic wizard * fix(ci): satisfy new lint rules, tool-display guard, and generated artifacts for crestodian * chore(i18n): refresh native inventory after permissions copy wrap * fix(crestodian): harden conversational onboarding * docs(crestodian): document conversational onboarding * test(crestodian): type embedded runner mock * fix(crestodian): close onboarding security gaps * chore: retrigger ci
769 lines
25 KiB
TypeScript
769 lines
25 KiB
TypeScript
// Protocol Gen Swift script supports OpenClaw repository automation.
|
|
import { promises as fs } from "node:fs";
|
|
import path from "node:path";
|
|
import { fileURLToPath } from "node:url";
|
|
import {
|
|
ErrorCodes,
|
|
MIN_CLIENT_PROTOCOL_VERSION,
|
|
PROTOCOL_VERSION,
|
|
ProtocolSchemas,
|
|
} from "../packages/gateway-protocol/src/schema.js";
|
|
|
|
type JsonSchema = {
|
|
type?: string | string[];
|
|
const?: boolean | number | string | null;
|
|
properties?: Record<string, JsonSchema>;
|
|
required?: string[];
|
|
items?: JsonSchema;
|
|
enum?: string[];
|
|
patternProperties?: Record<string, JsonSchema>;
|
|
anyOf?: JsonSchema[];
|
|
oneOf?: JsonSchema[];
|
|
additionalProperties?: boolean | JsonSchema;
|
|
};
|
|
|
|
const scriptDir = path.dirname(fileURLToPath(import.meta.url));
|
|
const repoRoot = path.resolve(scriptDir, "..");
|
|
const outPaths = [
|
|
path.join(
|
|
repoRoot,
|
|
"apps",
|
|
"shared",
|
|
"OpenClawKit",
|
|
"Sources",
|
|
"OpenClawProtocol",
|
|
"GatewayModels.swift",
|
|
),
|
|
];
|
|
|
|
const STRICT_LITERAL_STRUCTS = new Set([
|
|
"PluginsSessionActionSuccessResult",
|
|
"PluginsSessionActionFailureResult",
|
|
]);
|
|
|
|
const DEFAULTED_OPTIONAL_INIT_PARAM_ENTRIES: readonly [string, readonly string[]][] = [
|
|
["CrestodianChatResult", ["sensitive"]],
|
|
["SendParams", ["buffer", "filename", "contentType"]],
|
|
["SessionOperationEvent", ["agentId"]],
|
|
["SessionsCompactionListParams", ["agentId"]],
|
|
["SessionsCompactionGetParams", ["agentId"]],
|
|
["SessionsCompactionBranchParams", ["agentId"]],
|
|
["SessionsCompactionRestoreParams", ["agentId"]],
|
|
["SessionsSendParams", ["agentId"]],
|
|
["SessionsMessagesSubscribeParams", ["agentId"]],
|
|
["SessionsMessagesUnsubscribeParams", ["agentId"]],
|
|
["SessionsAbortParams", ["agentId"]],
|
|
["SessionsListParams", ["archived"]],
|
|
["SessionsPatchParams", ["agentId", "archived", "pinned"]],
|
|
["SessionsResetParams", ["agentId"]],
|
|
[
|
|
"SessionsDeleteParams",
|
|
["agentId", "expectedSessionId", "expectedLifecycleRevision", "expectedSessionUpdatedAt"],
|
|
],
|
|
["SessionsCompactParams", ["agentId"]],
|
|
["SessionsResolveParams", ["allowMissing"]],
|
|
["SessionsUsageParams", ["agentId", "agentScope"]],
|
|
["ChatHistoryParams", ["agentId", "offset"]],
|
|
["ChatSendParams", ["agentId"]],
|
|
["ChatAbortParams", ["agentId", "preserveSideRuns"]],
|
|
["ChatInjectParams", ["agentId"]],
|
|
["ChatDeltaEvent", ["agentId"]],
|
|
["ChatFinalEvent", ["agentId"]],
|
|
["ChatAbortedEvent", ["agentId"]],
|
|
["ChatErrorEvent", ["agentId"]],
|
|
["ArtifactsListParams", ["agentId"]],
|
|
["ArtifactsGetParams", ["agentId"]],
|
|
["ArtifactsDownloadParams", ["agentId"]],
|
|
["ChatAbortParams", ["agentId", "preserveSideRuns"]],
|
|
["ChatAbortedEvent", ["agentId"]],
|
|
["ChatDeltaEvent", ["agentId"]],
|
|
["ChatErrorEvent", ["agentId"]],
|
|
["ChatFinalEvent", ["agentId"]],
|
|
["ChatHistoryParams", ["agentId", "offset"]],
|
|
["ChatInjectParams", ["agentId"]],
|
|
["ChatSendParams", ["agentId"]],
|
|
["MessageActionParams", ["inboundTurnKind", "requesterAccountId"]],
|
|
["CronListParams", ["compact"]],
|
|
["CronRunLogEntry", ["errorReason", "failureNotificationDelivery"]],
|
|
["ExecApprovalRequestParams", ["requireDeliveryRoute", "suppressDelivery"]],
|
|
["AgentSummary", ["thinkingLevels", "thinkingOptions", "thinkingDefault"]],
|
|
["ModelChoice", ["available"]],
|
|
];
|
|
|
|
const DEFAULTED_OPTIONAL_INIT_PARAMS: Record<string, Set<string>> = Object.fromEntries(
|
|
DEFAULTED_OPTIONAL_INIT_PARAM_ENTRIES.map(([name, params]) => [name, new Set(params)]),
|
|
);
|
|
|
|
const header = `// Generated by scripts/protocol-gen-swift.ts — do not edit by hand\n// swiftlint:disable file_length\nimport Foundation\n\npublic let GATEWAY_PROTOCOL_VERSION = ${PROTOCOL_VERSION}\npublic let GATEWAY_MIN_PROTOCOL_VERSION = ${MIN_CLIENT_PROTOCOL_VERSION}\n\nprivate struct GatewayAnyCodingKey: CodingKey, Hashable {\n let stringValue: String\n let intValue: Int?\n\n init?(stringValue: String) {\n self.stringValue = stringValue\n self.intValue = nil\n }\n\n init?(intValue: Int) {\n self.stringValue = String(intValue)\n self.intValue = intValue\n }\n}\n\npublic enum ErrorCode: String, Codable, Sendable {\n${Object.values(
|
|
ErrorCodes,
|
|
)
|
|
.map((c) => ` case ${camelCase(c)} = "${c}"`)
|
|
.join("\n")}\n}\n`;
|
|
|
|
const reserved = new Set([
|
|
"associatedtype",
|
|
"class",
|
|
"deinit",
|
|
"enum",
|
|
"extension",
|
|
"fileprivate",
|
|
"func",
|
|
"import",
|
|
"init",
|
|
"inout",
|
|
"internal",
|
|
"let",
|
|
"open",
|
|
"operator",
|
|
"private",
|
|
"precedencegroup",
|
|
"protocol",
|
|
"public",
|
|
"rethrows",
|
|
"static",
|
|
"struct",
|
|
"subscript",
|
|
"typealias",
|
|
"var",
|
|
]);
|
|
|
|
function camelCase(input: string) {
|
|
return input
|
|
.replace(/[^a-zA-Z0-9]+/g, " ")
|
|
.trim()
|
|
.toLowerCase()
|
|
.split(/\s+/)
|
|
.map((p, i) => (i === 0 ? p : p[0].toUpperCase() + p.slice(1)))
|
|
.join("");
|
|
}
|
|
|
|
function safeName(name: string) {
|
|
const cc = camelCase(name.replace(/-/g, "_"));
|
|
if (/^\d/.test(cc)) {
|
|
return `_${cc}`;
|
|
}
|
|
if (reserved.has(cc)) {
|
|
return `_${cc}`;
|
|
}
|
|
return cc;
|
|
}
|
|
|
|
function swiftStoredPropertyName(structName: string, key: string): string {
|
|
if (structName === "ChatSendParams" && key === "fastMode") {
|
|
return "fastmodevalue";
|
|
}
|
|
if (structName === "ChatSendParams" && key === "fast_seconds") {
|
|
return "fastseconds";
|
|
}
|
|
return safeName(key);
|
|
}
|
|
|
|
function swiftInitializerName(structName: string, key: string): string {
|
|
if (structName === "ChatSendParams" && key === "fastMode") {
|
|
return "fastmodevalue";
|
|
}
|
|
if (structName === "ChatSendParams" && key === "fast_seconds") {
|
|
return "fastseconds";
|
|
}
|
|
return safeName(key);
|
|
}
|
|
|
|
function swiftCompatibilityPropertyLines(structName: string, key: string): string[] {
|
|
if (structName === "ChatSendParams" && key === "fastMode") {
|
|
return [" public var fastmode: Bool? { fastmodevalue?.value as? Bool }"];
|
|
}
|
|
return [];
|
|
}
|
|
|
|
// filled later once schemas are loaded
|
|
const schemaNameByObject = new Map<object, string>();
|
|
const schemaNameBySignature = new Map<string, string>();
|
|
const duplicateSchemaSignatures = new Set<string>();
|
|
|
|
function stableJson(value: unknown): unknown {
|
|
if (Array.isArray(value)) {
|
|
return value.map(stableJson);
|
|
}
|
|
if (value && typeof value === "object") {
|
|
const record = value as Record<string, unknown>;
|
|
return Object.fromEntries(
|
|
Object.keys(record)
|
|
.toSorted()
|
|
.map((key) => [key, stableJson(record[key])]),
|
|
);
|
|
}
|
|
return value;
|
|
}
|
|
|
|
function schemaSignature(schema: JsonSchema): string {
|
|
return JSON.stringify(stableJson(schema));
|
|
}
|
|
|
|
function registerNamedSchema(name: string, schema: JsonSchema): void {
|
|
schemaNameByObject.set(schema as object, name);
|
|
const signature = schemaSignature(schema);
|
|
if (duplicateSchemaSignatures.has(signature)) {
|
|
return;
|
|
}
|
|
if (schemaNameBySignature.has(signature)) {
|
|
schemaNameBySignature.delete(signature);
|
|
duplicateSchemaSignatures.add(signature);
|
|
return;
|
|
}
|
|
schemaNameBySignature.set(signature, name);
|
|
}
|
|
|
|
function namedSchema(schema: JsonSchema, allowStructuralFallback = false): string | undefined {
|
|
return (
|
|
schemaNameByObject.get(schema as object) ??
|
|
(allowStructuralFallback ? schemaNameBySignature.get(schemaSignature(schema)) : undefined)
|
|
);
|
|
}
|
|
|
|
function swiftType(schema: JsonSchema, required: boolean, allowStructuralNamed = false): string {
|
|
const t = schema.type;
|
|
const isOptional = !required;
|
|
let base: string;
|
|
const named = namedSchema(schema, allowStructuralNamed);
|
|
if (named) {
|
|
base = named;
|
|
} else if (t === "string") {
|
|
base = "String";
|
|
} else if (t === "integer") {
|
|
base = "Int";
|
|
} else if (t === "number") {
|
|
base = "Double";
|
|
} else if (t === "boolean") {
|
|
base = "Bool";
|
|
} else if (t === "array") {
|
|
base = `[${swiftType(schema.items ?? { type: "Any" }, true, true)}]`;
|
|
} else if (schema.enum) {
|
|
base = "String";
|
|
} else if (schema.patternProperties) {
|
|
base = "[String: AnyCodable]";
|
|
} else if (t === "object") {
|
|
base = "[String: AnyCodable]";
|
|
} else {
|
|
base = "AnyCodable";
|
|
}
|
|
return isOptional ? `${base}?` : base;
|
|
}
|
|
|
|
function stringEnumCases(schema: JsonSchema): string[] | undefined {
|
|
if (schema.type === "string" && schema.enum) {
|
|
return schema.enum.every((value) => typeof value === "string") ? schema.enum : undefined;
|
|
}
|
|
|
|
const variants = schema.oneOf ?? schema.anyOf;
|
|
if (!variants?.length) {
|
|
return undefined;
|
|
}
|
|
|
|
const cases = variants
|
|
.map((variant) => literalSchemaValue(variant))
|
|
.filter((value): value is string => typeof value === "string");
|
|
return cases.length === variants.length ? cases : undefined;
|
|
}
|
|
|
|
function swiftInitializerParam(params: {
|
|
structName: string;
|
|
key: string;
|
|
name: string;
|
|
schema: JsonSchema;
|
|
required: boolean;
|
|
allowStructuralNamed?: boolean;
|
|
}): string {
|
|
const type = swiftType(params.schema, true, params.allowStructuralNamed ?? true);
|
|
if (params.required) {
|
|
return `${params.name}: ${type}`;
|
|
}
|
|
const defaultNil =
|
|
params.key === "agentId" ||
|
|
(DEFAULTED_OPTIONAL_INIT_PARAMS[params.structName]?.has(params.key) ?? false);
|
|
return `${params.name}: ${type}?${defaultNil ? " = nil" : ""}`;
|
|
}
|
|
|
|
function emitEnum(name: string, schema: JsonSchema): string {
|
|
const cases = stringEnumCases(schema) ?? [];
|
|
return [
|
|
`public enum ${name}: String, Codable, Sendable {`,
|
|
...cases.map((value) => ` case ${safeName(value)} = "${value}"`),
|
|
"}",
|
|
"",
|
|
].join("\n");
|
|
}
|
|
|
|
function stringLiteralUnionValues(schema: JsonSchema): string[] | undefined {
|
|
const branches = schema.oneOf ?? schema.anyOf;
|
|
if (!branches || branches.length < 2) {
|
|
return undefined;
|
|
}
|
|
const values = branches.map((branch) => literalSchemaValue(branch));
|
|
if (values.some((value) => typeof value !== "string")) {
|
|
return undefined;
|
|
}
|
|
const stringValues = values as string[];
|
|
return new Set(stringValues).size === stringValues.length ? stringValues : undefined;
|
|
}
|
|
|
|
function emitStruct(name: string, schema: JsonSchema): string {
|
|
const props = schema.properties ?? {};
|
|
const required = new Set(schema.required ?? []);
|
|
const literalProps = Object.entries(props)
|
|
.map(([key, propSchema]) => ({
|
|
key,
|
|
propSchema,
|
|
literal: literalSchemaValue(propSchema),
|
|
}))
|
|
.filter(
|
|
(
|
|
entry,
|
|
): entry is {
|
|
key: string;
|
|
propSchema: JsonSchema;
|
|
literal: boolean | number | string | null;
|
|
} => entry.literal !== undefined,
|
|
);
|
|
const lines: string[] = [];
|
|
if (Object.keys(props).length === 0) {
|
|
return `public struct ${name}: Codable, Sendable {}\n`;
|
|
}
|
|
if (STRICT_LITERAL_STRUCTS.has(name) && literalProps.length > 0) {
|
|
const literalPropByKey = new Map(literalProps.map((entry) => [entry.key, entry.literal]));
|
|
lines.push(`public struct ${name}: Codable, Sendable {`);
|
|
const codingKeys: string[] = [];
|
|
for (const [key, propSchema] of Object.entries(props)) {
|
|
const propName = safeName(key);
|
|
const propType = swiftType(propSchema, required.has(key), true);
|
|
lines.push(` public let ${propName}: ${propType}`);
|
|
if (propName !== key) {
|
|
codingKeys.push(` case ${propName} = "${key}"`);
|
|
} else {
|
|
codingKeys.push(` case ${propName}`);
|
|
}
|
|
}
|
|
const initializerParams = Object.entries(props)
|
|
.filter(([key]) => !literalPropByKey.has(key))
|
|
.map(([key, prop]) => {
|
|
const propName = safeName(key);
|
|
const req = required.has(key);
|
|
return ` ${swiftInitializerParam({
|
|
structName: name,
|
|
key,
|
|
name: propName,
|
|
schema: prop,
|
|
required: req,
|
|
})}`;
|
|
});
|
|
lines.push(
|
|
"\n public init(\n" +
|
|
(initializerParams.length > 0 ? initializerParams.join(",\n") : " ") +
|
|
"\n )\n" +
|
|
" {\n" +
|
|
Object.entries(props)
|
|
.map(([key]) => {
|
|
const propName = safeName(key);
|
|
if (literalPropByKey.has(key)) {
|
|
return ` self.${propName} = ${swiftLiteralSource(literalPropByKey.get(key)!)}`;
|
|
}
|
|
return ` self.${propName} = ${propName}`;
|
|
})
|
|
.join("\n") +
|
|
"\n }\n\n" +
|
|
" private enum CodingKeys: String, CodingKey {\n" +
|
|
codingKeys.join("\n") +
|
|
"\n }\n\n" +
|
|
" public init(from decoder: Decoder) throws {\n" +
|
|
(schema.additionalProperties === false
|
|
? ` let rawContainer = try decoder.container(keyedBy: GatewayAnyCodingKey.self)\n let unexpectedKeys = rawContainer.allKeys\n .map(\\.stringValue)\n .filter { !Set([${Object.keys(
|
|
props,
|
|
)
|
|
.map((key) => JSON.stringify(key))
|
|
.join(
|
|
", ",
|
|
)}]).contains($0) }\n if !unexpectedKeys.isEmpty {\n throw DecodingError.dataCorrupted(\n .init(\n codingPath: rawContainer.codingPath,\n debugDescription: "Unexpected keys for ${name}: \\(unexpectedKeys.sorted().joined(separator: ", "))"\n )\n )\n }\n`
|
|
: "") +
|
|
" let container = try decoder.container(keyedBy: CodingKeys.self)\n" +
|
|
Object.entries(props)
|
|
.map(([key, propSchema]) => {
|
|
const propName = safeName(key);
|
|
const capitalizedPropName = propName.slice(0, 1).toUpperCase() + propName.slice(1);
|
|
const literal = literalPropByKey.get(key);
|
|
if (literal !== undefined) {
|
|
const literalType = swiftType(propSchema, true, true);
|
|
return ` let decoded${capitalizedPropName} = try container.decode(${literalType}.self, forKey: .${propName})\n guard decoded${capitalizedPropName} == ${swiftLiteralSource(literal)} else {\n throw DecodingError.dataCorruptedError(\n forKey: .${propName},\n in: container,\n debugDescription: "Expected ${key} to equal ${String(literal)}"\n )\n }\n self.${propName} = ${swiftLiteralSource(literal)}`;
|
|
}
|
|
if (required.has(key)) {
|
|
return ` self.${propName} = try container.decode(${swiftType(propSchema, true, true)}.self, forKey: .${propName})`;
|
|
}
|
|
return ` self.${propName} = try container.decodeIfPresent(${swiftType(propSchema, true, true)}.self, forKey: .${propName})`;
|
|
})
|
|
.join("\n") +
|
|
"\n }\n\n" +
|
|
" public func encode(to encoder: Encoder) throws {\n" +
|
|
" var container = encoder.container(keyedBy: CodingKeys.self)\n" +
|
|
Object.entries(props)
|
|
.map(([key]) => {
|
|
const propName = safeName(key);
|
|
const literal = literalPropByKey.get(key);
|
|
if (literal !== undefined) {
|
|
return ` try container.encode(${swiftLiteralSource(literal)}, forKey: .${propName})`;
|
|
}
|
|
if (required.has(key)) {
|
|
return ` try container.encode(${propName}, forKey: .${propName})`;
|
|
}
|
|
return ` try container.encodeIfPresent(${propName}, forKey: .${propName})`;
|
|
})
|
|
.join("\n") +
|
|
"\n }\n}",
|
|
);
|
|
lines.push("");
|
|
return lines.join("\n");
|
|
}
|
|
lines.push(`public struct ${name}: Codable, Sendable {`);
|
|
const codingKeys: string[] = [];
|
|
for (const [key, propSchema] of Object.entries(props)) {
|
|
const propName = swiftStoredPropertyName(name, key);
|
|
const propType = swiftType(propSchema, required.has(key), true);
|
|
lines.push(` public let ${propName}: ${propType}`);
|
|
lines.push(...swiftCompatibilityPropertyLines(name, key));
|
|
if (propName !== key) {
|
|
codingKeys.push(` case ${propName} = "${key}"`);
|
|
} else {
|
|
codingKeys.push(` case ${propName}`);
|
|
}
|
|
}
|
|
lines.push(
|
|
"\n public init(\n" +
|
|
Object.entries(props)
|
|
.map(([key, prop]) => {
|
|
const propName = swiftInitializerName(name, key);
|
|
const req = required.has(key);
|
|
return ` ${swiftInitializerParam({
|
|
structName: name,
|
|
key,
|
|
name: propName,
|
|
schema: prop,
|
|
required: req,
|
|
})}`;
|
|
})
|
|
.join(",\n") +
|
|
")\n" +
|
|
" {\n" +
|
|
Object.entries(props)
|
|
.map(([key]) => {
|
|
const propName = swiftStoredPropertyName(name, key);
|
|
const paramName = swiftInitializerName(name, key);
|
|
return ` self.${propName} = ${paramName}`;
|
|
})
|
|
.join("\n") +
|
|
"\n }" +
|
|
emitStructCompatibilityInitializer(name, props, required) +
|
|
"\n\n" +
|
|
" private enum CodingKeys: String, CodingKey {\n" +
|
|
codingKeys.join("\n") +
|
|
"\n }\n}",
|
|
);
|
|
lines.push("");
|
|
return lines.join("\n");
|
|
}
|
|
|
|
function emitStructCompatibilityInitializer(
|
|
name: string,
|
|
props: Record<string, JsonSchema>,
|
|
required: Set<string>,
|
|
): string {
|
|
if (name !== "ChatSendParams" || !props.fastMode) {
|
|
return "";
|
|
}
|
|
const legacyKeys = Object.keys(props).filter(
|
|
(key) => key !== "fastAutoOnSeconds" && key !== "fast_seconds",
|
|
);
|
|
const initializerParams = legacyKeys.map((key) => {
|
|
const prop = props[key];
|
|
if (!prop) {
|
|
throw new Error(`missing ${name}.${key} schema`);
|
|
}
|
|
const propName = swiftInitializerName(name, key);
|
|
if (key === "fastMode") {
|
|
return " fastmode: Bool?";
|
|
}
|
|
return ` ${swiftInitializerParam({
|
|
structName: name,
|
|
key,
|
|
name: propName,
|
|
schema: prop,
|
|
required: required.has(key),
|
|
})}`;
|
|
});
|
|
const delegatedArgs = Object.keys(props).map((key) => {
|
|
const propName = swiftInitializerName(name, key);
|
|
if (key === "fastMode") {
|
|
return " fastmodevalue: fastmode.map { AnyCodable($0) }";
|
|
}
|
|
if (key === "fastAutoOnSeconds" || key === "fast_seconds") {
|
|
return ` ${propName}: nil`;
|
|
}
|
|
return ` ${propName}: ${propName}`;
|
|
});
|
|
return (
|
|
"\n\n public init(\n" +
|
|
initializerParams.join(",\n") +
|
|
")\n" +
|
|
" {\n" +
|
|
" self.init(\n" +
|
|
delegatedArgs.join(",\n") +
|
|
")\n" +
|
|
" }"
|
|
);
|
|
}
|
|
|
|
function literalSchemaValue(schema: JsonSchema): boolean | number | string | null | undefined {
|
|
if ("const" in schema) {
|
|
return schema.const;
|
|
}
|
|
if (schema.enum?.length === 1) {
|
|
return schema.enum[0] ?? undefined;
|
|
}
|
|
return undefined;
|
|
}
|
|
|
|
function swiftLiteralTypeName(value: boolean | number | string | null): string {
|
|
if (typeof value === "boolean") {
|
|
return "Bool";
|
|
}
|
|
if (typeof value === "number") {
|
|
return Number.isInteger(value) ? "Int" : "Double";
|
|
}
|
|
if (value === null) {
|
|
return "AnyCodable";
|
|
}
|
|
return "String";
|
|
}
|
|
|
|
function swiftLiteralSource(value: boolean | number | string | null): string {
|
|
if (typeof value === "string") {
|
|
return JSON.stringify(value);
|
|
}
|
|
if (value === null) {
|
|
return "AnyCodable(nil)";
|
|
}
|
|
return String(value);
|
|
}
|
|
|
|
function swiftUnionCaseName(value: boolean | number | string | null, fallback: string): string {
|
|
if (typeof value === "boolean") {
|
|
return value ? "success" : "failure";
|
|
}
|
|
if (value === null) {
|
|
return fallback;
|
|
}
|
|
return safeName(String(value));
|
|
}
|
|
|
|
function emitDiscriminatedUnion(name: string, schema: JsonSchema): string | undefined {
|
|
const branches = schema.oneOf ?? schema.anyOf;
|
|
if (!branches || branches.length < 2) {
|
|
return undefined;
|
|
}
|
|
const objectBranches = branches.filter((branch) => branch.type === "object");
|
|
if (objectBranches.length !== branches.length) {
|
|
return undefined;
|
|
}
|
|
const discriminatorCandidates = Object.keys(objectBranches[0]?.properties ?? {});
|
|
for (const discriminator of discriminatorCandidates) {
|
|
const cases = objectBranches.map((branch, index) => {
|
|
const discriminatorSchema = branch.properties?.[discriminator];
|
|
const literal = discriminatorSchema ? literalSchemaValue(discriminatorSchema) : undefined;
|
|
const branchName = namedSchema(branch, true);
|
|
if (literal === undefined || !branchName) {
|
|
return undefined;
|
|
}
|
|
return {
|
|
branchName,
|
|
caseName: swiftUnionCaseName(literal, `case${index + 1}`),
|
|
literal,
|
|
};
|
|
});
|
|
if (cases.some((entry) => !entry)) {
|
|
continue;
|
|
}
|
|
const resolvedCases: Array<{
|
|
branchName: string;
|
|
caseName: string;
|
|
literal: boolean | number | string | null;
|
|
}> = cases;
|
|
const [firstCase] = resolvedCases;
|
|
if (!firstCase) {
|
|
continue;
|
|
}
|
|
const literalType = swiftLiteralTypeName(firstCase.literal);
|
|
if (
|
|
resolvedCases.some((entry) => swiftLiteralTypeName(entry.literal) !== literalType) ||
|
|
new Set(resolvedCases.map((entry) => String(entry.literal))).size !== resolvedCases.length
|
|
) {
|
|
continue;
|
|
}
|
|
const coversAllBoolCases =
|
|
literalType === "Bool" &&
|
|
resolvedCases.some((entry) => entry.literal === true) &&
|
|
resolvedCases.some((entry) => entry.literal === false);
|
|
const unknownDiscriminatorLines = coversAllBoolCases
|
|
? []
|
|
: [
|
|
" default:",
|
|
" throw DecodingError.dataCorruptedError(",
|
|
" forKey: .discriminator,",
|
|
" in: container,",
|
|
` debugDescription: "Unknown ${name} discriminator value"`,
|
|
" )",
|
|
];
|
|
return [
|
|
`public enum ${name}: Codable, Sendable {`,
|
|
...resolvedCases.map((entry) => ` case ${entry.caseName}(${entry.branchName})`),
|
|
"",
|
|
" private enum CodingKeys: String, CodingKey {",
|
|
` case discriminator = "${discriminator}"`,
|
|
" }",
|
|
"",
|
|
" public init(from decoder: Decoder) throws {",
|
|
" let container = try decoder.container(keyedBy: CodingKeys.self)",
|
|
` let discriminator = try container.decode(${literalType}.self, forKey: .discriminator)`,
|
|
" switch discriminator {",
|
|
...resolvedCases.map(
|
|
(entry) =>
|
|
` case ${swiftLiteralSource(entry.literal)}: self = try .${entry.caseName}(${entry.branchName}(from: decoder))`,
|
|
),
|
|
...unknownDiscriminatorLines,
|
|
" }",
|
|
" }",
|
|
"",
|
|
" public func encode(to encoder: Encoder) throws {",
|
|
" switch self {",
|
|
...resolvedCases.map(
|
|
(entry) => ` case .${entry.caseName}(let value): try value.encode(to: encoder)`,
|
|
),
|
|
" }",
|
|
" }",
|
|
"}",
|
|
"",
|
|
].join("\n");
|
|
}
|
|
return undefined;
|
|
}
|
|
|
|
function emitGatewayFrame(): string {
|
|
const cases = ["req", "res", "event"];
|
|
const associated: Record<string, string> = {
|
|
req: "RequestFrame",
|
|
res: "ResponseFrame",
|
|
event: "EventFrame",
|
|
};
|
|
const caseLines = cases.map((c) => ` case ${safeName(c)}(${associated[c]})`);
|
|
const initLines = `
|
|
private enum CodingKeys: String, CodingKey {
|
|
case type
|
|
}
|
|
|
|
public init(from decoder: Decoder) throws {
|
|
let typeContainer = try decoder.container(keyedBy: CodingKeys.self)
|
|
let type = try typeContainer.decode(String.self, forKey: .type)
|
|
switch type {
|
|
case "req":
|
|
self = try .req(RequestFrame(from: decoder))
|
|
case "res":
|
|
self = try .res(ResponseFrame(from: decoder))
|
|
case "event":
|
|
self = try .event(EventFrame(from: decoder))
|
|
default:
|
|
let container = try decoder.singleValueContainer()
|
|
let raw = try container.decode([String: AnyCodable].self)
|
|
self = .unknown(type: type, raw: raw)
|
|
}
|
|
}
|
|
|
|
public func encode(to encoder: Encoder) throws {
|
|
switch self {
|
|
case let .req(v):
|
|
try v.encode(to: encoder)
|
|
case let .res(v):
|
|
try v.encode(to: encoder)
|
|
case let .event(v):
|
|
try v.encode(to: encoder)
|
|
case let .unknown(_, raw):
|
|
var container = encoder.singleValueContainer()
|
|
try container.encode(raw)
|
|
}
|
|
}
|
|
`;
|
|
|
|
return [
|
|
"public enum GatewayFrame: Codable, Sendable {",
|
|
...caseLines,
|
|
" case unknown(type: String, raw: [String: AnyCodable])",
|
|
initLines.trimEnd(),
|
|
"}",
|
|
"",
|
|
].join("\n");
|
|
}
|
|
|
|
async function generate() {
|
|
const definitions = Object.entries(ProtocolSchemas) as Array<[string, JsonSchema]>;
|
|
|
|
for (const [name, schema] of definitions) {
|
|
registerNamedSchema(name, schema);
|
|
}
|
|
|
|
const parts: string[] = [];
|
|
parts.push(header);
|
|
|
|
// Named enums and value structs
|
|
for (const [name, schema] of definitions) {
|
|
if (name === "GatewayFrame") {
|
|
continue;
|
|
}
|
|
if (stringEnumCases(schema)) {
|
|
parts.push(emitEnum(name, schema));
|
|
continue;
|
|
}
|
|
const literalUnionValues = stringLiteralUnionValues(schema);
|
|
if (literalUnionValues) {
|
|
parts.push(emitEnum(name, { enum: literalUnionValues }));
|
|
}
|
|
}
|
|
|
|
for (const [name, schema] of definitions) {
|
|
if (name === "GatewayFrame") {
|
|
continue;
|
|
}
|
|
if (schema.type === "object") {
|
|
parts.push(emitStruct(name, schema));
|
|
}
|
|
}
|
|
|
|
for (const [name, schema] of definitions) {
|
|
if (name === "GatewayFrame") {
|
|
continue;
|
|
}
|
|
const union = emitDiscriminatedUnion(name, schema);
|
|
if (union) {
|
|
parts.push(union);
|
|
}
|
|
}
|
|
|
|
// Frame enum must come after payload structs
|
|
parts.push(emitGatewayFrame());
|
|
|
|
const content = parts.join("\n");
|
|
for (const outPath of outPaths) {
|
|
await fs.mkdir(path.dirname(outPath), { recursive: true });
|
|
await fs.writeFile(outPath, content);
|
|
console.log(`wrote ${outPath}`);
|
|
}
|
|
}
|
|
|
|
generate().catch((err: unknown) => {
|
|
console.error(err);
|
|
process.exit(1);
|
|
});
|