Introduced lifecycle hooks

Signed-off-by: Jean-Baptiste Bianchi <jb.bianchi@neuroglia.io>

Author: JBBianchi

src/lib/builder.ts

@@ -15,11 +15,35 @@
  *
  */
 
+/**
+ * Represents the options passed to the `build()` method
+ */
+export type BuildOptions = {
+  /**
+   * Default true
+   */
+  validate?: boolean;
+  /**
+   * Default true
+   */
+  normalize?: boolean;
+};
+
+/**
+ * The type of the underlying function called on `build()` for objects
+ */
+export type BuildingFunction<T> = (model: Partial<T>, options: BuildOptions) => T;
+
+/**
+ * The type of the underlying function called on `build()` for arrays
+ */
+export type ArrayBuildingFunction<T> = (model: Array<T>, options: BuildOptions) => Array<T>;
+
 /**
  * Represents a fluent builder proxy for an object
  */
 export type Builder<T> = {
-  build: (validate?: boolean) => T;
+  build: (option?: BuildOptions) => T;
 } & {
   [K in keyof T]-?: (arg: T[K]) => Builder<T>;
 };
@@ -29,15 +53,23 @@ export type Builder<T> = {
  */
 export type ArrayBuilder<T> = {
   push: (item: T) => ArrayBuilder<T>;
-  build: (validate?: boolean) => Array<T>;
+  build: (option?: BuildOptions) => Array<T>;
 };
 
 /**
  * The default function used to build an object, basically just return the provided object
  * @param model The object to "build"
+ * @param options The build options
  * @returns
  */
-function defaultBuildingFn<T>(model: Partial<T>): T {
+function defaultBuildingFn<T>(model: Partial<T>, options: BuildOptions): T {
+  // prevents @typescript-eslint/no-unused-vars ...
+  if (options.validate == null) {
+    options.validate = true;
+  }
+  if (options.normalize == null) {
+    options.normalize = true;
+  }
   return model as T;
 }
 
@@ -46,14 +78,20 @@ function defaultBuildingFn<T>(model: Partial<T>): T {
  * @param buildingFn The function used to validate and produce the object on build()
  * @returns A fluent builder
  */
-export function builder<T>(
-  model: Partial<T> = {},
-  buildingFn: (data: Partial<T>) => T = defaultBuildingFn,
-): Builder<T> {
+export function builder<T>(model: Partial<T> = {}, buildingFn: BuildingFunction<T> = defaultBuildingFn): Builder<T> {
   const proxy = new Proxy({} as Builder<T>, {
     get: (_, prop) => {
       if (prop === 'build') {
-        return (validate: boolean = true) => (validate ? buildingFn(model) : model);
+        return (options?: BuildOptions) => {
+          options = options || ({} as BuildOptions);
+          if (options.validate == null) {
+            options.validate = true;
+          }
+          if (options.normalize == null) {
+            options.normalize = true;
+          }
+          return buildingFn(model, options);
+        };
       }
       return (value: unknown): Builder<T> => {
         (model as any)[prop.toString()] = value;
@@ -74,15 +112,24 @@ export function builder<T>(
  */
 export function arrayBuilder<T>(
   model: Array<T> = [],
-  buildingFn: (data: Array<T>) => Array<T> = defaultBuildingFn,
+  buildingFn: ArrayBuildingFunction<T> = defaultBuildingFn,
 ): ArrayBuilder<T> {
   if (model != null && !Array.isArray(model)) {
     throw new Error(`The provided model should be an array`);
   }
   const proxy = new Proxy({} as ArrayBuilder<T>, {
     get: (_, prop) => {
       if (prop === 'build') {
-        return (validate: boolean = true) => (validate ? buildingFn(model) : model);
+        return (options?: BuildOptions) => {
+          options = options || ({} as BuildOptions);
+          if (options.validate == null) {
+            options.validate = true;
+          }
+          if (options.normalize == null) {
+            options.normalize = true;
+          }
+          return buildingFn(model, options);
+        };
       }
       if (prop === 'push') {
         return (value: T): ArrayBuilder<T> => {

src/lib/generated/builders/authentication-policy-basic-builder.ts

@@ -20,20 +20,23 @@
  *
  *****************************************************************************************/
 
-import { builder, Builder } from '../../builder';
-import { validate } from '../../validation';
+import { builder, Builder, BuildOptions } from '../../builder';
 import { Classes } from '../classes';
 import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.AuthenticationPolicyBasic} model The underlying object
- * @returns {Specification.AuthenticationPolicyBasic} The validated underlying object
+ * @param {Specification.AuthenticationPolicyBasic} model The proxied object
+ * @param {BuildOptions} options The build options to use
+ * @returns {Specification.AuthenticationPolicyBasic} The built object
  */
-function buildingFn(model: Specification.AuthenticationPolicyBasic): Specification.AuthenticationPolicyBasic {
+function buildingFn(
+  model: Specification.AuthenticationPolicyBasic,
+  options: BuildOptions,
+): Specification.AuthenticationPolicyBasic {
   const instance = new Classes.AuthenticationPolicyBasic(model);
-  validate('AuthenticationPolicyBasic', instance);
-  return instance as Specification.AuthenticationPolicyBasic;
+  if (options.validate) instance.validate();
+  return (options.normalize ? instance.normalize() : instance) as Specification.AuthenticationPolicyBasic;
 }
 
 /**

src/lib/generated/builders/authentication-policy-bearer-builder.ts

@@ -20,20 +20,23 @@
  *
  *****************************************************************************************/
 
-import { builder, Builder } from '../../builder';
-import { validate } from '../../validation';
+import { builder, Builder, BuildOptions } from '../../builder';
 import { Classes } from '../classes';
 import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.AuthenticationPolicyBearer} model The underlying object
- * @returns {Specification.AuthenticationPolicyBearer} The validated underlying object
+ * @param {Specification.AuthenticationPolicyBearer} model The proxied object
+ * @param {BuildOptions} options The build options to use
+ * @returns {Specification.AuthenticationPolicyBearer} The built object
  */
-function buildingFn(model: Specification.AuthenticationPolicyBearer): Specification.AuthenticationPolicyBearer {
+function buildingFn(
+  model: Specification.AuthenticationPolicyBearer,
+  options: BuildOptions,
+): Specification.AuthenticationPolicyBearer {
   const instance = new Classes.AuthenticationPolicyBearer(model);
-  validate('AuthenticationPolicyBearer', instance);
-  return instance as Specification.AuthenticationPolicyBearer;
+  if (options.validate) instance.validate();
+  return (options.normalize ? instance.normalize() : instance) as Specification.AuthenticationPolicyBearer;
 }
 
 /**

src/lib/generated/builders/authentication-policy-builder.ts

@@ -20,20 +20,23 @@
  *
  *****************************************************************************************/
 
-import { builder, Builder } from '../../builder';
-import { validate } from '../../validation';
+import { builder, Builder, BuildOptions } from '../../builder';
 import { Classes } from '../classes';
 import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.AuthenticationPolicy} model The underlying object
- * @returns {Specification.AuthenticationPolicy} The validated underlying object
+ * @param {Specification.AuthenticationPolicy} model The proxied object
+ * @param {BuildOptions} options The build options to use
+ * @returns {Specification.AuthenticationPolicy} The built object
  */
-function buildingFn(model: Specification.AuthenticationPolicy): Specification.AuthenticationPolicy {
+function buildingFn(
+  model: Specification.AuthenticationPolicy,
+  options: BuildOptions,
+): Specification.AuthenticationPolicy {
   const instance = new Classes.AuthenticationPolicy(model);
-  validate('AuthenticationPolicy', instance);
-  return instance as Specification.AuthenticationPolicy;
+  if (options.validate) instance.validate();
+  return (options.normalize ? instance.normalize() : instance) as Specification.AuthenticationPolicy;
 }
 
 /**

src/lib/generated/builders/authentication-policy-oauth2-builder.ts

@@ -20,20 +20,23 @@
  *
  *****************************************************************************************/
 
-import { builder, Builder } from '../../builder';
-import { validate } from '../../validation';
+import { builder, Builder, BuildOptions } from '../../builder';
 import { Classes } from '../classes';
 import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.AuthenticationPolicyOauth2} model The underlying object
- * @returns {Specification.AuthenticationPolicyOauth2} The validated underlying object
+ * @param {Specification.AuthenticationPolicyOauth2} model The proxied object
+ * @param {BuildOptions} options The build options to use
+ * @returns {Specification.AuthenticationPolicyOauth2} The built object
  */
-function buildingFn(model: Specification.AuthenticationPolicyOauth2): Specification.AuthenticationPolicyOauth2 {
+function buildingFn(
+  model: Specification.AuthenticationPolicyOauth2,
+  options: BuildOptions,
+): Specification.AuthenticationPolicyOauth2 {
   const instance = new Classes.AuthenticationPolicyOauth2(model);
-  validate('AuthenticationPolicyOauth2', instance);
-  return instance as Specification.AuthenticationPolicyOauth2;
+  if (options.validate) instance.validate();
+  return (options.normalize ? instance.normalize() : instance) as Specification.AuthenticationPolicyOauth2;
 }
 
 /**

src/lib/generated/builders/authentication-policy-oauth2-client-builder.ts

@@ -20,22 +20,23 @@
  *
  *****************************************************************************************/
 
-import { builder, Builder } from '../../builder';
-import { validate } from '../../validation';
+import { builder, Builder, BuildOptions } from '../../builder';
 import { Classes } from '../classes';
 import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.AuthenticationPolicyOauth2Client} model The underlying object
- * @returns {Specification.AuthenticationPolicyOauth2Client} The validated underlying object
+ * @param {Specification.AuthenticationPolicyOauth2Client} model The proxied object
+ * @param {BuildOptions} options The build options to use
+ * @returns {Specification.AuthenticationPolicyOauth2Client} The built object
  */
 function buildingFn(
   model: Specification.AuthenticationPolicyOauth2Client,
+  options: BuildOptions,
 ): Specification.AuthenticationPolicyOauth2Client {
   const instance = new Classes.AuthenticationPolicyOauth2Client(model);
-  validate('AuthenticationPolicyOauth2Client', instance);
-  return instance as Specification.AuthenticationPolicyOauth2Client;
+  if (options.validate) instance.validate();
+  return (options.normalize ? instance.normalize() : instance) as Specification.AuthenticationPolicyOauth2Client;
 }
 
 /**

src/lib/generated/builders/call-async-api-builder.ts

@@ -20,20 +20,20 @@
  *
  *****************************************************************************************/
 
-import { builder, Builder } from '../../builder';
-import { validate } from '../../validation';
+import { builder, Builder, BuildOptions } from '../../builder';
 import { Classes } from '../classes';
 import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.CallAsyncAPI} model The underlying object
- * @returns {Specification.CallAsyncAPI} The validated underlying object
+ * @param {Specification.CallAsyncAPI} model The proxied object
+ * @param {BuildOptions} options The build options to use
+ * @returns {Specification.CallAsyncAPI} The built object
  */
-function buildingFn(model: Specification.CallAsyncAPI): Specification.CallAsyncAPI {
+function buildingFn(model: Specification.CallAsyncAPI, options: BuildOptions): Specification.CallAsyncAPI {
   const instance = new Classes.CallAsyncAPI(model);
-  validate('CallAsyncAPI', instance);
-  return instance as Specification.CallAsyncAPI;
+  if (options.validate) instance.validate();
+  return (options.normalize ? instance.normalize() : instance) as Specification.CallAsyncAPI;
 }
 
 /**

src/lib/generated/builders/call-async-api-with-authentication-builder.ts

@@ -20,20 +20,23 @@
  *
  *****************************************************************************************/
 
-import { builder, Builder } from '../../builder';
-import { validate } from '../../validation';
+import { builder, Builder, BuildOptions } from '../../builder';
 import { Classes } from '../classes';
 import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.CallAsyncAPIWithAuthentication} model The underlying object
- * @returns {Specification.CallAsyncAPIWithAuthentication} The validated underlying object
+ * @param {Specification.CallAsyncAPIWithAuthentication} model The proxied object
+ * @param {BuildOptions} options The build options to use
+ * @returns {Specification.CallAsyncAPIWithAuthentication} The built object
  */
-function buildingFn(model: Specification.CallAsyncAPIWithAuthentication): Specification.CallAsyncAPIWithAuthentication {
+function buildingFn(
+  model: Specification.CallAsyncAPIWithAuthentication,
+  options: BuildOptions,
+): Specification.CallAsyncAPIWithAuthentication {
   const instance = new Classes.CallAsyncAPIWithAuthentication(model);
-  validate('CallAsyncAPIWithAuthentication', instance);
-  return instance as Specification.CallAsyncAPIWithAuthentication;
+  if (options.validate) instance.validate();
+  return (options.normalize ? instance.normalize() : instance) as Specification.CallAsyncAPIWithAuthentication;
 }
 
 /**

src/lib/generated/builders/call-async-api-with-builder.ts

@@ -20,20 +20,20 @@
  *
  *****************************************************************************************/
 
-import { builder, Builder } from '../../builder';
-import { validate } from '../../validation';
+import { builder, Builder, BuildOptions } from '../../builder';
 import { Classes } from '../classes';
 import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.CallAsyncAPIWith} model The underlying object
- * @returns {Specification.CallAsyncAPIWith} The validated underlying object
+ * @param {Specification.CallAsyncAPIWith} model The proxied object
+ * @param {BuildOptions} options The build options to use
+ * @returns {Specification.CallAsyncAPIWith} The built object
  */
-function buildingFn(model: Specification.CallAsyncAPIWith): Specification.CallAsyncAPIWith {
+function buildingFn(model: Specification.CallAsyncAPIWith, options: BuildOptions): Specification.CallAsyncAPIWith {
   const instance = new Classes.CallAsyncAPIWith(model);
-  validate('CallAsyncAPIWith', instance);
-  return instance as Specification.CallAsyncAPIWith;
+  if (options.validate) instance.validate();
+  return (options.normalize ? instance.normalize() : instance) as Specification.CallAsyncAPIWith;
 }
 
 /**

src/lib/generated/builders/call-function-builder.ts

@@ -20,20 +20,20 @@
  *
  *****************************************************************************************/
 
-import { builder, Builder } from '../../builder';
-import { validate } from '../../validation';
+import { builder, Builder, BuildOptions } from '../../builder';
 import { Classes } from '../classes';
 import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.CallFunction} model The underlying object
- * @returns {Specification.CallFunction} The validated underlying object
+ * @param {Specification.CallFunction} model The proxied object
+ * @param {BuildOptions} options The build options to use
+ * @returns {Specification.CallFunction} The built object
  */
-function buildingFn(model: Specification.CallFunction): Specification.CallFunction {
+function buildingFn(model: Specification.CallFunction, options: BuildOptions): Specification.CallFunction {
   const instance = new Classes.CallFunction(model);
-  validate('CallFunction', instance);
-  return instance as Specification.CallFunction;
+  if (options.validate) instance.validate();
+  return (options.normalize ? instance.normalize() : instance) as Specification.CallFunction;
 }
 
 /**