page2pdf_server 1.1.1 → 1.1.3

package/src/components/home/splitController.ts

@@ -1,125 +0,0 @@
-import fs from "fs";
-import { OK } from "http-status/lib";
-import { HeadFooter } from "../../types/request/config";
-import { apiResponse } from "../../helpers/apiResponse";
-
-import { RenderPDF } from "../../utils/pdfgen";
-import CONFIG from "../../configEnv";
-import { SplitConfig, SplitPdfFile } from "../../types/request/split";
-import { ConfigRoot, FileTransform } from "@/types";
-// import CONFIG from "@/configEnv";
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const { PDFDocument } = require("pdf-lib");
-
-/**只好拆分多个文件：就为了能够jest运行于单步调试模式啊。
- * __test__/./generatePdf.test.ts问题：jest用Run模式正常，可是若Debug模式单步调试的，.post(`/api/pdf`).send就会提前中止！原因xxxController容不下多个接口函数？
- *  ?估计同一个.ts文件引入的包有动态编译的问题？非得拆分两个文件。
- * */
-export class SplitController {
-  /** node.js对比前端App 太严格了，一点小毛病页不行啊。
-   * @description 生成pdf.
-   * @param {Req} req
-   * @param {Res} res
-   * 正常分解成两大步：task.files每一个文件生成，最后才是task.merge合并(包括页码生成)。
-   * @param next
-   */
-  //仅仅测试的
-  static postMakePdf = async (req: Req, res: Res, next: NextFn) => {
-    try {
-      // const appInfoKey1 = req.query.key as getAppInfoQuery;
-      const task = req.body as ConfigRoot<FileTransform>;
-      task.lay as HeadFooter;
-      //预处理汇总输出的pdf页眉页脚
-      if (task.lay) {
-        const newfoot = "";
-        const formfoot =
-          task.lay.foot &&
-          newfoot.concat(...task.lay.foot).replaceAll(`\\"`, '"');
-        task.footerTemplate = formfoot ?? undefined;
-        const formhead =
-          task.lay.head &&
-          newfoot.concat(...task.lay.head).replaceAll(`\\"`, '"');
-        task.headerTemplate = formhead ?? undefined;
-      }
-      //const homeServices = new HomeServices();
-      //let result = { ["文件名"]: "产生的.pdf" };
-      let result;
-      //若是用RenderPDF.generateSinglePdf(会导致没有等待该函数执行结果就会去执行下一步了，应答res,客户端立刻获得http回答，无等待=异步模式的。还是由客户端主动取消等待为佳。这里死等的；
-      try {
-        //const jobs = generateJobList(urls, pdfs);  分解成多个URL文件多个步骤的情况，可能还有个汇总步骤的：
-        // generateSinglePdf  mergePdfs  pageNoForPdf yeMeiyeJiaoPdf
-        if (
-          (task.merge === undefined || task.merge) &&
-          task.files === undefined &&
-          !task.lay
-        ) {
-          await RenderPDF.mergeAllPdfto(); //特殊的特殊？
-          result = `简易合并输出是: ${CONFIG.APP.MERGE}`;
-        } else {
-          //正常的合并阶段的事情： 前一阶段页眉页脚也不打印了。也要放这里了
-          //if(task.merge===undefined || task.merge)
-          result = await RenderPDF.MergeAllPdfs(task, {});
-        }
-      } catch (e) {
-        result = "算失败了" + e;
-        console.error(e);
-      }
-
-      if (!result || result === "") result = "成功！";
-      res.status(OK).json(apiResponse({ result: result }));
-    } catch (error) {
-      next(error);
-    }
-  };
-
-  /**拆分需要：支持pdf源文件的，抽取部分纸张页生成新文件*/
-  static postSplitPdf = async (req: Req, res: Res, next: NextFn) => {
-    try {
-      //也可能?用CDP:printPDF()来进行部分打印的后保存，就等于拆分pdf；
-      const task = req.body as SplitConfig;
-      task.files as SplitPdfFile[];
-      //输入文件 都是pdf了
-      const srcDoc = await PDFDocument.load(
-        fs.readFileSync(CONFIG.APP.PATH + "/" + task.input),
-      );
-      let result;
-      const allpagesum = await srcDoc.getPages().length;
-      //若是用RenderPDF.generateSinglePdf(会导致没有等待该函数执行结果就会去执行下一步了，应答res,客户端立刻获得http回答，无等待=异步模式的。还是由客户端主动取消等待为佳。这里死等的；
-      try {
-        for (const fileone of task.files) {
-          const oneDoc = await PDFDocument.create();
-          //可能出现例子是 '1-5, 8, 11-13' 类似打印机常见的选择页码范围。
-          const ofstr = fileone.pageRanges;
-          const ranges = ofstr.split(",");
-          for (const range of ranges) {
-            const bgend = range.split("-");
-            const beginp = bgend[0];
-            let endp = bgend[1];
-            if (!endp) {
-              endp = beginp;
-            }
-            //逗号分割开的某一区域 , , 被选定的： 页序数号是从开始的。
-            let i = Number(beginp);
-            const endpage = Number(endp);
-            if (i < 1 || i > allpagesum || endpage < i || endpage > allpagesum)
-              throw new Error("选定的页序号超范围:[" + i + "-" + endpage + "]");
-            for (; i <= endpage; i++) {
-              const [aPage] = await oneDoc.copyPages(srcDoc, [i - 1]);
-              oneDoc.addPage(aPage);
-            }
-          }
-          const name = CONFIG.APP.PATH + "/" + fileone.out + ".pdf";
-          fs.writeFileSync(name, await oneDoc.save());
-        }
-      } catch (e) {
-        result = "算失败了" + e;
-        console.error(e); //这个在最终服务端cmd窗口可输出
-      }
-
-      if (!result || result === "") result = "成功！";
-      res.status(OK).json(apiResponse({ result: result }));
-    } catch (error) {
-      next(error);
-    }
-  };
-}

package/src/components/home/validators.ts

@@ -1,12 +0,0 @@
-import { query } from "express-validator";
-import CONFIG from "../../configEnv";
-
-const appKeys = Object.keys(CONFIG.APP).map((key) => key.toLocaleLowerCase());
-
-export const appKeyValidator = [
-  query("key")
-    .optional()
-    .isString()
-    .isIn(appKeys)
-    .withMessage("`name` should be string type"),
-];

package/src/configEnv/index.ts

@@ -1,62 +0,0 @@
-import pkg from "../../package.json";
-
-// https://github.com/motdotla/dotenv#how-do-i-use-dotenv-with-import
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-require("dotenv").config();
-
-//提取独立的配置文件的设置参数：
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const config = require("config");
-const base_path = config.get("base_path");
-const default_file = config.get("default_file");
-console.log("默认合并输出文件： " + base_path + "/" + default_file + ".pdf");
-
-//pkg.是项目工程的配置；
-const CONFIG = {
-  APP: {
-    NAME: pkg.name,
-    VERSION: pkg.version,
-    VER: `v${pkg.version[0]}`,
-    DESCRIPTION: pkg.description,
-    AUTHORS: pkg.authors,
-    HOST: process.env.APP_HOST,
-    BASE_URL: process.env.API_BASE_URL,
-    PORT: process.env.NODE_ENV === "test" ? 8888 : process.env.PORT || 8080,
-    ENV: process.env.NODE_ENV,
-    PATH: base_path,
-    MERGE: default_file,
-  },
-  SERVER: {
-    TIMEOUT: 60 * 60 * 1000, // 60 *60秒没结果的
-  },
-  LOG: {
-    PATH: process.env.LOGGING_DIR || "logs",
-    LEVEL: process.env.LOGGING_LEVEL || "info",
-    MAX_FILES: process.env.LOGGING_MAX_FILES || 5,
-  },
-  AUTH: {
-    SALT_ROUNDS: process.env.SALT_ROUNDS || "11",
-    ACCESS_TOKEN_EXPIRE: process.env.ACCESS_TOKEN_DURATION || "300000",
-    REFRESH_TOKEN_EXPIRE: process.env.REFRESH_TOKEN_DURATION || "86400000",
-    ACCESS_TOKEN_SALT: process.env.ACCESS_TOKEN_SALT,
-    REFRESH_TOKEN_SALT: process.env.REFRESH_TOKEN_SALT,
-  },
-  AWS: {
-    ACCESS_KEY: process.env.AWS_ACCESS_KEY,
-    SECRET_KEY: process.env.AWS_SECRET_KEY,
-    REGION: process.env.AWS_REGION,
-    S3: {
-      PATH: process.env.S3_BUCKET_PATH,
-      BUCKET_NAME: process.env.S3_BUCKET_NAME,
-    },
-    COGNITO: {
-      USER_POOL_ID: process.env.COGNITO_USER_POOL_ID,
-      CLIENT_ID: process.env.COGNITO_CLIENT_ID,
-    },
-  },
-  EXTERNAL: {
-    API_KEY: process.env.API_KEY,
-  },
-} as const;
-
-export default CONFIG;

package/src/db/home.ts

@@ -1,14 +0,0 @@
-import AppInformation from "../types/response/AppInformation";
-import CONFIG from "../configEnv";
-import { getAppInfoQuery } from "../types/request/home";
-
-export class HomeDAO {
-  get = (key?: getAppInfoQuery): Promise<AppInformation | any> => {
-    if (!key) {
-      return Promise.resolve(CONFIG.APP);
-    }
-    const upperKey = key.toUpperCase() as keyof typeof CONFIG.APP;
-
-    return Promise.resolve({ [upperKey]: CONFIG.APP[upperKey] });
-  };
-}

package/src/helpers/apiResponse.ts

@@ -1,10 +0,0 @@
-import HttpStatus, { OK } from "http-status/lib";
-import { ApiSuccessResponse } from "../types/response";
-
-export const apiResponse = <T>(data?: T): ApiSuccessResponse<T> => {
-  return {
-    status: OK,
-    message: HttpStatus[OK] as string,
-    data,
-  };
-};

package/src/helpers/dataSanitizers.ts

@@ -1,32 +0,0 @@
-import { Result, ValidationChain, validationResult } from "express-validator";
-// @ts-ignore
-import { Middleware as ValidatorMiddleware } from "express-validator/src/base";
-import ValidationError from "./error/ValidationError";
-
-type MultiValidatorChain = ValidatorMiddleware & {
-  run: (req: Request) => Promise<Result>;
-};
-
-const catchValidatorError = (req: Req, _: Res, next: NextFn): void => {
-  const errors = validationResult(req);
-  if (!errors.isEmpty()) {
-    const validationErrors = errors
-      .array()
-      .reduce(
-        (
-          obj: Record<string, string>,
-          error: Record<string, any>,
-        ): Record<string, any> => {
-          obj[error.param] = error.msg;
-          return obj;
-        },
-        {},
-      );
-    throw new ValidationError(validationErrors);
-  }
-  next();
-};
-
-export const sanitizer = (
-  validator: (ValidationChain | MultiValidatorChain)[],
-) => [...validator, catchValidatorError];

package/src/helpers/error/ApiError.ts

@@ -1,25 +0,0 @@
-import HttpStatus, { INTERNAL_SERVER_ERROR } from "http-status/lib";
-
-class APIError extends Error {
-  readonly status: number;
-  readonly message: string;
-  readonly error: any | undefined;
-
-  constructor(message: string | null, error?: any) {
-    super();
-    Object.setPrototypeOf(this, new.target.prototype);
-    this.status = INTERNAL_SERVER_ERROR;
-    this.message = message || (HttpStatus[INTERNAL_SERVER_ERROR] as string);
-    if (error && error instanceof Error) {
-      this.error = {
-        type: error?.name,
-        message: error?.message,
-        stack: error?.stack,
-      };
-    }
-
-    Error.captureStackTrace(this);
-  }
-}
-
-export default APIError;

package/src/helpers/error/ForbiddenError.ts

@@ -1,15 +0,0 @@
-import { FORBIDDEN } from "http-status/lib";
-
-class ForbiddenError {
-  readonly status: number;
-  readonly message: string;
-
-  constructor(message: string) {
-    Object.setPrototypeOf(this, new.target.prototype);
-
-    this.status = FORBIDDEN;
-    this.message = message;
-  }
-}
-
-export default ForbiddenError;

package/src/helpers/error/NotFoundException.ts

@@ -1,15 +0,0 @@
-import HttpStatus, { NOT_FOUND } from "http-status/lib";
-
-class NotFoundException {
-  readonly status: number;
-  readonly message: string;
-
-  constructor() {
-    Object.setPrototypeOf(this, new.target.prototype);
-
-    this.status = NOT_FOUND;
-    this.message = HttpStatus[NOT_FOUND] as string;
-  }
-}
-
-export default NotFoundException;

package/src/helpers/error/TimeOutError.ts

@@ -1,20 +0,0 @@
-import httpStatus, { REQUEST_TIMEOUT } from "http-status/lib";
-import CONFIG from "../../configEnv";
-
-class TimeOutError {
-  readonly status: number;
-  readonly message: string;
-  readonly timeout: string | number;
-  readonly path: string;
-
-  constructor(path: string) {
-    Object.setPrototypeOf(this, new.target.prototype);
-
-    this.status = REQUEST_TIMEOUT;
-    this.message = httpStatus[REQUEST_TIMEOUT] as string;
-    this.timeout = CONFIG.SERVER.TIMEOUT;
-    this.path = path;
-  }
-}
-
-export default TimeOutError;

package/src/helpers/error/UnauthorizedError.ts

@@ -1,15 +0,0 @@
-import HttpStatus, { UNAUTHORIZED } from "http-status/lib";
-
-class UnauthorizedError {
-  readonly status: number;
-  readonly message: string;
-
-  constructor(message: string) {
-    Object.setPrototypeOf(this, new.target.prototype);
-
-    this.status = UNAUTHORIZED;
-    this.message = message || (HttpStatus[UNAUTHORIZED] as string);
-  }
-}
-
-export default UnauthorizedError;

package/src/helpers/error/ValidationError.ts

@@ -1,20 +0,0 @@
-import HttpStatus, { BAD_REQUEST } from "http-status/lib";
-
-class ValidationError extends Error {
-  readonly status: number;
-  readonly message: string;
-  readonly details: Record<string, any>;
-
-  constructor(validationErrors: Record<string, any>) {
-    super();
-    Object.setPrototypeOf(this, new.target.prototype);
-
-    this.status = BAD_REQUEST;
-    this.message = HttpStatus[BAD_REQUEST] as string;
-    this.details = validationErrors;
-
-    Error.captureStackTrace(this);
-  }
-}
-
-export default ValidationError;

package/src/helpers/error/index.ts

@@ -1,15 +0,0 @@
-import APIError from "./ApiError";
-import ValidationError from "./ValidationError";
-import ForbiddenError from "./ForbiddenError";
-import UnauthorizedError from "./UnauthorizedError";
-import NotFoundException from "./NotFoundException";
-import TimeOutError from "./TimeOutError";
-
-export {
-  APIError,
-  ValidationError,
-  ForbiddenError,
-  UnauthorizedError,
-  NotFoundException,
-  TimeOutError,
-};

package/src/helpers/index.ts

@@ -1,2 +0,0 @@
-export { expressPinoLogger, exitLog } from "./loggers";
-export { sanitizer } from "./dataSanitizers";

package/src/helpers/loggers.ts

@@ -1,75 +0,0 @@
-import httpStatus from "http-status/lib";
-import expressPino from "express-pino-logger";
-import { hidePassword } from "../utils/auth";
-
-const { OK, BAD_REQUEST } = httpStatus;
-
-// More info: https://github.com/pinojs/express-pino-logger
-export const expressPinoLogger = () =>
-  expressPino({
-    transport: {
-      target: "pino-pretty",
-      options: {
-        colorize: true,
-        translateTime: true,
-      },
-    },
-    customLogLevel(res, err) {
-      const status = res.statusCode!;
-      if (status >= 400 && status < 500) {
-        return "warn";
-      }
-      if (status >= 500 || err) {
-        return "error";
-      }
-      return "silent";
-    },
-    customErrorMessage: (err) => ` : ${err}`,
-    customSuccessMessage(res) {
-      const status = res.statusCode!;
-      if (status >= 400 && status < 500) {
-        // @ts-ignore
-        return `${status || BAD_REQUEST} : ${httpStatus[status || 400]}`;
-      }
-      if (status >= 500) {
-        // @ts-ignore
-        return `${status} : ${httpStatus[status || 500]}`;
-      }
-      return `${OK} : ${httpStatus[200].toUpperCase()}`;
-    },
-    serializers: {
-      req: (req) => {
-        // console.log('[ R E Q U E S T ] => ', req.raw);
-        const {
-          method,
-          url,
-          headers: { host },
-        } = req;
-        return {
-          origin: host,
-          method,
-          url,
-          query: req.query,
-          params: req.params,
-          body: hidePassword({ ...req.raw.body }),
-        };
-      },
-      res: (res) => {
-        // console.log("[ R E S P O N S E ] => ", res);
-        return {
-          status: res.statusCode,
-        };
-      },
-      err: (err) => `${err.type} : ${err.message}`,
-    },
-  });
-
-export const exitLog = (err: any, evt: string) => {
-  if (err) {
-    process.stdout.write(`\n\n[!ERROR][${evt}] => ${err}\n\n`);
-  } else {
-    process.stdout.write(`\n\n![${evt}] EVENT CAUSE EXIT\n\n`);
-  }
-
-  process.exit(err ? 1 : 0);
-};

package/src/middlewares/errorHandler.ts

@@ -1,52 +0,0 @@
-import { NextFunction, Request, Response } from "express";
-
-import HttpStatus, {
-  NOT_FOUND,
-  INTERNAL_SERVER_ERROR,
-  REQUEST_TIMEOUT,
-} from "http-status/lib";
-import { TimeOutError } from "../helpers/error";
-
-/**
- * @description Error response middleware for 404 not found. This middleware function should be at the very bottom of the stack.
- * @param req Express.Request
- * @param res Express.Response
- * @param _next Express.NextFunction
- */
-export const notFoundError = (
-  req: Request,
-  res: Response,
-  _next: NextFunction,
-) => {
-  res.status(NOT_FOUND).json({
-    error: {
-      code: NOT_FOUND,
-      message: HttpStatus[NOT_FOUND],
-      path: req.originalUrl,
-    },
-  });
-};
-
-/**
- * @description Generic error response middleware for validation and internal server errors.
- * @param {*} err
- * @param {object}   req Express.Request
- * @param {object}   res Express.Response
- * @param {function} next Express.NextFunction
- */
-export const genericErrorHandler = (
-  err: any,
-  req: Request,
-  res: Response,
-  _next: NextFunction,
-) => {
-  let resCode: number = err.status || INTERNAL_SERVER_ERROR;
-  let resBody = err;
-
-  if (err.code === "ETIMEDOUT") {
-    resCode = REQUEST_TIMEOUT;
-    resBody = new TimeOutError(req.originalUrl);
-  }
-
-  res.status(resCode).json(resBody);
-};