ai-sdk-provider-goose 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,162 @@
+import { LanguageModelV3, LanguageModelV3CallOptions, LanguageModelV3GenerateResult, LanguageModelV3StreamResult, ProviderV3, APICallError } from '@ai-sdk/provider';
+
+/**
+ * Settings for configuring the Goose language model provider.
+ */
+interface GooseSettings {
+    /**
+     * Path to the Goose binary.
+     * @default 'goose'
+     */
+    binPath?: string;
+    /**
+     * Additional CLI arguments to pass to Goose.
+     * @example ['--profile', 'custom']
+     */
+    args?: string[];
+    /**
+     * Timeout for the entire request in milliseconds.
+     * @default 120000 (2 minutes)
+     */
+    timeout?: number;
+    /**
+     * Logger instance for debugging.
+     */
+    logger?: Logger;
+    /**
+     * Session name for the conversation.
+     * When provided, adds --name flag to the CLI.
+     * @example 'my-session'
+     */
+    sessionName?: string;
+    /**
+     * Whether to resume an existing session.
+     * When true, adds --resume flag to the CLI.
+     * Requires sessionName to be set.
+     * @default false
+     */
+    resume?: boolean;
+}
+/**
+ * Logger interface for debugging.
+ */
+interface Logger {
+    debug(message: string, ...args: any[]): void;
+    info(message: string, ...args: any[]): void;
+    warn(message: string, ...args: any[]): void;
+    error(message: string, ...args: any[]): void;
+}
+
+type GooseModelId = 'goose' | (string & {});
+interface GooseLanguageModelOptions {
+    id: GooseModelId;
+    settings?: GooseSettings;
+}
+/**
+ * Goose CLI language model implementation for AI SDK.
+ */
+declare class GooseLanguageModel implements LanguageModelV3 {
+    readonly specificationVersion: "v3";
+    readonly provider = "goose";
+    readonly modelId: string;
+    readonly supportedUrls: {};
+    private settings;
+    private logger?;
+    constructor(options: GooseLanguageModelOptions);
+    doGenerate(options: LanguageModelV3CallOptions): Promise<LanguageModelV3GenerateResult>;
+    doStream(options: LanguageModelV3CallOptions): Promise<LanguageModelV3StreamResult>;
+    private buildCLIArgs;
+    private spawnGooseProcess;
+    private createStreamFromProcess;
+    private convertPromptToText;
+    private eventsToGenerateResult;
+}
+
+/**
+ * Goose provider interface extending AI SDK ProviderV3.
+ */
+interface GooseProvider extends ProviderV3 {
+    /**
+     * Create a language model (callable shorthand).
+     */
+    (modelId: GooseModelId, settings?: GooseSettings): LanguageModelV3;
+    /**
+     * Create a language model.
+     */
+    languageModel(modelId: GooseModelId, settings?: GooseSettings): LanguageModelV3;
+    /**
+     * Alias for languageModel (follows AI SDK pattern).
+     */
+    chat(modelId: GooseModelId, settings?: GooseSettings): LanguageModelV3;
+    /**
+     * Embedding models are not supported.
+     */
+    embeddingModel(modelId: string): never;
+    /**
+     * Image models are not supported.
+     */
+    imageModel(modelId: string): never;
+}
+/**
+ * Provider-level settings for Goose.
+ */
+interface GooseProviderSettings extends GooseSettings {
+}
+/**
+ * Creates a Goose provider with the specified settings.
+ *
+ * @param settings Provider-level settings
+ * @returns Goose provider instance
+ *
+ * @example
+ * ```typescript
+ * import { createGoose } from 'ai-sdk-provider-goose';
+ *
+ * const provider = createGoose({
+ *   binPath: '/path/to/goose',
+ *   timeout: 60000,
+ * });
+ *
+ * const model = provider('goose');
+ * ```
+ */
+declare function createGoose(settings?: GooseProviderSettings): GooseProvider;
+/**
+ * Default Goose provider instance.
+ *
+ * @example
+ * ```typescript
+ * import { goose } from 'ai-sdk-provider-goose';
+ * import { generateText } from 'ai';
+ *
+ * const result = await generateText({
+ *   model: goose('goose'),
+ *   prompt: 'Hello!',
+ * });
+ * ```
+ */
+declare const goose: GooseProvider;
+
+/**
+ * Metadata attached to errors from the Goose CLI provider.
+ */
+interface GooseErrorMetadata {
+    binPath?: string;
+    args?: string[];
+    exitCode?: number;
+    stderr?: string;
+}
+/**
+ * Creates a general API call error.
+ */
+declare function createAPICallError(message: string, metadata?: GooseErrorMetadata): APICallError;
+/**
+ * Creates a timeout error (retryable).
+ */
+declare function createTimeoutError(timeoutMs: number, metadata?: GooseErrorMetadata): APICallError;
+/**
+ * Creates a process error for non-zero exit codes.
+ */
+declare function createProcessError(message: string, exitCode: number, stderr: string, metadata?: GooseErrorMetadata): APICallError;
+
+export { type GooseErrorMetadata, GooseLanguageModel, type GooseLanguageModelOptions, type GooseModelId, type GooseProvider, type GooseProviderSettings, type GooseSettings, type Logger, createAPICallError, createGoose, createProcessError, createTimeoutError, goose };

package/dist/index.d.ts

@@ -0,0 +1,162 @@
+import { LanguageModelV3, LanguageModelV3CallOptions, LanguageModelV3GenerateResult, LanguageModelV3StreamResult, ProviderV3, APICallError } from '@ai-sdk/provider';
+
+/**
+ * Settings for configuring the Goose language model provider.
+ */
+interface GooseSettings {
+    /**
+     * Path to the Goose binary.
+     * @default 'goose'
+     */
+    binPath?: string;
+    /**
+     * Additional CLI arguments to pass to Goose.
+     * @example ['--profile', 'custom']
+     */
+    args?: string[];
+    /**
+     * Timeout for the entire request in milliseconds.
+     * @default 120000 (2 minutes)
+     */
+    timeout?: number;
+    /**
+     * Logger instance for debugging.
+     */
+    logger?: Logger;
+    /**
+     * Session name for the conversation.
+     * When provided, adds --name flag to the CLI.
+     * @example 'my-session'
+     */
+    sessionName?: string;
+    /**
+     * Whether to resume an existing session.
+     * When true, adds --resume flag to the CLI.
+     * Requires sessionName to be set.
+     * @default false
+     */
+    resume?: boolean;
+}
+/**
+ * Logger interface for debugging.
+ */
+interface Logger {
+    debug(message: string, ...args: any[]): void;
+    info(message: string, ...args: any[]): void;
+    warn(message: string, ...args: any[]): void;
+    error(message: string, ...args: any[]): void;
+}
+
+type GooseModelId = 'goose' | (string & {});
+interface GooseLanguageModelOptions {
+    id: GooseModelId;
+    settings?: GooseSettings;
+}
+/**
+ * Goose CLI language model implementation for AI SDK.
+ */
+declare class GooseLanguageModel implements LanguageModelV3 {
+    readonly specificationVersion: "v3";
+    readonly provider = "goose";
+    readonly modelId: string;
+    readonly supportedUrls: {};
+    private settings;
+    private logger?;
+    constructor(options: GooseLanguageModelOptions);
+    doGenerate(options: LanguageModelV3CallOptions): Promise<LanguageModelV3GenerateResult>;
+    doStream(options: LanguageModelV3CallOptions): Promise<LanguageModelV3StreamResult>;
+    private buildCLIArgs;
+    private spawnGooseProcess;
+    private createStreamFromProcess;
+    private convertPromptToText;
+    private eventsToGenerateResult;
+}
+
+/**
+ * Goose provider interface extending AI SDK ProviderV3.
+ */
+interface GooseProvider extends ProviderV3 {
+    /**
+     * Create a language model (callable shorthand).
+     */
+    (modelId: GooseModelId, settings?: GooseSettings): LanguageModelV3;
+    /**
+     * Create a language model.
+     */
+    languageModel(modelId: GooseModelId, settings?: GooseSettings): LanguageModelV3;
+    /**
+     * Alias for languageModel (follows AI SDK pattern).
+     */
+    chat(modelId: GooseModelId, settings?: GooseSettings): LanguageModelV3;
+    /**
+     * Embedding models are not supported.
+     */
+    embeddingModel(modelId: string): never;
+    /**
+     * Image models are not supported.
+     */
+    imageModel(modelId: string): never;
+}
+/**
+ * Provider-level settings for Goose.
+ */
+interface GooseProviderSettings extends GooseSettings {
+}
+/**
+ * Creates a Goose provider with the specified settings.
+ *
+ * @param settings Provider-level settings
+ * @returns Goose provider instance
+ *
+ * @example
+ * ```typescript
+ * import { createGoose } from 'ai-sdk-provider-goose';
+ *
+ * const provider = createGoose({
+ *   binPath: '/path/to/goose',
+ *   timeout: 60000,
+ * });
+ *
+ * const model = provider('goose');
+ * ```
+ */
+declare function createGoose(settings?: GooseProviderSettings): GooseProvider;
+/**
+ * Default Goose provider instance.
+ *
+ * @example
+ * ```typescript
+ * import { goose } from 'ai-sdk-provider-goose';
+ * import { generateText } from 'ai';
+ *
+ * const result = await generateText({
+ *   model: goose('goose'),
+ *   prompt: 'Hello!',
+ * });
+ * ```
+ */
+declare const goose: GooseProvider;
+
+/**
+ * Metadata attached to errors from the Goose CLI provider.
+ */
+interface GooseErrorMetadata {
+    binPath?: string;
+    args?: string[];
+    exitCode?: number;
+    stderr?: string;
+}
+/**
+ * Creates a general API call error.
+ */
+declare function createAPICallError(message: string, metadata?: GooseErrorMetadata): APICallError;
+/**
+ * Creates a timeout error (retryable).
+ */
+declare function createTimeoutError(timeoutMs: number, metadata?: GooseErrorMetadata): APICallError;
+/**
+ * Creates a process error for non-zero exit codes.
+ */
+declare function createProcessError(message: string, exitCode: number, stderr: string, metadata?: GooseErrorMetadata): APICallError;
+
+export { type GooseErrorMetadata, GooseLanguageModel, type GooseLanguageModelOptions, type GooseModelId, type GooseProvider, type GooseProviderSettings, type GooseSettings, type Logger, createAPICallError, createGoose, createProcessError, createTimeoutError, goose };