@sema-agent/client-core 0.111.0 → 0.112.0

package/dist/localConfig/modelPool.d.ts

@@ -0,0 +1,262 @@
+import type { SettingsDocument } from '../host.js';
+import type { ModelApiWord, PresetModel } from '../model/providerPresets.js';
+import { type CatalogDefaultDangling, type CatalogDefaultSelectCriteria, type CatalogDefaultSource } from '../model/catalogDefault.js';
+import { type Tier } from '../model/tierVocabulary.js';
+import { type EntryVisionResolution, type PoolDeleteBlocker, type PoolDeleteWarning } from '../model/modelSupplyRules.js';
+import { type ModelProbeResult, type ProbeVerdictWord } from '../modelCapabilityProbe.js';
+import { type OnboardWritePlan, type OnboardWritePlanInput } from '../model/onboardJudgement.js';
+import type { OnboardCatalogIssue, SeatModelPoolEdit } from '../seatContract.js';
+import type { LocalConfigDisclosure, LocalConfigFileReading, LocalConfigHostFacts, LocalConfigIntent, LocalConfigPreview, LocalConfigReceipt, LocalConfigRefusal, LocalConfigStorePort } from './kernel.js';
+import { type ModelPoolChannelSource, type ModelPoolCompleteness, type ModelPoolDefaultKeepReason, type ModelPoolProbeState } from './modelPoolWords.js';
+export { MODEL_POOL_EDIT_KINDS, MODEL_POOL_CHANNEL_SOURCES, MODEL_POOL_CREDENTIAL_KINDS, MODEL_POOL_COMPLETENESS, MODEL_POOL_MAX_BATCH, MODEL_POOL_PROBE_STATES, MODEL_POOL_DEFAULT_KEEP_REASONS } from './modelPoolWords.js';
+export type { ModelPoolEditKind, ModelPoolChannelSource, ModelPoolCredentialKind, ModelPoolCompleteness, ModelPoolProbeState, ModelPoolDefaultKeepReason } from './modelPoolWords.js';
+export interface ModelPoolEntrySpec {
+    readonly modelId: string;
+    readonly api: ModelApiWord;
+    readonly baseUrl: string;
+    readonly credential: {
+        readonly kind: 'key';
+        readonly apiKey: string;
+    } | {
+        readonly kind: 'none';
+    };
+    readonly label?: string;
+    readonly vision?: boolean;
+    readonly contextWindow?: number;
+    readonly maxTokens?: number;
+    readonly channel?: string;
+    readonly probe?: ModelPoolProbeReading;
+    readonly acceptUnverified?: boolean;
+    readonly thinking?: ModelProbeResult;
+}
+export interface ModelPoolProbeReading {
+    readonly verdict: ProbeVerdictWord;
+    readonly at: number;
+}
+export type ModelPoolChannelData = SettingsDocument | readonly SettingsDocument[];
+export interface ModelPoolModelRow {
+    readonly id: string;
+    readonly contextWindow?: number;
+    readonly maxTokens?: number;
+}
+export interface ModelPoolChannelProfile {
+    readonly source: ModelPoolChannelSource;
+    readonly id: string;
+    readonly name: string;
+    readonly baseUrl: string;
+    readonly api: ModelApiWord;
+    readonly apiKey?: string;
+    readonly models: readonly ModelPoolModelRow[];
+    readonly isCurrent?: boolean;
+}
+export type ModelPoolEdit = {
+    readonly kind: 'add';
+    readonly entries: readonly ModelPoolEntrySpec[];
+    readonly defaultIndex?: number;
+} | {
+    readonly kind: 'update';
+    readonly name: string;
+    readonly label?: string | null;
+    readonly vision?: boolean | null;
+    readonly contextWindow?: number;
+    readonly maxTokens?: number;
+} | {
+    readonly kind: 'remove';
+    readonly name: string;
+} | {
+    readonly kind: 'setDefault';
+    readonly name: string;
+} | {
+    readonly kind: 'importEnvModels';
+} | {
+    readonly kind: 'importChannel';
+    readonly profile: ModelPoolChannelProfile;
+    readonly modelIds: readonly string[];
+    readonly defaultIndex?: number;
+    readonly acceptUnverified?: boolean;
+} | {
+    readonly kind: 'bindTier';
+    readonly group: string;
+    readonly tier: Tier;
+    readonly name: string | null;
+} | {
+    readonly kind: 'switchTierGroup';
+    readonly group: string;
+} | {
+    readonly kind: 'addTierGroup';
+    readonly group: string;
+    readonly tiers?: Readonly<Partial<Record<Tier, string>>>;
+} | {
+    readonly kind: 'removeTierGroup';
+    readonly group: string;
+} | {
+    readonly kind: 'migrateTierGroups';
+} | {
+    readonly kind: 'sweepOrphanKeySlots';
+};
+export interface ModelPoolProblem {
+    readonly reason: LocalConfigRefusal;
+    readonly detail: string;
+    readonly index?: number;
+    readonly name?: string;
+}
+export interface ModelPoolPlannedEntry {
+    readonly name: string;
+    readonly modelId: string;
+    readonly keyEnv: string | null;
+    readonly updatedExisting: boolean;
+    readonly probe: ModelPoolProbeState;
+}
+export type ModelPoolPlan = {
+    readonly ok: true;
+    readonly nextModelsDoc: SettingsDocument;
+    readonly nextSettingsDoc: SettingsDocument;
+    readonly modelsChanged: boolean;
+    readonly settingsChanged: boolean;
+    readonly entries: readonly ModelPoolPlannedEntry[];
+    readonly releasedKeySlots: readonly string[];
+    readonly warnings: readonly PoolDeleteWarning[];
+    readonly otherIssues: readonly OnboardCatalogIssue[];
+    readonly disclosures: readonly LocalConfigDisclosure[];
+} | {
+    readonly ok: false;
+    readonly reason: LocalConfigRefusal;
+    readonly detail?: string;
+    readonly problems: readonly ModelPoolProblem[];
+};
+export type EffectiveDefaultModel = {
+    readonly kind: 'named';
+    readonly name: string;
+    readonly source: CatalogDefaultSource;
+    readonly dangling: readonly CatalogDefaultDangling[];
+    readonly disclosures: readonly LocalConfigDisclosure[];
+} | {
+    readonly kind: 'select';
+    readonly select: CatalogDefaultSelectCriteria;
+    readonly disclosures: readonly LocalConfigDisclosure[];
+} | {
+    readonly kind: 'none';
+    readonly disclosures: readonly LocalConfigDisclosure[];
+} | {
+    readonly kind: 'unknown';
+    readonly disclosures: readonly LocalConfigDisclosure[];
+};
+export interface EffectiveDefaultModelInput {
+    readonly modelsDoc: SettingsDocument | null | undefined;
+    readonly userSettings: SettingsDocument | null | undefined;
+}
+export declare function effectiveDefaultModelOf(input: EffectiveDefaultModelInput): EffectiveDefaultModel;
+export interface DefaultModelBatchRow {
+    readonly probe: ModelPoolProbeState;
+}
+export type DefaultModelChoice = {
+    readonly kind: 'pick';
+    readonly index: number;
+} | {
+    readonly kind: 'unchanged';
+    readonly reason: ModelPoolDefaultKeepReason;
+};
+export declare function defaultModelChoiceOf(existing: EffectiveDefaultModel, batch: readonly DefaultModelBatchRow[], declined?: boolean): DefaultModelChoice;
+export declare function poolWritePlan(edit: ModelPoolEdit, modelsDoc: SettingsDocument | null, settingsDoc: SettingsDocument | null, effectiveEnv: Readonly<Record<string, string | undefined>>): ModelPoolPlan;
+export interface ModelPoolIntentProbe {
+    plan: ModelPoolPlan | undefined;
+}
+export declare function modelPoolIntentOf(edit: ModelPoolEdit, effectiveEnv: Readonly<Record<string, string | undefined>>, probe?: ModelPoolIntentProbe): LocalConfigIntent;
+export interface ModelPoolEditOutcome {
+    readonly receipt: LocalConfigReceipt | LocalConfigPreview;
+    readonly problems?: readonly ModelPoolProblem[];
+    readonly entries?: readonly ModelPoolPlannedEntry[];
+    readonly warnings?: readonly PoolDeleteWarning[];
+    readonly otherIssues?: readonly OnboardCatalogIssue[];
+}
+export declare function editModelPoolWith(edit: ModelPoolEdit, store: LocalConfigStorePort, facts: LocalConfigHostFacts, effectiveEnv: Readonly<Record<string, string | undefined>>, opts?: {
+    readonly dryRun?: boolean;
+}): Promise<ModelPoolEditOutcome>;
+export declare function onboardWritePlan(input: OnboardWritePlanInput): OnboardWritePlan;
+export declare function channelProfilesOf(source: ModelPoolChannelSource, data: ModelPoolChannelData, env?: Readonly<Record<string, string | undefined>>): readonly ModelPoolChannelProfile[];
+export declare function modelPoolEditOfSeat(edit: SeatModelPoolEdit, profiles: readonly ModelPoolChannelProfile[], probes?: readonly (ModelPoolProbeReading | undefined)[]): ModelPoolEdit | undefined;
+export interface ModelPoolViewEntry {
+    readonly name: string;
+    readonly modelId: string;
+    readonly api: string;
+    readonly baseUrl: string;
+    readonly enabled: boolean;
+    readonly label?: string;
+    readonly vision: {
+        readonly source: EntryVisionResolution['source'];
+        readonly value?: boolean;
+    };
+    readonly keyless: boolean;
+    readonly keyEnv?: string;
+    readonly contextWindow?: number;
+    readonly maxTokens?: number;
+    readonly probe: ModelPoolProbeState;
+    readonly probeVerdict?: string;
+    readonly probedAt?: number;
+    readonly isDefault: boolean;
+    readonly tiers: readonly {
+        readonly group: string;
+        readonly tier: string;
+    }[];
+    readonly deleteBlockers: readonly PoolDeleteBlocker[];
+    readonly deleteWarnings: readonly PoolDeleteWarning[];
+    readonly credentialIssue?: string;
+}
+export interface ModelPoolViewTierGroup {
+    readonly name: string;
+    readonly active: boolean;
+    readonly tiers: Readonly<Record<string, string>>;
+    readonly resolved: Readonly<Record<string, string>>;
+}
+export interface ModelPoolRoleRow {
+    readonly role: string;
+    readonly model?: string;
+    readonly select?: true;
+}
+export type ModelPoolRowAction = {
+    readonly kind: 'remove';
+} | {
+    readonly kind: 'setDefault';
+} | {
+    readonly kind: 'update';
+    readonly label?: string | null;
+    readonly vision?: boolean | null;
+    readonly contextWindow?: number;
+    readonly maxTokens?: number;
+} | {
+    readonly kind: 'bindTier';
+    readonly group: string;
+    readonly tier: Tier;
+};
+export interface ModelPoolProvider {
+    readonly id: string;
+    readonly name: string;
+    readonly baseUrl: string;
+    readonly api: string;
+    readonly authEnv: string;
+    readonly consoleUrl?: string;
+    readonly signupUrl?: string;
+    readonly keyOptional: boolean;
+    readonly models: readonly Readonly<Pick<PresetModel, 'id' | 'contextWindow' | 'maxTokens'>>[];
+}
+export interface ModelPoolView {
+    readonly catalog: 'read' | 'absent' | 'unreadable';
+    readonly completeness: ModelPoolCompleteness;
+    readonly unreadableRows: number;
+    readonly entries: readonly ModelPoolViewEntry[];
+    readonly roles: readonly ModelPoolRoleRow[];
+    readonly tierGroups: readonly ModelPoolViewTierGroup[];
+    readonly activeTierGroup?: string;
+    readonly defaultModel: EffectiveDefaultModel;
+    readonly legacyTierSettings: boolean;
+    readonly orphanKeySlots: number;
+    readonly envModels: readonly string[];
+    readonly providers: readonly ModelPoolProvider[];
+}
+export interface ModelPoolReadings {
+    readonly models: LocalConfigFileReading | undefined;
+    readonly userSettings: LocalConfigFileReading | undefined;
+    readonly effectiveEnv?: Readonly<Record<string, string | undefined>>;
+}
+export declare function modelPoolViewOf(readings: ModelPoolReadings): ModelPoolView;
+export declare function modelPoolRowEditOf(row: ModelPoolViewEntry, action: ModelPoolRowAction): ModelPoolEdit | undefined;