@aifabrix/builder 2.52.0 → 2.53.0

package/scripts/export-builder-api-evidence.js

@@ -1,262 +0,0 @@
-#!/usr/bin/env node
-/**
- * Export builder-api help/knowledge fixtures to Evidence Fabrix v2 bulk-load JSON.
- *
- * @fileoverview One-time / repeatable generator for Role Assistant evidence import
- * @author AI Fabrix Team
- * @version 1.0.0
- */
-
-'use strict';
-
-const fs = require('fs');
-const path = require('path');
-
-const REPO_ROOT = path.join(__dirname, '..');
-const DEFAULT_OUT = path.join(
-  REPO_ROOT,
-  '..',
-  'aifabrix-dataplane',
-  'integration',
-  'builder-api',
-  'builder-api-evidence.json'
-);
-
-const EVIDENCE_PATTERNS = path.join(REPO_ROOT, 'docs', 'builder-help', 'evidence-patterns.json');
-const GOLDEN_DIR = path.join(REPO_ROOT, 'docs', 'builder-help', 'golden-examples');
-const PLATFORM_ROLES = path.join(REPO_ROOT, 'docs', 'builder-help', 'platform-roles.json');
-const RESOURCE_CATALOG = path.join(REPO_ROOT, 'docs', 'builder-help', 'resource-type-catalog.json');
-const HELP_MD_DIR = path.join(REPO_ROOT, 'lib', 'programmatic', 'help-content');
-
-/** @type {Array<{ file: string, resourceType: string, order: number }>} */
-const MD_TOPICS = [
-  { file: 'overview.md', resourceType: 'workspace', order: 10 },
-  { file: 'workflow.md', resourceType: 'workspace', order: 20 },
-  { file: 'subscription-guide.md', resourceType: 'system', order: 30 },
-  { file: 'cip-overview.md', resourceType: 'task', order: 40 },
-  { file: 'dimensions-guide.md', resourceType: 'policy', order: 50 },
-  { file: 'channel-onboarding.md', resourceType: 'channel', order: 60 },
-  { file: 'connected-system-ui.md', resourceType: 'workspace', order: 70 }
-];
-
-/**
- * @param {string} text
- * @returns {string}
- */
-function stripMarkdown(text) {
-  return String(text || '')
-    .replace(/\[([^\]]+)\]\([^)]+\)/g, '$1')
-    .replace(/https?:\/\/[^\s)]+/gi, '')
-    .replace(/^#+\s*/gm, '')
-    .replace(/\s{2,}/g, ' ')
-    .trim();
-}
-
-/**
- * @param {string} fileName
- * @returns {{ title: string, summary: string, body: string }}
- */
-function parseMarkdownTopic(fileName) {
-  const raw = fs.readFileSync(path.join(HELP_MD_DIR, fileName), 'utf8');
-  const lines = raw.split(/\r?\n/);
-  let title = path.basename(fileName, '.md');
-  const bodyLines = [];
-  for (const line of lines) {
-    if (line.startsWith('# ')) {
-      title = stripMarkdown(line.slice(2));
-    } else if (line.trim()) {
-      bodyLines.push(line);
-    }
-  }
-  const body = stripMarkdown(bodyLines.join('\n'));
-  const summary = body.slice(0, 240);
-  return { title, summary, body };
-}
-
-/**
- * @param {Object} row
- * @returns {Object}
- */
-function normalizeRow(row) {
-  const out = {
-    resourceType: String(row.resourceType || 'workspace').trim(),
-    title: String(row.title || '').trim(),
-    when: String(row.when || '').trim(),
-    expectedBehavior: String(row.expectedBehavior || '').trim(),
-    order: Number.isFinite(row.order) ? row.order : 100,
-    status: row.status === 'disabled' ? 'disabled' : 'active'
-  };
-  if (row.roleKey) {
-    out.roleKey = String(row.roleKey).trim();
-  }
-  if (row.description) {
-    out.description = String(row.description).trim();
-  }
-  return out;
-}
-
-/**
- * @returns {Object[]}
- */
-function rowsFromEvidencePatterns() {
-  const doc = JSON.parse(fs.readFileSync(EVIDENCE_PATTERNS, 'utf8'));
-  return (doc.patterns || []).map((p, i) =>
-    normalizeRow({
-      resourceType: p.resourceType || 'document',
-      title: p.title,
-      description: [p.summary, p.role ? `Audience: ${p.role}` : null, (p.steps || []).join(' → ')].filter(Boolean).join(' '),
-      when: p.summary || p.title,
-      expectedBehavior: (p.steps || []).join(' '),
-      order: 100 + i
-    })
-  );
-}
-
-/**
- * @returns {Object[]}
- */
-function rowsFromGoldenExamples() {
-  const rows = [];
-  let order = 200;
-  for (const file of fs.readdirSync(GOLDEN_DIR).sort()) {
-    if (!file.endsWith('.json')) {
-      continue;
-    }
-    const doc = JSON.parse(fs.readFileSync(path.join(GOLDEN_DIR, file), 'utf8'));
-    const traversal = (doc.metadataTraversal || []).join(', ');
-    rows.push(
-      normalizeRow({
-        resourceType: doc.resourceType || 'document',
-        title: `Golden example: ${doc.title || doc.key}`,
-        description: [doc.summary, doc.role ? `Audience: ${doc.role}` : null].filter(Boolean).join(' '),
-        when: `Designing a ${doc.resourceType || 'document'} integration similar to ${doc.key}`,
-        expectedBehavior: [
-          doc.summary,
-          doc.subscriptionGuidance,
-          traversal ? `Traverse sections: ${traversal}` : null,
-          (doc.recommendedSectionKeys || []).length
-            ? `Recommended sections: ${doc.recommendedSectionKeys.join(', ')}`
-            : null
-        ]
-          .filter(Boolean)
-          .join(' '),
-        order: order++
-      })
-    );
-  }
-  return rows;
-}
-
-/**
- * @returns {Object[]}
- */
-function rowsFromMarkdownTopics() {
-  return MD_TOPICS.map((t) => {
-    const parsed = parseMarkdownTopic(t.file);
-    return normalizeRow({
-      resourceType: t.resourceType,
-      title: parsed.title,
-      description: parsed.summary,
-      when: `Agent needs builder-api guidance for ${parsed.title}`,
-      expectedBehavior: parsed.body,
-      order: t.order
-    });
-  });
-}
-
-/**
- * @returns {Object[]}
- */
-function rowsFromPlatformRoles() {
-  const doc = JSON.parse(fs.readFileSync(PLATFORM_ROLES, 'utf8'));
-  const roleLines = (doc.roles || [])
-    .map((r) => `${r.value}: ${r.description}`)
-    .join(' ');
-  return [
-    normalizeRow({
-      resourceType: 'policy',
-      title: 'Platform RBAC roles for facade integrations',
-      description: 'Dataplane platform roles for orchestration facade systems (not per-system admin/reader).',
-      when: 'Patching system.rolesPermissions or repair rbac on a builder-api facade system',
-      expectedBehavior: `Use rbacPreset platform. Allowed roles: ${roleLines}. Avoid {systemKey}-admin or {systemKey}-reader on facade APIs.`,
-      order: 5
-    })
-  ];
-}
-
-/**
- * @returns {Object[]}
- */
-function rowsFromResourceCatalog() {
-  const doc = JSON.parse(fs.readFileSync(RESOURCE_CATALOG, 'utf8'));
-  const byCategory = {};
-  for (const rt of doc.resourceTypes || []) {
-    const cat = rt.category || 'other';
-    if (!byCategory[cat]) {
-      byCategory[cat] = [];
-    }
-    byCategory[cat].push(`${rt.key} (${rt.description})`);
-  }
-  const summary = Object.entries(byCategory)
-    .map(([cat, items]) => `${cat}: ${items.slice(0, 8).join('; ')}`)
-    .join(' ');
-  return [
-    normalizeRow({
-      resourceType: 'document',
-      title: 'Resource type catalog for datasource manifests',
-      description: 'Pick catalog keys that match business semantics; challenge generic placeholders.',
-      when: 'Choosing datasource.resourceType for a new or edited datasource',
-      expectedBehavior: `Compare purpose to catalog entries. Minimum system keys: ${(doc.minimumSystemKeys || []).join(', ')}. Categories: ${summary}`,
-      order: 8
-    })
-  ];
-}
-
-/**
- * @returns {Object[]}
- */
-function rowsFromManifestGuides() {
-  return [
-    normalizeRow({
-      resourceType: 'policy',
-      title: 'Manifest section keys and dependency order',
-      when: 'Agent edits external system or datasource manifest sections',
-      expectedBehavior:
-        'Read one section at a time via manifest section APIs. After metadata or capability patches, run repair hooks for fieldMappings, expose, and rbac. Use dependency graph: downstream sections derive from upstream patches.',
-      order: 15
-    }),
-    normalizeRow({
-      resourceType: 'workspace',
-      title: 'Repair hooks and CLI flag mapping',
-      when: 'Manifest repair is required after structural edits',
-      expectedBehavior:
-        'POST manifest repair with explicit hooks (fieldMappings, expose, rbac, sync, test). Align with repair CLI flags. Validate workspace before upload or certify.',
-      order: 16
-    }),
-    normalizeRow({
-      resourceType: 'workspace',
-      title: 'Section quality and missing inputs',
-      when: 'GET manifest section returns quality.missingInputs',
-      expectedBehavior:
-        'Collect required missing inputs from the user before PATCH. Do not guess values. sectionReadToken from GET is optional on PATCH (server re-reads when omitted; stale token returns 409). Prefer GET when you need quality or missingInputs.',
-      order: 17
-    })
-  ];
-}
-
-function main() {
-  const outPath = path.resolve(process.argv[2] || DEFAULT_OUT);
-  const rows = [
-    ...rowsFromPlatformRoles(),
-    ...rowsFromResourceCatalog(),
-    ...rowsFromMarkdownTopics(),
-    ...rowsFromManifestGuides(),
-    ...rowsFromEvidencePatterns(),
-    ...rowsFromGoldenExamples()
-  ];
-  fs.mkdirSync(path.dirname(outPath), { recursive: true });
-  fs.writeFileSync(outPath, `${JSON.stringify(rows, null, 2)}\n`, 'utf8');
-  process.stdout.write(`Wrote ${rows.length} evidence row(s) to ${outPath}\n`);
-}
-
-main();