public.ts 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152
  1. import { HttpApi, OpenApi } from "effect/unstable/httpapi"
  2. import { ConfigApi } from "./config"
  3. import { ControlApi } from "./control"
  4. import { EventApi } from "./event"
  5. import { ExperimentalApi } from "./experimental"
  6. import { FileApi } from "./file"
  7. import { GlobalApi } from "./global"
  8. import { InstanceApi } from "./instance"
  9. import { McpApi } from "./mcp"
  10. import { PermissionApi } from "./permission"
  11. import { ProjectApi } from "./project"
  12. import { ProviderApi } from "./provider"
  13. import { PtyApi, PtyConnectApi } from "./pty"
  14. import { QuestionApi } from "./question"
  15. import { SessionApi } from "./session"
  16. import { SyncApi } from "./sync"
  17. import { TuiApi } from "./tui"
  18. import { WorkspaceApi } from "./workspace"
  19. type OpenApiParameter = {
  20. name: string
  21. in: string
  22. required?: boolean
  23. schema?: unknown
  24. }
  25. type OpenApiOperation = {
  26. parameters?: OpenApiParameter[]
  27. requestBody?: {
  28. required?: boolean
  29. content?: Record<string, { schema?: OpenApiSchema }>
  30. }
  31. }
  32. type OpenApiPathItem = Partial<Record<"get" | "post" | "put" | "delete" | "patch", OpenApiOperation>>
  33. type OpenApiSpec = {
  34. components?: {
  35. schemas?: Record<string, OpenApiSchema>
  36. }
  37. paths?: Record<string, OpenApiPathItem>
  38. }
  39. type OpenApiSchema = {
  40. $ref?: string
  41. additionalProperties?: OpenApiSchema | boolean
  42. allOf?: OpenApiSchema[]
  43. anyOf?: OpenApiSchema[]
  44. items?: OpenApiSchema
  45. oneOf?: OpenApiSchema[]
  46. properties?: Record<string, OpenApiSchema>
  47. type?: string
  48. }
  49. const InstanceQueryParameters = [
  50. {
  51. name: "directory",
  52. in: "query",
  53. required: false,
  54. schema: { type: "string" },
  55. },
  56. {
  57. name: "workspace",
  58. in: "query",
  59. required: false,
  60. schema: { type: "string" },
  61. },
  62. ] satisfies OpenApiParameter[]
  63. const LegacyBodyRefParameters = new Set(["Auth", "Config", "Part", "WorktreeRemoveInput", "WorktreeResetInput"])
  64. function matchLegacyOpenApi(input: Record<string, unknown>) {
  65. const spec = input as OpenApiSpec
  66. for (const [path, item] of Object.entries(spec.paths ?? {})) {
  67. const isInstanceRoute = !path.startsWith("/global/") && !path.startsWith("/auth/")
  68. for (const method of ["get", "post", "put", "delete", "patch"] as const) {
  69. const operation = item[method]
  70. if (!operation) continue
  71. if (operation.requestBody) {
  72. delete operation.requestBody.required
  73. for (const media of Object.values(operation.requestBody.content ?? {})) {
  74. const ref = media.schema?.$ref?.replace("#/components/schemas/", "")
  75. if (ref && LegacyBodyRefParameters.has(ref)) continue
  76. if (ref && spec.components?.schemas?.[ref]) {
  77. media.schema = normalizeRequestSchema(structuredClone(spec.components.schemas[ref]))
  78. continue
  79. }
  80. if (media.schema) media.schema = normalizeRequestSchema(media.schema)
  81. }
  82. }
  83. if (!isInstanceRoute) continue
  84. operation.parameters = [
  85. ...InstanceQueryParameters,
  86. ...(operation.parameters ?? []).filter(
  87. (param) => param.in !== "query" || (param.name !== "directory" && param.name !== "workspace"),
  88. ),
  89. ]
  90. }
  91. }
  92. return input
  93. }
  94. function normalizeRequestSchema(schema: OpenApiSchema): OpenApiSchema {
  95. const options = schema.anyOf ?? schema.oneOf
  96. if (options) {
  97. const withoutNull = options.filter((item) => item.type !== "null")
  98. const finite = withoutNull.find((item) => item.type === "number")
  99. if (finite && withoutNull.every((item) => item.type === "number" || item.type === "string")) return finite
  100. if (withoutNull.length === 1) return normalizeRequestSchema(withoutNull[0])
  101. if (schema.anyOf) schema.anyOf = withoutNull.map(normalizeRequestSchema)
  102. if (schema.oneOf) schema.oneOf = withoutNull.map(normalizeRequestSchema)
  103. }
  104. if (schema.allOf) schema.allOf = schema.allOf.map(normalizeRequestSchema)
  105. if (schema.items) schema.items = normalizeRequestSchema(schema.items)
  106. if (schema.properties) {
  107. for (const [key, value] of Object.entries(schema.properties)) {
  108. schema.properties[key] = normalizeRequestSchema(value)
  109. }
  110. }
  111. if (schema.additionalProperties && typeof schema.additionalProperties === "object") {
  112. schema.additionalProperties = normalizeRequestSchema(schema.additionalProperties)
  113. }
  114. return schema
  115. }
  116. export const PublicApi = HttpApi.make("opencode")
  117. .addHttpApi(ControlApi)
  118. .addHttpApi(GlobalApi)
  119. .addHttpApi(EventApi)
  120. .addHttpApi(ConfigApi)
  121. .addHttpApi(ExperimentalApi)
  122. .addHttpApi(FileApi)
  123. .addHttpApi(InstanceApi)
  124. .addHttpApi(McpApi)
  125. .addHttpApi(PermissionApi)
  126. .addHttpApi(ProjectApi)
  127. .addHttpApi(ProviderApi)
  128. .addHttpApi(PtyApi)
  129. .addHttpApi(PtyConnectApi)
  130. .addHttpApi(QuestionApi)
  131. .addHttpApi(SessionApi)
  132. .addHttpApi(SyncApi)
  133. .addHttpApi(TuiApi)
  134. .addHttpApi(WorkspaceApi)
  135. .annotateMerge(
  136. OpenApi.annotations({
  137. title: "opencode",
  138. version: "1.0.0",
  139. description: "opencode api",
  140. transform: matchLegacyOpenApi,
  141. }),
  142. )