feat!: add options as parameter to constraints (#1667)

.eslintrc

@@ -6,7 +6,8 @@
     "security",
     "github",
     "jest",
-    "prettier"
+    "prettier",
+    "unused-imports"
   ],
   "extends": [
     "eslint:recommended",
@@ -55,7 +56,7 @@
     "no-empty-character-class": 2,
     "no-self-compare": 2,
     "valid-typeof": 2,
-    "no-unused-vars": 0,
+    "unused-imports/no-unused-imports": 2,
     "handle-callback-err": 2,
     "no-shadow-restricted-names": 2,
     "no-new-require": 2,
@@ -138,7 +139,6 @@
     "prefer-const": 2,
     "prefer-spread": 2,
     "prefer-template": 2,
-    "@typescript-eslint/no-unused-vars": 2,
     "prettier/prettier": 2,
     "sonarjs/no-identical-functions": "off",
     "sonarjs/prefer-single-boolean-return": "off",

docs/migrations/version-2-to-3.md

@@ -282,3 +282,13 @@ Is not affected by this change.
 ### C++
 
 Is not affected by this change.
+
+### Options in constraints
+
+As part of https://github.com/asyncapi/modelina/issues/1475 we had the need to access options in the constraint logic, therefore all constraints now have direct access to the provided options.
+
+To make it easier we now expose types for each of the constraints in each language to make it easier to re-use in TS integrations. They can be accessed as following:
+
+```ts
+import { <language>ConstantConstraint, <language>EnumKeyConstraint, <language>EnumValueConstraint, <language>ModelNameConstraint, <language>PropertyKeyConstraint } from @asyncapi/modelina
+```

examples/overwrite-default-constraint/__snapshots__/index.spec.ts.snap

@@ -3,16 +3,16 @@
 exports[`Should be able to render models with custom constrain logic and should log expected output to console 1`] = `
 Array [
   "class MyOwnCustomModelName {
-  private _email?: string;
+  private _MyCustomPropertyKey?: string;
 
   constructor(input: {
-    email?: string,
+    MyCustomPropertyKey?: string,
   }) {
-    this._email = input.email;
+    this._MyCustomPropertyKey = input.MyCustomPropertyKey;
   }
 
-  get email(): string | undefined { return this._email; }
-  set email(email: string | undefined) { this._email = email; }
+  get MyCustomPropertyKey(): string | undefined { return this._MyCustomPropertyKey; }
+  set MyCustomPropertyKey(MyCustomPropertyKey: string | undefined) { this._MyCustomPropertyKey = MyCustomPropertyKey; }
 }",
 ]
 `;

examples/overwrite-default-constraint/index.ts

@@ -1,10 +1,27 @@
 import { TypeScriptGenerator } from '../../src';
-import { pascalCase } from 'change-case';
 
 const generator = new TypeScriptGenerator({
   constraints: {
-    modelName: ({ modelName }) => {
+    modelName: ({ modelName, options }) => {
       return 'MyOwnCustomModelName';
+    },
+    constant: ({ constrainedMetaModel, options }) => {
+      return 'MyCustomConst';
+    },
+    enumKey: ({ constrainedEnumModel, enumKey, enumModel, options }) => {
+      return 'MyCustomKey';
+    },
+    enumValue: ({ constrainedEnumModel, enumValue, enumModel, options }) => {
+      return 'MyCustomValue';
+    },
+    propertyKey: ({
+      constrainedObjectModel,
+      constrainedObjectPropertyModel,
+      objectModel,
+      objectPropertyModel,
+      options
+    }) => {
+      return 'MyCustomPropertyKey';
     }
   }
 });

package.json

@@ -37,8 +37,8 @@
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^9.0.9",
     "@apidevtools/swagger-parser": "^10.0.3",
-    "@smoya/multi-parser": "^4.0.0",
     "@asyncapi/parser": "3.0.0-next-major-spec.8",
+    "@smoya/multi-parser": "^4.0.0",
     "@swc/core": "^1.3.5",
     "@swc/jest": "^0.2.23",
     "@types/node": "^20.3.3",
@@ -62,6 +62,7 @@
     "eslint-plugin-prettier": "^5.0.1",
     "eslint-plugin-security": "^1.7.1",
     "eslint-plugin-sonarjs": "^0.19.0",
+    "eslint-plugin-unused-imports": "^3.0.0",
     "jest": "^27.2.5",
     "markdown-toc": "^1.2.0",
     "ts-jest": "^27.0.5",

src/generators/cplusplus/CplusplusGenerator.ts

@@ -20,8 +20,13 @@ import { EnumRenderer } from './renderers/EnumRenderer';
 import { isReservedCplusplusKeyword } from './Constants';
 import { Logger } from '../..';
 import {
+  ConstantConstraint,
   constrainMetaModel,
-  Constraints
+  Constraints,
+  EnumKeyConstraint,
+  EnumValueConstraint,
+  ModelNameConstraint,
+  PropertyKeyConstraint
 } from '../../helpers/ConstrainHelpers';
 import {
   CplusplusDefaultConstraints,
@@ -33,9 +38,18 @@ import { CplusplusDependencyManager } from './CplusplusDependencyManager';
 export interface CplusplusOptions
   extends CommonGeneratorOptions<CplusplusPreset> {
   typeMapping: TypeMapping<CplusplusOptions, CplusplusDependencyManager>;
-  constraints: Constraints;
+  constraints: Constraints<CplusplusOptions>;
   namespace: string;
 }
+export type CplusplusConstantConstraint = ConstantConstraint<CplusplusOptions>;
+export type CplusplusEnumKeyConstraint = EnumKeyConstraint<CplusplusOptions>;
+export type CplusplusEnumValueConstraint =
+  EnumValueConstraint<CplusplusOptions>;
+export type CplusplusModelNameConstraint =
+  ModelNameConstraint<CplusplusOptions>;
+export type CplusplusPropertyKeyConstraint =
+  PropertyKeyConstraint<CplusplusOptions>;
+
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface CplusplusRenderCompleteModelOptions {}
 export class CplusplusGenerator extends AbstractGenerator<

src/generators/cplusplus/constrainer/ConstantConstrainer.ts

@@ -1,6 +1,7 @@
 import { ConstantConstraint } from '../../../helpers';
+import { CplusplusOptions } from '../CplusplusGenerator';
 
-export function defaultConstantConstraints(): ConstantConstraint {
+export function defaultConstantConstraints(): ConstantConstraint<CplusplusOptions> {
   return () => {
     return undefined;
   };

src/generators/cplusplus/constrainer/EnumConstrainer.ts

@@ -6,12 +6,12 @@ import {
   NO_EMPTY_VALUE,
   NO_RESERVED_KEYWORDS
 } from '../../../helpers/Constraints';
-import {
-  FormatHelpers,
-  EnumKeyConstraint,
-  EnumValueConstraint
-} from '../../../helpers';
+import { FormatHelpers } from '../../../helpers';
 import { isReservedCplusplusKeyword } from '../Constants';
+import {
+  CplusplusEnumKeyConstraint,
+  CplusplusEnumValueConstraint
+} from '../CplusplusGenerator';
 
 export type ModelEnumKeyConstraints = {
   NO_SPECIAL_CHAR: (value: string) => string;
@@ -50,7 +50,7 @@ export const DefaultEnumKeyConstraints: ModelEnumKeyConstraints = {
  */
 export function defaultEnumKeyConstraints(
   customConstraints?: Partial<ModelEnumKeyConstraints>
-): EnumKeyConstraint {
+): CplusplusEnumKeyConstraint {
   const constraints = { ...DefaultEnumKeyConstraints, ...customConstraints };
 
   return ({ enumKey, enumModel, constrainedEnumModel }) => {
@@ -76,7 +76,7 @@ export function defaultEnumKeyConstraints(
 /**
  * Convert the enum value to a value that is compatible with Cplusplus
  */
-export function defaultEnumValueConstraints(): EnumValueConstraint {
+export function defaultEnumValueConstraints(): CplusplusEnumValueConstraint {
   return ({ enumValue }) => {
     let constrainedEnumValue;
     switch (typeof enumValue) {

src/generators/cplusplus/constrainer/ModelNameConstrainer.ts

@@ -3,8 +3,9 @@ import {
   NO_EMPTY_VALUE,
   NO_RESERVED_KEYWORDS
 } from '../../../helpers/Constraints';
-import { FormatHelpers, ModelNameConstraint } from '../../../helpers';
+import { FormatHelpers } from '../../../helpers';
 import { isReservedCplusplusKeyword } from '../Constants';
+import { CplusplusModelNameConstraint } from '../CplusplusGenerator';
 
 export type ModelNameConstraints = {
   NO_SPECIAL_CHAR: (value: string) => string;
@@ -36,7 +37,7 @@ export const DefaultModelNameConstraints: ModelNameConstraints = {
  */
 export function defaultModelNameConstraints(
   customConstraints?: Partial<ModelNameConstraints>
-): ModelNameConstraint {
+): CplusplusModelNameConstraint {
   const constraints = { ...DefaultModelNameConstraints, ...customConstraints };
 
   return ({ modelName }) => {

src/generators/cplusplus/constrainer/PropertyKeyConstrainer.ts

@@ -4,8 +4,9 @@ import {
   NO_DUPLICATE_PROPERTIES,
   NO_EMPTY_VALUE
 } from '../../../helpers/Constraints';
-import { FormatHelpers, PropertyKeyConstraint } from '../../../helpers';
+import { FormatHelpers } from '../../../helpers';
 import { isReservedCplusplusKeyword } from '../Constants';
+import { CplusplusPropertyKeyConstraint } from '../CplusplusGenerator';
 
 export type PropertyKeyConstraintOptions = {
   NO_SPECIAL_CHAR: (value: string) => string;
@@ -46,7 +47,7 @@ export const DefaultPropertyKeyConstraints: PropertyKeyConstraintOptions = {
  */
 export function defaultPropertyKeyConstraints(
   customConstraints?: Partial<PropertyKeyConstraintOptions>
-): PropertyKeyConstraint {
+): CplusplusPropertyKeyConstraint {
   const constraints = {
     ...DefaultPropertyKeyConstraints,
     ...customConstraints

src/generators/csharp/CSharpConstrainer.ts

@@ -1,4 +1,3 @@
-import { Constraints } from '../../helpers';
 import {
   ConstrainedEnumValueModel,
   ConstrainedObjectPropertyModel
@@ -113,7 +112,7 @@ export const CSharpDefaultTypeMapping: CSharpTypeMapping = {
   }
 };
 
-export const CSharpDefaultConstraints: Constraints = {
+export const CSharpDefaultConstraints = {
   enumKey: defaultEnumKeyConstraints(),
   enumValue: defaultEnumValueConstraints(),
   modelName: defaultModelNameConstraints(),

src/generators/csharp/CSharpGenerator.ts

@@ -19,7 +19,12 @@ import {
   Constraints,
   constrainMetaModel,
   split,
-  SplitOptions
+  SplitOptions,
+  ConstantConstraint,
+  EnumKeyConstraint,
+  EnumValueConstraint,
+  ModelNameConstraint,
+  PropertyKeyConstraint
 } from '../../helpers';
 import { CSharpPreset, CSHARP_DEFAULT_PRESET } from './CSharpPreset';
 import { EnumRenderer } from './renderers/EnumRenderer';
@@ -37,11 +42,16 @@ import { CSharpDependencyManager } from './CSharpDependencyManager';
 export interface CSharpOptions extends CommonGeneratorOptions<CSharpPreset> {
   collectionType: 'List' | 'Array';
   typeMapping: TypeMapping<CSharpOptions, CSharpDependencyManager>;
-  constraints: Constraints;
+  constraints: Constraints<CSharpOptions>;
   autoImplementedProperties: boolean;
   modelType: 'class' | 'record';
   handleNullable: boolean;
 }
+export type CSharpConstantConstraint = ConstantConstraint<CSharpOptions>;
+export type CSharpEnumKeyConstraint = EnumKeyConstraint<CSharpOptions>;
+export type CSharpEnumValueConstraint = EnumValueConstraint<CSharpOptions>;
+export type CSharpModelNameConstraint = ModelNameConstraint<CSharpOptions>;
+export type CSharpPropertyKeyConstraint = PropertyKeyConstraint<CSharpOptions>;
 export type CSharpTypeMapping = TypeMapping<
   CSharpOptions,
   CSharpDependencyManager

src/generators/csharp/constrainer/ConstantConstrainer.ts

@@ -1,6 +1,6 @@
-import { ConstantConstraint } from '../../../helpers';
+import { CSharpConstantConstraint } from '../CSharpGenerator';
 
-export function defaultConstantConstraints(): ConstantConstraint {
+export function defaultConstantConstraints(): CSharpConstantConstraint {
   return () => {
     return undefined;
   };

src/generators/csharp/constrainer/EnumConstrainer.ts

@@ -5,12 +5,12 @@ import {
   NO_EMPTY_VALUE,
   NO_RESERVED_KEYWORDS
 } from '../../../helpers/Constraints';
-import {
-  EnumKeyConstraint,
-  EnumValueConstraint,
-  FormatHelpers
-} from '../../../helpers';
+import { FormatHelpers } from '../../../helpers';
 import { isReservedCSharpKeyword } from '../Constants';
+import {
+  CSharpEnumKeyConstraint,
+  CSharpEnumValueConstraint
+} from '../CSharpGenerator';
 
 export type ModelEnumKeyConstraints = {
   NO_SPECIAL_CHAR: (value: string) => string;
@@ -49,7 +49,7 @@ export const DefaultEnumKeyConstraints: ModelEnumKeyConstraints = {
 
 export function defaultEnumKeyConstraints(
   customConstraints?: Partial<ModelEnumKeyConstraints>
-): EnumKeyConstraint {
+): CSharpEnumKeyConstraint {
   const constraints = { ...DefaultEnumKeyConstraints, ...customConstraints };
 
   return ({ enumKey, enumModel, constrainedEnumModel }) => {
@@ -72,7 +72,7 @@ export function defaultEnumKeyConstraints(
   };
 }
 
-export function defaultEnumValueConstraints(): EnumValueConstraint {
+export function defaultEnumValueConstraints(): CSharpEnumValueConstraint {
   return ({ enumValue }) => {
     let normalizedEnumValue;
     switch (typeof enumValue) {

src/generators/csharp/constrainer/ModelNameConstrainer.ts

@@ -4,8 +4,9 @@ import {
   NO_EMPTY_VALUE,
   NO_RESERVED_KEYWORDS
 } from '../../../helpers/Constraints';
-import { FormatHelpers, ModelNameConstraint } from '../../../helpers';
+import { FormatHelpers } from '../../../helpers';
 import { isReservedCSharpKeyword } from '../Constants';
+import { CSharpModelNameConstraint } from '../CSharpGenerator';
 
 export type ModelNameConstraints = {
   NO_SPECIAL_CHAR: (value: string) => string;
@@ -35,7 +36,7 @@ export const DefaultModelNameConstraints: ModelNameConstraints = {
 };
 export function defaultModelNameConstraints(
   customConstraints?: Partial<ModelNameConstraints>
-): ModelNameConstraint {
+): CSharpModelNameConstraint {
   const constraints = { ...DefaultModelNameConstraints, ...customConstraints };
 
   return ({ modelName }) => {

src/generators/csharp/constrainer/PropertyKeyConstrainer.ts

@@ -5,8 +5,9 @@ import {
   NO_EMPTY_VALUE,
   NO_RESERVED_KEYWORDS
 } from '../../../helpers/Constraints';
-import { FormatHelpers, PropertyKeyConstraint } from '../../../helpers';
+import { FormatHelpers } from '../../../helpers';
 import { isReservedCSharpKeyword } from '../Constants';
+import { CSharpPropertyKeyConstraint } from '../CSharpGenerator';
 
 export type PropertyKeyConstraintOptions = {
   NO_SPECIAL_CHAR: (value: string) => string;
@@ -51,7 +52,7 @@ export const DefaultPropertyKeyConstraints: PropertyKeyConstraintOptions = {
 
 export function defaultPropertyKeyConstraints(
   customConstraints?: Partial<PropertyKeyConstraintOptions>
-): PropertyKeyConstraint {
+): CSharpPropertyKeyConstraint {
   const constraints = {
     ...DefaultPropertyKeyConstraints,
     ...customConstraints

src/generators/dart/DartConstrainer.ts

@@ -1,4 +1,3 @@
-import { Constraints } from '../../helpers';
 import {
   defaultEnumKeyConstraints,
   defaultEnumValueConstraints
@@ -71,7 +70,7 @@ export const DartDefaultTypeMapping: DartTypeMapping = {
   }
 };
 
-export const DartDefaultConstraints: Constraints = {
+export const DartDefaultConstraints = {
   enumKey: defaultEnumKeyConstraints(),
   enumValue: defaultEnumValueConstraints(),
   modelName: defaultModelNameConstraints(),