vendor/opencode
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

refactor(core): simplify integration credentials (#31968)

Browse Source
This commit is contained in:
Dax
2026-06-12 02:15:25 -04:00
committed by GitHub
parent a9c810cbbc
commit 30aec297d8
112 changed files with 2478 additions and 47739 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
packages/server/src/api.ts
View File

@@ -15,7 +15,8 @@ import { QuestionGroup } from "./groups/question"
import { ReferenceGroup } from "./groups/reference"
import { Authorization } from "./middleware/authorization"
import { LocationGroup } from "./groups/location"
import { ConnectorGroup } from "./groups/connector"
import { IntegrationGroup } from "./groups/integration"
import { CredentialGroup } from "./groups/credential"
export const Api = HttpApi.make("server")
.add(HealthGroup)
@@ -25,7 +26,8 @@ export const Api = HttpApi.make("server")
.add(MessageGroup)
.add(ModelGroup)
.add(ProviderGroup)
.add(ConnectorGroup)
.add(IntegrationGroup)
.add(CredentialGroup)
.add(PermissionGroup)
.add(FileSystemGroup)
.add(CommandGroup)

30
packages/server/src/groups/credential.ts Normal file
View File

@@ -0,0 +1,30 @@
import { Credential } from "@opencode-ai/core/credential"
import { Schema } from "effect"
import { HttpApiEndpoint, HttpApiGroup, HttpApiSchema, OpenApi } from "effect/unstable/httpapi"
export const CredentialGroup = HttpApiGroup.make("server.credential")
.add(
HttpApiEndpoint.patch("credential.update", "/api/credential/:credentialID", {
params: { credentialID: Credential.ID },
payload: Schema.Struct({ label: Schema.String }),
success: HttpApiSchema.NoContent,
}).annotateMerge(
OpenApi.annotations({
identifier: "v2.credential.update",
summary: "Update credential",
description: "Update a stored credential label.",
}),
),
)
.add(
HttpApiEndpoint.delete("credential.remove", "/api/credential/:credentialID", {
params: { credentialID: Credential.ID },
success: HttpApiSchema.NoContent,
}).annotateMerge(
OpenApi.annotations({
identifier: "v2.credential.remove",
summary: "Remove credential",
description: "Remove a stored integration credential.",
}),
),
)

66
packages/server/src/groups/connector.ts → packages/server/src/groups/integration.ts
View File

@@ -1,4 +1,4 @@
import { Connector } from "@opencode-ai/core/connector"
import { Integration } from "@opencode-ai/core/integration"
import { Location } from "@opencode-ai/core/location"
import { Schema } from "effect"
import { HttpApiEndpoint, HttpApiGroup, HttpApiSchema, OpenApi } from "effect/unstable/httpapi"
@@ -7,44 +7,42 @@ import { LocationMiddleware, LocationQuery, locationQueryOpenApi } from "./locat
const Inputs = Schema.Record(Schema.String, Schema.String)
export const ConnectorGroup = HttpApiGroup.make("server.connector")
export const IntegrationGroup = HttpApiGroup.make("server.integration")
.add(
HttpApiEndpoint.get("connector.list", "/api/connector", {
HttpApiEndpoint.get("integration.list", "/api/integration", {
query: LocationQuery,
success: Location.response(Schema.Array(Connector.Info)),
success: Location.response(Schema.Array(Integration.Info)),
})
.annotateMerge(locationQueryOpenApi)
.annotateMerge(
OpenApi.annotations({
identifier: "v2.connector.list",
summary: "List connectors",
description: "Retrieve available connectors and their authentication methods.",
identifier: "v2.integration.list",
summary: "List integrations",
description: "Retrieve available integrations and their authentication methods.",
}),
),
)
.add(
HttpApiEndpoint.get("connector.get", "/api/connector/:connectorID", {
params: { connectorID: Connector.ID },
HttpApiEndpoint.get("integration.get", "/api/integration/:integrationID", {
params: { integrationID: Integration.ID },
query: LocationQuery,
success: Location.response(Schema.UndefinedOr(Connector.Info)),
success: Location.response(Schema.UndefinedOr(Integration.Info)),
})
.annotateMerge(locationQueryOpenApi)
.annotateMerge(
OpenApi.annotations({
identifier: "v2.connector.get",
summary: "Get connector",
description: "Retrieve one connector and its authentication methods.",
identifier: "v2.integration.get",
summary: "Get integration",
description: "Retrieve one integration and its authentication methods.",
}),
),
)
.add(
HttpApiEndpoint.post("connector.connect.key", "/api/connector/:connectorID/connect/key", {
params: { connectorID: Connector.ID },
HttpApiEndpoint.post("integration.connect.key", "/api/integration/:integrationID/connect/key", {
params: { integrationID: Integration.ID },
query: LocationQuery,
payload: Schema.Struct({
methodID: Connector.MethodID,
key: Schema.String,
inputs: Inputs,
label: Schema.optional(Schema.String),
}),
success: HttpApiSchema.NoContent,
@@ -53,51 +51,51 @@ export const ConnectorGroup = HttpApiGroup.make("server.connector")
.annotateMerge(locationQueryOpenApi)
.annotateMerge(
OpenApi.annotations({
identifier: "v2.connector.connect.key",
identifier: "v2.integration.connect.key",
summary: "Connect with key",
description: "Run a key authentication method and store the resulting credential.",
}),
),
)
.add(
HttpApiEndpoint.post("connector.connect.oauth.begin", "/api/connector/:connectorID/connect/oauth", {
params: { connectorID: Connector.ID },
HttpApiEndpoint.post("integration.connect.oauth", "/api/integration/:integrationID/connect/oauth", {
params: { integrationID: Integration.ID },
query: LocationQuery,
payload: Schema.Struct({
methodID: Connector.MethodID,
methodID: Integration.MethodID,
inputs: Inputs,
label: Schema.optional(Schema.String),
}),
success: Location.response(Connector.Attempt),
success: Location.response(Integration.Attempt),
error: InvalidRequestError,
})
.annotateMerge(locationQueryOpenApi)
.annotateMerge(
OpenApi.annotations({
identifier: "v2.connector.connect.oauth.begin",
identifier: "v2.integration.connect.oauth",
summary: "Begin OAuth connection",
description: "Start an OAuth attempt and return the authorization details.",
}),
),
)
.add(
HttpApiEndpoint.get("connector.connect.oauth.status", "/api/connector/oauth/:attemptID", {
params: { attemptID: Connector.AttemptID },
HttpApiEndpoint.get("integration.attempt.status", "/api/integration/attempt/:attemptID", {
params: { attemptID: Integration.AttemptID },
query: LocationQuery,
success: Location.response(Connector.AttemptStatus),
success: Location.response(Integration.AttemptStatus),
})
.annotateMerge(locationQueryOpenApi)
.annotateMerge(
OpenApi.annotations({
identifier: "v2.connector.connect.oauth.status",
identifier: "v2.integration.attempt.status",
summary: "Get OAuth attempt status",
description: "Poll the current status of an OAuth attempt.",
}),
),
)
.add(
HttpApiEndpoint.post("connector.connect.oauth.complete", "/api/connector/oauth/:attemptID/complete", {
params: { attemptID: Connector.AttemptID },
HttpApiEndpoint.post("integration.attempt.complete", "/api/integration/attempt/:attemptID/complete", {
params: { attemptID: Integration.AttemptID },
query: LocationQuery,
payload: Schema.Struct({ code: Schema.optional(Schema.String) }),
success: HttpApiSchema.NoContent,
@@ -106,28 +104,28 @@ export const ConnectorGroup = HttpApiGroup.make("server.connector")
.annotateMerge(locationQueryOpenApi)
.annotateMerge(
OpenApi.annotations({
identifier: "v2.connector.connect.oauth.complete",
identifier: "v2.integration.attempt.complete",
summary: "Complete OAuth connection",
description: "Complete a code-based OAuth attempt and store the resulting credential.",
}),
),
)
.add(
HttpApiEndpoint.delete("connector.connect.oauth.cancel", "/api/connector/oauth/:attemptID", {
params: { attemptID: Connector.AttemptID },
HttpApiEndpoint.delete("integration.attempt.cancel", "/api/integration/attempt/:attemptID", {
params: { attemptID: Integration.AttemptID },
query: LocationQuery,
success: HttpApiSchema.NoContent,
})
.annotateMerge(locationQueryOpenApi)
.annotateMerge(
OpenApi.annotations({
identifier: "v2.connector.connect.oauth.cancel",
identifier: "v2.integration.attempt.cancel",
summary: "Cancel OAuth connection",
description: "Cancel an OAuth attempt and release its resources.",
}),
),
)
.annotateMerge(
OpenApi.annotations({ title: "connectors", description: "Connector discovery and authentication routes." }),
OpenApi.annotations({ title: "integrations", description: "Integration discovery and authentication routes." }),
)
.middleware(LocationMiddleware)

8
packages/server/src/handlers.ts
View File

@@ -19,7 +19,9 @@ import { QuestionHandler } from "./handlers/question"
import { ReferenceHandler } from "./handlers/reference"
import * as SessionExecutionLocal from "@opencode-ai/core/session/execution/local"
import { LocationHandler } from "./handlers/location"
import { ConnectorHandler } from "./handlers/connector"
import { IntegrationHandler } from "./handlers/integration"
import { CredentialHandler } from "./handlers/credential"
import { Credential } from "@opencode-ai/core/credential"
export const handlers = Layer.mergeAll(
HealthHandler,
@@ -29,7 +31,8 @@ export const handlers = Layer.mergeAll(
MessageHandler,
ModelHandler,
ProviderHandler,
ConnectorHandler,
IntegrationHandler,
CredentialHandler,
PermissionHandler,
FileSystemHandler,
CommandHandler,
@@ -44,4 +47,5 @@ export const handlers = Layer.mergeAll(
Layer.provide(SessionExecutionLocal.defaultLayer),
Layer.provide(PermissionSaved.defaultLayer),
Layer.provide(LocationServiceMap.layer),
Layer.provide(Credential.defaultLayer),
)

22
packages/server/src/handlers/credential.ts Normal file
View File

@@ -0,0 +1,22 @@
import { Credential } from "@opencode-ai/core/credential"
import { Effect } from "effect"
import { HttpApiBuilder, HttpApiSchema } from "effect/unstable/httpapi"
import { Api } from "../api"
export const CredentialHandler = HttpApiBuilder.group(Api, "server.credential", (handlers) =>
handlers
.handle(
"credential.update",
Effect.fn(function* (ctx) {
yield* (yield* Credential.Service).update(ctx.params.credentialID, { label: ctx.payload.label })
return HttpApiSchema.NoContent.make()
}),
)
.handle(
"credential.remove",
Effect.fn(function* (ctx) {
yield* (yield* Credential.Service).remove(ctx.params.credentialID)
return HttpApiSchema.NoContent.make()
}),
),
)

59
packages/server/src/handlers/connector.ts → packages/server/src/handlers/integration.ts
View File

@@ -1,48 +1,46 @@
import { Connector } from "@opencode-ai/core/connector"
import { Integration } from "@opencode-ai/core/integration"
import { Effect } from "effect"
import { HttpApiBuilder, HttpApiSchema } from "effect/unstable/httpapi"
import { Api } from "../api"
import { InvalidRequestError } from "../errors"
import { response } from "../groups/location"
const authorize = <A, R>(effect: Effect.Effect<A, Connector.AuthorizationError, R>) =>
const authorize = <A, R>(effect: Effect.Effect<A, Integration.AuthorizationError, R>) =>
effect.pipe(
Effect.mapError(
() =>
new InvalidRequestError({
message: "Authentication failed",
kind: "connector_authorization",
kind: "integration_authorization",
}),
),
)
export const ConnectorHandler = HttpApiBuilder.group(Api, "server.connector", (handlers) =>
export const IntegrationHandler = HttpApiBuilder.group(Api, "server.integration", (handlers) =>
Effect.gen(function* () {
return handlers
.handle(
"connector.list",
"integration.list",
Effect.fn(function* () {
const service = yield* Connector.Service
const service = yield* Integration.Service
return yield* response(service.list())
}),
)
.handle(
"connector.get",
"integration.get",
Effect.fn(function* (ctx) {
const service = yield* Connector.Service
return yield* response(service.get(ctx.params.connectorID))
const service = yield* Integration.Service
return yield* response(service.get(ctx.params.integrationID))
}),
)
.handle(
"connector.connect.key",
"integration.connect.key",
Effect.fn(function* (ctx) {
const service = yield* Connector.Service
const service = yield* Integration.Service
yield* authorize(
service.connect.key({
connectorID: ctx.params.connectorID,
methodID: ctx.payload.methodID,
integrationID: ctx.params.integrationID,
key: ctx.payload.key,
inputs: ctx.payload.inputs,
label: ctx.payload.label,
}),
)
@@ -50,13 +48,13 @@ export const ConnectorHandler = HttpApiBuilder.group(Api, "server.connector", (h
}),
)
.handle(
"connector.connect.oauth.begin",
"integration.connect.oauth",
Effect.fn(function* (ctx) {
const service = yield* Connector.Service
const service = yield* Integration.Service
return yield* response(
authorize(
service.connect.oauth.begin({
connectorID: ctx.params.connectorID,
service.connect.oauth({
integrationID: ctx.params.integrationID,
methodID: ctx.payload.methodID,
inputs: ctx.payload.inputs,
label: ctx.payload.label,
@@ -66,25 +64,28 @@ export const ConnectorHandler = HttpApiBuilder.group(Api, "server.connector", (h
}),
)
.handle(
"connector.connect.oauth.status",
"integration.attempt.status",
Effect.fn(function* (ctx) {
const service = yield* Connector.Service
return yield* response(service.connect.oauth.status(ctx.params.attemptID))
const service = yield* Integration.Service
return yield* response(service.attempt.status(ctx.params.attemptID))
}),
)
.handle(
"connector.connect.oauth.complete",
"integration.attempt.complete",
Effect.fn(function* (ctx) {
const service = yield* Connector.Service
yield* service.connect.oauth.complete({ attemptID: ctx.params.attemptID, code: ctx.payload.code }).pipe(
const service = yield* Integration.Service
yield* service.attempt.complete({ attemptID: ctx.params.attemptID, code: ctx.payload.code }).pipe(
Effect.mapError(
(error) =>
new InvalidRequestError({
message:
error._tag === "Connector.CodeRequired"
error._tag === "Integration.CodeRequired"
? "Authorization code is required"
: "Authentication failed",
kind: error._tag === "Connector.CodeRequired" ? "connector_code_required" : "connector_authorization",
kind:
error._tag === "Integration.CodeRequired"
? "integration_code_required"
: "integration_authorization",
}),
),
)
@@ -92,10 +93,10 @@ export const ConnectorHandler = HttpApiBuilder.group(Api, "server.connector", (h
}),
)
.handle(
"connector.connect.oauth.cancel",
"integration.attempt.cancel",
Effect.fn(function* (ctx) {
const service = yield* Connector.Service
yield* service.connect.oauth.cancel(ctx.params.attemptID)
const service = yield* Integration.Service
yield* service.attempt.cancel(ctx.params.attemptID)
return HttpApiSchema.NoContent.make()
}),
)