@ever-works/openai-plugin 1.0.0 → 1.0.2

package/dist/index.d.cts

@@ -0,0 +1,48 @@
+import { BaseAiProvider } from '@ever-works/plugin/abstract';
+import { JsonSchema, PluginContext, ChatCompletionOptions, ChatCompletionResponse, ChatCompletionChunk, EmbeddingOptions, EmbeddingResponse, TranscriptionOptions, TranscriptionResponse, PluginSettings, AiModel, AiModelCapabilities, PluginHealthCheck, PluginManifest } from '@ever-works/plugin';
+
+/**
+ * OpenAI AI provider plugin
+ *
+ * Provides AI capabilities through OpenAI's API.
+ * Uses 'user-required' configuration mode - users MUST provide their own API key.
+ */
+declare class OpenAiPlugin extends BaseAiProvider {
+    readonly id = "openai";
+    readonly name = "OpenAI";
+    readonly version = "1.0.0";
+    readonly providerType = "openai";
+    readonly providerName = "OpenAI";
+    readonly configurationMode: 'admin-only' | 'user-required' | 'hybrid';
+    readonly settingsSchema: JsonSchema;
+    onLoad(context: PluginContext): Promise<void>;
+    onUnload(): Promise<void>;
+    createChatCompletion(options: ChatCompletionOptions): Promise<ChatCompletionResponse>;
+    createStreamingChatCompletion(options: ChatCompletionOptions): AsyncIterable<ChatCompletionChunk>;
+    createEmbedding(options: EmbeddingOptions): Promise<EmbeddingResponse>;
+    /**
+     * Whisper-backed speech-to-text. Wraps OpenAI's `/v1/audio/transcriptions`
+     * REST endpoint directly with `fetch` + `FormData` so the plugin avoids
+     * pulling the heavy `openai` SDK just for this code path (we already do
+     * everything else via LangChain).
+     *
+     * The handler accepts any of the three binary shapes the KB ingest task
+     * forwards — Web ReadableStream (from the upload route), Node Buffer (from
+     * the Trigger.dev local runner), or Uint8Array (from tests). We normalize
+     * to a Blob before constructing the multipart body so the OpenAI server's
+     * MIME sniffer sees a real file part with the original filename.
+     *
+     * Disabled-by-omission: when `apiKey` is unset the call throws — the
+     * facade catches and falls through to the next provider in the chain.
+     */
+    transcribe(options: TranscriptionOptions): Promise<TranscriptionResponse>;
+    private normaliseAudioInput;
+    private detectMimeFromName;
+    listModels(settings?: PluginSettings): Promise<readonly AiModel[]>;
+    getCapabilities(): AiModelCapabilities;
+    protected getDefaultModelId(): string;
+    healthCheck(): Promise<PluginHealthCheck>;
+    getManifest(): PluginManifest;
+}
+
+export { OpenAiPlugin, OpenAiPlugin as default };

package/dist/index.d.ts

@@ -0,0 +1,48 @@
+import { BaseAiProvider } from '@ever-works/plugin/abstract';
+import { JsonSchema, PluginContext, ChatCompletionOptions, ChatCompletionResponse, ChatCompletionChunk, EmbeddingOptions, EmbeddingResponse, TranscriptionOptions, TranscriptionResponse, PluginSettings, AiModel, AiModelCapabilities, PluginHealthCheck, PluginManifest } from '@ever-works/plugin';
+
+/**
+ * OpenAI AI provider plugin
+ *
+ * Provides AI capabilities through OpenAI's API.
+ * Uses 'user-required' configuration mode - users MUST provide their own API key.
+ */
+declare class OpenAiPlugin extends BaseAiProvider {
+    readonly id = "openai";
+    readonly name = "OpenAI";
+    readonly version = "1.0.0";
+    readonly providerType = "openai";
+    readonly providerName = "OpenAI";
+    readonly configurationMode: 'admin-only' | 'user-required' | 'hybrid';
+    readonly settingsSchema: JsonSchema;
+    onLoad(context: PluginContext): Promise<void>;
+    onUnload(): Promise<void>;
+    createChatCompletion(options: ChatCompletionOptions): Promise<ChatCompletionResponse>;
+    createStreamingChatCompletion(options: ChatCompletionOptions): AsyncIterable<ChatCompletionChunk>;
+    createEmbedding(options: EmbeddingOptions): Promise<EmbeddingResponse>;
+    /**
+     * Whisper-backed speech-to-text. Wraps OpenAI's `/v1/audio/transcriptions`
+     * REST endpoint directly with `fetch` + `FormData` so the plugin avoids
+     * pulling the heavy `openai` SDK just for this code path (we already do
+     * everything else via LangChain).
+     *
+     * The handler accepts any of the three binary shapes the KB ingest task
+     * forwards — Web ReadableStream (from the upload route), Node Buffer (from
+     * the Trigger.dev local runner), or Uint8Array (from tests). We normalize
+     * to a Blob before constructing the multipart body so the OpenAI server's
+     * MIME sniffer sees a real file part with the original filename.
+     *
+     * Disabled-by-omission: when `apiKey` is unset the call throws — the
+     * facade catches and falls through to the next provider in the chain.
+     */
+    transcribe(options: TranscriptionOptions): Promise<TranscriptionResponse>;
+    private normaliseAudioInput;
+    private detectMimeFromName;
+    listModels(settings?: PluginSettings): Promise<readonly AiModel[]>;
+    getCapabilities(): AiModelCapabilities;
+    protected getDefaultModelId(): string;
+    healthCheck(): Promise<PluginHealthCheck>;
+    getManifest(): PluginManifest;
+}
+
+export { OpenAiPlugin, OpenAiPlugin as default };