oip-common 0.0.33 → 0.0.36

package/index.d.ts

@@ -695,6 +695,12 @@ interface FullRequestParams extends Omit<RequestInit, "body"> {
     cancelToken?: CancelToken;
 }
 type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
+interface ApiConfig<SecurityDataType = unknown> {
+    baseUrl?: string;
+    baseApiParams?: Omit<RequestParams, "baseUrl" | "cancelToken" | "signal">;
+    securityWorker?: (securityData: SecurityDataType | null) => Promise<RequestParams | void> | RequestParams | void;
+    customFetch?: typeof fetch;
+}
 type CancelToken = Symbol | string | number;
 declare enum ContentType {
     Json = "application/json",
@@ -704,15 +710,13 @@ declare enum ContentType {
     Text = "text/plain"
 }
 declare class HttpClient<SecurityDataType = unknown> {
-    protected securityService: SecurityService;
-    protected layoutService: LayoutService;
     baseUrl: string;
     private securityData;
     private securityWorker?;
     private abortControllers;
     private customFetch;
     private baseApiParams;
-    constructor();
+    constructor(apiConfig?: ApiConfig<SecurityDataType>);
     setSecurityData: (data: SecurityDataType | null) => void;
     protected encodeQueryParam(key: string, value: any): string;
     protected addQueryParam(query: QueryParamsType, key: string): string;

package/package.json

@@ -1,15 +1,12 @@
 {
   "name": "oip-common",
-  "version": "0.0.33",
+  "version": "0.0.36",
   "description": "A template for cross-platform web applications based on sakai-ng and primeNG",
   "main": "index.js",
   "keywords": [
     "oip",
     "template"
   ],
-  "bin": {
-    "oip-generate-api": "./dist/oip-common/scripts/generate-api.mjs"
-  },
   "author": "Igor Tyulyakov aka g101k",
   "license": "MIT",
   "repository": {

package/scripts/generate-api.mjs

@@ -1,163 +1,147 @@
-#!/usr/bin/env node
-
-import fs from "node:fs";
-import path from "node:path";
-import {generateApi, generateTemplates} from "swagger-typescript-api";
-import {ArgumentParser} from 'argparse';
-
-const parser = new ArgumentParser({
-  description: 'Argparse example'
-});
-
-parser.add_argument('-o', '--output', {help: 'Output path'});
-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'});
-
-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"
-  defaultResponseAsSuccess: false,
-  generateClient: true,
-  useCommonClient: a.use_common_client,
-  generateRouteTypes: false,
-  generateResponses: true,
-  toJS: false,
-  extractRequestParams: true,
-  extractRequestBody: true,
-  extractEnums: true,
-  unwrapResponseData: true,
-  modular: true,
-  prettier: {
-    printWidth: 120,
-    tabWidth: 2,
-    trailingComma: "all",
-    parser: "typescript",
-  },
-  defaultResponseType: "void",
-  singleHttpClient: false,
-  cleanOutput: false,
-  enumNamesAsValues: false,
-  moduleNameFirstTag: true,
-  generateUnionEnums: false,
-  dataContractPrefix: a.data_contract_prefix,
-  typePrefix: "",
-  typeSuffix: "",
-  enumKeyPrefix: "",
-  enumKeySuffix: "",
-  addReadonly: false,
-  sortTypes: false,
-  sortRouters: false,
-  extractingOptions: {
-    requestBodySuffix: ["Payload", "Body", "Input"],
-    requestParamsSuffix: ["Params"],
-    responseBodySuffix: ["Data", "Result", "Output"],
-    responseErrorSuffix: [
-      "Error",
-      "Fail",
-      "Fails",
-      "ErrorData",
-      "HttpError",
-      "BadResponse",
-    ],
-  },
-  /** allow to generate extra files based with this extra templates, see more below */
-  extraTemplates: [],
-  anotherArrayType: false,
-  fixInvalidTypeNamePrefix: "Type",
-  fixInvalidEnumKeyPrefix: "Value",
-  codeGenConstructs: (constructs) => ({
-    ...constructs,
-    RecordType: (key, value) => `MyRecord<key, value>`,
-  }),
-  primitiveTypeConstructs: (constructs) => ({
-    ...constructs,
-    string: {
-      "date-time": "Date",
-    },
-  }),
-  hooks: {
-    onCreateComponent: (component) => {
-    },
-    onCreateRequestParams: (rawType) => {
-    },
-    onCreateRoute: (routeData) => {
-    },
-    onCreateRouteName: (routeNameInfo, rawRouteInfo) => {
-      if (routeNameInfo.usage.startsWith(rawRouteInfo.moduleName)) {
-        const str = routeNameInfo.usage.substring(rawRouteInfo.moduleName.length);
-        routeNameInfo.usage = str[0].toLowerCase() + str.slice(1);
-        routeNameInfo.original = routeNameInfo.usage;
-      }
-      return routeNameInfo;
-    },
-    onFormatRouteName: (routeInfo, templateRouteName) => {
-    },
-    onFormatTypeName: (typeName, rawTypeName, schemaType) => {
-    },
-    onInit: (configuration) => {
-    },
-    onPreParseSchema: (originalSchema, typeName, schemaType) => {
-    },
-    onParseSchema: (originalSchema, parsedSchema) => {
-    },
-    onPrepareConfig: (currentConfiguration) => {
-    },
-  },
-}
-const toKebabCase = (str) =>
-  str &&
-  str
-    .match(/[A-Z]{2,}(?=[A-Z][a-z]+[0-9]*|\b)|[A-Z]?[a-z]+[0-9]*|[A-Z]|[0-9]+/g)
-    .map(x => x.toLowerCase())
-    .join('-');
-
-generateApi(config)
-  .then(async ({files, configuration}) => {
-    for (const f of files) {
-      if (f.fileContent) {
-        if (f.fileName === 'http-client')
-          continue;
-        let dir = path.join(process.cwd(), a.output);
-        if (!fs.existsSync(dir))
-          fs.mkdirSync(dir);
-
-        if (f.fileName === 'data-contracts') {
-          f.fileName = config.dataContractPrefix + f.fileName;
-        } else if (f.fileName.endsWith('http-client')) {
-          // do nothing
-        } else {
-          f.fileName = `${toKebabCase(f.fileName)}.api`;
-        }
-
-        const absolutePath = path.join(dir, `${f.fileName}${f.fileExtension}`);
-        fs.writeFile(absolutePath, f.fileContent, (err) => {
-          if (err) {
-            console.log(err);
-          } else {
-            console.log(`File create: ${f.fileName}${f.fileExtension}`);
-          }
-        });
-      }
-    }
-  })
-  .catch((e) => console.error(e));
-
-/*
-generateTemplates({
-  cleanOutput: false,
-  output: './output/',
-  httpClientType: "fetch",
-  modular: true,
-  silent: false,
-  rewrite: false,
-});
-*/
+import fs from "node:fs";
+import path from "node:path";
+import { generateApi, generateTemplates } from "swagger-typescript-api";
+import { ArgumentParser } from "argparse";
+
+const parser = new ArgumentParser({
+  description: "Argparse example"
+});
+
+parser.add_argument("-o", "--output", { help: "Output path" });
+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" });
+
+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"
+  defaultResponseAsSuccess: false,
+  generateClient: true,
+  useCommonClient: a.use_common_client,
+  generateRouteTypes: false,
+  generateResponses: true,
+  toJS: false,
+  extractRequestParams: true,
+  extractRequestBody: true,
+  extractEnums: true,
+  unwrapResponseData: true,
+  modular: true,
+  prettier: {
+    printWidth: 120,
+    tabWidth: 2,
+    trailingComma: "all",
+    parser: "typescript"
+  },
+  defaultResponseType: "void",
+  singleHttpClient: false,
+  cleanOutput: false,
+  enumNamesAsValues: false,
+  moduleNameFirstTag: true,
+  generateUnionEnums: false,
+  dataContractPrefix: a.data_contract_prefix,
+  typePrefix: "",
+  typeSuffix: "",
+  enumKeyPrefix: "",
+  enumKeySuffix: "",
+  addReadonly: false,
+  sortTypes: false,
+  sortRouters: false,
+  extractingOptions: {
+    requestBodySuffix: ["Payload", "Body", "Input"],
+    requestParamsSuffix: ["Params"],
+    responseBodySuffix: ["Data", "Result", "Output"],
+    responseErrorSuffix: ["Error", "Fail", "Fails", "ErrorData", "HttpError", "BadResponse"]
+  },
+  /** allow to generate extra files based with this extra templates, see more below */
+  extraTemplates: [],
+  anotherArrayType: false,
+  fixInvalidTypeNamePrefix: "Type",
+  fixInvalidEnumKeyPrefix: "Value",
+  codeGenConstructs: (constructs) => ({
+    ...constructs,
+    RecordType: (key, value) => `MyRecord<key, value>`
+  }),
+  primitiveTypeConstructs: (constructs) => ({
+    ...constructs,
+    string: {
+      "date-time": "Date"
+    }
+  }),
+  hooks: {
+    onCreateComponent: (component) => {},
+    onCreateRequestParams: (rawType) => {},
+    onCreateRoute: (routeData) => {},
+    onCreateRouteName: (routeNameInfo, rawRouteInfo) => {
+      if (routeNameInfo.usage.startsWith(rawRouteInfo.moduleName)) {
+        const str = routeNameInfo.usage.substring(rawRouteInfo.moduleName.length);
+        routeNameInfo.usage = str[0].toLowerCase() + str.slice(1);
+        routeNameInfo.original = routeNameInfo.usage;
+      }
+      return routeNameInfo;
+    },
+    onFormatRouteName: (routeInfo, templateRouteName) => {},
+    onFormatTypeName: (typeName, rawTypeName, schemaType) => {},
+    onInit: (configuration) => {},
+    onPreParseSchema: (originalSchema, typeName, schemaType) => {},
+    onParseSchema: (originalSchema, parsedSchema) => {},
+    onPrepareConfig: (currentConfiguration) => {}
+  }
+};
+const toKebabCase = (str) =>
+  str &&
+  str
+    .match(/[A-Z]{2,}(?=[A-Z][a-z]+[0-9]*|\b)|[A-Z]?[a-z]+[0-9]*|[A-Z]|[0-9]+/g)
+    .map((x) => x.toLowerCase())
+    .join("-");
+
+generateApi(config)
+  .then(async ({ files, configuration }) => {
+    let dir = path.join(process.cwd(), a.output);
+    if (!fs.existsSync(dir)) fs.mkdirSync(dir);
+
+    for (const f of files) {
+      if (f.fileContent) {
+        if (a.use_common_client && f.fileName === "http-client") {
+          console.log("Use common http client from oip, skip generate http-client.ts");
+          continue;
+        }
+
+        if (f.fileName === "data-contracts") {
+          f.fileName = config.dataContractPrefix + f.fileName;
+        } else if (f.fileName.endsWith("http-client")) {
+          // do nothing
+        } else {
+          f.fileName = `${toKebabCase(f.fileName)}.api`;
+        }
+
+        const absolutePath = path.join(dir, `${f.fileName}${f.fileExtension}`);
+        fs.writeFile(absolutePath, f.fileContent, (err) => {
+          if (err) {
+            console.log(err);
+          } else {
+            console.log(`File create: ${f.fileName}${f.fileExtension}`);
+          }
+        });
+      }
+    }
+  })
+  .catch((e) => console.error(e));
+
+/*
+generateTemplates({
+  cleanOutput: false,
+  output: './output/',
+  httpClientType: "fetch",
+  modular: true,
+  silent: false,
+  rewrite: false,
+});
+*/

package/templates/api.ejs

@@ -1,3 +1,7 @@
+/* eslint-disable */
+/* tslint:disable */
+// @ts-nocheck
+
 <%
 const { utils, route, config, modelTypes } = it;
 const { _, pascalCase, require } = utils;

package/templates/http-client.ejs

@@ -1,3 +1,7 @@
+/* eslint-disable */
+/* tslint:disable */
+// @ts-nocheck
+
 <%
 const { apiConfig, generateResponses, config } = it;
 %>