broods 0.2.0 → 0.2.1

package/dist/cli/index.js

@@ -686,8 +686,56 @@ async function normalizeConfig(resource, projectRoot) {
   }
   return rewriteValues(resource.config);
 }
+var KNOWN_PROVIDER_NAMES = ["google", "openai", "anthropic", "bedrock", "gateway", "minimax", "custom"];
+var KNOWN_PROVIDER_SETTING_KEYS = new Set([
+  "apiKey",
+  "base_url",
+  "baseURL",
+  "headers",
+  "organization",
+  "project",
+  "name",
+  "region",
+  "accessKeyId",
+  "secretAccessKey",
+  "sessionToken"
+]);
+function suggestProviderKey(key) {
+  const canonical = key.replace(/[^a-z0-9]/gi, "").toLowerCase();
+  if (canonical === "baseurl")
+    return `"base_url" or "baseURL"`;
+  if (canonical === "apikey")
+    return `"apiKey"`;
+  return "";
+}
+function validateProviderConfig(agentName, provider) {
+  if (provider === undefined || provider === null)
+    return;
+  if (typeof provider !== "object" || Array.isArray(provider)) {
+    throw new Error(`Agent "${agentName}" config.provider must be an object`);
+  }
+  for (const [providerName, settings] of Object.entries(provider)) {
+    if (!KNOWN_PROVIDER_NAMES.includes(providerName)) {
+      throw new Error(`Agent "${agentName}" config.provider.${providerName} is not a supported provider (expected one of: ${KNOWN_PROVIDER_NAMES.join(", ")})`);
+    }
+    if (typeof settings !== "object" || settings === null || Array.isArray(settings)) {
+      throw new Error(`Agent "${agentName}" config.provider.${providerName} must be an object`);
+    }
+    const record = settings;
+    for (const key of Object.keys(record)) {
+      if (KNOWN_PROVIDER_SETTING_KEYS.has(key))
+        continue;
+      const suggestion = suggestProviderKey(key);
+      throw new Error(`Agent "${agentName}" config.provider.${providerName} has unknown option "${key}"${suggestion ? ` \u2014 did you mean ${suggestion}?` : ""}`);
+    }
+    if (providerName === "custom" && record.base_url === undefined && record.baseURL === undefined) {
+      throw new Error(`Agent "${agentName}" config.provider.custom.base_url is required (use "base_url" or "baseURL")`);
+    }
+  }
+}
 function normalizeAgentConfig(resource, _projectRoot) {
   const config = { ...resource.config };
+  validateProviderConfig(resource.name, config.provider);
   const inlineHooks = normalizeInlineAgentHooks(resource.name, config.hooks);
   if (inlineHooks) {
     config.hooks = inlineHooks.agentHooksConfig;
@@ -2547,7 +2595,7 @@ function renderStreamPart(part, state) {
 // package.json
 var package_default = {
   name: "broods",
-  version: "0.2.0",
+  version: "0.2.1",
   description: "CLI + TypeScript SDK for the broods agent platform.",
   type: "module",
   license: "MIT",
@@ -2602,6 +2650,7 @@ var package_default = {
   devDependencies: {
     "@types/bun": "^1.3.14",
     rollup: "^4.53.3",
+    typescript: "^6.0.3",
     "rollup-plugin-dts": "^6.3.0"
   }
 };

package/dist/index.d.ts

@@ -132,8 +132,28 @@ type AgentModelOutputMetadata = {
     [key: string]: unknown;
 };
 type AgentProviderConfig = Partial<Record<AccountModelProviderName, AgentProviderSettings>>;
+/**
+ * Constructor settings for a model provider. The keys are an explicit allow-list
+ * (no open index signature) so a misspelled option — most commonly the camel
+ * `baseUrl` instead of the canonical `base_url`/`baseURL` — is a compile-time
+ * error in the SDK and is caught by `normalizeProviderSettings` at runtime.
+ * Keep this list in sync with `normalizeProviderSettings` and the SDK's
+ * `KNOWN_PROVIDER_SETTING_KEYS`.
+ */
 interface AgentProviderSettings {
-    [key: string]: unknown;
+    apiKey?: string;
+    /** OpenAI-compatible endpoint (`custom`). Snake form, as documented. */
+    base_url?: string;
+    /** OpenAI-compatible endpoint (`custom`). AI-SDK form; the dashboard writes both. */
+    baseURL?: string;
+    headers?: Record<string, string>;
+    organization?: string;
+    project?: string;
+    name?: string;
+    region?: string;
+    accessKeyId?: string;
+    secretAccessKey?: string;
+    sessionToken?: string;
 }
 interface AgentWorkspaceRef {
     name: string;
@@ -1272,7 +1292,33 @@ type AgentPolicyDefinitionConfig = Omit<AgentPolicyConfig, "policyIds"> & {
  * `workspace:` instead of `workspaces:`. Add a key here when core's `AgentConfig`
  * gains a new top-level field that should be code-definable.
  */
-type AgentDefinitionConfig = EnvRefString<Pick<AgentConfig, "agent" | "model" | "provider" | "session" | "tools">> & {
+/**
+ * SDK-facing model-provider constructor settings. Written as an explicit
+ * interface — NOT `EnvRefString<AgentProviderSettings>` — because TypeScript
+ * suppresses excess-property checks through mapped types, which would let a
+ * typo like the camel `baseUrl` (instead of `base_url`/`baseURL`) slip past
+ * `tsc`. Keep the keys in lockstep with core's `AgentProviderSettings`; the
+ * `_ProviderKeyParity` assertion below fails `broods check` if they drift.
+ * Every string field also accepts an `env(...)` reference.
+ */
+interface ProviderSettingsInput {
+    apiKey?: string | EnvRef;
+    base_url?: string | EnvRef;
+    baseURL?: string | EnvRef;
+    headers?: Record<string, string | EnvRef>;
+    organization?: string | EnvRef;
+    project?: string | EnvRef;
+    name?: string | EnvRef;
+    region?: string | EnvRef;
+    accessKeyId?: string | EnvRef;
+    secretAccessKey?: string | EnvRef;
+    sessionToken?: string | EnvRef;
+}
+/** Per-provider settings; provider names stay synced with core's `AgentConfig`. */
+type ProviderConfigInput = Partial<Record<keyof NonNullable<AgentConfig["provider"]>, ProviderSettingsInput>>;
+type AgentDefinitionConfig = EnvRefString<Pick<AgentConfig, "agent" | "model" | "session" | "tools">> & {
+    provider?: ProviderConfigInput;
+} & {
     hooks?: AgentHooks & {
         webhooks?: readonly EnvRefString<AgentWebhookHookConfig>[];
     };
@@ -1334,4 +1380,4 @@ declare function isChannelDefinition(value: unknown): value is AnyChannelDefinit
 declare function isBroodsConfig(value: unknown): value is BroodsConfigDefinition;
 
 export { BroodsClient, BroodsWebSocketClient, DEFAULT_CORE_BASE_URL, MAX_OBSERVABILITY_BACKFILL, BroodsWebSocketClient as WebSocketClient, BroodsWebSocketClient as WebsocketClient, defineAgent, defineBroods, defineCron, defineDiscordChannel, defineGitHubChannel, definePancakeChannel, definePolicy, defineSandbox, defineSkill, defineSlackChannel, defineTelegramChannel, defineTool, defineWorkspace, defineZaloChannel, env, isBroodsConfig, isChannelDefinition, isObservabilityClientMessage, isResource, normalizeHttpServiceUrl, readSseStream, resolveRunEvents, toWebSocketBaseUrl };
-export type { Account, Agent, AgentChannelWorkspaceScope, AgentChannelsConfig, AgentCodeHookConfig, AgentConfig, AgentConfigDoc, AgentDefinitionConfig, AgentDiscordChannelConfig, AgentGitHubChannelConfig, AgentHandle, AgentHookEventName, AgentHooks, AgentHooksConfig, AgentPancakeChannelConfig, AgentPolicyConfig, AgentPolicyDefinitionConfig, AgentPolicyDocument, AgentReference, AgentResource, AgentRunEventInput, AgentRunInput, AgentRunModelOverrides, AgentRunOverrides, AgentRunResult, AgentSkillsDefinitionConfig, AgentSlackChannelConfig, AgentStreamPart, AgentSubagentDefinitionConfig, AgentTelegramChannelConfig, AgentWebhookHookConfig, AgentWorkspaceInput, AgentWorkspaceRef, AgentWorkspaceRefInput, AgentZaloChannelConfig, AnyChannelDefinition, AnyResource, AsyncAgentRun, AsyncPollOptions, AsyncRequestAccepted, AsyncStatus, BroodsClientOptions, BroodsConfigDefinition, BroodsProjectConfig, BroodsWebSocketClientOptions, ChannelDefinition, ChannelMessageReceived, ChannelReference, ChannelType, CliManifest, CliManifestResource, CliResourceKind, CreateClientCronInput, CreateCronInput, Cron, CronDefinitionConfig, CronDoc, CronLastStatus, CronResource, CronRun, CronStatus, CustomTool, DiscordChannelDefinition, DiscordChannelInput, DiscordMessageSource, DiscordSource, Doc, EnvAccessor, EnvRef, EnvRefString, EnvironmentDoc, GeneratedIds, GitHubChannelDefinition, GitHubChannelInput, GitHubMessageSource, GitHubSource, HookContext, Id, LogLevel, ObservabilityBackfillMessage, ObservabilityClientMessage, ObservabilityErrorMessage, ObservabilityLogEntry, ObservabilityLogMessage, ObservabilityReadyMessage, ObservabilityServerMessage, ObservabilitySpanMessage, ObservabilitySpanRow, ObservabilitySubscribeMessage, ObservabilityUnsubscribeMessage, PancakeChannelDefinition, PancakeChannelInput, PancakeMessageSource, PancakeSource, PolicyDefinitionConfig, PolicyResource, ProjectDoc, ResourceApi, ResourceDefinition, ResourceDefinitionInput, ResourceKind, Sandbox, SandboxConfig, SandboxConfigDoc, SandboxDefinitionConfig, SandboxResource, Skill, SkillDefinitionConfig, SkillResource, SlackChannelDefinition, SlackChannelInput, SlackMessageSource, SlackSource, TelegramChannelDefinition, TelegramChannelInput, TelegramMessageSource, TelegramSource, ToolApprovalSummary, ToolDefinitionConfig, ToolResource, UpdateCronInput, WebSocketClientCancelMessage, WebSocketClientExecuteMessage, WebSocketClientMessage, WebSocketConstructorLike, WebSocketHandlers, WebSocketLike, WebSocketRunInput, WebSocketServerMessage, WebSocketStreamMessage, WebSocketSubscription, Workspace, WorkspaceConfig, WorkspaceConfigDoc, WorkspaceResource, ZaloChannelDefinition, ZaloChannelInput, ZaloMessageSource, ZaloSource };
+export type { Account, Agent, AgentChannelWorkspaceScope, AgentChannelsConfig, AgentCodeHookConfig, AgentConfig, AgentConfigDoc, AgentDefinitionConfig, AgentDiscordChannelConfig, AgentGitHubChannelConfig, AgentHandle, AgentHookEventName, AgentHooks, AgentHooksConfig, AgentPancakeChannelConfig, AgentPolicyConfig, AgentPolicyDefinitionConfig, AgentPolicyDocument, AgentProviderSettings, AgentReference, AgentResource, AgentRunEventInput, AgentRunInput, AgentRunModelOverrides, AgentRunOverrides, AgentRunResult, AgentSkillsDefinitionConfig, AgentSlackChannelConfig, AgentStreamPart, AgentSubagentDefinitionConfig, AgentTelegramChannelConfig, AgentWebhookHookConfig, AgentWorkspaceInput, AgentWorkspaceRef, AgentWorkspaceRefInput, AgentZaloChannelConfig, AnyChannelDefinition, AnyResource, AsyncAgentRun, AsyncPollOptions, AsyncRequestAccepted, AsyncStatus, BroodsClientOptions, BroodsConfigDefinition, BroodsProjectConfig, BroodsWebSocketClientOptions, ChannelDefinition, ChannelMessageReceived, ChannelReference, ChannelType, CliManifest, CliManifestResource, CliResourceKind, CreateClientCronInput, CreateCronInput, Cron, CronDefinitionConfig, CronDoc, CronLastStatus, CronResource, CronRun, CronStatus, CustomTool, DiscordChannelDefinition, DiscordChannelInput, DiscordMessageSource, DiscordSource, Doc, EnvAccessor, EnvRef, EnvRefString, EnvironmentDoc, GeneratedIds, GitHubChannelDefinition, GitHubChannelInput, GitHubMessageSource, GitHubSource, HookContext, Id, LogLevel, ObservabilityBackfillMessage, ObservabilityClientMessage, ObservabilityErrorMessage, ObservabilityLogEntry, ObservabilityLogMessage, ObservabilityReadyMessage, ObservabilityServerMessage, ObservabilitySpanMessage, ObservabilitySpanRow, ObservabilitySubscribeMessage, ObservabilityUnsubscribeMessage, PancakeChannelDefinition, PancakeChannelInput, PancakeMessageSource, PancakeSource, PolicyDefinitionConfig, PolicyResource, ProjectDoc, ProviderConfigInput, ProviderSettingsInput, ResourceApi, ResourceDefinition, ResourceDefinitionInput, ResourceKind, Sandbox, SandboxConfig, SandboxConfigDoc, SandboxDefinitionConfig, SandboxResource, Skill, SkillDefinitionConfig, SkillResource, SlackChannelDefinition, SlackChannelInput, SlackMessageSource, SlackSource, TelegramChannelDefinition, TelegramChannelInput, TelegramMessageSource, TelegramSource, ToolApprovalSummary, ToolDefinitionConfig, ToolResource, UpdateCronInput, WebSocketClientCancelMessage, WebSocketClientExecuteMessage, WebSocketClientMessage, WebSocketConstructorLike, WebSocketHandlers, WebSocketLike, WebSocketRunInput, WebSocketServerMessage, WebSocketStreamMessage, WebSocketSubscription, Workspace, WorkspaceConfig, WorkspaceConfigDoc, WorkspaceResource, ZaloChannelDefinition, ZaloChannelInput, ZaloMessageSource, ZaloSource };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "broods",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "CLI + TypeScript SDK for the broods agent platform.",
   "type": "module",
   "license": "MIT",
@@ -55,6 +55,7 @@
   "devDependencies": {
     "@types/bun": "^1.3.14",
     "rollup": "^4.53.3",
+    "typescript": "^6.0.3",
     "rollup-plugin-dts": "^6.3.0"
   }
 }