@signaliz/sdk 1.0.13 → 1.0.15

package/README.md

@@ -99,9 +99,24 @@ const readiness = await signaliz.campaignBuilderAgent.readiness({
   targetCount: 500,
   builtIns: ['lead_generation', 'local_leads', 'email_finding', 'email_verification', 'signals'],
 });
+const proof = await signaliz.campaignBuilderAgent.proof({
+  goal: 'Build a strategy-template campaign for mature local operators',
+  strategyTemplate: 'non-medical-home-care',
+  targetCount: 25,
+  builtIns: ['lead_generation', 'local_leads', 'email_finding', 'email_verification', 'signals'],
+});
+const kit = signaliz.campaignBuilderAgent.buildKit({
+  goal: 'Build a strategy-template campaign for mature local operators',
+  strategyTemplate: 'non-medical-home-care',
+  targetCount: 250,
+  includeLocalLeads: true,
+  includeCustomToolPlaceholder: true,
+});
 
 console.log(plan.strategyMemoryStatus?.ready);
 console.log(readiness.summary.ready);
+console.log(proof.success);
+console.log(kit.mcp_calls.find((call) => call.tool === 'gtm_campaign_agent_proof'));
 console.log(plan.mcpFlow.filter((step) =>
   ['gtm_provider_recipe_prepare', 'gtm_provider_route_activate'].includes(step.tool)
 ));
@@ -130,6 +145,13 @@ npx @signaliz/sdk campaign-agent init \
   --with-byo-placeholder \
   --output-file campaign-request.json
 
+npx @signaliz/sdk campaign-agent kit \
+  --strategy-template non-medical-home-care \
+  --target-count 250 \
+  --use-local-leads \
+  --with-byo-placeholder \
+  --json
+
 npx @signaliz/sdk campaign-agent plan \
   --request-file campaign-request.json \
   --target-count 250 \
@@ -139,6 +161,11 @@ npx @signaliz/sdk campaign-agent doctor \
   --request-file campaign-request.json \
   --json
 
+npx @signaliz/cli build "Build a strategy-template campaign for local operators" \
+  --strategy-template non-medical-home-care \
+  --target-count 25 \
+  --use-local-leads
+
 npx @signaliz/sdk campaign-agent status campaign_build_id --json
 npx @signaliz/sdk campaign-agent review campaign_build_id --limit 100 --json
 npx @signaliz/sdk campaign-agent rows campaign_build_id --limit 100 --json

package/dist/{chunk-DJVOGXVD.mjs → chunk-6OZWMAV3.mjs}

@@ -1698,6 +1698,16 @@ var CampaignBuilderAgent = class {
     const plan = await this.createPlan(request, options);
     return createCampaignBuilderReadiness(plan);
   }
+  async proof(request, options = {}) {
+    const plan = await this.createPlan(request, options);
+    const result = await this.dryRunPlan(plan, {
+      idempotencyKey: options.idempotencyKey
+    });
+    return createCampaignBuilderProofReceipt(plan, result);
+  }
+  buildKit(options = {}) {
+    return createCampaignBuilderBuildKit(options);
+  }
   async commitPlan(plan, options = {}) {
     const writeMode = options.confirm === true && options.dryRun === false;
     if (writeMode && !options.approvedBy) {
@@ -2143,6 +2153,72 @@ function createCampaignBuilderReadiness(plan) {
     nextActions: campaignReadinessNextActions(plan, ready, customRoutes.length)
   };
 }
+function createCampaignBuilderProofReceipt(plan, result) {
+  const strategyMemory = asRecord(plan.strategyMemoryStatus);
+  const dryRunResult = asRecord(result);
+  const memoryReady = plan.strategyMemoryStatus ? strategyMemory.ready !== false : false;
+  const dryRunCompleted = dryRunResult.dryRun === true || dryRunResult.dry_run === true || dryRunResult.status === "dry_run";
+  const noLaunch = dryRunCompleted && !dryRunResult.campaignBuildId && !dryRunResult.campaign_build_id;
+  const gates = [
+    {
+      id: "strategy_memory_ready",
+      passed: memoryReady,
+      ready: strategyMemory.ready ?? null,
+      blocker_count: Array.isArray(strategyMemory.blockers) ? strategyMemory.blockers.length : 0
+    },
+    {
+      id: "campaign_plan_ready",
+      passed: Boolean(plan.planId && plan.mcpFlow.length > 0),
+      plan_id: plan.planId,
+      flow_steps: plan.mcpFlow.length
+    },
+    {
+      id: "approval_gates_present",
+      passed: plan.approvals.length > 0,
+      approval_types: plan.approvals.map((approval) => approval.type)
+    },
+    {
+      id: "dry_run_completed",
+      passed: dryRunCompleted,
+      status: dryRunResult.status ?? null,
+      current_phase: dryRunResult.currentPhase ?? dryRunResult.current_phase ?? null
+    },
+    {
+      id: "no_spendful_launch",
+      passed: noLaunch,
+      campaign_build_id: dryRunResult.campaignBuildId ?? dryRunResult.campaign_build_id ?? null
+    }
+  ];
+  return {
+    receipt_version: "campaign-agent-proof.v1",
+    source: "signaliz.campaignBuilderAgent.proof",
+    success: gates.every((gate) => gate.passed),
+    safety: {
+      spendful_tools_called: false,
+      external_writes_called: false,
+      sender_loads_called: false,
+      email_sends_called: false,
+      dry_run_only: true
+    },
+    campaign: {
+      plan_id: plan.planId,
+      campaign_name: plan.campaignName,
+      strategy_template: campaignBuilderProofStrategyTemplate(plan),
+      target_count: plan.targetCount,
+      estimated_credits: plan.estimatedCredits,
+      operating_playbooks: plan.operatingPlaybooks.map((playbook) => playbook.slug)
+    },
+    gates,
+    strategy_memory_status: summarizeCampaignBuilderProofStrategyMemory(strategyMemory),
+    dry_run_result: summarizeCampaignBuilderProofDryRun(dryRunResult),
+    recommended_next_actions: [
+      "Review the plan, approvals, and dry-run result.",
+      "Use campaign-agent commit-plan --confirm-write only after review.",
+      "Use campaign-agent build-approved only with --confirm-launch, approval identity, approval types, and spend limit.",
+      "When an approved build reaches pending_approval, review rows and approve delivery through the Campaigns SDK."
+    ]
+  };
+}
 function getMissingCampaignBuilderApprovals(plan, approval) {
   if (approval.planId !== plan.planId) {
     return plan.approvals;
@@ -2296,6 +2372,156 @@ function createCampaignBuilderAgentRequestTemplate(input = {}) {
     }
   });
 }
+function createCampaignBuilderBuildKit(input = {}) {
+  const requestFile = input.requestFile || "campaign-request.json";
+  const cliPackage = input.cliPackage || "@signaliz/cli";
+  const sdkPackage = input.sdkPackage || "@signaliz/sdk";
+  const request = createCampaignBuilderAgentRequestTemplate(input);
+  const strategyTemplate = stringValue(request.strategyTemplate) ?? null;
+  const builtIns = request.builtIns ?? DEFAULT_CAMPAIGN_BUILDER_BUILT_INS;
+  const useLocalLeads = builtIns.includes("local_leads");
+  const customRoutes = [
+    ...request.integrations ?? [],
+    ...routesFromCustomerTools(request.customerTools ?? [])
+  ].filter((route) => route.provider !== "signaliz");
+  const strategyFlag = strategyTemplate ? ` --strategy-template ${shellArg(strategyTemplate)}` : "";
+  const targetFlag = request.targetCount ? ` --target-count ${request.targetCount}` : "";
+  const localLeadsFlag = useLocalLeads ? " --use-local-leads" : "";
+  const cliBase = `npx ${cliPackage}`;
+  const sdkCliBase = `npx ${sdkPackage}`;
+  const brief = request.goal || "Build a strategy-template campaign for the target ICP.";
+  const mcpArgs = campaignBuilderBuildKitMcpArgs(request);
+  return {
+    kit_version: "campaign-builder-kit.v1",
+    source: "signaliz.campaignBuilderAgent.buildKit",
+    request_file: requestFile,
+    request,
+    strategy_template: strategyTemplate,
+    built_in_lanes: builtIns,
+    operating_playbooks: getCampaignBuilderOperatingPlaybooksForRequest(request).map((playbook) => playbook.slug),
+    custom_routes: customRoutes.map((route) => ({
+      provider: String(route.provider),
+      layer: String(route.layer),
+      tool: firstNonEmptyString(route.toolName),
+      mcp_server: firstNonEmptyString(route.mcpServerName),
+      mode: route.mode ?? "if_available",
+      approval_required: route.approvalRequired === true || route.mode === "required"
+    })),
+    approval_boundaries: request.approvalPolicy?.requireApprovalFor ?? DEFAULT_CAMPAIGN_BUILDER_APPROVAL_TYPES,
+    byo_tool_pattern: {
+      cli_flag: "--custom-tool provider:layer:tool[:mcp]",
+      request_fragment: createCampaignBuilderToolRoute({
+        provider: "workspace_mcp",
+        layer: "enrichment",
+        gtmLayers: ["company_enrichment"],
+        toolName: "workspace_account_enrich",
+        mcpServerName: "workspace-mcp",
+        label: "Workspace account enrichment",
+        mode: "required",
+        approvalRequired: true
+      })
+    },
+    cli_commands: [
+      {
+        id: "write_request",
+        label: "Write reusable request JSON",
+        command: `${cliBase} campaign-agent init${strategyFlag}${targetFlag}${localLeadsFlag} --output-file ${shellArg(requestFile)}`,
+        safety: "local file only; no MCP calls, credits, provider writes, sender loads, exports, or sends"
+      },
+      {
+        id: "proof_shortcut",
+        label: "Run no-spend campaign-builder proof",
+        command: `${cliBase} build ${shellArg(brief)}${strategyFlag}${targetFlag}${localLeadsFlag} --json`,
+        safety: "strategy memory, Kernel plan, approvals, and forced build_campaign dry-run only"
+      },
+      {
+        id: "plan",
+        label: "Inspect the full campaign-agent plan",
+        command: `${sdkCliBase} campaign-agent plan --request-file ${shellArg(requestFile)} --json`,
+        safety: "read-only MCP planning and provider-route dry-runs"
+      },
+      {
+        id: "doctor",
+        label: "Check readiness gates",
+        command: `${sdkCliBase} campaign-agent doctor --request-file ${shellArg(requestFile)} --json`,
+        safety: "read-only readiness checks for Memory, Brain, built-ins, BYO routes, and approvals"
+      },
+      {
+        id: "commit_preview",
+        label: "Preview GTM campaign object commit",
+        command: `${sdkCliBase} campaign-agent commit-plan --request-file ${shellArg(requestFile)} --json`,
+        safety: "dry-run commit; writes only with --confirm-write and --approved-by"
+      },
+      {
+        id: "approved_launch",
+        label: "Launch after explicit approval",
+        command: `${sdkCliBase} campaign-agent build-approved --request-file ${shellArg(requestFile)} --confirm-launch --approve-all --approved-by operator@example.com --spend-limit ${request.signalizDefaults?.maxCredits ?? 0} --json`,
+        safety: "spendful path; requires human approval identity, approval types, and spend limit"
+      }
+    ],
+    mcp_calls: [
+      {
+        id: "request_template",
+        tool: "gtm_campaign_agent_request_template",
+        arguments: mcpArgs,
+        safety: "read-only reusable request generation"
+      },
+      {
+        id: "readiness",
+        tool: "gtm_campaign_agent_readiness",
+        arguments: mcpArgs,
+        safety: "read-only preflight across strategy memory, Kernel plan, lanes, routes, and approvals"
+      },
+      {
+        id: "proof",
+        tool: "gtm_campaign_agent_proof",
+        arguments: { ...mcpArgs, idempotency_key: "campaign-agent-proof-001" },
+        safety: "forces build_campaign dry_run=true and confirm_spend=false"
+      },
+      {
+        id: "plan",
+        tool: "gtm_campaign_agent_plan",
+        arguments: mcpArgs,
+        safety: "read-only one-call campaign-agent runbook"
+      },
+      {
+        id: "commit_preview",
+        tool: "gtm_campaign_build_plan_commit",
+        arguments: {
+          name: request.campaignName,
+          campaign_brief: request.goal,
+          lead_count: request.targetCount,
+          dry_run: true,
+          confirm: false
+        },
+        safety: "dry-run commit preview only"
+      }
+    ],
+    sdk_example: {
+      language: "typescript",
+      code: campaignBuilderBuildKitSdkExample(request, requestFile)
+    },
+    verification: [
+      `${cliBase} campaign-agent proof --request-file ${shellArg(requestFile)} --json`,
+      `${cliBase} campaign-agent doctor --request-file ${shellArg(requestFile)} --json`,
+      "Confirm proof.success is true and dry_run_result.status is dry_run before any approved launch.",
+      "Confirm no campaign_build_id exists in a proof receipt before moving to approved launch."
+    ],
+    privacy: {
+      client_names_allowed: false,
+      notes: [
+        "Use strategy templates, operating playbooks, and anonymized workflow patterns instead of client names.",
+        "Do not include raw leads, private replies, domains, secrets, or customer account labels in public kit output."
+      ]
+    },
+    next_actions: [
+      `Write or review ${requestFile}.`,
+      "Run the proof command before spending credits or activating provider writes.",
+      "Add BYO integrations with --custom-tool provider:layer:tool[:mcp] or the request_fragment shape.",
+      "Use build-approved only after human approval, spend limit, and delivery review policy are set."
+    ]
+  };
+}
 function createCampaignBuilderToolRoute(input) {
   return {
     provider: input.provider ?? "custom_mcp",
@@ -2311,6 +2537,63 @@ function createCampaignBuilderToolRoute(input) {
     rationale: `${input.label ?? input.provider ?? "Custom tool"} is a user-provided campaign-builder route for ${input.layer}.`
   };
 }
+function campaignBuilderBuildKitMcpArgs(request) {
+  return compact({
+    goal: request.goal,
+    campaign_brief: request.goal,
+    campaign_name: request.campaignName,
+    account_label: request.accountLabel,
+    account_context: request.accountContext,
+    strategy_template: request.strategyTemplate,
+    operating_playbooks: request.operatingPlaybooks,
+    target_icp: request.icp,
+    target_count: request.targetCount,
+    builtins: request.builtIns,
+    include_local_leads: request.builtIns?.includes("local_leads") || void 0,
+    preferred_providers: request.preferredProviders,
+    custom_tools: request.integrations?.map((route) => compact({
+      provider: route.provider,
+      layer: route.layer,
+      gtm_layers: route.gtmLayers ?? (route.gtmLayer ? [route.gtmLayer] : void 0),
+      tool: route.toolName,
+      mcp: route.mcpServerName,
+      mode: route.mode,
+      approval_required: route.approvalRequired
+    })),
+    include_nango_catalog: request.agencyContext?.includeNangoCatalog,
+    include_memory: request.memory?.enabled,
+    include_brain: true,
+    include_provider_routes: true,
+    include_delivery_risk: true
+  });
+}
+function campaignBuilderBuildKitSdkExample(request, requestFile) {
+  const proofRequest = {
+    goal: request.goal,
+    strategyTemplate: request.strategyTemplate,
+    targetCount: request.targetCount,
+    builtIns: request.builtIns,
+    integrations: request.integrations
+  };
+  return [
+    "import { Signaliz, createCampaignBuilderBuildKit } from '@signaliz/sdk';",
+    "",
+    `const kit = createCampaignBuilderBuildKit({ requestFile: ${JSON.stringify(requestFile)}, ...${JSON.stringify(proofRequest, null, 2)} });`,
+    "console.log(kit.cli_commands.find((command) => command.id === 'proof_shortcut')?.command);",
+    "",
+    "const signaliz = new Signaliz({ apiKey: process.env.SIGNALIZ_API_KEY! });",
+    "const proof = await signaliz.campaignBuilderAgent.proof(kit.request, {",
+    "  idempotencyKey: `campaign-agent-proof-${Date.now()}`,",
+    "});",
+    "",
+    'if (!proof.success || proof.dry_run_result?.status !== "dry_run") {',
+    "  throw new Error('Campaign proof failed or launched work unexpectedly');",
+    "}"
+  ].join("\n");
+}
+function shellArg(value) {
+  return `'${value.replace(/'/g, "'\\''")}'`;
+}
 function normalizeTemplateKey(value) {
   return String(value || "").trim().toLowerCase().replace(/[_\s]+/g, "-");
 }
@@ -3585,6 +3868,72 @@ function campaignReadinessNextActions(plan, ready, customRouteCount) {
   ];
   return actions.filter((item) => Boolean(item));
 }
+function campaignBuilderProofStrategyTemplate(plan) {
+  const buildRequest = asRecord(plan.buildRequest);
+  const strategyMemory = asRecord(plan.strategyMemoryStatus);
+  const statusTemplate = strategyMemory.strategy_template ?? strategyMemory.strategyTemplate;
+  const statusTemplateRecord = asRecord(statusTemplate);
+  const flowTemplate = plan.mcpFlow.map((step) => asRecord(step.arguments).strategy_template ?? asRecord(step.arguments).strategyTemplate).find((value) => typeof value === "string" && value.trim());
+  return firstNonEmptyString(
+    buildRequest.strategyTemplate,
+    buildRequest.strategy_template,
+    statusTemplate,
+    statusTemplateRecord.slug,
+    statusTemplateRecord.id,
+    flowTemplate
+  );
+}
+function summarizeCampaignBuilderProofStrategyMemory(strategyMemory) {
+  if (Object.keys(strategyMemory).length === 0) return { ready: false };
+  const template = strategyMemory.strategy_template ?? strategyMemory.strategyTemplate;
+  const templateRecord = asRecord(template);
+  const coverage = asRecord(strategyMemory.coverage);
+  const rawSourceGroups = Array.isArray(strategyMemory.source_groups) ? strategyMemory.source_groups : Array.isArray(strategyMemory.sourceGroups) ? strategyMemory.sourceGroups : [];
+  const sourceGroups = rawSourceGroups.map((group) => {
+    const sourceGroup = asRecord(group);
+    return {
+      id: sourceGroup.id ?? null,
+      required: sourceGroup.required ?? null,
+      ready: sourceGroup.ready ?? null,
+      counts: asRecord(sourceGroup.counts)
+    };
+  });
+  return {
+    ready: strategyMemory.ready ?? null,
+    read_only: strategyMemory.read_only ?? strategyMemory.readOnly ?? null,
+    source_tool: firstNonEmptyString(strategyMemory.source_tool, strategyMemory.sourceTool),
+    strategy_template: {
+      slug: firstNonEmptyString(template, templateRecord.slug, templateRecord.id),
+      label: firstNonEmptyString(templateRecord.label)
+    },
+    coverage: {
+      required_groups_ready: coverage.required_groups_ready ?? coverage.requiredGroupsReady ?? null,
+      required_groups_total: coverage.required_groups_total ?? coverage.requiredGroupsTotal ?? null,
+      source_groups_ready: coverage.source_groups_ready ?? coverage.sourceGroupsReady ?? null,
+      source_groups_total: coverage.source_groups_total ?? coverage.sourceGroupsTotal ?? null,
+      knowledge_docs: coverage.knowledge_docs ?? coverage.knowledgeDocs ?? null,
+      memories: coverage.memories ?? null
+    },
+    source_groups: sourceGroups,
+    blocker_count: Array.isArray(strategyMemory.blockers) ? strategyMemory.blockers.length : 0,
+    warning_count: Array.isArray(strategyMemory.warnings) ? strategyMemory.warnings.length : 0
+  };
+}
+function summarizeCampaignBuilderProofDryRun(dryRunResult) {
+  return {
+    dryRun: dryRunResult.dryRun ?? dryRunResult.dry_run ?? null,
+    status: dryRunResult.status ?? null,
+    currentPhase: dryRunResult.currentPhase ?? dryRunResult.current_phase ?? null,
+    campaignBuildId: dryRunResult.campaignBuildId ?? dryRunResult.campaign_build_id ?? null,
+    plannedTargetCount: dryRunResult.plannedTargetCount ?? dryRunResult.planned_target_count ?? null
+  };
+}
+function firstNonEmptyString(...values) {
+  for (const value of values) {
+    if (typeof value === "string" && value.trim()) return value;
+  }
+  return null;
+}
 function diagnosticMessages2(value) {
   if (!Array.isArray(value)) return [];
   return value.map((item) => {
@@ -6596,6 +6945,7 @@ export {
   CampaignBuilderAgent,
   createCampaignBuilderAgentPlan,
   createCampaignBuilderReadiness,
+  createCampaignBuilderProofReceipt,
   getMissingCampaignBuilderApprovals,
   createCampaignBuilderApproval,
   getCampaignBuilderStrategyTemplate,
@@ -6603,6 +6953,7 @@ export {
   getCampaignBuilderOperatingPlaybooksForRequest,
   applyCampaignBuilderStrategyTemplate,
   createCampaignBuilderAgentRequestTemplate,
+  createCampaignBuilderBuildKit,
   createCampaignBuilderToolRoute,
   Icps,
   normalizeExecutionReference,