@api-client/core 0.14.9 → 0.15.0

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

@@ -0,0 +1,126 @@
+import { DomainEntityKind } from '../../models/kinds.js';
+import { SemanticType } from '../Semantics.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.
+ */
+export class SemanticValidation {
+    domain;
+    constructor(domain) {
+        this.domain = domain;
+    }
+    /**
+     * Performs all the semantic validation rules on the domain.
+     * @returns The list of validation messages.
+     */
+    validate() {
+        const results = [];
+        // Check for User entity semantic
+        const hasUserEntity = this.validateUserEntity();
+        results.push(...hasUserEntity);
+        // Check for timestamp semantics
+        const timestampSemantics = this.validateTimestampSemantics();
+        results.push(...timestampSemantics);
+        // Check for soft delete semantics
+        const softDeleteSemantics = this.validateSoftDeleteSemantics();
+        results.push(...softDeleteSemantics);
+        return results;
+    }
+    /**
+     * Validates if there is at least one entity with the User semantic.
+     * This is a recommended semantic for authentication purposes.
+     */
+    validateUserEntity() {
+        const results = [];
+        let hasUserEntity = false;
+        for (const entity of this.domain.listEntities()) {
+            if (entity.hasSemantic(SemanticType.User)) {
+                hasUserEntity = true;
+                break;
+            }
+        }
+        if (!hasUserEntity) {
+            results.push({
+                field: 'semantics',
+                rule: 'recommended',
+                message: 'No entity with User taxonomy found in the domain.',
+                help: 'It is recommended to have at least one entity with the User taxonomy for authentication purposes.',
+                severity: 'warning',
+                key: 'user_semantic',
+                kind: DomainEntityKind,
+            });
+        }
+        return results;
+    }
+    /**
+     * Validates if entities have the recommended timestamp semantics.
+     * This includes CreatedTimestamp and UpdatedTimestamp.
+     */
+    validateTimestampSemantics() {
+        const results = [];
+        for (const entity of this.domain.listEntities()) {
+            let hasCreatedTimestamp = false;
+            let hasUpdatedTimestamp = false;
+            for (const property of entity.listProperties()) {
+                if (property.hasSemantic(SemanticType.CreatedTimestamp)) {
+                    hasCreatedTimestamp = true;
+                }
+                if (property.hasSemantic(SemanticType.UpdatedTimestamp)) {
+                    hasUpdatedTimestamp = true;
+                }
+            }
+            if (!hasCreatedTimestamp) {
+                results.push({
+                    field: 'semantics',
+                    rule: 'recommended',
+                    message: `The "${entity.info.getLabel()}" entity does not have a CreatedTimestamp taxonomy.`,
+                    help: 'It is recommended to have a CreatedTimestamp property to track when the entity was created.',
+                    severity: 'info',
+                    key: entity.key,
+                    kind: entity.kind,
+                });
+            }
+            if (!hasUpdatedTimestamp) {
+                results.push({
+                    field: 'semantics',
+                    rule: 'recommended',
+                    message: `The "${entity.info.getLabel()}" entity does not have an UpdatedTimestamp taxonomy.`,
+                    help: 'It is recommended to have an UpdatedTimestamp property to track when the entity was last modified.',
+                    severity: 'info',
+                    key: entity.key,
+                    kind: entity.kind,
+                });
+            }
+        }
+        return results;
+    }
+    /**
+     * Validates if entities have the recommended soft delete semantics.
+     * This includes either DeletedTimestamp or DeletedFlag.
+     */
+    validateSoftDeleteSemantics() {
+        const results = [];
+        for (const entity of this.domain.listEntities()) {
+            let hasSoftDelete = false;
+            for (const property of entity.listProperties()) {
+                if (property.hasSemantic(SemanticType.DeletedTimestamp) || property.hasSemantic(SemanticType.DeletedFlag)) {
+                    hasSoftDelete = true;
+                    break;
+                }
+            }
+            if (!hasSoftDelete) {
+                results.push({
+                    field: 'semantics',
+                    rule: 'recommended',
+                    message: `The "${entity.info.getLabel()}" entity does not have soft delete taxonomy.`,
+                    help: 'It is recommended to have either a DeletedTimestamp or DeletedFlag property for soft deletion.',
+                    severity: 'info',
+                    key: entity.key,
+                    kind: entity.kind,
+                });
+            }
+        }
+        return results;
+    }
+}
+//# sourceMappingURL=semantic_validation.js.map

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

@@ -0,0 +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,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAG9C;;;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,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;CACF","sourcesContent":["import { DomainEntityKind } from '../../models/kinds.js'\nimport type { DataDomain } from '../DataDomain.js'\nimport { 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    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"]}