@pdfme/common 2.2.0 → 3.0.0-beta.1

package/src/helper.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 import { Buffer } from 'buffer';
-import { BasePdf, CommonProps, BarCodeType, } from './type';
+import { Schema, Template, Font, BasePdf, Plugins } from './types';
 import {
   Inputs as InputsSchema,
   UIOptions as UIOptionsSchema,
@@ -10,8 +10,35 @@ import {
   GenerateProps as GeneratePropsSchema,
   UIProps as UIPropsSchema,
 } from './schema';
-import { MM_TO_PT_RATIO, PT_TO_MM_RATIO, PT_TO_PX_RATIO } from './constants';
-import { checkFont } from './font';
+import {
+  MM_TO_PT_RATIO,
+  PT_TO_MM_RATIO,
+  PT_TO_PX_RATIO,
+  DEFAULT_FONT_NAME,
+  DEFAULT_FONT_VALUE,
+} from './constants';
+
+const uniq = <T>(array: Array<T>) => Array.from(new Set(array));
+
+export const getFallbackFontName = (font: Font) => {
+  const initial = '';
+  const fallbackFontName = Object.entries(font).reduce((acc, cur) => {
+    const [fontName, fontValue] = cur;
+
+    return !acc && fontValue.fallback ? fontName : acc;
+  }, initial);
+  if (fallbackFontName === initial) {
+    throw Error(
+      `[@pdfme/common] fallback flag is not found in font. true fallback flag must be only one.`
+    );
+  }
+
+  return fallbackFontName;
+};
+
+export const getDefaultFont = (): Font => ({
+  [DEFAULT_FONT_NAME]: { data: b64toUint8Array(DEFAULT_FONT_VALUE), fallback: true },
+});
 
 export const mm2pt = (mm: number): number => {
   return parseFloat(String(mm)) * MM_TO_PT_RATIO;
@@ -32,7 +59,7 @@ const blob2Base64Pdf = (blob: Blob) => {
       if ((reader.result as string).startsWith('data:application/pdf;')) {
         resolve(reader.result as string);
       } else {
-        reject(Error('template.basePdf must be pdf data.'));
+        reject(Error('[@pdfme/common] template.basePdf must be pdf data.'));
       }
     };
     reader.readAsDataURL(blob);
@@ -68,6 +95,67 @@ export const b64toUint8Array = (base64: string) => {
   return unit8arr;
 };
 
+const getFontNamesInSchemas = (schemas: { [key: string]: Schema }[]) =>
+  uniq(
+    schemas
+      .map((s) => Object.values(s).map((v) => (v as any).fontName ?? ''))
+      .reduce((acc, cur) => acc.concat(cur), [] as (string | undefined)[])
+      .filter(Boolean) as string[]
+  );
+
+export const checkFont = (arg: { font: Font; template: Template }) => {
+  const {
+    font,
+    template: { schemas },
+  } = arg;
+  const fontValues = Object.values(font);
+  const fallbackFontNum = fontValues.reduce((acc, cur) => (cur.fallback ? acc + 1 : acc), 0);
+  if (fallbackFontNum === 0) {
+    throw Error(
+      `[@pdfme/common] fallback flag is not found in font. true fallback flag must be only one.
+Check this document: https://pdfme.com/docs/custom-fonts#about-font-type`
+    );
+  }
+  if (fallbackFontNum > 1) {
+    throw Error(
+      `[@pdfme/common] ${fallbackFontNum} fallback flags found in font. true fallback flag must be only one.
+Check this document: https://pdfme.com/docs/custom-fonts#about-font-type`
+    );
+  }
+
+  const fontNamesInSchemas = getFontNamesInSchemas(schemas);
+  const fontNames = Object.keys(font);
+  if (fontNamesInSchemas.some((f) => !fontNames.includes(f))) {
+    throw Error(
+      `[@pdfme/common] ${fontNamesInSchemas
+        .filter((f) => !fontNames.includes(f))
+        .join()} of template.schemas is not found in font.
+Check this document: https://pdfme.com/docs/custom-fonts`
+    );
+  }
+};
+
+export const checkPlugins = (arg: { plugins: Plugins; template: Template }) => {
+  const {
+    plugins,
+    template: { schemas },
+  } = arg;
+  const allSchemaTypes = uniq(schemas.map((s) => Object.values(s).map((v) => v.type)).flat());
+
+  // text and image are builtin schema types so they are not included in plugins.
+  const exceptBuiltinSchemaTypes = allSchemaTypes.filter((t) => t !== 'text' && t !== 'image');
+
+  const pluginsSchemaTypes = Object.keys(plugins);
+
+  if (exceptBuiltinSchemaTypes.some((s) => !pluginsSchemaTypes.includes(s))) {
+    throw Error(
+      `[@pdfme/common] ${exceptBuiltinSchemaTypes
+        .filter((s) => !pluginsSchemaTypes.includes(s))
+        .join()} of template.schemas is not found in plugins.`
+    );
+  }
+};
+
 const checkProps = <T>(data: unknown, zodSchema: z.ZodType<T>) => {
   try {
     zodSchema.parse(data);
@@ -80,16 +168,26 @@ ERROR MESSAGE: ${issue.message}
       );
 
       const message = messages.join('\n');
-      throw Error(`Invalid argument:
+      throw Error(`[@pdfme/common] Invalid argument:
 --------------------------
 ${message}`);
     }
   }
-  const commonProps = data as CommonProps;
-  const { template, options } = commonProps;
-  const font = options?.font;
-  if (font) {
-    checkFont({ font, template });
+
+  // Check fon if template and options exist
+  if (data && typeof data === 'object' && 'template' in data && 'options' in data) {
+    const { template, options } = data as { template: Template; options: { font?: Font } };
+    if (options && options.font) {
+      checkFont({ font: options.font, template });
+    }
+  }
+
+  // Check plugins if template and plugins exist
+  if (data && typeof data === 'object' && 'template' in data && 'plugins' in data) {
+    const { template, plugins } = data as { template: Template; plugins: Plugins };
+    if (plugins) {
+      checkPlugins({ plugins, template });
+    }
   }
 };
 
@@ -100,108 +198,3 @@ export const checkUIProps = (data: unknown) => checkProps(data, UIPropsSchema);
 export const checkPreviewProps = (data: unknown) => checkProps(data, PreviewPropsSchema);
 export const checkDesignerProps = (data: unknown) => checkProps(data, DesignerPropsSchema);
 export const checkGenerateProps = (data: unknown) => checkProps(data, GeneratePropsSchema);
-
-// 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: BarCodeType, input: string) => {
-  if (!input) return false;
-  if (type === 'qrcode') {
-    // 500文字以下
-    return input.length < 500;
-  }
-  if (type === 'japanpost') {
-    // 郵便番号は数字(0-9)のみ。住所表示番号は英数字(0-9,A-Z)とハイフン(-)が使用可能です。
-    const regexp = /^(\d{7})(\d|[A-Z]|-)+$/;
-
-    return regexp.test(input);
-  }
-  if (type === 'ean13') {
-    // 有効文字は数値(0-9)のみ。チェックデジットを含まない12桁orチェックデジットを含む13桁。
-    const regexp = /^\d{12}$|^\d{13}$/;
-
-    return regexp.test(input) && validateCheckDigit(input, 13);
-  }
-  if (type === 'ean8') {
-    // 有効文字は数値(0-9)のみ。チェックデジットを含まない7桁orチェックデジットを含む8桁。
-    const regexp = /^\d{7}$|^\d{8}$/;
-
-    return regexp.test(input) && validateCheckDigit(input, 8);
-  }
-  if (type === 'code39') {
-    // 有効文字は数字(0-9)。アルファベット大文字(A-Z)、記号(-.$/+%)、半角スペース。
-    const regexp = /^(\d|[A-Z]|\-|\.|\$|\/|\+|\%|\s)+$/;
-
-    return regexp.test(input);
-  }
-  if (type === 'code128') {
-    // 有効文字は漢字、ひらがな、カタカナ以外。
-    // https://qiita.com/graminume/items/2ac8dd9c32277fa9da64
-    return !input.match(
-      /([\u30a0-\u30ff\u3040-\u309f\u3005-\u3006\u30e0-\u9fcf]|[Ａ-Ｚａ-ｚ０-９！＂＃＄％＆＇（）＊＋，－．／：；＜＝＞？＠［＼］＾＿｀｛｜｝〜　])+/
-    );
-  }
-  if (type === 'nw7') {
-    // 有効文字はNW-7は数字(0-9)と記号(-.$:/+)。
-    // スタートコード／ストップコードとして、コードの始まりと終わりはアルファベット(A-D)のいずれかを使用してください。
-    const regexp = /^[A-Da-d]([0-9\-\.\$\:\/\+])+[A-Da-d]$/;
-
-    return regexp.test(input);
-  }
-  if (type === 'itf14') {
-    // 有効文字は数値(0-9)のみ。 チェックデジットを含まない13桁orチェックデジットを含む14桁。
-    const regexp = /^\d{13}$|^\d{14}$/;
-
-    return regexp.test(input) && validateCheckDigit(input, 14);
-  }
-  if (type === 'upca') {
-    // 有効文字は数値(0-9)のみ。 チェックデジットを含まない11桁orチェックデジットを含む12桁。
-    const regexp = /^\d{11}$|^\d{12}$/;
-
-    return regexp.test(input) && validateCheckDigit(input, 12);
-  }
-  if (type === 'upce') {
-    // 有効文字は数値(0-9)のみ。 1桁目に指定できる数字(ナンバーシステムキャラクタ)は0のみ。
-    // チェックデジットを含まない7桁orチェックデジットを含む8桁。
-    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 after it until another "("
-    const regexp = /\((01)\)(\d*)(\(|$)/;
-    let res = input.match(regexp);
-    if (
-      res != null &&
-      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;
-  }
-
-  return false;
-};

package/src/index.ts

@@ -1,54 +1,40 @@
 import {
-  DEFAULT_FONT_NAME,
-  DEFAULT_FONT_SIZE,
-  DEFAULT_ALIGNMENT,
-  VERTICAL_ALIGN_TOP,
-  VERTICAL_ALIGN_MIDDLE,
-  VERTICAL_ALIGN_BOTTOM,
-  DEFAULT_VERTICAL_ALIGNMENT,
-  DEFAULT_LINE_HEIGHT,
-  DEFAULT_CHARACTER_SPACING,
-  DEFAULT_FONT_COLOR,
-  DYNAMIC_FIT_VERTICAL,
-  DYNAMIC_FIT_HORIZONTAL,
-  DEFAULT_DYNAMIC_FIT,
-  FONT_SIZE_ADJUSTMENT,
   MM_TO_PT_RATIO,
   PT_TO_MM_RATIO,
   PT_TO_PX_RATIO,
   BLANK_PDF,
-  DEFAULT_FONT_VALUE,
+  ZOOM,
+  DEFAULT_FONT_NAME,
 } from './constants.js';
-import { schemaTypes, isImageSchema, isBarcodeSchema, isTextSchema } from './type.js';
 import type {
-  FontWidthCalcValues,
+  ChangeSchemas,
+  PropPanel,
+  PropPanelSchema,
+  PropPanelWidgetProps,
+  PDFRenderProps,
+  UIRenderProps,
+  Plugin,
   Lang,
   Size,
-  Alignment,
-  SchemaType,
-  BarCodeType,
-  TextSchema,
-  ImageSchema,
-  BarcodeSchema,
   Schema,
-  SchemaInputs,
   SchemaForUI,
   Font,
   BasePdf,
   Template,
-  CommonProps,
   GeneratorOptions,
+  Plugins,
   GenerateProps,
   UIOptions,
   UIProps,
   PreviewProps,
-  PreviewReactProps,
   DesignerProps,
-  DesignerReactProps,
-} from './type.js';
+} from './types.js';
 import {
+  getFallbackFontName,
+  getDefaultFont,
   getB64BasePdf,
   b64toUint8Array,
+  checkFont,
   checkInputs,
   checkUIOptions,
   checkTemplate,
@@ -57,59 +43,25 @@ import {
   checkDesignerProps,
   checkGenerateProps,
   mm2pt,
+  pt2mm,
   pt2px,
-  validateBarcodeInput,
 } from './helper.js';
-import {
-  calculateDynamicFontSize,
-  getFallbackFontName,
-  getDefaultFont,
-  heightOfFontAtSize,
-  widthOfTextAtSize,
-  checkFont,
-  getFontKitFont,
-  getBrowserVerticalFontAdjustments,
-  getFontDescentInPt,
-  getSplittedLines,
-} from './font.js';
 
 export {
-  DEFAULT_FONT_NAME,
-  DEFAULT_FONT_SIZE,
-  DEFAULT_ALIGNMENT,
-  VERTICAL_ALIGN_TOP,
-  VERTICAL_ALIGN_MIDDLE,
-  VERTICAL_ALIGN_BOTTOM,
-  DEFAULT_VERTICAL_ALIGNMENT,
-  DEFAULT_LINE_HEIGHT,
-  DEFAULT_CHARACTER_SPACING,
-  DEFAULT_FONT_COLOR,
-  DYNAMIC_FIT_VERTICAL,
-  DYNAMIC_FIT_HORIZONTAL,
-  DEFAULT_DYNAMIC_FIT,
-  FONT_SIZE_ADJUSTMENT,
   MM_TO_PT_RATIO,
   PT_TO_MM_RATIO,
   PT_TO_PX_RATIO,
   BLANK_PDF,
-  DEFAULT_FONT_VALUE,
-  schemaTypes,
-  isTextSchema,
-  isImageSchema,
-  isBarcodeSchema,
-  getB64BasePdf,
-  b64toUint8Array,
+  ZOOM,
+  DEFAULT_FONT_NAME,
   getFallbackFontName,
   getDefaultFont,
-  getSplittedLines,
-  heightOfFontAtSize,
-  widthOfTextAtSize,
+  getB64BasePdf,
+  b64toUint8Array,
   mm2pt,
+  pt2mm,
   pt2px,
   checkFont,
-  getBrowserVerticalFontAdjustments,
-  getFontDescentInPt,
-  getFontKitFont,
   checkInputs,
   checkUIOptions,
   checkTemplate,
@@ -117,33 +69,28 @@ export {
   checkPreviewProps,
   checkDesignerProps,
   checkGenerateProps,
-  validateBarcodeInput,
-  calculateDynamicFontSize,
 };
 
 export type {
   Lang,
   Size,
-  Alignment,
-  SchemaType,
-  BarCodeType,
-  TextSchema,
-  ImageSchema,
-  BarcodeSchema,
   Schema,
-  SchemaInputs,
   SchemaForUI,
   Font,
   BasePdf,
   Template,
-  CommonProps,
   GeneratorOptions,
+  Plugins,
   GenerateProps,
   UIOptions,
   UIProps,
   PreviewProps,
-  PreviewReactProps,
   DesignerProps,
-  DesignerReactProps,
-  FontWidthCalcValues,
+  ChangeSchemas,
+  PropPanel,
+  PropPanelSchema,
+  PropPanelWidgetProps,
+  PDFRenderProps,
+  UIRenderProps,
+  Plugin,
 };

package/src/schema.ts

@@ -1,70 +1,27 @@
-/* eslint dot-notation: "off"*/
 import { z } from 'zod';
-import { VERTICAL_ALIGN_TOP, VERTICAL_ALIGN_MIDDLE, VERTICAL_ALIGN_BOTTOM } from "./constants";
 
-const langs = ['en', 'ja', 'ar', 'th', 'pl'] as const;
+const langs = ['en', 'ja', 'ar', 'th', 'pl', 'it'] as const;
+
 export const Lang = z.enum(langs);
 
 export const Size = z.object({ height: z.number(), width: z.number() });
 
-const alignments = ['left', 'center', 'right'] as const;
-export const Alignment = z.enum(alignments);
-
-const verticalAlignments = [
-  VERTICAL_ALIGN_TOP,
-  VERTICAL_ALIGN_MIDDLE,
-  VERTICAL_ALIGN_BOTTOM,
-] as const;
-export const VerticalAlignment = z.enum(verticalAlignments);
-
-// prettier-ignore
-export const barcodeSchemaTypes = ['qrcode', 'japanpost', 'ean13', 'ean8', 'code39', 'code128', 'nw7', 'itf14', 'upca', 'upce', 'gs1datamatrix'] as const;
-const notBarcodeSchemaTypes = ['text', 'image'] as const;
-export const schemaTypes = [...notBarcodeSchemaTypes, ...barcodeSchemaTypes] as const;
-
-export const BarcodeSchemaType = z.enum(barcodeSchemaTypes);
-export const SchemaType = z.enum(schemaTypes);
-
-export const CommonSchema = z.object({
-  type: SchemaType,
-  position: z.object({ x: z.number(), y: z.number() }),
-  width: z.number(),
-  height: z.number(),
-  rotate: z.number().optional(),
-});
-
-export const TextSchema = CommonSchema.extend({
-  type: z.literal(SchemaType.Enum.text),
-  alignment: Alignment.optional(),
-  verticalAlignment: VerticalAlignment.optional(),
-  fontSize: z.number().optional(),
-  fontName: z.string().optional(),
-  fontColor: z.string().optional(),
-  backgroundColor: z.string().optional(),
-  characterSpacing: z.number().optional(),
-  lineHeight: z.number().optional(),
-  dynamicFontSize: z.object({
-    max: z.number(),
-    min: z.number(),
-    fit: z.string().optional(),
-  }).optional(),
-});
-
-export const ImageSchema = CommonSchema.extend({ type: z.literal(SchemaType.Enum.image) });
-
-export const BarcodeSchema = CommonSchema.extend({ type: BarcodeSchemaType });
-
-export const Schema = z.union([TextSchema, ImageSchema, BarcodeSchema]);
+export const Schema = z
+  .object({
+    type: z.string(),
+    position: z.object({ x: z.number(), y: z.number() }),
+    width: z.number(),
+    height: z.number(),
+    rotate: z.number().optional(),
+  })
+  .passthrough();
 
 const SchemaForUIAdditionalInfo = z.object({
-  id: z.string(), key: z.string(), data: z.string(),
+  id: z.string(),
+  key: z.string(),
+  data: z.string(),
 });
-
-export const SchemaForUI = z.union([
-  TextSchema.merge(SchemaForUIAdditionalInfo),
-  ImageSchema.merge(SchemaForUIAdditionalInfo),
-  BarcodeSchema.merge(SchemaForUIAdditionalInfo),
-]);
+export const SchemaForUI = Schema.merge(SchemaForUIAdditionalInfo);
 
 const ArrayBufferSchema: z.ZodSchema<ArrayBuffer> = z.any().refine((v) => v instanceof ArrayBuffer);
 const Uint8ArraySchema: z.ZodSchema<Uint8Array> = z.any().refine((v) => v instanceof Uint8Array);
@@ -88,25 +45,24 @@ export const Template = z.object({
 
 export const Inputs = z.array(z.record(z.string())).min(1);
 
-const CommonOptions = z.object({ font: Font.optional() });
+const CommonOptions = z.object({ font: Font.optional() }).passthrough();
 
-export const CommonProps = z.object({
+const CommonProps = z.object({
   template: Template,
   options: CommonOptions.optional(),
+  plugins: z.record(z.object({ ui: z.any(), pdf: z.any(), propPanel: z.any() })).optional(),
 });
 
 // -------------------generate-------------------
 
-export const GeneratorOptions = CommonOptions;
+export const GeneratorOptions = CommonOptions.extend({});
 
 export const GenerateProps = CommonProps.extend({
   inputs: Inputs,
   options: GeneratorOptions.optional(),
 }).strict();
 
-export const SchemaInputs = z.record(z.string());
-
-// ---------------------------------------------
+// ---------------------ui------------------------
 
 export const UIOptions = CommonOptions.extend({ lang: Lang.optional() });
 
@@ -117,22 +73,6 @@ export const UIProps = CommonProps.extend({
   options: UIOptions.optional(),
 });
 
-// -----------------Form, Viewer-----------------
-
 export const PreviewProps = UIProps.extend({ inputs: Inputs }).strict();
-export const PreviewReactProps = PreviewProps.omit({ domContainer: true }).extend({
-  onChangeInput: z
-    .function()
-    .args(z.object({ index: z.number(), value: z.string(), key: z.string() }))
-    .returns(z.void())
-    .optional(),
-  size: Size,
-});
-
-// ---------------Designer---------------
 
 export const DesignerProps = UIProps.extend({}).strict();
-export const DesignerReactProps = DesignerProps.omit({ domContainer: true }).extend({
-  onSaveTemplate: z.function().args(Template).returns(z.void()),
-  size: Size,
-});