@opencode/ai 0.0.0-beta-19275

package/dist/route/auth.d.ts

@@ -0,0 +1,51 @@
+import { Config, Effect, Redacted } from "effect";
+import { Headers } from "effect/unstable/http";
+import { AIError, type HttpOptions } from "../schema/index.js";
+export declare class MissingCredentialError extends Error {
+    readonly source: string;
+    readonly _tag = "MissingCredentialError";
+    constructor(source: string);
+}
+export type CredentialError = MissingCredentialError | Config.ConfigError;
+export type AuthError = CredentialError | AIError;
+type Secret = string | Redacted.Redacted | Config.Config<string | Redacted.Redacted>;
+export interface AuthInput {
+    readonly request: {
+        readonly http?: HttpOptions;
+    };
+    readonly method: "POST" | "GET";
+    readonly url: string;
+    readonly body: string;
+    readonly headers: Headers.Headers;
+}
+export interface Credential {
+    readonly load: Effect.Effect<Redacted.Redacted, CredentialError>;
+    readonly orElse: (that: Credential) => Credential;
+    readonly bearer: () => Definition;
+    readonly header: (name: string) => Definition;
+    readonly pipe: <A>(f: (self: Credential) => A) => A;
+}
+export interface Definition {
+    readonly apply: (input: AuthInput) => Effect.Effect<Headers.Headers, AuthError>;
+    readonly andThen: (that: Definition) => Definition;
+    readonly orElse: (that: Definition) => Definition;
+    readonly pipe: <A>(f: (self: Definition) => A) => A;
+}
+export declare const isAuth: (input: unknown) => input is Definition;
+export declare const value: (secret: string, source?: string) => Credential;
+export declare const optional: (secret: Secret | undefined, source?: string) => Credential;
+export declare const config: (name: string) => Credential;
+export declare const effect: (load: Effect.Effect<Redacted.Redacted, CredentialError>) => Credential;
+export declare const none: Definition;
+export declare const headers: (input: Headers.Input) => Definition;
+export declare const remove: (name: string) => Definition;
+export declare const custom: (apply: (input: AuthInput) => Effect.Effect<Headers.Headers, AIError>) => Definition;
+export declare const passthrough: Definition;
+export declare function bearer(source: Secret | Credential): Definition;
+export declare const apiKey: typeof bearer;
+export declare function header(name: string): (source: Secret | Credential) => Definition;
+export declare function header(name: string, source: Secret | Credential): Definition;
+export declare function bearerHeader(name: string): (source: Secret | Credential) => Definition;
+export declare function bearerHeader(name: string, source: Secret | Credential): Definition;
+export declare const toEffect: (input: Definition) => (authInput: AuthInput) => Effect.Effect<Headers.Headers, AIError>;
+export * as Auth from "./auth.js";

package/dist/route/auth.js

@@ -0,0 +1,87 @@
+import { Config, Effect, Redacted } from "effect";
+import { Headers } from "effect/unstable/http";
+import { AuthenticationError, InvalidRequestError, AIError } from "../schema/index.js";
+export class MissingCredentialError extends Error {
+    source;
+    _tag = "MissingCredentialError";
+    constructor(source) {
+        super(`Missing auth credential: ${source}`);
+        this.source = source;
+    }
+}
+export const isAuth = (input) => typeof input === "object" && input !== null && "apply" in input && typeof input.apply === "function";
+const credential = (load) => {
+    const self = {
+        load,
+        orElse: (that) => credential(load.pipe(Effect.catch(() => that.load))),
+        bearer: () => fromCredential(self, (secret) => ({ authorization: `Bearer ${secret}` })),
+        header: (name) => fromCredential(self, (secret) => ({ [name]: secret })),
+        pipe: (f) => f(self),
+    };
+    return self;
+};
+const auth = (apply) => {
+    const self = {
+        apply,
+        andThen: (that) => auth((input) => apply(input).pipe(Effect.flatMap((headers) => that.apply({ ...input, headers })))),
+        orElse: (that) => auth((input) => apply(input).pipe(Effect.catch(() => that.apply(input)))),
+        pipe: (f) => f(self),
+    };
+    return self;
+};
+const fromCredential = (source, render) => auth((input) => source.load.pipe(Effect.map((secret) => Headers.setAll(input.headers, render(Redacted.value(secret))))));
+const secretEffect = (secret, source) => {
+    const redacted = typeof secret === "string" ? Redacted.make(secret) : secret;
+    if (Redacted.value(redacted) === "")
+        return Effect.fail(new MissingCredentialError(source));
+    return Effect.succeed(redacted);
+};
+const credentialFromSecret = (secret, source) => {
+    if (typeof secret === "string" || Redacted.isRedacted(secret))
+        return credential(secretEffect(secret, source));
+    return credential(Effect.gen(function* () {
+        return yield* secretEffect(yield* secret, source);
+    }));
+};
+export const value = (secret, source = "value") => credentialFromSecret(secret, source);
+export const optional = (secret, source = "optional value") => secret === undefined
+    ? credential(Effect.fail(new MissingCredentialError(source)))
+    : credentialFromSecret(secret, source);
+export const config = (name) => credentialFromSecret(Config.redacted(name), name);
+export const effect = (load) => credential(load);
+export const none = auth((input) => Effect.succeed(input.headers));
+export const headers = (input) => auth((inputAuth) => Effect.succeed(Headers.setAll(inputAuth.headers, input)));
+export const remove = (name) => auth((input) => Effect.succeed(Headers.remove(input.headers, name)));
+export const custom = (apply) => auth(apply);
+export const passthrough = none;
+const credentialInput = (source) => typeof source === "string" || Redacted.isRedacted(source) || Config.isConfig(source)
+    ? credentialFromSecret(source, "value")
+    : source;
+export function bearer(source) {
+    return credentialInput(source).bearer();
+}
+export const apiKey = bearer;
+export function header(name, source) {
+    if (source === undefined) {
+        return (next) => credentialInput(next).header(name);
+    }
+    return credentialInput(source).header(name);
+}
+export function bearerHeader(name, source) {
+    const render = (input) => fromCredential(credentialInput(input), (secret) => ({ [name]: `Bearer ${secret}` }));
+    if (source === undefined)
+        return render;
+    return render(source);
+}
+const toAIError = (error) => {
+    if (error instanceof MissingCredentialError || error instanceof Config.ConfigError) {
+        return new AIError({
+            reason: error instanceof MissingCredentialError
+                ? new AuthenticationError({ message: error.message, cause: error })
+                : new InvalidRequestError({ message: `Failed to resolve auth config: ${error.message}`, cause: error }),
+        });
+    }
+    return error;
+};
+export const toEffect = (input) => (authInput) => input.apply(authInput).pipe(Effect.mapError(toAIError));
+export * as Auth from "./auth.js";

package/dist/route/client.d.ts

@@ -0,0 +1,430 @@
+import { Context, Effect, Layer, Schema, Stream } from "effect";
+import { Auth } from "./auth.js";
+import { Endpoint, type EndpointPatch } from "./endpoint.js";
+import { RequestExecutor } from "./executor.js";
+import { Framing } from "./framing.js";
+import { HttpTransport } from "./transport/index.js";
+import type { HttpMiddleware, Transport, TransportRuntime, WebSocketChannelExecutor } from "./transport/index.js";
+import type { Protocol } from "./protocol.js";
+import type { ProtocolID, ProviderOptions } from "../schema/index.js";
+import { AIError, CompactionResponse, CompactionCheckpointResponse, GenerationOptions, HttpOptions, LLMRequest, LLMResponse, LanguageModel, LLMEvent, ProviderID } from "../schema/index.js";
+export interface RouteBody<Body> {
+    /** Schema for the validated provider-native body sent as the JSON request. */
+    readonly schema: Schema.Codec<Body, unknown>;
+    /** Build the provider-native body from a common `LLMRequest`. */
+    readonly from: (request: LLMRequest) => Effect.Effect<Body, AIError>;
+}
+export interface Route<Body, Prepared = unknown, Compact extends CompactionOperations | undefined = CompactionOperations | undefined> {
+    readonly compact: Compact;
+    readonly id: string;
+    readonly provider?: ProviderID;
+    /** ProviderMetadata namespace emitted and consumed by this route. */
+    readonly providerMetadataKey?: string;
+    readonly protocol: ProtocolID;
+    readonly endpoint: Endpoint.Definition<Body>;
+    readonly auth: Auth.Definition;
+    /** Deployment headers resolved once for every operation, before transport authentication. */
+    readonly headers?: (input: {
+        readonly request: LLMRequest;
+    }) => Record<string, string>;
+    readonly transport: Transport<Body, Prepared, unknown>;
+    readonly defaults: RouteDefaults;
+    readonly body: RouteBody<Body>;
+    readonly with: {
+        <Next extends CompactionOperations | undefined>(patch: RoutePatch<Body, Prepared> & {
+            readonly compact: Next;
+        }): Route<Body, Prepared, Next>;
+        (patch: Omit<RoutePatch<Body, Prepared>, "compact"> & {
+            readonly compact?: undefined;
+        }): Route<Body, Prepared, Compact>;
+        (patch: RoutePatch<Body, Prepared>): Route<Body, Prepared>;
+    };
+    readonly model: <Options extends ProviderOptions = ProviderOptions>(input: RouteMappedLanguageModelInput) => LanguageModel<Options, Compact>;
+    readonly prepareTransport: (body: Body, request: LLMRequest, options?: StreamOptions) => Effect.Effect<Prepared, AIError>;
+    readonly streamPrepared: (prepared: Prepared, request: LLMRequest, runtime: TransportRuntime, options?: StreamOptions) => Stream.Stream<LLMEvent, AIError>;
+}
+export type AnyRoute<Compact extends CompactionOperations | undefined = CompactionOperations | undefined> = Route<any, any, Compact>;
+export type HttpOptionsInput = HttpOptions.Input;
+export type RouteLanguageModelInput = Omit<LanguageModel.Input, "provider" | "route">;
+export type RouteRoutedLanguageModelInput = Omit<LanguageModel.Input, "route">;
+export interface RouteDefaults {
+    readonly headers?: Record<string, string>;
+    readonly generation?: GenerationOptions;
+    readonly providerOptions?: ProviderOptions;
+    readonly http?: HttpOptions;
+}
+export interface RouteDefaultsInput {
+    readonly headers?: Record<string, string>;
+    readonly generation?: GenerationOptions.Input;
+    readonly providerOptions?: ProviderOptions;
+    readonly http?: HttpOptions.Input;
+}
+export interface RoutePatch<Body, Prepared> extends RouteDefaultsInput {
+    readonly compact?: CompactionOperations;
+    readonly id?: string;
+    readonly provider?: string | ProviderID;
+    readonly providerMetadataKey?: string;
+    readonly auth?: Auth.Definition;
+    readonly transport?: Transport<Body, Prepared, unknown>;
+    readonly endpoint?: EndpointPatch<Body>;
+}
+type RouteMappedLanguageModelInput = RouteLanguageModelInput | RouteRoutedLanguageModelInput;
+export declare const generationOptions: (input: GenerationOptions.Input | undefined) => GenerationOptions | undefined;
+export declare const httpOptions: (input: HttpOptionsInput | undefined) => HttpOptions | undefined;
+export interface Interface {
+    readonly compact: CompactMethod;
+    readonly stream: StreamMethod;
+    readonly generate: GenerateMethod;
+}
+export interface StreamOptions {
+    readonly http?: HttpMiddleware;
+    readonly webSocket?: WebSocketChannelExecutor;
+}
+export interface StreamMethod {
+    (request: LLMRequest, options?: StreamOptions): Stream.Stream<LLMEvent, AIError>;
+}
+export interface GenerateMethod {
+    (request: LLMRequest, options?: StreamOptions): Effect.Effect<LLMResponse, AIError>;
+}
+export type CompactOperation = (request: LLMRequest, executor: RequestExecutor.Interface, options?: Pick<StreamOptions, "http">) => Effect.Effect<CompactionResponse, AIError>;
+export type TriggerCompactOperation = (request: LLMRequest, executor: RequestExecutor.Interface, options: TriggerCompactOptions) => Effect.Effect<CompactionCheckpointResponse, AIError>;
+/** Protocol capabilities, not deployment/model eligibility. */
+export interface CompactionOperations {
+    readonly endpoint?: CompactOperation;
+    readonly trigger?: TriggerCompactOperation;
+}
+export interface EndpointCompactOptions extends Pick<StreamOptions, "http"> {
+    readonly mechanism?: "endpoint";
+    readonly webSocket?: never;
+}
+export interface TriggerCompactOptions extends StreamOptions {
+    readonly mechanism: "trigger";
+}
+export type CompactionRequest = LLMRequest & {
+    readonly model: LanguageModel<ProviderOptions, {
+        readonly endpoint: CompactOperation;
+    }>;
+};
+export type CheckpointRequest = LLMRequest & {
+    readonly model: LanguageModel<ProviderOptions, {
+        readonly trigger: TriggerCompactOperation;
+    }>;
+};
+export interface CompactMethod<R = never> {
+    (request: CheckpointRequest, options: TriggerCompactOptions): Effect.Effect<CompactionCheckpointResponse, AIError, R>;
+    (request: CompactionRequest, options?: EndpointCompactOptions): Effect.Effect<CompactionResponse, AIError, R>;
+}
+export declare function canCompact(request: LLMRequest, options?: {
+    readonly mechanism?: "endpoint";
+}): request is CompactionRequest;
+export declare function canCompact(request: LLMRequest, options: {
+    readonly mechanism: "trigger";
+}): request is CheckpointRequest;
+declare const Service_base: Context.ServiceClass<Service, "@opencode/LLMClient", Interface>;
+export declare class Service extends Service_base {
+}
+export interface MakeInput<Body, Frame, Event, State> {
+    readonly compact?: CompactionOperations;
+    /** Route id used in diagnostics and prepared request metadata. */
+    readonly id: string;
+    /** Provider identity for route-owned model construction. */
+    readonly provider?: string | ProviderID;
+    /** ProviderMetadata namespace emitted and consumed by this route. */
+    readonly providerMetadataKey?: string;
+    /** Semantic API contract — owns body construction, body schema, and parsing. */
+    readonly protocol: Protocol<Body, Frame, Event, State>;
+    /** Where the request is sent. */
+    readonly endpoint: Endpoint.Definition<Body>;
+    /** Per-request transport auth. Provider facades override this via `route.with(...)`. */
+    readonly auth?: Auth.Definition;
+    /** Stream framing — bytes -> frames before `protocol.stream.event` decoding. */
+    readonly framing: Framing.Definition<Frame>;
+    /** Static / per-request headers added before `auth` runs. */
+    readonly headers?: (input: {
+        readonly request: LLMRequest;
+    }) => Record<string, string>;
+    /** Route/request defaults used when compiling requests for this route. */
+    readonly defaults?: RouteDefaultsInput;
+}
+export interface MakeTransportInput<Body, Prepared, Frame, Event, State> {
+    readonly compact?: CompactionOperations;
+    /** Route id used in diagnostics and prepared request metadata. */
+    readonly id: string;
+    /** Provider identity for route-owned model construction. */
+    readonly provider?: string | ProviderID;
+    /** ProviderMetadata namespace emitted and consumed by this route. */
+    readonly providerMetadataKey?: string;
+    /** Semantic API contract — owns body construction, body schema, and parsing. */
+    readonly protocol: Protocol<Body, Frame, Event, State>;
+    /** Where the request is sent. */
+    readonly endpoint: Endpoint.Definition<Body>;
+    /** Per-request transport auth. Provider facades override this via `route.with(...)`. */
+    readonly auth?: Auth.Definition;
+    /** Static / per-request headers added before `auth` runs. */
+    readonly headers?: (input: {
+        readonly request: LLMRequest;
+    }) => Record<string, string>;
+    /** Runnable transport route. */
+    readonly transport: Transport<Body, Prepared, Frame>;
+    /** Route/request defaults used when compiling requests for this route. */
+    readonly defaults?: RouteDefaultsInput;
+}
+export declare function make<Body, Prepared, Frame, Event, State, Compact extends CompactionOperations>(input: MakeTransportInput<Body, Prepared, Frame, Event, State> & {
+    readonly compact: Compact;
+}): Route<Body, Prepared, Compact>;
+export declare function make<Body, Frame, Event, State, Compact extends CompactionOperations>(input: MakeInput<Body, Frame, Event, State> & {
+    readonly compact: Compact;
+}): Route<Body, HttpTransport.HttpPrepared<Frame>, Compact>;
+export declare function make<Body, Prepared, Frame, Event, State>(input: MakeTransportInput<Body, Prepared, Frame, Event, State>): Route<Body, Prepared>;
+/**
+ * Build a `Route` by composing the four orthogonal pieces of a deployment:
+ *
+ * - `Protocol` — what is the API I'm speaking?
+ * - `Endpoint` — where do I send the request?
+ * - `Auth` — how do I authenticate it?
+ * - `Framing` — how do I cut the response stream into protocol frames?
+ *
+ * Plus optional `headers` for cross-cutting deployment concerns (provider
+ * version pins, per-deployment quirks).
+ *
+ * This is the canonical route constructor. If a new route does not fit
+ * this four-axis model, add a purpose-built constructor rather than widening
+ * the public surface preemptively.
+ */
+export declare function make<Body, Frame, Event, State>(input: MakeInput<Body, Frame, Event, State>): Route<Body, HttpTransport.HttpPrepared<Frame>>;
+/** @internal Test-only projection of the execution compiler; not exported from package barrels. */
+export declare const compileRequest: (request: LLMRequest<LanguageModel<{
+    readonly [x: string]: unknown;
+}, CompactionOperations | undefined>>) => Effect.Effect<{
+    id: string;
+    route: string;
+    protocol: string;
+    model: LanguageModel<{
+        readonly [x: string]: unknown;
+    }, CompactionOperations | undefined>;
+    body: any;
+    metadata: {
+        transport: string;
+    };
+}, AIError, never>;
+export declare function stream(request: LLMRequest, options?: StreamOptions): Stream.Stream<LLMEvent, AIError, Service>;
+export declare function generate(request: LLMRequest, options?: StreamOptions): Effect.Effect<LLMResponse, AIError, Service>;
+export declare function compact(request: CheckpointRequest, options: TriggerCompactOptions): Effect.Effect<CompactionCheckpointResponse, AIError, Service>;
+export declare function compact(request: CompactionRequest, options?: EndpointCompactOptions): Effect.Effect<CompactionResponse, AIError, Service>;
+export declare const streamRequest: (request: LLMRequest, options?: StreamOptions) => Stream.Stream<({
+    readonly type: "compaction";
+    readonly provider: string & import("effect/Brand").Brand<"AI.ProviderID">;
+    readonly id?: string | undefined;
+    readonly text?: string | null | undefined;
+    readonly encrypted?: string | undefined;
+} & ({
+    readonly encrypted: string;
+    readonly text?: never;
+} | {
+    readonly text: string | null;
+    readonly encrypted?: never;
+})) | {
+    readonly type: "step-start";
+    readonly index: number;
+} | {
+    readonly id: string;
+    readonly type: "text-start";
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+} | {
+    readonly id: string;
+    readonly type: "text-delta";
+    readonly text: string;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+} | {
+    readonly id: string;
+    readonly type: "text-end";
+    readonly text?: string | undefined;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+} | {
+    readonly id: string;
+    readonly type: "reasoning-start";
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+} | {
+    readonly id: string;
+    readonly type: "reasoning-delta";
+    readonly text: string;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+} | {
+    readonly id: string;
+    readonly type: "reasoning-end";
+    readonly text?: string | undefined;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+} | {
+    readonly id: string;
+    readonly type: "tool-input-start";
+    readonly name: string;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+    readonly namespace?: string | undefined;
+    readonly providerExecuted?: boolean | undefined;
+} | {
+    readonly id: string;
+    readonly type: "tool-input-delta";
+    readonly name: string;
+    readonly text: string;
+    readonly input?: unknown;
+    readonly namespace?: string | undefined;
+} | {
+    readonly id: string;
+    readonly type: "tool-input-end";
+    readonly name: string;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+    readonly namespace?: string | undefined;
+} | {
+    readonly id: string;
+    readonly type: "tool-input-error";
+    readonly name: string;
+    readonly raw: string;
+    readonly namespace?: string | undefined;
+} | {
+    readonly id: string;
+    readonly type: "tool-call";
+    readonly name: string;
+    readonly input: unknown;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+    readonly namespace?: string | undefined;
+    readonly providerExecuted?: boolean | undefined;
+} | {
+    readonly id: string;
+    readonly type: "tool-result";
+    readonly name: string;
+    readonly result: {
+        readonly type: "json";
+        readonly value: unknown;
+    } | {
+        readonly type: "text";
+        readonly value: unknown;
+    } | {
+        readonly type: "error";
+        readonly value: unknown;
+    } | {
+        readonly type: "content";
+        readonly value: readonly ({
+            readonly type: "text";
+            readonly text: string;
+        } | {
+            readonly type: "file";
+            readonly uri: string;
+            readonly mime: string;
+            readonly name?: string | undefined;
+        })[];
+    };
+    readonly output?: {
+        readonly structured: unknown;
+        readonly content: readonly ({
+            readonly type: "text";
+            readonly text: string;
+        } | {
+            readonly type: "file";
+            readonly uri: string;
+            readonly mime: string;
+            readonly name?: string | undefined;
+        })[];
+    } | undefined;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+    readonly namespace?: string | undefined;
+    readonly providerExecuted?: boolean | undefined;
+} | {
+    readonly id: string;
+    readonly type: "tool-error";
+    readonly name: string;
+    readonly message: string;
+    readonly error?: unknown;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+    readonly namespace?: string | undefined;
+} | {
+    readonly type: "step-finish";
+    readonly reason: {
+        readonly normalized: "length" | "stop" | "tool-calls" | "content-filter" | "error" | "unknown";
+        readonly raw?: string | undefined;
+    };
+    readonly index: number;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+    readonly usage?: import("../schema/events.js").Usage | undefined;
+} | {
+    readonly type: "finish";
+    readonly reason: {
+        readonly normalized: "length" | "stop" | "tool-calls" | "content-filter" | "error" | "unknown";
+        readonly raw?: string | undefined;
+    };
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+    readonly usage?: import("../schema/events.js").Usage | undefined;
+} | {
+    readonly type: "provider-error";
+    readonly message: string;
+    readonly providerMetadata?: {
+        readonly [x: string]: {
+            readonly [x: string]: unknown;
+        };
+    } | undefined;
+    readonly classification?: "context-overflow" | "payload-too-large" | undefined;
+}, AIError, Service>;
+export declare const layer: Layer.Layer<Service, never, RequestExecutor.Service>;
+export declare const Route: {
+    readonly make: typeof make;
+};
+export declare const LLMClient: {
+    readonly canCompact: typeof canCompact;
+    readonly compact: typeof compact;
+    readonly Service: typeof Service;
+    readonly layer: Layer.Layer<Service, never, RequestExecutor.Service>;
+    readonly stream: typeof stream;
+    readonly generate: typeof generate;
+};
+export {};