@amitdeshmukh/ax-crew 4.1.2 → 6.0.0

package/src/types.ts

@@ -3,26 +3,13 @@ import type {
   AxSignature, 
   AxModelConfig,
   AxMCPStreamableHTTPTransportOptions,
-  AxProgramForwardOptions
+  AxProgramForwardOptions,
+  AxAIArgs
 } from '@ax-llm/ax';
 
-// Canonical provider slugs supported by ai() factory
-export type Provider =
-  // Canonical slugs per docs
-  | 'openai'
-  | 'anthropic'
-  | 'google-gemini'
-  | 'mistral'
-  | 'groq'
-  | 'cohere'
-  | 'together'
-  | 'deepseek'
-  | 'ollama'
-  | 'huggingface'
-  | 'openrouter'
-  | 'azure-openai'
-  | 'reka'
-  | 'x-grok'
+// Provider ids are derived from Ax's factory arg type so new providers added in Ax
+// are picked up at compile time without updating AxCrew.
+export type Provider = AxAIArgs<any>['name'];
 
 /**
  * A state instance that is shared between agents.
@@ -196,6 +183,11 @@ interface AgentConfig {
   ai: AxModelConfig & { model: string };
   debug?: boolean;
   apiURL?: string;
+  /**
+   * Provider-specific arguments that are forwarded to the underlying Ax factory.
+   * Example (azure-openai): { resourceName, deploymentName, version }
+   */
+  providerArgs?: Record<string, unknown>;
   options?: Partial<AxProgramForwardOptions<any>> & Record<string, any>;
   functions?: string[];
   agents?: string[];
@@ -204,13 +196,49 @@ interface AgentConfig {
 }
 
 /**
- * The input type for the agent config. This can be a path to a JSON file or a JSON object.
+ * The configuration object for an AxCrew instance.
+ * 
+ * @property {AgentConfig[]} crew - The agents that make up the crew.
+ * @example
+ * const config: AxCrewConfig = {
+ *   crew: [
+ *     {
+ *       name: "Agent1",
+ *       description: "Agent 1 description",
+ *       signature: "signature",
+ *       provider: "provider",
+ *       providerKeyName: "providerKeyName",
+ *       ai: {
+ *         model: "model",
+ *         temperature: 0,
+ *       },
+ *       options: {
+ *         debug: true,
+ *       },
+ *       functions: ["function1", "function2"],
+ *       agents: ["agent2"],
+ *     },
+ *     {
+ *       name: "Agent2",
+ *       description: "Agent 2 description",
+ *       signature: "signature",
+ *       provider: "provider",
+ *       providerKeyName: "providerKeyName",
+ *       ai: {
+ *         model: "model",
+ *         temperature: 0,
+ *       }
+ *   ]
+ * }
+ * const crew = new AxCrew(config);
  */
-type CrewConfigInput = string | { crew: AgentConfig[] };
+interface AxCrewConfig {
+  crew: AgentConfig[]
+}
 
 export {
   type AgentConfig,
-  type CrewConfigInput,
+  type AxCrewConfig,
   type AggregatedMetrics,
   type StateInstance,
   type FunctionRegistryType,

package/dist/config/index.d.ts

@@ -1,5 +0,0 @@
-interface ProviderApiKeys {
-    [key: string]: string | undefined;
-}
-declare const PROVIDER_API_KEYS: ProviderApiKeys;
-export { PROVIDER_API_KEYS, };

package/dist/config/index.js

@@ -1,30 +0,0 @@
-import dotenv from 'dotenv';
-dotenv.config();
-// AI API keys
-const ANTHROPIC_API_KEY = process.env.ANTHROPIC_API_KEY;
-const OPENAI_API_KEY = process.env.OPENAI_API_KEY;
-const AZURE_OPENAI_API_KEY = process.env.AZURE_OPENAI_API_KEY;
-const COHERE_API_KEY = process.env.COHERE_API_KEY;
-const DEEPSEEK_API_KEY = process.env.DEEPSEEK_API_KEY;
-const GEMINI_API_KEY = process.env.GEMINI_API_KEY;
-const GROQ_API_KEY = process.env.GROQ_API_KEY;
-const TOGETHER_API_KEY = process.env.TOGETHER_API_KEY;
-const MISTRAL_API_KEY = process.env.MISTRAL_API_KEY;
-const HUGGINGFACE_API_KEY = process.env.HUGGINGFACE_API_KEY;
-const REKA_API_KEY = process.env.REKA_API_KEY;
-const GROK_API_KEY = process.env.GROK_API_KEY;
-const PROVIDER_API_KEYS = {
-    COHERE_API_KEY,
-    GEMINI_API_KEY,
-    OPENAI_API_KEY,
-    AZURE_OPENAI_API_KEY,
-    ANTHROPIC_API_KEY,
-    DEEPSEEK_API_KEY,
-    GROQ_API_KEY,
-    TOGETHER_API_KEY,
-    MISTRAL_API_KEY,
-    HUGGINGFACE_API_KEY,
-    REKA_API_KEY,
-    GROK_API_KEY
-};
-export { PROVIDER_API_KEYS, };

package/src/config/index.ts

@@ -1,40 +0,0 @@
-import dotenv from 'dotenv';
-dotenv.config();
-
-// AI API keys
-const ANTHROPIC_API_KEY: string | undefined = process.env.ANTHROPIC_API_KEY;
-const OPENAI_API_KEY: string | undefined = process.env.OPENAI_API_KEY;
-const AZURE_OPENAI_API_KEY: string | undefined = process.env.AZURE_OPENAI_API_KEY;
-const COHERE_API_KEY: string | undefined = process.env.COHERE_API_KEY;
-const DEEPSEEK_API_KEY: string | undefined = process.env.DEEPSEEK_API_KEY;
-const GEMINI_API_KEY: string | undefined = process.env.GEMINI_API_KEY;
-const GROQ_API_KEY: string | undefined = process.env.GROQ_API_KEY;
-const TOGETHER_API_KEY: string | undefined = process.env.TOGETHER_API_KEY;
-const MISTRAL_API_KEY: string | undefined = process.env.MISTRAL_API_KEY;
-const HUGGINGFACE_API_KEY: string | undefined = process.env.HUGGINGFACE_API_KEY;
-const REKA_API_KEY: string | undefined = process.env.REKA_API_KEY;
-const GROK_API_KEY: string | undefined = process.env.GROK_API_KEY;
-// Note: Ollama typically doesn't require an API key for local usage
-
-interface ProviderApiKeys {
-  [key: string]: string | undefined;
-}
-
-const PROVIDER_API_KEYS: ProviderApiKeys = {
-  COHERE_API_KEY,
-  GEMINI_API_KEY,
-  OPENAI_API_KEY,
-  AZURE_OPENAI_API_KEY,
-  ANTHROPIC_API_KEY,
-  DEEPSEEK_API_KEY,
-  GROQ_API_KEY,
-  TOGETHER_API_KEY,
-  MISTRAL_API_KEY,
-  HUGGINGFACE_API_KEY,
-  REKA_API_KEY,
-  GROK_API_KEY
-};
-
-export {
-  PROVIDER_API_KEYS,
-};