@api-client/core 0.12.1 → 0.12.3

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

@@ -0,0 +1,241 @@
+import { DomainEntityKind } from '../../models/kinds.js';
+import { ReservedKeywords } from './postgresql.js';
+/**
+ * EntityValidation is a class that performs validation on entities in a data domain.
+ *
+ * @remarks
+ * - We do not need to check for parent uniqueness here, because in the graph there can only be one edge
+ *   between two nodes. Parent relationships are described by an edge in the graph.
+ */
+export class EntityValidation {
+    domain;
+    constructor(domain) {
+        this.domain = domain;
+    }
+    /**
+     * Performs all the validation rules on the entity.
+     * If you are interested in a specific rule, use the specific method.
+     * @param target The target entity to validate. Can be a string with the entity key or a DomainEntity object.
+     */
+    validate(target) {
+        const results = [];
+        let entity;
+        if (typeof target === 'string') {
+            entity = this.domain.findEntity(target);
+        }
+        else {
+            entity = target;
+        }
+        if (!entity) {
+            const message = `The "${target}" entity does not exist.`;
+            const help = `The entity must be defined in the domain.`;
+            results.push({
+                field: '*',
+                rule: 'exists',
+                message,
+                help,
+                key: target,
+                kind: DomainEntityKind,
+                severity: 'error',
+            });
+            return results;
+        }
+        const primary = this.validatePrimaryKey(entity);
+        results.push(...primary);
+        const minimum = this.minimumRequiredProperties(entity);
+        results.push(...minimum);
+        const name = this.validateName(entity);
+        results.push(...name);
+        const uniqueName = this.uniqueName(entity);
+        results.push(...uniqueName);
+        return results;
+    }
+    /**
+     * Validates the entity against the primary key validation rules.
+     * @param entity The entity to validate
+     * @returns The list of validation messages.
+     */
+    validatePrimaryKey(entity) {
+        const results = [];
+        const primary = entity.primaryKey();
+        if (!primary) {
+            const message = `The "${entity.info.getLabel()}" entity has no identifier.`;
+            const help = `An entity that can exists by itself must have identifier defined.`;
+            results.push({
+                field: 'properties',
+                rule: 'primary_key',
+                message,
+                help,
+                severity: 'error',
+                key: entity.key,
+                kind: entity.kind,
+            });
+        }
+        return results;
+    }
+    /**
+     * Checks if the entity has the minimum required properties.
+     * @param entity The entity to validate
+     */
+    minimumRequiredProperties(entity) {
+        const results = [];
+        if (!entity.hasProperties() && !entity.hasAssociations()) {
+            const message = `The "${entity.info.getLabel()}" entity has no properties. It will be ignored.`;
+            const help = `Entities that have no properties are ignored in the data domain. No schema will be generated for it.`;
+            results.push({
+                field: 'properties',
+                rule: 'required',
+                message,
+                help,
+                severity: 'warning',
+                key: entity.key,
+                kind: entity.kind,
+            });
+        }
+        return results;
+    }
+    /**
+     * Validates the entity name.
+     *
+     * @remarks
+     * - An entity must have a name defined.
+     * - The name has to follow the same rules as the names in a PostgreSQL database.
+     *   - Table names must start with a letter (a-z) or underscore (_).
+     *   - Subsequent characters can be letters, digits (0-9), or underscores (_).
+     *   - Names are case-insensitive.
+     *   - The maximum length of a table name is 31 characters
+     *   - Should be snake case (it's a convention, not an error).
+     *   - Should not be a reserved word (for example: "IN", "SELECT", "FROM", etc.).
+     * @param entity The entity to validate
+     */
+    validateName(entity) {
+        const results = [];
+        const label = entity.info.getLabel();
+        if (!entity.info.name) {
+            const message = `The "${label}" entity has no name.`;
+            const help = `An entity must have a name.`;
+            results.push({
+                field: 'name',
+                rule: 'required',
+                message,
+                help,
+                severity: 'error',
+                key: entity.key,
+                kind: entity.kind,
+            });
+            return results;
+        }
+        const name = entity.info.name;
+        if (name.length < 2) {
+            const message = `The "${label}" entity name is too short.`;
+            const help = `The name must be at least 2 characters long.`;
+            results.push({
+                field: 'name',
+                rule: 'length',
+                message,
+                help,
+                severity: 'error',
+                key: entity.key,
+                kind: entity.kind,
+            });
+        }
+        if (name.length > 31) {
+            const message = `The "${label}" entity name is too long.`;
+            const help = `The name must be at most 31 characters long.`;
+            results.push({
+                field: 'name',
+                rule: 'length',
+                message,
+                help,
+                severity: 'error',
+                key: entity.key,
+                kind: entity.kind,
+            });
+        }
+        if (!/^[a-zA-Z_][a-zA-Z0-9_]*$/.test(name)) {
+            const message = `The "${label}" entity name is invalid.`;
+            const help = `The name must start with a letter (a-z) or underscore (_). Subsequent characters can be letters, digits (0-9), or underscores (_).`;
+            results.push({
+                field: 'name',
+                rule: 'format',
+                message,
+                help,
+                severity: 'error',
+                key: entity.key,
+                kind: entity.kind,
+            });
+        }
+        if (/^[A-Z]/.test(name)) {
+            const message = `The "${label}" entity name is not in snake case.`;
+            const help = `The name should be in snake case (lowercase letters and underscores).`;
+            results.push({
+                field: 'name',
+                rule: 'snake_case',
+                message,
+                help,
+                severity: 'info',
+                key: entity.key,
+                kind: entity.kind,
+            });
+        }
+        if (ReservedKeywords.has(name.toUpperCase())) {
+            const message = `The "${label}" entity name is a reserved keyword.`;
+            const help = `The name should not be a reserved keyword.`;
+            results.push({
+                field: 'name',
+                rule: 'reserved',
+                message,
+                help,
+                severity: 'error',
+                key: entity.key,
+                kind: entity.kind,
+            });
+        }
+        return results;
+    }
+    /**
+     * Checks if the entity name is unique in the data domain.
+     * @param entity The entity to validate
+     */
+    uniqueName(entity) {
+        const results = [];
+        const name = entity.info.name?.toLowerCase();
+        if (!name) {
+            return results;
+        }
+        // We need to check the unique names in all entities, including foreign ones.
+        for (const other of this.domain.listEntities()) {
+            if (other.info.name?.toLowerCase() === name && other.key !== entity.key) {
+                const message = `The "${name}" entity name is already used in the data domain.`;
+                const help = `The name must be unique. This includes references to other data domains.`;
+                results.push({
+                    field: 'name',
+                    rule: 'unique',
+                    message,
+                    help,
+                    severity: 'error',
+                    key: other.key,
+                    kind: other.kind,
+                });
+            }
+        }
+        for (const other of this.domain.listForeignEntities()) {
+            if (other.info.name?.toLowerCase() === name && other.key !== entity.key) {
+                const message = `The "${name}" entity name is already used in the foreign data domain.`;
+                const help = `The name must be unique. This includes references to other data domains.`;
+                results.push({
+                    field: 'name',
+                    rule: 'unique',
+                    message,
+                    help,
+                    severity: 'error',
+                    key: other.key,
+                    kind: other.kind,
+                    parent: other.domain.key,
+                });
+            }
+        }
+        return results;
+    }
+}
+//# sourceMappingURL=entity_validation.js.map

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

@@ -0,0 +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;;;;OAIG;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,OAAO,GAAG,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAA;QAC/C,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;QACxB,MAAM,OAAO,GAAG,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,CAAA;QACtD,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAA;QACxB,MAAM,IAAI,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QACtC,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC,CAAA;QACrB,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAA;QAC1C,OAAO,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,CAAA;QAC3B,OAAO,OAAO,CAAA;IAChB,CAAC;IAED;;;;OAIG;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;;;OAGG;IACH,yBAAyB,CAAC,MAAoB;QAC5C,MAAM,OAAO,GAAuB,EAAE,CAAA;QACtC,IAAI,CAAC,MAAM,CAAC,aAAa,EAAE,IAAI,CAAC,MAAM,CAAC,eAAe,EAAE,EAAE,CAAC;YACzD,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,mBAAmB,EAAE,EAAE,CAAC;YACtD,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 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 primary = this.validatePrimaryKey(entity)\n    results.push(...primary)\n    const minimum = this.minimumRequiredProperties(entity)\n    results.push(...minimum)\n    const name = this.validateName(entity)\n    results.push(...name)\n    const uniqueName = this.uniqueName(entity)\n    results.push(...uniqueName)\n    return results\n  }\n\n  /**\n   * Validates the entity against the primary key validation rules.\n   * @param entity The entity to validate\n   * @returns The list of validation messages.\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 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    if (!entity.hasProperties() && !entity.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.listForeignEntities()) {\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/postgresql.d.ts

@@ -0,0 +1,2 @@
+export declare const ReservedKeywords: Set<string>;
+//# sourceMappingURL=postgresql.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"postgresql.d.ts","sourceRoot":"","sources":["../../../../src/modeling/validation/postgresql.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB,aAwD3B,CAAA"}

package/build/src/modeling/validation/postgresql.js

@@ -0,0 +1,58 @@
+export const ReservedKeywords = new Set([
+    'IN',
+    'EXISTS',
+    'SELECT',
+    'FROM',
+    'WHERE',
+    'AND',
+    'OR',
+    'NOT',
+    'NULL',
+    'TRUE',
+    'FALSE',
+    'BETWEEN',
+    'LIKE',
+    'INTO',
+    'JOIN',
+    'INNER JOIN',
+    'LEFT JOIN',
+    'RIGHT JOIN',
+    'FULL JOIN',
+    'CROSS JOIN',
+    'UNION',
+    'INTERSECT',
+    'EXCEPT',
+    'ORDER BY',
+    'GROUP BY',
+    'HAVING',
+    'DISTINCT',
+    'LIMIT',
+    'OFFSET',
+    'INSERT',
+    'UPDATE',
+    'DELETE',
+    'CREATE',
+    'ALTER',
+    'DROP',
+    'TRUNCATE',
+    'RENAME',
+    'GRANT',
+    'REVOKE',
+    'COMMIT',
+    'ROLLBACK',
+    'SAVEPOINT',
+    'TRANSACTION',
+    'BEGIN',
+    'END',
+    'CASE',
+    'WHEN',
+    'THEN',
+    'ELSE',
+    'END CASE',
+    'EXCEPTION',
+    'RAISE',
+    'RETURN',
+    'FUNCTION',
+    'PROCEDURE',
+]);
+//# sourceMappingURL=postgresql.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"postgresql.js","sourceRoot":"","sources":["../../../../src/modeling/validation/postgresql.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAC;IACtC,IAAI;IACJ,QAAQ;IACR,QAAQ;IACR,MAAM;IACN,OAAO;IACP,KAAK;IACL,IAAI;IACJ,KAAK;IACL,MAAM;IACN,MAAM;IACN,OAAO;IACP,SAAS;IACT,MAAM;IACN,MAAM;IACN,MAAM;IACN,YAAY;IACZ,WAAW;IACX,YAAY;IACZ,WAAW;IACX,YAAY;IACZ,OAAO;IACP,WAAW;IACX,QAAQ;IACR,UAAU;IACV,UAAU;IACV,QAAQ;IACR,UAAU;IACV,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,OAAO;IACP,MAAM;IACN,UAAU;IACV,QAAQ;IACR,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,UAAU;IACV,WAAW;IACX,aAAa;IACb,OAAO;IACP,KAAK;IACL,MAAM;IACN,MAAM;IACN,MAAM;IACN,MAAM;IACN,UAAU;IACV,WAAW;IACX,OAAO;IACP,QAAQ;IACR,UAAU;IACV,WAAW;CACZ,CAAC,CAAA","sourcesContent":["export const ReservedKeywords = new Set([\n  'IN',\n  'EXISTS',\n  'SELECT',\n  'FROM',\n  'WHERE',\n  'AND',\n  'OR',\n  'NOT',\n  'NULL',\n  'TRUE',\n  'FALSE',\n  'BETWEEN',\n  'LIKE',\n  'INTO',\n  'JOIN',\n  'INNER JOIN',\n  'LEFT JOIN',\n  'RIGHT JOIN',\n  'FULL JOIN',\n  'CROSS JOIN',\n  'UNION',\n  'INTERSECT',\n  'EXCEPT',\n  'ORDER BY',\n  'GROUP BY',\n  'HAVING',\n  'DISTINCT',\n  'LIMIT',\n  'OFFSET',\n  'INSERT',\n  'UPDATE',\n  'DELETE',\n  'CREATE',\n  'ALTER',\n  'DROP',\n  'TRUNCATE',\n  'RENAME',\n  'GRANT',\n  'REVOKE',\n  'COMMIT',\n  'ROLLBACK',\n  'SAVEPOINT',\n  'TRANSACTION',\n  'BEGIN',\n  'END',\n  'CASE',\n  'WHEN',\n  'THEN',\n  'ELSE',\n  'END CASE',\n  'EXCEPTION',\n  'RAISE',\n  'RETURN',\n  'FUNCTION',\n  'PROCEDURE',\n])\n"]}

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

@@ -0,0 +1,29 @@
+import type { DataDomain } from '../DataDomain.js';
+import type { DomainProperty } from '../DomainProperty.js';
+import { type DomainValidation } from './rules.js';
+export declare class PropertyValidation {
+    protected domain: DataDomain;
+    constructor(domain: DataDomain);
+    /**
+     * Performs all the validation rules on the property.
+     * If you are interested in a specific rule, use the specific method.
+     * @param target The target property to validate. Can be a string with
+     *               the property key or a DomainProperty object.
+     */
+    validate(target: string | DomainProperty): DomainValidation[];
+    /**
+     * Validates the property name.
+     *
+     * @remarks
+     * - A property must have a name defined.
+     * - The name has to follow the same rules as the names in a PostgreSQL database.
+     *   - Column names can only contain letters (a-z, A-Z), numbers (0-9), and underscores (_).
+     *   - The name must start with a letter (a-z, A-Z) or an underscore (_).
+     *   - PostgreSQL limits column names to a maximum of 59 characters.
+     *   - (our rule) Column names are case insensitive.
+     *   - (recommendation) Column names should be in lower case.
+     * @param property The property to validate
+     */
+    validateName(property: DomainProperty): DomainValidation[];
+}
+//# sourceMappingURL=property_validation.d.ts.map

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

@@ -0,0 +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"}

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

@@ -0,0 +1,58 @@
+import { DomainPropertyKind } from '../../models/kinds.js';
+import { validatePropertyName } from './rules.js';
+export class PropertyValidation {
+    domain;
+    constructor(domain) {
+        this.domain = domain;
+    }
+    /**
+     * Performs all the validation rules on the property.
+     * If you are interested in a specific rule, use the specific method.
+     * @param target The target property to validate. Can be a string with
+     *               the property key or a DomainProperty object.
+     */
+    validate(target) {
+        const results = [];
+        let property;
+        if (typeof target === 'string') {
+            property = this.domain.findProperty(target);
+        }
+        else {
+            property = target;
+        }
+        if (!property) {
+            const message = `The "${target}" property does not exist.`;
+            const help = `The property must be defined in the domain.`;
+            results.push({
+                field: '*',
+                rule: 'exists',
+                message,
+                help,
+                key: target,
+                kind: DomainPropertyKind,
+                severity: 'error',
+            });
+            return results;
+        }
+        const name = this.validateName(property);
+        results.push(...name);
+        return results;
+    }
+    /**
+     * Validates the property name.
+     *
+     * @remarks
+     * - A property must have a name defined.
+     * - The name has to follow the same rules as the names in a PostgreSQL database.
+     *   - Column names can only contain letters (a-z, A-Z), numbers (0-9), and underscores (_).
+     *   - The name must start with a letter (a-z, A-Z) or an underscore (_).
+     *   - PostgreSQL limits column names to a maximum of 59 characters.
+     *   - (our rule) Column names are case insensitive.
+     *   - (recommendation) Column names should be in lower case.
+     * @param property The property to validate
+     */
+    validateName(property) {
+        return validatePropertyName(property);
+    }
+}
+//# sourceMappingURL=property_validation.js.map

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

@@ -0,0 +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"]}

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

@@ -0,0 +1,55 @@
+import type { DomainProperty } from '../DomainProperty.js';
+import type { DomainAssociation } from '../DomainAssociation.js';
+import type { DomainImpactItem } from '../DomainImpactAnalysis.js';
+/**
+ * `DomainImpactItem` mapping:
+ * - `impact` -> `message`
+ * - `resolution` -> `help`
+ * - `type` -> unused
+ * - `blocking` -> unused (deprecated)
+ * - `relationship` -> unused
+ */
+export interface DomainValidation extends Omit<DomainImpactItem, 'type' | 'impact' | 'blocking' | 'relationship' | 'resolution'> {
+    /**
+     * The field that did not pass validation.
+     */
+    field: string;
+    /**
+     * The name of the rule that was violated.
+     */
+    rule: string;
+    /**
+     * Optional help message that can be used to provide
+     * more information about the error.
+     */
+    help?: string;
+    /**
+     * Optional URL that can be used to provide more information
+     * about the error.
+     */
+    url?: string;
+    /**
+     * The validation error message.
+     * This message should be user-friendly and should not
+     * contain any technical details.
+     * It should be used to display the error to the user.
+     * It should be short and concise.
+     */
+    message: string;
+}
+/**
+ * Validates the property name. This includes associations.
+ *
+ * @remarks
+ * - A property must have a name defined.
+ * - The name has to follow the same rules as the names in a PostgreSQL database.
+ *   - Column names can only contain letters (a-z, A-Z), numbers (0-9), and underscores (_).
+ *   - The name must start with a letter (a-z, A-Z) or an underscore (_).
+ *   - PostgreSQL limits column names to a maximum of 59 characters.
+ *   - (our rule) Column names are case insensitive.
+ *   - (recommendation) Column names should be in lower case.
+ *
+ * @param property The property to validate
+ */
+export declare function validatePropertyName(property: DomainProperty | DomainAssociation): DomainValidation[];
+//# sourceMappingURL=rules.d.ts.map

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

@@ -0,0 +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,4BAA4B,CAAA;AAIlE;;;;;;;GAOG;AACH,MAAM,WAAW,gBACf,SAAQ,IAAI,CAAC,gBAAgB,EAAE,MAAM,GAAG,QAAQ,GAAG,UAAU,GAAG,cAAc,GAAG,YAAY,CAAC;IAC9F;;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"}

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

@@ -0,0 +1,110 @@
+import { ReservedKeywords } from './postgresql.js';
+import { DomainPropertyKind } from '../../models/kinds.js';
+/**
+ * Validates the property name. This includes associations.
+ *
+ * @remarks
+ * - A property must have a name defined.
+ * - The name has to follow the same rules as the names in a PostgreSQL database.
+ *   - Column names can only contain letters (a-z, A-Z), numbers (0-9), and underscores (_).
+ *   - The name must start with a letter (a-z, A-Z) or an underscore (_).
+ *   - PostgreSQL limits column names to a maximum of 59 characters.
+ *   - (our rule) Column names are case insensitive.
+ *   - (recommendation) Column names should be in lower case.
+ *
+ * @param property The property to validate
+ */
+export function validatePropertyName(property) {
+    const results = [];
+    const label = property.info.getLabel();
+    const parentEntity = property.getParentInstance();
+    const type = property.kind === DomainPropertyKind ? 'property' : 'association';
+    if (!property.info.name) {
+        const message = `The "${label}" ${type} has no name.`;
+        const help = `The ${type} must have a name.`;
+        results.push({
+            field: 'name',
+            rule: 'required',
+            message,
+            help,
+            severity: 'error',
+            key: property.key,
+            kind: property.kind,
+            parent: parentEntity.key,
+        });
+        return results;
+    }
+    const name = property.info.name;
+    if (name.length < 2) {
+        const message = `The "${label}" ${type} name is too short.`;
+        const help = `The name must be at least 2 characters long.`;
+        results.push({
+            field: 'name',
+            rule: 'length',
+            message,
+            help,
+            severity: 'error',
+            key: property.key,
+            kind: property.kind,
+            parent: parentEntity.key,
+        });
+    }
+    if (name.length > 59) {
+        const message = `The "${label}" ${type} name is too long.`;
+        const help = `The name must be at most 59 characters long.`;
+        results.push({
+            field: 'name',
+            rule: 'length',
+            message,
+            help,
+            severity: 'error',
+            key: property.key,
+            kind: property.kind,
+            parent: parentEntity.key,
+        });
+    }
+    if (!/^[a-zA-Z_][a-zA-Z0-9_]*$/.test(name)) {
+        const message = `The "${label}" ${type} name is invalid.`;
+        const help = `The name must start with a letter (a-z) or underscore (_). Subsequent characters can be letters, digits (0-9), or underscores (_).`;
+        results.push({
+            field: 'name',
+            rule: 'format',
+            message,
+            help,
+            severity: 'error',
+            key: property.key,
+            kind: property.kind,
+            parent: parentEntity.key,
+        });
+    }
+    if (/^[A-Z]/.test(name)) {
+        const message = `The "${label}" ${type} name is not in snake case.`;
+        const help = `The name should be in snake case (lowercase letters and underscores).`;
+        results.push({
+            field: 'name',
+            rule: 'snake_case',
+            message,
+            help,
+            severity: 'info',
+            key: property.key,
+            kind: property.kind,
+            parent: parentEntity.key,
+        });
+    }
+    if (ReservedKeywords.has(name.toUpperCase())) {
+        const message = `The "${label}" ${type} name is a reserved keyword.`;
+        const help = `The name should not be a reserved keyword.`;
+        results.push({
+            field: 'name',
+            rule: 'reserved',
+            message,
+            help,
+            severity: 'error',
+            key: property.key,
+            kind: property.kind,
+            parent: parentEntity.key,
+        });
+    }
+    return results;
+}
+//# sourceMappingURL=rules.js.map

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

@@ -0,0 +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;AAwC1D;;;;;;;;;;;;;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 '../DomainImpactAnalysis.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 * - `blocking` -> unused (deprecated)\n * - `relationship` -> unused\n */\nexport interface DomainValidation\n  extends Omit<DomainImpactItem, 'type' | 'impact' | 'blocking' | '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"]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-client/core",
   "description": "The API Client's core client library. Works in NodeJS and in a ES enabled browser.",
-  "version": "0.12.1",
+  "version": "0.12.3",
   "license": "Apache-2.0",
   "exports": {
     "./browser.js": {