@pdfme/schemas 0.0.0

package/eslint.config.mjs

@@ -0,0 +1,22 @@
+import { fileURLToPath } from 'url';
+import { dirname, resolve } from 'path';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+// Import the root config
+const rootConfigPath = resolve(__dirname, '../../eslint.config.mjs');
+const rootConfig = await import(rootConfigPath);
+
+export default [
+  ...rootConfig.default,
+  {
+    files: ['src/**/*.ts'],
+    languageOptions: {
+      parserOptions: {
+        project: ['./tsconfig.esm.json'],
+        tsconfigRootDir: __dirname,
+      },
+    },
+  },
+];

package/package.json

@@ -0,0 +1,97 @@
+{
+  "name": "@pdfme/schemas",
+  "version": "0.0.0",
+  "sideEffects": false,
+  "author": "hand-dot",
+  "license": "MIT",
+  "keywords": [
+    "pdf",
+    "pdf-generation",
+    "pdf-designer",
+    "pdf-viewer",
+    "typescript",
+    "react"
+  ],
+  "description": "TypeScript base PDF generator and React base UI. Open source, developed by the community, and completely free to use under the MIT license!",
+  "homepage": "https://pdfme.com",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:pdfme/pdfme.git"
+  },
+  "bugs": {
+    "url": "https://github.com/pdfme/pdfme/issues"
+  },
+  "main": "dist/cjs/src/index.js",
+  "module": "dist/esm/src/index.js",
+  "types": "dist/types/src/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "node": "./dist/node/src/index.js",
+        "default": "./dist/esm/src/index.js"
+      },
+      "require": "./dist/cjs/src/index.js",
+      "types": "./dist/types/src/index.d.ts"
+    },
+    "./utils": {
+      "import": {
+        "node": "./dist/node/src/utils.js",
+        "default": "./dist/esm/src/utils.js"
+      },
+      "require": "./dist/cjs/src/utils.js",
+      "types": "./dist/types/src/utils.d.ts"
+    }
+  },
+  "scripts": {
+    "dev": "tsc -p tsconfig.esm.json -w",
+    "build": "run-p build:cjs build:esm build:node",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:node": "tsc -p tsconfig.node.json",
+    "clean": "rimraf dist",
+    "lint": "eslint --ext .ts src --config eslint.config.mjs",
+    "test": "jest",
+    "prune": "ts-prune src",
+    "prettier": "prettier --write 'src/**/*.ts'"
+  },
+  "dependencies": {
+    "@pdfme/pdf-lib": "*",
+    "air-datepicker": "^3.6.0",
+    "bwip-js": "^4.7.0",
+    "date-fns": "^4.1.0",
+    "fontkit": "^2.0.2",
+    "lucide": "^0.552.0"
+  },
+  "devDependencies": {
+    "@pdfme/common": "*",
+    "@types/bwip-js": "^3.2.1",
+    "@types/fontkit": "^2.0.8",
+    "@types/pngjs": "^6.0.2",
+    "jsqr": "^1.4.0",
+    "pngjs": "^7.0.0"
+  },
+  "peerDependencies": {
+    "@pdfme/common": "latest"
+  },
+  "jest": {
+    "resolver": "ts-jest-resolver",
+    "moduleFileExtensions": [
+      "js",
+      "ts"
+    ],
+    "transform": {
+      "^.+\\.ts?$": [
+        "ts-jest",
+        {
+          "tsconfig": "tsconfig.esm.json"
+        }
+      ]
+    },
+    "testMatch": [
+      "**/*.test.ts"
+    ]
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/src/barcodes/constants.ts

@@ -0,0 +1,20 @@
+export const BARCODE_TYPES = [
+  'qrcode',
+  'japanpost',
+  'ean13',
+  'ean8',
+  'code39',
+  'code128',
+  'nw7',
+  'itf14',
+  'upca',
+  'upce',
+  'gs1datamatrix',
+  'pdf417',
+] as const;
+
+export const DEFAULT_BARCODE_BG_COLOR = '#ffffff';
+
+export const DEFAULT_BARCODE_COLOR = '#000000';
+
+export const DEFAULT_BARCODE_INCLUDETEXT = true;

package/src/barcodes/helper.ts

@@ -0,0 +1,187 @@
+import { b64toUint8Array } from '@pdfme/common';
+import bwipjs, { RenderOptions } from 'bwip-js';
+import { Buffer } from 'buffer';
+import { BARCODE_TYPES, DEFAULT_BARCODE_INCLUDETEXT } from './constants.js';
+import { BarcodeTypes } from './types.js';
+
+// GTIN-13, GTIN-8, GTIN-12, GTIN-14
+const validateCheckDigit = (input: string, checkDigitPos: number) => {
+  let passCheckDigit = true;
+
+  if (input.length === checkDigitPos) {
+    const ds = input.slice(0, -1).replace(/[^0-9]/g, '');
+    let sum = 0;
+    let odd = 1;
+    for (let i = ds.length - 1; i > -1; i -= 1) {
+      sum += Number(ds[i]) * (odd ? 3 : 1);
+      odd ^= 1;
+      if (sum > 0xffffffffffff) {
+        // ~2^48 at max
+        sum %= 10;
+      }
+    }
+    passCheckDigit = String(10 - (sum % 10)).slice(-1) === input.slice(-1);
+  }
+
+  return passCheckDigit;
+};
+export const validateBarcodeInput = (type: BarcodeTypes, input: string) => {
+  if (!input) return false;
+
+  if (!BARCODE_TYPES.includes(type)) return false;
+
+  if (type === 'qrcode') {
+    // Up to 500 characters
+    return input.length < 500;
+  }
+  if (type === 'japanpost') {
+    // For Japan Post: Postal codes must be digits (0-9) only.
+    // Address display numbers can use alphanumeric characters (0-9, A-Z) and hyphen (-).
+    const regexp = /^(\d{7})(\d|[A-Z]|-)+$/;
+    return regexp.test(input);
+  }
+  if (type === 'ean13') {
+    // For EAN-13: Valid characters are digits (0-9) only.
+    // Either 12 digits (without check digit) or 13 digits (with check digit).
+    const regexp = /^\d{12}$|^\d{13}$/;
+    return regexp.test(input) && validateCheckDigit(input, 13);
+  }
+  if (type === 'ean8') {
+    // For EAN-8: Valid characters are digits (0-9) only.
+    // Either 7 digits (without check digit) or 8 digits (with check digit).
+    const regexp = /^\d{7}$|^\d{8}$/;
+    return regexp.test(input) && validateCheckDigit(input, 8);
+  }
+  if (type === 'code39') {
+    // For Code39: Valid characters are digits (0-9), uppercase alphabets (A-Z),
+    // symbols (-, ., $, /, +, %), and space.
+    const regexp = /^(\d|[A-Z]|\-|\.|\$|\/|\+|\%|\s)+$/;
+    return regexp.test(input);
+  }
+  if (type === 'code128') {
+    // For Code128: Valid characters are all except Kanji, Hiragana, and Katakana.
+    // https://qiita.com/graminume/items/2ac8dd9c32277fa9da64
+    return !input.match(
+      /([\u30a0-\u30ff\u3040-\u309f\u3005-\u3006\u30e0-\u9fcf]|[Ａ-Ｚａ-ｚ０-９！＂＃＄％＆＇（）＊＋，－．／：；＜＝＞？＠［＼］＾＿｀｛｜｝〜　])+/,
+    );
+  }
+  if (type === 'nw7') {
+    // For NW-7: Valid characters are digits (0-9) and symbols (-, ., $, :, /, +).
+    // The first and last characters must be one of the alphabets A-D (start/stop codes).
+    const regexp = /^[A-Da-d]([0-9\-\.\$\:\/\+])+[A-Da-d]$/;
+    return regexp.test(input);
+  }
+  if (type === 'itf14') {
+    // For ITF-14: Valid characters are digits (0-9) only.
+    // Either 13 digits (without check digit) or 14 digits (with check digit).
+    const regexp = /^\d{13}$|^\d{14}$/;
+    return regexp.test(input) && validateCheckDigit(input, 14);
+  }
+  if (type === 'upca') {
+    // For UPCA: Valid characters are digits (0-9) only.
+    // Either 11 digits (without check digit) or 12 digits (with check digit).
+    const regexp = /^\d{11}$|^\d{12}$/;
+    return regexp.test(input) && validateCheckDigit(input, 12);
+  }
+  if (type === 'upce') {
+    // For UPCE: Valid characters are digits (0-9) only.
+    // The first digit (number system character) must be 0.
+    // Either 7 digits (without check digit) or 8 digits (with check digit).
+    const regexp = /^0(\d{6}$|\d{7}$)/;
+    return regexp.test(input) && validateCheckDigit(input, 8);
+  }
+  if (type === 'gs1datamatrix') {
+    let ret = false;
+    // Find the GTIN application identifier: regex for "(01)" and the digits following it until another "(".
+    const regexp = /\((01)\)(\d*)(\(|$)/;
+    let res = input.match(regexp);
+    if (
+      res != null &&
+      input.length <= 52 && // 52 is the max length of a GS1 DataMatrix barcode before bwip-js throws an error
+      res[1] === '01' &&
+      (res[2].length === 14 || res[2].length === 8 || res[2].length === 12 || res[2].length === 13)
+    ) {
+      let gtin = res[2];
+      ret = validateCheckDigit(gtin, gtin.length);
+    }
+    return ret;
+  }
+  if (type === 'pdf417') {
+    // PDF417 can encode a wide range of characters,
+    // but considering performance and library limitations, the maximum number of characters is limited (up to 1000 characters here).
+    return input.length > 0 && input.length <= 1000;
+  }
+
+  return false;
+};
+
+/**
+ * The bwip.js lib has a different name for nw7 type barcodes
+ */
+export const barCodeType2Bcid = (type: BarcodeTypes) =>
+  type === 'nw7' ? 'rationalizedCodabar' : type;
+
+/**
+ *  Strip hash from the beginning of HTML hex color codes for the bwip.js lib
+ */
+export const mapHexColorForBwipJsLib = (color: string | undefined, fallback?: string) =>
+  color ? color.replace('#', '') : fallback ? fallback.replace('#', '') : '000000';
+
+export const createBarCode = async (arg: {
+  type: BarcodeTypes;
+  input: string;
+  width: number;
+  height: number;
+  backgroundColor?: string;
+  barColor?: string;
+  textColor?: string;
+  includetext?: boolean;
+}): Promise<Buffer> => {
+  const {
+    type,
+    input,
+    width,
+    height,
+    backgroundColor,
+    barColor,
+    textColor,
+    includetext = DEFAULT_BARCODE_INCLUDETEXT,
+  } = arg;
+
+  const bcid = barCodeType2Bcid(type);
+  const scale = 5;
+  const bwipjsArg: RenderOptions = {
+    bcid,
+    text: input,
+    width,
+    height,
+    scale,
+    includetext,
+    textxalign: 'center',
+  };
+
+  if (backgroundColor) bwipjsArg.backgroundcolor = mapHexColorForBwipJsLib(backgroundColor);
+  if (barColor) bwipjsArg.barcolor = mapHexColorForBwipJsLib(barColor);
+  if (textColor) bwipjsArg.textcolor = mapHexColorForBwipJsLib(textColor);
+
+  let res: Buffer;
+
+  if (typeof window !== 'undefined') {
+    const canvas = document.createElement('canvas');
+    // Use a type assertion to safely call toCanvas
+    const bwipjsModule = bwipjs as unknown as {
+      toCanvas(canvas: HTMLCanvasElement, options: RenderOptions): void;
+    };
+    bwipjsModule.toCanvas(canvas, bwipjsArg);
+    const dataUrl = canvas.toDataURL('image/png');
+    res = Buffer.from(b64toUint8Array(dataUrl).buffer);
+  } else {
+    // Use a type assertion to safely call toBuffer
+    const bwipjsModule = bwipjs as unknown as {
+      toBuffer(options: RenderOptions): Promise<Buffer>;
+    };
+    res = await bwipjsModule.toBuffer(bwipjsArg);
+  }
+
+  return res;
+};

package/src/barcodes/index.ts

@@ -0,0 +1,23 @@
+import { pdfRender } from './pdfRender.js';
+import { getPropPanelByBarcodeType } from './propPanel.js';
+import { uiRender } from './uiRender.js';
+import type { BarcodeSchema, BarcodeTypes } from './types.js';
+import { BARCODE_TYPES } from './constants.js';
+import { createSvgStr } from '../utils.js';
+import { Plugin } from '@pdfme/common';
+import { QrCode, Barcode } from 'lucide';
+
+const barcodes = BARCODE_TYPES.reduce(
+  (acc, type) =>
+    Object.assign(acc, {
+      [type]: {
+        pdf: pdfRender,
+        ui: uiRender,
+        propPanel: getPropPanelByBarcodeType(type),
+        icon: createSvgStr(type == 'qrcode' ? QrCode : Barcode),
+      },
+    }),
+  {} as Record<BarcodeTypes, Plugin<BarcodeSchema>>,
+);
+
+export default barcodes;

package/src/barcodes/pdfRender.ts

@@ -0,0 +1,37 @@
+import { PDFRenderProps } from '@pdfme/common';
+import { convertForPdfLayoutProps } from '../utils.js';
+import type { BarcodeSchema } from './types.js';
+import { createBarCode, validateBarcodeInput } from './helper.js';
+import { PDFImage } from '@pdfme/pdf-lib';
+
+const getBarcodeCacheKey = (schema: BarcodeSchema, value: string) => {
+  return `${schema.type}${schema.backgroundColor}${schema.barColor}${schema.textColor}${value}${schema.includetext}`;
+};
+
+export const pdfRender = async (arg: PDFRenderProps<BarcodeSchema>) => {
+  const { value, schema, pdfDoc, page, _cache } = arg;
+  if (!validateBarcodeInput(schema.type, value)) return;
+
+  const inputBarcodeCacheKey = getBarcodeCacheKey(schema, value);
+  let image = _cache.get(inputBarcodeCacheKey) as PDFImage | undefined;
+  if (!image) {
+    const imageBuf = await createBarCode({
+      ...schema,
+      type: schema.type,
+      input: value,
+    });
+    image = await pdfDoc.embedPng(imageBuf);
+    _cache.set(inputBarcodeCacheKey, image);
+  }
+
+  const pageHeight = page.getHeight();
+  const {
+    width,
+    height,
+    rotate,
+    position: { x, y },
+    opacity,
+  } = convertForPdfLayoutProps({ schema, pageHeight });
+
+  page.drawImage(image, { x, y, rotate, width, height, opacity });
+};

package/src/barcodes/propPanel.ts

@@ -0,0 +1,249 @@
+import type { PropPanel } from '@pdfme/common';
+import type { BarcodeSchema } from './types.js';
+import {
+  DEFAULT_BARCODE_COLOR,
+  DEFAULT_BARCODE_BG_COLOR,
+  DEFAULT_BARCODE_INCLUDETEXT,
+} from './constants.js';
+import { DEFAULT_OPACITY, HEX_COLOR_PATTERN } from '../constants.js';
+
+const defaultColors = {
+  backgroundColor: DEFAULT_BARCODE_BG_COLOR,
+  barColor: DEFAULT_BARCODE_COLOR,
+};
+const defaultTextColors = { textColor: DEFAULT_BARCODE_COLOR };
+const defaultIncludetext = { includetext: DEFAULT_BARCODE_INCLUDETEXT };
+const position = { x: 0, y: 0 };
+const default40x20 = { width: 40, height: 20 };
+
+const barcodeDefaults: { defaultSchema: BarcodeSchema }[] = [
+  {
+    defaultSchema: {
+      name: '',
+      type: 'qrcode',
+      content: 'https://pdfme.com/',
+      position,
+      ...defaultColors,
+      width: 30,
+      height: 30,
+      rotate: 0,
+      opacity: DEFAULT_OPACITY,
+    },
+  },
+  {
+    defaultSchema: {
+      name: '',
+      type: 'japanpost',
+      content: '6540123789-A-K-Z',
+      position,
+      ...defaultColors,
+      ...defaultTextColors,
+      ...defaultIncludetext,
+      width: 80,
+      height: 7.2,
+      rotate: 0,
+      opacity: DEFAULT_OPACITY,
+    },
+  },
+  {
+    defaultSchema: {
+      name: '',
+      type: 'ean13',
+      content: '2112345678900',
+      position,
+      ...defaultColors,
+      ...defaultTextColors,
+      ...defaultIncludetext,
+      ...default40x20,
+      height: 16,
+      rotate: 0,
+      opacity: DEFAULT_OPACITY,
+    },
+  },
+  {
+    defaultSchema: {
+      name: '',
+      type: 'ean8',
+      content: '02345673',
+      position,
+      ...defaultColors,
+      ...defaultTextColors,
+      ...defaultIncludetext,
+      ...default40x20,
+      rotate: 0,
+      opacity: DEFAULT_OPACITY,
+    },
+  },
+  {
+    defaultSchema: {
+      name: '',
+      type: 'code39',
+      content: 'THIS IS CODE 39',
+      position,
+      ...defaultColors,
+      ...defaultTextColors,
+      ...defaultIncludetext,
+      ...default40x20,
+      opacity: DEFAULT_OPACITY,
+    },
+  },
+  {
+    defaultSchema: {
+      name: '',
+      type: 'code128',
+      content: 'This is Code 128!',
+      position,
+      ...defaultColors,
+      ...defaultTextColors,
+      ...defaultIncludetext,
+      ...default40x20,
+      rotate: 0,
+      opacity: DEFAULT_OPACITY,
+    },
+  },
+  {
+    defaultSchema: {
+      name: '',
+      type: 'nw7',
+      content: 'A0123456789B',
+      position,
+      ...defaultColors,
+      ...defaultTextColors,
+      ...defaultIncludetext,
+      ...default40x20,
+      rotate: 0,
+      opacity: DEFAULT_OPACITY,
+    },
+  },
+  {
+    defaultSchema: {
+      name: '',
+      type: 'itf14',
+      content: '04601234567893',
+      position,
+      ...defaultColors,
+      ...defaultTextColors,
+      ...defaultIncludetext,
+      ...default40x20,
+      height: 12,
+      rotate: 0,
+      opacity: DEFAULT_OPACITY,
+    },
+  },
+  {
+    defaultSchema: {
+      name: '',
+      type: 'upca',
+      content: '416000336108',
+      position,
+      ...defaultColors,
+      ...defaultTextColors,
+      ...defaultIncludetext,
+      ...default40x20,
+      height: 16,
+      rotate: 0,
+      opacity: DEFAULT_OPACITY,
+    },
+  },
+  {
+    defaultSchema: {
+      name: '',
+      type: 'upce',
+      content: '00123457',
+      position,
+      ...defaultColors,
+      ...defaultTextColors,
+      ...defaultIncludetext,
+      ...default40x20,
+      rotate: 0,
+      opacity: DEFAULT_OPACITY,
+    },
+  },
+  {
+    defaultSchema: {
+      name: '',
+      type: 'gs1datamatrix',
+      content: '(01)03453120000011(17)191125(10)ABCD1234',
+      position,
+      ...defaultColors,
+      width: 30,
+      height: 30,
+      rotate: 0,
+      opacity: DEFAULT_OPACITY,
+    },
+  },
+  {
+    defaultSchema: {
+      name: '',
+      type: 'pdf417',
+      content: 'This is PDF417!',
+      position,
+      ...defaultColors,
+      width: 40,
+      height: 16,
+      rotate: 0,
+      opacity: DEFAULT_OPACITY,
+    },
+  },
+];
+
+export const getPropPanelByBarcodeType = (barcodeType: string): PropPanel<BarcodeSchema> => {
+  const barcodeHasText =
+    barcodeType !== 'qrcode' && barcodeType !== 'gs1datamatrix' && barcodeType !== 'pdf417';
+
+  const defaults = barcodeDefaults.find(({ defaultSchema }) => defaultSchema.type === barcodeType);
+
+  if (!defaults)
+    throw new Error(`[@pdfme/schemas/barcodes] No default for barcode type ${barcodeType}`);
+
+  return {
+    schema: ({ i18n }) => ({
+      barColor: {
+        title: i18n('schemas.barcodes.barColor'),
+        type: 'string',
+        widget: 'color',
+        props: {
+          disabledAlpha: true,
+        },
+        rules: [
+          {
+            pattern: HEX_COLOR_PATTERN,
+            message: i18n('validation.hexColor'),
+          },
+        ],
+      },
+      backgroundColor: {
+        title: i18n('schemas.bgColor'),
+        type: 'string',
+        widget: 'color',
+        props: {
+          disabledAlpha: true,
+        },
+        rules: [
+          {
+            pattern: HEX_COLOR_PATTERN,
+            message: i18n('validation.hexColor'),
+          },
+        ],
+      },
+      ...(barcodeHasText
+        ? {
+            textColor: {
+              title: i18n('schemas.textColor'),
+              type: 'string',
+              widget: 'color',
+              props: {
+                disabledAlpha: true,
+              },
+            },
+            includetext: {
+              title: i18n('schemas.barcodes.includetext'),
+              type: 'boolean',
+              widget: 'switch',
+            },
+          }
+        : {}),
+    }),
+    ...defaults,
+  };
+};

package/src/barcodes/types.ts

@@ -0,0 +1,12 @@
+import { Schema } from '@pdfme/common';
+import { BARCODE_TYPES } from './constants.js';
+
+export interface BarcodeSchema extends Schema {
+  type: (typeof BARCODE_TYPES)[number];
+  backgroundColor: string;
+  barColor: string;
+  textColor?: string;
+  includetext?: boolean;
+}
+
+export type BarcodeTypes = (typeof BARCODE_TYPES)[number];