clawchef 0.1.0

package/src/schema.ts

@@ -0,0 +1,157 @@
+import { z } from "zod";
+
+const paramDefSchema = z.object({
+  default: z.string().optional(),
+  required: z.boolean().optional(),
+  description: z.string().optional(),
+});
+
+const openClawCommandsSchema = z
+  .object({
+    use_version: z.string().optional(),
+    install_version: z.string().optional(),
+    uninstall_version: z.string().optional(),
+    factory_reset: z.string().optional(),
+    start_gateway: z.string().optional(),
+    enable_plugin: z.string().optional(),
+    login_channel: z.string().optional(),
+    create_workspace: z.string().optional(),
+    create_agent: z.string().optional(),
+    install_skill: z.string().optional(),
+    send_message: z.string().optional(),
+    run_agent: z.string().optional(),
+  })
+  .strict();
+
+const openClawBootstrapSchema = z
+  .object({
+    non_interactive: z.boolean().optional(),
+    accept_risk: z.boolean().optional(),
+    mode: z.enum(["local", "remote"]).optional(),
+    flow: z.enum(["quickstart", "advanced", "manual"]).optional(),
+    auth_choice: z.string().optional(),
+    workspace: z.string().optional(),
+    reset: z.boolean().optional(),
+    skip_channels: z.boolean().optional(),
+    skip_skills: z.boolean().optional(),
+    skip_health: z.boolean().optional(),
+    skip_ui: z.boolean().optional(),
+    skip_daemon: z.boolean().optional(),
+    install_daemon: z.boolean().optional(),
+    openai_api_key: z.string().optional(),
+    anthropic_api_key: z.string().optional(),
+    openrouter_api_key: z.string().optional(),
+    xai_api_key: z.string().optional(),
+    gemini_api_key: z.string().optional(),
+    ai_gateway_api_key: z.string().optional(),
+    cloudflare_ai_gateway_api_key: z.string().optional(),
+    cloudflare_ai_gateway_account_id: z.string().optional(),
+    cloudflare_ai_gateway_gateway_id: z.string().optional(),
+    token: z.string().optional(),
+    token_provider: z.string().optional(),
+    token_profile_id: z.string().optional(),
+  })
+  .strict();
+
+const openClawSchema = z
+  .object({
+    bin: z.string().optional(),
+    version: z.string(),
+    install: z.enum(["auto", "always", "never"]).optional(),
+    bootstrap: openClawBootstrapSchema.optional(),
+    commands: openClawCommandsSchema.optional(),
+  })
+  .strict();
+
+const workspaceSchema = z
+  .object({
+    name: z.string().min(1),
+    path: z.string().min(1).optional(),
+  })
+  .strict();
+
+const channelSchema = z
+  .object({
+    channel: z.string().min(1),
+    account: z.string().min(1).optional(),
+    login: z.boolean().optional(),
+    login_mode: z.enum(["interactive"]).optional(),
+    login_account: z.string().min(1).optional(),
+    name: z.string().min(1).optional(),
+    token: z.string().min(1).optional(),
+    token_file: z.string().min(1).optional(),
+    use_env: z.boolean().optional(),
+    bot_token: z.string().min(1).optional(),
+    access_token: z.string().min(1).optional(),
+    app_token: z.string().min(1).optional(),
+    webhook_url: z.string().min(1).optional(),
+    webhook_path: z.string().min(1).optional(),
+    signal_number: z.string().min(1).optional(),
+    password: z.string().min(1).optional(),
+    extra_flags: z.record(z.string(), z.union([z.string(), z.number(), z.boolean()])).optional(),
+  })
+  .strict();
+
+const agentSchema = z
+  .object({
+    workspace: z.string().min(1),
+    name: z.string().min(1),
+    model: z.string().optional(),
+    skills: z.array(z.string().min(1)).optional(),
+  })
+  .strict();
+
+const fileSchema = z
+  .object({
+    workspace: z.string().min(1),
+    path: z.string().min(1),
+    content: z.string().optional(),
+    content_from: z.string().min(1).optional(),
+    source: z.string().optional(),
+    overwrite: z.boolean().optional(),
+  })
+  .strict()
+  .refine((v) => [v.content, v.content_from, v.source].filter((item) => item !== undefined).length === 1, {
+    message: "files[] requires exactly one of content, content_from, or source",
+  });
+
+const conversationExpectSchema = z
+  .object({
+    contains: z.array(z.string()).optional(),
+    not_contains: z.array(z.string()).optional(),
+    regex: z.array(z.string()).optional(),
+    equals: z.string().optional(),
+  })
+  .strict();
+
+const messageSchema = z
+  .object({
+    content: z.string(),
+    expect: conversationExpectSchema.optional(),
+  })
+  .strict();
+
+const conversationSchema = z
+  .object({
+    workspace: z.string().min(1),
+    agent: z.string().min(1),
+    messages: z.array(messageSchema).min(1),
+    run: z.boolean().optional(),
+  })
+  .strict();
+
+export const recipeSchema = z
+  .object({
+    version: z.string().min(1),
+    name: z.string().min(1),
+    params: z.record(z.string(), paramDefSchema).optional(),
+    openclaw: openClawSchema,
+    workspaces: z.array(workspaceSchema).optional(),
+    channels: z.array(channelSchema).optional(),
+    agents: z.array(agentSchema).optional(),
+    files: z.array(fileSchema).optional(),
+    conversations: z.array(conversationSchema).optional(),
+  })
+  .strict();
+
+export type RecipeSchema = z.infer<typeof recipeSchema>;

package/src/template.ts

@@ -0,0 +1,41 @@
+import { ClawChefError } from "./errors.js";
+
+const TOKEN_RE = /\$\{([A-Za-z_][A-Za-z0-9_]*)\}/g;
+
+export function resolveTemplate(
+  value: string,
+  vars: Record<string, string>,
+  allowMissing: boolean,
+): string {
+  return value.replace(TOKEN_RE, (_, key: string) => {
+    if (Object.prototype.hasOwnProperty.call(vars, key)) {
+      return vars[key];
+    }
+    if (allowMissing) {
+      return `\${${key}}`;
+    }
+    throw new ClawChefError(`Missing parameter: ${key}`);
+  });
+}
+
+export function deepResolveTemplates<T>(
+  input: T,
+  vars: Record<string, string>,
+  allowMissing: boolean,
+): T {
+  if (typeof input === "string") {
+    return resolveTemplate(input, vars, allowMissing) as T;
+  }
+  if (Array.isArray(input)) {
+    return input.map((v) => deepResolveTemplates(v, vars, allowMissing)) as T;
+  }
+  if (input && typeof input === "object") {
+    const obj = input as Record<string, unknown>;
+    const out: Record<string, unknown> = {};
+    for (const [key, value] of Object.entries(obj)) {
+      out[key] = deepResolveTemplates(value, vars, allowMissing);
+    }
+    return out as T;
+  }
+  return input;
+}

package/src/types.ts

@@ -0,0 +1,150 @@
+export type InstallPolicy = "auto" | "always" | "never";
+export type OpenClawProvider = "command" | "mock" | "remote";
+
+export interface OpenClawRemoteConfig {
+  base_url: string;
+  api_key?: string;
+  api_header?: string;
+  api_scheme?: string;
+  timeout_ms?: number;
+  operation_path?: string;
+}
+
+export interface ParamDef {
+  default?: string;
+  required?: boolean;
+  description?: string;
+}
+
+export interface OpenClawCommandOverrides {
+  use_version?: string;
+  install_version?: string;
+  uninstall_version?: string;
+  factory_reset?: string;
+  start_gateway?: string;
+  enable_plugin?: string;
+  login_channel?: string;
+  create_workspace?: string;
+  create_agent?: string;
+  install_skill?: string;
+  send_message?: string;
+  run_agent?: string;
+}
+
+export interface OpenClawBootstrap {
+  non_interactive?: boolean;
+  accept_risk?: boolean;
+  mode?: "local" | "remote";
+  flow?: "quickstart" | "advanced" | "manual";
+  auth_choice?: string;
+  workspace?: string;
+  reset?: boolean;
+  skip_channels?: boolean;
+  skip_skills?: boolean;
+  skip_health?: boolean;
+  skip_ui?: boolean;
+  skip_daemon?: boolean;
+  install_daemon?: boolean;
+  openai_api_key?: string;
+  anthropic_api_key?: string;
+  openrouter_api_key?: string;
+  xai_api_key?: string;
+  gemini_api_key?: string;
+  ai_gateway_api_key?: string;
+  cloudflare_ai_gateway_api_key?: string;
+  cloudflare_ai_gateway_account_id?: string;
+  cloudflare_ai_gateway_gateway_id?: string;
+  token?: string;
+  token_provider?: string;
+  token_profile_id?: string;
+}
+
+export interface OpenClawSection {
+  bin?: string;
+  version: string;
+  install?: InstallPolicy;
+  bootstrap?: OpenClawBootstrap;
+  commands?: OpenClawCommandOverrides;
+}
+
+export interface WorkspaceDef {
+  name: string;
+  path?: string;
+}
+
+export interface ChannelDef {
+  channel: string;
+  account?: string;
+  login?: boolean;
+  login_mode?: "interactive";
+  login_account?: string;
+  name?: string;
+  token?: string;
+  token_file?: string;
+  use_env?: boolean;
+  bot_token?: string;
+  access_token?: string;
+  app_token?: string;
+  webhook_url?: string;
+  webhook_path?: string;
+  signal_number?: string;
+  password?: string;
+  extra_flags?: Record<string, string | number | boolean>;
+}
+
+export interface AgentDef {
+  workspace: string;
+  name: string;
+  model?: string;
+  skills?: string[];
+}
+
+export interface FileDef {
+  workspace: string;
+  path: string;
+  content?: string;
+  content_from?: string;
+  source?: string;
+  overwrite?: boolean;
+}
+
+export interface MessageDef {
+  content: string;
+  expect?: ConversationExpectDef;
+}
+
+export interface ConversationExpectDef {
+  contains?: string[];
+  not_contains?: string[];
+  regex?: string[];
+  equals?: string;
+}
+
+export interface ConversationDef {
+  workspace: string;
+  agent: string;
+  messages: MessageDef[];
+  run?: boolean;
+}
+
+export interface Recipe {
+  version: string;
+  name: string;
+  params?: Record<string, ParamDef>;
+  openclaw: OpenClawSection;
+  workspaces?: WorkspaceDef[];
+  channels?: ChannelDef[];
+  agents?: AgentDef[];
+  files?: FileDef[];
+  conversations?: ConversationDef[];
+}
+
+export interface RunOptions {
+  vars: Record<string, string>;
+  dryRun: boolean;
+  allowMissing: boolean;
+  verbose: boolean;
+  silent: boolean;
+  provider: OpenClawProvider;
+  remote: Partial<OpenClawRemoteConfig>;
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "strict": true,
+    "esModuleInterop": true,
+    "forceConsistentCasingInFileNames": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "outDir": "dist",
+    "rootDir": "src",
+    "resolveJsonModule": true
+  },
+  "include": ["src/**/*.ts"]
+}