@jmm-devkit/ngx-form-generator 1.3.1 → 1.4.0

package/README.md

@@ -14,8 +14,6 @@ Generates an Angular ReactiveForm from a Swagger or OpenAPI definition.
 
 Validation rules should have a single source of truth. These rules should be exposed to consumers to apply them. By doing this we can be sure that the same rules for UI validation are enforced at the API layer.
 
-[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
-
 ## Install
 
 ```bash

package/dist/file-utils.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Saves the generated file
+ * @param content - The content of the file to save.
+ * @param fileName - The name of the file to save.
+ */
+export declare function saveFile(content: string, fileName: string): void;

package/dist/file-utils.js

@@ -0,0 +1,9 @@
+import * as fs from 'node:fs';
+/**
+ * Saves the generated file
+ * @param content - The content of the file to save.
+ * @param fileName - The name of the file to save.
+ */
+export function saveFile(content, fileName) {
+    fs.writeFileSync(fileName, content);
+}

package/dist/generator-cli.d.ts

@@ -0,0 +1,9 @@
+#! /usr/bin/env node
+/**
+ * @license
+ * Licensed under the MIT License, (“the License”); you may not use this
+ * file except in compliance with the License.
+ *
+ * Copyright (c) 2020 Verizon
+ */
+export {};

package/dist/generator-cli.js

@@ -1,57 +1,56 @@
-#! /usr/bin/env node
-"use strict";
-/**
- * @license
- * Licensed under the MIT License, (“the License”); you may not use this
- * file except in compliance with the License.
- *
- * Copyright (c) 2020 Verizon
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-const generator_lib_1 = require("./generator-lib");
-const path_1 = require("path");
-const yargs = require('yargs');
-async function main() {
-    const argv = yargs
-        .option('input-spec', {
-        alias: ['i', 'swaggerUrl'],
-        description: 'Location of the OpenAPI spec as a URL or file path',
-        type: 'string',
-        require: true
-    })
-        .option('output', {
-        alias: ['o', 'outDir'],
-        description: 'Where to write the generated files',
-        type: 'string'
-    })
-        .option('file-name', {
-        alias: ['f', 'outFile'],
-        description: 'Generated file name',
-        type: 'string'
-    })
-        .option('max-depth', {
-        alias: ['d', 'maxDepth'],
-        description: 'Maximum depth of the generated forms',
-        type: 'number'
-    })
-        .help()
-        .wrap(null)
-        .usage('Generates Angular ReactiveForms from an OpenAPI v2 or v3 spec.\n\n Usage: $0 -i <spec> -o <path>')
-        .example('ngx-form-generator -i https://petstore.swagger.io/v2/swagger.json -o petstore-forms')
-        .example('ngx-form-generator -i https://petstore.swagger.io/v2/swagger.yaml -o petstore-forms')
-        .example('npx ngx-form-generator -i swagger.json -o project/form/src/lib')
-        .alias('help', 'h').argv;
-    const spec = await (0, generator_lib_1.loadSpec)(argv['input-spec']);
-    const maxDepth = argv['max-depth'];
-    if (maxDepth !== undefined && (isNaN(maxDepth) || maxDepth < 1)) {
-        console.error('Error: max-depth must be a number greater than 0');
-        process.exit(1);
-    }
-    const file = (0, generator_lib_1.makeForm)(spec, maxDepth);
-    let fileName = argv['file-name'] || (0, generator_lib_1.makeFileName)(spec) || 'forms.ts';
-    if (argv.output) {
-        fileName = (0, path_1.join)(argv.output, fileName);
-    }
-    await (0, generator_lib_1.saveFile)(file, fileName);
-}
-main();
+#! /usr/bin/env node
+/**
+ * @license
+ * Licensed under the MIT License, (“the License”); you may not use this
+ * file except in compliance with the License.
+ *
+ * Copyright (c) 2020 Verizon
+ */
+import { saveFile } from './file-utils';
+import { makeForm, makeFileName, loadSpec } from './generator-lib';
+import { join } from 'node:path';
+const yargs = require('yargs');
+async function main() {
+    const argv = yargs
+        .option('input-spec', {
+        alias: ['i', 'swaggerUrl'],
+        description: 'Location of the OpenAPI spec as a URL or file path',
+        type: 'string',
+        require: true,
+    })
+        .option('output', {
+        alias: ['o', 'outDir'],
+        description: 'Where to write the generated files',
+        type: 'string',
+    })
+        .option('file-name', {
+        alias: ['f', 'outFile'],
+        description: 'Generated file name',
+        type: 'string',
+    })
+        .option('max-depth', {
+        alias: ['d', 'maxDepth'],
+        description: 'Maximum depth of the generated forms',
+        type: 'number',
+    })
+        .help()
+        .wrap(null)
+        .usage('Generates Angular ReactiveForms from an OpenAPI v2 or v3 spec.\n\n Usage: $0 -i <spec> -o <path>')
+        .example('ngx-form-generator -i https://petstore.swagger.io/v2/swagger.json -o petstore-forms')
+        .example('ngx-form-generator -i https://petstore.swagger.io/v2/swagger.yaml -o petstore-forms')
+        .example('npx ngx-form-generator -i swagger.json -o project/form/src/lib')
+        .alias('help', 'h').argv;
+    const spec = await loadSpec(argv['input-spec']);
+    const maxDepth = argv['max-depth'];
+    if (maxDepth !== undefined && (Number.isNaN(maxDepth) || maxDepth < 1)) {
+        console.error('Error: max-depth must be a number greater than 0');
+        process.exit(1);
+    }
+    const file = await makeForm(spec, maxDepth);
+    let fileName = argv['file-name'] || makeFileName(spec) || 'forms.ts';
+    if (argv.output) {
+        fileName = join(argv.output, fileName);
+    }
+    saveFile(file, fileName);
+}
+await main();

package/dist/generator-lib.d.ts

@@ -1,45 +1,38 @@
-/**
- * @license
- * Licensed under the MIT License, (“the License”); you may not use this
- * file except in compliance with the License.
- *
- * Copyright (c) 2020 Verizon
- */
-import { Rule } from './rules';
-import { OpenAPI } from 'openapi-types';
-/**
- * Generates Angular ReactiveForms from an OpenAPI v2 or v3 spec.
- * @param spec - The OpenAPI document.
- * @param maxDepth - The maximum depth of the generated forms.
- * @returns A string representing the generated forms.
- */
-export declare function makeForm(spec: OpenAPI.Document, maxDepth?: number): string;
-/**
- * Adds a validation rule for a form field.
- * @param rule - The validation rule to add.
- */
-export declare function addRule(rule: Rule): void;
-/**
- * Removes a validation rule from the form field rules.
- * @param rule - The validation rule to remove.
- */
-export declare function resetRules(): void;
-/**
- * Generates a file name based on the OpenAPI spec title.
- * @param swagger - The OpenAPI document.
- * @returns A string representing the file name or undefined if no title is available.
- */
-export declare function makeFileName(swagger: OpenAPI.Document): string | undefined;
-/**
- * Saves the generated file using ts-morph.
- * @param file - The content of the file to save.
- * @param fileName - The name of the file to save.
- * @returns A promise that resolves when the file is saved.
- */
-export declare function saveFile(file: string, fileName: string): Promise<void>;
-/**
- * Loads an OpenAPI specification from a file or URL.
- * @param fileOrUrlPath - The path to the OpenAPI spec file or URL.
- * @returns A promise that resolves to the dereferenced OpenAPI document.
- */
-export declare function loadSpec(fileOrUrlPath: string): Promise<OpenAPI.Document>;
+/**
+ * @license
+ * Licensed under the MIT License, (“the License”); you may not use this
+ * file except in compliance with the License.
+ *
+ * Copyright (c) 2020 Verizon
+ */
+import { type Rule } from './rules';
+import { type OpenAPI } from 'openapi-types';
+/**
+ * Generates Angular ReactiveForms from an OpenAPI v2 or v3 spec.
+ * @param spec - The OpenAPI document.
+ * @param maxDepth - The maximum depth of the generated forms.
+ * @returns A string representing the generated forms.
+ */
+export declare function makeForm(spec: OpenAPI.Document, maxDepth?: number): Promise<string>;
+/**
+ * Adds a validation rule for a form field.
+ * @param rule - The validation rule to add.
+ */
+export declare function addRule(rule: Rule): void;
+/**
+ * Removes a validation rule from the form field rules.
+ * @param rule - The validation rule to remove.
+ */
+export declare function resetRules(): void;
+/**
+ * Generates a file name based on the OpenAPI spec title.
+ * @param swagger - The OpenAPI document.
+ * @returns A string representing the file name or undefined if no title is available.
+ */
+export declare function makeFileName(swagger: OpenAPI.Document): string | undefined;
+/**
+ * Loads an OpenAPI specification from a file or URL.
+ * @param fileOrUrlPath - The path to the OpenAPI spec file or URL.
+ * @returns A promise that resolves to the dereferenced OpenAPI document.
+ */
+export declare function loadSpec(fileOrUrlPath: string): Promise<OpenAPI.Document>;

package/dist/generator-lib.js

@@ -1,265 +1,239 @@
-"use strict";
-/**
- * @license
- * Licensed under the MIT License, (“the License”); you may not use this
- * file except in compliance with the License.
- *
- * Copyright (c) 2020 Verizon
- */
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.loadSpec = exports.saveFile = exports.makeFileName = exports.resetRules = exports.addRule = exports.makeForm = void 0;
-const ts_morph_1 = require("ts-morph");
-const prettier_1 = __importDefault(require("prettier"));
-const camelcase_1 = __importDefault(require("camelcase"));
-const rules_1 = require("./rules");
-const swagger_parser_1 = __importDefault(require("@apidevtools/swagger-parser"));
-const DEFAULT_RULES = [rules_1.requiredRule, rules_1.patternRule, rules_1.minLengthRule, rules_1.maxLengthRule, rules_1.emailRule, rules_1.minimumRule, rules_1.maximumRule];
-const NEEDED_IMPORTS = `import { FormGroup, FormControl, Validators, FormArray } from '@angular/forms'; \n`;
-let rules = [...DEFAULT_RULES];
-let MAX_DEPTH = 2;
-/**
- * Generates Angular ReactiveForms from an OpenAPI v2 or v3 spec.
- * @param spec - The OpenAPI document.
- * @param maxDepth - The maximum depth of the generated forms.
- * @returns A string representing the generated forms.
- */
-function makeForm(spec, maxDepth) {
-    var _a;
-    let definitions;
-    MAX_DEPTH = maxDepth !== null && maxDepth !== void 0 ? maxDepth : MAX_DEPTH;
-    if ('definitions' in spec) {
-        definitions = spec.definitions;
-    }
-    else if ('components' in spec) {
-        definitions = (_a = spec.components) === null || _a === void 0 ? void 0 : _a.schemas;
-    }
-    else {
-        throw new Error('Cannot find schemas/definitions');
-    }
-    if (!definitions) {
-        throw new Error('Cannot find schemas/definitions');
-    }
-    let body = NEEDED_IMPORTS + '\n\n';
-    for (const [key, value] of Object.entries(definitions)) {
-        if (value) {
-            body += makeDefinition(key, value);
-        }
-    }
-    return prettier_1.default.format(body, { parser: 'typescript', singleQuote: true });
-}
-exports.makeForm = makeForm;
-/**
- * Creates a form definition for a given OpenAPI definition.
- * @param definitionName - The name of the definition.
- * @param definition - The OpenAPI definition object.
- * @returns A string representing the form definition.
- */
-function makeDefinition(definitionName, definition) {
-    return `export const ${(0, camelcase_1.default)(definitionName)}Form = () => new FormGroup({
-      ${makeFieldsBody(definition, 0)}
-    });\n`;
-}
-/**
- * Generates the body of fields for a form based on the provided definition.
- * @param definition - The OpenAPI definition object containing properties.
- * @param depth - The current depth of recursion.
- * @returns An array of strings representing the form fields.
- */
-function makeFieldsBody(definition, depth) {
-    if (depth >= MAX_DEPTH)
-        return [];
-    depth++;
-    return [...extractPropertiesFields(definition, depth), ...extractAllOfFields(definition, depth)];
-}
-/**
- * Extracts fields from the properties of a given OpenAPI definition.
- * @param definition - The OpenAPI definition object.
- * @param depth - The current depth of recursion.
- * @returns An array of strings representing the form fields.
- */
-function extractPropertiesFields(definition, depth) {
-    var _a;
-    if (!('properties' in definition) || !definition.properties)
-        return [];
-    const fields = [];
-    for (const [fieldName, fieldValue] of Object.entries(definition.properties)) {
-        const field = makeField(fieldName, fieldValue, !!((_a = definition.required) === null || _a === void 0 ? void 0 : _a.includes(fieldName)), depth);
-        if (field !== '') {
-            fields.push(field);
-        }
-    }
-    return fields;
-}
-/**
- * Extracts fields from the allOf properties of a given OpenAPI definition.
- * @param definition - The OpenAPI definition object.
- * @param depth - The current depth of recursion.
- * @returns An array of strings representing the form fields.
- */
-function extractAllOfFields(definition, depth) {
-    var _a, _b, _c;
-    if (!('allOf' in definition) || !Array.isArray(definition.allOf))
-        return [];
-    const fields = [];
-    for (const subSchema of definition.allOf) {
-        if ('$ref' in subSchema) {
-            const refName = subSchema.$ref.split('/').pop();
-            const refSchema = ((_a = definition.definitions) === null || _a === void 0 ? void 0 : _a[refName]) || ((_c = (_b = definition.components) === null || _b === void 0 ? void 0 : _b.schemas) === null || _c === void 0 ? void 0 : _c[refName]);
-            if (refSchema) {
-                fields.push(...makeFieldsBody(refSchema, depth));
-            }
-        }
-        else if ('type' in subSchema && subSchema.type === 'object') {
-            subSchema.required = definition.required;
-            fields.push(...makeFieldsBody(subSchema, depth));
-        }
-        else {
-            fields.push(...makeFieldsBody(subSchema, depth));
-        }
-    }
-    return fields;
-}
-/**
- * Creates a form field for a given OpenAPI property.
- * @param fieldName - The name of the field.
- * @param property - The OpenAPI property object.
- * @param isRequired - Indicates if the field is required.
- * @param depth - The current depth of recursion.
- * @returns A string representing the form field.
- */
-function makeField(fieldName, property, isRequired, depth) {
-    let fieldRepesentation;
-    if (property.allOf) {
-        fieldRepesentation = makeField(fieldName, property.allOf, isRequired, depth);
-    }
-    else if (property.type === 'array') {
-        fieldRepesentation = makeArrayField(fieldName, property, isRequired, depth);
-    }
-    else if (property.type === 'object') {
-        fieldRepesentation = makeObjectField(fieldName, property, isRequired, depth);
-    }
-    else {
-        fieldRepesentation = makePrimitiveField(fieldName, property, isRequired);
-    }
-    return fieldRepesentation;
-}
-/**
- * Creates a form array field for a given OpenAPI array schema.
- * @param fieldName - The name of the field.
- * @param property - The OpenAPI array schema object.
- * @param isRequired - Indicates if the field is required.
- * @param depth - The current depth of recursion.
- * @returns A string representing the form array field.
- */
-function makeArrayField(fieldName, property, isRequired, depth) {
-    var _a;
-    const itemDefinition = property.items;
-    const minItems = (_a = property['minItems']) !== null && _a !== void 0 ? _a : 1;
-    const items = [];
-    if (itemDefinition['type'] === 'object') {
-        for (let i = 0; i <= minItems; i++) {
-            items.push(`new FormGroup({${makeFieldsBody(itemDefinition, depth)}})`);
-        }
-    }
-    else {
-        const _dummyProps = {
-            properties: {
-                dummy: itemDefinition
-            }
-        };
-        const value = 'default' in _dummyProps.properties.dummy ? `'${_dummyProps.properties.dummy.default}'` : null;
-        for (let i = 1; i <= minItems; i++) {
-            items.push(`new FormControl(${value}, [${makeFieldRules('dummy', _dummyProps, isRequired)}])`);
-        }
-    }
-    return `"${fieldName}": new FormArray([${items.join(',')}])`;
-}
-/**
- * Creates a form object field for a given OpenAPI object schema.
- * @param fieldName - The name of the field.
- * @param property - The OpenAPI object schema object.
- * @param isRequired - Indicates if the field is required.
- * @param depth - The current depth of recursion.
- * @returns A string representing the form object field.
- */
-function makeObjectField(fieldName, property, isRequired, depth) {
-    const groupBody = makeFieldsBody(property, depth);
-    return `"${fieldName}": new FormGroup({${groupBody}}, [${makeFieldRules(fieldName, property, isRequired)}])`;
-}
-/**
- * Creates a form control for a primitive field based on its OpenAPI definition.
- * @param fieldName - The name of the field.
- * @param property - The OpenAPI property object.
- * @param isRequired - Indicates if the field is required.
- * @returns A string representing the form control.
- */
-function makePrimitiveField(fieldName, property, isRequired) {
-    const value = 'default' in property ? `'${property.default}'` : null;
-    return `"${fieldName}": new FormControl(${value}, [${makeFieldRules(fieldName, property, isRequired)}])`;
-}
-/**
- * Creates validation rules for a form field based on its OpenAPI definition.
- * @param fieldName - The name of the field.
- * @param property - The OpenAPI property object.
- * @param isRequired - Indicates if the field is required.
- * @returns A string representing the validation rules.
- */
-function makeFieldRules(fieldName, property, isRequired) {
-    return rules
-        .map(rule => rule(fieldName, property, isRequired))
-        .filter(item => item != '')
-        .join();
-}
-/**
- * Adds a validation rule for a form field.
- * @param rule - The validation rule to add.
- */
-function addRule(rule) {
-    rules.push(rule);
-}
-exports.addRule = addRule;
-/**
- * Removes a validation rule from the form field rules.
- * @param rule - The validation rule to remove.
- */
-function resetRules() {
-    rules = [...DEFAULT_RULES];
-}
-exports.resetRules = resetRules;
-/**
- * Generates a file name based on the OpenAPI spec title.
- * @param swagger - The OpenAPI document.
- * @returns A string representing the file name or undefined if no title is available.
- */
-function makeFileName(swagger) {
-    var _a;
-    if ((_a = swagger.info) === null || _a === void 0 ? void 0 : _a.title) {
-        return `${(0, camelcase_1.default)(swagger.info.title)}.ts`;
-    }
-}
-exports.makeFileName = makeFileName;
-/**
- * Saves the generated file using ts-morph.
- * @param file - The content of the file to save.
- * @param fileName - The name of the file to save.
- * @returns A promise that resolves when the file is saved.
- */
-async function saveFile(file, fileName) {
-    const project = new ts_morph_1.Project();
-    project.createSourceFile(fileName, file, { overwrite: true });
-    return project.save();
-}
-exports.saveFile = saveFile;
-/**
- * Loads an OpenAPI specification from a file or URL.
- * @param fileOrUrlPath - The path to the OpenAPI spec file or URL.
- * @returns A promise that resolves to the dereferenced OpenAPI document.
- */
-async function loadSpec(fileOrUrlPath) {
-    const parser = new swagger_parser_1.default();
-    return parser.dereference(fileOrUrlPath);
-}
-exports.loadSpec = loadSpec;
+/**
+ * @license
+ * Licensed under the MIT License, (“the License”); you may not use this
+ * file except in compliance with the License.
+ *
+ * Copyright (c) 2020 Verizon
+ */
+import * as prettier from 'prettier';
+import camelcase from 'camelcase';
+import { requiredRule, patternRule, minLengthRule, maxLengthRule, emailRule, minimumRule, maximumRule, } from './rules';
+import * as SwaggerParser from '@apidevtools/swagger-parser';
+import { OpenAPIV3 } from 'openapi-types';
+const DEFAULT_RULES = [requiredRule, patternRule, minLengthRule, maxLengthRule, emailRule, minimumRule, maximumRule];
+const NEEDED_IMPORTS = `import { FormGroup, FormControl, Validators, FormArray } from '@angular/forms'; \n`;
+let rules = [...DEFAULT_RULES];
+let MAX_DEPTH = 2;
+/**
+ * Generates Angular ReactiveForms from an OpenAPI v2 or v3 spec.
+ * @param spec - The OpenAPI document.
+ * @param maxDepth - The maximum depth of the generated forms.
+ * @returns A string representing the generated forms.
+ */
+export async function makeForm(spec, maxDepth) {
+    let definitions;
+    MAX_DEPTH = maxDepth ?? MAX_DEPTH;
+    if ('definitions' in spec) {
+        definitions = spec.definitions;
+    }
+    else if ('components' in spec) {
+        definitions = spec.components?.schemas;
+    }
+    else {
+        throw new Error('Cannot find schemas/definitions');
+    }
+    if (!definitions) {
+        throw new Error('Cannot find schemas/definitions');
+    }
+    let body = NEEDED_IMPORTS + '\n\n';
+    for (const [key, value] of Object.entries(definitions)) {
+        if (value) {
+            body += makeDefinition(key, value);
+        }
+    }
+    return await prettier.format(body, { parser: 'typescript', singleQuote: true });
+}
+/**
+ * Creates a form definition for a given OpenAPI definition.
+ * @param definitionName - The name of the definition.
+ * @param definition - The OpenAPI definition object.
+ * @returns A string representing the form definition.
+ */
+function makeDefinition(definitionName, definition) {
+    return `export const ${camelcase(definitionName)}Form = () => new FormGroup({
+      ${makeFieldsBody({ ...definition }, 0)}
+    });\n`;
+}
+/**
+ * Generates the body of fields for a form based on the provided definition.
+ * @param definition - The OpenAPI definition object containing properties.
+ * @param depth - The current depth of recursion.
+ * @returns An array of strings representing the form fields.
+ */
+function makeFieldsBody(definition, depth) {
+    if (depth >= MAX_DEPTH)
+        return [];
+    depth++;
+    return [...extractPropertiesFields(definition, depth), ...extractAllOfFields(definition, depth)];
+}
+/**
+ * Extracts fields from the properties of a given OpenAPI definition.
+ * @param definition - The OpenAPI definition object.
+ * @param depth - The current depth of recursion.
+ * @returns An array of strings representing the form fields.
+ */
+function extractPropertiesFields(definition, depth) {
+    if (!('properties' in definition) || !definition.properties)
+        return [];
+    const fields = [];
+    for (const [fieldName, fieldValue] of Object.entries(definition.properties)) {
+        const field = makeField(fieldName, fieldValue, !!definition.required?.includes(fieldName), depth);
+        if (field !== '') {
+            fields.push(field);
+        }
+    }
+    return fields;
+}
+/**
+ * Extracts fields from the allOf properties of a given OpenAPI definition.
+ * @param definition - The OpenAPI definition object.
+ * @param depth - The current depth of recursion.
+ * @returns An array of strings representing the form fields.
+ */
+function extractAllOfFields(definition, depth) {
+    if (!('allOf' in definition) || !Array.isArray(definition.allOf))
+        return [];
+    const fields = [];
+    const definitionRequired = definition.required ?? [];
+    for (const subSchema of definition.allOf) {
+        if ('$ref' in subSchema) {
+            const refName = subSchema.$ref.split('/').pop();
+            const refSchema = definition.definitions?.[refName] || definition.components?.schemas?.[refName];
+            if (refSchema) {
+                refSchema.required = [...refSchema.required, ...definitionRequired];
+                fields.push(...makeFieldsBody(refSchema, depth));
+            }
+        }
+        else if ('type' in subSchema && subSchema.type === 'object') {
+            subSchema.required = [...(subSchema.required ?? []), ...definitionRequired];
+            fields.push(...makeFieldsBody(subSchema, depth));
+        }
+        else {
+            fields.push(...makeFieldsBody(subSchema, depth));
+        }
+    }
+    return fields;
+}
+/**
+ * Creates a form field for a given OpenAPI property.
+ * @param fieldName - The name of the field.
+ * @param property - The OpenAPI property object.
+ * @param isRequired - Indicates if the field is required.
+ * @param depth - The current depth of recursion.
+ * @returns A string representing the form field.
+ */
+function makeField(fieldName, property, isRequired, depth) {
+    let fieldRepesentation;
+    if (property.allOf) {
+        fieldRepesentation = makeField(fieldName, property.allOf, isRequired, depth);
+    }
+    else if (property.type === 'array') {
+        fieldRepesentation = makeArrayField(fieldName, property, isRequired, depth);
+    }
+    else if (property.type === 'object') {
+        fieldRepesentation = makeObjectField(fieldName, property, isRequired, depth);
+    }
+    else {
+        fieldRepesentation = makePrimitiveField(fieldName, property, isRequired);
+    }
+    return fieldRepesentation;
+}
+/**
+ * Creates a form array field for a given OpenAPI array schema.
+ * @param fieldName - The name of the field.
+ * @param property - The OpenAPI array schema object.
+ * @param isRequired - Indicates if the field is required.
+ * @param depth - The current depth of recursion.
+ * @returns A string representing the form array field.
+ */
+function makeArrayField(fieldName, property, isRequired, depth) {
+    const itemDefinition = property.items;
+    const minItems = property['minItems'] ?? 1;
+    const items = [];
+    if (itemDefinition['type'] === 'object') {
+        for (let i = 0; i <= minItems; i++) {
+            items.push(`new FormGroup({${makeFieldsBody(itemDefinition, depth)}})`);
+        }
+    }
+    else {
+        const _dummyProps = {
+            properties: {
+                dummy: itemDefinition,
+            },
+        };
+        const value = 'default' in _dummyProps.properties.dummy ? `'${_dummyProps.properties.dummy.default}'` : null;
+        for (let i = 1; i <= minItems; i++) {
+            items.push(`new FormControl(${value}, [${makeFieldRules('dummy', _dummyProps, isRequired)}])`);
+        }
+    }
+    return `"${fieldName}": new FormArray([${items.join(',')}])`;
+}
+/**
+ * Creates a form object field for a given OpenAPI object schema.
+ * @param fieldName - The name of the field.
+ * @param property - The OpenAPI object schema object.
+ * @param isRequired - Indicates if the field is required.
+ * @param depth - The current depth of recursion.
+ * @returns A string representing the form object field.
+ */
+function makeObjectField(fieldName, property, isRequired, depth) {
+    const groupBody = makeFieldsBody(property, depth);
+    return `"${fieldName}": new FormGroup({${groupBody}}, [${makeFieldRules(fieldName, property, isRequired)}])`;
+}
+/**
+ * Creates a form control for a primitive field based on its OpenAPI definition.
+ * @param fieldName - The name of the field.
+ * @param property - The OpenAPI property object.
+ * @param isRequired - Indicates if the field is required.
+ * @returns A string representing the form control.
+ */
+function makePrimitiveField(fieldName, property, isRequired) {
+    const value = 'default' in property ? `'${property.default}'` : null;
+    return `"${fieldName}": new FormControl(${value}, [${makeFieldRules(fieldName, property, isRequired)}])`;
+}
+/**
+ * Creates validation rules for a form field based on its OpenAPI definition.
+ * @param fieldName - The name of the field.
+ * @param property - The OpenAPI property object.
+ * @param isRequired - Indicates if the field is required.
+ * @returns A string representing the validation rules.
+ */
+function makeFieldRules(fieldName, property, isRequired) {
+    return rules
+        .map((rule) => rule(fieldName, property, isRequired))
+        .filter((item) => item != '')
+        .join();
+}
+/**
+ * Adds a validation rule for a form field.
+ * @param rule - The validation rule to add.
+ */
+export function addRule(rule) {
+    rules.push(rule);
+}
+/**
+ * Removes a validation rule from the form field rules.
+ * @param rule - The validation rule to remove.
+ */
+export function resetRules() {
+    rules = [...DEFAULT_RULES];
+}
+/**
+ * Generates a file name based on the OpenAPI spec title.
+ * @param swagger - The OpenAPI document.
+ * @returns A string representing the file name or undefined if no title is available.
+ */
+export function makeFileName(swagger) {
+    if (swagger.info?.title) {
+        return `${camelcase(swagger.info.title)}.ts`;
+    }
+}
+/**
+ * Loads an OpenAPI specification from a file or URL.
+ * @param fileOrUrlPath - The path to the OpenAPI spec file or URL.
+ * @returns A promise that resolves to the dereferenced OpenAPI document.
+ */
+export async function loadSpec(fileOrUrlPath) {
+    const parser = new SwaggerParser();
+    return parser.dereference(fileOrUrlPath);
+}

package/dist/index.d.ts

@@ -1,2 +1,3 @@
-export * from './generator-lib';
-export * from './rules';
+export * from './generator-lib';
+export * from './rules';
+export * from './file-utils';

package/dist/index.js

@@ -1,18 +1,3 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./generator-lib"), exports);
-__exportStar(require("./rules"), exports);
+export * from './generator-lib';
+export * from './rules';
+export * from './file-utils';

package/dist/rules.d.ts

@@ -1,28 +1,28 @@
-/**
- * @license
- * Licensed under the MIT License, (“the License”); you may not use this
- * file except in compliance with the License.
- *
- * Copyright (c) 2020 Verizon
- */
-import { OpenAPIV2, OpenAPIV3 } from 'openapi-types';
-export declare type Property = {
-    format?: string;
-    pattern?: string;
-    maxLength?: number;
-    minLength?: number;
-    minimum?: number;
-    maximum?: number;
-};
-export declare type Properties = Record<string, Property>;
-export declare type Rule = (fieldName: string, properties: SchemaProperty, isRequired: boolean) => string;
-export declare type Definitions = OpenAPIV2.DefinitionsObject | Record<string, OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject> | undefined;
-export declare type Definition = OpenAPIV2.DefinitionsObject | OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject;
-export declare type SchemaProperty = OpenAPIV2.SchemaObject | OpenAPIV3.SchemaObject;
-export declare function requiredRule(fieldName: string, property: SchemaProperty, isRequired: boolean): string;
-export declare function patternRule(fieldName: string, property: SchemaProperty): string;
-export declare function minLengthRule(fieldName: string, property: SchemaProperty): string;
-export declare function maxLengthRule(fieldName: string, property: SchemaProperty): string;
-export declare function emailRule(fieldName: string, property: SchemaProperty): string;
-export declare function minimumRule(fieldName: string, property: SchemaProperty): string;
-export declare function maximumRule(fieldName: string, property: SchemaProperty): string;
+/**
+ * @license
+ * Licensed under the MIT License, (“the License”); you may not use this
+ * file except in compliance with the License.
+ *
+ * Copyright (c) 2020 Verizon
+ */
+import { OpenAPIV2, OpenAPIV3 } from 'openapi-types';
+export type Property = {
+    format?: string;
+    pattern?: string;
+    maxLength?: number;
+    minLength?: number;
+    minimum?: number;
+    maximum?: number;
+};
+export type Properties = Record<string, Property>;
+export type Rule = (fieldName: string, properties: SchemaProperty, isRequired: boolean) => string;
+export type Definitions = OpenAPIV2.DefinitionsObject | Record<string, OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject> | undefined;
+export type Definition = OpenAPIV2.DefinitionsObject | OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject;
+export type SchemaProperty = OpenAPIV2.SchemaObject | OpenAPIV3.SchemaObject;
+export declare function requiredRule(fieldName: string, property: SchemaProperty, isRequired: boolean): string;
+export declare function patternRule(fieldName: string, property: SchemaProperty): string;
+export declare function minLengthRule(fieldName: string, property: SchemaProperty): string;
+export declare function maxLengthRule(fieldName: string, property: SchemaProperty): string;
+export declare function emailRule(fieldName: string, property: SchemaProperty): string;
+export declare function minimumRule(fieldName: string, property: SchemaProperty): string;
+export declare function maximumRule(fieldName: string, property: SchemaProperty): string;

package/dist/rules.js

@@ -1,44 +1,35 @@
-"use strict";
-/**
- * @license
- * Licensed under the MIT License, (“the License”); you may not use this
- * file except in compliance with the License.
- *
- * Copyright (c) 2020 Verizon
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.maximumRule = exports.minimumRule = exports.emailRule = exports.maxLengthRule = exports.minLengthRule = exports.patternRule = exports.requiredRule = void 0;
-function hasMetadata(fieldName, property, metadataName) {
-    return property.hasOwnProperty(metadataName);
-}
-function abstractRule(fieldName, property, ruleName) {
-    return hasMetadata(fieldName, property, ruleName) ? `Validators.${ruleName}(${property[ruleName]})` : '';
-}
-function requiredRule(fieldName, property, isRequired) {
-    return isRequired ? `Validators.required` : '';
-}
-exports.requiredRule = requiredRule;
-function patternRule(fieldName, property) {
-    return hasMetadata(fieldName, property, 'pattern') ? `Validators.pattern(/${property['pattern']}/)` : '';
-}
-exports.patternRule = patternRule;
-function minLengthRule(fieldName, property) {
-    return abstractRule(fieldName, property, 'minLength');
-}
-exports.minLengthRule = minLengthRule;
-function maxLengthRule(fieldName, property) {
-    return abstractRule(fieldName, property, 'maxLength');
-}
-exports.maxLengthRule = maxLengthRule;
-function emailRule(fieldName, property) {
-    return property.format === 'email' ? `Validators.email` : '';
-}
-exports.emailRule = emailRule;
-function minimumRule(fieldName, property) {
-    return hasMetadata(fieldName, property, 'minimum') ? `Validators.min(${property['minimum']})` : '';
-}
-exports.minimumRule = minimumRule;
-function maximumRule(fieldName, property) {
-    return hasMetadata(fieldName, property, 'maximum') ? `Validators.max(${property['maximum']})` : '';
-}
-exports.maximumRule = maximumRule;
+/**
+ * @license
+ * Licensed under the MIT License, (“the License”); you may not use this
+ * file except in compliance with the License.
+ *
+ * Copyright (c) 2020 Verizon
+ */
+import { OpenAPIV2, OpenAPIV3 } from 'openapi-types';
+function hasMetadata(fieldName, property, metadataName) {
+    return property.hasOwnProperty(metadataName);
+}
+function abstractRule(fieldName, property, ruleName) {
+    return hasMetadata(fieldName, property, ruleName) ? `Validators.${ruleName}(${property[ruleName]})` : '';
+}
+export function requiredRule(fieldName, property, isRequired) {
+    return isRequired ? `Validators.required` : '';
+}
+export function patternRule(fieldName, property) {
+    return hasMetadata(fieldName, property, 'pattern') ? `Validators.pattern(/${property['pattern']}/)` : '';
+}
+export function minLengthRule(fieldName, property) {
+    return abstractRule(fieldName, property, 'minLength');
+}
+export function maxLengthRule(fieldName, property) {
+    return abstractRule(fieldName, property, 'maxLength');
+}
+export function emailRule(fieldName, property) {
+    return property.format === 'email' ? `Validators.email` : '';
+}
+export function minimumRule(fieldName, property) {
+    return hasMetadata(fieldName, property, 'minimum') ? `Validators.min(${property['minimum']})` : '';
+}
+export function maximumRule(fieldName, property) {
+    return hasMetadata(fieldName, property, 'maximum') ? `Validators.max(${property['maximum']})` : '';
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jmm-devkit/ngx-form-generator",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "Generates an Angular ReactiveForm from a Swagger or OpenAPI definition",
   "main": "dist/generator-lib.js",
   "repository": "github:jmm-devkit/ngx-form-generator",
@@ -25,55 +25,16 @@
     "typescript"
   ],
   "devDependencies": {
-    "@commitlint/cli": "^17.1.2",
-    "@commitlint/config-conventional": "^17.0.3",
-    "@types/camelcase": "^4.1.0",
-    "@types/jasmine": "^4.3.0",
-    "@types/node-fetch": "^2.5.5",
-    "@types/prettier": "^1.19.1",
-    "@types/yaml": "^1.2.0",
-    "@types/yargs": "^17.0.13",
-    "@typescript-eslint/eslint-plugin": "^5.0.0",
-    "@typescript-eslint/parser": "^5.0.0",
-    "commitiquette": "^1.2.1",
-    "commitizen": "^4.2.4",
-    "eslint": "^8.0.1",
-    "eslint-config-prettier": "^6.10.1",
-    "husky": "^7.0.4",
-    "jasmine": "^4.4.0",
-    "lint-staged": "^13.0.3",
-    "openapi-types": "^7.0.1",
-    "typescript": "^4.8.4"
+    "@eslint/js": "^10.0.1",
+    "eslint": "^10.0.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.56.0"
   },
   "dependencies": {
-    "@apidevtools/swagger-parser": "^10.0.2",
-    "camelcase": "^5.0.0",
-    "prettier": "^1.19.1",
-    "ts-morph": "^16.0.0",
-    "yaml": "^2.1.3",
-    "yargs": "^17.6.0"
-  },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged",
-      "prepare-commit-msg": "exec < /dev/tty && git cz --hook || true",
-      "commit-msg": "commitLint -E HUSKY_GIT_PARAMS"
-    }
-  },
-  "lint-staged": {
-    "*.{js,css,json,md}": [
-      "prettier --write",
-      "git add"
-    ],
-    "*.ts": [
-      "eslint --fix",
-      "prettier --write",
-      "git add"
-    ]
-  },
-  "config": {
-    "commitizen": {
-      "path": "commitiquette"
-    }
+    "@apidevtools/swagger-parser": "^12.1.0",
+    "camelcase": "^9.0.0",
+    "openapi-types": "^12.1.3",
+    "prettier": "^3.8.1"
   }
-}
+}