/** * A map of codes to their descriptions */ export type MessageCodes = { readonly [code: string]: string; }; export declare const WARNING_CODES: { readonly NAMING: "A naming convention has been violated"; readonly DEPRECATED: "A deprecated feature is used"; readonly UNUSED: "A type is declared but not used"; readonly MIRRORED_RELATIONS: "Two relations are the exact mirror of each other. A \"inverseOf\" on one of them might be missing."; readonly DEPRECATED_REFERENCE: "@reference is used without keyField"; readonly BOOLEAN_AGGREGATION: "A @collect field that aggregates booleans in a possibly unintended way"; readonly UNSUPPORTED_PARENT_FIELD: "A @parent field that is currently not usable"; readonly INEFFECTIVE_FLEX_SEARCH: "@flexSearch or @flexSearchFulltext is specified but does not have an effect"; readonly INEFFECTIVE_INCLUDE_IN_SEARCH: "@flexSearch(includeInSearch: true) is specified but does not have an effect"; readonly NO_ROLES: "@roles is specified but no roles are allowed, so access is denied for everyone"; readonly EMPTY_NAME: "The empty string is used as a name"; readonly REDUNDANT_FIELD: "A field declaration that is not needed"; }; export type WarningCode = keyof typeof WARNING_CODES; export declare const INFO_CODES: { readonly NO_TYPE_CHECKS: "@defaultValue currently does not have type checks for the value"; }; export type InfoCode = keyof typeof INFO_CODES; export declare const COMPATIBILITY_ISSUE_CODES: { readonly CALC_MUTATIONS: "Missing @calcMutations operators"; readonly COLLECT: "Missing, superfluous or diverging @collect"; readonly DEFAULT_VALUE: "Missing, superfluous or diverging @defaultValue"; readonly MISSING_ENUM_VALUE: "An enum declaration is missing a value"; readonly FIELD_TYPE: "A field has the wrong type"; readonly KEY_FIELD: "Missing or superfluous @key"; readonly REFERENCE: "Missing, superfluous or diverging @reference"; readonly RELATION: "Missing, superfluous or diverging @relation"; readonly ROOT_FIELD: "Missing or superfluous @root"; readonly PARENT_FIELD: "Missing or superfluous @parent"; readonly BUSINESS_OBJECT: "Missing or superfluous @businessObject"; readonly TYPE_KIND: "A type declaration is of the wrong kind (e.g. root entity, value object or enum)"; readonly TTL: "Missing or superfluous time-to-live configuration"; readonly FLEX_SEARCH: "Missing, superfluous or diverging flexSearch configuration on a type or field"; readonly FLEX_SEARCH_ORDER: "Missing, superfluous or diverging flexSearchOrder configuration"; readonly FLEX_SEARCH_SEARCH: "Missing includeInSearch in @flexSearch or @flexSearchFullText"; readonly INDICES: "Missing indices"; }; export type CompatibilityIssueCode = keyof typeof COMPATIBILITY_ISSUE_CODES; export type MessageCode = WarningCode | InfoCode | CompatibilityIssueCode;