@mushinjs/plugin-providers 0.0.0-stage → 0.2.0-next.20261112165327

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Setobox
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/index.d.ts

@@ -0,0 +1,188 @@
+import { ChatRequest, ChatResponse, ContentPart, DecisionAnswer, DecisionAsset, DecisionQuestion, DecisionRequest, DecisionResponse, DecisionText, EmbedRequest, EmbedResponse, FinishReason, LlmChatOptions, LlmDecideOptions, LlmDecideResult, LlmEmbedOptions, LlmEmbedResult, LlmMessage, LlmResult, ModelProfile, ProfileModel, ProviderCapability, ProviderClient, ProviderPreset, ProviderRecord, ProviderTest, ProviderType, RawTurn, StreamEvent, ToolCall, ToolDefinition, Usage } from "./types.js";
+import { Context, Service, z } from "@mushinjs/core";
+declare module '@mushinjs/core' {
+  interface Context {
+    llm: LlmService;
+  }
+  interface Events {
+    'providers/changed'(): void;
+    'llm/called'(call: LlmCall): void;
+  }
+}
+/** One finished model request, for usage statistics. */
+export interface LlmCall {
+  provider: string;
+  providerName: string;
+  model: string;
+  ok: boolean;
+  inputTokens?: number;
+  outputTokens?: number;
+  latencyMs: number;
+}
+/** Most texts sent in one embedding request. */
+export declare const EMBED_BATCH = 64;
+declare const providerInput: z.ZodObject<{
+  name: z.ZodString;
+  type: z.ZodString;
+  config: z.ZodRecord<z.ZodString, z.ZodAny>;
+  models: z.ZodOptional<z.ZodArray<z.ZodString>>;
+  defaultModel: z.ZodOptional<z.ZodString>;
+  isDefault: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strip>;
+declare const profileInput: z.ZodObject<{
+  name: z.ZodString;
+  models: z.ZodArray<z.ZodObject<{
+    provider: z.ZodString;
+    model: z.ZodString;
+  }, z.core.$strip>>;
+}, z.core.$strip>;
+/**
+ * Owns provider records and exposes one `chat` entry point.
+ * Provider types (OpenAI-compatible, Anthropic, ...) are registered by other plugins.
+ */
+export declare class LlmService extends Service {
+  static inject: string[];
+  private home;
+  private typeStore;
+  private records;
+  private profileRecords;
+  private clients;
+  constructor(ctx: Context);
+  /** Provider lifecycle lines, tagged `provider` in the dashboard. Never includes config values. */
+  private get logger();
+  [Service.init](): AsyncGenerator<import("cordis").Disposable<Promise<void>>, void, unknown>;
+  /** Registers a provider type. It is removed when the calling plugin unloads. */
+  defineType<C>(type: ProviderType<C>): import("cordis").Disposable<Promise<void>>;
+  types(): {
+    id: string;
+    displayName: import("@mushinjs/core").LocalizedText;
+    configSchema: import("@mushinjs/core").JsonSchema;
+    secrets: string[];
+    presets: ProviderPreset[];
+    capabilities: ProviderCapability[];
+  }[];
+  list(): {
+    config: {
+      [x: string]: any;
+    };
+    typeAvailable: boolean;
+    capabilities: ProviderCapability[];
+    id: string;
+    name: string;
+    type: string;
+    models: string[];
+    defaultModel?: string;
+    isDefault?: boolean;
+    lastTest?: ProviderTest;
+    createdAt: number;
+  }[];
+  get(id: string): ProviderRecord;
+  /** What a saved provider can do. A record whose type is not loaded counts as a chat provider. */
+  capabilities(record: ProviderRecord): ProviderCapability[];
+  supports(record: ProviderRecord, capability: ProviderCapability): boolean;
+  /** The default provider that can do `capability`, or the first such one if none is marked default. */
+  defaultProvider(capability?: ProviderCapability): ProviderRecord;
+  /** True when at least one chat provider has passed its connection test. */
+  isReady(): boolean;
+  private redact;
+  private requireType;
+  private validateConfig;
+  private save;
+  create(input: z.infer<typeof providerInput>): Promise<{
+    config: {
+      [x: string]: any;
+    };
+    typeAvailable: boolean;
+    capabilities: ProviderCapability[];
+    id: string;
+    name: string;
+    type: string;
+    models: string[];
+    defaultModel?: string;
+    isDefault?: boolean;
+    lastTest?: ProviderTest;
+    createdAt: number;
+  }>;
+  update(id: string, patch: Partial<z.infer<typeof providerInput>>): Promise<{
+    config: {
+      [x: string]: any;
+    };
+    typeAvailable: boolean;
+    capabilities: ProviderCapability[];
+    id: string;
+    name: string;
+    type: string;
+    models: string[];
+    defaultModel?: string;
+    isDefault?: boolean;
+    lastTest?: ProviderTest;
+    createdAt: number;
+  }>;
+  delete(id: string): Promise<{
+    deleted: string;
+  }>;
+  private markDefault;
+  /** Log lines name a provider by its id; the dashboard links it to the provider. */
+  private label;
+  setDefault(id: string): Promise<{
+    config: {
+      [x: string]: any;
+    };
+    typeAvailable: boolean;
+    capabilities: ProviderCapability[];
+    id: string;
+    name: string;
+    type: string;
+    models: string[];
+    defaultModel?: string;
+    isDefault?: boolean;
+    lastTest?: ProviderTest;
+    createdAt: number;
+  }>;
+  profiles(): ModelProfile[];
+  getProfile(id: string): ModelProfile;
+  isProfile(id: string): boolean;
+  private checkProfileModels;
+  createProfile(input: z.infer<typeof profileInput>): Promise<ModelProfile>;
+  updateProfile(id: string, patch: Partial<z.infer<typeof profileInput>>): Promise<ModelProfile>;
+  deleteProfile(id: string): Promise<{
+    deleted: string;
+  }>;
+  /** Providers and profiles as `{ value, label }`, for fields that take either. */
+  choices(): {
+    value: string;
+    label: string;
+    group: string;
+  }[];
+  client(record: ProviderRecord): ProviderClient;
+  private resolve;
+  /** Where a request goes: one provider and model, or a profile's models in order. */
+  private targets;
+  /** Logs a failed model of a profile and says whether to try the next one. */
+  private fallBack;
+  /** Counts a request against the message being handled, if any; see `usage` in core. */
+  private report;
+  private result;
+  /** Runs one chat completion through the chosen (or default) provider. */
+  chat(options: LlmChatOptions): Promise<LlmResult>;
+  /** Streams text deltas, then yields the final result. Falls back to `chat` for clients without streaming. */
+  stream(options: LlmChatOptions): AsyncGenerator<StreamEvent | {
+    type: 'result';
+    result: LlmResult;
+  }>;
+  /** Whether a provider can embed text, for pickers. */
+  canEmbed(id: string): boolean;
+  /** Embeds texts through a provider, `EMBED_BATCH` at a time; each batch is retried once. */
+  embed(options: LlmEmbedOptions): Promise<LlmEmbedResult>;
+  /** Asks a decision provider structured questions about a state. */
+  decide(options: LlmDecideOptions): Promise<LlmDecideResult>;
+  private logRequestError;
+  test(id: string): Promise<ProviderTest>;
+  models(input: {
+    provider?: string;
+    type?: string;
+    config?: Record<string, any>;
+  }): Promise<string[]>;
+  private defineActions;
+}
+export { ChatRequest, ChatResponse, ContentPart, DecisionAnswer, DecisionAsset, DecisionQuestion, DecisionRequest, DecisionResponse, DecisionText, EmbedRequest, EmbedResponse, FinishReason, LlmChatOptions, LlmDecideOptions, LlmDecideResult, LlmEmbedOptions, LlmEmbedResult, LlmMessage, LlmResult, LlmService as default, ModelProfile, ProfileModel, ProviderCapability, ProviderClient, ProviderPreset, ProviderRecord, ProviderTest, ProviderType, RawTurn, StreamEvent, ToolCall, ToolDefinition, Usage };