swaggular 1.0.3 → 1.0.6

package/README.md

@@ -59,7 +59,49 @@ You can configure Swaggular using CLI arguments or a configuration file (e.g., `
 
 ### Configuration File (`SwaggularConfig`)
 
-You can create a `swaggular.config.json` file in your project root to define advanced configurations, such as custom templates, base classes for DTOs, or generic types.
+You can create a `swaggular.config.json` file in your project root to define advanced configurations. Below is the detailed structure of the configuration object.
+
+#### **Properties**
+
+- **`input`** _(optional)_: `string` - Path to the input Swagger/OpenAPI file (e.g., `swagger.json`). If not specified, defaults to the basic input.
+- **`output`** _(optional)_: `string` - Path to the output directory where generated files will be saved. Default: `results`.
+- **`groupingMode`** _(optional)_: `'tags' | 'path'` - Strategy for grouping services.
+  - `'tags'`: Groups operations based on their Swagger tags.
+  - `'path'`: Groups operations based on their URL path segments.
+- **`segmentsToIgnore`** _(optional)_: `string[]` - List of URL segments to ignore when generating service names (e.g., `['api', 'v1']`).
+- **`types`** _(optional)_: `object` - Configuration for type generation and inheritance.
+  - **`extendsFrom`** _(optional)_: `InterfaceData[]` - Defines base classes that generated DTOs should extend if they match the properties.
+  - **`generic`** _(optional)_: `InterfaceData[]` - Defines generic types to replace duplicate generated classes (e.g., `PagedResultDto<T>`).
+- **`templates`** _(optional)_: `object` - Configuration for templates used in generation.
+  - **`service`** _(optional)_: `object` - Service template configuration.
+    - **`path`**: `string` - Path to the internal or custom service template file (e.g., `'templates/angular-service.template'`).
+    - **`httpParamsHandler`** _(optional)_: `string` - Custom logic to handle HTTP parameters (e.g., `'const params = HttpHelper.toHttpParams(${params} || {});'`). The `${params}` is a placeholder for the query parameters, it MUST exist in the string.
+    - **`httpParamsHandlerImport`** _(optional)_: `string` - Import statement for the custom parameters handler (e.g., `'import { HttpHelper } from "@shared/utils";'`).
+
+---
+
+#### **Object Structures**
+
+**`InterfaceData`**
+
+Used in `types.extendsFrom` and `types.generic`.
+
+- **`name`**: `string` - The name of the interface or class.
+- **`imports`**: `string[]` - List of imports required for this interface. It has to be the name of other generated interfaces, e.g. `['SomeProperty']`.
+- **`type`**: `'interface' | 'enum' | 'type'` - The kind of TypeScript structure.
+- **`properties`**: `InterfaceDataProperty[]` - Array of properties belonging to this interface.
+- **`extendsFrom`** _(optional)_: `string[]` - Names of other interfaces this one extends. It has to be the name of other generated interfaces, e.g. `['SomeProperty']`.
+
+**`InterfaceDataProperty`**
+
+Used in `InterfaceData.properties`.
+
+- **`name`**: `string` - The name of the property.
+- **`type`**: `string` - The TypeScript type of the property (e.g., `'string'`, `'number'`, `'T[]'`).
+- **`optional`**: `boolean` - Whether the property is optional (`?`).
+- **`comments`**: `string` - JSDoc comments or other annotations for the property. It must be surrounded by the `/** ... */` .
+
+---
 
 #### Example `swaggular.config.json`
 
@@ -95,6 +137,7 @@ You can create a `swaggular.config.json` file in your project root to define adv
   },
   "templates": {
     "service": {
+      "path": "templates/angular-service.template",
       "httpParamsHandlerImport": "import { HttpHelper } from '@shared/utils/http-helper';",
       "httpParamsHandler": "const params = HttpHelper.toHttpParams(${params} || {});"
     }
@@ -106,7 +149,7 @@ This configuration allows you to:
 
 1. **extendsFrom**: Automatically make generated DTOs extend a base class (e.g., `PagedRequestDto`) if they share the same properties.
 2. **generic**: Automatically detect and use generic types (e.g., `PagedResultDto<T>`) instead of generating duplicate classes like `PagedResultDtoOfUser`.
-3. **templates.service.options**: Customize how HTTP parameters are handled in generated services, allowing you to use your own helper functions.
+3. **templates.service**: Customize how HTTP parameters are handled in generated services, allowing you to use your own helper functions.
 
 ## Development
 

package/dist/renderers/generate-service.js

@@ -210,23 +210,6 @@ function buildMethodName(method, path, groupedPath, usedNames, serviceName) {
             nameParts.push('ById');
         }
     }
-    const normalizedPath = path.toLowerCase();
-    const suffixes = [
-        { pattern: '/all', label: 'All' },
-        { pattern: '/search', label: 'Search' },
-        { pattern: '/stats', label: 'Stats' },
-        { pattern: '/history', label: 'History' },
-        { pattern: '/summary', label: 'Summary' },
-        { pattern: '/details', label: 'Details' },
-    ];
-    for (const suffix of suffixes) {
-        if (normalizedPath.endsWith(suffix.pattern)) {
-            if (!nameParts.join('').endsWith(suffix.label)) {
-                nameParts.push(suffix.label);
-            }
-            break;
-        }
-    }
     let candidateName = (0, string_utils_1.lowerFirst)(nameParts.join(''));
     if (candidateName === 'getById' && !usedNames.includes('get')) {
         candidateName = 'get';

package/dist/utils/build-types.d.ts

@@ -1,2 +1,7 @@
-export declare function buildTypes(masterSchema: any, defaultType?: string): string;
-export declare function switchTypeJson(schema: any): string;
+import { OpenAPIV3 } from 'openapi-types';
+/**
+ * Converts a JSON schema object to a TypeScript type string.
+ * @param schema The JSON schema object or reference object.
+ * @returns The corresponding TypeScript type.
+ */
+export declare function switchTypeJson(schema: OpenAPIV3.ReferenceObject | OpenAPIV3.SchemaObject | undefined): string;

package/dist/utils/build-types.js

@@ -1,44 +1,27 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildTypes = buildTypes;
 exports.switchTypeJson = switchTypeJson;
 const interface_state_1 = require("../core/state/interface-state");
-function buildTypes(masterSchema, defaultType = 'any') {
-    if (!masterSchema)
-        return defaultType;
-    const jsonSchema = masterSchema?.['content']?.['application/json'];
-    if (!jsonSchema) {
-        const formData = masterSchema?.['content']?.['multipart/form-data'];
-        if (formData) {
-            return 'FormData';
-        }
-        return defaultType;
-    }
-    const schema = jsonSchema?.['schema'];
-    if (!schema || Object.keys(schema).length === 0)
-        return defaultType;
-    const ref = schema?.['$ref'];
-    if (ref) {
-        const name = ref.split('/').pop();
-        return interface_state_1.interfaceState.getTypeMapping(name) || name;
-    }
-    return switchTypeJson(schema);
-}
+const type_guard_1 = require("./type-guard");
+/**
+ * Converts a JSON schema object to a TypeScript type string.
+ * @param schema The JSON schema object or reference object.
+ * @returns The corresponding TypeScript type.
+ */
 function switchTypeJson(schema) {
     if (!schema || Object.keys(schema).length === 0)
         return 'any';
-    const ref = schema?.['$ref'];
-    const type = schema?.['type'];
-    const format = schema?.['format'];
-    if (ref) {
-        const name = ref.split('/').pop();
+    if ((0, type_guard_1.isReference)(schema)) {
+        const name = schema.$ref.split('/').pop();
         return interface_state_1.interfaceState.getTypeMapping(name) || name;
     }
+    const type = schema.type;
+    const format = schema.format;
     if (type === 'object') {
         return 'any';
     }
     if (type === 'array') {
-        return switchTypeJson(schema?.['items']) + '[]';
+        return switchTypeJson(schema.items) + '[]';
     }
     if (type === 'number') {
         return 'number';

package/dist/utils/string-utils.d.ts

@@ -1,4 +1,3 @@
-export declare function kebabToCamelCase(str: string): string;
 export declare function kebabToPascalCase(str: string): string;
 export declare function removeAllWhitespace(text: string): string;
 export declare function lowerFirst(str: string): string;

package/dist/utils/string-utils.js

@@ -1,6 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.kebabToCamelCase = kebabToCamelCase;
 exports.kebabToPascalCase = kebabToPascalCase;
 exports.removeAllWhitespace = removeAllWhitespace;
 exports.lowerFirst = lowerFirst;
@@ -8,9 +7,6 @@ exports.upFirst = upFirst;
 exports.toKebabCase = toKebabCase;
 exports.normalizeSegment = normalizeSegment;
 exports.toPascalCase = toPascalCase;
-function kebabToCamelCase(str) {
-    return str.replace(/-([a-z])/g, (_, char) => char.toUpperCase());
-}
 function kebabToPascalCase(str) {
     const camel = str.replace(/-([a-z])/g, (_, char) => char.toUpperCase());
     return camel.charAt(0).toUpperCase() + camel.slice(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "swaggular",
-  "version": "1.0.3",
+  "version": "1.0.6",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "bin": {