Function checkCanonicalIdContract

apps/sim/scripts/check-block-registry.ts:192–238

()

}

function checkCanonicalIdContract(): CheckResult {
  const errors: string[] = []

  for (const block of getAllBlocks()) {
    const access: string[] = block.tools?.access ?? []
    if (access.length === 0) continue

    // A subBlock with `canonicalParamId` has its raw `id` deleted from `params` during
    // canonical-group resolution in `extractParams` (serializer/index.ts), so the raw id is
    // NOT a valid lookup key at execution time — only the canonical is. Tool params must
    // align with the canonical, not the raw id.
    const subBlockKeys = new Set<string>()
    for (const sb of block.subBlocks ?? []) {
      const canonical = (sb as { canonicalParamId?: string }).canonicalParamId
      if (canonical) {
        subBlockKeys.add(canonical)
      } else if (sb.id) {
        subBlockKeys.add(sb.id)
      }
    }

    for (const toolId of access) {
      const tool = toolRegistry[toolId]
      if (!tool) continue

      for (const [paramId, paramConfig] of Object.entries(tool.params ?? {})) {
        if (!paramConfig || typeof paramConfig !== 'object') continue
        const required = (paramConfig as { required?: boolean }).required === true
        const userOnly = (paramConfig as { visibility?: string }).visibility === 'user-only'
        if (!required || !userOnly) continue

        if (!subBlockKeys.has(paramId)) {
          errors.push(
            `Block "${block.type}" → tool "${toolId}": required user-only param "${paramId}" has no subBlock with id or canonicalParamId === "${paramId}".\n` +
              '  → Rename a subBlock id or canonicalParamId to match the tool param id,\n' +
              "    and update the block's inputs + tools.config.params mapper to read from that key."
          )
        }
      }
    }
  }

  if (errors.length === 0) {
    return { kind: 'pass', message: 'Canonical-id contract check passed' }
  }
  return { kind: 'fail', errors }
}

/**
 * Every catalog-visible integration block must expose a `BlockMeta` entry in