feat(runner): color schema

Author: Novout

README.md

@@ -124,24 +124,40 @@ pdfeasy.new({
 
 ## Runner Options
 
+### Client-Side Setup
+
 ```ts
 pdfeasy.run({
   type: 'client',
-  clientEmit: 'save'
-}).then(() => {}).catch((err: any) => {
+  clientEmit: 'save',
+}).then(() => {}).catch((err) => {
   console.error(err)
 })
 ```
 
+### Server-Side Setup
+
 ```ts
 pdfeasy.run({
   type: 'server',
-  serverPath: path.resolve(process.cwd() + '/examples')
-}).then(() => {}).catch((err: any) => {
+  serverPath: path.resolve(process.cwd() + '/examples'),
+}).then(() => {}).catch((err) => {
   console.error(err)
 })
 ```
 
+### Color Schema
+
+It is possible to define the color scheme used automatically:
+
+```ts
+// converts all hex color to cmyk
+pdfeasy.run({ colorSchema: 'CMYK' })
+
+// converts all hex color to rgb
+pdfeasy.run({ colorSchema: 'RBG' })
+```
+
 ## Custom Fonts
 
 ```ts
@@ -169,8 +185,6 @@ See [scripts](./scripts/generate/) for server-side runner.
 
 ## Bundles
 
-> **Attention!** Its recommended use explicit imports (*import pdfeasy from 'pdfeasy/dist/client.esm.js'*) in your projects.
-
 `pdfeasy/dist/client.cjs.js`
 
 `pdfeasy/dist/client.esm.js`

demo/src/main.ts

@@ -42,7 +42,7 @@ pdfeasy.addFonts([
   }
 ])
 
-pdfeasy.run().then((blob: string) => {
+pdfeasy.run({ colorSchema: 'CMYK' }).then((blob: string) => {
   const iframe = document.querySelector('#pdf') as HTMLIFrameElement
 
   iframe.src = blob

src/pipe/factory.ts

@@ -1,12 +1,19 @@
-import {
+import type {
   Content,
   ContentText,
   ContentImage,
   PDFEasyDefaults,
   InternalGlobals,
+  HexColor,
+  RunOptionsBase,
 } from '../types'
 import { getCorrectFontFamily } from './transform'
 import { getImageRaw, SvgToPNG } from '../content/image'
+import { HEXToCMYK } from 'src/schema/color'
+
+export const resolveColor = (color: HexColor, run: RunOptionsBase) => {
+  return run?.colorSchema === 'CMYK' ? HEXToCMYK(color) : color
+}
 
 export const resolveCover = async (app: PDFKit.PDFDocument, based: string) => {
   const { raw } = await getImageRaw(based)
@@ -23,7 +30,8 @@ export const resolveContent = async (
   app: PDFKit.PDFDocument,
   defaults: PDFEasyDefaults,
   content: Content,
-  globals: InternalGlobals
+  globals: InternalGlobals,
+  run: RunOptionsBase
 ) => {
   const addStack = async () => {
     const stack = content.stack as Content[]
@@ -41,7 +49,7 @@ export const resolveContent = async (
           )
         )
         .fontSize(entity.text.fontSize || defaults.text.fontSize)
-        .fillColor(entity.text.color || defaults.text.color)
+        .fillColor(resolveColor(entity.text.color || defaults.text.color, run))
         .fillOpacity(entity.text.opacity || defaults.text.opacity)
         .text(entity.raw, {
           continued: !isLast,
@@ -66,7 +74,7 @@ export const resolveContent = async (
     await app
       .font(getCorrectFontFamily(style?.font || defaults.text.font, style))
       .fontSize(style?.fontSize || defaults.text.fontSize)
-      .fillColor(style?.color || defaults.text.color)
+      .fillColor(resolveColor(style?.color || defaults.text.color, run))
       .fillOpacity(style?.opacity || defaults.text.opacity)
       .text(data, {
         indent: style?.indent || defaults.text.indent,
@@ -84,7 +92,7 @@ export const resolveContent = async (
     await app
       .font(getCorrectFontFamily(defaults.text.font, {}))
       .fontSize(defaults.text.fontSize)
-      .fillColor(defaults.text.color)
+      .fillColor(resolveColor(defaults.text.color, run))
       .fillOpacity(defaults.text.opacity)
       .text(content.raw, {
         indent: defaults.text.indent,
@@ -143,10 +151,14 @@ export const resolveContent = async (
   }
 
   const addCheckbox = async () => {
-    const backgroundColor =
-      content.checkbox?.backgroundColor ?? defaults.checkbox.backgroundColor
-    const borderColor =
-      content.checkbox?.borderColor ?? defaults.checkbox.borderColor
+    const backgroundColor = resolveColor(
+      content.checkbox?.backgroundColor ?? defaults.checkbox.backgroundColor,
+      run
+    )
+    const borderColor = resolveColor(
+      content.checkbox?.borderColor ?? defaults.checkbox.borderColor,
+      run
+    )
     const size = content.checkbox?.size ?? defaults.checkbox.size
 
     app.initForm()
@@ -170,7 +182,7 @@ export const resolveContent = async (
       app
         .circle(app.x + 4, app.y + 6, 3)
         .lineWidth(1)
-        .fill('#000')
+        .fill(resolveColor('#000000', run))
 
       await addText(false, `    ${content.raw}`)
     }

src/runner/pdfeasy.ts

@@ -141,7 +141,8 @@ export default class {
         this.pdfkit as typeof PDFDocument,
         this.def,
         content,
-        this.globals
+        this.globals,
+        this.optionsRun
       )
     }
   }

src/schema/color.ts

@@ -0,0 +1,47 @@
+import { HexColor } from 'src/types'
+
+export const HEXToCMYK = (
+  color: HexColor
+): [number, number, number, number] | HexColor => {
+  let C = 0
+  let M = 0
+  let Y = 0
+  let K = 0
+
+  const hex = color.charAt(0) == '#' ? color.substring(1, 7) : color
+
+  if (hex.length != 6) {
+    return color
+  }
+
+  const r = parseInt(hex.substring(0, 2), 16)
+  const g = parseInt(hex.substring(2, 4), 16)
+  const b = parseInt(hex.substring(4, 6), 16)
+
+  if (r === 0 && g === 0 && b === 0) {
+    return [0, 0, 0, 100]
+  }
+
+  C = 1 - r / 255
+  M = 1 - g / 255
+  Y = 1 - b / 255
+
+  const minCMY = Math.min(C, Math.min(M, Y))
+
+  C = (C - minCMY) / (1 - minCMY)
+  M = (M - minCMY) / (1 - minCMY)
+  Y = (Y - minCMY) / (1 - minCMY)
+  K = minCMY
+
+  C = Math.round(C * 100)
+  M = Math.round(M * 100)
+  Y = Math.round(Y * 100)
+  K = Math.round(K * 100)
+
+  C = Number(C.toFixed(0)) ?? 0
+  M = Number(M.toFixed(0)) ?? 0
+  Y = Number(Y.toFixed(0)) ?? 0
+  K = Number(K.toFixed(0)) ?? 0
+
+  return [C, M, Y, K]
+}

src/types.ts

@@ -30,6 +30,10 @@ export type PDFRunEmitOption = 'save' | 'blob' | 'none'
 
 export type TextAlign = 'start' | 'center' | 'end' | 'justify'
 
+export type ColorSchema = 'RGB' | 'CMYK'
+
+export type HexColor = string | `#${string}`
+
 export type EmitterType = {}
 
 export interface InternalGlobals {
@@ -301,4 +305,10 @@ export interface RunOptions {
    *  Required in {@link RunOptions} type: server
    */
   serverPath?: string
+  /**
+   *  Server file destination
+   *
+   *  @default 'rgb'
+   */
+  colorSchema?: ColorSchema
 }