@pdfme/generator 2.2.0 → 3.0.0-beta.1

package/dist/types/src/builtInRenderer.d.ts

@@ -0,0 +1,3 @@
+import type { PDFRenderer } from './types';
+declare const renderer: PDFRenderer;
+export default renderer;

package/dist/types/src/index.d.ts

@@ -1,5 +1,2 @@
 import generate from './generate.js';
-import { BLANK_PDF, DEFAULT_FONT_VALUE, isTextSchema, isImageSchema, isBarcodeSchema, checkTemplate, checkUIProps, checkPreviewProps, checkDesignerProps, checkGenerateProps, validateBarcodeInput } from '@pdfme/common';
-import type { Lang, Size, Alignment, SchemaType, BarCodeType, TextSchema, ImageSchema, BarcodeSchema, Schema, SchemaForUI, Font, BasePdf, Template, CommonProps, GeneratorOptions, GenerateProps, UIOptions, UIProps, PreviewProps, DesignerProps } from '@pdfme/common';
-export { generate, BLANK_PDF, DEFAULT_FONT_VALUE, isTextSchema, isImageSchema, isBarcodeSchema, checkTemplate, checkUIProps, checkPreviewProps, checkDesignerProps, checkGenerateProps, validateBarcodeInput, };
-export type { Lang, Size, Alignment, SchemaType, BarCodeType, TextSchema, ImageSchema, BarcodeSchema, Schema, SchemaForUI, Font, BasePdf, Template, CommonProps, GeneratorOptions, GenerateProps, UIOptions, UIProps, PreviewProps, DesignerProps, };
+export { generate };

package/dist/types/src/pdfUtils.d.ts

@@ -0,0 +1,15 @@
+import { PDFPage, PDFDocument, PDFEmbeddedPage } from '@pdfme/pdf-lib';
+import { BasePdf } from '@pdfme/common';
+import type { EmbedPdfBox } from './types';
+export declare const getEmbeddedPagesAndEmbedPdfBoxes: (arg: {
+    pdfDoc: PDFDocument;
+    basePdf: BasePdf;
+}) => Promise<{
+    embeddedPages: PDFEmbeddedPage[];
+    embedPdfBoxes: EmbedPdfBox[];
+}>;
+export declare const drawEmbeddedPage: (arg: {
+    page: PDFPage;
+    embeddedPage: PDFEmbeddedPage;
+    embedPdfBox: EmbedPdfBox;
+}) => void;

package/dist/types/src/types.d.ts

@@ -0,0 +1,25 @@
+import type { Schema, PDFRenderProps } from '@pdfme/common';
+export type PDFRender = (arg: PDFRenderProps<Schema>) => Promise<void>;
+export interface PDFRenderer {
+    [key: string]: PDFRender | undefined;
+}
+export type EmbedPdfBox = {
+    mediaBox: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    bleedBox: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    trimBox: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdfme/generator",
-  "version": "2.2.0",
+  "version": "3.0.0-beta.1",
   "sideEffects": false,
   "author": "hand-dot",
   "license": "MIT",
@@ -43,24 +43,21 @@
     "test": "jest",
     "lint:watch": "tsc -w --noEmit",
     "test:watch": "jest --coverage --watch",
-    "prune": "ts-prune src"
+    "prune": "ts-prune src",
+    "prettier": "prettier --write 'src/**/*.ts'"
   },
   "dependencies": {
     "@pdfme/pdf-lib": "^1.17.3",
     "atob": "^2.1.2",
-    "bwip-js": "^3.2.2",
     "fontkit": "^2.0.2"
   },
   "devDependencies": {
     "@pdfme/common": "file:../common",
-    "@types/bwip-js": "^3.0.0",
-    "@types/pngjs": "^6.0.1",
-    "jsqr": "^1.4.0",
-    "pdf2json": "^2.0.0",
-    "pngjs": "^6.0.0"
+    "@pdfme/schemas": "file:../schemas",
+    "pdf2json": "^2.0.0"
   },
   "peerDependencies": {
-    "@pdfme/common": "^2.1.0"
+    "@pdfme/common": "latest"
   },
   "jest": {
     "resolver": "ts-jest-resolver",

package/src/builtInRenderer.ts

@@ -0,0 +1,5 @@
+import { text } from '@pdfme/schemas';
+import type { PDFRenderer, PDFRender } from './types';
+
+const renderer: PDFRenderer = { text: text.pdf as PDFRender };
+export default renderer;

package/src/generate.ts

@@ -1,57 +1,46 @@
-import { PDFDocument } from '@pdfme/pdf-lib';
+import * as pdfLib from '@pdfme/pdf-lib';
 import * as fontkit from 'fontkit';
-import type {
-  Font,
-  GenerateProps,
-  SchemaInputs,
-  Template,
-} from '@pdfme/common';
-import {
-  getDefaultFont,
-  getFallbackFontName,
-  checkGenerateProps,
-} from '@pdfme/common';
-import {
-  getEmbeddedPagesAndEmbedPdfBoxes,
-  drawInputByTemplateSchema,
-  drawEmbeddedPage,
-  embedAndGetFontObj,
-  InputImageCache,
-} from './helper.js';
-import { TOOL_NAME } from './constants.js';
-
-const preprocessing = async (arg: { inputs: SchemaInputs[]; template: Template; font: Font }) => {
-  const { template, font } = arg;
+import type { GenerateProps, Template } from '@pdfme/common';
+import { checkGenerateProps } from '@pdfme/common';
+import type { PDFRenderer } from './types';
+import builtInRenderer from './builtInRenderer';
+import { drawEmbeddedPage, getEmbeddedPagesAndEmbedPdfBoxes } from './pdfUtils';
+import { TOOL_NAME } from './constants';
+
+const preprocessing = async ({ template }: { template: Template }) => {
   const { basePdf } = template;
-  const fallbackFontName = getFallbackFontName(font);
 
-  const pdfDoc = await PDFDocument.create();
+  const pdfDoc = await pdfLib.PDFDocument.create();
   // @ts-ignore
   pdfDoc.registerFontkit(fontkit);
 
-  const pdfFontObj = await embedAndGetFontObj({ pdfDoc, font });
-
   const pagesAndBoxes = await getEmbeddedPagesAndEmbedPdfBoxes({ pdfDoc, basePdf });
   const { embeddedPages, embedPdfBoxes } = pagesAndBoxes;
 
-  return { pdfDoc, pdfFontObj, fallbackFontName, embeddedPages, embedPdfBoxes };
+  return { pdfDoc, embeddedPages, embedPdfBoxes };
 };
 
-const postProcessing = (pdfDoc: PDFDocument) => {
+const postProcessing = ({ pdfDoc }: { pdfDoc: pdfLib.PDFDocument }) => {
   pdfDoc.setProducer(TOOL_NAME);
   pdfDoc.setCreator(TOOL_NAME);
 };
 
 const generate = async (props: GenerateProps) => {
   checkGenerateProps(props);
-  const { inputs, template, options = {} } = props;
-  const { font = getDefaultFont() } = options;
-  const { schemas } = template;
+  const { inputs, template, options = {}, plugins = {} } = props;
+
+  const { pdfDoc, embeddedPages, embedPdfBoxes } = await preprocessing({ template });
+
+  const customRenderer = Object.entries(plugins).reduce(
+    (acc, [key, { pdf }]) => Object.assign(acc, { [key]: pdf }),
+    {} as PDFRenderer
+  );
 
-  const preRes = await preprocessing({ inputs, template, font });
-  const { pdfDoc, pdfFontObj, fallbackFontName, embeddedPages, embedPdfBoxes } = preRes;
+  const rendererRegistry: PDFRenderer =
+    Object.keys(customRenderer).length > 0 ? customRenderer : builtInRenderer;
+
+  const _cache = new Map();
 
-  const inputImageCache: InputImageCache = {};
   for (let i = 0; i < inputs.length; i += 1) {
     const inputObj = inputs[i];
     const keys = Object.keys(inputObj);
@@ -65,24 +54,25 @@ const generate = async (props: GenerateProps) => {
       drawEmbeddedPage({ page, embeddedPage, embedPdfBox });
       for (let l = 0; l < keys.length; l += 1) {
         const key = keys[l];
-        const schema = schemas[j];
-        const templateSchema = schema[key];
-        const input = inputObj[key];
-        const fontSetting = { font, pdfFontObj, fallbackFontName };
-
-        await drawInputByTemplateSchema({
-          input,
-          templateSchema,
-          pdfDoc,
-          page,
-          fontSetting,
-          inputImageCache,
-        });
+        const schemaObj = template.schemas[j];
+        const schema = schemaObj[key];
+        const value = inputObj[key];
+
+        if (!schema || !value) {
+          continue;
+        }
+
+        const render = rendererRegistry[schema.type];
+        if (!render) {
+          throw new Error(`[@pdfme/generator] Renderer for type ${schema.type} not found.
+Check this document: https://pdfme.com/docs/custom-schemas`);
+        }
+        await render({ value, schema, pdfLib, pdfDoc, page, options, _cache });
       }
     }
   }
 
-  postProcessing(pdfDoc);
+  postProcessing({ pdfDoc });
 
   return pdfDoc.save();
 };

package/src/index.ts

@@ -1,73 +1,3 @@
 import generate from './generate.js';
-import {
-  BLANK_PDF,
-  DEFAULT_FONT_VALUE,
-  isTextSchema,
-  isImageSchema,
-  isBarcodeSchema,
-  checkTemplate,
-  checkUIProps,
-  checkPreviewProps,
-  checkDesignerProps,
-  checkGenerateProps,
-  validateBarcodeInput,
-} from '@pdfme/common';
-import type {
-  Lang,
-  Size,
-  Alignment,
-  SchemaType,
-  BarCodeType,
-  TextSchema,
-  ImageSchema,
-  BarcodeSchema,
-  Schema,
-  SchemaForUI,
-  Font,
-  BasePdf,
-  Template,
-  CommonProps,
-  GeneratorOptions,
-  GenerateProps,
-  UIOptions,
-  UIProps,
-  PreviewProps,
-  DesignerProps,
-} from '@pdfme/common';
 
-export {
-  generate,
-  BLANK_PDF,
-  DEFAULT_FONT_VALUE,
-  isTextSchema,
-  isImageSchema,
-  isBarcodeSchema,
-  checkTemplate,
-  checkUIProps,
-  checkPreviewProps,
-  checkDesignerProps,
-  checkGenerateProps,
-  validateBarcodeInput,
-};
-export type {
-  Lang,
-  Size,
-  Alignment,
-  SchemaType,
-  BarCodeType,
-  TextSchema,
-  ImageSchema,
-  BarcodeSchema,
-  Schema,
-  SchemaForUI,
-  Font,
-  BasePdf,
-  Template,
-  CommonProps,
-  GeneratorOptions,
-  GenerateProps,
-  UIOptions,
-  UIProps,
-  PreviewProps,
-  DesignerProps,
-};
+export { generate };

package/src/pdfUtils.ts

@@ -0,0 +1,48 @@
+import { PDFPage, PDFDocument, PDFEmbeddedPage, TransformationMatrix } from '@pdfme/pdf-lib';
+import { getB64BasePdf, BasePdf } from '@pdfme/common';
+import type { EmbedPdfBox } from './types';
+
+export const getEmbeddedPagesAndEmbedPdfBoxes = async (arg: {
+  pdfDoc: PDFDocument;
+  basePdf: BasePdf;
+}) => {
+  const { pdfDoc, basePdf } = arg;
+  let embeddedPages: PDFEmbeddedPage[] = [];
+  let embedPdfBoxes: EmbedPdfBox[] = [];
+  const willLoadPdf = typeof basePdf === 'string' ? await getB64BasePdf(basePdf) : basePdf;
+  const embedPdf = await PDFDocument.load(willLoadPdf);
+  const embedPdfPages = embedPdf.getPages();
+
+  embedPdfBoxes = embedPdfPages.map((p) => ({
+    mediaBox: p.getMediaBox(),
+    bleedBox: p.getBleedBox(),
+    trimBox: p.getTrimBox(),
+  }));
+
+  const boundingBoxes = embedPdfPages.map((p) => {
+    const { x, y, width, height } = p.getMediaBox();
+
+    return { left: x, bottom: y, right: width, top: height + y };
+  });
+
+  const transformationMatrices = embedPdfPages.map(
+    () => [1, 0, 0, 1, 0, 0] as TransformationMatrix
+  );
+
+  embeddedPages = await pdfDoc.embedPages(embedPdfPages, boundingBoxes, transformationMatrices);
+
+  return { embeddedPages, embedPdfBoxes };
+};
+
+export const drawEmbeddedPage = (arg: {
+  page: PDFPage;
+  embeddedPage: PDFEmbeddedPage;
+  embedPdfBox: EmbedPdfBox;
+}) => {
+  const { page, embeddedPage, embedPdfBox } = arg;
+  page.drawPage(embeddedPage);
+  const { mediaBox: mb, bleedBox: bb, trimBox: tb } = embedPdfBox;
+  page.setMediaBox(mb.x, mb.y, mb.width, mb.height);
+  page.setBleedBox(bb.x, bb.y, bb.width, bb.height);
+  page.setTrimBox(tb.x, tb.y, tb.width, tb.height);
+};

package/src/types.ts

@@ -0,0 +1,13 @@
+import type { Schema, PDFRenderProps } from '@pdfme/common';
+
+export type PDFRender = (arg: PDFRenderProps<Schema>) => Promise<void>;
+
+export interface PDFRenderer {
+  [key: string]: PDFRender | undefined;
+}
+
+export type EmbedPdfBox = {
+  mediaBox: { x: number; y: number; width: number; height: number };
+  bleedBox: { x: number; y: number; width: number; height: number };
+  trimBox: { x: number; y: number; width: number; height: number };
+};

package/tsconfig.cjs.json

@@ -4,6 +4,7 @@
     "module": "commonjs",
     "outDir": "./dist/cjs",
     "declaration": true,
-    "declarationDir": "dist/types"
+    "declarationDir": "dist/types",
+    "skipLibCheck": true,
   }
-}
+}

package/tsconfig.esm.json

@@ -4,6 +4,7 @@
     "module": "ESNext",
     "outDir": "./dist/esm",
     "declaration": true,
-    "declarationDir": "dist/types"
+    "declarationDir": "dist/types",
+    "skipLibCheck": true,
   }
-}
+}

package/tsconfig.json

@@ -6,6 +6,9 @@
   "paths": {
     "@pdfme/common": [
       "packages/common/src"
+    ],
+    "@pdfme/schemas": [
+      "packages/schemas/src"
     ]
   }
 }

package/dist/cjs/__tests__/helper.test.js

@@ -1,53 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const helper_1 = require("../src/helper");
-const jsqr_1 = __importDefault(require("jsqr"));
-const pngjs_1 = require("pngjs");
-/**
- * 生成したQRコード（png）画像から入力データが正常に読み取れるかをテスト
- */
-describe('createBarCode', () => {
-    describe('qrcode', () => {
-        // テスト名, input, expected
-        const tests = [
-            ['URL', 'https://www.google.com/', 'https://www.google.com/'],
-            ['ひらがな', 'てすとです', 'てすとです'],
-            ['ひらがな2', 'あいうえおあいうえお２', 'あいうえおあいうえお２'],
-            ['カタカナ', 'テストです', 'テストです'],
-            ['漢字', 'お正月', 'お正月'],
-            ['中国語', '新年快乐', '新年快乐'],
-            ['タイ語', 'สวัสดีปีใหม่', 'สวัสดีปีใหม่'],
-        ];
-        for (const t of tests) {
-            // eslint-disable-next-line no-loop-func
-            test(`${t[0]}: ${t[1]}`, () => __awaiter(void 0, void 0, void 0, function* () {
-                const buffer = (yield (0, helper_1.createBarCode)({
-                    type: 'qrcode',
-                    input: t[1],
-                    width: 10,
-                    height: 10,
-                    backgroundColor: '00000000', // 背景色を指定しないとjsQRでうまく解析できない
-                }));
-                const png = pngjs_1.PNG.sync.read(buffer);
-                const pngData = new Uint8ClampedArray(png.data);
-                const qr = (0, jsqr_1.default)(pngData, png.width, png.height);
-                expect(qr).not.toBeNull();
-                const dataBuffer = Buffer.from(qr.binaryData);
-                expect(dataBuffer.toString('utf8')).toEqual(t[2]);
-            }));
-        }
-    });
-});
-//# sourceMappingURL=helper.test.js.map

package/dist/cjs/__tests__/helper.test.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"helper.test.js","sourceRoot":"","sources":["../../../__tests__/helper.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AAAA,0CAA8C;AAC9C,gDAAoC;AACpC,iCAA4B;AAE5B;;GAEG;AACH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;QACtB,wBAAwB;QACxB,MAAM,KAAK,GAAG;YACZ,CAAC,KAAK,EAAE,yBAAyB,EAAE,yBAAyB,CAAC;YAC7D,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC;YAC1B,CAAC,OAAO,EAAE,aAAa,EAAE,aAAa,CAAC;YACvC,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC;YAC1B,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC;YACpB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC;YACvB,CAAC,KAAK,EAAE,cAAc,EAAE,cAAc,CAAC;SACxC,CAAC;QACF,KAAK,MAAM,CAAC,IAAI,KAAK,EAAE;YACrB,wCAAwC;YACxC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,GAAS,EAAE;gBAClC,MAAM,MAAM,GAAG,CAAC,MAAM,IAAA,sBAAa,EAAC;oBAClC,IAAI,EAAE,QAAQ;oBACd,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;oBACX,KAAK,EAAE,EAAE;oBACT,MAAM,EAAE,EAAE;oBACV,eAAe,EAAE,UAAU,EAAE,2BAA2B;iBACzD,CAAC,CAAW,CAAC;gBACd,MAAM,GAAG,GAAG,WAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAClC,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBAChD,MAAM,EAAE,GAAG,IAAA,cAAI,EAAC,OAAO,EAAE,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,MAAM,CAAW,CAAC;gBAC1D,MAAM,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC;gBAC1B,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC;gBAC9C,MAAM,CAAC,UAAU,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACpD,CAAC,CAAA,CAAC,CAAC;SACJ;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}