@embedpdf/models 1.0.13 → 1.0.15

package/dist/index.d.ts

@@ -13,6 +13,7 @@ export * from './pdf';
 export * from './task';
 export * from './color';
 export * from './date';
+export * from './helpers';
 /**
  * ignore will do nothing when called.
  *

package/dist/index.js

@@ -768,6 +768,36 @@ var PdfZoomMode = /* @__PURE__ */ ((PdfZoomMode2) => {
   PdfZoomMode2[PdfZoomMode2["FitRectangle"] = 5] = "FitRectangle";
   return PdfZoomMode2;
 })(PdfZoomMode || {});
+var PdfStandardFont = /* @__PURE__ */ ((PdfStandardFont2) => {
+  PdfStandardFont2[PdfStandardFont2["Unknown"] = -1] = "Unknown";
+  PdfStandardFont2[PdfStandardFont2["Courier"] = 0] = "Courier";
+  PdfStandardFont2[PdfStandardFont2["Courier_Bold"] = 1] = "Courier_Bold";
+  PdfStandardFont2[PdfStandardFont2["Courier_BoldOblique"] = 2] = "Courier_BoldOblique";
+  PdfStandardFont2[PdfStandardFont2["Courier_Oblique"] = 3] = "Courier_Oblique";
+  PdfStandardFont2[PdfStandardFont2["Helvetica"] = 4] = "Helvetica";
+  PdfStandardFont2[PdfStandardFont2["Helvetica_Bold"] = 5] = "Helvetica_Bold";
+  PdfStandardFont2[PdfStandardFont2["Helvetica_BoldOblique"] = 6] = "Helvetica_BoldOblique";
+  PdfStandardFont2[PdfStandardFont2["Helvetica_Oblique"] = 7] = "Helvetica_Oblique";
+  PdfStandardFont2[PdfStandardFont2["Times_Roman"] = 8] = "Times_Roman";
+  PdfStandardFont2[PdfStandardFont2["Times_Bold"] = 9] = "Times_Bold";
+  PdfStandardFont2[PdfStandardFont2["Times_BoldItalic"] = 10] = "Times_BoldItalic";
+  PdfStandardFont2[PdfStandardFont2["Times_Italic"] = 11] = "Times_Italic";
+  PdfStandardFont2[PdfStandardFont2["Symbol"] = 12] = "Symbol";
+  PdfStandardFont2[PdfStandardFont2["ZapfDingbats"] = 13] = "ZapfDingbats";
+  return PdfStandardFont2;
+})(PdfStandardFont || {});
+var PdfTextAlignment = /* @__PURE__ */ ((PdfTextAlignment2) => {
+  PdfTextAlignment2[PdfTextAlignment2["Left"] = 0] = "Left";
+  PdfTextAlignment2[PdfTextAlignment2["Center"] = 1] = "Center";
+  PdfTextAlignment2[PdfTextAlignment2["Right"] = 2] = "Right";
+  return PdfTextAlignment2;
+})(PdfTextAlignment || {});
+var PdfVerticalAlignment = /* @__PURE__ */ ((PdfVerticalAlignment2) => {
+  PdfVerticalAlignment2[PdfVerticalAlignment2["Top"] = 0] = "Top";
+  PdfVerticalAlignment2[PdfVerticalAlignment2["Middle"] = 1] = "Middle";
+  PdfVerticalAlignment2[PdfVerticalAlignment2["Bottom"] = 2] = "Bottom";
+  return PdfVerticalAlignment2;
+})(PdfVerticalAlignment || {});
 var PdfBlendMode = /* @__PURE__ */ ((PdfBlendMode2) => {
   PdfBlendMode2[PdfBlendMode2["Normal"] = 0] = "Normal";
   PdfBlendMode2[PdfBlendMode2["Multiply"] = 1] = "Multiply";
@@ -787,66 +817,6 @@ var PdfBlendMode = /* @__PURE__ */ ((PdfBlendMode2) => {
   PdfBlendMode2[PdfBlendMode2["Luminosity"] = 15] = "Luminosity";
   return PdfBlendMode2;
 })(PdfBlendMode || {});
-const MixedBlendMode = Symbol("mixed");
-const BLEND_MODE_INFOS = Object.freeze([
-  { id: 0, label: "Normal", css: "normal" },
-  { id: 1, label: "Multiply", css: "multiply" },
-  { id: 2, label: "Screen", css: "screen" },
-  { id: 3, label: "Overlay", css: "overlay" },
-  { id: 4, label: "Darken", css: "darken" },
-  { id: 5, label: "Lighten", css: "lighten" },
-  { id: 6, label: "Color Dodge", css: "color-dodge" },
-  { id: 7, label: "Color Burn", css: "color-burn" },
-  { id: 8, label: "Hard Light", css: "hard-light" },
-  { id: 9, label: "Soft Light", css: "soft-light" },
-  { id: 10, label: "Difference", css: "difference" },
-  { id: 11, label: "Exclusion", css: "exclusion" },
-  { id: 12, label: "Hue", css: "hue" },
-  { id: 13, label: "Saturation", css: "saturation" },
-  { id: 14, label: "Color", css: "color" },
-  { id: 15, label: "Luminosity", css: "luminosity" }
-]);
-const enumToInfo = BLEND_MODE_INFOS.reduce(
-  (m, info) => {
-    m[info.id] = info;
-    return m;
-  },
-  {}
-);
-const cssToEnum = BLEND_MODE_INFOS.reduce(
-  (m, info) => {
-    m[info.css] = info.id;
-    return m;
-  },
-  {}
-);
-function getBlendModeInfo(mode) {
-  return enumToInfo[mode] ?? enumToInfo[
-    0
-    /* Normal */
-  ];
-}
-function blendModeToCss(mode) {
-  return getBlendModeInfo(mode).css;
-}
-function cssToBlendMode(value) {
-  return cssToEnum[value];
-}
-function blendModeLabel(mode) {
-  return getBlendModeInfo(mode).label;
-}
-function reduceBlendModes(modes) {
-  if (!modes.length) return 0;
-  const first = modes[0];
-  return modes.every((m) => m === first) ? first : MixedBlendMode;
-}
-const blendModeSelectOptions = BLEND_MODE_INFOS.map((info) => ({
-  value: info.id,
-  label: info.label
-}));
-function uiBlendModeDisplay(value) {
-  return value === MixedBlendMode ? "(mixed)" : blendModeLabel(value);
-}
 var PdfActionType = /* @__PURE__ */ ((PdfActionType2) => {
   PdfActionType2[PdfActionType2["Unsupported"] = 0] = "Unsupported";
   PdfActionType2[PdfActionType2["Goto"] = 1] = "Goto";
@@ -1306,28 +1276,54 @@ class PdfTaskHelper {
     return task;
   }
 }
-function pdfAlphaColorToWebAlphaColor(c) {
+function pdfColorToWebColor(c) {
   const clamp = (n) => Math.max(0, Math.min(255, n));
   const toHex = (n) => clamp(n).toString(16).padStart(2, "0");
-  const color = `#${toHex(c.red)}${toHex(c.green)}${toHex(c.blue)}`;
-  const opacity = clamp(c.alpha) / 255;
-  return { color, opacity };
+  return `#${toHex(c.red)}${toHex(c.green)}${toHex(c.blue)}`;
 }
-function webAlphaColorToPdfAlphaColor({ color, opacity }) {
+function webColorToPdfColor(color) {
   if (/^#?[0-9a-f]{3}$/i.test(color)) {
     color = color.replace(/^#?([0-9a-f])([0-9a-f])([0-9a-f])$/i, "#$1$1$2$2$3$3").toLowerCase();
   }
   const [, r, g, b] = /^#?([0-9a-f]{2})([0-9a-f]{2})([0-9a-f]{2})$/i.exec(color) ?? (() => {
-    throw new Error(`Invalid hex colour: “${color}”`);
+    throw new Error(`Invalid hex colour: "${color}"`);
   })();
-  const clamp = (n, hi = 255) => Math.max(0, Math.min(hi, n));
   return {
     red: parseInt(r, 16),
     green: parseInt(g, 16),
-    blue: parseInt(b, 16),
-    alpha: clamp(Math.round(opacity * 255))
+    blue: parseInt(b, 16)
   };
 }
+function pdfAlphaToWebOpacity(alpha) {
+  const clamp = (n) => Math.max(0, Math.min(255, n));
+  return clamp(alpha) / 255;
+}
+function webOpacityToPdfAlpha(opacity) {
+  const clamp = (n, hi = 255) => Math.max(0, Math.min(hi, n));
+  return clamp(Math.round(opacity * 255));
+}
+function extractPdfColor(c) {
+  return { red: c.red, green: c.green, blue: c.blue };
+}
+function extractWebOpacity(c) {
+  return pdfAlphaToWebOpacity(c.alpha);
+}
+function combinePdfColorWithAlpha(color, alpha) {
+  return { ...color, alpha };
+}
+function combineWebColorWithOpacity(color, opacity) {
+  return { color, opacity };
+}
+function pdfAlphaColorToWebAlphaColor(c) {
+  const color = pdfColorToWebColor(extractPdfColor(c));
+  const opacity = extractWebOpacity(c);
+  return { color, opacity };
+}
+function webAlphaColorToPdfAlphaColor({ color, opacity }) {
+  const pdfColor = webColorToPdfColor(color);
+  const alpha = webOpacityToPdfAlpha(opacity);
+  return combinePdfColorWithAlpha(pdfColor, alpha);
+}
 function pdfDateToDate(pdf) {
   if (!(pdf == null ? void 0 : pdf.startsWith("D:")) || pdf.length < 16) return;
   const y = +pdf.slice(2, 6);
@@ -1348,6 +1344,288 @@ function dateToPdfDate(date = /* @__PURE__ */ new Date()) {
   const SS = z(date.getUTCSeconds());
   return `D:${YYYY}${MM}${DD}${HH}${mm}${SS}`;
 }
+const MixedTextAlignment = Symbol("mixed");
+const TEXT_ALIGNMENT_INFOS = Object.freeze([
+  { id: PdfTextAlignment.Left, label: "Left", css: "left" },
+  { id: PdfTextAlignment.Center, label: "Center", css: "center" },
+  { id: PdfTextAlignment.Right, label: "Right", css: "right" }
+]);
+const enumToTextInfo = TEXT_ALIGNMENT_INFOS.reduce(
+  (m, info) => {
+    m[info.id] = info;
+    return m;
+  },
+  {}
+);
+const cssToTextEnum = TEXT_ALIGNMENT_INFOS.reduce(
+  (m, info) => {
+    m[info.css] = info.id;
+    return m;
+  },
+  {}
+);
+function getTextAlignmentInfo(alignment) {
+  return enumToTextInfo[alignment] ?? enumToTextInfo[PdfTextAlignment.Left];
+}
+function textAlignmentToCss(alignment) {
+  return getTextAlignmentInfo(alignment).css;
+}
+function cssToTextAlignment(value) {
+  return cssToTextEnum[value];
+}
+function textAlignmentLabel(alignment) {
+  return getTextAlignmentInfo(alignment).label;
+}
+function reduceTextAlignments(values) {
+  if (!values.length) return PdfTextAlignment.Left;
+  const first = values[0];
+  return values.every((a) => a === first) ? first : MixedTextAlignment;
+}
+const textAlignmentSelectOptions = TEXT_ALIGNMENT_INFOS.map((info) => ({
+  value: info.id,
+  label: info.label
+}));
+var PdfStandardFontFamily = /* @__PURE__ */ ((PdfStandardFontFamily2) => {
+  PdfStandardFontFamily2["Courier"] = "Courier";
+  PdfStandardFontFamily2["Helvetica"] = "Helvetica";
+  PdfStandardFontFamily2["Times"] = "Times";
+  PdfStandardFontFamily2["Symbol"] = "Symbol";
+  PdfStandardFontFamily2["ZapfDingbats"] = "ZapfDingbats";
+  PdfStandardFontFamily2["Unknown"] = "Unknown";
+  return PdfStandardFontFamily2;
+})(PdfStandardFontFamily || {});
+const DEFAULT_FALLBACK_FONT = PdfStandardFont.Helvetica;
+const MixedStandardFont = Symbol("mixed");
+const HELVETICA_DESC = {
+  id: PdfStandardFont.Helvetica,
+  family: "Helvetica",
+  bold: false,
+  italic: false,
+  label: "Helvetica",
+  css: "Helvetica, Arial, sans-serif"
+};
+const STANDARD_FONT_DESCRIPTORS = Object.freeze([
+  {
+    id: PdfStandardFont.Courier,
+    family: "Courier",
+    bold: false,
+    italic: false,
+    label: "Courier",
+    css: "Courier, monospace"
+  },
+  {
+    id: PdfStandardFont.Courier_Bold,
+    family: "Courier",
+    bold: true,
+    italic: false,
+    label: "Courier Bold",
+    css: '"Courier-Bold", Courier, monospace'
+  },
+  {
+    id: PdfStandardFont.Courier_BoldOblique,
+    family: "Courier",
+    bold: true,
+    italic: true,
+    label: "Courier Bold Oblique",
+    css: '"Courier-BoldOblique", Courier, monospace'
+  },
+  {
+    id: PdfStandardFont.Courier_Oblique,
+    family: "Courier",
+    bold: false,
+    italic: true,
+    label: "Courier Oblique",
+    css: '"Courier-Oblique", Courier, monospace'
+  },
+  HELVETICA_DESC,
+  {
+    id: PdfStandardFont.Helvetica_Bold,
+    family: "Helvetica",
+    bold: true,
+    italic: false,
+    label: "Helvetica Bold",
+    css: '"Helvetica-Bold", Arial, sans-serif'
+  },
+  {
+    id: PdfStandardFont.Helvetica_BoldOblique,
+    family: "Helvetica",
+    bold: true,
+    italic: true,
+    label: "Helvetica Bold Oblique",
+    css: '"Helvetica-BoldOblique", Arial, sans-serif'
+  },
+  {
+    id: PdfStandardFont.Helvetica_Oblique,
+    family: "Helvetica",
+    bold: false,
+    italic: true,
+    label: "Helvetica Oblique",
+    css: '"Helvetica-Oblique", Arial, sans-serif'
+  },
+  {
+    id: PdfStandardFont.Times_Roman,
+    family: "Times",
+    bold: false,
+    italic: false,
+    label: "Times Roman",
+    css: '"Times New Roman", Times, serif'
+  },
+  {
+    id: PdfStandardFont.Times_Bold,
+    family: "Times",
+    bold: true,
+    italic: false,
+    label: "Times Bold",
+    css: '"Times New Roman Bold", Times, serif'
+  },
+  {
+    id: PdfStandardFont.Times_BoldItalic,
+    family: "Times",
+    bold: true,
+    italic: true,
+    label: "Times Bold Italic",
+    css: '"Times New Roman Bold Italic", Times, serif'
+  },
+  {
+    id: PdfStandardFont.Times_Italic,
+    family: "Times",
+    bold: false,
+    italic: true,
+    label: "Times Italic",
+    css: '"Times New Roman Italic", Times, serif'
+  },
+  {
+    id: PdfStandardFont.Symbol,
+    family: "Symbol",
+    bold: false,
+    italic: false,
+    label: "Symbol",
+    css: "Symbol"
+  },
+  {
+    id: PdfStandardFont.ZapfDingbats,
+    family: "ZapfDingbats",
+    bold: false,
+    italic: false,
+    label: "Zapf Dingbats",
+    css: "ZapfDingbats"
+  }
+]);
+const idToDescriptor = STANDARD_FONT_DESCRIPTORS.reduce((m, d) => (m[d.id] = d, m), {});
+const familyStyleToId = /* @__PURE__ */ new Map();
+for (const d of STANDARD_FONT_DESCRIPTORS) {
+  familyStyleToId.set(`${d.family}_${d.bold}_${d.italic}`, d.id);
+}
+function unknownDescriptor() {
+  return HELVETICA_DESC;
+}
+function getStandardFontDescriptor(font) {
+  return idToDescriptor[font] ?? unknownDescriptor();
+}
+function standardFontFamily(font) {
+  return getStandardFontDescriptor(font).family;
+}
+function standardFontIsBold(font) {
+  return getStandardFontDescriptor(font).bold;
+}
+function standardFontIsItalic(font) {
+  return getStandardFontDescriptor(font).italic;
+}
+function makeStandardFont(family, { bold, italic }) {
+  return familyStyleToId.get(`${family}_${bold}_${italic}`) ?? DEFAULT_FALLBACK_FONT;
+}
+function standardFontLabel(font) {
+  return getStandardFontDescriptor(font).label;
+}
+function standardFontCss(font) {
+  return getStandardFontDescriptor(font).css;
+}
+const standardFontFamilySelectOptions = Object.values(PdfStandardFontFamily).filter(
+  (f) => f !== "Unknown"
+  /* Unknown */
+).map((family) => ({ value: family, label: family }));
+function reduceStandardFonts(fonts) {
+  if (!fonts.length) return PdfStandardFont.Unknown;
+  const first = fonts[0];
+  return fonts.every((f) => f === first) ? first : MixedStandardFont;
+}
+const STANDARD_FONT_FAMILIES = [
+  ...new Set(STANDARD_FONT_DESCRIPTORS.map((d) => d.family))
+];
+function standardFontFamilyLabel(fam) {
+  switch (fam) {
+    case "Courier":
+      return "Courier";
+    case "Helvetica":
+      return "Helvetica";
+    case "Times":
+      return "Times";
+    case "Symbol":
+      return "Symbol";
+    case "ZapfDingbats":
+      return "ZapfDingbats";
+    /* fallback */
+    default:
+      return "Helvetica";
+  }
+}
+const MixedBlendMode = Symbol("mixed");
+const BLEND_MODE_INFOS = Object.freeze([
+  { id: PdfBlendMode.Normal, label: "Normal", css: "normal" },
+  { id: PdfBlendMode.Multiply, label: "Multiply", css: "multiply" },
+  { id: PdfBlendMode.Screen, label: "Screen", css: "screen" },
+  { id: PdfBlendMode.Overlay, label: "Overlay", css: "overlay" },
+  { id: PdfBlendMode.Darken, label: "Darken", css: "darken" },
+  { id: PdfBlendMode.Lighten, label: "Lighten", css: "lighten" },
+  { id: PdfBlendMode.ColorDodge, label: "Color Dodge", css: "color-dodge" },
+  { id: PdfBlendMode.ColorBurn, label: "Color Burn", css: "color-burn" },
+  { id: PdfBlendMode.HardLight, label: "Hard Light", css: "hard-light" },
+  { id: PdfBlendMode.SoftLight, label: "Soft Light", css: "soft-light" },
+  { id: PdfBlendMode.Difference, label: "Difference", css: "difference" },
+  { id: PdfBlendMode.Exclusion, label: "Exclusion", css: "exclusion" },
+  { id: PdfBlendMode.Hue, label: "Hue", css: "hue" },
+  { id: PdfBlendMode.Saturation, label: "Saturation", css: "saturation" },
+  { id: PdfBlendMode.Color, label: "Color", css: "color" },
+  { id: PdfBlendMode.Luminosity, label: "Luminosity", css: "luminosity" }
+]);
+const enumToInfo = BLEND_MODE_INFOS.reduce(
+  (m, info) => {
+    m[info.id] = info;
+    return m;
+  },
+  {}
+);
+const cssToEnum = BLEND_MODE_INFOS.reduce(
+  (m, info) => {
+    m[info.css] = info.id;
+    return m;
+  },
+  {}
+);
+function getBlendModeInfo(mode) {
+  return enumToInfo[mode] ?? enumToInfo[PdfBlendMode.Normal];
+}
+function blendModeToCss(mode) {
+  return getBlendModeInfo(mode).css;
+}
+function cssToBlendMode(value) {
+  return cssToEnum[value];
+}
+function blendModeLabel(mode) {
+  return getBlendModeInfo(mode).label;
+}
+function reduceBlendModes(modes) {
+  if (!modes.length) return PdfBlendMode.Normal;
+  const first = modes[0];
+  return modes.every((m) => m === first) ? first : MixedBlendMode;
+}
+const blendModeSelectOptions = BLEND_MODE_INFOS.map((info) => ({
+  value: info.id,
+  label: info.label
+}));
+function uiBlendModeDisplay(value) {
+  return value === MixedBlendMode ? "(mixed)" : blendModeLabel(value);
+}
 function ignore() {
 }
 export {
@@ -1358,6 +1636,8 @@ export {
   LogLevel,
   MatchFlag,
   MixedBlendMode,
+  MixedStandardFont,
+  MixedTextAlignment,
   NoopLogger,
   PDF_FORM_FIELD_FLAG,
   PDF_FORM_FIELD_TYPE,
@@ -1385,14 +1665,19 @@ export {
   PdfPermission,
   PdfSegmentObjectType,
   PdfSoftHyphenMarker,
+  PdfStandardFont,
+  PdfStandardFontFamily,
   PdfTaskHelper,
+  PdfTextAlignment,
   PdfUnwantedTextMarkers,
   PdfUnwantedTextRegex,
+  PdfVerticalAlignment,
   PdfWordJoiner,
   PdfZeroWidthSpace,
   PdfZoomMode,
   PerfLogger,
   Rotation,
+  STANDARD_FONT_FAMILIES,
   Task,
   TaskAbortedError,
   TaskRejectedError,
@@ -1403,22 +1688,34 @@ export {
   boundingRect,
   calculateAngle,
   calculateDegree,
+  combinePdfColorWithAlpha,
+  combineWebColorWithOpacity,
   compareSearchTarget,
   cssToBlendMode,
+  cssToTextAlignment,
   dateToPdfDate,
   expandRect,
+  extractPdfColor,
+  extractWebOpacity,
   flagsToNames,
   getBlendModeInfo,
+  getStandardFontDescriptor,
+  getTextAlignmentInfo,
   ignore,
   makeMatrix,
+  makeStandardFont,
   namesToFlags,
   pdfAlphaColorToWebAlphaColor,
+  pdfAlphaToWebOpacity,
+  pdfColorToWebColor,
   pdfDateToDate,
   quadToRect,
   rectEquals,
   rectFromPoints,
   rectToQuad,
   reduceBlendModes,
+  reduceStandardFonts,
+  reduceTextAlignments,
   restoreOffset,
   restorePosition,
   restoreRect,
@@ -1427,8 +1724,18 @@ export {
   rotateRect,
   scalePosition,
   scaleRect,
+  standardFontCss,
+  standardFontFamily,
+  standardFontFamilyLabel,
+  standardFontFamilySelectOptions,
+  standardFontIsBold,
+  standardFontIsItalic,
+  standardFontLabel,
   stripPdfUnwantedMarkers,
   swap,
+  textAlignmentLabel,
+  textAlignmentSelectOptions,
+  textAlignmentToCss,
   toIntPos,
   toIntRect,
   toIntSize,
@@ -1437,6 +1744,8 @@ export {
   transformSize,
   uiBlendModeDisplay,
   unionFlags,
-  webAlphaColorToPdfAlphaColor
+  webAlphaColorToPdfAlphaColor,
+  webColorToPdfColor,
+  webOpacityToPdfAlpha
 };
 //# sourceMappingURL=index.js.map