@api-client/core 0.19.11 → 0.19.12

package/build/src/modeling/validation/entity_validation.js.map

@@ -1 +1 @@
-{"version":3,"file":"entity_validation.js","sourceRoot":"","sources":["../../../../src/modeling/validation/entity_validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAGxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAGlD;;;;;;GAMG;AACH,MAAM,OAAO,gBAAgB;IACL;IAAtB,YAAsB,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAE5C;;;;;OAKG;IACH,QAAQ,CAAC,MAA6B;QACpC,MAAM,OAAO,GAAuB,EAAE,CAAA;QACtC,IAAI,MAAgC,CAAA;QACpC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QACzC,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,MAAM,CAAA;QACjB,CAAC;QACD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,OAAO,GAAG,QAAQ,MAAM,0BAA0B,CAAA;YACxD,MAAM,IAAI,GAAG,2CAA2C,CAAA;YACxD,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,GAAG;gBACV,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,GAAG,EAAE,MAAgB;gBACrB,IAAI,EAAE,gBAAgB;gBACtB,QAAQ,EAAE,OAAO;aAClB,CAAC,CAAA;YACF,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAA;QAClD,OAAO,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAA;QAC3B,MAAM,iBAAiB,GAAG,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;QAChE,OAAO,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,CAAA;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QACtC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAA;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QACtC,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAA;QACvB,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;OAGG;IACH,kBAAkB,CAAC,MAAoB;QACrC,MAAM,OAAO,GAAuB,EAAE,CAAA;QACtC,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAA;QACnC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,OAAO,GAAG,QAAQ,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,6BAA6B,CAAA;YAC3E,MAAM,IAAI,GAAG,mEAAmE,CAAA;YAChF,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,YAAY;gBACnB,IAAI,EAAE,aAAa;gBACnB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;;OAKG;IACK,sBAAsB,CAAC,MAAoB;QACjD,gCAAgC;QAChC,IAAI,MAAM,CAAC,aAAa,EAAE,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAA;QACb,CAAC;QAED,gCAAgC;QAChC,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,WAAW,EAAE,EAAE,CAAC;YAC1C,IAAI,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,EAAE,CAAC;gBACxC,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;OAKG;IACK,wBAAwB,CAAC,MAAoB;QACnD,kCAAkC;QAClC,IAAI,MAAM,CAAC,eAAe,EAAE,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAA;QACb,CAAC;QAED,gCAAgC;QAChC,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,WAAW,EAAE,EAAE,CAAC;YAC1C,IAAI,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1C,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;OAGG;IACH,yBAAyB,CAAC,MAAoB;QAC5C,MAAM,OAAO,GAAuB,EAAE,CAAA;QAEtC,kFAAkF;QAClF,MAAM,aAAa,GAAG,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAA;QACzD,MAAM,eAAe,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAA;QAE7D,IAAI,CAAC,aAAa,IAAI,CAAC,eAAe,EAAE,CAAC;YACvC,MAAM,OAAO,GAAG,QAAQ,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,iDAAiD,CAAA;YAC/F,MAAM,IAAI,GAAG,sGAAsG,CAAA;YACnH,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,YAAY;gBACnB,IAAI,EAAE,UAAU;gBAChB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,SAAS;gBACnB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,MAAoB;QAC/B,MAAM,OAAO,GAAuB,EAAE,CAAA;QACtC,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAA;QACpC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACtB,MAAM,OAAO,GAAG,QAAQ,KAAK,uBAAuB,CAAA;YACpD,MAAM,IAAI,GAAG,6BAA6B,CAAA;YAC1C,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,UAAU;gBAChB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;YACF,OAAO,OAAO,CAAA;QAChB,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAA;QAC7B,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,MAAM,OAAO,GAAG,QAAQ,KAAK,6BAA6B,CAAA;YAC1D,MAAM,IAAI,GAAG,8CAA8C,CAAA;YAC3D,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YACrB,MAAM,OAAO,GAAG,QAAQ,KAAK,4BAA4B,CAAA;YACzD,MAAM,IAAI,GAAG,8CAA8C,CAAA;YAC3D,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3C,MAAM,OAAO,GAAG,QAAQ,KAAK,2BAA2B,CAAA;YACxD,MAAM,IAAI,GAAG,oIAAoI,CAAA;YACjJ,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,QAAQ,KAAK,qCAAqC,CAAA;YAClE,MAAM,IAAI,GAAG,uEAAuE,CAAA;YACpF,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,YAAY;gBAClB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,MAAM;gBAChB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YAC7C,MAAM,OAAO,GAAG,QAAQ,KAAK,sCAAsC,CAAA;YACnE,MAAM,IAAI,GAAG,4CAA4C,CAAA;YACzD,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,UAAU;gBAChB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,MAAoB;QAC7B,MAAM,OAAO,GAAuB,EAAE,CAAA;QACtC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,CAAA;QAC5C,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,6EAA6E;QAC7E,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,CAAC;YAC/C,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,IAAI,IAAI,KAAK,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC;gBACxE,MAAM,OAAO,GAAG,QAAQ,IAAI,mDAAmD,CAAA;gBAC/E,MAAM,IAAI,GAAG,0EAA0E,CAAA;gBACvF,OAAO,CAAC,IAAI,CAAC;oBACX,KAAK,EAAE,MAAM;oBACb,IAAI,EAAE,QAAQ;oBACd,OAAO;oBACP,IAAI;oBACJ,QAAQ,EAAE,OAAO;oBACjB,GAAG,EAAE,KAAK,CAAC,GAAG;oBACd,IAAI,EAAE,KAAK,CAAC,IAAI;iBACjB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,sBAAsB,EAAE,EAAE,CAAC;YACzD,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,IAAI,IAAI,KAAK,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC;gBACxE,MAAM,OAAO,GAAG,QAAQ,IAAI,2DAA2D,CAAA;gBACvF,MAAM,IAAI,GAAG,0EAA0E,CAAA;gBACvF,OAAO,CAAC,IAAI,CAAC;oBACX,KAAK,EAAE,MAAM;oBACb,IAAI,EAAE,QAAQ;oBACd,OAAO;oBACP,IAAI;oBACJ,QAAQ,EAAE,OAAO;oBACjB,GAAG,EAAE,KAAK,CAAC,GAAG;oBACd,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG;iBACzB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;CACF","sourcesContent":["import { DomainEntityKind } from '../../models/kinds.js'\nimport type { DataDomain } from '../DataDomain.js'\nimport type { DomainEntity } from '../DomainEntity.js'\nimport { ReservedKeywords } from './postgresql.js'\nimport type { DomainValidation } from './rules.js'\n\n/**\n * EntityValidation is a class that performs validation on entities in a data domain.\n *\n * @remarks\n * - We do not need to check for parent uniqueness here, because in the graph there can only be one edge\n *   between two nodes. Parent relationships are described by an edge in the graph.\n */\nexport class EntityValidation {\n  constructor(protected domain: DataDomain) {}\n\n  /**\n   * Performs all the validation rules on the entity.\n   * If you are interested in a specific rule, use the specific method.\n   * @param target The target entity to validate. Can be a string with\n   *               the entity key or a DomainEntity object.\n   */\n  validate(target: string | DomainEntity): DomainValidation[] {\n    const results: DomainValidation[] = []\n    let entity: DomainEntity | undefined\n    if (typeof target === 'string') {\n      entity = this.domain.findEntity(target)\n    } else {\n      entity = target\n    }\n    if (!entity) {\n      const message = `The \"${target}\" entity does not exist.`\n      const help = `The entity must be defined in the domain.`\n      results.push({\n        field: '*',\n        rule: 'exists',\n        message,\n        help,\n        key: target as string,\n        kind: DomainEntityKind,\n        severity: 'error',\n      })\n      return results\n    }\n    const primaryKey = this.validatePrimaryKey(entity)\n    results.push(...primaryKey)\n    const minimumProperties = this.minimumRequiredProperties(entity)\n    results.push(...minimumProperties)\n    const name = this.validateName(entity)\n    results.push(...name)\n    const unique = this.uniqueName(entity)\n    results.push(...unique)\n    return results\n  }\n\n  /**\n   * Validates the entity primary key.\n   * @param entity The entity to validate\n   */\n  validatePrimaryKey(entity: DomainEntity): DomainValidation[] {\n    const results: DomainValidation[] = []\n    const primary = entity.primaryKey()\n    if (!primary) {\n      const message = `The \"${entity.info.getLabel()}\" entity has no identifier.`\n      const help = `An entity that can exists by itself must have identifier defined.`\n      results.push({\n        field: 'properties',\n        rule: 'primary_key',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    return results\n  }\n\n  /**\n   * Checks if an entity has properties through its entire inheritance chain.\n   * This includes direct properties and properties inherited from any level of parent entities.\n   * @param entity The entity to check\n   * @returns True if the entity has properties either directly or through inheritance\n   */\n  private hasPropertiesInherited(entity: DomainEntity): boolean {\n    // Check direct properties first\n    if (entity.hasProperties()) {\n      return true\n    }\n\n    // Check all parents recursively\n    for (const parent of entity.listParents()) {\n      if (this.hasPropertiesInherited(parent)) {\n        return true\n      }\n    }\n\n    return false\n  }\n\n  /**\n   * Checks if an entity has associations through its entire inheritance chain.\n   * This includes direct associations and associations inherited from any level of parent entities.\n   * @param entity The entity to check\n   * @returns True if the entity has associations either directly or through inheritance\n   */\n  private hasAssociationsInherited(entity: DomainEntity): boolean {\n    // Check direct associations first\n    if (entity.hasAssociations()) {\n      return true\n    }\n\n    // Check all parents recursively\n    for (const parent of entity.listParents()) {\n      if (this.hasAssociationsInherited(parent)) {\n        return true\n      }\n    }\n\n    return false\n  }\n\n  /**\n   * Checks if the entity has the minimum required properties.\n   * @param entity The entity to validate\n   */\n  minimumRequiredProperties(entity: DomainEntity): DomainValidation[] {\n    const results: DomainValidation[] = []\n\n    // Check if entity has properties or associations through entire inheritance chain\n    const hasProperties = this.hasPropertiesInherited(entity)\n    const hasAssociations = this.hasAssociationsInherited(entity)\n\n    if (!hasProperties && !hasAssociations) {\n      const message = `The \"${entity.info.getLabel()}\" entity has no properties. It will be ignored.`\n      const help = `Entities that have no properties are ignored in the data domain. No schema will be generated for it.`\n      results.push({\n        field: 'properties',\n        rule: 'required',\n        message,\n        help,\n        severity: 'warning',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    return results\n  }\n\n  /**\n   * Validates the entity name.\n   *\n   * @remarks\n   * - An entity must have a name defined.\n   * - The name has to follow the same rules as the names in a PostgreSQL database.\n   *   - Table names must start with a letter (a-z) or underscore (_).\n   *   - Subsequent characters can be letters, digits (0-9), or underscores (_).\n   *   - Names are case-insensitive.\n   *   - The maximum length of a table name is 31 characters\n   *   - Should be snake case (it's a convention, not an error).\n   *   - Should not be a reserved word (for example: \"IN\", \"SELECT\", \"FROM\", etc.).\n   * @param entity The entity to validate\n   */\n  validateName(entity: DomainEntity): DomainValidation[] {\n    const results: DomainValidation[] = []\n    const label = entity.info.getLabel()\n    if (!entity.info.name) {\n      const message = `The \"${label}\" entity has no name.`\n      const help = `An entity must have a name.`\n      results.push({\n        field: 'name',\n        rule: 'required',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n      return results\n    }\n\n    const name = entity.info.name\n    if (name.length < 2) {\n      const message = `The \"${label}\" entity name is too short.`\n      const help = `The name must be at least 2 characters long.`\n      results.push({\n        field: 'name',\n        rule: 'length',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    if (name.length > 31) {\n      const message = `The \"${label}\" entity name is too long.`\n      const help = `The name must be at most 31 characters long.`\n      results.push({\n        field: 'name',\n        rule: 'length',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    if (!/^[a-zA-Z_][a-zA-Z0-9_]*$/.test(name)) {\n      const message = `The \"${label}\" entity name is invalid.`\n      const help = `The name must start with a letter (a-z) or underscore (_). Subsequent characters can be letters, digits (0-9), or underscores (_).`\n      results.push({\n        field: 'name',\n        rule: 'format',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    if (/^[A-Z]/.test(name)) {\n      const message = `The \"${label}\" entity name is not in snake case.`\n      const help = `The name should be in snake case (lowercase letters and underscores).`\n      results.push({\n        field: 'name',\n        rule: 'snake_case',\n        message,\n        help,\n        severity: 'info',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    if (ReservedKeywords.has(name.toUpperCase())) {\n      const message = `The \"${label}\" entity name is a reserved keyword.`\n      const help = `The name should not be a reserved keyword.`\n      results.push({\n        field: 'name',\n        rule: 'reserved',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    return results\n  }\n\n  /**\n   * Checks if the entity name is unique in the data domain.\n   * @param entity The entity to validate\n   */\n  uniqueName(entity: DomainEntity): DomainValidation[] {\n    const results: DomainValidation[] = []\n    const name = entity.info.name?.toLowerCase()\n    if (!name) {\n      return results\n    }\n    // We need to check the unique names in all entities, including foreign ones.\n    for (const other of this.domain.listEntities()) {\n      if (other.info.name?.toLowerCase() === name && other.key !== entity.key) {\n        const message = `The \"${name}\" entity name is already used in the data domain.`\n        const help = `The name must be unique. This includes references to other data domains.`\n        results.push({\n          field: 'name',\n          rule: 'unique',\n          message,\n          help,\n          severity: 'error',\n          key: other.key,\n          kind: other.kind,\n        })\n      }\n    }\n    for (const other of this.domain.listAllForeignEntities()) {\n      if (other.info.name?.toLowerCase() === name && other.key !== entity.key) {\n        const message = `The \"${name}\" entity name is already used in the foreign data domain.`\n        const help = `The name must be unique. This includes references to other data domains.`\n        results.push({\n          field: 'name',\n          rule: 'unique',\n          message,\n          help,\n          severity: 'error',\n          key: other.key,\n          kind: other.kind,\n          parent: other.domain.key,\n        })\n      }\n    }\n    return results\n  }\n}\n"]}
+{"version":3,"file":"entity_validation.js","sourceRoot":"","sources":["../../../../src/modeling/validation/entity_validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAGxD,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAGlD;;;;;;GAMG;AACH,MAAM,OAAO,gBAAgB;IACL;IAAtB,YAAsB,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAE5C;;;;;OAKG;IACH,QAAQ,CAAC,MAA6B;QACpC,MAAM,OAAO,GAA6B,EAAE,CAAA;QAC5C,IAAI,MAAgC,CAAA;QACpC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QACzC,CAAC;aAAM,CAAC;YACN,MAAM,GAAG,MAAM,CAAA;QACjB,CAAC;QACD,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,OAAO,GAAG,QAAQ,MAAM,0BAA0B,CAAA;YACxD,MAAM,IAAI,GAAG,2CAA2C,CAAA;YACxD,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,GAAG;gBACV,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,GAAG,EAAE,MAAgB;gBACrB,IAAI,EAAE,gBAAgB;gBACtB,QAAQ,EAAE,OAAO;aAClB,CAAC,CAAA;YACF,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAA;QAClD,OAAO,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAA;QAC3B,MAAM,iBAAiB,GAAG,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;QAChE,OAAO,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,CAAA;QAClC,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QACtC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAA;QACrB,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QACtC,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,CAAC,CAAA;QACvB,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;OAGG;IACH,kBAAkB,CAAC,MAAoB;QACrC,MAAM,OAAO,GAA6B,EAAE,CAAA;QAC5C,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,EAAE,CAAA;QACnC,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,OAAO,GAAG,QAAQ,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,6BAA6B,CAAA;YAC3E,MAAM,IAAI,GAAG,mEAAmE,CAAA;YAChF,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,YAAY;gBACnB,IAAI,EAAE,aAAa;gBACnB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;;OAKG;IACK,sBAAsB,CAAC,MAAoB;QACjD,gCAAgC;QAChC,IAAI,MAAM,CAAC,aAAa,EAAE,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAA;QACb,CAAC;QAED,gCAAgC;QAChC,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,WAAW,EAAE,EAAE,CAAC;YAC1C,IAAI,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,EAAE,CAAC;gBACxC,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;OAKG;IACK,wBAAwB,CAAC,MAAoB;QACnD,kCAAkC;QAClC,IAAI,MAAM,CAAC,eAAe,EAAE,EAAE,CAAC;YAC7B,OAAO,IAAI,CAAA;QACb,CAAC;QAED,gCAAgC;QAChC,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,WAAW,EAAE,EAAE,CAAC;YAC1C,IAAI,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC1C,OAAO,IAAI,CAAA;YACb,CAAC;QACH,CAAC;QAED,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;OAGG;IACH,yBAAyB,CAAC,MAAoB;QAC5C,MAAM,OAAO,GAA6B,EAAE,CAAA;QAE5C,kFAAkF;QAClF,MAAM,aAAa,GAAG,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAA;QACzD,MAAM,eAAe,GAAG,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,CAAA;QAE7D,IAAI,CAAC,aAAa,IAAI,CAAC,eAAe,EAAE,CAAC;YACvC,MAAM,OAAO,GAAG,QAAQ,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,iDAAiD,CAAA;YAC/F,MAAM,IAAI,GAAG,sGAAsG,CAAA;YACnH,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,YAAY;gBACnB,IAAI,EAAE,UAAU;gBAChB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,SAAS;gBACnB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,MAAoB;QAC/B,MAAM,OAAO,GAA6B,EAAE,CAAA;QAC5C,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAA;QACpC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACtB,MAAM,OAAO,GAAG,QAAQ,KAAK,uBAAuB,CAAA;YACpD,MAAM,IAAI,GAAG,6BAA6B,CAAA;YAC1C,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,UAAU;gBAChB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;YACF,OAAO,OAAO,CAAA;QAChB,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAA;QAC7B,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACpB,MAAM,OAAO,GAAG,QAAQ,KAAK,6BAA6B,CAAA;YAC1D,MAAM,IAAI,GAAG,8CAA8C,CAAA;YAC3D,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YACrB,MAAM,OAAO,GAAG,QAAQ,KAAK,4BAA4B,CAAA;YACzD,MAAM,IAAI,GAAG,8CAA8C,CAAA;YAC3D,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3C,MAAM,OAAO,GAAG,QAAQ,KAAK,2BAA2B,CAAA;YACxD,MAAM,IAAI,GAAG,oIAAoI,CAAA;YACjJ,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACxB,MAAM,OAAO,GAAG,QAAQ,KAAK,qCAAqC,CAAA;YAClE,MAAM,IAAI,GAAG,uEAAuE,CAAA;YACpF,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,YAAY;gBAClB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,MAAM;gBAChB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,IAAI,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;YAC7C,MAAM,OAAO,GAAG,QAAQ,KAAK,sCAAsC,CAAA;YACnE,MAAM,IAAI,GAAG,4CAA4C,CAAA;YACzD,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,MAAM;gBACb,IAAI,EAAE,UAAU;gBAChB,OAAO;gBACP,IAAI;gBACJ,QAAQ,EAAE,OAAO;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;aAClB,CAAC,CAAA;QACJ,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,MAAoB;QAC7B,MAAM,OAAO,GAA6B,EAAE,CAAA;QAC5C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,CAAA;QAC5C,IAAI,CAAC,IAAI,EAAE,CAAC;YACV,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,6EAA6E;QAC7E,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,CAAC;YAC/C,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,IAAI,IAAI,KAAK,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC;gBACxE,MAAM,OAAO,GAAG,QAAQ,IAAI,mDAAmD,CAAA;gBAC/E,MAAM,IAAI,GAAG,0EAA0E,CAAA;gBACvF,OAAO,CAAC,IAAI,CAAC;oBACX,KAAK,EAAE,MAAM;oBACb,IAAI,EAAE,QAAQ;oBACd,OAAO;oBACP,IAAI;oBACJ,QAAQ,EAAE,OAAO;oBACjB,GAAG,EAAE,KAAK,CAAC,GAAG;oBACd,IAAI,EAAE,KAAK,CAAC,IAAI;iBACjB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QACD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,MAAM,CAAC,sBAAsB,EAAE,EAAE,CAAC;YACzD,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,IAAI,IAAI,KAAK,CAAC,GAAG,KAAK,MAAM,CAAC,GAAG,EAAE,CAAC;gBACxE,MAAM,OAAO,GAAG,QAAQ,IAAI,2DAA2D,CAAA;gBACvF,MAAM,IAAI,GAAG,0EAA0E,CAAA;gBACvF,OAAO,CAAC,IAAI,CAAC;oBACX,KAAK,EAAE,MAAM;oBACb,IAAI,EAAE,QAAQ;oBACd,OAAO;oBACP,IAAI;oBACJ,QAAQ,EAAE,OAAO;oBACjB,GAAG,EAAE,KAAK,CAAC,GAAG;oBACd,IAAI,EAAE,KAAK,CAAC,IAAI;oBAChB,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG;iBACzB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;CACF","sourcesContent":["import { DomainEntityKind } from '../../models/kinds.js'\nimport type { DataDomain } from '../DataDomain.js'\nimport type { DomainEntity } from '../DomainEntity.js'\nimport { ReservedKeywords } from './postgresql.js'\nimport type { DomainValidationSchema } from './rules.js'\n\n/**\n * EntityValidation is a class that performs validation on entities in a data domain.\n *\n * @remarks\n * - We do not need to check for parent uniqueness here, because in the graph there can only be one edge\n *   between two nodes. Parent relationships are described by an edge in the graph.\n */\nexport class EntityValidation {\n  constructor(protected domain: DataDomain) {}\n\n  /**\n   * Performs all the validation rules on the entity.\n   * If you are interested in a specific rule, use the specific method.\n   * @param target The target entity to validate. Can be a string with\n   *               the entity key or a DomainEntity object.\n   */\n  validate(target: string | DomainEntity): DomainValidationSchema[] {\n    const results: DomainValidationSchema[] = []\n    let entity: DomainEntity | undefined\n    if (typeof target === 'string') {\n      entity = this.domain.findEntity(target)\n    } else {\n      entity = target\n    }\n    if (!entity) {\n      const message = `The \"${target}\" entity does not exist.`\n      const help = `The entity must be defined in the domain.`\n      results.push({\n        field: '*',\n        rule: 'exists',\n        message,\n        help,\n        key: target as string,\n        kind: DomainEntityKind,\n        severity: 'error',\n      })\n      return results\n    }\n    const primaryKey = this.validatePrimaryKey(entity)\n    results.push(...primaryKey)\n    const minimumProperties = this.minimumRequiredProperties(entity)\n    results.push(...minimumProperties)\n    const name = this.validateName(entity)\n    results.push(...name)\n    const unique = this.uniqueName(entity)\n    results.push(...unique)\n    return results\n  }\n\n  /**\n   * Validates the entity primary key.\n   * @param entity The entity to validate\n   */\n  validatePrimaryKey(entity: DomainEntity): DomainValidationSchema[] {\n    const results: DomainValidationSchema[] = []\n    const primary = entity.primaryKey()\n    if (!primary) {\n      const message = `The \"${entity.info.getLabel()}\" entity has no identifier.`\n      const help = `An entity that can exists by itself must have identifier defined.`\n      results.push({\n        field: 'properties',\n        rule: 'primary_key',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    return results\n  }\n\n  /**\n   * Checks if an entity has properties through its entire inheritance chain.\n   * This includes direct properties and properties inherited from any level of parent entities.\n   * @param entity The entity to check\n   * @returns True if the entity has properties either directly or through inheritance\n   */\n  private hasPropertiesInherited(entity: DomainEntity): boolean {\n    // Check direct properties first\n    if (entity.hasProperties()) {\n      return true\n    }\n\n    // Check all parents recursively\n    for (const parent of entity.listParents()) {\n      if (this.hasPropertiesInherited(parent)) {\n        return true\n      }\n    }\n\n    return false\n  }\n\n  /**\n   * Checks if an entity has associations through its entire inheritance chain.\n   * This includes direct associations and associations inherited from any level of parent entities.\n   * @param entity The entity to check\n   * @returns True if the entity has associations either directly or through inheritance\n   */\n  private hasAssociationsInherited(entity: DomainEntity): boolean {\n    // Check direct associations first\n    if (entity.hasAssociations()) {\n      return true\n    }\n\n    // Check all parents recursively\n    for (const parent of entity.listParents()) {\n      if (this.hasAssociationsInherited(parent)) {\n        return true\n      }\n    }\n\n    return false\n  }\n\n  /**\n   * Checks if the entity has the minimum required properties.\n   * @param entity The entity to validate\n   */\n  minimumRequiredProperties(entity: DomainEntity): DomainValidationSchema[] {\n    const results: DomainValidationSchema[] = []\n\n    // Check if entity has properties or associations through entire inheritance chain\n    const hasProperties = this.hasPropertiesInherited(entity)\n    const hasAssociations = this.hasAssociationsInherited(entity)\n\n    if (!hasProperties && !hasAssociations) {\n      const message = `The \"${entity.info.getLabel()}\" entity has no properties. It will be ignored.`\n      const help = `Entities that have no properties are ignored in the data domain. No schema will be generated for it.`\n      results.push({\n        field: 'properties',\n        rule: 'required',\n        message,\n        help,\n        severity: 'warning',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    return results\n  }\n\n  /**\n   * Validates the entity name.\n   *\n   * @remarks\n   * - An entity must have a name defined.\n   * - The name has to follow the same rules as the names in a PostgreSQL database.\n   *   - Table names must start with a letter (a-z) or underscore (_).\n   *   - Subsequent characters can be letters, digits (0-9), or underscores (_).\n   *   - Names are case-insensitive.\n   *   - The maximum length of a table name is 31 characters\n   *   - Should be snake case (it's a convention, not an error).\n   *   - Should not be a reserved word (for example: \"IN\", \"SELECT\", \"FROM\", etc.).\n   * @param entity The entity to validate\n   */\n  validateName(entity: DomainEntity): DomainValidationSchema[] {\n    const results: DomainValidationSchema[] = []\n    const label = entity.info.getLabel()\n    if (!entity.info.name) {\n      const message = `The \"${label}\" entity has no name.`\n      const help = `An entity must have a name.`\n      results.push({\n        field: 'name',\n        rule: 'required',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n      return results\n    }\n\n    const name = entity.info.name\n    if (name.length < 2) {\n      const message = `The \"${label}\" entity name is too short.`\n      const help = `The name must be at least 2 characters long.`\n      results.push({\n        field: 'name',\n        rule: 'length',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    if (name.length > 31) {\n      const message = `The \"${label}\" entity name is too long.`\n      const help = `The name must be at most 31 characters long.`\n      results.push({\n        field: 'name',\n        rule: 'length',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    if (!/^[a-zA-Z_][a-zA-Z0-9_]*$/.test(name)) {\n      const message = `The \"${label}\" entity name is invalid.`\n      const help = `The name must start with a letter (a-z) or underscore (_). Subsequent characters can be letters, digits (0-9), or underscores (_).`\n      results.push({\n        field: 'name',\n        rule: 'format',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    if (/^[A-Z]/.test(name)) {\n      const message = `The \"${label}\" entity name is not in snake case.`\n      const help = `The name should be in snake case (lowercase letters and underscores).`\n      results.push({\n        field: 'name',\n        rule: 'snake_case',\n        message,\n        help,\n        severity: 'info',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    if (ReservedKeywords.has(name.toUpperCase())) {\n      const message = `The \"${label}\" entity name is a reserved keyword.`\n      const help = `The name should not be a reserved keyword.`\n      results.push({\n        field: 'name',\n        rule: 'reserved',\n        message,\n        help,\n        severity: 'error',\n        key: entity.key,\n        kind: entity.kind,\n      })\n    }\n    return results\n  }\n\n  /**\n   * Checks if the entity name is unique in the data domain.\n   * @param entity The entity to validate\n   */\n  uniqueName(entity: DomainEntity): DomainValidationSchema[] {\n    const results: DomainValidationSchema[] = []\n    const name = entity.info.name?.toLowerCase()\n    if (!name) {\n      return results\n    }\n    // We need to check the unique names in all entities, including foreign ones.\n    for (const other of this.domain.listEntities()) {\n      if (other.info.name?.toLowerCase() === name && other.key !== entity.key) {\n        const message = `The \"${name}\" entity name is already used in the data domain.`\n        const help = `The name must be unique. This includes references to other data domains.`\n        results.push({\n          field: 'name',\n          rule: 'unique',\n          message,\n          help,\n          severity: 'error',\n          key: other.key,\n          kind: other.kind,\n        })\n      }\n    }\n    for (const other of this.domain.listAllForeignEntities()) {\n      if (other.info.name?.toLowerCase() === name && other.key !== entity.key) {\n        const message = `The \"${name}\" entity name is already used in the foreign data domain.`\n        const help = `The name must be unique. This includes references to other data domains.`\n        results.push({\n          field: 'name',\n          rule: 'unique',\n          message,\n          help,\n          severity: 'error',\n          key: other.key,\n          kind: other.kind,\n          parent: other.domain.key,\n        })\n      }\n    }\n    return results\n  }\n}\n"]}

package/build/src/modeling/validation/property_validation.d.ts

@@ -1,6 +1,6 @@
 import type { DataDomain } from '../DataDomain.js';
 import type { DomainProperty } from '../DomainProperty.js';
-import { type DomainValidation } from './rules.js';
+import { type DomainValidationSchema } from './rules.js';
 export declare class PropertyValidation {
     protected domain: DataDomain;
     constructor(domain: DataDomain);
@@ -10,7 +10,7 @@ export declare class PropertyValidation {
      * @param target The target property to validate. Can be a string with
      *               the property key or a DomainProperty object.
      */
-    validate(target: string | DomainProperty): DomainValidation[];
+    validate(target: string | DomainProperty): DomainValidationSchema[];
     /**
      * Validates the property name.
      *
@@ -24,6 +24,6 @@ export declare class PropertyValidation {
      *   - (recommendation) Column names should be in lower case.
      * @param property The property to validate
      */
-    validateName(property: DomainProperty): DomainValidation[];
+    validateName(property: DomainProperty): DomainValidationSchema[];
 }
 //# sourceMappingURL=property_validation.d.ts.map

package/build/src/modeling/validation/property_validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"property_validation.d.ts","sourceRoot":"","sources":["../../../../src/modeling/validation/property_validation.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,EAAE,KAAK,gBAAgB,EAAwB,MAAM,YAAY,CAAA;AAExE,qBAAa,kBAAkB;IACjB,SAAS,CAAC,MAAM,EAAE,UAAU;gBAAlB,MAAM,EAAE,UAAU;IAExC;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,GAAG,gBAAgB,EAAE;IA2B7D;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,QAAQ,EAAE,cAAc,GAAG,gBAAgB,EAAE;CAG3D"}
+{"version":3,"file":"property_validation.d.ts","sourceRoot":"","sources":["../../../../src/modeling/validation/property_validation.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAClD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,EAAE,KAAK,sBAAsB,EAAwB,MAAM,YAAY,CAAA;AAE9E,qBAAa,kBAAkB;IACjB,SAAS,CAAC,MAAM,EAAE,UAAU;gBAAlB,MAAM,EAAE,UAAU;IAExC;;;;;OAKG;IACH,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,cAAc,GAAG,sBAAsB,EAAE;IA2BnE;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,QAAQ,EAAE,cAAc,GAAG,sBAAsB,EAAE;CAGjE"}

package/build/src/modeling/validation/property_validation.js.map

@@ -1 +1 @@
-{"version":3,"file":"property_validation.js","sourceRoot":"","sources":["../../../../src/modeling/validation/property_validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAG1D,OAAO,EAAyB,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAExE,MAAM,OAAO,kBAAkB;IACP;IAAtB,YAAsB,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAE5C;;;;;OAKG;IACH,QAAQ,CAAC,MAA+B;QACtC,MAAM,OAAO,GAAuB,EAAE,CAAA;QACtC,IAAI,QAAoC,CAAA;QACxC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QAC7C,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,MAAM,CAAA;QACnB,CAAC;QACD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,OAAO,GAAG,QAAQ,MAAM,4BAA4B,CAAA;YAC1D,MAAM,IAAI,GAAG,6CAA6C,CAAA;YAC1D,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,GAAG;gBACV,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,GAAG,EAAE,MAAgB;gBACrB,IAAI,EAAE,kBAAkB;gBACxB,QAAQ,EAAE,OAAO;aAClB,CAAC,CAAA;YACF,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;QACxC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAA;QACrB,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,QAAwB;QACnC,OAAO,oBAAoB,CAAC,QAAQ,CAAC,CAAA;IACvC,CAAC;CACF","sourcesContent":["import { DomainPropertyKind } from '../../models/kinds.js'\nimport type { DataDomain } from '../DataDomain.js'\nimport type { DomainProperty } from '../DomainProperty.js'\nimport { type DomainValidation, validatePropertyName } from './rules.js'\n\nexport class PropertyValidation {\n  constructor(protected domain: DataDomain) {}\n\n  /**\n   * Performs all the validation rules on the property.\n   * If you are interested in a specific rule, use the specific method.\n   * @param target The target property to validate. Can be a string with\n   *               the property key or a DomainProperty object.\n   */\n  validate(target: string | DomainProperty): DomainValidation[] {\n    const results: DomainValidation[] = []\n    let property: DomainProperty | undefined\n    if (typeof target === 'string') {\n      property = this.domain.findProperty(target)\n    } else {\n      property = target\n    }\n    if (!property) {\n      const message = `The \"${target}\" property does not exist.`\n      const help = `The property must be defined in the domain.`\n      results.push({\n        field: '*',\n        rule: 'exists',\n        message,\n        help,\n        key: target as string,\n        kind: DomainPropertyKind,\n        severity: 'error',\n      })\n      return results\n    }\n    const name = this.validateName(property)\n    results.push(...name)\n    return results\n  }\n\n  /**\n   * Validates the property name.\n   *\n   * @remarks\n   * - A property must have a name defined.\n   * - The name has to follow the same rules as the names in a PostgreSQL database.\n   *   - Column names can only contain letters (a-z, A-Z), numbers (0-9), and underscores (_).\n   *   - The name must start with a letter (a-z, A-Z) or an underscore (_).\n   *   - PostgreSQL limits column names to a maximum of 59 characters.\n   *   - (our rule) Column names are case insensitive.\n   *   - (recommendation) Column names should be in lower case.\n   * @param property The property to validate\n   */\n  validateName(property: DomainProperty): DomainValidation[] {\n    return validatePropertyName(property)\n  }\n}\n"]}
+{"version":3,"file":"property_validation.js","sourceRoot":"","sources":["../../../../src/modeling/validation/property_validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAG1D,OAAO,EAA+B,oBAAoB,EAAE,MAAM,YAAY,CAAA;AAE9E,MAAM,OAAO,kBAAkB;IACP;IAAtB,YAAsB,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAE5C;;;;;OAKG;IACH,QAAQ,CAAC,MAA+B;QACtC,MAAM,OAAO,GAA6B,EAAE,CAAA;QAC5C,IAAI,QAAoC,CAAA;QACxC,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;YAC/B,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QAC7C,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,MAAM,CAAA;QACnB,CAAC;QACD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,MAAM,OAAO,GAAG,QAAQ,MAAM,4BAA4B,CAAA;YAC1D,MAAM,IAAI,GAAG,6CAA6C,CAAA;YAC1D,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,GAAG;gBACV,IAAI,EAAE,QAAQ;gBACd,OAAO;gBACP,IAAI;gBACJ,GAAG,EAAE,MAAgB;gBACrB,IAAI,EAAE,kBAAkB;gBACxB,QAAQ,EAAE,OAAO;aAClB,CAAC,CAAA;YACF,OAAO,OAAO,CAAA;QAChB,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAA;QACxC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAA;QACrB,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,YAAY,CAAC,QAAwB;QACnC,OAAO,oBAAoB,CAAC,QAAQ,CAAC,CAAA;IACvC,CAAC;CACF","sourcesContent":["import { DomainPropertyKind } from '../../models/kinds.js'\nimport type { DataDomain } from '../DataDomain.js'\nimport type { DomainProperty } from '../DomainProperty.js'\nimport { type DomainValidationSchema, validatePropertyName } from './rules.js'\n\nexport class PropertyValidation {\n  constructor(protected domain: DataDomain) {}\n\n  /**\n   * Performs all the validation rules on the property.\n   * If you are interested in a specific rule, use the specific method.\n   * @param target The target property to validate. Can be a string with\n   *               the property key or a DomainProperty object.\n   */\n  validate(target: string | DomainProperty): DomainValidationSchema[] {\n    const results: DomainValidationSchema[] = []\n    let property: DomainProperty | undefined\n    if (typeof target === 'string') {\n      property = this.domain.findProperty(target)\n    } else {\n      property = target\n    }\n    if (!property) {\n      const message = `The \"${target}\" property does not exist.`\n      const help = `The property must be defined in the domain.`\n      results.push({\n        field: '*',\n        rule: 'exists',\n        message,\n        help,\n        key: target as string,\n        kind: DomainPropertyKind,\n        severity: 'error',\n      })\n      return results\n    }\n    const name = this.validateName(property)\n    results.push(...name)\n    return results\n  }\n\n  /**\n   * Validates the property name.\n   *\n   * @remarks\n   * - A property must have a name defined.\n   * - The name has to follow the same rules as the names in a PostgreSQL database.\n   *   - Column names can only contain letters (a-z, A-Z), numbers (0-9), and underscores (_).\n   *   - The name must start with a letter (a-z, A-Z) or an underscore (_).\n   *   - PostgreSQL limits column names to a maximum of 59 characters.\n   *   - (our rule) Column names are case insensitive.\n   *   - (recommendation) Column names should be in lower case.\n   * @param property The property to validate\n   */\n  validateName(property: DomainProperty): DomainValidationSchema[] {\n    return validatePropertyName(property)\n  }\n}\n"]}

package/build/src/modeling/validation/rules.d.ts

@@ -8,7 +8,7 @@ import type { DomainImpactItem } from '../types.js';
  * - `type` -> unused
  * - `relationship` -> unused
  */
-export interface DomainValidation extends Omit<DomainImpactItem, 'type' | 'impact' | 'relationship' | 'resolution'> {
+export interface DomainValidationSchema extends Omit<DomainImpactItem, 'type' | 'impact' | 'relationship' | 'resolution'> {
     /**
      * The field that did not pass validation.
      */
@@ -50,5 +50,5 @@ export interface DomainValidation extends Omit<DomainImpactItem, 'type' | 'impac
  *
  * @param property The property to validate
  */
-export declare function validatePropertyName(property: DomainProperty | DomainAssociation): DomainValidation[];
+export declare function validatePropertyName(property: DomainProperty | DomainAssociation): DomainValidationSchema[];
 //# sourceMappingURL=rules.d.ts.map

package/build/src/modeling/validation/rules.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rules.d.ts","sourceRoot":"","sources":["../../../../src/modeling/validation/rules.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAInD;;;;;;GAMG;AACH,MAAM,WAAW,gBAAiB,SAAQ,IAAI,CAAC,gBAAgB,EAAE,MAAM,GAAG,QAAQ,GAAG,cAAc,GAAG,YAAY,CAAC;IACjH;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;;;;;OAMG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,cAAc,GAAG,iBAAiB,GAAG,gBAAgB,EAAE,CA4FrG"}
+{"version":3,"file":"rules.d.ts","sourceRoot":"","sources":["../../../../src/modeling/validation/rules.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,sBAAsB,CAAA;AAC1D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAA;AAChE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAInD;;;;;;GAMG;AACH,MAAM,WAAW,sBAAuB,SAAQ,IAAI,CAClD,gBAAgB,EAChB,MAAM,GAAG,QAAQ,GAAG,cAAc,GAAG,YAAY,CAClD;IACC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ;;;;;;OAMG;IACH,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,cAAc,GAAG,iBAAiB,GAAG,sBAAsB,EAAE,CA4F3G"}

package/build/src/modeling/validation/rules.js.map

@@ -1 +1 @@
-{"version":3,"file":"rules.js","sourceRoot":"","sources":["../../../../src/modeling/validation/rules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAKlD,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAsC1D;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,oBAAoB,CAAC,QAA4C;IAC/E,MAAM,OAAO,GAAuB,EAAE,CAAA;IACtC,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAA;IACtC,MAAM,YAAY,GAAG,QAAQ,CAAC,iBAAiB,EAAkB,CAAA;IACjE,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,KAAK,kBAAkB,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAA;IAC9E,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,eAAe,CAAA;QACrD,MAAM,IAAI,GAAG,OAAO,IAAI,oBAAoB,CAAA;QAC5C,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,UAAU;YAChB,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;QACF,OAAO,OAAO,CAAA;IAChB,CAAC;IACD,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAA;IAC/B,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,qBAAqB,CAAA;QAC3D,MAAM,IAAI,GAAG,8CAA8C,CAAA;QAC3D,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,QAAQ;YACd,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QACrB,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,oBAAoB,CAAA;QAC1D,MAAM,IAAI,GAAG,8CAA8C,CAAA;QAC3D,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,QAAQ;YACd,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3C,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,mBAAmB,CAAA;QACzD,MAAM,IAAI,GAAG,oIAAoI,CAAA;QACjJ,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,QAAQ;YACd,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,6BAA6B,CAAA;QACnE,MAAM,IAAI,GAAG,uEAAuE,CAAA;QACpF,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,YAAY;YAClB,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,MAAM;YAChB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;QAC7C,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,8BAA8B,CAAA;QACpE,MAAM,IAAI,GAAG,4CAA4C,CAAA;QACzD,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,UAAU;YAChB,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC","sourcesContent":["import { ReservedKeywords } from './postgresql.js'\nimport type { DomainProperty } from '../DomainProperty.js'\nimport type { DomainAssociation } from '../DomainAssociation.js'\nimport type { DomainImpactItem } from '../types.js'\nimport type { DomainEntity } from '../DomainEntity.js'\nimport { DomainPropertyKind } from '../../models/kinds.js'\n\n/**\n * `DomainImpactItem` mapping:\n * - `impact` -> `message`\n * - `resolution` -> `help`\n * - `type` -> unused\n * - `relationship` -> unused\n */\nexport interface DomainValidation extends Omit<DomainImpactItem, 'type' | 'impact' | 'relationship' | 'resolution'> {\n  /**\n   * The field that did not pass validation.\n   */\n  field: string\n  /**\n   * The name of the rule that was violated.\n   */\n  rule: string\n  /**\n   * Optional help message that can be used to provide\n   * more information about the error.\n   */\n  help?: string\n  /**\n   * Optional URL that can be used to provide more information\n   * about the error.\n   */\n  url?: string\n  /**\n   * The validation error message.\n   * This message should be user-friendly and should not\n   * contain any technical details.\n   * It should be used to display the error to the user.\n   * It should be short and concise.\n   */\n  message: string\n}\n\n/**\n * Validates the property name. This includes associations.\n *\n * @remarks\n * - A property must have a name defined.\n * - The name has to follow the same rules as the names in a PostgreSQL database.\n *   - Column names can only contain letters (a-z, A-Z), numbers (0-9), and underscores (_).\n *   - The name must start with a letter (a-z, A-Z) or an underscore (_).\n *   - PostgreSQL limits column names to a maximum of 59 characters.\n *   - (our rule) Column names are case insensitive.\n *   - (recommendation) Column names should be in lower case.\n *\n * @param property The property to validate\n */\nexport function validatePropertyName(property: DomainProperty | DomainAssociation): DomainValidation[] {\n  const results: DomainValidation[] = []\n  const label = property.info.getLabel()\n  const parentEntity = property.getParentInstance() as DomainEntity\n  const type = property.kind === DomainPropertyKind ? 'property' : 'association'\n  if (!property.info.name) {\n    const message = `The \"${label}\" ${type} has no name.`\n    const help = `The ${type} must have a name.`\n    results.push({\n      field: 'name',\n      rule: 'required',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n    return results\n  }\n  const name = property.info.name\n  if (name.length < 2) {\n    const message = `The \"${label}\" ${type} name is too short.`\n    const help = `The name must be at least 2 characters long.`\n    results.push({\n      field: 'name',\n      rule: 'length',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  if (name.length > 59) {\n    const message = `The \"${label}\" ${type} name is too long.`\n    const help = `The name must be at most 59 characters long.`\n    results.push({\n      field: 'name',\n      rule: 'length',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  if (!/^[a-zA-Z_][a-zA-Z0-9_]*$/.test(name)) {\n    const message = `The \"${label}\" ${type} name is invalid.`\n    const help = `The name must start with a letter (a-z) or underscore (_). Subsequent characters can be letters, digits (0-9), or underscores (_).`\n    results.push({\n      field: 'name',\n      rule: 'format',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  if (/^[A-Z]/.test(name)) {\n    const message = `The \"${label}\" ${type} name is not in snake case.`\n    const help = `The name should be in snake case (lowercase letters and underscores).`\n    results.push({\n      field: 'name',\n      rule: 'snake_case',\n      message,\n      help,\n      severity: 'info',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  if (ReservedKeywords.has(name.toUpperCase())) {\n    const message = `The \"${label}\" ${type} name is a reserved keyword.`\n    const help = `The name should not be a reserved keyword.`\n    results.push({\n      field: 'name',\n      rule: 'reserved',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  return results\n}\n"]}
+{"version":3,"file":"rules.js","sourceRoot":"","sources":["../../../../src/modeling/validation/rules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAKlD,OAAO,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAA;AAyC1D;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,oBAAoB,CAAC,QAA4C;IAC/E,MAAM,OAAO,GAA6B,EAAE,CAAA;IAC5C,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAA;IACtC,MAAM,YAAY,GAAG,QAAQ,CAAC,iBAAiB,EAAkB,CAAA;IACjE,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,KAAK,kBAAkB,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,aAAa,CAAA;IAC9E,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,eAAe,CAAA;QACrD,MAAM,IAAI,GAAG,OAAO,IAAI,oBAAoB,CAAA;QAC5C,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,UAAU;YAChB,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;QACF,OAAO,OAAO,CAAA;IAChB,CAAC;IACD,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAA;IAC/B,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,qBAAqB,CAAA;QAC3D,MAAM,IAAI,GAAG,8CAA8C,CAAA;QAC3D,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,QAAQ;YACd,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,IAAI,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;QACrB,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,oBAAoB,CAAA;QAC1D,MAAM,IAAI,GAAG,8CAA8C,CAAA;QAC3D,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,QAAQ;YACd,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,CAAC,0BAA0B,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QAC3C,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,mBAAmB,CAAA;QACzD,MAAM,IAAI,GAAG,oIAAoI,CAAA;QACjJ,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,QAAQ;YACd,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,6BAA6B,CAAA;QACnE,MAAM,IAAI,GAAG,uEAAuE,CAAA;QACpF,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,YAAY;YAClB,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,MAAM;YAChB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,IAAI,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;QAC7C,MAAM,OAAO,GAAG,QAAQ,KAAK,KAAK,IAAI,8BAA8B,CAAA;QACpE,MAAM,IAAI,GAAG,4CAA4C,CAAA;QACzD,OAAO,CAAC,IAAI,CAAC;YACX,KAAK,EAAE,MAAM;YACb,IAAI,EAAE,UAAU;YAChB,OAAO;YACP,IAAI;YACJ,QAAQ,EAAE,OAAO;YACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;YACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,MAAM,EAAE,YAAY,CAAC,GAAG;SACzB,CAAC,CAAA;IACJ,CAAC;IACD,OAAO,OAAO,CAAA;AAChB,CAAC","sourcesContent":["import { ReservedKeywords } from './postgresql.js'\nimport type { DomainProperty } from '../DomainProperty.js'\nimport type { DomainAssociation } from '../DomainAssociation.js'\nimport type { DomainImpactItem } from '../types.js'\nimport type { DomainEntity } from '../DomainEntity.js'\nimport { DomainPropertyKind } from '../../models/kinds.js'\n\n/**\n * `DomainImpactItem` mapping:\n * - `impact` -> `message`\n * - `resolution` -> `help`\n * - `type` -> unused\n * - `relationship` -> unused\n */\nexport interface DomainValidationSchema extends Omit<\n  DomainImpactItem,\n  'type' | 'impact' | 'relationship' | 'resolution'\n> {\n  /**\n   * The field that did not pass validation.\n   */\n  field: string\n  /**\n   * The name of the rule that was violated.\n   */\n  rule: string\n  /**\n   * Optional help message that can be used to provide\n   * more information about the error.\n   */\n  help?: string\n  /**\n   * Optional URL that can be used to provide more information\n   * about the error.\n   */\n  url?: string\n  /**\n   * The validation error message.\n   * This message should be user-friendly and should not\n   * contain any technical details.\n   * It should be used to display the error to the user.\n   * It should be short and concise.\n   */\n  message: string\n}\n\n/**\n * Validates the property name. This includes associations.\n *\n * @remarks\n * - A property must have a name defined.\n * - The name has to follow the same rules as the names in a PostgreSQL database.\n *   - Column names can only contain letters (a-z, A-Z), numbers (0-9), and underscores (_).\n *   - The name must start with a letter (a-z, A-Z) or an underscore (_).\n *   - PostgreSQL limits column names to a maximum of 59 characters.\n *   - (our rule) Column names are case insensitive.\n *   - (recommendation) Column names should be in lower case.\n *\n * @param property The property to validate\n */\nexport function validatePropertyName(property: DomainProperty | DomainAssociation): DomainValidationSchema[] {\n  const results: DomainValidationSchema[] = []\n  const label = property.info.getLabel()\n  const parentEntity = property.getParentInstance() as DomainEntity\n  const type = property.kind === DomainPropertyKind ? 'property' : 'association'\n  if (!property.info.name) {\n    const message = `The \"${label}\" ${type} has no name.`\n    const help = `The ${type} must have a name.`\n    results.push({\n      field: 'name',\n      rule: 'required',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n    return results\n  }\n  const name = property.info.name\n  if (name.length < 2) {\n    const message = `The \"${label}\" ${type} name is too short.`\n    const help = `The name must be at least 2 characters long.`\n    results.push({\n      field: 'name',\n      rule: 'length',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  if (name.length > 59) {\n    const message = `The \"${label}\" ${type} name is too long.`\n    const help = `The name must be at most 59 characters long.`\n    results.push({\n      field: 'name',\n      rule: 'length',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  if (!/^[a-zA-Z_][a-zA-Z0-9_]*$/.test(name)) {\n    const message = `The \"${label}\" ${type} name is invalid.`\n    const help = `The name must start with a letter (a-z) or underscore (_). Subsequent characters can be letters, digits (0-9), or underscores (_).`\n    results.push({\n      field: 'name',\n      rule: 'format',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  if (/^[A-Z]/.test(name)) {\n    const message = `The \"${label}\" ${type} name is not in snake case.`\n    const help = `The name should be in snake case (lowercase letters and underscores).`\n    results.push({\n      field: 'name',\n      rule: 'snake_case',\n      message,\n      help,\n      severity: 'info',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  if (ReservedKeywords.has(name.toUpperCase())) {\n    const message = `The \"${label}\" ${type} name is a reserved keyword.`\n    const help = `The name should not be a reserved keyword.`\n    results.push({\n      field: 'name',\n      rule: 'reserved',\n      message,\n      help,\n      severity: 'error',\n      key: property.key,\n      kind: property.kind,\n      parent: parentEntity.key,\n    })\n  }\n  return results\n}\n"]}

package/build/src/modeling/validation/semantic_validation.d.ts

@@ -1,5 +1,5 @@
 import type { DataDomain } from '../DataDomain.js';
-import type { DomainValidation } from './rules.js';
+import type { DomainValidationSchema } from './rules.js';
 /**
  * SemanticValidation is a class that performs validation on semantics in a data domain.
  * It checks for required and recommended semantics in entities, properties, and associations.
@@ -11,7 +11,7 @@ export declare class SemanticValidation {
      * Performs all the semantic validation rules on the domain.
      * @returns The list of validation messages.
      */
-    validate(): DomainValidation[];
+    validate(): DomainValidationSchema[];
     /**
      * Validates if there is at least one entity with the User semantic.
      * This is a recommended semantic for authentication purposes.

package/build/src/modeling/validation/semantic_validation.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"semantic_validation.d.ts","sourceRoot":"","sources":["../../../../src/modeling/validation/semantic_validation.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAElD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAElD;;;GAGG;AACH,qBAAa,kBAAkB;IACjB,SAAS,CAAC,MAAM,EAAE,UAAU;gBAAlB,MAAM,EAAE,UAAU;IAExC;;;OAGG;IACH,QAAQ,IAAI,gBAAgB,EAAE;IAsB9B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IA0B1B;;;OAGG;IACH,OAAO,CAAC,0BAA0B;IA4ClC;;;OAGG;IACH,OAAO,CAAC,2BAA2B;IA6BnC;;OAEG;IACH,OAAO,CAAC,kCAAkC;CA0B3C"}
+{"version":3,"file":"semantic_validation.d.ts","sourceRoot":"","sources":["../../../../src/modeling/validation/semantic_validation.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAA;AAElD,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAA;AAExD;;;GAGG;AACH,qBAAa,kBAAkB;IACjB,SAAS,CAAC,MAAM,EAAE,UAAU;gBAAlB,MAAM,EAAE,UAAU;IAExC;;;OAGG;IACH,QAAQ,IAAI,sBAAsB,EAAE;IAsBpC;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IA0B1B;;;OAGG;IACH,OAAO,CAAC,0BAA0B;IA4ClC;;;OAGG;IACH,OAAO,CAAC,2BAA2B;IA6BnC;;OAEG;IACH,OAAO,CAAC,kCAAkC;CA0B3C"}

package/build/src/modeling/validation/semantic_validation.js.map

@@ -1 +1 @@
-{"version":3,"file":"semantic_validation.js","sourceRoot":"","sources":["../../../../src/modeling/validation/semantic_validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAGjF;;;GAGG;AACH,MAAM,OAAO,kBAAkB;IACP;IAAtB,YAAsB,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAE5C;;;OAGG;IACH,QAAQ;QACN,MAAM,OAAO,GAAuB,EAAE,CAAA;QAEtC,iCAAiC;QACjC,MAAM,aAAa,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAA;QAC/C,OAAO,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAA;QAE9B,gCAAgC;QAChC,MAAM,kBAAkB,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAA;QAC5D,OAAO,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,CAAA;QAEnC,kCAAkC;QAClC,MAAM,mBAAmB,GAAG,IAAI,CAAC,2BAA2B,EAAE,CAAA;QAC9D,OAAO,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,CAAA;QAEpC,yCAAyC;QACzC,MAAM,0BAA0B,GAAG,IAAI,CAAC,kCAAkC,EAAE,CAAA;QAC5E,OAAO,CAAC,IAAI,CAAC,GAAG,0BAA0B,CAAC,CAAA;QAE3C,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;OAGG;IACK,kBAAkB;QACxB,MAAM,OAAO,GAAuB,EAAE,CAAA;QACtC,IAAI,aAAa,GAAG,KAAK,CAAA;QAEzB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,CAAC;YAChD,IAAI,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1C,aAAa,GAAG,IAAI,CAAA;gBACpB,MAAK;YACP,CAAC;QACH,CAAC;QAED,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,WAAW;gBAClB,IAAI,EAAE,aAAa;gBACnB,OAAO,EAAE,mDAAmD;gBAC5D,IAAI,EAAE,mGAAmG;gBACzG,QAAQ,EAAE,SAAS;gBACnB,GAAG,EAAE,eAAe;gBACpB,IAAI,EAAE,gBAAgB;aACvB,CAAC,CAAA;QACJ,CAAC;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;OAGG;IACK,0BAA0B;QAChC,MAAM,OAAO,GAAuB,EAAE,CAAA;QAEtC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,CAAC;YAChD,IAAI,mBAAmB,GAAG,KAAK,CAAA;YAC/B,IAAI,mBAAmB,GAAG,KAAK,CAAA;YAE/B,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,cAAc,EAAE,EAAE,CAAC;gBAC/C,IAAI,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE,CAAC;oBACxD,mBAAmB,GAAG,IAAI,CAAA;gBAC5B,CAAC;gBACD,IAAI,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE,CAAC;oBACxD,mBAAmB,GAAG,IAAI,CAAA;gBAC5B,CAAC;YACH,CAAC;YAED,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACzB,OAAO,CAAC,IAAI,CAAC;oBACX,KAAK,EAAE,WAAW;oBAClB,IAAI,EAAE,aAAa;oBACnB,OAAO,EAAE,QAAQ,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,qDAAqD;oBAC5F,IAAI,EAAE,6FAA6F;oBACnG,QAAQ,EAAE,MAAM;oBAChB,GAAG,EAAE,MAAM,CAAC,GAAG;oBACf,IAAI,EAAE,MAAM,CAAC,IAAI;iBAClB,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACzB,OAAO,CAAC,IAAI,CAAC;oBACX,KAAK,EAAE,WAAW;oBAClB,IAAI,EAAE,aAAa;oBACnB,OAAO,EAAE,QAAQ,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,sDAAsD;oBAC7F,IAAI,EAAE,oGAAoG;oBAC1G,QAAQ,EAAE,MAAM;oBAChB,GAAG,EAAE,MAAM,CAAC,GAAG;oBACf,IAAI,EAAE,MAAM,CAAC,IAAI;iBAClB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;OAGG;IACK,2BAA2B;QACjC,MAAM,OAAO,GAAuB,EAAE,CAAA;QAEtC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,CAAC;YAChD,IAAI,aAAa,GAAG,KAAK,CAAA;YAEzB,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,cAAc,EAAE,EAAE,CAAC;gBAC/C,IAAI,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC;oBAC1G,aAAa,GAAG,IAAI,CAAA;oBACpB,MAAK;gBACP,CAAC;YACH,CAAC;YAED,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,OAAO,CAAC,IAAI,CAAC;oBACX,KAAK,EAAE,WAAW;oBAClB,IAAI,EAAE,aAAa;oBACnB,OAAO,EAAE,QAAQ,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,8CAA8C;oBACrF,IAAI,EAAE,gGAAgG;oBACtG,QAAQ,EAAE,MAAM;oBAChB,GAAG,EAAE,MAAM,CAAC,GAAG;oBACf,IAAI,EAAE,MAAM,CAAC,IAAI;iBAClB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;OAEG;IACK,kCAAkC;QACxC,MAAM,OAAO,GAAuB,EAAE,CAAA;QAEtC,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,CAAC;YAChD,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,cAAc,EAAE,EAAE,CAAC;gBAC/C,KAAK,MAAM,eAAe,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;oBACjD,MAAM,kBAAkB,GAAG,aAAa,CAAC,eAAe,CAAC,EAAE,CAAC,CAAA;oBAC5D,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,IAAI,kBAAkB,CAAC,mBAAmB,EAAE,CAAC;wBACrF,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;4BACpE,OAAO,CAAC,IAAI,CAAC;gCACX,KAAK,EAAE,WAAW;gCAClB,IAAI,EAAE,eAAe;gCACrB,OAAO,EAAE,QAAQ,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,uBAAuB,kBAAkB,CAAC,WAAW,qCAAqC,QAAQ,CAAC,IAAI,sBAAsB;gCACtK,IAAI,EAAE,QAAQ,kBAAkB,CAAC,WAAW,4DAA4D,kBAAkB,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;gCAC5J,QAAQ,EAAE,OAAO;gCACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;gCACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;gCACnB,MAAM,EAAE,MAAM,CAAC,GAAG;6BACnB,CAAC,CAAA;wBACJ,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;CACF","sourcesContent":["import { DomainEntityKind } from '../../models/kinds.js'\nimport type { DataDomain } from '../DataDomain.js'\nimport { DataSemantics, isPropertySemantic, SemanticType } from '../Semantics.js'\nimport type { DomainValidation } from './rules.js'\n\n/**\n * SemanticValidation is a class that performs validation on semantics in a data domain.\n * It checks for required and recommended semantics in entities, properties, and associations.\n */\nexport class SemanticValidation {\n  constructor(protected domain: DataDomain) {}\n\n  /**\n   * Performs all the semantic validation rules on the domain.\n   * @returns The list of validation messages.\n   */\n  validate(): DomainValidation[] {\n    const results: DomainValidation[] = []\n\n    // Check for User entity semantic\n    const hasUserEntity = this.validateUserEntity()\n    results.push(...hasUserEntity)\n\n    // Check for timestamp semantics\n    const timestampSemantics = this.validateTimestampSemantics()\n    results.push(...timestampSemantics)\n\n    // Check for soft delete semantics\n    const softDeleteSemantics = this.validateSoftDeleteSemantics()\n    results.push(...softDeleteSemantics)\n\n    // Validate property semantics data types\n    const propertySemanticsDataTypes = this.validatePropertySemanticsDataTypes()\n    results.push(...propertySemanticsDataTypes)\n\n    return results\n  }\n\n  /**\n   * Validates if there is at least one entity with the User semantic.\n   * This is a recommended semantic for authentication purposes.\n   */\n  private validateUserEntity(): DomainValidation[] {\n    const results: DomainValidation[] = []\n    let hasUserEntity = false\n\n    for (const entity of this.domain.listEntities()) {\n      if (entity.hasSemantic(SemanticType.User)) {\n        hasUserEntity = true\n        break\n      }\n    }\n\n    if (!hasUserEntity) {\n      results.push({\n        field: 'semantics',\n        rule: 'recommended',\n        message: 'No entity with User taxonomy found in the domain.',\n        help: 'It is recommended to have at least one entity with the User taxonomy for authentication purposes.',\n        severity: 'warning',\n        key: 'user_semantic',\n        kind: DomainEntityKind,\n      })\n    }\n\n    return results\n  }\n\n  /**\n   * Validates if entities have the recommended timestamp semantics.\n   * This includes CreatedTimestamp and UpdatedTimestamp.\n   */\n  private validateTimestampSemantics(): DomainValidation[] {\n    const results: DomainValidation[] = []\n\n    for (const entity of this.domain.listEntities()) {\n      let hasCreatedTimestamp = false\n      let hasUpdatedTimestamp = false\n\n      for (const property of entity.listProperties()) {\n        if (property.hasSemantic(SemanticType.CreatedTimestamp)) {\n          hasCreatedTimestamp = true\n        }\n        if (property.hasSemantic(SemanticType.UpdatedTimestamp)) {\n          hasUpdatedTimestamp = true\n        }\n      }\n\n      if (!hasCreatedTimestamp) {\n        results.push({\n          field: 'semantics',\n          rule: 'recommended',\n          message: `The \"${entity.info.getLabel()}\" entity does not have a CreatedTimestamp taxonomy.`,\n          help: 'It is recommended to have a CreatedTimestamp property to track when the entity was created.',\n          severity: 'info',\n          key: entity.key,\n          kind: entity.kind,\n        })\n      }\n\n      if (!hasUpdatedTimestamp) {\n        results.push({\n          field: 'semantics',\n          rule: 'recommended',\n          message: `The \"${entity.info.getLabel()}\" entity does not have an UpdatedTimestamp taxonomy.`,\n          help: 'It is recommended to have an UpdatedTimestamp property to track when the entity was last modified.',\n          severity: 'info',\n          key: entity.key,\n          kind: entity.kind,\n        })\n      }\n    }\n\n    return results\n  }\n\n  /**\n   * Validates if entities have the recommended soft delete semantics.\n   * This includes either DeletedTimestamp or DeletedFlag.\n   */\n  private validateSoftDeleteSemantics(): DomainValidation[] {\n    const results: DomainValidation[] = []\n\n    for (const entity of this.domain.listEntities()) {\n      let hasSoftDelete = false\n\n      for (const property of entity.listProperties()) {\n        if (property.hasSemantic(SemanticType.DeletedTimestamp) || property.hasSemantic(SemanticType.DeletedFlag)) {\n          hasSoftDelete = true\n          break\n        }\n      }\n\n      if (!hasSoftDelete) {\n        results.push({\n          field: 'semantics',\n          rule: 'recommended',\n          message: `The \"${entity.info.getLabel()}\" entity does not have soft delete taxonomy.`,\n          help: 'It is recommended to have either a DeletedTimestamp or DeletedFlag property for soft deletion.',\n          severity: 'info',\n          key: entity.key,\n          kind: entity.kind,\n        })\n      }\n    }\n\n    return results\n  }\n\n  /**\n   * Validates if property semantics are applied to properties with compatible data types.\n   */\n  private validatePropertySemanticsDataTypes(): DomainValidation[] {\n    const results: DomainValidation[] = []\n\n    for (const entity of this.domain.listEntities()) {\n      for (const property of entity.listProperties()) {\n        for (const appliedSemantic of property.semantics) {\n          const semanticDefinition = DataSemantics[appliedSemantic.id]\n          if (isPropertySemantic(semanticDefinition) && semanticDefinition.applicableDataTypes) {\n            if (!semanticDefinition.applicableDataTypes.includes(property.type)) {\n              results.push({\n                field: 'semantics',\n                rule: 'type_mismatch',\n                message: `The \"${property.info.getLabel()}\" property has the \"${semanticDefinition.displayName}\" semantic applied, but its type \"${property.type}\" is not compatible.`,\n                help: `The \"${semanticDefinition.displayName}\" semantic can only be applied to properties of type(s): ${semanticDefinition.applicableDataTypes.join(', ')}.`,\n                severity: 'error',\n                key: property.key,\n                kind: property.kind,\n                parent: entity.key,\n              })\n            }\n          }\n        }\n      }\n    }\n    return results\n  }\n}\n"]}
+{"version":3,"file":"semantic_validation.js","sourceRoot":"","sources":["../../../../src/modeling/validation/semantic_validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAExD,OAAO,EAAE,aAAa,EAAE,kBAAkB,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAGjF;;;GAGG;AACH,MAAM,OAAO,kBAAkB;IACP;IAAtB,YAAsB,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAE5C;;;OAGG;IACH,QAAQ;QACN,MAAM,OAAO,GAA6B,EAAE,CAAA;QAE5C,iCAAiC;QACjC,MAAM,aAAa,GAAG,IAAI,CAAC,kBAAkB,EAAE,CAAA;QAC/C,OAAO,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,CAAA;QAE9B,gCAAgC;QAChC,MAAM,kBAAkB,GAAG,IAAI,CAAC,0BAA0B,EAAE,CAAA;QAC5D,OAAO,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,CAAA;QAEnC,kCAAkC;QAClC,MAAM,mBAAmB,GAAG,IAAI,CAAC,2BAA2B,EAAE,CAAA;QAC9D,OAAO,CAAC,IAAI,CAAC,GAAG,mBAAmB,CAAC,CAAA;QAEpC,yCAAyC;QACzC,MAAM,0BAA0B,GAAG,IAAI,CAAC,kCAAkC,EAAE,CAAA;QAC5E,OAAO,CAAC,IAAI,CAAC,GAAG,0BAA0B,CAAC,CAAA;QAE3C,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;OAGG;IACK,kBAAkB;QACxB,MAAM,OAAO,GAA6B,EAAE,CAAA;QAC5C,IAAI,aAAa,GAAG,KAAK,CAAA;QAEzB,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,CAAC;YAChD,IAAI,MAAM,CAAC,WAAW,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC1C,aAAa,GAAG,IAAI,CAAA;gBACpB,MAAK;YACP,CAAC;QACH,CAAC;QAED,IAAI,CAAC,aAAa,EAAE,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC;gBACX,KAAK,EAAE,WAAW;gBAClB,IAAI,EAAE,aAAa;gBACnB,OAAO,EAAE,mDAAmD;gBAC5D,IAAI,EAAE,mGAAmG;gBACzG,QAAQ,EAAE,SAAS;gBACnB,GAAG,EAAE,eAAe;gBACpB,IAAI,EAAE,gBAAgB;aACvB,CAAC,CAAA;QACJ,CAAC;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;OAGG;IACK,0BAA0B;QAChC,MAAM,OAAO,GAA6B,EAAE,CAAA;QAE5C,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,CAAC;YAChD,IAAI,mBAAmB,GAAG,KAAK,CAAA;YAC/B,IAAI,mBAAmB,GAAG,KAAK,CAAA;YAE/B,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,cAAc,EAAE,EAAE,CAAC;gBAC/C,IAAI,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE,CAAC;oBACxD,mBAAmB,GAAG,IAAI,CAAA;gBAC5B,CAAC;gBACD,IAAI,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,gBAAgB,CAAC,EAAE,CAAC;oBACxD,mBAAmB,GAAG,IAAI,CAAA;gBAC5B,CAAC;YACH,CAAC;YAED,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACzB,OAAO,CAAC,IAAI,CAAC;oBACX,KAAK,EAAE,WAAW;oBAClB,IAAI,EAAE,aAAa;oBACnB,OAAO,EAAE,QAAQ,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,qDAAqD;oBAC5F,IAAI,EAAE,6FAA6F;oBACnG,QAAQ,EAAE,MAAM;oBAChB,GAAG,EAAE,MAAM,CAAC,GAAG;oBACf,IAAI,EAAE,MAAM,CAAC,IAAI;iBAClB,CAAC,CAAA;YACJ,CAAC;YAED,IAAI,CAAC,mBAAmB,EAAE,CAAC;gBACzB,OAAO,CAAC,IAAI,CAAC;oBACX,KAAK,EAAE,WAAW;oBAClB,IAAI,EAAE,aAAa;oBACnB,OAAO,EAAE,QAAQ,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,sDAAsD;oBAC7F,IAAI,EAAE,oGAAoG;oBAC1G,QAAQ,EAAE,MAAM;oBAChB,GAAG,EAAE,MAAM,CAAC,GAAG;oBACf,IAAI,EAAE,MAAM,CAAC,IAAI;iBAClB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;OAGG;IACK,2BAA2B;QACjC,MAAM,OAAO,GAA6B,EAAE,CAAA;QAE5C,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,CAAC;YAChD,IAAI,aAAa,GAAG,KAAK,CAAA;YAEzB,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,cAAc,EAAE,EAAE,CAAC;gBAC/C,IAAI,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,gBAAgB,CAAC,IAAI,QAAQ,CAAC,WAAW,CAAC,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC;oBAC1G,aAAa,GAAG,IAAI,CAAA;oBACpB,MAAK;gBACP,CAAC;YACH,CAAC;YAED,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,OAAO,CAAC,IAAI,CAAC;oBACX,KAAK,EAAE,WAAW;oBAClB,IAAI,EAAE,aAAa;oBACnB,OAAO,EAAE,QAAQ,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,8CAA8C;oBACrF,IAAI,EAAE,gGAAgG;oBACtG,QAAQ,EAAE,MAAM;oBAChB,GAAG,EAAE,MAAM,CAAC,GAAG;oBACf,IAAI,EAAE,MAAM,CAAC,IAAI;iBAClB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC;QAED,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;OAEG;IACK,kCAAkC;QACxC,MAAM,OAAO,GAA6B,EAAE,CAAA;QAE5C,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC,YAAY,EAAE,EAAE,CAAC;YAChD,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,cAAc,EAAE,EAAE,CAAC;gBAC/C,KAAK,MAAM,eAAe,IAAI,QAAQ,CAAC,SAAS,EAAE,CAAC;oBACjD,MAAM,kBAAkB,GAAG,aAAa,CAAC,eAAe,CAAC,EAAE,CAAC,CAAA;oBAC5D,IAAI,kBAAkB,CAAC,kBAAkB,CAAC,IAAI,kBAAkB,CAAC,mBAAmB,EAAE,CAAC;wBACrF,IAAI,CAAC,kBAAkB,CAAC,mBAAmB,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;4BACpE,OAAO,CAAC,IAAI,CAAC;gCACX,KAAK,EAAE,WAAW;gCAClB,IAAI,EAAE,eAAe;gCACrB,OAAO,EAAE,QAAQ,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,uBAAuB,kBAAkB,CAAC,WAAW,qCAAqC,QAAQ,CAAC,IAAI,sBAAsB;gCACtK,IAAI,EAAE,QAAQ,kBAAkB,CAAC,WAAW,4DAA4D,kBAAkB,CAAC,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG;gCAC5J,QAAQ,EAAE,OAAO;gCACjB,GAAG,EAAE,QAAQ,CAAC,GAAG;gCACjB,IAAI,EAAE,QAAQ,CAAC,IAAI;gCACnB,MAAM,EAAE,MAAM,CAAC,GAAG;6BACnB,CAAC,CAAA;wBACJ,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,OAAO,CAAA;IAChB,CAAC;CACF","sourcesContent":["import { DomainEntityKind } from '../../models/kinds.js'\nimport type { DataDomain } from '../DataDomain.js'\nimport { DataSemantics, isPropertySemantic, SemanticType } from '../Semantics.js'\nimport type { DomainValidationSchema } from './rules.js'\n\n/**\n * SemanticValidation is a class that performs validation on semantics in a data domain.\n * It checks for required and recommended semantics in entities, properties, and associations.\n */\nexport class SemanticValidation {\n  constructor(protected domain: DataDomain) {}\n\n  /**\n   * Performs all the semantic validation rules on the domain.\n   * @returns The list of validation messages.\n   */\n  validate(): DomainValidationSchema[] {\n    const results: DomainValidationSchema[] = []\n\n    // Check for User entity semantic\n    const hasUserEntity = this.validateUserEntity()\n    results.push(...hasUserEntity)\n\n    // Check for timestamp semantics\n    const timestampSemantics = this.validateTimestampSemantics()\n    results.push(...timestampSemantics)\n\n    // Check for soft delete semantics\n    const softDeleteSemantics = this.validateSoftDeleteSemantics()\n    results.push(...softDeleteSemantics)\n\n    // Validate property semantics data types\n    const propertySemanticsDataTypes = this.validatePropertySemanticsDataTypes()\n    results.push(...propertySemanticsDataTypes)\n\n    return results\n  }\n\n  /**\n   * Validates if there is at least one entity with the User semantic.\n   * This is a recommended semantic for authentication purposes.\n   */\n  private validateUserEntity(): DomainValidationSchema[] {\n    const results: DomainValidationSchema[] = []\n    let hasUserEntity = false\n\n    for (const entity of this.domain.listEntities()) {\n      if (entity.hasSemantic(SemanticType.User)) {\n        hasUserEntity = true\n        break\n      }\n    }\n\n    if (!hasUserEntity) {\n      results.push({\n        field: 'semantics',\n        rule: 'recommended',\n        message: 'No entity with User taxonomy found in the domain.',\n        help: 'It is recommended to have at least one entity with the User taxonomy for authentication purposes.',\n        severity: 'warning',\n        key: 'user_semantic',\n        kind: DomainEntityKind,\n      })\n    }\n\n    return results\n  }\n\n  /**\n   * Validates if entities have the recommended timestamp semantics.\n   * This includes CreatedTimestamp and UpdatedTimestamp.\n   */\n  private validateTimestampSemantics(): DomainValidationSchema[] {\n    const results: DomainValidationSchema[] = []\n\n    for (const entity of this.domain.listEntities()) {\n      let hasCreatedTimestamp = false\n      let hasUpdatedTimestamp = false\n\n      for (const property of entity.listProperties()) {\n        if (property.hasSemantic(SemanticType.CreatedTimestamp)) {\n          hasCreatedTimestamp = true\n        }\n        if (property.hasSemantic(SemanticType.UpdatedTimestamp)) {\n          hasUpdatedTimestamp = true\n        }\n      }\n\n      if (!hasCreatedTimestamp) {\n        results.push({\n          field: 'semantics',\n          rule: 'recommended',\n          message: `The \"${entity.info.getLabel()}\" entity does not have a CreatedTimestamp taxonomy.`,\n          help: 'It is recommended to have a CreatedTimestamp property to track when the entity was created.',\n          severity: 'info',\n          key: entity.key,\n          kind: entity.kind,\n        })\n      }\n\n      if (!hasUpdatedTimestamp) {\n        results.push({\n          field: 'semantics',\n          rule: 'recommended',\n          message: `The \"${entity.info.getLabel()}\" entity does not have an UpdatedTimestamp taxonomy.`,\n          help: 'It is recommended to have an UpdatedTimestamp property to track when the entity was last modified.',\n          severity: 'info',\n          key: entity.key,\n          kind: entity.kind,\n        })\n      }\n    }\n\n    return results\n  }\n\n  /**\n   * Validates if entities have the recommended soft delete semantics.\n   * This includes either DeletedTimestamp or DeletedFlag.\n   */\n  private validateSoftDeleteSemantics(): DomainValidationSchema[] {\n    const results: DomainValidationSchema[] = []\n\n    for (const entity of this.domain.listEntities()) {\n      let hasSoftDelete = false\n\n      for (const property of entity.listProperties()) {\n        if (property.hasSemantic(SemanticType.DeletedTimestamp) || property.hasSemantic(SemanticType.DeletedFlag)) {\n          hasSoftDelete = true\n          break\n        }\n      }\n\n      if (!hasSoftDelete) {\n        results.push({\n          field: 'semantics',\n          rule: 'recommended',\n          message: `The \"${entity.info.getLabel()}\" entity does not have soft delete taxonomy.`,\n          help: 'It is recommended to have either a DeletedTimestamp or DeletedFlag property for soft deletion.',\n          severity: 'info',\n          key: entity.key,\n          kind: entity.kind,\n        })\n      }\n    }\n\n    return results\n  }\n\n  /**\n   * Validates if property semantics are applied to properties with compatible data types.\n   */\n  private validatePropertySemanticsDataTypes(): DomainValidationSchema[] {\n    const results: DomainValidationSchema[] = []\n\n    for (const entity of this.domain.listEntities()) {\n      for (const property of entity.listProperties()) {\n        for (const appliedSemantic of property.semantics) {\n          const semanticDefinition = DataSemantics[appliedSemantic.id]\n          if (isPropertySemantic(semanticDefinition) && semanticDefinition.applicableDataTypes) {\n            if (!semanticDefinition.applicableDataTypes.includes(property.type)) {\n              results.push({\n                field: 'semantics',\n                rule: 'type_mismatch',\n                message: `The \"${property.info.getLabel()}\" property has the \"${semanticDefinition.displayName}\" semantic applied, but its type \"${property.type}\" is not compatible.`,\n                help: `The \"${semanticDefinition.displayName}\" semantic can only be applied to properties of type(s): ${semanticDefinition.applicableDataTypes.join(', ')}.`,\n                severity: 'error',\n                key: property.key,\n                kind: property.kind,\n                parent: entity.key,\n              })\n            }\n          }\n        }\n      }\n    }\n    return results\n  }\n}\n"]}