@dbcube/schema-builder 1.0.16 → 1.0.17

package/dist/index.cjs

@@ -30,15 +30,17 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  CubeValidator: () => CubeValidator,
   Schema: () => Schema,
+  UIUtils: () => UIUtils,
   default: () => index_default
 });
 module.exports = __toCommonJS(index_exports);
 
 // src/lib/Schema.ts
-var import_fs2 = __toESM(require("fs"));
+var import_fs3 = __toESM(require("fs"));
 var import_core = require("@dbcube/core");
-var import_path = __toESM(require("path"));
+var import_path2 = __toESM(require("path"));
 
 // src/lib/FileUtils.ts
 var fs = __toESM(require("fs"));
@@ -285,6 +287,313 @@ ${import_chalk.default.red("\u{1F6AB}")} ${import_chalk.default.bold.red("ERRORS
   }
 };
 
+// src/lib/CubeValidator.ts
+var import_fs2 = __toESM(require("fs"));
+var import_path = __toESM(require("path"));
+var CubeValidator = class {
+  validTypes = ["varchar", "int", "string", "text", "boolean", "date", "datetime", "timestamp", "decimal", "float", "double", "enum", "json"];
+  validOptions = ["not null", "primary", "autoincrement", "unique", "zerofill", "index", "required", "unsigned"];
+  validProperties = ["type", "length", "options", "value", "defaultValue", "foreign", "enumValues", "description"];
+  knownAnnotations = ["database", "table", "meta", "columns", "fields", "dataset", "beforeAdd", "afterAdd", "beforeUpdate", "afterUpdate", "beforeDelete", "afterDelete", "compute", "column"];
+  /**
+   * Validates a cube file comprehensively
+   */
+  validateCubeFile(filePath) {
+    const errors = [];
+    try {
+      const content = import_fs2.default.readFileSync(filePath, "utf8");
+      const lines = content.split("\n");
+      const fileName = import_path.default.basename(filePath, import_path.default.extname(filePath));
+      for (let lineIndex = 0; lineIndex < lines.length; lineIndex++) {
+        const line = lines[lineIndex];
+        if (line.trim() === "" || line.trim().startsWith("//")) {
+          continue;
+        }
+        this.validateAnnotations(line, lineIndex + 1, filePath, fileName, errors);
+        this.validateDataTypes(line, lineIndex + 1, filePath, fileName, errors, content);
+        this.validateColumnOptions(line, lineIndex + 1, filePath, fileName, errors, lines);
+        this.validateColumnProperties(line, lineIndex + 1, filePath, fileName, errors, content);
+        this.validateRequiredColumnProperties(lines, lineIndex + 1, filePath, fileName, errors);
+        this.validateGeneralSyntax(line, lineIndex + 1, filePath, fileName, errors);
+      }
+      this.validateOverallStructure(content, filePath, fileName, errors);
+    } catch (error) {
+      errors.push({
+        itemName: import_path.default.basename(filePath, import_path.default.extname(filePath)),
+        error: `Failed to read cube file: ${error.message}`,
+        filePath,
+        lineNumber: 1
+      });
+    }
+    return {
+      isValid: errors.length === 0,
+      errors
+    };
+  }
+  validateAnnotations(line, lineNumber, filePath, fileName, errors) {
+    const annotationRegex = /@(\w+)/g;
+    let match;
+    while ((match = annotationRegex.exec(line)) !== null) {
+      const annotation = match[1];
+      if (!this.knownAnnotations.includes(annotation)) {
+        errors.push({
+          itemName: fileName,
+          error: `Unknown annotation '@${annotation}'. Valid annotations: ${this.knownAnnotations.join(", ")}`,
+          filePath,
+          lineNumber
+        });
+      }
+    }
+  }
+  validateDataTypes(line, lineNumber, filePath, fileName, errors, content) {
+    const typeRegex = /type:\s*["'](\w+)["']/g;
+    let match;
+    while ((match = typeRegex.exec(line)) !== null) {
+      const type = match[1];
+      if (!this.validTypes.includes(type)) {
+        errors.push({
+          itemName: fileName,
+          error: `Invalid data type '${type}'. Valid types: ${this.validTypes.join(", ")}`,
+          filePath,
+          lineNumber
+        });
+      }
+    }
+    if (line.includes('type: "varchar"')) {
+      const lines = content.split("\n");
+      const hasLengthNearby = lines.slice(Math.max(0, lineNumber - 1), Math.min(lineNumber + 4, lines.length)).some((nextLine) => nextLine.includes("length:"));
+      if (!hasLengthNearby) {
+        errors.push({
+          itemName: fileName,
+          error: "VARCHAR type requires a length specification",
+          filePath,
+          lineNumber
+        });
+      }
+    }
+  }
+  validateColumnOptions(line, lineNumber, filePath, fileName, errors, lines) {
+    const optionsMatch = line.match(/^\s*options\s*:\s*\[(.*)\]\s*;?\s*$/);
+    if (!optionsMatch) return;
+    const optionsContent = optionsMatch[1].trim();
+    const invalidSyntaxMatch = optionsContent.match(/[^",\s]+(?![^"]*")/);
+    if (invalidSyntaxMatch) {
+      errors.push({
+        itemName: fileName,
+        error: `Invalid syntax '${invalidSyntaxMatch[0]}' in options array. All values must be quoted strings`,
+        filePath,
+        lineNumber
+      });
+      return;
+    }
+    const optionMatches = optionsContent.match(/"([^"]*)"/g);
+    if (optionMatches) {
+      const columnType = this.getColumnTypeForOptions(lines, lineNumber - 1);
+      optionMatches.forEach((optionMatch) => {
+        const option = optionMatch.replace(/"/g, "");
+        if (option.trim() === "") {
+          errors.push({
+            itemName: fileName,
+            error: "Empty option found in options array. All options must have a value",
+            filePath,
+            lineNumber
+          });
+        } else if (!this.validOptions.includes(option)) {
+          errors.push({
+            itemName: fileName,
+            error: `Invalid option '${option}'. Valid options: ${this.validOptions.join(", ")}`,
+            filePath,
+            lineNumber
+          });
+        } else if (!this.isOptionCompatibleWithType(option, columnType)) {
+          errors.push({
+            itemName: fileName,
+            error: `Option '${option}' is not compatible with type '${columnType}'`,
+            filePath,
+            lineNumber
+          });
+        }
+      });
+    }
+  }
+  validateColumnProperties(line, lineNumber, filePath, fileName, errors, content) {
+    const propertyKeyRegex = /^\s*([a-zA-Z_][a-zA-Z0-9_]*)\s*:/;
+    const propMatch = propertyKeyRegex.exec(line);
+    if (!propMatch) return;
+    const propertyName = propMatch[1];
+    if (/^\s*[a-zA-Z_][a-zA-Z0-9_]*\s*:\s*\{/.test(line)) {
+      return;
+    }
+    if (this.isInsideColumnsBlock(content, lineNumber - 1)) {
+      if (!this.validProperties.includes(propertyName)) {
+        errors.push({
+          itemName: fileName,
+          error: `Invalid property '${propertyName}'. Valid properties: ${this.validProperties.join(", ")}`,
+          filePath,
+          lineNumber
+        });
+      }
+    }
+    if (/^\s*([a-zA-Z_][a-zA-Z0-9_]*)\s*:\s*$/.test(line)) {
+      errors.push({
+        itemName: fileName,
+        error: `Property '${propertyName}' is missing a value`,
+        filePath,
+        lineNumber
+      });
+    }
+  }
+  validateRequiredColumnProperties(lines, lineNumber, filePath, fileName, errors) {
+    const line = lines[lineNumber - 1];
+    if (!/^\s*\}\s*;?\s*$/.test(line)) {
+      return;
+    }
+    let columnStartLine = -1;
+    let columnName = "";
+    for (let i = lineNumber - 2; i >= 0; i--) {
+      const currentLine = lines[i];
+      const columnDefMatch = currentLine.match(/^\s*([a-zA-Z_][a-zA-Z0-9_]*)\s*:\s*\{/);
+      if (columnDefMatch) {
+        let openBraces = 0;
+        let closeBraces = 0;
+        for (let j = i; j < lineNumber; j++) {
+          openBraces += (lines[j].match(/\{/g) || []).length;
+          closeBraces += (lines[j].match(/\}/g) || []).length;
+        }
+        if (openBraces === closeBraces) {
+          columnStartLine = i;
+          columnName = columnDefMatch[1];
+          break;
+        }
+      }
+    }
+    if (columnStartLine === -1 || !columnName) return;
+    let hasType = false;
+    for (let i = columnStartLine + 1; i < lineNumber - 1; i++) {
+      if (lines[i].match(/^\s*type\s*:/)) {
+        hasType = true;
+        break;
+      }
+    }
+    if (!hasType && columnName !== "foreign" && columnName !== "defaultValue") {
+      errors.push({
+        itemName: fileName,
+        error: `Column '${columnName}' is missing required 'type' property`,
+        filePath,
+        lineNumber: columnStartLine + 1
+      });
+    }
+  }
+  validateGeneralSyntax(line, lineNumber, filePath, fileName, errors) {
+    const quotes = line.match(/["']/g);
+    if (quotes && quotes.length % 2 !== 0) {
+      errors.push({
+        itemName: fileName,
+        error: "Mismatched quotes detected",
+        filePath,
+        lineNumber
+      });
+    }
+    if (line.includes("@database") || line.includes("@table")) {
+      const stringAnnotationRegex = /@(database|table)\s*\(\s*"([^"]*)"\s*\)/;
+      if (!stringAnnotationRegex.test(line)) {
+        errors.push({
+          itemName: fileName,
+          error: 'Invalid annotation syntax. Expected format: @annotation("value")',
+          filePath,
+          lineNumber
+        });
+      }
+    }
+    if (line.includes("@meta")) {
+      const metaObjectRegex = /@meta\s*\(\s*\{/;
+      if (!metaObjectRegex.test(line)) {
+        errors.push({
+          itemName: fileName,
+          error: "Invalid @meta syntax. Expected format: @meta({ ... })",
+          filePath,
+          lineNumber
+        });
+      }
+    }
+  }
+  validateOverallStructure(content, filePath, fileName, errors) {
+    const lines = content.split("\n");
+    const hasDatabase = lines.some((line) => line.includes("@database"));
+    if (!hasDatabase) {
+      errors.push({
+        itemName: fileName,
+        error: "Missing required @database annotation",
+        filePath,
+        lineNumber: 1
+      });
+    }
+    if (filePath.includes(".table.cube")) {
+      const hasColumns = lines.some((line) => line.includes("@columns"));
+      if (!hasColumns) {
+        errors.push({
+          itemName: fileName,
+          error: "Table cube files require @columns annotation",
+          filePath,
+          lineNumber: 1
+        });
+      }
+    }
+  }
+  getColumnTypeForOptions(lines, optionsLineIndex) {
+    for (let i = optionsLineIndex - 1; i >= 0; i--) {
+      const line = lines[i];
+      const typeMatch = line.match(/^\s*type\s*:\s*"([^"]+)"/);
+      if (typeMatch) {
+        return typeMatch[1];
+      }
+      if (/^\s*[a-zA-Z_][a-zA-Z0-9_]*\s*:\s*\{/.test(line)) {
+        break;
+      }
+    }
+    return "unknown";
+  }
+  isOptionCompatibleWithType(option, type) {
+    const compatibilityRules = {
+      "zerofill": ["int", "decimal", "float", "double"],
+      "unsigned": ["int", "decimal", "float", "double"],
+      "autoincrement": ["int"],
+      "primary": ["int", "varchar", "string"],
+      "not null": ["int", "varchar", "string", "text", "boolean", "date", "datetime", "timestamp", "decimal", "float", "double"],
+      "unique": ["int", "varchar", "string", "text"],
+      "index": ["int", "varchar", "string", "text", "date", "datetime", "timestamp"],
+      "required": ["int", "varchar", "string", "text", "boolean", "date", "datetime", "timestamp", "decimal", "float", "double"]
+    };
+    const compatibleTypes = compatibilityRules[option];
+    if (!compatibleTypes) {
+      return true;
+    }
+    return compatibleTypes.includes(type);
+  }
+  isInsideColumnsBlock(content, lineIndex) {
+    const lines = content.split("\n");
+    let columnsStartLine = -1;
+    let columnsEndLine = -1;
+    for (let i = 0; i < lines.length; i++) {
+      if (lines[i].includes("@columns")) {
+        columnsStartLine = i;
+        let braceCount = 0;
+        for (let j = i; j < lines.length; j++) {
+          const currentLine = lines[j];
+          braceCount += (currentLine.match(/\{/g) || []).length;
+          braceCount -= (currentLine.match(/\}/g) || []).length;
+          if (braceCount === 0 && j > i) {
+            columnsEndLine = j;
+            break;
+          }
+        }
+        break;
+      }
+    }
+    return columnsStartLine !== -1 && columnsEndLine !== -1 && lineIndex > columnsStartLine && lineIndex < columnsEndLine;
+  }
+};
+
 // src/lib/Schema.ts
 var Schema = class {
   name;
@@ -294,18 +603,27 @@ var Schema = class {
     this.engine = new import_core.Engine(name);
   }
   /**
-   * Validates that the database specified in cube file exists in configuration
+   * Validates cube file comprehensively including syntax, database configuration, and structure
    * @param filePath - Path to the cube file
-   * @returns true if valid, throws error if invalid
+   * @returns validation result with any errors found
    */
   validateDatabaseConfiguration(filePath) {
     try {
+      const cubeValidator = new CubeValidator();
+      const cubeValidation = cubeValidator.validateCubeFile(filePath);
+      if (!cubeValidation.isValid && cubeValidation.errors.length > 0) {
+        return {
+          isValid: false,
+          error: cubeValidation.errors[0]
+          // Return the first error found
+        };
+      }
       const dbResult = FileUtils_default.extractDatabaseNameFromCube(filePath);
       if (dbResult.status !== 200) {
         return {
           isValid: false,
           error: {
-            itemName: import_path.default.basename(filePath, import_path.default.extname(filePath)),
+            itemName: import_path2.default.basename(filePath, import_path2.default.extname(filePath)),
             error: `Error reading database directive: ${dbResult.message}`,
             filePath,
             lineNumber: this.findDatabaseLineNumber(filePath)
@@ -314,7 +632,7 @@ var Schema = class {
       }
       const cubeDbName = dbResult.message;
       const configInstance = new import_core.Config();
-      const configFilePath = import_path.default.resolve(process.cwd(), "dbcube.config.js");
+      const configFilePath = import_path2.default.resolve(process.cwd(), "dbcube.config.js");
       const configFn = require(configFilePath);
       if (typeof configFn === "function") {
         configFn(configInstance);
@@ -341,7 +659,7 @@ var Schema = class {
         return {
           isValid: false,
           error: {
-            itemName: import_path.default.basename(filePath, import_path.default.extname(filePath)),
+            itemName: import_path2.default.basename(filePath, import_path2.default.extname(filePath)),
             error: `Database configuration '${cubeDbName}' not found in dbcube.config.js. Available: ${availableText}`,
             filePath,
             lineNumber: this.findDatabaseLineNumber(filePath)
@@ -353,7 +671,7 @@ var Schema = class {
       return {
         isValid: false,
         error: {
-          itemName: import_path.default.basename(filePath, import_path.default.extname(filePath)),
+          itemName: import_path2.default.basename(filePath, import_path2.default.extname(filePath)),
           error: `Database configuration validation failed: ${error.message}`,
           filePath,
           lineNumber: this.findDatabaseLineNumber(filePath)
@@ -366,7 +684,7 @@ var Schema = class {
    */
   findDatabaseLineNumber(filePath) {
     try {
-      const content = import_fs2.default.readFileSync(filePath, "utf8");
+      const content = import_fs3.default.readFileSync(filePath, "utf8");
       const lines = content.split("\n");
       for (let i = 0; i < lines.length; i++) {
         if (lines[i].includes("@database")) {
@@ -380,7 +698,7 @@ var Schema = class {
   }
   async createDatabase() {
     const startTime = Date.now();
-    const rootPath = import_path.default.resolve(process.cwd());
+    const rootPath = import_path2.default.resolve(process.cwd());
     UIUtils.showOperationHeader(" CREATING DATABASE", this.name, "\u{1F5C4}\uFE0F");
     await UIUtils.showItemProgress("Preparando e instalando base de datos", 1, 1);
     try {
@@ -424,8 +742,8 @@ var Schema = class {
   }
   async refreshTables() {
     const startTime = Date.now();
-    const cubesDir = import_path.default.join(process.cwd(), "dbcube", "cubes");
-    if (!import_fs2.default.existsSync(cubesDir)) {
+    const cubesDir = import_path2.default.join(process.cwd(), "dbcube", "cubes");
+    if (!import_fs3.default.existsSync(cubesDir)) {
       throw new Error("\u274C The cubes folder does not exist");
     }
     const cubeFiles = FileUtils_default.getCubeFilesRecursively("dbcube", "table.cube");
@@ -440,11 +758,11 @@ var Schema = class {
     const errors = [];
     for (let index = 0; index < cubeFiles.length; index++) {
       const file = cubeFiles[index];
-      const filePath = import_path.default.isAbsolute(file) ? file : import_path.default.join(cubesDir, file);
-      const stats = import_fs2.default.statSync(filePath);
+      const filePath = import_path2.default.isAbsolute(file) ? file : import_path2.default.join(cubesDir, file);
+      const stats = import_fs3.default.statSync(filePath);
       if (stats.isFile()) {
         const getTableName = FileUtils_default.extracTableNameFromCube(filePath);
-        const tableName = getTableName.status === 200 ? getTableName.message : import_path.default.basename(file, ".table.cube");
+        const tableName = getTableName.status === 200 ? getTableName.message : import_path2.default.basename(file, ".table.cube");
         await UIUtils.showItemProgress(tableName, index + 1, cubeFiles.length);
         try {
           const validation = this.validateDatabaseConfiguration(filePath);
@@ -526,8 +844,8 @@ var Schema = class {
   }
   async freshTables() {
     const startTime = Date.now();
-    const cubesDir = import_path.default.join(process.cwd(), "dbcube", "cubes");
-    if (!import_fs2.default.existsSync(cubesDir)) {
+    const cubesDir = import_path2.default.join(process.cwd(), "dbcube", "cubes");
+    if (!import_fs3.default.existsSync(cubesDir)) {
       throw new Error("\u274C The cubes folder does not exist");
     }
     const cubeFiles = FileUtils_default.getCubeFilesRecursively("dbcube", "table.cube");
@@ -542,11 +860,11 @@ var Schema = class {
     const errors = [];
     for (let index = 0; index < cubeFiles.length; index++) {
       const file = cubeFiles[index];
-      const filePath = import_path.default.isAbsolute(file) ? file : import_path.default.join(cubesDir, file);
-      const stats = import_fs2.default.statSync(filePath);
+      const filePath = import_path2.default.isAbsolute(file) ? file : import_path2.default.join(cubesDir, file);
+      const stats = import_fs3.default.statSync(filePath);
       if (stats.isFile()) {
         const getTableName = FileUtils_default.extracTableNameFromCube(filePath);
-        const tableName = getTableName.status === 200 ? getTableName.message : import_path.default.basename(file, ".table.cube");
+        const tableName = getTableName.status === 200 ? getTableName.message : import_path2.default.basename(file, ".table.cube");
         await UIUtils.showItemProgress(tableName, index + 1, cubeFiles.length);
         try {
           const validation = this.validateDatabaseConfiguration(filePath);
@@ -626,8 +944,8 @@ var Schema = class {
   }
   async executeSeeders() {
     const startTime = Date.now();
-    const cubesDir = import_path.default.join(process.cwd(), "dbcube", "cubes");
-    if (!import_fs2.default.existsSync(cubesDir)) {
+    const cubesDir = import_path2.default.join(process.cwd(), "dbcube", "cubes");
+    if (!import_fs3.default.existsSync(cubesDir)) {
       throw new Error("\u274C The cubes folder does not exist");
     }
     const cubeFiles = FileUtils_default.getCubeFilesRecursively("dbcube", "seeder.cube");
@@ -642,11 +960,11 @@ var Schema = class {
     const errors = [];
     for (let index = 0; index < cubeFiles.length; index++) {
       const file = cubeFiles[index];
-      const filePath = import_path.default.isAbsolute(file) ? file : import_path.default.join(cubesDir, file);
-      const stats = import_fs2.default.statSync(filePath);
+      const filePath = import_path2.default.isAbsolute(file) ? file : import_path2.default.join(cubesDir, file);
+      const stats = import_fs3.default.statSync(filePath);
       if (stats.isFile()) {
         const getSeederName = FileUtils_default.extracTableNameFromCube(filePath);
-        const seederName = getSeederName.status === 200 ? getSeederName.message : import_path.default.basename(file, ".seeder.cube");
+        const seederName = getSeederName.status === 200 ? getSeederName.message : import_path2.default.basename(file, ".seeder.cube");
         await UIUtils.showItemProgress(seederName, index + 1, cubeFiles.length);
         try {
           const validation = this.validateDatabaseConfiguration(filePath);
@@ -697,9 +1015,9 @@ var Schema = class {
   }
   async executeTriggers() {
     const startTime = Date.now();
-    const cubesDir = import_path.default.join(process.cwd(), "dbcube", "cubes");
-    const triggersDirExit = import_path.default.join(process.cwd(), "dbcube", "triggers");
-    if (!import_fs2.default.existsSync(cubesDir)) {
+    const cubesDir = import_path2.default.join(process.cwd(), "dbcube", "cubes");
+    const triggersDirExit = import_path2.default.join(process.cwd(), "dbcube", "triggers");
+    if (!import_fs3.default.existsSync(cubesDir)) {
       throw new Error("\u274C The cubes folder does not exist");
     }
     const cubeFiles = FileUtils_default.getCubeFilesRecursively("dbcube", "trigger.cube");
@@ -714,11 +1032,11 @@ var Schema = class {
     const errors = [];
     for (let index = 0; index < cubeFiles.length; index++) {
       const file = cubeFiles[index];
-      const filePath = import_path.default.isAbsolute(file) ? file : import_path.default.join(cubesDir, file);
-      const stats = import_fs2.default.statSync(filePath);
+      const filePath = import_path2.default.isAbsolute(file) ? file : import_path2.default.join(cubesDir, file);
+      const stats = import_fs3.default.statSync(filePath);
       if (stats.isFile()) {
         const getTriggerName = FileUtils_default.extracTableNameFromCube(filePath);
-        const triggerName = getTriggerName.status === 200 ? getTriggerName.message : import_path.default.basename(file, ".trigger.cube");
+        const triggerName = getTriggerName.status === 200 ? getTriggerName.message : import_path2.default.basename(file, ".trigger.cube");
         await UIUtils.showItemProgress(triggerName, index + 1, cubeFiles.length);
         try {
           const validation = this.validateDatabaseConfiguration(filePath);
@@ -789,7 +1107,7 @@ ${import_chalk2.default.red("\u{1F6AB}")} ${import_chalk2.default.bold.red("ERRO
       const errorLocation = `${filePath}:${lineStr}:${columnStr}`;
       console.log(`${import_chalk2.default.cyan("[code]")} ${import_chalk2.default.yellow(errorLocation)}`);
       try {
-        const codeLines = import_fs2.default.readFileSync(filePath, "utf-8").split("\n");
+        const codeLines = import_fs3.default.readFileSync(filePath, "utf-8").split("\n");
         const start = Math.max(0, lineNum - 3);
         const end = Math.min(codeLines.length, lineNum + 2);
         for (let i = start; i < end; i++) {
@@ -803,6 +1121,7 @@ ${import_chalk2.default.red("\u{1F6AB}")} ${import_chalk2.default.bold.red("ERRO
       }
     }
   }
+  console.log("");
   process.exit(1);
 }
 
@@ -810,6 +1129,8 @@ ${import_chalk2.default.red("\u{1F6AB}")} ${import_chalk2.default.bold.red("ERRO
 var index_default = Schema;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  Schema
+  CubeValidator,
+  Schema,
+  UIUtils
 });
 //# sourceMappingURL=index.cjs.map