jh-be-tools 1.0.47 → 1.0.49

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,5 +1,5 @@
1
- import { AxiosError, AxiosRequestConfig, AxiosResponseHeaders } from 'axios';
2
- import { RouteDef } from '../route-handler/routeCreation';
1
+ import { AxiosError, AxiosRequestConfig, AxiosResponseHeaders, AxiosResponse } from 'axios';
2
+ import { RouteDef } from '../route-handler/routeCreation.js';
3
3
  export interface QueryData {
4
4
  params?: Record<string, string>;
5
5
  query?: AxiosRequestConfig['params'];
@@ -12,9 +12,13 @@ export interface Request {
12
12
  serviceName: string;
13
13
  queryData?: QueryData;
14
14
  }
15
+ export interface ProcessingMethods {
16
+ pre?: (request: QueryData) => Promise<QueryData>;
17
+ post?: (response: AxiosResponse) => AxiosResponse;
18
+ }
15
19
  export interface Error {
16
20
  serviceName: string;
17
21
  status: number;
18
22
  error: AxiosError;
19
23
  }
20
- export declare const request: <Response>(req: Request) => Promise<Response>;
24
+ export declare const request: <Response>(req: Request, processing?: ProcessingMethods) => Promise<Response>;
@@ -1,59 +1,30 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
- Object.defineProperty(o, "default", { enumerable: true, value: v });
15
- }) : function(o, v) {
16
- o["default"] = v;
17
- });
18
- var __importStar = (this && this.__importStar) || (function () {
19
- var ownKeys = function(o) {
20
- ownKeys = Object.getOwnPropertyNames || function (o) {
21
- var ar = [];
22
- for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
- return ar;
24
- };
25
- return ownKeys(o);
26
- };
27
- return function (mod) {
28
- if (mod && mod.__esModule) return mod;
29
- var result = {};
30
- if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
- __setModuleDefault(result, mod);
32
- return result;
33
- };
34
- })();
35
- Object.defineProperty(exports, "__esModule", { value: true });
36
- exports.request = void 0;
37
- const axios_1 = __importStar(require("axios"));
38
- const request = async (req) => {
39
- const { baseUrl, definition, queryData, serviceName } = req;
1
+ import axios, { AxiosError } from 'axios';
2
+ export const request = async (req, processing) => {
3
+ const { baseUrl, definition, serviceName } = req;
4
+ let { queryData } = req;
40
5
  let path = `${baseUrl}${definition.path}`;
41
6
  let func;
7
+ if (processing?.pre) {
8
+ if (!queryData) {
9
+ queryData = {};
10
+ }
11
+ queryData = await processing.pre(queryData);
12
+ }
42
13
  switch (definition.method) {
43
14
  case 'get':
44
15
  if (queryData?.body) {
45
16
  throw Error('Get requests with body are not supported.');
46
17
  }
47
- func = axios_1.default.get;
18
+ func = axios.get;
48
19
  break;
49
20
  case 'post':
50
- func = axios_1.default.post;
21
+ func = axios.post;
51
22
  if (queryData && !queryData?.body) {
52
23
  queryData.body = {};
53
24
  }
54
25
  break;
55
26
  case 'put':
56
- func = axios_1.default.put;
27
+ func = axios.put;
57
28
  if (queryData && !queryData?.body) {
58
29
  queryData.body = {};
59
30
  }
@@ -62,34 +33,38 @@ const request = async (req) => {
62
33
  if (queryData?.body) {
63
34
  throw Error('Delete requests with body are not supported.');
64
35
  }
65
- func = axios_1.default.delete;
36
+ func = axios.delete;
66
37
  break;
67
38
  }
68
39
  if (req.queryData && req.queryData.params) {
69
40
  path = replaceUrlParams(path, req.queryData.params);
70
41
  }
42
+ let response;
71
43
  try {
72
- return await baseQuery(func, path, queryData);
44
+ response = await baseQuery(func, path, queryData);
73
45
  }
74
46
  catch (error) {
75
47
  return errorHandler(error, serviceName);
76
48
  }
49
+ if (processing?.post) {
50
+ response = processing.post(response);
51
+ }
52
+ return response.data;
77
53
  };
78
- exports.request = request;
79
54
  const baseQuery = async (func, path, req) => {
80
55
  const options = {
81
56
  headers: { 'content-type': 'application/json', ...req?.headers },
82
57
  params: req?.query,
83
58
  };
84
59
  if (req?.body) {
85
- return (await func(path, req.body, options)).data;
60
+ return (await func(path, req.body, options));
86
61
  }
87
62
  else {
88
- return (await func(path, options)).data;
63
+ return (await func(path, options));
89
64
  }
90
65
  };
91
66
  const errorHandler = (error, serviceName) => {
92
- if (!(error instanceof axios_1.AxiosError))
67
+ if (!(error instanceof AxiosError))
93
68
  throw error;
94
69
  throw {
95
70
  serviceName: serviceName,
@@ -104,10 +104,11 @@ declare const _default: (import("eslint").Linter.Config<import("eslint").Linter.
104
104
  })[];
105
105
  'import/export': string;
106
106
  quotes: string[];
107
- "prettier/prettier": (string | {
107
+ 'prettier/prettier': (string | {
108
108
  singleQuote: boolean;
109
109
  semi: boolean;
110
110
  useTabs: boolean;
111
+ printWidth: number;
111
112
  })[];
112
113
  semi: string[];
113
114
  indent: string[];
@@ -5,7 +5,7 @@ import { FlatCompat } from '@eslint/eslintrc';
5
5
  import js from '@eslint/js';
6
6
  import typescriptEslint from '@typescript-eslint/eslint-plugin';
7
7
  import tsParser from '@typescript-eslint/parser';
8
- import _import from 'eslint-plugin-import';
8
+ import _import from '@eslint/eslint-plugin-module';
9
9
  import nodePlugin from 'eslint-plugin-n';
10
10
  import prettier from 'eslint-plugin-prettier';
11
11
  import unusedImports from 'eslint-plugin-unused-imports';
@@ -58,10 +58,10 @@ export default [
58
58
  },
59
59
  ],
60
60
  'import/export': 'off',
61
- "quotes": ["off"],
62
- "prettier/prettier": ["error", { "singleQuote": true, "semi": false, useTabs: true }],
63
- "semi": ['error', 'never'],
64
- 'indent': ['error', 'tab'],
61
+ quotes: ['off'],
62
+ 'prettier/prettier': ['error', { singleQuote: true, semi: false, useTabs: true, printWidth: 150 }],
63
+ semi: ['error', 'never'],
64
+ indent: ['error', 'tab'],
65
65
  },
66
66
  },
67
67
  {
@@ -1,40 +1,5 @@
1
1
  #! /usr/bin/env node
2
- "use strict";
3
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
- if (k2 === undefined) k2 = k;
5
- var desc = Object.getOwnPropertyDescriptor(m, k);
6
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
7
- desc = { enumerable: true, get: function() { return m[k]; } };
8
- }
9
- Object.defineProperty(o, k2, desc);
10
- }) : (function(o, m, k, k2) {
11
- if (k2 === undefined) k2 = k;
12
- o[k2] = m[k];
13
- }));
14
- var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
15
- Object.defineProperty(o, "default", { enumerable: true, value: v });
16
- }) : function(o, v) {
17
- o["default"] = v;
18
- });
19
- var __importStar = (this && this.__importStar) || (function () {
20
- var ownKeys = function(o) {
21
- ownKeys = Object.getOwnPropertyNames || function (o) {
22
- var ar = [];
23
- for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
24
- return ar;
25
- };
26
- return ownKeys(o);
27
- };
28
- return function (mod) {
29
- if (mod && mod.__esModule) return mod;
30
- var result = {};
31
- if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
32
- __setModuleDefault(result, mod);
33
- return result;
34
- };
35
- })();
36
- Object.defineProperty(exports, "__esModule", { value: true });
37
- const fs = __importStar(require("fs"));
2
+ import * as fs from "fs";
38
3
  if (!fs.existsSync("./package-data/dist")) {
39
4
  fs.mkdirSync("./dist", { recursive: true });
40
5
  }
package/dist/index.d.ts CHANGED
@@ -1,3 +1,3 @@
1
- export * from './route-handler/routeHandler';
2
- export * from './route-handler/routeCreation';
3
- export * from './api-request/apiRequest';
1
+ export * from './route-handler/routeHandler.js';
2
+ export * from './route-handler/routeCreation.js';
3
+ export * from './api-request/apiRequest.js';
package/dist/index.js CHANGED
@@ -1,19 +1,3 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./route-handler/routeHandler"), exports);
18
- __exportStar(require("./route-handler/routeCreation"), exports);
19
- __exportStar(require("./api-request/apiRequest"), exports);
1
+ export * from './route-handler/routeHandler.js';
2
+ export * from './route-handler/routeCreation.js';
3
+ export * from './api-request/apiRequest.js';
@@ -1,10 +1,11 @@
1
- import { Router } from 'express';
2
- import { RouteSchema } from './routeHandler';
1
+ import { Router, RequestHandler } from 'express';
2
+ import { RouteSchema } from './routeHandler.js';
3
3
  export type RouteMethods = 'get' | 'post' | 'put' | 'delete';
4
4
  export type RouteDef = {
5
5
  method: RouteMethods;
6
6
  path: string;
7
7
  routeSchema: RouteSchema;
8
+ middleware?: RequestHandler[];
8
9
  };
9
10
  export type RouteData = [RouteDef, (req?: any) => any];
10
11
  export declare const createRoutes: (routeData: RouteData[], router: Router) => void;
@@ -1,15 +1,12 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.createRoutes = void 0;
4
- const routeHandler_1 = require("./routeHandler");
1
+ import { routeHandler } from './routeHandler.js';
5
2
  const createRoute = (meta, route) => {
6
3
  return (app) => {
7
- app[meta.method](meta.path, async (req, res) => {
8
- await (0, routeHandler_1.routeHandler)(req, res, route, meta.routeSchema);
4
+ const middlewares = meta.middleware ?? [];
5
+ app[meta.method](meta.path, ...middlewares, async (req, res) => {
6
+ await routeHandler(req, res, route, meta.routeSchema);
9
7
  });
10
8
  };
11
9
  };
12
- const createRoutes = (routeData, router) => {
10
+ export const createRoutes = (routeData, router) => {
13
11
  routeData.forEach((data) => createRoute(...data)(router));
14
12
  };
15
- exports.createRoutes = createRoutes;
@@ -1,20 +1,6 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.routeHandler = void 0;
4
- const routeHandler = async (req, res, fun, schema) => {
5
- if (schema.request) {
6
- try {
7
- await schema.request.parseAsync({
8
- body: req.body,
9
- query: req.query,
10
- params: req.params,
11
- });
12
- }
13
- catch (error) {
14
- console.log(JSON.stringify(error));
15
- return res.status(400).json(error.errors);
16
- }
17
- }
1
+ export const routeHandler = async (req, res, fun, schema) => {
2
+ if (!(await parseRequest(schema, req, res)))
3
+ return;
18
4
  let data;
19
5
  let status;
20
6
  try {
@@ -29,15 +15,38 @@ const routeHandler = async (req, res, fun, schema) => {
29
15
  }
30
16
  return res.status(500).json(error);
31
17
  }
18
+ if (!(await parseResponse(schema, res, data)))
19
+ return;
20
+ res.status(status).json({ data });
21
+ };
22
+ const parseRequest = async (schema, req, res) => {
23
+ if (schema.request) {
24
+ try {
25
+ await schema.request.parseAsync({
26
+ body: req.body,
27
+ query: req.query,
28
+ params: req.params,
29
+ headers: req.headers,
30
+ });
31
+ }
32
+ catch (error) {
33
+ console.log(JSON.stringify(error));
34
+ res.status(400).json(error.errors);
35
+ return false;
36
+ }
37
+ }
38
+ return true;
39
+ };
40
+ const parseResponse = async (schema, res, data) => {
32
41
  if (schema.response) {
33
42
  try {
34
43
  await schema.response.parseAsync({ data });
35
44
  }
36
45
  catch (error) {
37
46
  console.log(JSON.stringify(error));
38
- return res.status(500).json(error);
47
+ res.status(500).json(error.errors);
48
+ return false;
39
49
  }
40
50
  }
41
- res.status(status).json({ data });
51
+ return true;
42
52
  };
43
- exports.routeHandler = routeHandler;
@@ -1 +1 @@
1
- {"root":["../src/index.ts","../src/api-request/apirequest.ts","../src/config/eslint.config.mjs","../src/config/prettier.config.js","../src/create-package-index-files/createpackageindexfiles.ts","../src/route-handler/routecreation.ts","../src/route-handler/routehandler.ts"],"version":"5.8.2"}
1
+ {"root":["../src/index.ts","../src/api-request/apirequest.ts","../src/config/eslint.config.mjs","../src/create-package-index-files/createpackageindexfiles.ts","../src/route-handler/routecreation.ts","../src/route-handler/routehandler.ts"],"version":"5.8.3"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "jh-be-tools",
3
- "version": "1.0.47",
3
+ "version": "1.0.49",
4
4
  "description": "",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -11,28 +11,30 @@
11
11
  "author": "",
12
12
  "license": "ISC",
13
13
  "devDependencies": {
14
+ "@eslint/js": "^9.30.0",
14
15
  "@types/express": "^5.0.1",
15
16
  "@types/node": "^22.13.11",
16
- "typescript": "^5.8.2"
17
+ "eslint": "^9.30.0",
18
+ "typescript": "^5.8.3",
19
+ "typescript-eslint": "^8.35.0"
17
20
  },
18
21
  "dependencies": {
19
- "axios": "^1.8.4",
20
- "express": "^4.21.2",
21
- "zod": "^3.24.2"
22
+ "axios": "^1.1.0",
23
+ "express": "^5.1.0",
24
+ "zod": "^3.25.67"
22
25
  },
23
26
  "peerDependencies": {
24
- "eslint": "^9.23.0",
27
+ "@eslint/compat": "^1.2.4",
28
+ "@eslint/eslintrc": "^3.3.1",
29
+ "@eslint/js": "^9.23.0",
25
30
  "@typescript-eslint/eslint-plugin": "^8.27.0",
26
31
  "@typescript-eslint/parser": "^8.27.0",
32
+ "eslint": "^9.23.0",
27
33
  "eslint-config-prettier": "^10.1.1",
28
- "eslint-plugin-import": "^2.31.0",
29
34
  "eslint-plugin-n": "^17.16.2",
30
35
  "eslint-plugin-node": "^11.1.0",
31
36
  "eslint-plugin-prettier": "^5.2.1",
32
- "eslint-plugin-unused-imports": "^4.1.4",
33
- "@eslint/compat": "^1.2.4",
34
- "@eslint/eslintrc": "^3.3.1",
35
- "@eslint/js": "^9.23.0"
37
+ "eslint-plugin-unused-imports": "^4.1.4"
36
38
  },
37
39
  "bin": {
38
40
  "createPackageIndexFiles": "./dist/create-package-index-files/createPackageIndexFiles.js"
@@ -40,5 +42,6 @@
40
42
  "exports": {
41
43
  "./eslint.config.mjs": "./dist/config/eslint.config.mjs",
42
44
  ".": "./dist/index.js"
43
- }
45
+ },
46
+ "type": "module"
44
47
  }