oip-common 0.0.31 → 0.0.32

package/templates/http-client.ejs

@@ -1,9 +1,8 @@
 <%
 const { apiConfig, generateResponses, config } = it;
 %>
-
-import { SecurityService } from "oip-common";
-import { LayoutService } from "oip-common";
+import { LayoutService } from "../services/app.layout.service";
+import { SecurityService } from "../services/security.service";
 import { inject, Injectable } from "@angular/core";
 
 export type QueryParamsType = Record<string | number, any>;
@@ -47,6 +46,7 @@ type CancelToken = Symbol | string | number;
 
 export enum ContentType {
     Json = "application/json",
+    JsonApi = "application/vnd.api+json",
     FormData = "multipart/form-data",
     UrlEncoded = "application/x-www-form-urlencoded",
     Text = "text/plain",
@@ -54,20 +54,9 @@ export enum ContentType {
 
 @Injectable({ providedIn: 'root' })
 export class HttpClient<SecurityDataType = unknown> {
-    protected securityService = inject(SecurityService);
-    protected layoutService = inject(LayoutService);
     public baseUrl: string = "<%~ apiConfig.baseUrl %>";
     private securityData: SecurityDataType | null = null;
-    private securityWorker?: ApiConfig<SecurityDataType>["securityWorker"]  =
-      (securityData) => ({
-        headers: {
-          "Accept-language": this.layoutService.language()
-            ? this.layoutService.language()
-            : 'en',
-          "X-Timezone": this.layoutService.timeZone(),
-          Authorization: `Bearer ${securityData}`,
-        },
-      });
+    private securityWorker?: ApiConfig<SecurityDataType>["securityWorker"];
     private abortControllers = new Map<CancelToken, AbortController>();
     private customFetch = (...fetchParams: Parameters<typeof fetch>) => fetch(...fetchParams);
 
@@ -78,10 +67,8 @@ export class HttpClient<SecurityDataType = unknown> {
         referrerPolicy: 'no-referrer',
     }
 
-    constructor() {
-      this.securityService.getAccessToken().subscribe((token) => {
-        this.securityData = token;
-      });
+    constructor(apiConfig: ApiConfig<SecurityDataType> = {}) {
+        Object.assign(this, apiConfig);
     }
 
     public setSecurityData = (data: SecurityDataType | null) => {
@@ -121,9 +108,14 @@ export class HttpClient<SecurityDataType = unknown> {
 
     private contentFormatters: Record<ContentType, (input: any) => any> = {
         [ContentType.Json]: (input:any) => input !== null && (typeof input === "object" || typeof input === "string") ? JSON.stringify(input) : input,
+        [ContentType.JsonApi]: (input:any) => input !== null && (typeof input === "object" || typeof input === "string") ? JSON.stringify(input) : input,
         [ContentType.Text]: (input:any) => input !== null && typeof input !== "string" ? JSON.stringify(input) : input,
-        [ContentType.FormData]: (input: any) =>
-            Object.keys(input || {}).reduce((formData, key) => {
+        [ContentType.FormData]: (input: any) => {
+            if (input instanceof FormData) {
+                return input;
+            }
+
+            return Object.keys(input || {}).reduce((formData, key) => {
                 const property = input[key];
                 formData.append(
                     key,
@@ -134,7 +126,8 @@ export class HttpClient<SecurityDataType = unknown> {
                     `${property}`
                 );
                 return formData;
-            }, new FormData()),
+            }, new FormData());
+        },
         [ContentType.UrlEncoded]: (input: any) => this.toQueryString(input),
     }
 
@@ -193,7 +186,7 @@ export class HttpClient<SecurityDataType = unknown> {
         const requestParams = this.mergeRequestParams(params, secureParams);
         const queryString = query && this.toQueryString(query);
         const payloadFormatter = this.contentFormatters[type || ContentType.Json];
-        let responseFormat = format || requestParams.format;
+        const responseFormat = format || requestParams.format;
 
         return this.customFetch(
         `${baseUrl || this.baseUrl || ""}${path}${queryString ? `?${queryString}` : ""}`,
@@ -207,14 +200,15 @@ export class HttpClient<SecurityDataType = unknown> {
             body: typeof body === "undefined" || body === null ? null : payloadFormatter(body),
         }
         ).then(async (response) => {
-            const r = response.clone() as HttpResponse<T, E>;
+            const r = response as HttpResponse<T, E>;
             r.data = (null as unknown) as T;
             r.error = (null as unknown) as E;
 
             if (typeof E !== undefined && responseFormat === undefined)
               responseFormat = 'json';
 
-            const data = !responseFormat ? r : await response[responseFormat]()
+            const responseToParse = responseFormat ? response.clone() : response;
+            const data = !responseFormat ? r : await responseToParse[responseFormat]()
                 .then((data) => {
                     if (r.ok) {
                         r.data = data;

package/templates/object-field-jsdoc.ejs

@@ -1,18 +1,18 @@
 <%
 const { field, utils } = it;
-const { formatDescription, require, _ } = utils;
+const { formatDescription, escapeJSDocContent, require, _ } = utils;
 
 const comments = _.uniq(
     _.compact([
-        field.title,
-        field.description,
+        field.title && formatDescription(field.title),
+        field.description && formatDescription(field.description),
         field.deprecated && ` * @deprecated`,
-        !_.isUndefined(field.format) && `@format ${field.format}`,
-        !_.isUndefined(field.minimum) && `@min ${field.minimum}`,
-        !_.isUndefined(field.maximum) && `@max ${field.maximum}`,
-        !_.isUndefined(field.pattern) && `@pattern ${field.pattern}`,
+        !_.isUndefined(field.format) && `@format ${escapeJSDocContent(field.format)}`,
+        !_.isUndefined(field.minimum) && `@min ${escapeJSDocContent(field.minimum)}`,
+        !_.isUndefined(field.maximum) && `@max ${escapeJSDocContent(field.maximum)}`,
+        !_.isUndefined(field.pattern) && `@pattern ${escapeJSDocContent(field.pattern)}`,
         !_.isUndefined(field.example) &&
-        `@example ${_.isObject(field.example) ? JSON.stringify(field.example) : field.example}`,
+        `@example ${escapeJSDocContent(_.isObject(field.example) ? JSON.stringify(field.example) : field.example)}`,
     ]).reduce((acc, comment) => [...acc, ...comment.split(/\n/g)], []),
 );
 %>

package/templates/procedure-call.ejs

@@ -48,6 +48,7 @@ const wrapperArgs = _
 // RequestParams["type"]
 const requestContentKind = {
     "JSON": "ContentType.Json",
+    "JSON_API": "ContentType.JsonApi",
     "URL_ENCODED": "ContentType.UrlEncoded",
     "FORM_DATA": "ContentType.FormData",
     "TEXT": "ContentType.Text",
@@ -73,11 +74,13 @@ const describeReturnType = () => {
           return `Promise<AxiosResponse<${type}>>`
         }
         default: {
-          return `Promise<HttpResponse<${type}, ${errorType}>`
+          return `Promise<HttpResponse<${type}, ${errorType}>>`
         }
     }
 }
 
+const isValidIdentifier = (name) => /^[A-Za-z_$][A-Za-z0-9_$]*$/.test(name);
+
 %>
 /**
 <%~ routeDocs.description %>
@@ -87,7 +90,7 @@ const describeReturnType = () => {
 <%~ routeDocs.lines %>
 
  */
-<%~ route.routeName.usage %> = (<%~ wrapperArgs %>)<%~ config.toJS ? `: ${describeReturnType()}` : "" %> =>
+<% 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 %>`,
         method: '<%~ _.upperCase(method) %>',

package/templates/route-docs.ejs

@@ -1,25 +1,32 @@
 <%
 const { config, route, utils } = it;
-const { _, formatDescription, fmtToJSDocLine, pascalCase, require } = utils;
+const { _, formatDescription, escapeJSDocContent, fmtToJSDocLine, pascalCase, require } = utils;
 const { raw, request, routeName } = route;
 
 const jsDocDescription = raw.summary ?
     ` * @description ${formatDescription(raw.summary, true)}` :
     fmtToJSDocLine('No description', { eol: false });
 const jsDocLines = _.compact([
-    _.size(raw.tags) && ` * @tags ${raw.tags.join(", ")}`,
-    ` * @name ${_.camelCase(routeName.usage)}`,
-    ` * @request ${_.upperCase(request.method)}:${raw.route}`,
+    _.size(raw.tags) && ` * @tags ${raw.tags.map((tag) => formatDescription(tag, true)).join(", ")}`,
+    ` * @name ${_.camelCase(escapeJSDocContent(pascalCase(routeName.usage)))}`,
+    raw.summary && ` * @summary ${formatDescription(raw.summary, true)}`,
+    ` * @request ${escapeJSDocContent(_.upperCase(request.method))}:${escapeJSDocContent(raw.route)}`,
     raw.deprecated && ` * @deprecated`,
-    routeName.duplicate && ` * @originalName ${routeName.original}`,
+    routeName.duplicate && ` * @originalName ${escapeJSDocContent(routeName.original)}`,
     routeName.duplicate && ` * @duplicate`,
     request.security && ` * @secure`,
     ...(config.generateResponses && raw.responsesTypes.length
     ? raw.responsesTypes.map(
         ({ type, status, description, isSuccess }) =>
-            ` * @response \`${status}\` \`${_.replace(_.replace(type, /\/\*/g, "\\*"), /\*\//g, "*\\")}\` ${description}`,
+            ` * @response \`${escapeJSDocContent(status)}\` \`${escapeJSDocContent(type)}\` ${formatDescription(description, true)}`,
         )
     : []),
+    ...(raw.links?.length
+    ? raw.links.map(
+        ({ status, name, operationId, operationRef }) =>
+            ` * @link \`${status}.${name}\` ${operationId ? `operationId:${operationId}` : `operationRef:${operationRef}`}`,
+      )
+    : []),
 ]).map(str => str.trimEnd()).join("\n");
 
 return {

package/templates/route-type.ejs

@@ -4,6 +4,7 @@ const { _, pascalCase, require } = utils;
 const { query, payload, pathParams, headers } = route.request;
 
 const routeDocs = includeFile("./route-docs", { config, route, utils });
+const isValidIdentifier = (name) => /^[A-Za-z_$][A-Za-z0-9_$]*$/.test(name);
 const routeNamespace = pascalCase(route.routeName.usage);
 
 %>
@@ -14,7 +15,7 @@ const routeNamespace = pascalCase(route.routeName.usage);
 <%~ routeDocs.lines %>
 
 */
-export namespace <%~ routeNamespace %> {
+export namespace <% if (isValidIdentifier(routeNamespace)) { %><%~ routeNamespace %><% } else { %>"<%~ routeNamespace %>"<% } %> {
   export type RequestParams = <%~ (pathParams && pathParams.type) || '{}' %>;
   export type RequestQuery = <%~ (query && query.type) || '{}' %>;
   export type RequestBody = <%~ (payload && payload.type) || 'never' %>;