@elizaos/agent 0.25.8 → 2.0.0-alpha.83

package/packages/agent/src/contracts/onboarding.d.ts

@@ -0,0 +1,379 @@
+/**
+ * Shared onboarding contracts.
+ */
+import type { WalletConfigUpdateRequest } from "./wallet";
+export interface StylePreset {
+    catchphrase: string;
+    hint: string;
+    bio: string[];
+    system: string;
+    adjectives: string[];
+    style: {
+        all: string[];
+        chat: string[];
+        post: string[];
+    };
+    postExamples: string[];
+    postExamples_zhCN?: string[];
+    messageExamples: Array<Array<{
+        user: string;
+        content: {
+            text: string;
+        };
+    }>>;
+}
+export type OnboardingProviderFamily = "anthropic" | "deepseek" | "elizacloud" | "gemini" | "grok" | "groq" | "mistral" | "ollama" | "openai" | "openrouter" | "pi-ai" | "together" | "zai";
+export type OnboardingProviderId = "anthropic" | "anthropic-subscription" | "deepseek" | "elizacloud" | "gemini" | "grok" | "groq" | "mistral" | "ollama" | "openai" | "openai-subscription" | "openrouter" | "pi-ai" | "together" | "zai";
+export type OnboardingProviderAuthMode = "api-key" | "cloud" | "credentials" | "local" | "subscription";
+export type OnboardingProviderGroup = "cloud" | "local" | "subscription";
+export interface ProviderOption {
+    id: OnboardingProviderId;
+    name: string;
+    envKey: string | null;
+    pluginName: string;
+    keyPrefix: string | null;
+    description: string;
+    family: OnboardingProviderFamily;
+    authMode: OnboardingProviderAuthMode;
+    group: OnboardingProviderGroup;
+    order: number;
+    recommended?: boolean;
+    labelKey?: string;
+    storedProvider?: string;
+    supportsPrimaryModelOverride?: boolean;
+}
+export interface CloudProviderOption {
+    id: "elizacloud";
+    name: string;
+    description: string;
+}
+export interface ModelOption {
+    id: string;
+    name: string;
+    provider: string;
+    description: string;
+}
+export interface OpenRouterModelOption {
+    id: string;
+    name: string;
+    description: string;
+}
+export interface PiAiModelOption {
+    id: string;
+    name: string;
+    provider: string;
+    isDefault: boolean;
+}
+export interface MessageExampleContent {
+    text: string;
+    actions?: string[];
+}
+export interface MessageExample {
+    user: string;
+    content: MessageExampleContent;
+}
+export interface ConnectorConfig {
+    enabled?: boolean;
+    botToken?: string;
+    token?: string;
+    apiKey?: string;
+    [key: string]: string | boolean | number | string[] | Record<string, unknown> | undefined;
+}
+export interface RpcProviderOption {
+    id: string;
+    label: string;
+    envKey?: string | null;
+    requiresKey?: boolean;
+}
+export interface InventoryProviderOption {
+    id: string;
+    name: string;
+    description: string;
+    rpcProviders: RpcProviderOption[];
+}
+export type SubscriptionProviderSelectionId = "anthropic-subscription" | "openai-subscription";
+export type StoredSubscriptionProviderId = "anthropic-subscription" | "openai-codex";
+export declare const SUBSCRIPTION_PROVIDER_SELECTIONS: readonly [{
+    readonly id: "anthropic-subscription";
+    readonly storedProvider: "anthropic-subscription";
+    readonly family: "anthropic";
+    readonly labelKey: "providerswitcher.claudeSubscription";
+}, {
+    readonly id: "openai-subscription";
+    readonly storedProvider: "openai-codex";
+    readonly family: "openai";
+    readonly labelKey: "providerswitcher.chatgptSubscription";
+}];
+export declare const ONBOARDING_PROVIDER_CATALOG: readonly [{
+    readonly id: "elizacloud";
+    readonly name: "Eliza Cloud";
+    readonly envKey: any;
+    readonly pluginName: "@elizaos/plugin-elizacloud";
+    readonly keyPrefix: any;
+    readonly description: "Managed hosting for Eliza agents and bundled infrastructure.";
+    readonly family: "elizacloud";
+    readonly authMode: "cloud";
+    readonly group: "cloud";
+    readonly order: 10;
+    readonly recommended: true;
+}, {
+    readonly id: "anthropic-subscription";
+    readonly name: "Claude Subscription";
+    readonly envKey: any;
+    readonly pluginName: "@elizaos/plugin-anthropic";
+    readonly keyPrefix: any;
+    readonly description: "Use your Claude Pro or Max subscription via OAuth or setup token.";
+    readonly family: "anthropic";
+    readonly authMode: "subscription";
+    readonly group: "subscription";
+    readonly order: 20;
+    readonly recommended: true;
+    readonly labelKey: "providerswitcher.claudeSubscription";
+    readonly storedProvider: "anthropic-subscription";
+}, {
+    readonly id: "openai-subscription";
+    readonly name: "ChatGPT Subscription";
+    readonly envKey: any;
+    readonly pluginName: "@elizaos/plugin-openai";
+    readonly keyPrefix: any;
+    readonly description: "Use your ChatGPT Plus or Pro subscription via OAuth.";
+    readonly family: "openai";
+    readonly authMode: "subscription";
+    readonly group: "subscription";
+    readonly order: 30;
+    readonly recommended: true;
+    readonly labelKey: "providerswitcher.chatgptSubscription";
+    readonly storedProvider: "openai-codex";
+}, {
+    readonly id: "pi-ai";
+    readonly name: "Pi Credentials";
+    readonly envKey: any;
+    readonly pluginName: "@elizaos/plugin-pi-ai";
+    readonly keyPrefix: any;
+    readonly description: "Use credentials from ~/.pi/agent/auth.json (API keys or OAuth).";
+    readonly family: "pi-ai";
+    readonly authMode: "credentials";
+    readonly group: "local";
+    readonly order: 40;
+    readonly supportsPrimaryModelOverride: true;
+}, {
+    readonly id: "anthropic";
+    readonly name: "Anthropic";
+    readonly envKey: "ANTHROPIC_API_KEY";
+    readonly pluginName: "@elizaos/plugin-anthropic";
+    readonly keyPrefix: "sk-ant-";
+    readonly description: "Claude models via API key.";
+    readonly family: "anthropic";
+    readonly authMode: "api-key";
+    readonly group: "local";
+    readonly order: 50;
+}, {
+    readonly id: "openai";
+    readonly name: "OpenAI";
+    readonly envKey: "OPENAI_API_KEY";
+    readonly pluginName: "@elizaos/plugin-openai";
+    readonly keyPrefix: "sk-";
+    readonly description: "GPT models via API key.";
+    readonly family: "openai";
+    readonly authMode: "api-key";
+    readonly group: "local";
+    readonly order: 60;
+}, {
+    readonly id: "openrouter";
+    readonly name: "OpenRouter";
+    readonly envKey: "OPENROUTER_API_KEY";
+    readonly pluginName: "@elizaos/plugin-openrouter";
+    readonly keyPrefix: "sk-or-";
+    readonly description: "Access multiple models via one API key.";
+    readonly family: "openrouter";
+    readonly authMode: "api-key";
+    readonly group: "local";
+    readonly order: 70;
+    readonly supportsPrimaryModelOverride: true;
+}, {
+    readonly id: "gemini";
+    readonly name: "Gemini";
+    readonly envKey: "GOOGLE_GENERATIVE_AI_API_KEY";
+    readonly pluginName: "@elizaos/plugin-google-genai";
+    readonly keyPrefix: any;
+    readonly description: "Google's Gemini models.";
+    readonly family: "gemini";
+    readonly authMode: "api-key";
+    readonly group: "local";
+    readonly order: 80;
+}, {
+    readonly id: "grok";
+    readonly name: "xAI (Grok)";
+    readonly envKey: "XAI_API_KEY";
+    readonly pluginName: "@elizaos/plugin-xai";
+    readonly keyPrefix: "xai-";
+    readonly description: "xAI's Grok models.";
+    readonly family: "grok";
+    readonly authMode: "api-key";
+    readonly group: "local";
+    readonly order: 90;
+}, {
+    readonly id: "groq";
+    readonly name: "Groq";
+    readonly envKey: "GROQ_API_KEY";
+    readonly pluginName: "@elizaos/plugin-groq";
+    readonly keyPrefix: "gsk_";
+    readonly description: "Fast inference.";
+    readonly family: "groq";
+    readonly authMode: "api-key";
+    readonly group: "local";
+    readonly order: 100;
+}, {
+    readonly id: "deepseek";
+    readonly name: "DeepSeek";
+    readonly envKey: "DEEPSEEK_API_KEY";
+    readonly pluginName: "@elizaos/plugin-deepseek";
+    readonly keyPrefix: "sk-";
+    readonly description: "DeepSeek models.";
+    readonly family: "deepseek";
+    readonly authMode: "api-key";
+    readonly group: "local";
+    readonly order: 110;
+}, {
+    readonly id: "mistral";
+    readonly name: "Mistral";
+    readonly envKey: "MISTRAL_API_KEY";
+    readonly pluginName: "@elizaos/plugin-mistral";
+    readonly keyPrefix: any;
+    readonly description: "Mistral AI models.";
+    readonly family: "mistral";
+    readonly authMode: "api-key";
+    readonly group: "local";
+    readonly order: 120;
+}, {
+    readonly id: "together";
+    readonly name: "Together AI";
+    readonly envKey: "TOGETHER_API_KEY";
+    readonly pluginName: "@elizaos/plugin-together";
+    readonly keyPrefix: any;
+    readonly description: "Open-source model hosting.";
+    readonly family: "together";
+    readonly authMode: "api-key";
+    readonly group: "local";
+    readonly order: 130;
+}, {
+    readonly id: "ollama";
+    readonly name: "Ollama";
+    readonly envKey: any;
+    readonly pluginName: "@elizaos/plugin-ollama";
+    readonly keyPrefix: any;
+    readonly description: "Local models, no API key needed.";
+    readonly family: "ollama";
+    readonly authMode: "local";
+    readonly group: "local";
+    readonly order: 140;
+}, {
+    readonly id: "zai";
+    readonly name: "z.ai";
+    readonly envKey: "ZAI_API_KEY";
+    readonly pluginName: "@homunculuslabs/plugin-zai";
+    readonly keyPrefix: any;
+    readonly description: "GLM models via z.ai Coding Plan.";
+    readonly family: "zai";
+    readonly authMode: "api-key";
+    readonly group: "local";
+    readonly order: 150;
+}];
+export declare const ONBOARDING_CLOUD_PROVIDER_OPTIONS: readonly [{
+    readonly id: "elizacloud";
+    readonly name: "Eliza Cloud";
+    readonly description: "Managed cloud infrastructure. Wallets, LLMs, and RPCs included.";
+}];
+export type OnboardingLocalProviderId = Exclude<OnboardingProviderId, "elizacloud">;
+export interface OnboardingCloudManagedConnection {
+    kind: "cloud-managed";
+    cloudProvider: "elizacloud";
+    apiKey?: string;
+    smallModel?: string;
+    largeModel?: string;
+}
+export interface OnboardingLocalProviderConnection {
+    kind: "local-provider";
+    provider: OnboardingLocalProviderId;
+    apiKey?: string;
+    primaryModel?: string;
+}
+export interface OnboardingRemoteProviderConnection {
+    kind: "remote-provider";
+    remoteApiBase: string;
+    remoteAccessToken?: string;
+    provider?: OnboardingLocalProviderId;
+    apiKey?: string;
+    primaryModel?: string;
+}
+export type OnboardingConnection = OnboardingCloudManagedConnection | OnboardingLocalProviderConnection | OnboardingRemoteProviderConnection;
+export interface OnboardingOptions {
+    names: string[];
+    styles: StylePreset[];
+    providers: ProviderOption[];
+    cloudProviders: CloudProviderOption[];
+    models: {
+        small: ModelOption[];
+        large: ModelOption[];
+    };
+    openrouterModels?: OpenRouterModelOption[];
+    piAiModels?: PiAiModelOption[];
+    piAiDefaultModel?: string | null;
+    inventoryProviders: InventoryProviderOption[];
+    sharedStyleRules: string;
+    githubOAuthAvailable?: boolean;
+}
+export interface OnboardingData {
+    name: string;
+    sandboxMode?: "off" | "light" | "standard" | "max";
+    bio: string[];
+    systemPrompt: string;
+    style?: {
+        all: string[];
+        chat: string[];
+        post: string[];
+    };
+    adjectives?: string[];
+    postExamples?: string[];
+    messageExamples?: MessageExample[][];
+    connection: OnboardingConnection;
+    channels?: Record<string, unknown>;
+    walletConfig?: WalletConfigUpdateRequest;
+    inventoryProviders?: Array<{
+        chain: string;
+        rpcProvider: string;
+        rpcApiKey?: string;
+    }>;
+    connectors?: Record<string, ConnectorConfig>;
+    telegramToken?: string;
+    discordToken?: string;
+    whatsappSessionPath?: string;
+    twilioAccountSid?: string;
+    twilioAuthToken?: string;
+    twilioPhoneNumber?: string;
+    blooioApiKey?: string;
+    blooioPhoneNumber?: string;
+    githubToken?: string;
+}
+export interface SubscriptionProviderStatus {
+    provider: string;
+    configured: boolean;
+    valid: boolean;
+    expiresAt: number | null;
+}
+export interface SubscriptionStatusResponse {
+    providers: SubscriptionProviderStatus[];
+}
+export declare function isSubscriptionProviderSelectionId(value: unknown): value is SubscriptionProviderSelectionId;
+export declare function normalizeSubscriptionProviderSelectionId(value: unknown): SubscriptionProviderSelectionId | null;
+export declare function getStoredSubscriptionProvider(selectionId: SubscriptionProviderSelectionId): StoredSubscriptionProviderId;
+export declare function getSubscriptionProviderFamily(selectionId: SubscriptionProviderSelectionId): "anthropic" | "openai";
+export declare function normalizeOnboardingProviderId(value: unknown): OnboardingProviderId | null;
+export declare function getOnboardingProviderOption(providerId: unknown): ProviderOption | null;
+export declare function getOnboardingProviderFamily(providerId: unknown): OnboardingProviderFamily | null;
+export declare function getStoredOnboardingProviderId(providerId: unknown): string | null;
+export declare function sortOnboardingProviders(providers: readonly ProviderOption[]): ProviderOption[];
+export declare function isCloudManagedConnection(connection: OnboardingConnection | null | undefined): connection is OnboardingCloudManagedConnection;
+export declare function isRemoteProviderConnection(connection: OnboardingConnection | null | undefined): connection is OnboardingRemoteProviderConnection;
+export declare function isLocalProviderConnection(connection: OnboardingConnection | null | undefined): connection is OnboardingLocalProviderConnection;
+//# sourceMappingURL=onboarding.d.ts.map

package/packages/agent/src/contracts/onboarding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onboarding.d.ts","sourceRoot":"","sources":["../../../../../src/contracts/onboarding.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,UAAU,CAAC;AAE1D,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,KAAK,EAAE;QACL,GAAG,EAAE,MAAM,EAAE,CAAC;QACd,IAAI,EAAE,MAAM,EAAE,CAAC;QACf,IAAI,EAAE,MAAM,EAAE,CAAC;KAChB,CAAC;IACF,YAAY,EAAE,MAAM,EAAE,CAAC;IACvB,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC7B,eAAe,EAAE,KAAK,CACpB,KAAK,CAAC;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE;YAAE,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;KAC3B,CAAC,CACH,CAAC;CACH;AAED,MAAM,MAAM,wBAAwB,GAChC,WAAW,GACX,UAAU,GACV,YAAY,GACZ,QAAQ,GACR,MAAM,GACN,MAAM,GACN,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,YAAY,GACZ,OAAO,GACP,UAAU,GACV,KAAK,CAAC;AAEV,MAAM,MAAM,oBAAoB,GAC5B,WAAW,GACX,wBAAwB,GACxB,UAAU,GACV,YAAY,GACZ,QAAQ,GACR,MAAM,GACN,MAAM,GACN,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,qBAAqB,GACrB,YAAY,GACZ,OAAO,GACP,UAAU,GACV,KAAK,CAAC;AAEV,MAAM,MAAM,0BAA0B,GAClC,SAAS,GACT,OAAO,GACP,aAAa,GACb,OAAO,GACP,cAAc,CAAC;AAEnB,MAAM,MAAM,uBAAuB,GAAG,OAAO,GAAG,OAAO,GAAG,cAAc,CAAC;AAEzE,MAAM,WAAW,cAAc;IAC7B,EAAE,EAAE,oBAAoB,CAAC;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,wBAAwB,CAAC;IACjC,QAAQ,EAAE,0BAA0B,CAAC;IACrC,KAAK,EAAE,uBAAuB,CAAC;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,4BAA4B,CAAC,EAAE,OAAO,CAAC;CACxC;AAED,MAAM,WAAW,mBAAmB;IAClC,EAAE,EAAE,YAAY,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,WAAW;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,qBAAqB,CAAC;CAChC;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,CAAC,GAAG,EAAE,MAAM,GACR,MAAM,GACN,OAAO,GACP,MAAM,GACN,MAAM,EAAE,GACR,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACvB,SAAS,CAAC;CACf;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB;AAED,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,iBAAiB,EAAE,CAAC;CACnC;AAED,MAAM,MAAM,+BAA+B,GACvC,wBAAwB,GACxB,qBAAqB,CAAC;AAE1B,MAAM,MAAM,4BAA4B,GACpC,wBAAwB,GACxB,cAAc,CAAC;AAEnB,eAAO,MAAM,gCAAgC;;;;;;;;;;EAkB3C,CAAC;AAEH,eAAO,MAAM,2BAA2B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAgMU,CAAC;AAEnD,eAAO,MAAM,iCAAiC;;;;EAOS,CAAC;AAExD,MAAM,MAAM,yBAAyB,GAAG,OAAO,CAC7C,oBAAoB,EACpB,YAAY,CACb,CAAC;AAEF,MAAM,WAAW,gCAAgC;IAC/C,IAAI,EAAE,eAAe,CAAC;IACtB,aAAa,EAAE,YAAY,CAAC;IAC5B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iCAAiC;IAChD,IAAI,EAAE,gBAAgB,CAAC;IACvB,QAAQ,EAAE,yBAAyB,CAAC;IACpC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,kCAAkC;IACjD,IAAI,EAAE,iBAAiB,CAAC;IACxB,aAAa,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,EAAE,yBAAyB,CAAC;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,oBAAoB,GAC5B,gCAAgC,GAChC,iCAAiC,GACjC,kCAAkC,CAAC;AAEvC,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,SAAS,EAAE,cAAc,EAAE,CAAC;IAC5B,cAAc,EAAE,mBAAmB,EAAE,CAAC;IACtC,MAAM,EAAE;QACN,KAAK,EAAE,WAAW,EAAE,CAAC;QACrB,KAAK,EAAE,WAAW,EAAE,CAAC;KACtB,CAAC;IACF,gBAAgB,CAAC,EAAE,qBAAqB,EAAE,CAAC;IAC3C,UAAU,CAAC,EAAE,eAAe,EAAE,CAAC;IAC/B,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,kBAAkB,EAAE,uBAAuB,EAAE,CAAC;IAC9C,gBAAgB,EAAE,MAAM,CAAC;IACzB,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,UAAU,GAAG,KAAK,CAAC;IACnD,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE;QACN,GAAG,EAAE,MAAM,EAAE,CAAC;QACd,IAAI,EAAE,MAAM,EAAE,CAAC;QACf,IAAI,EAAE,MAAM,EAAE,CAAC;KAChB,CAAC;IACF,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,EAAE,CAAC;IACxB,eAAe,CAAC,EAAE,cAAc,EAAE,EAAE,CAAC;IACrC,UAAU,EAAE,oBAAoB,CAAC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACnC,YAAY,CAAC,EAAE,yBAAyB,CAAC;IACzC,kBAAkB,CAAC,EAAE,KAAK,CAAC;QACzB,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,EAAE,MAAM,CAAC;QACpB,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC,CAAC;IACH,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IAC7C,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,0BAA0B;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,OAAO,CAAC;IACpB,KAAK,EAAE,OAAO,CAAC;IACf,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAED,MAAM,WAAW,0BAA0B;IACzC,SAAS,EAAE,0BAA0B,EAAE,CAAC;CACzC;AAiBD,wBAAgB,iCAAiC,CAC/C,KAAK,EAAE,OAAO,GACb,KAAK,IAAI,+BAA+B,CAI1C;AAED,wBAAgB,wCAAwC,CACtD,KAAK,EAAE,OAAO,GACb,+BAA+B,GAAG,IAAI,CAMxC;AAED,wBAAgB,6BAA6B,CAC3C,WAAW,EAAE,+BAA+B,GAC3C,4BAA4B,CAI9B;AAED,wBAAgB,6BAA6B,CAC3C,WAAW,EAAE,+BAA+B,GAC3C,WAAW,GAAG,QAAQ,CAExB;AAED,wBAAgB,6BAA6B,CAC3C,KAAK,EAAE,OAAO,GACb,oBAAoB,GAAG,IAAI,CAS7B;AAED,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,OAAO,GAClB,cAAc,GAAG,IAAI,CAQvB;AAED,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,OAAO,GAClB,wBAAwB,GAAG,IAAI,CAEjC;AAED,wBAAgB,6BAA6B,CAC3C,UAAU,EAAE,OAAO,GAClB,MAAM,GAAG,IAAI,CAIf;AAED,wBAAgB,uBAAuB,CACrC,SAAS,EAAE,SAAS,cAAc,EAAE,GACnC,cAAc,EAAE,CASlB;AAED,wBAAgB,wBAAwB,CACtC,UAAU,EAAE,oBAAoB,GAAG,IAAI,GAAG,SAAS,GAClD,UAAU,IAAI,gCAAgC,CAEhD;AAED,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,oBAAoB,GAAG,IAAI,GAAG,SAAS,GAClD,UAAU,IAAI,kCAAkC,CAElD;AAED,wBAAgB,yBAAyB,CACvC,UAAU,EAAE,oBAAoB,GAAG,IAAI,GAAG,SAAS,GAClD,UAAU,IAAI,iCAAiC,CAEjD"}

package/packages/agent/src/contracts/onboarding.js

@@ -0,0 +1,290 @@
+/**
+ * Shared onboarding contracts.
+ */
+export const SUBSCRIPTION_PROVIDER_SELECTIONS = [
+    {
+        id: "anthropic-subscription",
+        storedProvider: "anthropic-subscription",
+        family: "anthropic",
+        labelKey: "providerswitcher.claudeSubscription",
+    },
+    {
+        id: "openai-subscription",
+        storedProvider: "openai-codex",
+        family: "openai",
+        labelKey: "providerswitcher.chatgptSubscription",
+    },
+];
+export const ONBOARDING_PROVIDER_CATALOG = [
+    {
+        id: "elizacloud",
+        name: "Eliza Cloud",
+        envKey: null,
+        pluginName: "@elizaos/plugin-elizacloud",
+        keyPrefix: null,
+        description: "Managed hosting for Eliza agents and bundled infrastructure.",
+        family: "elizacloud",
+        authMode: "cloud",
+        group: "cloud",
+        order: 10,
+        recommended: true,
+    },
+    {
+        id: "anthropic-subscription",
+        name: "Claude Subscription",
+        envKey: null,
+        pluginName: "@elizaos/plugin-anthropic",
+        keyPrefix: null,
+        description: "Use your Claude Pro or Max subscription via OAuth or setup token.",
+        family: "anthropic",
+        authMode: "subscription",
+        group: "subscription",
+        order: 20,
+        recommended: true,
+        labelKey: "providerswitcher.claudeSubscription",
+        storedProvider: "anthropic-subscription",
+    },
+    {
+        id: "openai-subscription",
+        name: "ChatGPT Subscription",
+        envKey: null,
+        pluginName: "@elizaos/plugin-openai",
+        keyPrefix: null,
+        description: "Use your ChatGPT Plus or Pro subscription via OAuth.",
+        family: "openai",
+        authMode: "subscription",
+        group: "subscription",
+        order: 30,
+        recommended: true,
+        labelKey: "providerswitcher.chatgptSubscription",
+        storedProvider: "openai-codex",
+    },
+    {
+        id: "pi-ai",
+        name: "Pi Credentials",
+        envKey: null,
+        pluginName: "@elizaos/plugin-pi-ai",
+        keyPrefix: null,
+        description: "Use credentials from ~/.pi/agent/auth.json (API keys or OAuth).",
+        family: "pi-ai",
+        authMode: "credentials",
+        group: "local",
+        order: 40,
+        supportsPrimaryModelOverride: true,
+    },
+    {
+        id: "anthropic",
+        name: "Anthropic",
+        envKey: "ANTHROPIC_API_KEY",
+        pluginName: "@elizaos/plugin-anthropic",
+        keyPrefix: "sk-ant-",
+        description: "Claude models via API key.",
+        family: "anthropic",
+        authMode: "api-key",
+        group: "local",
+        order: 50,
+    },
+    {
+        id: "openai",
+        name: "OpenAI",
+        envKey: "OPENAI_API_KEY",
+        pluginName: "@elizaos/plugin-openai",
+        keyPrefix: "sk-",
+        description: "GPT models via API key.",
+        family: "openai",
+        authMode: "api-key",
+        group: "local",
+        order: 60,
+    },
+    {
+        id: "openrouter",
+        name: "OpenRouter",
+        envKey: "OPENROUTER_API_KEY",
+        pluginName: "@elizaos/plugin-openrouter",
+        keyPrefix: "sk-or-",
+        description: "Access multiple models via one API key.",
+        family: "openrouter",
+        authMode: "api-key",
+        group: "local",
+        order: 70,
+        supportsPrimaryModelOverride: true,
+    },
+    {
+        id: "gemini",
+        name: "Gemini",
+        envKey: "GOOGLE_GENERATIVE_AI_API_KEY",
+        pluginName: "@elizaos/plugin-google-genai",
+        keyPrefix: null,
+        description: "Google's Gemini models.",
+        family: "gemini",
+        authMode: "api-key",
+        group: "local",
+        order: 80,
+    },
+    {
+        id: "grok",
+        name: "xAI (Grok)",
+        envKey: "XAI_API_KEY",
+        pluginName: "@elizaos/plugin-xai",
+        keyPrefix: "xai-",
+        description: "xAI's Grok models.",
+        family: "grok",
+        authMode: "api-key",
+        group: "local",
+        order: 90,
+    },
+    {
+        id: "groq",
+        name: "Groq",
+        envKey: "GROQ_API_KEY",
+        pluginName: "@elizaos/plugin-groq",
+        keyPrefix: "gsk_",
+        description: "Fast inference.",
+        family: "groq",
+        authMode: "api-key",
+        group: "local",
+        order: 100,
+    },
+    {
+        id: "deepseek",
+        name: "DeepSeek",
+        envKey: "DEEPSEEK_API_KEY",
+        pluginName: "@elizaos/plugin-deepseek",
+        keyPrefix: "sk-",
+        description: "DeepSeek models.",
+        family: "deepseek",
+        authMode: "api-key",
+        group: "local",
+        order: 110,
+    },
+    {
+        id: "mistral",
+        name: "Mistral",
+        envKey: "MISTRAL_API_KEY",
+        pluginName: "@elizaos/plugin-mistral",
+        keyPrefix: null,
+        description: "Mistral AI models.",
+        family: "mistral",
+        authMode: "api-key",
+        group: "local",
+        order: 120,
+    },
+    {
+        id: "together",
+        name: "Together AI",
+        envKey: "TOGETHER_API_KEY",
+        pluginName: "@elizaos/plugin-together",
+        keyPrefix: null,
+        description: "Open-source model hosting.",
+        family: "together",
+        authMode: "api-key",
+        group: "local",
+        order: 130,
+    },
+    {
+        id: "ollama",
+        name: "Ollama",
+        envKey: null,
+        pluginName: "@elizaos/plugin-ollama",
+        keyPrefix: null,
+        description: "Local models, no API key needed.",
+        family: "ollama",
+        authMode: "local",
+        group: "local",
+        order: 140,
+    },
+    {
+        id: "zai",
+        name: "z.ai",
+        envKey: "ZAI_API_KEY",
+        pluginName: "@homunculuslabs/plugin-zai",
+        keyPrefix: null,
+        description: "GLM models via z.ai Coding Plan.",
+        family: "zai",
+        authMode: "api-key",
+        group: "local",
+        order: 150,
+    },
+];
+export const ONBOARDING_CLOUD_PROVIDER_OPTIONS = [
+    {
+        id: "elizacloud",
+        name: "Eliza Cloud",
+        description: "Managed cloud infrastructure. Wallets, LLMs, and RPCs included.",
+    },
+];
+const ONBOARDING_PROVIDER_ALIASES = {
+    "openai-codex": "openai-subscription",
+    "openai-subscription": "openai-subscription",
+    "anthropic-subscription": "anthropic-subscription",
+    google: "gemini",
+    "google-genai": "gemini",
+    gemini: "gemini",
+    xai: "grok",
+    grok: "grok",
+    "together-ai": "together",
+    together: "together",
+    "z.ai": "zai",
+    zai: "zai",
+};
+export function isSubscriptionProviderSelectionId(value) {
+    return SUBSCRIPTION_PROVIDER_SELECTIONS.some((provider) => provider.id === value);
+}
+export function normalizeSubscriptionProviderSelectionId(value) {
+    if (value === "anthropic-subscription")
+        return "anthropic-subscription";
+    if (value === "openai-subscription" || value === "openai-codex") {
+        return "openai-subscription";
+    }
+    return null;
+}
+export function getStoredSubscriptionProvider(selectionId) {
+    return selectionId === "anthropic-subscription"
+        ? "anthropic-subscription"
+        : "openai-codex";
+}
+export function getSubscriptionProviderFamily(selectionId) {
+    return selectionId === "anthropic-subscription" ? "anthropic" : "openai";
+}
+export function normalizeOnboardingProviderId(value) {
+    if (typeof value !== "string")
+        return null;
+    const directMatch = ONBOARDING_PROVIDER_CATALOG.find((provider) => provider.id === value);
+    if (directMatch) {
+        return directMatch.id;
+    }
+    return ONBOARDING_PROVIDER_ALIASES[value] ?? null;
+}
+export function getOnboardingProviderOption(providerId) {
+    const normalized = normalizeOnboardingProviderId(providerId);
+    if (!normalized)
+        return null;
+    return (ONBOARDING_PROVIDER_CATALOG.find((provider) => provider.id === normalized) ?? null);
+}
+export function getOnboardingProviderFamily(providerId) {
+    return getOnboardingProviderOption(providerId)?.family ?? null;
+}
+export function getStoredOnboardingProviderId(providerId) {
+    const provider = getOnboardingProviderOption(providerId);
+    if (!provider)
+        return null;
+    return provider.storedProvider ?? provider.id;
+}
+export function sortOnboardingProviders(providers) {
+    return [...providers].sort((left, right) => {
+        const recommendedDelta = Number(Boolean(right.recommended)) - Number(Boolean(left.recommended));
+        if (recommendedDelta !== 0) {
+            return recommendedDelta;
+        }
+        return left.order - right.order;
+    });
+}
+export function isCloudManagedConnection(connection) {
+    return connection?.kind === "cloud-managed";
+}
+export function isRemoteProviderConnection(connection) {
+    return connection?.kind === "remote-provider";
+}
+export function isLocalProviderConnection(connection) {
+    return connection?.kind === "local-provider";
+}