oip-common 0.1.8 → 0.2.1

package/index.d.ts

@@ -1,10 +1,10 @@
 import * as i0 from '@angular/core';
-import { OnInit, OnDestroy, WritableSignal, OnChanges, SimpleChanges, Type, Provider, InjectionToken, EventEmitter, Renderer2, EnvironmentProviders, PipeTransform } from '@angular/core';
+import { OnDestroy, OnInit, DestroyRef, WritableSignal, OnChanges, SimpleChanges, Type, Provider, InjectionToken, EventEmitter, Renderer2, EnvironmentProviders, PipeTransform } from '@angular/core';
 import { MessageService, ToastMessageOptions, MenuItem, ConfirmationService, FilterMetadata } from 'primeng/api';
 import { ActivatedRoute, QueryParamsHandling, IsActiveMatchOptions, Params, Router, UrlTree } from '@angular/router';
 import { InterpolationParameters, Translation, TranslationObject, TranslateService } from '@ngx-translate/core';
 import * as rxjs from 'rxjs';
-import { Subscription, Subject, Observable, BehaviorSubject } from 'rxjs';
+import { Observable, BehaviorSubject, Subscription, Subject } from 'rxjs';
 import { LoginResponse, AuthOptions, OidcSecurityService, LogoutAuthOptions, AbstractSecurityStorage, StsConfigHttpLoader } from 'angular-auth-oidc-client';
 import { ContextMenu } from 'primeng/contextmenu';
 import { PaletteDesignToken, Preset } from '@primeuix/themes/types';
@@ -228,6 +228,105 @@ interface SecurityDto {
     roles: string[];
 }
 
+interface PutSecurityDto {
+    id: number;
+    securities: SecurityDto[];
+}
+
+declare class SecurityDataService extends BaseDataService {
+    getSecurity(controller: string, id: number): Promise<SecurityDto[]>;
+    saveSecurity(controller: string, request: PutSecurityDto): Promise<any>;
+    getRealmRoles(): Promise<string[]>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<SecurityDataService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<SecurityDataService>;
+}
+
+declare abstract class SecurityService {
+    abstract auth(): void;
+    abstract logout(): void;
+    abstract isAuthenticated(): Observable<boolean>;
+    abstract getAccessToken(): Observable<string>;
+    abstract isTokenExpired(): Observable<boolean>;
+    abstract getCurrentUser(): any;
+    abstract getCurrentUser$(): Observable<any>;
+    abstract forceRefreshSession(): Observable<LoginResponse>;
+    abstract isAdmin(): boolean;
+    abstract authorize(configId?: string, authOptions?: AuthOptions): void;
+    abstract payload: BehaviorSubject<any>;
+}
+/**
+ * SecurityService extends OidcSecurityService to manage authentication,
+ * token handling, and user role access in an Angular application.
+ *
+ * It provides helper methods for checking authentication, managing tokens,
+ * determining user roles, and performing logout and refresh operations.
+ */
+declare class KeycloakSecurityService extends OidcSecurityService implements OnDestroy, SecurityService {
+    /**
+     * Handles angular OIDC events.
+     */
+    private readonly publicEventsService;
+    /**
+     * Stores the latest login response from checkAuth().
+     */
+    loginResponse: BehaviorSubject<LoginResponse>;
+    /**
+     * Stores the decoded access token payload.
+     */
+    readonly payload: BehaviorSubject<any>;
+    /**
+     * Stores user-specific data from the login response.
+     */
+    private readonly currentUser;
+    /**
+     * Emits access token updates from initial auth check, manual refresh,
+     * and library authentication events.
+     */
+    private accessToken;
+    /**
+     * Initializes service and subscribes to authentication events.
+     * When a 'NewAuthenticationResult' event is received, the `auth` method is called.
+     */
+    constructor();
+    getCurrentUser(): any;
+    getCurrentUser$(): Observable<any>;
+    /**
+     * Returns the ID token for the sign-in.
+     * @returns A string with the id token.
+     */
+    getAccessToken(configId?: string): Observable<string>;
+    /**
+     * Indicates whether the current user has the 'admin' role.
+     *
+     * @returns {boolean} True if the user is an admin, false otherwise.
+     */
+    isAdmin(): boolean;
+    /**
+     * Initiates authentication check and updates login response, user data,
+     * and decoded token payload if authenticated.
+     */
+    auth(): void;
+    /**
+     * Performs logout and clears the local token payload.
+     *
+     * @param {string} [configId] Optional configuration ID for logout.
+     * @param {LogoutAuthOptions} [logoutAuthOptions] Optional logout options.
+     */
+    logout(configId?: string, logoutAuthOptions?: LogoutAuthOptions): void;
+    /**
+     * Completes the BehaviorSubjects when the service is destroyed to avoid memory leaks.
+     */
+    ngOnDestroy(): void;
+    /**
+     * Checks whether the current access token is expired based on the 'exp' claim.
+     *
+     * @returns {Observable<boolean>} Observable that emits true if the token is expired.
+     */
+    isTokenExpired(): Observable<boolean>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<KeycloakSecurityService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<KeycloakSecurityService>;
+}
+
 declare abstract class BaseModuleComponent<TBackendStoreSettings, TLocalStoreSettings> implements OnInit, OnDestroy {
     private static readonly readRight;
     private static readonly editRight;
@@ -235,9 +334,9 @@ declare abstract class BaseModuleComponent<TBackendStoreSettings, TLocalStoreSet
     private isInitialized;
     private moduleInstanceReloadPromise;
     private rightsSubscription?;
-    private readonly destroyRef;
-    private readonly securityDataService;
-    private readonly securityService;
+    protected readonly destroyRef: DestroyRef;
+    protected readonly securityDataService: SecurityDataService;
+    protected readonly securityService: SecurityService;
     /**
      * Provide access to app settings
      */
@@ -419,92 +518,6 @@ declare class SecurityComponent implements OnChanges, OnInit, OnDestroy {
     static ɵcmp: i0.ɵɵComponentDeclaration<SecurityComponent, "security", never, { "id": { "alias": "id"; "required": false; }; "controller": { "alias": "controller"; "required": false; }; }, {}, never, never, true, never>;
 }
 
-declare abstract class SecurityService {
-    abstract auth(): void;
-    abstract logout(): void;
-    abstract isAuthenticated(): Observable<boolean>;
-    abstract getAccessToken(): Observable<string>;
-    abstract isTokenExpired(): Observable<boolean>;
-    abstract getCurrentUser(): any;
-    abstract getCurrentUser$(): Observable<any>;
-    abstract forceRefreshSession(): Observable<LoginResponse>;
-    abstract isAdmin(): boolean;
-    abstract authorize(configId?: string, authOptions?: AuthOptions): void;
-    abstract payload: BehaviorSubject<any>;
-}
-/**
- * SecurityService extends OidcSecurityService to manage authentication,
- * token handling, and user role access in an Angular application.
- *
- * It provides helper methods for checking authentication, managing tokens,
- * determining user roles, and performing logout and refresh operations.
- */
-declare class KeycloakSecurityService extends OidcSecurityService implements OnDestroy, SecurityService {
-    /**
-     * Handles angular OIDC events.
-     */
-    private readonly publicEventsService;
-    /**
-     * Stores the latest login response from checkAuth().
-     */
-    loginResponse: BehaviorSubject<LoginResponse>;
-    /**
-     * Stores the decoded access token payload.
-     */
-    readonly payload: BehaviorSubject<any>;
-    /**
-     * Stores user-specific data from the login response.
-     */
-    private readonly currentUser;
-    /**
-     * Emits access token updates from initial auth check, manual refresh,
-     * and library authentication events.
-     */
-    private accessToken;
-    /**
-     * Initializes service and subscribes to authentication events.
-     * When a 'NewAuthenticationResult' event is received, the `auth` method is called.
-     */
-    constructor();
-    getCurrentUser(): any;
-    getCurrentUser$(): Observable<any>;
-    /**
-     * Returns the ID token for the sign-in.
-     * @returns A string with the id token.
-     */
-    getAccessToken(configId?: string): Observable<string>;
-    /**
-     * Indicates whether the current user has the 'admin' role.
-     *
-     * @returns {boolean} True if the user is an admin, false otherwise.
-     */
-    isAdmin(): boolean;
-    /**
-     * Initiates authentication check and updates login response, user data,
-     * and decoded token payload if authenticated.
-     */
-    auth(): void;
-    /**
-     * Performs logout and clears the local token payload.
-     *
-     * @param {string} [configId] Optional configuration ID for logout.
-     * @param {LogoutAuthOptions} [logoutAuthOptions] Optional logout options.
-     */
-    logout(configId?: string, logoutAuthOptions?: LogoutAuthOptions): void;
-    /**
-     * Completes the BehaviorSubjects when the service is destroyed to avoid memory leaks.
-     */
-    ngOnDestroy(): void;
-    /**
-     * Checks whether the current access token is expired based on the 'exp' claim.
-     *
-     * @returns {Observable<boolean>} Observable that emits true if the token is expired.
-     */
-    isTokenExpired(): Observable<boolean>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<KeycloakSecurityService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<KeycloakSecurityService>;
-}
-
 /**
  * UserService is responsible for retrieving and handling user-related data,
  * including the user's photo and short label for avatar display.
@@ -571,134 +584,58 @@ declare class FooterComponent {
     static ɵcmp: i0.ɵɵComponentDeclaration<FooterComponent, "app-footer", never, {}, {}, never, never, true, never>;
 }
 
-/** Data Transfer Object for creating a new module instance */
 interface AddModuleInstanceDto {
-    /**
-     * The identifier of the module to create an instance of
-     * @format int32
-     */
     moduleId?: number;
-    /** The display label for the module instance */
     label?: string | null;
-    /** The icon identifier for the module instance (optional) */
     icon?: string | null;
-    /**
-     * The parent module instance identifier (optional)
-     * @format int32
-     */
     parentId?: number | null;
-    /** Array of role identifiers that can view this module instance (optional) */
     viewRoles?: string[] | null;
 }
-/** Data Transfer Object for editing an existing module instance */
 interface EditModuleInstanceDto {
-    /**
-     * The identifier of the module instance to edit
-     * @format int32
-     */
     moduleInstanceId?: number;
-    /** The updated display label for the module instance */
     label?: string | null;
-    /** The updated icon identifier for the module instance (optional) */
     icon?: string | null;
-    /**
-     * The updated parent module instance identifier (optional)
-     * @format int32
-     */
     parentId?: number | null;
-    /** Updated array of role identifiers that can view this module instance (optional) */
     viewRoles?: string[] | null;
-    /**
-     * For front compatibility
-     * @format int32
-     */
     moduleId?: number | null;
 }
-/** Represents a key-value pair where the key is an integer and the value is a string. */
+interface IframeModuleSettings {
+    url?: string | null;
+}
 interface IntKeyValueDto {
-    /** @format int32 */
     key?: number;
     value?: string | null;
 }
-/** It module in app */
 interface ModuleDto {
-    /**
-     * Id
-     * @format int32
-     */
     moduleId?: number;
-    /** Name */
     name?: string | null;
-    /** Settings */
     settings?: string | null;
-    /** Securities */
     moduleSecurities?: ModuleSecurityDto[] | null;
 }
-/** Module Instance Dto */
 interface ModuleInstanceDto {
-    /**
-     * Unique identifier for the module instance.
-     * @format int32
-     */
     moduleInstanceId?: number;
-    /**
-     * Identifier for the module.
-     * @format int32
-     */
     moduleId?: number;
-    /** The label for the module instance. */
     label?: string | null;
-    /** Icon associated with the module instance. see https://primeng.org/icons */
     icon?: string | null;
-    /** Route link. */
     routerLink?: string[] | null;
-    /** URL for the module instance. */
     url?: string | null;
-    /** The target. */
     target?: string | null;
-    /** Configuration settings for the module instance. */
     settings?: string | null;
-    /** Child module instances. */
     items?: ModuleInstanceDto[] | null;
-    /** Securities */
     securities?: string[] | null;
-    /**
-     * Identifier for the parent module instance.
-     * @format int32
-     */
     parentId?: number | null;
-    /**
-     * Sort order position for the module instance.
-     * @format int32
-     */
     order?: number;
-    /** Indicates whether this module instance should be displayed as a separator. */
     separator?: boolean;
 }
-/** Module security DTO */
 interface ModuleSecurityDto {
-    /** Right */
     right: string | null;
-    /** Role */
     role: string | null;
 }
 interface DeleteModuleInstanceParams {
-    /**
-     * The unique identifier of the module instance to delete.
-     * @format int32
-     */
     id?: number;
 }
 interface ChangeOrderParams {
-    /**
-     * The identifier of the first module to swap.
-     * @format int32
-     */
     firstModuleId?: number;
-    /**
-     * The identifier of the second module to swap with.
-     * @format int32
-     */
     secondModuleId?: number;
 }
 
@@ -837,86 +774,12 @@ declare class HttpClient<SecurityDataType = unknown> {
 }
 
 declare class MenuApi<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
-    /**
-     * @description Retrieves the menu available to the current authenticated user.
-     *
-     * @tags Menu
-     * @name get
-     * @summary Retrieves the menu available to the current authenticated user.
-     * @request GET:/api/menu/get
-     * @secure
-     * @response `200` `(ModuleInstanceDto)[]` OK
-     */
     get: (params?: RequestParams) => Promise<ModuleInstanceDto[]>;
-    /**
-     * @description Retrieves the admin-specific menu.
-     *
-     * @tags Menu
-     * @name getAdminMenu
-     * @summary Retrieves the admin-specific menu.
-     * @request GET:/api/menu/get-admin-menu
-     * @secure
-     * @response `200` `(ModuleInstanceDto)[]` OK
-     */
     getAdminMenu: (params?: RequestParams) => Promise<ModuleInstanceDto[]>;
-    /**
-     * @description Retrieves all available modules in the system.
-     *
-     * @tags Menu
-     * @name getModules
-     * @summary Retrieves all available modules in the system.
-     * @request GET:/api/menu/get-modules
-     * @secure
-     * @response `200` `(IntKeyValueDto)[]` OK
-     */
     getModules: (params?: RequestParams) => Promise<IntKeyValueDto[]>;
-    /**
-     * @description Adds a new module instance to the system.
-     *
-     * @tags Menu
-     * @name addModuleInstance
-     * @summary Adds a new module instance to the system.
-     * @request POST:/api/menu/add-module-instance
-     * @secure
-     * @response `200` `void` OK
-     * @response `500` `ApiExceptionResponse` Internal Server Error
-     */
     addModuleInstance: (data: AddModuleInstanceDto, params?: RequestParams) => Promise<void>;
-    /**
-     * @description Edits an existing module instance.
-     *
-     * @tags Menu
-     * @name editModuleInstance
-     * @summary Edits an existing module instance.
-     * @request POST:/api/menu/edit-module-instance
-     * @secure
-     * @response `200` `void` OK
-     * @response `500` `ApiExceptionResponse` Internal Server Error
-     */
     editModuleInstance: (data: EditModuleInstanceDto, params?: RequestParams) => Promise<void>;
-    /**
-     * @description Deletes a module instance by its identifier.
-     *
-     * @tags Menu
-     * @name deleteModuleInstance
-     * @summary Deletes a module instance by its identifier.
-     * @request DELETE:/api/menu/delete-module-instance
-     * @secure
-     * @response `200` `void` OK
-     * @response `500` `ApiExceptionResponse` Internal Server Error
-     */
     deleteModuleInstance: (query: DeleteModuleInstanceParams, params?: RequestParams) => Promise<void>;
-    /**
-     * @description Swaps the order positions of two modules in the menu structure.
-     *
-     * @tags Menu
-     * @name changeOrder
-     * @summary Swaps the order positions of two modules in the menu structure.
-     * @request POST:/api/menu/change-order
-     * @secure
-     * @response `200` `void` OK
-     * @response `500` `ApiExceptionResponse` Internal Server Error
-     */
     changeOrder: (query: ChangeOrderParams, params?: RequestParams) => Promise<void>;
     static ɵfac: i0.ɵɵFactoryDeclaration<MenuApi<any>, never>;
     static ɵprov: i0.ɵɵInjectableDeclaration<MenuApi<any>>;
@@ -1453,17 +1316,20 @@ declare class DiscussionComponent implements OnChanges, OnDestroy, OnInit {
     static ɵcmp: i0.ɵɵComponentDeclaration<DiscussionComponent, "discussion", never, { "objectTypeId": { "alias": "objectTypeId"; "required": true; }; "objectId": { "alias": "objectId"; "required": true; }; }, {}, never, never, true, never>;
 }
 
-interface PutSecurityDto {
-    id: number;
-    securities: SecurityDto[];
-}
-
-declare class SecurityDataService extends BaseDataService {
-    getSecurity(controller: string, id: number): Promise<SecurityDto[]>;
-    saveSecurity(controller: string, request: PutSecurityDto): Promise<any>;
-    getRealmRoles(): Promise<string[]>;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SecurityDataService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<SecurityDataService>;
+declare class IframeModuleComponent extends BaseModuleComponent<IframeModuleSettings, IframeModuleSettings> implements OnInit, OnDestroy {
+    private iframe?;
+    private readonly renderer;
+    private readonly translate;
+    protected iframeUrl: string | null;
+    constructor();
+    private set iframeElement(value);
+    private setIframeUrl;
+    private isAllowedIframeUrl;
+    protected onModuleInstanceChange(): Promise<void>;
+    private updateIframeSrc;
+    onIframeError(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<IframeModuleComponent, never>;
+    static ɵcmp: i0.ɵɵComponentDeclaration<IframeModuleComponent, "ng-component", never, {}, {}, never, never, true, never>;
 }
 
 /**
@@ -1589,5 +1455,5 @@ declare class SecurePipe implements PipeTransform {
  */
 declare const httpLoaderAuthFactory: (httpClient: HttpClient$1) => StsConfigHttpLoader;
 
-export { APP_THEME_PRESETS, APP_THEME_PRESETS_MERGE_MODE, AppConfiguratorComponent, AppFloatingConfiguratorComponent, AppLayoutComponent, AppModulesComponent, AppTopbar, AuthGuardService, BaseDataService, BaseModuleComponent, ConfigComponent, ContentType, DEFAULT_OIP_FRONTEND_CONFIG, DbMigrationComponent, DiscussionComponent, ErrorComponent, FooterComponent, HttpClient, KeycloakSecurityService, L10nService, LOGO_COMPONENT_TOKEN, LayoutService, LogoComponent, LogoService, MenuComponent, MenuService, MsgService, NotfoundComponent, NotificationService, OIP_FRONTEND_CONFIG, ProfileComponent, SecurePipe, SecurityComponent, SecurityDataService, SecurityService, SecurityStorageService, SidebarComponent, TableFilterService, TopBarService, UnauthorizedComponent, UserService, httpLoaderAuthFactory, langIntercept, mergeWithDefaults, provideAppThemes, provideLogoComponent, replaceDefaults };
+export { APP_THEME_PRESETS, APP_THEME_PRESETS_MERGE_MODE, AppConfiguratorComponent, AppFloatingConfiguratorComponent, AppLayoutComponent, AppModulesComponent, AppTopbar, AuthGuardService, BaseDataService, BaseModuleComponent, ConfigComponent, ContentType, DEFAULT_OIP_FRONTEND_CONFIG, DbMigrationComponent, DiscussionComponent, ErrorComponent, FooterComponent, HttpClient, IframeModuleComponent, KeycloakSecurityService, L10nService, LOGO_COMPONENT_TOKEN, LayoutService, LogoComponent, LogoService, MenuComponent, MenuService, MsgService, NotfoundComponent, NotificationService, OIP_FRONTEND_CONFIG, ProfileComponent, SecurePipe, SecurityComponent, SecurityDataService, SecurityService, SecurityStorageService, SidebarComponent, TableFilterService, TopBarService, UnauthorizedComponent, UserService, httpLoaderAuthFactory, langIntercept, mergeWithDefaults, provideAppThemes, provideLogoComponent, replaceDefaults };
 export type { AppConfig, AppThemePreset, AppThemePresetMergeMode, LanguageDto, MenuChangeEvent, NoSettingsDto, OipFrontendAppMode, OipFrontendConfig, PutSecurityDto, RequestParams, SecurityDto, TopBarDto };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oip-common",
-  "version": "0.1.8",
+  "version": "0.2.1",
   "description": "A template for cross-platform web applications based on sakai-ng and primeNG",
   "main": "index.js",
   "keywords": [

package/scripts/generate-api.mjs

@@ -12,22 +12,23 @@ parser.add_argument("-i", "--input", { help: "Input swagger file path" });
 parser.add_argument("-t", "--templates", { help: "Templates" });
 parser.add_argument("-d", "--data-contract-prefix", { help: "Data Contract Prefix" });
 parser.add_argument("-c", "--use-common-client", { action: "store_true", help: "Use common http client" });
+parser.add_argument("--disable-jsdoc", { action: "store_true", help: "Disable JSDoc generation" });
 
 let a = parser.parse_args();
 a.data_contract_prefix ??= "";
 
-console.log(a);
 /* NOTE: all fields are optional expect one of `input`, `url`, `spec` */
 
 let config = {
   input: path.resolve(process.cwd(), a.input),
   templates: path.resolve(process.cwd(), a.templates),
-  httpClientType: "fetch", // or "fetch"
+  httpClientType: "fetch",
   defaultResponseAsSuccess: false,
   generateClient: true,
   useCommonClient: a.use_common_client,
   generateRouteTypes: false,
   generateResponses: true,
+  generateJSDoc: !a.disable_jsdoc,
   toJS: false,
   extractRequestParams: true,
   extractRequestBody: true,

package/templates/data-contract-jsdoc.ejs

@@ -2,6 +2,8 @@
 const { data, utils } = it;
 const { formatDescription, escapeJSDocContent, require, _ } = utils;
 
+if (it.config.generateJSDoc === false) return "";
+
 const stringify = (value) => _.isObject(value) ? JSON.stringify(value) : _.isString(value) ? `"${value}"` : value;
 
 const jsDocLines = _.compact([

package/templates/object-field-jsdoc.ejs

@@ -2,6 +2,8 @@
 const { field, utils } = it;
 const { formatDescription, escapeJSDocContent, require, _ } = utils;
 
+if (it.config.generateJSDoc === false) return "";
+
 const comments = _.uniq(
     _.compact([
         field.title && formatDescription(field.title),

package/templates/procedure-call.ejs

@@ -5,7 +5,8 @@ const { _, getInlineParseContent, getParseContent, parseSchema, getComponentByRe
 const { parameters, path, method, payload, query, formData, security, requestParams } = route.request;
 const { type, errorType, contentTypes } = route.response;
 const { HTTP_CLIENT, RESERVED_REQ_PARAMS_ARG_NAMES } = config.constants;
-const routeDocs = includeFile("./route-docs", { config, route, utils });
+const shouldGenerateJSDoc = config.generateJSDoc !== false;
+const routeDocs = shouldGenerateJSDoc ? includeFile("./route-docs", { config, route, utils }) : null;
 const queryName = (query && query.name) || "query";
 const pathParams = _.values(parameters);
 const pathParamsNames = _.map(pathParams, "name");
@@ -82,6 +83,7 @@ const describeReturnType = () => {
 const isValidIdentifier = (name) => /^[A-Za-z_$][A-Za-z0-9_$]*$/.test(name);
 
 %>
+<% if (shouldGenerateJSDoc) { %>
 /**
 <%~ routeDocs.description %>
 
@@ -90,6 +92,7 @@ const isValidIdentifier = (name) => /^[A-Za-z_$][A-Za-z0-9_$]*$/.test(name);
 <%~ routeDocs.lines %>
 
  */
+<% } %>
 <% if (isValidIdentifier(route.routeName.usage)) { %><%~ route.routeName.usage %><% } else { %>"<%~ route.routeName.usage %>"<% } %> = (<%~ wrapperArgs %>)<%~ config.toJS ? `: ${describeReturnType()}` : "" %> =>
     <%~ config.singleHttpClient ? 'this.http.request' : 'this.request' %><<%~ type %>, <%~ errorType %>>({
         path: `<%~ path %>`,

package/templates/route-type.ejs

@@ -3,18 +3,21 @@ const { route, utils, config } = it;
 const { _, pascalCase, require } = utils;
 const { query, payload, pathParams, headers } = route.request;
 
-const routeDocs = includeFile("./route-docs", { config, route, utils });
+const shouldGenerateJSDoc = config.generateJSDoc !== false;
+const routeDocs = shouldGenerateJSDoc ? includeFile("./route-docs", { config, route, utils }) : null;
 const isValidIdentifier = (name) => /^[A-Za-z_$][A-Za-z0-9_$]*$/.test(name);
 const routeNamespace = pascalCase(route.routeName.usage);
 
 %>
 
+<% if (shouldGenerateJSDoc) { %>
 /**
 <%~ routeDocs.description %>
 
 <%~ routeDocs.lines %>
 
 */
+<% } %>
 export namespace <% if (isValidIdentifier(routeNamespace)) { %><%~ routeNamespace %><% } else { %>"<%~ routeNamespace %>"<% } %> {
   export type RequestParams = <%~ (pathParams && pathParams.type) || '{}' %>;
   export type RequestQuery = <%~ (query && query.type) || '{}' %>;