npm - page2pdf_server - Versions diffs - 1.0.0 - Mend

page2pdf_server 1.0.0

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.

Files changed (79) hide show

package/.babelrc +3 -0
package/.eslintrc +33 -0
package/.github/ISSUE_TEMPLATE/bug_report.md +28 -0
package/.github/ISSUE_TEMPLATE/feature_request.md +15 -0
package/.github/ISSUE_TEMPLATE/refactoring.md +15 -0
package/.github/PULL_REQUEST_TEMPLATE.md +18 -0
package/.github/stale.yml +17 -0
package/.github/workflows/cd.yml +75 -0
package/.github/workflows/ci.yml +36 -0
package/.husky/pre-commit +6 -0
package/.husky/pre-push +4 -0
package/.idea/codeStyles/Project.xml +58 -0
package/.idea/codeStyles/codeStyleConfig.xml +5 -0
package/.idea/encodings.xml +7 -0
package/.idea/inspectionProfiles/Project_Default.xml +7 -0
package/.idea/modules.xml +8 -0
package/.idea/page2pdf-server.iml +12 -0
package/.idea/tenstack-starter-main.iml +12 -0
package/.idea/vcs.xml +6 -0
package/.prettierrc +8 -0
package/.vscode/settings.json +3 -0
package/LICENSE +18 -0
package/README.md +238 -0
package/__tests__/UrltoPdf/generatePdf.test.ts +207 -0
package/__tests__/UrltoPdf/pdfSplit.test.ts +69 -0
package/__tests__/helpers/index.ts +21 -0
package/__tests__/home.test.ts +77 -0
package/config/default.json +10 -0
package/config/development.json +3 -0
package/config/production.json +3 -0
package/config/test.json +3 -0
package/ecosystem.config.js +41 -0
package/eslintrc.json +14 -0
package/jest.config.js +35 -0
package/nodemon.json +6 -0
package/package.json +105 -0
package/src/CSS/345/205/274/345/256/271/346/200/247.txt +56 -0
package/src/app.ts +41 -0
package/src/components/home/controller.ts +27 -0
package/src/components/home/index.ts +4 -0
package/src/components/home/pdfController.ts +112 -0
package/src/components/home/services.ts +31 -0
package/src/components/home/splitController.ts +124 -0
package/src/components/home/validators.ts +12 -0
package/src/configEnv/index.ts +62 -0
package/src/db/home.ts +14 -0
package/src/helpers/apiResponse.ts +10 -0
package/src/helpers/dataSanitizers.ts +31 -0
package/src/helpers/error/ApiError.ts +25 -0
package/src/helpers/error/ForbiddenError.ts +15 -0
package/src/helpers/error/NotFoundException.ts +15 -0
package/src/helpers/error/TimeOutError.ts +20 -0
package/src/helpers/error/UnauthorizedError.ts +15 -0
package/src/helpers/error/ValidationError.ts +20 -0
package/src/helpers/error/index.ts +15 -0
package/src/helpers/index.ts +2 -0
package/src/helpers/loggers.ts +73 -0
package/src/index.ts +13 -0
package/src/middlewares/errorHandler.ts +52 -0
package/src/new_tab1.mhtml +722 -0
package/src/routes/index.ts +22 -0
package/src/server.ts +30 -0
package/src/testCSS.html +241 -0
package/src/types/global.d.ts +13 -0
package/src/types/request/home.ts +166 -0
package/src/types/request/split.ts +18 -0
package/src/types/response/AppInformation.ts +9 -0
package/src/types/response/index.ts +5 -0
package/src/utils/array.ts +19 -0
package/src/utils/auth.ts +12 -0
package/src/utils/crypt.ts +26 -0
package/src/utils/filter.ts +59 -0
package/src/utils/object.ts +58 -0
package/src/utils/pdfgen.ts +998 -0
package/src/utils/url.ts +54 -0
package/src//346/265/213/350/257/225.txt +241 -0
package/tsconfig.json +41 -0
package/tslint.json +22 -0
package//346/226/207/344/271/246/346/211/223/345/215/260/350/275/254/346/215/242/345/231/250.bat +2 -0

package/src/routes/index.ts ADDED Viewed

@@ -0,0 +1,22 @@
+import { Router } from "express";
+import {
+  HomeController,
+  appKeyValidator,
+  PdfController,
+  SplitController,
+} from "@/components/home";
+import { sanitizer } from "@/helpers";
+const router = Router();
+router.get("/", sanitizer(appKeyValidator), HomeController.getAppInfo);
+//正常都用一个的 post传输的数据量比get大得多；
+//基本都统一入口：
+router.post("/pdf", sanitizer(appKeyValidator), PdfController.postMakePdf);
+//为了支持拆分pdf操作：
+router.post("/split", sanitizer(appKeyValidator), SplitController.postSplitPdf);
+export default router;
+//厂家的文档： https://pdf-lib.js.org/   https://www.npmjs.com/package/pdf-lib

package/src/server.ts ADDED Viewed

@@ -0,0 +1,30 @@
+import { Server, createServer } from "http";
+import e from "express";
+// @ts-ignore
+import config from "config";
+import { exitLog } from "./helpers";
+import CONFIG from "./configEnv";
+//自定义服务端口：
+const server_port = config.get("server_port");
+export const startServer = (app: e.Application): Server => {
+  const httpServer = createServer(app);
+  process
+    .on("SIGINT", () => exitLog(null, "SIGINT"))
+    .on("SIGQUIT", () => exitLog(null, "SIGQUIT"))
+    .on("SIGTERM", () => exitLog(null, "SIGTERM"))
+    .on("uncaughtException", (err) => exitLog(err, "uncaughtException"))
+    .on("beforeExit", () => exitLog(null, "beforeExit"))
+    .on("exit", () => exitLog(null, "exit"));
+  //自定义用server_port替代掉 CONFIG.APP.PORT；
+  return httpServer.listen({ port: server_port }, (): void => {
+    process.stdout.write(`⚙️ Application Environment: ${CONFIG.APP.ENV}\n`);
+    process.stdout.write(`⏱ Started on: ${Date.now()}\n`);
+    process.stdout.write(
+      `🚀 文书打印转换器启动好 http://localhost:${server_port}\n`,
+    );
+  });
+};

package/src/testCSS.html ADDED Viewed

@@ -0,0 +1,241 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta charset="utf-8">
+  <meta name="robots" content="noindex, nofollow">
+  <style>
+      body {
+          padding: 0;
+          margin: 0;
+      }
+      svg:not(:root) {
+          display: block;
+      }
+      .playable-code {
+          background-color: #f4f7f8;
+          border: none;
+          border-left: 6px solid #558abb;
+          border-width: medium medium medium 6px;
+          color: #4d4e53;
+          height: 100px;
+          width: 90%;
+          padding: 10px 10px 0;
+      }
+      .playable-canvas {
+          border: 1px solid #4d4e53;
+          border-radius: 2px;
+      }
+      .playable-buttons {
+          text-align: right;
+          width: 90%;
+          padding: 5px 10px 5px 26px;
+      }
+  </style>
+  <style>
+      fieldset {
+          display: flex;
+          flex-direction: row;
+          justify-content: space-between;
+          gap: 1rem;
+          width: fit-content;
+      }
+      @page toc {
+          size: a4 portrait;
+          @top-middle {
+              content: "Table of contents";
+          }
+      }
+      @page foreword {
+          size: a4 portrait;
+          @top-middle {
+              content: "Foreword";
+          }
+      }
+      @page introduction {
+          size: a4 portrait;
+          @top-middle {
+              content: "Introduction";
+          }
+      }
+      @page conclusion {
+          size: a4 portrait;
+          @top-middle {
+              content: "Conclusion";
+          }
+      }
+      @page chapter {
+          size: a4 landscape;
+          @top-middle {
+              content: "Chapter";
+          }
+      }
+      @media print {
+          fieldset {
+              display: none;
+          }
+          section {
+              font-size: 2rem;
+              font-family: Roboto;
+          }
+          .chapter {
+              border: tomato 2px solid;
+          }
+          [data-print="grouped"] > #toc,
+          [data-print="paged"] > #toc {
+              page: toc;
+              font-family: Courier;
+          }
+          [data-print="grouped"] > #foreword,
+          [data-print="paged"] > #foreword {
+              page: foreword;
+              font-family: Courier;
+          }
+          [data-print="grouped"] > #introduction,
+          [data-print="paged"] > #introduction {
+              page: introduction;
+              font-family: Courier;
+          }
+          [data-print="grouped"] > #conclusion,
+          [data-print="paged"] > #conclusion {
+              page: conclusion;
+              font-family: Courier;
+          }
+          [data-print="grouped"] > .chapter,
+          [data-print="paged"] > .chapter {
+              page: chapter;
+          }
+          [data-print="paged"] > .chapter {
+              border: none;
+              break-after: page;
+          }
+          .chapter > ul {
+              columns: 2;
+          }
+      }
+  </style>
+  <title>page - named_page_example - code sample</title>
+</head>
+<body>
+<!-- print options 文档看 https://developer.mozilla.org/en-US/docs/Web/CSS/page#named_page_example
+   [data-print="paged"] > .chapter {   属性选择符号？
+  -->
+<fieldset id="printStyle">
+  <legend>How would you like to print</legend>
+  <label for="single"
+  ><input type="radio" id="single" name="type" value="single" checked />No
+    Pages</label
+  >
+  <label for="grouped"
+  ><input type="radio" id="grouped" name="type" value="grouped" />Pages with
+    Grouped Chapters</label
+  >
+  <label for="paged"
+  ><input type="radio" id="paged" name="type" value="paged" />Chapters
+    Paged</label
+  >
+  <button id="print">Print</button>
+</fieldset>
+<!-- Content to be printed -->
+<article id="print-area" data-print="single">
+  <section id="toc">
+    <h2>Table of contents</h2>
+    <ul>
+      <li>Foreword</li>
+      <li>Introduction</li>
+      <li>Chapter One - named pages</li>
+      <li>Chapter Two - page orientation</li>
+      <li>Chapter Three - page margins</li>
+      <li>Conclusion</li>
+    </ul>
+  </section>
+  <section id="foreword">
+    <h2>Foreword</h2>
+    <p>
+      This book is all about how the CSS <code>@page</code> at-rule can help
+      with printing HTML books.
+    </p>
+  </section>
+  <section id="introduction">
+    <h2>Introduction</h2>
+    <p>
+      This book is a concept to show how an <em>HTML</em> document can easily be
+      printed out in pages.
+    </p>
+  </section>
+  <section id="chapter1" class="chapter">
+    <h2>Named pages</h2>
+    <p>Lorem ipsum</p>
+  </section>
+  <section id="chapter2" class="chapter">
+    <h2>Page Orientation</h2>
+    <p>Lorem ipsum</p>
+  </section>
+  <section id="chapter3" class="chapter">
+    <h2>Page Margins</h2>
+    <p>There are 16 page margins that can be set:</p>
+    <ul>
+      <li>@top-left-corner</li>
+      <li>@top-left</li>
+      <li>@top-middle</li>
+      <li>@top-right</li>
+      <li>@top-right-corner</li>
+      <li>@left-top</li>
+      <li>@left-middle</li>
+      <li>@left-bottom</li>
+      <li>@right-top</li>
+      <li>@right-middle</li>
+      <li>@right-bottom</li>
+      <li>@bottom-left-corner</li>
+      <li>@bottom-left</li>
+      <li>@bottom-middle</li>
+      <li>@bottom-right</li>
+      <li>@bottom-right-corner</li>
+    </ul>
+    <p>They can be used to show what appears in these parts of the margin</p>
+  </section>
+  <section id="conclusion">
+    <h2>Conclusion</h2>
+    <p>Now go ahead and write books.</p>
+  </section>
+</article>
+<script>
+  const printArea = document.querySelector("#print-area");
+  const printButton = document.querySelector("#print");
+  const printOption = document.querySelector("#printStyle");
+  printOption.addEventListener("change", (event) => {
+    //对调paged single： ?? .dataset.print如何变身 data-print="single"属性值的？？
+    if (event.target.value === "single") {
+      printArea.dataset.print = "paged";
+    } else if (event.target.value === "grouped") {
+      printArea.dataset.print = "grouped";
+    } else {
+      printArea.dataset.print = "single";
+    }
+  });
+  printButton.addEventListener("click", () => {
+    window.print();
+  });
+</script>
+</body>
+</html>

package/src/types/global.d.ts ADDED Viewed

@@ -0,0 +1,13 @@
+import { Request, Response, NextFunction } from "express";
+declare global {
+  type TodoType = any;
+  type Req = Request;
+  type Res = Response;
+  type NextFn = NextFunction;
+  type ResponseData<T> = {
+    opcode: number;
+    message: string;
+    data?: T;
+  };
+}

package/src/types/request/home.ts ADDED Viewed

@@ -0,0 +1,166 @@
+import CONFIG from "@/configEnv";
+export type getAppInfoQuery = `${Lowercase<keyof typeof CONFIG.APP>}`;
+/**一次作业的模型配置；
+ * 若本对象为空{}的话：默认是按照修改时间的顺序简易模式地合并当前工作目录的所有pdf文件。
+ * 若某个URL不正常的，很可能无法触发页面加载完成，导致作业一致无法继续下去，大大超出预期执行时间。URL对应网页若不是一次性加载完成还会陆陆续续修改内容的就是这种情况造成死等长时间没结果。
+ * */
+export interface ConfigRoot<T> {
+  //是否生成合并的pdf：正常情况下， 默认=true进行files输出pdf全部做合并的。 除非files[]也是空的情形。
+  //但若需对任一个URL叠加新页眉页脚的，merge就不能=false的。
+  merge?: boolean;
+  //重定义 合并的pdf文件名, 否则默认名。不需要加 .pdf结尾的
+  name: string;
+  //双面打印的合并输出pdf， 默认=true, 表示合并输出的pdf考虑到双面打印的页眉页脚的布局差异化情况了。
+  doubleSide?: boolean;
+  //统一一整份应该用的页眉页脚
+  //假如files[]里面有些url自己也定义了lay{localSumNo=false}的页眉页脚输出配置，只能忽略掉它们，页码总数不算他们的，页码连续编号也不算它们的占坑:最好都挪到最后面。
+  lay?: HeadFooter;
+  //每一个独立的pdf生成：
+  files: [T];
+  //共用一个浏览器窗口 默认=true
+  singleTab?: boolean;
+  //自动关闭浏览器窗口 默认=false
+  closeTab?: boolean;
+  //下面这5个参数不是前端配置发送过来的，而是lay{}对象预先进行转换后保存的汇总页眉页脚，只能内部使用，并非外部接口参数！Page.printToPDF需要的。
+  headerTemplate?: string;
+  footerTemplate?: string;
+  headerTemplateL?: string;
+  footerTemplateL?: string;
+  //第二阶段页眉页脚生成的浏览器执行窗口的targetId,不可配置。
+  CDPtab?: string;
+}
+/**等待输出的每个独立文件:URL，这些文件可能要合并。
+ * @前提条件 是：每个url独立文件生成的PDF，它的纸张大小必须保证同一个大小尺寸， size: 必须唯一，但是纸张方向在某些约束条件中可以横屏竖屏混合的。
+ * 物理打印机：纸张适配，横竖方向还好能自动调节，size 真实打印纸张尺寸就不好自动处理, 不一样的尺寸?最好拆解pdf。
+ * 标准纸张大小的：静态html内CSS定义横竖纸张方向混合的：用reverseRanges参数设置部分纸张反转纸张方向，pageRanges=''的前提下：配置比如'1-5, 8, 11-13'和landscape参数设置相反方向。
+ * */
+export interface FileTransform {
+  //[必须配置的] 特殊的前缀是 http:// https:// 没有这俩个的都是本地工作目录的文件全名(含文件类型后缀 *.pdf *.*)。
+  //任意的本地文件类型，只要可以被Chrome装载并能够支持打印预览的都可以。http打头的网页必须确保已经登录了，也就是遗留cockies token,不能要求交互登录。本地文件不能要求输入口令。
+  //不支持*.xls *.doc文件；不支持的格式实际在浏览器拖拽窗口后会蜕变成了下载形式的。被加密的文件必须提前解密,网站登录需提前解决。
+  //【特殊问题】若URL网页动态化太离谱，周期性地不间断地更新页面,没法触发加载结束事件的，只能手动在浏览器查看打印另存pdf，然后把手动生成pdf合并进来。Tab切换会主动刷新的也不触发。
+  url: string;
+  //输出本地工作目录的文件名， 不需要加 .pdf结尾的 【注意】如果out为空表示url是pdf的没必要转换的要直接进入合并步骤。
+  //【特别】必须配置唯一性 的本地 工作目录的文件名，同名的被直接覆盖了。
+  out: string;
+  //是否汇总合并阶段省略本url，不合并进去，那就是单独独立的pdf输出了。默认=true是合并进去。 和是否打印页眉页脚或页眉统计页数没有绝对关系的。
+  merge?: boolean;
+  //默认取值都是=true; 第一阶段不会生成页眉页脚的，汇总第二阶段这个参数才会生效！
+  //这里配置displayHeaderFooter优先级最高。
+  //页眉页脚如何分开控制是否打印的： 可以把lay{head，foot}其中一个配置串给设置为null,null就代表不输出。例如head=null就不输出页眉，但是页脚照旧打印的。本url的配置优先于汇总pdf配置。
+  //若ConfigRoot<T>.merge=false那么必然导致FileTransform.merge强制=false，每个独立pdf页码独立的独立都从1开始编号吗还需要打印吗，页眉页脚需要打印吗？这个情况页眉页脚打印的默认值改成false;
+  displayHeaderFooter: boolean;
+  //【特别注意】frNo 可能和 headFrom 配置矛盾。
+  //本url打印：从第几页才开始页眉页脚的打印，#页码同样也是在这之后才可能计数和编号!。默认值headFrom=1：就是第一页就开始打印页眉页脚的。
+  //书本封面页情况的。这个参数有最高优先级。 【注意】和frNo设置相互影响, 没有页眉页脚就失去页码意义了。若真的违反了可能页码不能连续输出的，被隐藏了页码缘故。
+  headFrom?: number;
+  //本url打印后，从本URL输出的第几页开始才进行的页码序号的顺序输出的，前面几页不打印页码(但是页眉页脚要打印)。默认值=1全部都打页码。若frNo=0全部不打页码的。
+  //假如displayHeaderFooter=false也即页码无法显示出来的情况：请申明frNo=0; 不然默认是连续页码的，不打印的也有占用页码的隐藏的连续数字啊。
+  //注意若有配置 headFrom 的要协调好。
+  frNo?: number;
+  //是否对页码支持连续编号：  Continuous numbering 是跟随汇总合并的页码 基数合计。【注意】本配置单个url范围，单个url不能混合本地页码和全局页面两种！
+  //统计页数是否本URL独立自己范围之内进行的汇总计数。比如书本目录有多页的可以独立统计页码序号以及总页数的。默认=false;
+  localSumNo?: boolean;
+  //本url对应的部分应该用的页眉页脚，覆盖掉合并pdf的相对应设置。页面上只能支持输出一次页眉页脚，不重叠做输出。
+  //若lay{localSumNo=false}只能固定支持本url自己内部的页码统计顺序编号，不考虑合并pdf总页数带来的影响的。 还是？预设其它部分的页数统计总数之后？再做偏移页码编写？
+  lay: PartHeadFooter;
+  //前端声明本url在第一阶段打印输出后，生成的pdf应该有几页。 count没有设置的救不会做异常检查的。不是第二阶段的计数：双面情况可能增加空白页
+  count?: number;
+  //双面打印的 默认=true, 表示独立分开输出的pdf文件的：考虑到双面打印的页眉页脚的布局差异化情况了。
+  //合并输出merge=true的情况：该参数无效，要看汇总配置的哪一个 # ConfigRoot<T>{ doubleSide： }字段。
+  doubleSide: boolean;
+  //双面打印的情形：必须确保本URL的第一个页是正好右手边(书本翻页的奇数号页码)开始的位置页。正常第一个URL首页面就是双面打印的右手边位置页；默认值=false不必确保.
+  rightHand: boolean;
+  //页码是罗马数字；论文目录需要的；默认=false阿拉伯数字。"I","II","III","IV","V","VI","VII","VIII","IX" "X"XI"XII"表盘符号
+  //roman只能针对本URL启用；数字转换范围最大支持1到12，超过了便改阿拉伯数字，且只针对pageNumber有效, totalPages不会采用。
+  roman?: boolean;
+  //下面这5个参数不是前端配置发送过来的，而是lay{}对象预先进行转换后保存的汇总页眉页脚，只能内部使用，并非外部接口参数！Page.printToPDF需要的。
+  headerTemplate?: string;
+  footerTemplate?: string;
+  headerTemplateL?: string;
+  footerTemplateL?: string;
+  //第一阶段Url转pdf的浏览器执行窗口的targetId,不可配置。
+  CDPtab?: string;
+}
+/*看 Page.printToPDF（）文档说明的： 可以使用的注入参数:
+  date: formatted print date
+  title: document title
+  url: document location
+  pageNumber: current page number
+  totalPages: total pages in the document
+  For example, <span class=title></span> would generate span containing the title.
+*/
+/**页眉页脚声明；前提条件是页眉页脚htm描述里面：不应该把-NOT_DISPLAY- ${pageNumber} ${totalPages}这三个保留字字符串当作普通文字输出的。
+ * 前端发送数据包时刻，页眉页脚的脚本需要在 HTML转JSON 工具网站 进行转换处理后的；网站地址  https://uutool.cn/html2json/ 转换htm模板后是数组[string]
+ * 实际上也就进行拆分多行字符串拼接数组，还有把html语法中的 ""引号 进行转义 style="position: 变成 style=\\\"position: 处置的。
+ * */
+export interface HeadFooter {
+  //每一个URL独立设置的 页眉 的 : 若是配置值=null  表示不要打印本页眉: 针对本url。
+  //双面打印：右手边位置的,或单面打印使用
+  head?: string | string[] | null;
+  //每一个页 页脚的
+  //每一个URL独立设置的 页脚的 : 若是配置值=null  表示不要打印本页脚的， 针对本url。
+  //双面打印：右手边位置的,或单面打印使用
+  foot?: string | string[] | null; //实际前端发过来却是[string]的也可以啊。
+  /**可注入3个参数"特殊标记字符串"如下： 服务端依据参数来对注入的html进行修改的。
+   * ${pageNumber}
+   * ${totalPages}
+   * -NOT_DISPLAY-
+   * 这三个分别代表 页码 总页数 以及页码<div style=""></div>中的可替代占位位置。-NOT_DISPLAY-在后端要直接替代成display:none;的CSS标记字符串！其它2个替换成数字号码。
+   * */
+  //双面打印：左手边位置的
+  headL?: string | string[] | null;
+  //双面打印：左手边位置的
+  footL?: string | string[] | null;
+}
+/**实际在第二步骤也即汇总阶段：页眉页脚的生成底下的参数size，landscape，reverseRanges,marginLeft,marginRight几个都不会涉及到了。
+ * */
+export interface PartHeadFooter extends HeadFooter {
+  //纸张大小: 纸张大小尺寸+布局方向是自定义系列的：
+  //a5 a4 a3 b5 b4  jis-b5  jis-b4 letter legal ledger auto 等常见的名字， 默认是 "a4 portrait"
+  //中国：默认值改成是 a4 portrait
+  size: string;
+  //W3C标准纸张大小，横着的吗; 但是非标准尺寸的#自定义的没有这个选择参数的！。 默认是 "portrait"
+  landscape: boolean;
+  //背景， 默认 =false
+  printBackground: boolean;
+  //底下的这四个参数默认都=1cm (~0.4 inches)； 若要做配置的必须是英寸为单位的数字, 【单位 注意】
+  marginTop?: number;
+  marginBottom?: number;
+  //就算纸张是横屏的：Chrome生成页眉页脚的位置实际也没牵涉到marginLeft,marginRight;
+  marginLeft?: number;
+  marginRight?: number;
+  //默认全部打印的，#可自定义部分页面输出的。 Paper ranges to print, one based, e.g., '1-5, 8, 11-13'.
+  pageRanges?: string;
+}
+/**配置自定义地非标准纸张尺寸， 横竖纸张要独立配置。
+ * */
+export interface MyPaperSize {
+  //自定义的尺寸名称 ,前端发送数据包时用这个名字 替换通常的 a4 a5 a3等，纸张横的竖的要定义两个标签。
+  name: string;
+  //W3C @page size{}语境中配的描述串。 如下："4in 6in", 前面4英寸宽度的纸张。
+  //{"name":"D8", "css": "4in 6in","w": 4,"h": 6},
+  css: string;
+  //纸张 4 英寸宽度 "w": 4,
+  w: number;
+  //纸张高度： 英寸单位的，必须和css参数确保一致性。
+  h: number;
+}
+//【CDP文档】  https://chromedevtools.github.io/devtools-protocol/tot/Target/

package/src/types/request/split.ts ADDED Viewed

@@ -0,0 +1,18 @@
+/**拆分大的pdf文件，输出部分页数的小的pdf
+ * 支持按pdf纸张页面进行重新排序, 部分提取页数。
+ * */
+export interface SplitConfig {
+  //等待拆分大的df文件名, 需要加 .pdf结尾的；只能是pdf文档！
+  input: string;
+  //每一个独立的pdf生成：
+  files: [SplitPdfFile];
+}
+export interface SplitPdfFile {
+  //定义部分页面输出的。 Paper ranges to print, one based, e.g., '1-5, 8, 11-13'.
+  pageRanges: string;
+  //输出本地工作目录的文件名， 不需要加 .pdf结尾的。
+  //【特别】必须配置唯一性 的本地 工作目录的文件名，同名的被直接覆盖了。
+  //拆分提取的pdf输出页面顺序是依据pageRanges所选定的顺序来输出的，不是原本pdf的顺序。
+  out: string;
+}

package/src/types/response/AppInformation.ts ADDED Viewed

@@ -0,0 +1,9 @@
+/**
+ * Application Information response strucuture.
+ */
+interface AppInformation {
+  NAME: string;
+  VERSION: string;
+}
+export default AppInformation;

package/src/types/response/index.ts ADDED Viewed

@@ -0,0 +1,5 @@
+export interface ApiSuccessResponse<T> {
+  status: number;
+  message: string;
+  data?: T;
+}

package/src/utils/array.ts ADDED Viewed

@@ -0,0 +1,19 @@
+import { differenceWith, isEqual } from "lodash-es";
+export interface ArrayDifference {
+  added: any[];
+  removed: any[];
+}
+/**
+ *
+ * @param {any[]} arr1
+ * @param {any[]} arr2
+ * @returns {ArrayDifference}
+ */
+export const diff = (arr1: any[], arr2: any[]): ArrayDifference => {
+  const added = differenceWith(arr2, arr1, isEqual);
+  const removed = differenceWith(arr1, arr2, isEqual);
+  return { added, removed };
+};

package/src/utils/auth.ts ADDED Viewed

@@ -0,0 +1,12 @@
+/**
+ * @description hide password content with '*'
+ * @param {object} bodyData
+ * @returns bodyData with formatted 'password'
+ */
+export const hidePassword = (bodyData: Record<string, any>) => {
+  if (bodyData.hasOwnProperty("password")) {
+    bodyData.password = "********";
+  }
+  return bodyData;
+};

package/src/utils/crypt.ts ADDED Viewed

@@ -0,0 +1,26 @@
+import bcrypt from "bcrypt";
+import CONFIG from "@/configEnv";
+/**
+ * @description Create a bcrypt hash for a string.
+ * @param {string} value
+ * @returns {Promise<any>}
+ */
+export const hash = async (value: string): Promise<any> => {
+  const saltRounds = parseInt(CONFIG.AUTH.SALT_ROUNDS, 10);
+  return bcrypt.hash(value, saltRounds);
+};
+/**
+ * @description Compare a string with the hash.
+ * @param {string} value
+ * @param {string} hashedValue
+ * @returns {Promise<boolean>}
+ */
+export const compare = async (
+  value: string,
+  hashedValue: string,
+): Promise<boolean> => {
+  return bcrypt.compare(value, hashedValue);
+};

package/src/utils/filter.ts ADDED Viewed

@@ -0,0 +1,59 @@
+/**
+ * Converts empty value to null.
+ *
+ * @param obj
+ * @returns {*}
+ */
+export const emptyToNull = (obj: any): any => {
+  if (isScalarType(obj)) {
+    return obj;
+  }
+  if (Array.isArray(obj)) {
+    return obj.map(emptyToNull);
+  }
+  const result: any = {};
+  for (const key of Object.keys(obj)) {
+    const value = obj[key];
+    if (typeof value === "object") {
+      result[key] = emptyToNull(value);
+    } else {
+      result[key] = nullIfEmpty(value);
+    }
+  }
+  return result;
+};
+/**
+ * Returns if scalar type.
+ *
+ * @param obj
+ * @returns {boolean}
+ */
+const isScalarType = (obj: any) => {
+  return (
+    typeof obj !== "object" ||
+    obj instanceof String ||
+    obj instanceof Number ||
+    obj instanceof Boolean ||
+    obj === null
+  );
+};
+/**
+ * Changes empty value to null.
+ *
+ * @param value
+ * @returns {*}
+ */
+const nullIfEmpty = (value: any) => {
+  if (typeof value !== "string") {
+    return value;
+  }
+  return value.trim() === "" ? null : value;
+};