@api-client/core 0.15.0 → 0.16.0

package/build/src/modeling/definitions/URL.d.ts

@@ -0,0 +1,68 @@
+import type { AppliedDataSemantic } from '../Semantics.js';
+import { SemanticType } from '../Semantics.js';
+/**
+ * Configuration options for the URL semantic.
+ * Controls validation, allowed protocols, and formatting.
+ */
+export interface URLConfig {
+    /**
+     * List of allowed protocols (e.g., ['http', 'https']).
+     */
+    allowedProtocols?: string[];
+    /**
+     * Whether to require HTTPS protocol (default: false).
+     */
+    requireHttps?: boolean;
+    /**
+     * Whether to allow query parameters in the URL.
+     */
+    allowQueryParams?: boolean;
+    /**
+     * Whether to allow URL fragments (e.g., #section).
+     */
+    allowFragments?: boolean;
+    /**
+     * Whether to allow internationalized domain names.
+     */
+    allowInternational?: boolean;
+    /**
+     * Whether to allow IP addresses as hostnames.
+     */
+    allowIP?: boolean;
+    /**
+     * Whether to allow port numbers in the URL.
+     */
+    allowPort?: boolean;
+    /**
+     * Whether to allow authentication info (user:pass@host).
+     */
+    allowAuthentication?: boolean;
+    /**
+     * Custom metadata for the URL field.
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * Index signature to allow additional properties.
+     */
+    [key: string]: unknown;
+}
+/**
+ * Type-safe configuration for URL semantic.
+ */
+export interface AppliedURLSemantic extends AppliedDataSemantic {
+    id: SemanticType.URL;
+    config?: URLConfig;
+}
+/**
+ * Type guard to check if a semantic is a URL semantic.
+ */
+export declare const isURLSemantic: (semantic: AppliedDataSemantic) => semantic is AppliedURLSemantic;
+/**
+ * Helper function to create a URL semantic with configuration.
+ */
+export declare const createURLSemantic: (config?: URLConfig) => AppliedURLSemantic;
+/**
+ * Default configuration for URL semantic.
+ */
+export declare const DEFAULT_URL_CONFIG: URLConfig;
+//# sourceMappingURL=URL.d.ts.map

package/build/src/modeling/definitions/URL.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"URL.d.ts","sourceRoot":"","sources":["../../../../src/modeling/definitions/URL.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAE9C;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAA;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;IAC5B;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAA;IAC7B;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAClC;;OAEG;IACH,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D,EAAE,EAAE,YAAY,CAAC,GAAG,CAAA;IACpB,MAAM,CAAC,EAAE,SAAS,CAAA;CACnB;AAED;;GAEG;AACH,eAAO,MAAM,aAAa,GAAI,UAAU,mBAAmB,KAAG,QAAQ,IAAI,kBAEzE,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,iBAAiB,GAAI,SAAQ,SAAc,KAAG,kBAa1D,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,SAShC,CAAA"}

package/build/src/modeling/definitions/URL.js

@@ -0,0 +1,37 @@
+import { SemanticType } from '../Semantics.js';
+/**
+ * Type guard to check if a semantic is a URL semantic.
+ */
+export const isURLSemantic = (semantic) => {
+    return semantic.id === SemanticType.URL;
+};
+/**
+ * Helper function to create a URL semantic with configuration.
+ */
+export const createURLSemantic = (config = {}) => {
+    const mergedConfig = {
+        ...DEFAULT_URL_CONFIG,
+        ...config,
+    };
+    if (config.metadata) {
+        mergedConfig.metadata = { ...config.metadata };
+    }
+    return {
+        id: SemanticType.URL,
+        config: mergedConfig,
+    };
+};
+/**
+ * Default configuration for URL semantic.
+ */
+export const DEFAULT_URL_CONFIG = {
+    allowedProtocols: ['http', 'https'],
+    requireHttps: false,
+    allowQueryParams: true,
+    allowFragments: true,
+    allowInternational: true,
+    allowIP: true,
+    allowPort: true,
+    allowAuthentication: false,
+};
+//# sourceMappingURL=URL.js.map

package/build/src/modeling/definitions/URL.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"URL.js","sourceRoot":"","sources":["../../../../src/modeling/definitions/URL.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAyD9C;;GAEG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,QAA6B,EAAkC,EAAE;IAC7F,OAAO,QAAQ,CAAC,EAAE,KAAK,YAAY,CAAC,GAAG,CAAA;AACzC,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAAC,SAAoB,EAAE,EAAsB,EAAE;IAC9E,MAAM,YAAY,GAAG;QACnB,GAAG,kBAAkB;QACrB,GAAG,MAAM;KACV,CAAA;IACD,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACpB,YAAY,CAAC,QAAQ,GAAG,EAAE,GAAG,MAAM,CAAC,QAAQ,EAAE,CAAA;IAChD,CAAC;IAED,OAAO;QACL,EAAE,EAAE,YAAY,CAAC,GAAG;QACpB,MAAM,EAAE,YAAY;KACrB,CAAA;AACH,CAAC,CAAA;AAED;;GAEG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAc;IAC3C,gBAAgB,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC;IACnC,YAAY,EAAE,KAAK;IACnB,gBAAgB,EAAE,IAAI;IACtB,cAAc,EAAE,IAAI;IACpB,kBAAkB,EAAE,IAAI;IACxB,OAAO,EAAE,IAAI;IACb,SAAS,EAAE,IAAI;IACf,mBAAmB,EAAE,KAAK;CAC3B,CAAA","sourcesContent":["import type { AppliedDataSemantic } from '../Semantics.js'\nimport { SemanticType } from '../Semantics.js'\n\n/**\n * Configuration options for the URL semantic.\n * Controls validation, allowed protocols, and formatting.\n */\nexport interface URLConfig {\n  /**\n   * List of allowed protocols (e.g., ['http', 'https']).\n   */\n  allowedProtocols?: string[]\n  /**\n   * Whether to require HTTPS protocol (default: false).\n   */\n  requireHttps?: boolean\n  /**\n   * Whether to allow query parameters in the URL.\n   */\n  allowQueryParams?: boolean\n  /**\n   * Whether to allow URL fragments (e.g., #section).\n   */\n  allowFragments?: boolean\n  /**\n   * Whether to allow internationalized domain names.\n   */\n  allowInternational?: boolean\n  /**\n   * Whether to allow IP addresses as hostnames.\n   */\n  allowIP?: boolean\n  /**\n   * Whether to allow port numbers in the URL.\n   */\n  allowPort?: boolean\n  /**\n   * Whether to allow authentication info (user:pass@host).\n   */\n  allowAuthentication?: boolean\n  /**\n   * Custom metadata for the URL field.\n   */\n  metadata?: Record<string, unknown>\n  /**\n   * Index signature to allow additional properties.\n   */\n  [key: string]: unknown\n}\n\n/**\n * Type-safe configuration for URL semantic.\n */\nexport interface AppliedURLSemantic extends AppliedDataSemantic {\n  id: SemanticType.URL\n  config?: URLConfig\n}\n\n/**\n * Type guard to check if a semantic is a URL semantic.\n */\nexport const isURLSemantic = (semantic: AppliedDataSemantic): semantic is AppliedURLSemantic => {\n  return semantic.id === SemanticType.URL\n}\n\n/**\n * Helper function to create a URL semantic with configuration.\n */\nexport const createURLSemantic = (config: URLConfig = {}): AppliedURLSemantic => {\n  const mergedConfig = {\n    ...DEFAULT_URL_CONFIG,\n    ...config,\n  }\n  if (config.metadata) {\n    mergedConfig.metadata = { ...config.metadata }\n  }\n\n  return {\n    id: SemanticType.URL,\n    config: mergedConfig,\n  }\n}\n\n/**\n * Default configuration for URL semantic.\n */\nexport const DEFAULT_URL_CONFIG: URLConfig = {\n  allowedProtocols: ['http', 'https'],\n  requireHttps: false,\n  allowQueryParams: true,\n  allowFragments: true,\n  allowInternational: true,\n  allowIP: true,\n  allowPort: true,\n  allowAuthentication: false,\n}\n"]}

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

@@ -27,5 +27,9 @@ export declare class SemanticValidation {
      * This includes either DeletedTimestamp or DeletedFlag.
      */
     private validateSoftDeleteSemantics;
+    /**
+     * Validates if property semantics are applied to properties with compatible data types.
+     */
+    private validatePropertySemanticsDataTypes;
 }
 //# sourceMappingURL=semantic_validation.d.ts.map

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;IAkB9B;;;OAGG;IACH,OAAO,CAAC,kBAAkB;IA0B1B;;;OAGG;IACH,OAAO,CAAC,0BAA0B;IA4ClC;;;OAGG;IACH,OAAO,CAAC,2BAA2B;CA4BpC"}
+{"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"}

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

@@ -1,5 +1,5 @@
 import { DomainEntityKind } from '../../models/kinds.js';
-import { SemanticType } from '../Semantics.js';
+import { DataSemantics, isPropertySemantic, 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.
@@ -24,6 +24,9 @@ export class SemanticValidation {
         // Check for soft delete semantics
         const softDeleteSemantics = this.validateSoftDeleteSemantics();
         results.push(...softDeleteSemantics);
+        // Validate property semantics data types
+        const propertySemanticsDataTypes = this.validatePropertySemanticsDataTypes();
+        results.push(...propertySemanticsDataTypes);
         return results;
     }
     /**
@@ -122,5 +125,33 @@ export class SemanticValidation {
         }
         return results;
     }
+    /**
+     * Validates if property semantics are applied to properties with compatible data types.
+     */
+    validatePropertySemanticsDataTypes() {
+        const results = [];
+        for (const entity of this.domain.listEntities()) {
+            for (const property of entity.listProperties()) {
+                for (const appliedSemantic of property.semantics) {
+                    const semanticDefinition = DataSemantics[appliedSemantic.id];
+                    if (isPropertySemantic(semanticDefinition) && semanticDefinition.applicableDataTypes) {
+                        if (!semanticDefinition.applicableDataTypes.includes(property.type)) {
+                            results.push({
+                                field: 'semantics',
+                                rule: 'type_mismatch',
+                                message: `The "${property.info.getLabel()}" property has the "${semanticDefinition.displayName}" semantic applied, but its type "${property.type}" is not compatible.`,
+                                help: `The "${semanticDefinition.displayName}" semantic can only be applied to properties of type(s): ${semanticDefinition.applicableDataTypes.join(', ')}.`,
+                                severity: 'error',
+                                key: property.key,
+                                kind: property.kind,
+                                parent: entity.key,
+                            });
+                        }
+                    }
+                }
+            }
+        }
+        return results;
+    }
 }
 //# sourceMappingURL=semantic_validation.js.map

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