@elizaos/client 1.5.5-alpha.10

package/src/config/agent-templates.ts

@@ -0,0 +1,349 @@
+import type { Agent } from '@elizaos/core';
+
+/**
+ * Templates for quick-start agent creation
+ */
+export interface AgentTemplate {
+  id: string;
+  label: string;
+  description: string;
+  template: Partial<Agent>;
+}
+
+/**
+ * Predefined agent templates based on The Org agents and client types
+ */
+export const agentTemplates: AgentTemplate[] = [
+  {
+    id: 'none',
+    label: 'None (Start Blank)',
+    description: 'Start with an empty configuration',
+    template: {
+      name: '',
+      username: '',
+      system: '',
+      bio: [],
+      topics: [],
+      adjectives: [],
+      plugins: ['@elizaos/plugin-sql', '@elizaos/plugin-openai', '@elizaos/plugin-bootstrap'],
+      settings: { secrets: {} },
+    },
+  },
+
+  // Client-specific agents
+  {
+    id: 'discord-bot',
+    label: 'Discord Bot',
+    description: 'Interactive Discord bot that handles server interactions',
+    template: {
+      name: 'Discord Assistant',
+      username: 'discordbot',
+      system:
+        'You are a Discord bot designed to assist users in a Discord server. You respond to messages, handle commands, and provide helpful information to community members. You should be friendly, helpful, and maintain a consistent personality. Focus on providing value to the community through clear, concise responses.',
+      bio: [
+        'Helpful Discord community assistant',
+        'Responds to commands and natural language queries',
+        'Assists with server-specific information and resources',
+        'Maintains a friendly and helpful tone',
+      ],
+      topics: ['Discord server', 'Community assistance', 'Command handling', 'Server information'],
+      adjectives: ['Helpful', 'Responsive', 'Friendly', 'Informative', 'Reliable'],
+      plugins: [
+        '@elizaos/plugin-sql',
+        '@elizaos/plugin-openai',
+        '@elizaos/plugin-bootstrap',
+        '@elizaos/plugin-discord',
+      ],
+      style: {
+        all: [
+          'Be friendly and helpful',
+          'Use clear, concise language',
+          'Follow Discord conventions',
+        ],
+        chat: [
+          'Respond promptly to queries',
+          'Use appropriate formatting for clarity',
+          'Reference relevant commands when helpful',
+        ],
+        post: [
+          'Structure longer responses with clear sections',
+          'Use embeds for rich content when appropriate',
+        ],
+      },
+      settings: {
+        secrets: {},
+      },
+    },
+  },
+  {
+    id: 'telegram-bot',
+    label: 'Telegram Bot',
+    description: 'Interactive bot for Telegram channels and groups',
+    template: {
+      name: 'Telegram Assistant',
+      username: 'telegrambot',
+      system:
+        'You are a helpful Telegram bot designed to assist users in channels and groups. You respond to commands and natural language queries, providing information, assistance, and engaging with users in a friendly manner. You can handle both one-on-one conversations and group interactions, adapting your tone and content accordingly while respecting privacy and community guidelines.',
+      bio: [
+        'Interactive Telegram bot',
+        'Assists users in channels and groups',
+        'Responds to commands and natural language',
+      ],
+      topics: [
+        'Channel information',
+        'User assistance',
+        'Content sharing',
+        'Group moderation',
+        'FAQ responses',
+      ],
+      adjectives: ['Helpful', 'Responsive', 'Friendly', 'Informative', 'Reliable'],
+      plugins: [
+        '@elizaos/plugin-sql',
+        '@elizaos/plugin-openai',
+        '@elizaos/plugin-bootstrap',
+        '@elizaos/plugin-telegram',
+      ],
+      style: {
+        all: [
+          'Be concise and clear',
+          'Use Telegram-friendly formatting',
+          'Respond promptly to user queries',
+        ],
+        chat: [
+          'Handle commands efficiently',
+          'Include relevant emoji when appropriate',
+          'Maintain conversation context',
+        ],
+        post: [
+          'Structure longer messages clearly',
+          'Use formatting for better readability',
+          'Include relevant links when helpful',
+        ],
+      },
+      settings: {
+        clients: ['telegram'],
+        allowDirectMessages: true,
+        shouldOnlyJoinInAllowedGroups: false,
+        messageTrackingLimit: 100,
+        secrets: {},
+      },
+    },
+  },
+  {
+    id: 'slack-bot',
+    label: 'Slack Bot',
+    description: 'Interactive bot for Slack workspaces',
+    template: {
+      name: 'Slack Assistant',
+      username: 'slackbot',
+      system:
+        "You are a specialized assistant for Slack workspaces. You help teams by answering questions, providing information, and facilitating collaboration. You can respond to direct messages and channel mentions, maintaining a helpful and professional tone that aligns with the organization's culture. Keep responses concise and relevant to the conversation context.",
+      bio: [
+        'Specialized Slack workspace assistant',
+        'Facilitates team collaboration',
+        'Provides timely responses to queries',
+      ],
+      topics: [
+        'Workspace information',
+        'Team collaboration',
+        'Company policies',
+        'Resource access',
+        'Task management',
+      ],
+      adjectives: ['Responsive', 'Helpful', 'Organized', 'Team-oriented', 'Professional'],
+      plugins: [
+        '@elizaos/plugin-sql',
+        '@elizaos/plugin-openai',
+        '@elizaos/plugin-bootstrap',
+        '@elizaos/plugin-slack',
+      ],
+      style: {
+        all: [
+          'Be concise and clear',
+          'Match the tone of the workspace',
+          'Use Slack-appropriate formatting',
+        ],
+        chat: [
+          'Reference relevant messages when appropriate',
+          'Use thread replies for detailed responses',
+          'Include emojis when fitting the workspace culture',
+        ],
+        post: [
+          'Structure information with clear sections',
+          'Use bullet points for lists',
+          'Include relevant links when helpful',
+        ],
+      },
+      settings: {
+        secrets: {},
+      },
+    },
+  },
+  {
+    id: 'twitter-agent',
+    label: 'Twitter/X Agent',
+    description: 'Manages Twitter presence and engagement',
+    template: {
+      name: 'Twitter Agent',
+      username: 'twitteragent',
+      system:
+        'You are a Twitter engagement specialist designed to help create and manage effective Twitter content. You assist with drafting tweets, responding to mentions, analyzing engagement metrics, and suggesting content strategies. Your tone should match the brand voice while maintaining authenticity and encouraging audience interaction. Keep tweets concise and impactful within character limits.',
+      bio: [
+        'Twitter engagement specialist',
+        'Creates compelling social content',
+        'Manages audience interactions',
+      ],
+      topics: [
+        'Tweet creation',
+        'Audience engagement',
+        'Content strategy',
+        'Trend analysis',
+        'Brand voice',
+      ],
+      adjectives: ['Engaging', 'Concise', 'Strategic', 'Conversational', 'Creative'],
+      plugins: [
+        '@elizaos/plugin-sql',
+        '@elizaos/plugin-openai',
+        '@elizaos/plugin-bootstrap',
+        '@elizaos/plugin-twitter',
+      ],
+      style: {
+        all: [
+          'Be concise and impactful',
+          'Stay within character limits',
+          'Use platform-appropriate formatting',
+        ],
+        chat: [
+          'Match brand voice in replies',
+          'Be conversational and authentic',
+          'Use hashtags strategically',
+        ],
+        post: [
+          'Draft varied content types',
+          'Suggest engaging visuals or polls',
+          'Include call-to-actions when appropriate',
+        ],
+      },
+      settings: {
+        TWITTER_DRY_RUN: false,
+        MAX_TWEET_LENGTH: 280,
+        TWITTER_ENABLE_POST_GENERATION: true,
+        TWITTER_POST_INTERVAL_MIN: 90,
+        TWITTER_POST_INTERVAL_MAX: 180,
+        secrets: {},
+      },
+    },
+  },
+  {
+    id: 'github-bot',
+    label: 'GitHub Repository Assistant',
+    description: 'Helps manage GitHub repositories and development workflows',
+    template: {
+      name: 'GitHub Assistant',
+      username: 'githubasst',
+      system:
+        'You are a GitHub repository assistant designed to help development teams manage their workflow and codebase. You can assist with pull request reviews, issue triage, documentation updates, and providing information about repository structure and conventions. Maintain a technical but approachable tone, and prioritize accuracy in all technical information.',
+      bio: [
+        'GitHub repository management specialist',
+        'Assists with development workflows',
+        'Provides code and documentation support',
+      ],
+      topics: [
+        'Pull requests',
+        'Issue tracking',
+        'Repository structure',
+        'Code reviews',
+        'Development workflows',
+      ],
+      adjectives: ['Technical', 'Precise', 'Helpful', 'Organized', 'Knowledgeable'],
+      plugins: [
+        '@elizaos/plugin-sql',
+        '@elizaos/plugin-openai',
+        '@elizaos/plugin-bootstrap',
+        '@elizaos/plugin-github',
+      ],
+      style: {
+        all: [
+          'Use technically precise language',
+          'Reference GitHub concepts appropriately',
+          'Link to relevant documentation when helpful',
+        ],
+        chat: [
+          'Be concise in comments',
+          'Format code snippets properly',
+          'Summarize technical points clearly',
+        ],
+        post: [
+          'Structure longer responses with clear headings',
+          'Use code blocks with syntax highlighting',
+          'Link to specific lines of code when relevant',
+        ],
+      },
+      settings: {
+        secrets: {},
+      },
+    },
+  },
+  {
+    id: 'instagram-agent',
+    label: 'Instagram Content Manager',
+    description: 'Creates and manages content for Instagram',
+    template: {
+      name: 'Instagram Manager',
+      username: 'instagrammgr',
+      system:
+        "You are an Instagram content specialist designed to help create and manage engaging Instagram presence. You assist with content creation, caption writing, hashtag strategy, engagement tactics, and understanding analytics. Your approach emphasizes visual storytelling, authenticity, and building connections with followers. Maintain a voice that matches the brand identity while adapting to Instagram's evolving features and trends.",
+      bio: [
+        'Instagram content creation specialist',
+        'Develops engaging visual storytelling',
+        'Optimizes profile engagement',
+      ],
+      topics: [
+        'Content creation',
+        'Caption writing',
+        'Hashtag strategy',
+        'Engagement tactics',
+        'Visual aesthetics',
+      ],
+      adjectives: ['Creative', 'Visual', 'Engaging', 'Trend-aware', 'Authentic'],
+      plugins: [
+        '@elizaos/plugin-sql',
+        '@elizaos/plugin-openai',
+        '@elizaos/plugin-bootstrap',
+        '@elizaos/plugin-instagram',
+      ],
+      style: {
+        all: [
+          'Balance visual description with compelling text',
+          'Maintain brand voice consistency',
+          'Consider current platform trends',
+        ],
+        chat: [
+          'Provide actionable content suggestions',
+          'Reference visual elements clearly',
+          'Include relevant hashtag recommendations',
+        ],
+        post: [
+          'Craft captions that enhance visual content',
+          'Suggest content series and themes',
+          'Balance promotional with authentic content',
+        ],
+      },
+      settings: {
+        POST_INTERVAL_MIN: 90,
+        POST_INTERVAL_MAX: 180,
+        ENABLE_ACTION_PROCESSING: true,
+        ACTION_INTERVAL: 5,
+        MAX_ACTIONS_PROCESSING: 1,
+        secrets: {},
+      },
+    },
+  },
+];
+
+/**
+ * Get a template by its ID
+ */
+export function getTemplateById(id: string): AgentTemplate | undefined {
+  return agentTemplates.find((template) => template.id === id);
+}

package/src/config/voice-models.ts

@@ -0,0 +1,181 @@
+export interface VoiceModel {
+  value: string;
+  label: string;
+  provider: 'elevenlabs' | 'openai' | 'none';
+  gender?: 'male' | 'female';
+  language?: string;
+  features?: string[];
+}
+
+// TODO: ELI2-218 Refactor this to use plugin categories when available
+// This hardcoded mapping will be replaced with a more flexible approach
+// that leverages plugin category metadata once implemented
+
+export const providerPluginMap: Record<string, string> = {
+  elevenlabs: '@elizaos/plugin-elevenlabs',
+  openai: '@elizaos/plugin-openai',
+  none: '', // No plugin needed for "No Voice" option
+};
+
+// No voice option for agents that don't need speech capabilities
+export const noVoiceModel: VoiceModel[] = [{ value: 'none', label: 'No Voice', provider: 'none' }];
+
+export const localVoiceModels: VoiceModel[] = [];
+
+export const elevenLabsVoiceModels: VoiceModel[] = [
+  {
+    value: 'EXAVITQu4vr4xnSDxMaL',
+    label: 'ElevenLabs - Rachel (Default)',
+    provider: 'elevenlabs',
+    gender: 'female',
+    language: 'en',
+    features: ['natural', 'professional'],
+  },
+  {
+    value: '21m00Tcm4TlvDq8ikWAM',
+    label: 'ElevenLabs - Adam',
+    provider: 'elevenlabs',
+    gender: 'male',
+    language: 'en',
+    features: ['natural', 'professional'],
+  },
+  {
+    value: 'AZnzlk1XvdvUeBnXmlld',
+    label: 'ElevenLabs - Domi',
+    provider: 'elevenlabs',
+    gender: 'female',
+    language: 'en',
+    features: ['natural', 'friendly'],
+  },
+  {
+    value: 'MF3mGyEYCl7XYWbV9V6O',
+    label: 'ElevenLabs - Elli',
+    provider: 'elevenlabs',
+    gender: 'female',
+    language: 'en',
+    features: ['natural', 'friendly'],
+  },
+  {
+    value: 'TxGEqnHWrfWFTfGW9XjX',
+    label: 'ElevenLabs - Josh',
+    provider: 'elevenlabs',
+    gender: 'male',
+    language: 'en',
+    features: ['natural', 'professional'],
+  },
+];
+
+export const openAIVoiceModels: VoiceModel[] = [
+  {
+    value: 'alloy',
+    label: 'OpenAI - Alloy',
+    provider: 'openai',
+    gender: 'female',
+    language: 'en',
+    features: ['natural', 'versatile'],
+  },
+  {
+    value: 'echo',
+    label: 'OpenAI - Echo',
+    provider: 'openai',
+    gender: 'male',
+    language: 'en',
+    features: ['natural', 'professional'],
+  },
+  {
+    value: 'fable',
+    label: 'OpenAI - Fable',
+    provider: 'openai',
+    gender: 'male',
+    language: 'en',
+    features: ['natural', 'narrative'],
+  },
+  {
+    value: 'onyx',
+    label: 'OpenAI - Onyx',
+    provider: 'openai',
+    gender: 'male',
+    language: 'en',
+    features: ['natural', 'deep'],
+  },
+  {
+    value: 'nova',
+    label: 'OpenAI - Nova',
+    provider: 'openai',
+    gender: 'female',
+    language: 'en',
+    features: ['natural', 'friendly'],
+  },
+  {
+    value: 'shimmer',
+    label: 'OpenAI - Shimmer',
+    provider: 'openai',
+    gender: 'female',
+    language: 'en',
+    features: ['natural', 'bright'],
+  },
+  {
+    value: 'ash',
+    label: 'OpenAI - Ash',
+    provider: 'openai',
+    gender: 'male',
+    language: 'en',
+    features: ['natural', 'calm'],
+  },
+  {
+    value: 'coral',
+    label: 'OpenAI - Coral',
+    provider: 'openai',
+    gender: 'female',
+    language: 'en',
+    features: ['natural', 'warm'],
+  },
+  {
+    value: 'sage',
+    label: 'OpenAI - Sage',
+    provider: 'openai',
+    gender: 'female',
+    language: 'en',
+    features: ['natural', 'wise'],
+  },
+  {
+    value: 'ballad',
+    label: 'OpenAI - Ballad',
+    provider: 'openai',
+    gender: 'male',
+    language: 'en',
+    features: ['natural', 'melodic'],
+  },
+];
+
+export const getAllVoiceModels = (): VoiceModel[] => {
+  return [...noVoiceModel, ...localVoiceModels, ...elevenLabsVoiceModels, ...openAIVoiceModels];
+};
+
+export const getVoiceModelsByProvider = (
+  provider: 'elevenlabs' | 'openai' | 'none'
+): VoiceModel[] => {
+  switch (provider) {
+    case 'elevenlabs':
+      return elevenLabsVoiceModels;
+    case 'openai':
+      return openAIVoiceModels;
+    case 'none':
+      return noVoiceModel;
+    default:
+      return [];
+  }
+};
+
+export const getVoiceModelByValue = (value: string): VoiceModel | undefined => {
+  return getAllVoiceModels().find((model) => model.value === value);
+};
+
+export const getRequiredPluginForProvider = (provider: string): string | undefined => {
+  return providerPluginMap[provider];
+};
+
+export const getAllRequiredPlugins = (): string[] => {
+  // Filter out empty strings (for "none" provider)
+  return Object.values(providerPluginMap).filter(Boolean);
+};

package/src/constants.ts

@@ -0,0 +1,23 @@
+export const USER_NAME = 'user';
+export const CHAT_SOURCE = 'client_chat';
+export const GROUP_CHAT_SOURCE = 'client_group_chat';
+
+export const AVATAR_IMAGE_MAX_SIZE = 512;
+
+export enum FIELD_REQUIREMENT_TYPE {
+  REQUIRED = 'required',
+  OPTIONAL = 'optional',
+}
+
+export const FIELD_REQUIREMENTS = {
+  name: FIELD_REQUIREMENT_TYPE.REQUIRED,
+  username: FIELD_REQUIREMENT_TYPE.OPTIONAL,
+  system: FIELD_REQUIREMENT_TYPE.REQUIRED,
+  'settings.voice.model': FIELD_REQUIREMENT_TYPE.OPTIONAL,
+  bio: FIELD_REQUIREMENT_TYPE.OPTIONAL,
+  topics: FIELD_REQUIREMENT_TYPE.OPTIONAL,
+  adjectives: FIELD_REQUIREMENT_TYPE.OPTIONAL,
+  'style.all': FIELD_REQUIREMENT_TYPE.OPTIONAL,
+  'style.chat': FIELD_REQUIREMENT_TYPE.OPTIONAL,
+  'style.post': FIELD_REQUIREMENT_TYPE.OPTIONAL,
+};

package/src/context/AuthContext.tsx

@@ -0,0 +1,44 @@
+import { createContext, useState, useContext, ReactNode, useCallback } from 'react';
+import { useQueryClient } from '@tanstack/react-query';
+import { ApiKeyDialog } from '@/components/api-key-dialog';
+import clientLogger from '@/lib/logger';
+
+interface AuthContextType {
+  openApiKeyDialog: () => void;
+}
+
+const AuthContext = createContext<AuthContextType | undefined>(undefined);
+
+export const AuthProvider = ({ children }: { children: ReactNode }) => {
+  const queryClient = useQueryClient();
+  const [isApiKeyDialogOpen, setIsApiKeyDialogOpen] = useState(false);
+
+  const openApiKeyDialog = useCallback(() => {
+    setIsApiKeyDialogOpen(true);
+  }, []);
+
+  const handleApiKeySaved = useCallback(() => {
+    setIsApiKeyDialogOpen(false);
+    clientLogger.info('API key saved via dialog, invalidating ping query.');
+    queryClient.invalidateQueries({ queryKey: ['ping'] });
+  }, [queryClient]);
+
+  return (
+    <AuthContext.Provider value={{ openApiKeyDialog }}>
+      {children}
+      <ApiKeyDialog
+        open={isApiKeyDialogOpen}
+        onOpenChange={setIsApiKeyDialogOpen}
+        onApiKeySaved={handleApiKeySaved}
+      />
+    </AuthContext.Provider>
+  );
+};
+
+export const useAuth = () => {
+  const context = useContext(AuthContext);
+  if (context === undefined) {
+    throw new Error('useAuth must be used within an AuthProvider');
+  }
+  return context;
+};