oip-common 0.2.0 → 0.2.1

package/index.d.ts

@@ -584,137 +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;
 }
 interface IframeModuleSettings {
     url?: string | null;
 }
-/** Represents a key-value pair where the key is an integer and the value is a string. */
 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;
 }
 
@@ -853,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>>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oip-common",
-  "version": "0.2.0",
+  "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) || '{}' %>;