Extended support to array types

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

Author: JBBianchi

src/lib/builder.ts

@@ -16,37 +16,47 @@
  */
 
 /**
- * Represents a fluent builder proxy
+ * Represents a fluent builder proxy for an object
  */
 export type Builder<T> = {
   build: (validate?: boolean) => T;
 } & {
   [K in keyof T]-?: (arg: T[K]) => Builder<T>;
 };
 
+/**
+ * Represents a fluent builder proxy for an array
+ */
+export type ArrayBuilder<T> = {
+  push: (item: T) => ArrayBuilder<T>;
+  build: (validate?: boolean) => Array<T>;
+};
+
 /**
  * The default function used to build an object, basically just return the provided object
- * @param data The object to "build"
+ * @param model The object to "build"
  * @returns
  */
-function defaultBuildingFn<T>(data: Partial<T>): T {
-  return data as T;
+function defaultBuildingFn<T>(model: Partial<T>): T {
+  return model as T;
 }
 
 /**
  * A factory for fluent builders that proxy properties assignations and can validate against schema on build()
- * @param {Function} buildingFn The function used to validate and produce the object on build()
- * @returns {Builder} A fluent builder
+ * @param buildingFn The function used to validate and produce the object on build()
+ * @returns A fluent builder
  */
-export function builder<T>(buildingFn?: (data: Partial<T>) => T): Builder<T> {
-  const data: Partial<T> = {};
+export function builder<T>(
+  model: Partial<T> = {},
+  buildingFn: (data: Partial<T>) => T = defaultBuildingFn,
+): Builder<T> {
   const proxy = new Proxy({} as Builder<T>, {
     get: (_, prop) => {
       if (prop === 'build') {
-        return (validate: boolean = true) => (validate ? (buildingFn || defaultBuildingFn)(data) : data);
+        return (validate: boolean = true) => (validate ? buildingFn(model) : model);
       }
       return (value: unknown): Builder<T> => {
-        (data as any)[prop.toString()] = value;
+        (model as any)[prop.toString()] = value;
         return proxy;
       };
     },
@@ -56,3 +66,34 @@ export function builder<T>(buildingFn?: (data: Partial<T>) => T): Builder<T> {
   });
   return proxy;
 }
+
+/**
+ * A factory for fluent builders that proxy properties assignations and can validate against schema on build()
+ * @param buildingFn The function used to validate and produce the object on build()
+ * @returns A fluent builder
+ */
+export function arrayBuilder<T>(
+  model: Array<T> = [],
+  buildingFn: (data: Array<T>) => Array<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);
+      }
+      if (prop === 'push') {
+        return (value: T): ArrayBuilder<T> => {
+          model.push(value);
+          return proxy;
+        };
+      }
+    },
+    set: () => {
+      return false;
+    },
+  });
+  return proxy;
+}

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

@@ -21,19 +21,20 @@ import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.AuthenticationPolicyBasic} data The underlying object
+ * @param {Specification.AuthenticationPolicyBasic} model The underlying object
  * @returns {Specification.AuthenticationPolicyBasic} The validated underlying object
  */
-function buildingFn(data: Specification.AuthenticationPolicyBasic): Specification.AuthenticationPolicyBasic {
-  const model = new Classes.AuthenticationPolicyBasic(data);
-
-  validate('AuthenticationPolicyBasic', model);
-  return model as Specification.AuthenticationPolicyBasic;
+function buildingFn(model: Specification.AuthenticationPolicyBasic): Specification.AuthenticationPolicyBasic {
+  const instance = new Classes.AuthenticationPolicyBasic(model);
+  validate('AuthenticationPolicyBasic', instance);
+  return instance as Specification.AuthenticationPolicyBasic;
 }
 
 /**
  * A factory to create a builder proxy for the type `Specification.AuthenticationPolicyBasic`
- * @returns {Specification.AuthenticationPolicyBasic} A builder for `Specification.AuthenticationPolicyBasic`
+ * @returns {Builder<Specification.AuthenticationPolicyBasic>} A builder for `Specification.AuthenticationPolicyBasic`
  */
-export const authenticationPolicyBasicBuilder = (): Builder<Specification.AuthenticationPolicyBasic> =>
-  builder<Specification.AuthenticationPolicyBasic>(buildingFn);
+export const authenticationPolicyBasicBuilder = (
+  model?: Partial<Specification.AuthenticationPolicyBasic>,
+): Builder<Specification.AuthenticationPolicyBasic> =>
+  builder<Specification.AuthenticationPolicyBasic>(model, buildingFn);

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

@@ -21,19 +21,20 @@ import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.AuthenticationPolicyBearer} data The underlying object
+ * @param {Specification.AuthenticationPolicyBearer} model The underlying object
  * @returns {Specification.AuthenticationPolicyBearer} The validated underlying object
  */
-function buildingFn(data: Specification.AuthenticationPolicyBearer): Specification.AuthenticationPolicyBearer {
-  const model = new Classes.AuthenticationPolicyBearer(data);
-
-  validate('AuthenticationPolicyBearer', model);
-  return model as Specification.AuthenticationPolicyBearer;
+function buildingFn(model: Specification.AuthenticationPolicyBearer): Specification.AuthenticationPolicyBearer {
+  const instance = new Classes.AuthenticationPolicyBearer(model);
+  validate('AuthenticationPolicyBearer', instance);
+  return instance as Specification.AuthenticationPolicyBearer;
 }
 
 /**
  * A factory to create a builder proxy for the type `Specification.AuthenticationPolicyBearer`
- * @returns {Specification.AuthenticationPolicyBearer} A builder for `Specification.AuthenticationPolicyBearer`
+ * @returns {Builder<Specification.AuthenticationPolicyBearer>} A builder for `Specification.AuthenticationPolicyBearer`
  */
-export const authenticationPolicyBearerBuilder = (): Builder<Specification.AuthenticationPolicyBearer> =>
-  builder<Specification.AuthenticationPolicyBearer>(buildingFn);
+export const authenticationPolicyBearerBuilder = (
+  model?: Partial<Specification.AuthenticationPolicyBearer>,
+): Builder<Specification.AuthenticationPolicyBearer> =>
+  builder<Specification.AuthenticationPolicyBearer>(model, buildingFn);

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

@@ -21,19 +21,19 @@ import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.AuthenticationPolicy} data The underlying object
+ * @param {Specification.AuthenticationPolicy} model The underlying object
  * @returns {Specification.AuthenticationPolicy} The validated underlying object
  */
-function buildingFn(data: Specification.AuthenticationPolicy): Specification.AuthenticationPolicy {
-  const model = new Classes.AuthenticationPolicy(data);
-
-  validate('AuthenticationPolicy', model);
-  return model as Specification.AuthenticationPolicy;
+function buildingFn(model: Specification.AuthenticationPolicy): Specification.AuthenticationPolicy {
+  const instance = new Classes.AuthenticationPolicy(model);
+  validate('AuthenticationPolicy', instance);
+  return instance as Specification.AuthenticationPolicy;
 }
 
 /**
  * A factory to create a builder proxy for the type `Specification.AuthenticationPolicy`
- * @returns {Specification.AuthenticationPolicy} A builder for `Specification.AuthenticationPolicy`
+ * @returns {Builder<Specification.AuthenticationPolicy>} A builder for `Specification.AuthenticationPolicy`
  */
-export const authenticationPolicyBuilder = (): Builder<Specification.AuthenticationPolicy> =>
-  builder<Specification.AuthenticationPolicy>(buildingFn);
+export const authenticationPolicyBuilder = (
+  model?: Partial<Specification.AuthenticationPolicy>,
+): Builder<Specification.AuthenticationPolicy> => builder<Specification.AuthenticationPolicy>(model, buildingFn);

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

@@ -21,19 +21,20 @@ import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.AuthenticationPolicyOauth2} data The underlying object
+ * @param {Specification.AuthenticationPolicyOauth2} model The underlying object
  * @returns {Specification.AuthenticationPolicyOauth2} The validated underlying object
  */
-function buildingFn(data: Specification.AuthenticationPolicyOauth2): Specification.AuthenticationPolicyOauth2 {
-  const model = new Classes.AuthenticationPolicyOauth2(data);
-
-  validate('AuthenticationPolicyOauth2', model);
-  return model as Specification.AuthenticationPolicyOauth2;
+function buildingFn(model: Specification.AuthenticationPolicyOauth2): Specification.AuthenticationPolicyOauth2 {
+  const instance = new Classes.AuthenticationPolicyOauth2(model);
+  validate('AuthenticationPolicyOauth2', instance);
+  return instance as Specification.AuthenticationPolicyOauth2;
 }
 
 /**
  * A factory to create a builder proxy for the type `Specification.AuthenticationPolicyOauth2`
- * @returns {Specification.AuthenticationPolicyOauth2} A builder for `Specification.AuthenticationPolicyOauth2`
+ * @returns {Builder<Specification.AuthenticationPolicyOauth2>} A builder for `Specification.AuthenticationPolicyOauth2`
  */
-export const authenticationPolicyOauth2Builder = (): Builder<Specification.AuthenticationPolicyOauth2> =>
-  builder<Specification.AuthenticationPolicyOauth2>(buildingFn);
+export const authenticationPolicyOauth2Builder = (
+  model?: Partial<Specification.AuthenticationPolicyOauth2>,
+): Builder<Specification.AuthenticationPolicyOauth2> =>
+  builder<Specification.AuthenticationPolicyOauth2>(model, buildingFn);

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

@@ -21,21 +21,22 @@ import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.AuthenticationPolicyOauth2Client} data The underlying object
+ * @param {Specification.AuthenticationPolicyOauth2Client} model The underlying object
  * @returns {Specification.AuthenticationPolicyOauth2Client} The validated underlying object
  */
 function buildingFn(
-  data: Specification.AuthenticationPolicyOauth2Client,
+  model: Specification.AuthenticationPolicyOauth2Client,
 ): Specification.AuthenticationPolicyOauth2Client {
-  const model = new Classes.AuthenticationPolicyOauth2Client(data);
-
-  validate('AuthenticationPolicyOauth2Client', model);
-  return model as Specification.AuthenticationPolicyOauth2Client;
+  const instance = new Classes.AuthenticationPolicyOauth2Client(model);
+  validate('AuthenticationPolicyOauth2Client', instance);
+  return instance as Specification.AuthenticationPolicyOauth2Client;
 }
 
 /**
  * A factory to create a builder proxy for the type `Specification.AuthenticationPolicyOauth2Client`
- * @returns {Specification.AuthenticationPolicyOauth2Client} A builder for `Specification.AuthenticationPolicyOauth2Client`
+ * @returns {Builder<Specification.AuthenticationPolicyOauth2Client>} A builder for `Specification.AuthenticationPolicyOauth2Client`
  */
-export const authenticationPolicyOauth2ClientBuilder = (): Builder<Specification.AuthenticationPolicyOauth2Client> =>
-  builder<Specification.AuthenticationPolicyOauth2Client>(buildingFn);
+export const authenticationPolicyOauth2ClientBuilder = (
+  model?: Partial<Specification.AuthenticationPolicyOauth2Client>,
+): Builder<Specification.AuthenticationPolicyOauth2Client> =>
+  builder<Specification.AuthenticationPolicyOauth2Client>(model, buildingFn);

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

@@ -21,19 +21,18 @@ import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.CallAsyncAPI} data The underlying object
+ * @param {Specification.CallAsyncAPI} model The underlying object
  * @returns {Specification.CallAsyncAPI} The validated underlying object
  */
-function buildingFn(data: Specification.CallAsyncAPI): Specification.CallAsyncAPI {
-  const model = new Classes.CallAsyncAPI(data);
-
-  validate('CallAsyncAPI', model);
-  return model as Specification.CallAsyncAPI;
+function buildingFn(model: Specification.CallAsyncAPI): Specification.CallAsyncAPI {
+  const instance = new Classes.CallAsyncAPI(model);
+  validate('CallAsyncAPI', instance);
+  return instance as Specification.CallAsyncAPI;
 }
 
 /**
  * A factory to create a builder proxy for the type `Specification.CallAsyncAPI`
- * @returns {Specification.CallAsyncAPI} A builder for `Specification.CallAsyncAPI`
+ * @returns {Builder<Specification.CallAsyncAPI>} A builder for `Specification.CallAsyncAPI`
  */
-export const callAsyncAPIBuilder = (): Builder<Specification.CallAsyncAPI> =>
-  builder<Specification.CallAsyncAPI>(buildingFn);
+export const callAsyncAPIBuilder = (model?: Partial<Specification.CallAsyncAPI>): Builder<Specification.CallAsyncAPI> =>
+  builder<Specification.CallAsyncAPI>(model, buildingFn);

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

@@ -21,19 +21,20 @@ import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.CallAsyncAPIWithAuthentication} data The underlying object
+ * @param {Specification.CallAsyncAPIWithAuthentication} model The underlying object
  * @returns {Specification.CallAsyncAPIWithAuthentication} The validated underlying object
  */
-function buildingFn(data: Specification.CallAsyncAPIWithAuthentication): Specification.CallAsyncAPIWithAuthentication {
-  const model = new Classes.CallAsyncAPIWithAuthentication(data);
-
-  validate('CallAsyncAPIWithAuthentication', model);
-  return model as Specification.CallAsyncAPIWithAuthentication;
+function buildingFn(model: Specification.CallAsyncAPIWithAuthentication): Specification.CallAsyncAPIWithAuthentication {
+  const instance = new Classes.CallAsyncAPIWithAuthentication(model);
+  validate('CallAsyncAPIWithAuthentication', instance);
+  return instance as Specification.CallAsyncAPIWithAuthentication;
 }
 
 /**
  * A factory to create a builder proxy for the type `Specification.CallAsyncAPIWithAuthentication`
- * @returns {Specification.CallAsyncAPIWithAuthentication} A builder for `Specification.CallAsyncAPIWithAuthentication`
+ * @returns {Builder<Specification.CallAsyncAPIWithAuthentication>} A builder for `Specification.CallAsyncAPIWithAuthentication`
  */
-export const callAsyncAPIWithAuthenticationBuilder = (): Builder<Specification.CallAsyncAPIWithAuthentication> =>
-  builder<Specification.CallAsyncAPIWithAuthentication>(buildingFn);
+export const callAsyncAPIWithAuthenticationBuilder = (
+  model?: Partial<Specification.CallAsyncAPIWithAuthentication>,
+): Builder<Specification.CallAsyncAPIWithAuthentication> =>
+  builder<Specification.CallAsyncAPIWithAuthentication>(model, buildingFn);

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

@@ -21,19 +21,19 @@ import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.CallAsyncAPIWith} data The underlying object
+ * @param {Specification.CallAsyncAPIWith} model The underlying object
  * @returns {Specification.CallAsyncAPIWith} The validated underlying object
  */
-function buildingFn(data: Specification.CallAsyncAPIWith): Specification.CallAsyncAPIWith {
-  const model = new Classes.CallAsyncAPIWith(data);
-
-  validate('CallAsyncAPIWith', model);
-  return model as Specification.CallAsyncAPIWith;
+function buildingFn(model: Specification.CallAsyncAPIWith): Specification.CallAsyncAPIWith {
+  const instance = new Classes.CallAsyncAPIWith(model);
+  validate('CallAsyncAPIWith', instance);
+  return instance as Specification.CallAsyncAPIWith;
 }
 
 /**
  * A factory to create a builder proxy for the type `Specification.CallAsyncAPIWith`
- * @returns {Specification.CallAsyncAPIWith} A builder for `Specification.CallAsyncAPIWith`
+ * @returns {Builder<Specification.CallAsyncAPIWith>} A builder for `Specification.CallAsyncAPIWith`
  */
-export const callAsyncAPIWithBuilder = (): Builder<Specification.CallAsyncAPIWith> =>
-  builder<Specification.CallAsyncAPIWith>(buildingFn);
+export const callAsyncAPIWithBuilder = (
+  model?: Partial<Specification.CallAsyncAPIWith>,
+): Builder<Specification.CallAsyncAPIWith> => builder<Specification.CallAsyncAPIWith>(model, buildingFn);

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

@@ -21,19 +21,18 @@ import { Specification } from '../definitions';
 
 /**
  * The internal function used by the builder proxy to validate and return its underlying object
- * @param {Specification.CallFunction} data The underlying object
+ * @param {Specification.CallFunction} model The underlying object
  * @returns {Specification.CallFunction} The validated underlying object
  */
-function buildingFn(data: Specification.CallFunction): Specification.CallFunction {
-  const model = new Classes.CallFunction(data);
-
-  validate('CallFunction', model);
-  return model as Specification.CallFunction;
+function buildingFn(model: Specification.CallFunction): Specification.CallFunction {
+  const instance = new Classes.CallFunction(model);
+  validate('CallFunction', instance);
+  return instance as Specification.CallFunction;
 }
 
 /**
  * A factory to create a builder proxy for the type `Specification.CallFunction`
- * @returns {Specification.CallFunction} A builder for `Specification.CallFunction`
+ * @returns {Builder<Specification.CallFunction>} A builder for `Specification.CallFunction`
  */
-export const callFunctionBuilder = (): Builder<Specification.CallFunction> =>
-  builder<Specification.CallFunction>(buildingFn);
+export const callFunctionBuilder = (model?: Partial<Specification.CallFunction>): Builder<Specification.CallFunction> =>
+  builder<Specification.CallFunction>(model, buildingFn);