Function emitClientGlobalApiRegistration

scripts/codegen/go.ts:4356–4455

(lines: string[], clientSchema: Record<string, unknown>, resolveType: (name: string) => string, unionInfos: Map<string, GoDiscriminatedUnionInfo>)

}

function emitClientGlobalApiRegistration(lines: string[], clientSchema: Record<string, unknown>, resolveType: (name: string) => string, unionInfos: Map<string, GoDiscriminatedUnionInfo>): void {
    const groups = collectClientGroups(clientSchema);

    for (const { groupName, groupNode, methods } of groups) {
        const interfaceName = clientHandlerInterfaceName(groupName);
        const groupExperimental = isNodeFullyExperimental(groupNode);
        const groupDeprecated = isNodeFullyDeprecated(groupNode);
        if (groupDeprecated) {
            pushGoComment(lines, `Deprecated: ${interfaceName} contains deprecated APIs that will be removed in a future version.`);
        }
        if (groupExperimental) {
            pushGoExperimentalApiComment(lines, interfaceName);
        }
        lines.push(`type ${interfaceName} interface {`);
        for (const method of methods) {
            const resultSchema = getMethodResultSchema(method);
            pushGoRpcMethodComment(
                lines,
                clientHandlerMethodName(method.rpcMethod),
                method,
                resultSchema,
                goRpcParamsDescription(method, getMethodParamsSchema(method)),
                "\t",
                "handles"
            );
            if (method.deprecated && !groupDeprecated) {
                pushGoComment(lines, `Deprecated: ${clientHandlerMethodName(method.rpcMethod)} is deprecated and will be removed in a future version.`, "\t");
            }
            if (method.stability === "experimental" && !groupExperimental) {
                pushGoExperimentalMethodComment(lines, clientHandlerMethodName(method.rpcMethod), "\t");
            }
            const paramsType = resolveType(goParamsTypeName(method));
            const nullableInner = resultSchema ? getNullableInner(resultSchema) : undefined;
            let returnType: string;
            if (isOpaqueJson(resultSchema)) {
                returnType = "any";
            } else {
                const resultType = nullableInner
                    ? resolveType(goNullableResultTypeName(method, nullableInner))
                    : resolveType(goResultTypeName(method));
                returnType = unionInfos.has(resultType) ? resultType : `*${resultType}`;
            }
            lines.push(`\t${clientHandlerMethodName(method.rpcMethod)}(request *${paramsType}) (${returnType}, error)`);
        }
        lines.push(`}`);
        lines.push(``);
    }

    lines.push(`// ClientGlobalAPIHandlers provides all client-global API handler groups.`);
    lines.push(`//`);
    lines.push(`// Unlike client-session handlers these carry no implicit session id dispatch`);
    lines.push(`// key; a single set of handlers serves the entire connection.`);
    lines.push(`type ClientGlobalAPIHandlers struct {`);
    for (const { groupName } of groups) {
        lines.push(`\t${toGoFieldName(groupName)} ${clientHandlerInterfaceName(groupName)}`);
    }
    lines.push(`}`);
    lines.push(``);