@aifabrix/builder 2.8.0 → 2.9.0

package/lib/schema/external-system.schema.json

@@ -3,7 +3,6 @@
   "$id": "https://raw.githubusercontent.com/esystemsdev/aifabrix-builder/refs/heads/main/lib/schema/external-system.schema.json",
   "title": "AI Fabrix External System Configuration Schema",
   "description": "Schema for configuring an external system connected to the AI Fabrix Dataplane. This defines authentication, OpenAPI/MCP bindings, field mappings defaults, metadata handling and portal inputs.",
-
   "metadata": {
     "key": "external-system-schema",
     "name": "External System Configuration Schema",
@@ -19,7 +18,13 @@
       "maxVersion": "2.0.0",
       "deprecated": false
     },
-    "tags": ["schema", "external-system", "dataplane", "integration", "validation"],
+    "tags": [
+      "schema",
+      "external-system",
+      "dataplane",
+      "integration",
+      "validation"
+    ],
     "dependencies": [],
     "changelog": [
       {
@@ -36,9 +41,7 @@
       }
     ]
   },
-
   "type": "object",
-
   "required": [
     "key",
     "displayName",
@@ -46,7 +49,6 @@
     "type",
     "authentication"
   ],
-
   "properties": {
     "key": {
       "type": "string",
@@ -55,32 +57,31 @@
       "minLength": 3,
       "maxLength": 40
     },
-
     "displayName": {
       "type": "string",
       "description": "Human-readable name for the external system",
       "minLength": 1,
       "maxLength": 100
     },
-
     "description": {
       "type": "string",
       "description": "Description of this external system integration",
       "minLength": 1,
       "maxLength": 500
     },
-
     "type": {
       "type": "string",
-      "enum": ["openapi", "mcp", "custom"],
+      "enum": [
+        "openapi",
+        "mcp",
+        "custom"
+      ],
       "description": "Integration type: OpenAPI-driven, MCP-driven, or custom Python connector."
     },
-
     "enabled": {
       "type": "boolean",
       "default": true
     },
-
     "environment": {
       "type": "object",
       "description": "Environment-level configuration values used by dataplane and external data sources.",
@@ -97,95 +98,80 @@
       },
       "additionalProperties": true
     },
-
     "authentication": {
       "type": "object",
-      "description": "Authentication configuration for the external system.",
-      "required": ["type"],
+      "description": "Authentication configuration for external system",
+      "required": [
+        "type"
+      ],
       "properties": {
         "type": {
           "type": "string",
-          "enum": ["oauth2", "apikey", "basic", "aad", "none"],
-          "description": "Authentication method used for API access."
+          "enum": [
+            "oauth2",
+            "apikey",
+            "basic",
+            "aad",
+            "none"
+          ],
+          "description": "Authentication type"
         },
-
         "oauth2": {
           "type": "object",
-          "description": "OAuth2 configuration used when type == 'oauth2'. All secrets are stored in Key Vault.",
-          "properties": {
-            "tokenUrl": {
-              "type": "string",
-              "pattern": "^(http|https)://.*$"
-            },
-            "clientId": {
-              "type": "string"
-            },
-            "clientSecret": {
-              "type": "string"
-            },
-            "scopes": {
-              "type": "array",
-              "items": { "type": "string" }
-            }
-          },
-          "additionalProperties": false
+          "description": "OAuth2 authentication configuration",
+          "additionalProperties": true
         },
-
         "apikey": {
           "type": "object",
-          "properties": {
-            "headerName": { "type": "string" },
-            "key": { "type": "string" }
-          },
-          "additionalProperties": false
+          "description": "API key authentication configuration",
+          "additionalProperties": true
         },
-
         "basic": {
           "type": "object",
-          "properties": {
-            "username": { "type": "string" },
-            "password": { "type": "string" }
-          },
-          "additionalProperties": false
+          "description": "Basic authentication configuration",
+          "additionalProperties": true
+        },
+        "aad": {
+          "type": "object",
+          "description": "Azure AD authentication configuration",
+          "additionalProperties": true
         }
       },
-      "additionalProperties": false
+      "additionalProperties": true
     },
-
     "openapi": {
       "type": "object",
-      "description": "OpenAPI integration configuration.",
+      "description": "OpenAPI integration configuration",
       "properties": {
         "documentKey": {
           "type": "string",
-          "description": "Reference to OpenAPI spec registered via builder. Example: 'hubspot-v3'."
+          "description": "Key of the OpenAPI document in the registry"
         },
-        "autoDiscoverEntities": {
-          "type": "boolean",
-          "default": false,
-          "description": "Automatically discover resources/entities from OpenAPI schema."
+        "specUrl": {
+          "type": "string",
+          "description": "URL to the OpenAPI specification",
+          "pattern": "^(http|https)://.*$"
         }
       },
-      "additionalProperties": false
+      "additionalProperties": true
     },
-
     "mcp": {
       "type": "object",
-      "description": "Model Context Protocol integration config.",
+      "description": "Model Context Protocol integration configuration",
       "properties": {
         "serverUrl": {
           "type": "string",
+          "description": "MCP server URL",
           "pattern": "^(http|https)://.*$"
         },
         "toolPrefix": {
           "type": "string",
-          "pattern": "^[a-z0-9-]+$",
-          "description": "Prefix for MCP tool names generated from this system."
+          "description": "Prefix for MCP tool names",
+          "pattern": "^[a-zA-Z0-9_-]+$"
         }
       },
-      "additionalProperties": false
+      "additionalProperties": true
     },
-
     "dataSources": {
       "type": "array",
       "description": "List of data source keys belonging to this external system. Each must match external-datasource.schema.json.",
@@ -195,13 +181,17 @@
       },
       "uniqueItems": true
     },
-
     "configuration": {
       "type": "array",
       "description": "External system configuration variables (same pattern as application-schema).",
       "items": {
         "type": "object",
-        "required": ["name", "value", "location", "required"],
+        "required": [
+          "name",
+          "value",
+          "location",
+          "required"
+        ],
         "properties": {
           "name": {
             "type": "string",
@@ -213,33 +203,61 @@
           },
           "location": {
             "type": "string",
-            "enum": ["variable", "keyvault"]
+            "enum": [
+              "variable",
+              "keyvault"
+            ]
           },
           "required": {
             "type": "boolean"
           },
           "portalInput": {
             "type": "object",
-            "required": ["field", "label"],
+            "required": [
+              "field",
+              "label"
+            ],
             "properties": {
               "field": {
                 "type": "string",
-                "enum": ["password", "text", "textarea", "select", "json"]
+                "enum": [
+                  "password",
+                  "text",
+                  "textarea",
+                  "select",
+                  "json"
+                ]
+              },
+              "label": {
+                "type": "string"
+              },
+              "placeholder": {
+                "type": "string"
               },
-              "label": { "type": "string" },
-              "placeholder": { "type": "string" },
               "options": {
                 "type": "array",
-                "items": { "type": "string" }
+                "items": {
+                  "type": "string"
+                }
+              },
+              "masked": {
+                "type": "boolean"
               },
-              "masked": { "type": "boolean" },
               "validation": {
                 "type": "object",
                 "properties": {
-                  "minLength": { "type": "integer" },
-                  "maxLength": { "type": "integer" },
-                  "pattern": { "type": "string" },
-                  "required": { "type": "boolean" }
+                  "minLength": {
+                    "type": "integer"
+                  },
+                  "maxLength": {
+                    "type": "integer"
+                  },
+                  "pattern": {
+                    "type": "string"
+                  },
+                  "required": {
+                    "type": "boolean"
+                  }
                 },
                 "additionalProperties": false
               }
@@ -250,13 +268,13 @@
         "additionalProperties": false
       }
     },
-
     "tags": {
       "type": "array",
       "description": "Optional tags for search / filtering",
-      "items": { "type": "string" }
+      "items": {
+        "type": "string"
+      }
     }
   },
-
   "additionalProperties": false
 }

package/lib/templates.js

@@ -32,7 +32,7 @@ function generateVariablesYaml(appName, config) {
         environment: 'dev'
       },
       externalIntegration: {
-        schemaBasePath: './schemas',
+        schemaBasePath: './',
         systems: [],
         dataSources: [],
         autopublish: true,

package/lib/utils/cli-utils.js

@@ -57,7 +57,7 @@ function formatError(error) {
   } else if (errorMsg.includes('Docker') && (errorMsg.includes('not running') || errorMsg.includes('not installed') || errorMsg.includes('Cannot connect'))) {
     messages.push('   Docker is not running or not installed.');
     messages.push('   Please start Docker Desktop and try again.');
-  } else if (errorMsg.includes('port')) {
+  } else if (errorMsg.toLowerCase().includes('port') && (errorMsg.includes('already in use') || errorMsg.includes('in use') || errorMsg.includes('conflict'))) {
     messages.push('   Port conflict detected.');
     messages.push('   Run "aifabrix doctor" to check which ports are in use.');
   } else if ((errorMsg.includes('permission denied') || errorMsg.includes('EACCES') || errorMsg.includes('Permission denied')) && !errorMsg.includes('permissions/') && !errorMsg.includes('Field "permissions')) {
@@ -69,13 +69,13 @@ function formatError(error) {
     messages.push('   Azure CLI is not installed or not working properly.');
     messages.push('   Install from: https://docs.microsoft.com/cli/azure/install-azure-cli');
     messages.push('   Run: az login');
+  } else if (errorMsg.includes('Invalid ACR URL') || errorMsg.includes('Invalid registry URL') || errorMsg.includes('Expected format')) {
+    messages.push('   Invalid registry URL format.');
+    messages.push('   Use format: *.azurecr.io (e.g., myacr.azurecr.io)');
   } else if (errorMsg.includes('authenticate') || errorMsg.includes('ACR') || errorMsg.includes('Authentication required')) {
     messages.push('   Azure Container Registry authentication failed.');
     messages.push('   Run: az acr login --name <registry-name>');
     messages.push('   Or login to Azure: az login');
-  } else if (errorMsg.includes('Invalid ACR URL') || errorMsg.includes('Expected format')) {
-    messages.push('   Invalid registry URL format.');
-    messages.push('   Use format: *.azurecr.io (e.g., myacr.azurecr.io)');
   } else if (errorMsg.includes('Registry URL is required')) {
     messages.push('   Registry URL is required.');
     messages.push('   Provide via --registry flag or configure in variables.yaml under image.registry');

package/lib/utils/external-system-display.js

@@ -0,0 +1,159 @@
+/**
+ * External System Test Display Helpers
+ *
+ * Provides formatted output for test results.
+ *
+ * @fileoverview Display helpers for external system testing
+ * @author AI Fabrix Team
+ * @version 2.0.0
+ */
+
+const chalk = require('chalk');
+const logger = require('./logger');
+
+/**
+ * Displays formatted test results
+ * @param {Object} results - Test results
+ * @param {boolean} verbose - Show detailed output
+ */
+function displayTestResults(results, verbose = false) {
+  logger.log(chalk.blue('\n📊 Test Results\n'));
+
+  if (results.systemResults.length > 0) {
+    logger.log(chalk.blue('System Files:'));
+    for (const systemResult of results.systemResults) {
+      if (systemResult.valid) {
+        logger.log(chalk.green(`  ✓ ${systemResult.file}`));
+      } else {
+        logger.log(chalk.red(`  ✗ ${systemResult.file}`));
+      }
+    }
+  }
+
+  if (results.datasourceResults.length > 0) {
+    logger.log(chalk.blue('\nDatasource Files:'));
+    for (const dsResult of results.datasourceResults) {
+      if (dsResult.valid) {
+        logger.log(chalk.green(`  ✓ ${dsResult.key} (${dsResult.file})`));
+      } else {
+        logger.log(chalk.red(`  ✗ ${dsResult.key} (${dsResult.file})`));
+        if (verbose && dsResult.errors.length > 0) {
+          dsResult.errors.forEach(err => logger.log(chalk.red(`    - ${err}`)));
+        }
+      }
+
+      if (verbose) {
+        if (dsResult.warnings.length > 0) {
+          dsResult.warnings.forEach(warn => logger.log(chalk.yellow(`    ⚠ ${warn}`)));
+        }
+
+        if (dsResult.fieldMappingResults) {
+          const fm = dsResult.fieldMappingResults;
+          logger.log(chalk.gray(`    Field mappings: ${Object.keys(fm.mappedFields || {}).length} fields`));
+        }
+
+        if (dsResult.metadataSchemaResults) {
+          const ms = dsResult.metadataSchemaResults;
+          if (ms.valid) {
+            logger.log(chalk.gray('    Metadata schema: ✓ Valid'));
+          } else {
+            logger.log(chalk.red('    Metadata schema: ✗ Invalid'));
+          }
+        }
+      }
+    }
+  }
+
+  if (results.errors.length > 0) {
+    logger.log(chalk.red('\n❌ Errors:'));
+    results.errors.forEach(err => logger.log(chalk.red(`  - ${err}`)));
+  }
+
+  if (results.warnings.length > 0) {
+    logger.log(chalk.yellow('\n⚠ Warnings:'));
+    results.warnings.forEach(warn => logger.log(chalk.yellow(`  - ${warn}`)));
+  }
+
+  if (results.valid) {
+    logger.log(chalk.green('\n✅ All tests passed!'));
+  } else {
+    logger.log(chalk.red('\n❌ Some tests failed'));
+  }
+}
+
+/**
+ * Displays formatted integration test results
+ * @param {Object} results - Integration test results
+ * @param {boolean} verbose - Show detailed output
+ */
+function displayIntegrationTestResults(results, verbose = false) {
+  logger.log(chalk.blue('\n📊 Integration Test Results\n'));
+  logger.log(chalk.blue(`System: ${results.systemKey}`));
+
+  if (results.datasourceResults.length === 0) {
+    logger.log(chalk.yellow('No datasources tested'));
+    return;
+  }
+
+  for (const dsResult of results.datasourceResults) {
+    if (dsResult.skipped) {
+      logger.log(chalk.yellow(`  ⚠ ${dsResult.key}: ${dsResult.reason}`));
+      continue;
+    }
+
+    if (dsResult.success) {
+      logger.log(chalk.green(`  ✓ ${dsResult.key}`));
+    } else {
+      logger.log(chalk.red(`  ✗ ${dsResult.key}`));
+      if (dsResult.error) {
+        logger.log(chalk.red(`    Error: ${dsResult.error}`));
+      }
+    }
+
+    if (verbose) {
+      if (dsResult.validationResults) {
+        const vr = dsResult.validationResults;
+        if (vr.isValid) {
+          logger.log(chalk.gray('    Validation: ✓ Valid'));
+        } else {
+          logger.log(chalk.red('    Validation: ✗ Invalid'));
+          if (vr.errors && vr.errors.length > 0) {
+            vr.errors.forEach(err => logger.log(chalk.red(`      - ${err}`)));
+          }
+        }
+        if (vr.warnings && vr.warnings.length > 0) {
+          vr.warnings.forEach(warn => logger.log(chalk.yellow(`      ⚠ ${warn}`)));
+        }
+      }
+
+      if (dsResult.fieldMappingResults) {
+        const fmr = dsResult.fieldMappingResults;
+        logger.log(chalk.gray(`    Field mappings: ${fmr.mappingCount || 0} fields`));
+        if (fmr.accessFields && fmr.accessFields.length > 0) {
+          logger.log(chalk.gray(`      Access fields: ${fmr.accessFields.join(', ')}`));
+        }
+      }
+
+      if (dsResult.endpointTestResults) {
+        const etr = dsResult.endpointTestResults;
+        if (etr.endpointConfigured) {
+          logger.log(chalk.gray('    Endpoint: ✓ Configured'));
+        } else {
+          logger.log(chalk.gray('    Endpoint: Not configured'));
+        }
+      }
+    }
+  }
+
+  if (results.success) {
+    logger.log(chalk.green('\n✅ All integration tests passed!'));
+  } else {
+    logger.log(chalk.red('\n❌ Some integration tests failed'));
+  }
+}
+
+module.exports = {
+  displayTestResults,
+  displayIntegrationTestResults
+};
+