feat(ghoulscrupt): add option for additional args

adenvt · adenvt · commit 7ed5075838b5 · 2024-07-17T15:50:55.000+07:00
diff --git a/packages/ghostscript/build/post-build.js b/packages/ghostscript/build/post-build.js
@@ -20,9 +20,7 @@ async function createMeta () {
   }
 
   await writeFile(resolve(_dirname, '../dist/meta.cjs'), `module.export = ${JSON.stringify(meta)}${EOL}`)
-
   await writeFile(resolve(_dirname, '../dist/meta.mjs'), `export default ${JSON.stringify(meta)}${EOL}`)
-
   await copyFile(resolve(_dirname, './meta.d.ts'), resolve(_dirname, '../dist/meta.d.ts'))
 }
 
diff --git a/packages/ghoulscript/README.md b/packages/ghoulscript/README.md
@@ -56,17 +56,21 @@ await fs.writeFile(resolve(__dirname, './sample.compressed.pdf'), output)
 
 #### CompressOptions
 
-| Options                   |   Type    | Default  | Description                                                                        |
-|---------------------------|:---------:|:--------:|------------------------------------------------------------------------------------|
-| `password`                | `String`  |    -     | Document protection password                                                       |
-| `pdfSettings`             | `String`  | `screen` | Preset setting, valid value is `screen`, `ebook`, `printer`, `prepress`, `default` |
-| `fastWebView`             | `Boolean` |  `true`  | Enable Fast Web View (Linearization)                                               |
-| `compatibilityLevel`      | `String`  |  `1.4`   | Compability version                                                                |
-| `colorConversionStrategy` | `String`  |  `RGB`   | Color conversion strategy, valid value is `RGB`, `CMYK`                            |
-| `noTransparency`          | `Boolean` |  `true`  | Remove transparency                                                                |
-| `keepPassword`            | `Boolean` |  `true`  | Keep document password if document have a password protection                      |
-| `userPassword`            | `String`  |    -     | Set User Password to document                                                      |
-| `ownerPassword`           | `String`  |    -     | Set Owner Password to document                                                     |
+| Options                   |    Type    | Default  | Description                                                                        |
+|---------------------------|:----------:|:--------:|------------------------------------------------------------------------------------|
+| `password`                |  `String`  |    -     | Document protection password                                                       |
+| `pdfSettings`             |  `String`  | `screen` | Preset setting, valid value is `screen`, `ebook`, `printer`, `prepress`, `default` |
+| `fastWebView`             | `Boolean`  |  `true`  | Enable Fast Web View (Linearization)                                               |
+| `compatibilityLevel`      |  `String`  |  `1.4`   | Compability version                                                                |
+| `colorConversionStrategy` |  `String`  |  `RGB`   | Color conversion strategy, valid value is `RGB`, `CMYK`                            |
+| `noTransparency`          | `Boolean`  |  `true`  | Remove transparency                                                                |
+| `keepPassword`            | `Boolean`  |  `true`  | Keep document password if document have a password protection                      |
+| `userPassword`            |  `String`  |    -     | Set User Password to document                                                      |
+| `ownerPassword`           |  `String`  |    -     | Set Owner Password to document                                                     |
+| `colorImageResolution`    |  `Number`  |   300    | Color image resolution                                                             |
+| `grayImageResolution`     |  `Number`  |   300    | Gray image resolution                                                              |
+| `monoImageResolution`     |  `Number`  |   300    | Mono image resolution                                                              |
+| `args`                    | `String[]` |    -     | Additional arguments                                                               |
 
 ### combinePDF (files: Buffer[], options?: CompressOptions)
 
@@ -141,12 +145,13 @@ await fs.writeFile(resolve(__dirname, './sample.jpg'), output)
 
 #### RenderOptions
 
-| Options             |   Type   | Default | Description                                  |
-|---------------------|:--------:|:-------:|----------------------------------------------|
-| `resolution`        | `Number` |  `96`   | Render resolution                            |
-| `textAlphaBits`     | `Number` |   `4`   | Text alpha bits, valid value is `1`-`4`      |
-| `graphicsAlphaBits` | `Number` |   `4`   | Graphic alpha bits, valid value is `1`-`4`   |
-| `format`            | `String` |  `jpg`  | Render format, valid value is `jpg` or `png` |
+| Options             |    Type    | Default | Description                                  |
+|---------------------|:----------:|:-------:|----------------------------------------------|
+| `resolution`        |  `Number`  |  `96`   | Render resolution                            |
+| `textAlphaBits`     |  `Number`  |   `4`   | Text alpha bits, valid value is `1`-`4`      |
+| `graphicsAlphaBits` |  `Number`  |   `4`   | Graphic alpha bits, valid value is `1`-`4`   |
+| `format`            |  `String`  |  `jpg`  | Render format, valid value is `jpg` or `png` |
+| `args`              | `String[]` |    -    | Additional arguments                         |
 
 ## getInfo (file: Buffer, options?: { password: string })
 
diff --git a/packages/ghoulscript/build.config.ts b/packages/ghoulscript/build.config.ts
diff --git a/packages/ghoulscript/package.json b/packages/ghoulscript/package.json
@@ -18,13 +18,15 @@
   ],
   "scripts": {
     "prepare": "yarn build",
-    "build": "unbuild",
+    "build": "vite build",
     "test": "node --test"
   },
   "devDependencies": {
-    "jiti": "1.21.0",
     "typescript": "5.4.5",
-    "unbuild": "3.0.0-rc.6"
+    "vite": "^5.3.3",
+    "vite-plugin-dts": "^3.9.1",
+    "vite-plugin-externalize-deps": "^0.8.0",
+    "vite-plugin-node-polyfills": "^0.22.0"
   },
   "dependencies": {
     "@privyid/ghostscript": "workspace:^",
diff --git a/packages/ghoulscript/src/core.ts b/packages/ghoulscript/src/core.ts
@@ -61,6 +61,25 @@ export interface CompressOptions {
    * createPDF({ pageList: ['1-3', '6-10'] })
    */
   pageList?: PageList,
+  /**
+   * Color image resolution
+   * @default 300
+   */
+  colorImageResolution: number,
+  /**
+   * Gray image resolution
+   * @default 300
+   */
+  grayImageResolution: number,
+  /**
+   * Monochrome image resolution
+   * @default 300
+   */
+  monoImageResolution: number,
+  /**
+   * Additional arguments to Ghostscript
+   */
+  args: string[],
 }
 
 type InputFile = ArrayBufferView | Blob
@@ -81,9 +100,14 @@ async function createPDF (inputs: InputFile[], options: Partial<CompressOptions>
     fastWebView            : true,
     noTransparency         : true,
     keepPassword           : true,
+    colorImageResolution   : 300,
+    grayImageResolution    : 300,
+    monoImageResolution    : 300,
+    args                   : [],
   })
 
   const args = [
+    ...opts.args,
     '-dQUIET',
     '-dNOPAUSE',
     '-dBATCH',
@@ -132,6 +156,9 @@ async function createPDF (inputs: InputFile[], options: Partial<CompressOptions>
     `-sColorConversionStrategy=${opts.colorConversionStrategy}`,
     `-dPDFSETTINGS=/${opts.pdfSettings}`,
     `-dFastWebView=${opts.fastWebView.toString()}`,
+    `-dColorImageResolution=${opts.colorImageResolution}`,
+    `-dGrayImageResolution=${opts.grayImageResolution}`,
+    `-dMonoImageResolution=${opts.monoImageResolution}`,
     '-sOutputFile=./output',
   )
 
@@ -227,6 +254,10 @@ export interface RenderOptions {
    * @default 'jpg'
    */
   format: 'jpg' | 'png',
+  /**
+   * Additional arguments to Ghostscript
+   */
+  args: string[],
 }
 
 /**
@@ -243,10 +274,12 @@ export async function renderPageAsImage (input: InputFile, pageNumber: number =
     graphicsAlphaBits: 4,
     textAlphaBits    : 4,
     resolution       : 96,
+    args             : [],
   })
 
   const device = opts.format === 'png' ? 'png16m' : 'jpeg'
   const args   = [
+    ...opts.args,
     '-dQUIET',
     '-dNOPAUSE',
     '-dBATCH',
diff --git a/packages/ghoulscript/src/rpc.ts b/packages/ghoulscript/src/rpc.ts
@@ -1,4 +1,5 @@
 import * as core from './core'
+import RpcWorker from './rpc.worker?worker&inline'
 
 export type Core = typeof core
 
@@ -24,7 +25,7 @@ let worker: Worker
 
 export async function useWorkerRPC () {
   if (!worker)
-    worker = new Worker(new URL('rpc.worker.mjs', import.meta.url), { type: 'module' })
+    worker = new RpcWorker({ name: 'rpc-worker' })
 
   return worker
 }
diff --git a/packages/ghoulscript/tsconfig.json b/packages/ghoulscript/tsconfig.json
@@ -23,7 +23,8 @@
     "strict": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
-    "noFallthroughCasesInSwitch": true
+    "noFallthroughCasesInSwitch": true,
+    "types": ["vite/client"]
   },
   "include": ["src", "tests"]
 }
diff --git a/packages/ghoulscript/vite.config.ts b/packages/ghoulscript/vite.config.ts
@@ -0,0 +1,29 @@
+import { defineConfig } from 'vite'
+import dts from 'vite-plugin-dts'
+import { nodePolyfills } from 'vite-plugin-node-polyfills'
+import { externalizeDeps } from 'vite-plugin-externalize-deps'
+
+export default defineConfig({
+  plugins: [
+    dts({ rollupTypes: true }),
+    nodePolyfills(),
+    externalizeDeps(),
+  ],
+  build: {
+    minify: false,
+    lib   : {
+      entry  : 'src/index',
+      name   : 'Ghoulscript',
+      formats: ['cjs', 'es'],
+      fileName (format, entryName) {
+        const EXT: Record<string, string> = {
+          cjs: '.cjs',
+          es : '.mjs',
+          umd: '.umd.cjs',
+        }
+
+        return `${entryName}${EXT[format] ?? '.js'}`
+      },
+    },
+  },
+})
diff --git a/playground/sample/src/main.ts b/playground/sample/src/main.ts
@@ -9,7 +9,7 @@ function bytes (bytes: number, decimal = 2, k = 1024) {
     return '0 Bytes'
 
   const sizes = [
-    `${bytes > 1 ? 'Bytes' : 'Byte'}`,
+    `${bytes === 1 ? 'Byte' : 'Bytes'}`,
     'KB',
     'MB',
     'GB',
@@ -30,13 +30,14 @@ input?.addEventListener('change', async () => {
 
   if (file) {
     try {
-      const start = performance.now()
+      const start  = performance.now()
+      const result = await optimizePDF(file)
 
-      const result = await optimizePDF(file) as Uint8Array
-      const diff   = Math.round((result.byteLength - file.size) / file.size * 100)
+      const diffBytes = result.byteLength - file.size
+      const diff      = Math.round(diffBytes / file.size * 100)
 
       if (log)
-        log.textContent = `Result: ${bytes(file.size)} => ${bytes(result.byteLength)} (${diff}%), Duration: ${Math.round((performance.now() - start) / 1000)}s`
+        log.textContent = `Result: ${bytes(file.size)} => ${bytes(result.byteLength)} (${diff}%: ${bytes(Math.abs(diffBytes))}), Duration: ${Math.round((performance.now() - start) / 1000)}s`
 
       window.open(URL.createObjectURL(new Blob([result], { type: 'application/pdf' })), '_blank')
     } catch (error) {
diff --git a/playground/sample/vite.config.ts b/playground/sample/vite.config.ts
@@ -1,3 +1,3 @@
 import { defineConfig } from 'vite'
 
-export default defineConfig({ optimizeDeps: { exclude: ['@privyid/ghoulscript'] } })
+export default defineConfig({})
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -20,9 +20,7 @@ async function createMeta () {`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	await writeFile(resolve(_dirname, '../dist/meta.cjs'), `module.export = ${JSON.stringify(meta)}${EOL}`)
`23`		`-`
`24`	`23`	await writeFile(resolve(_dirname, '../dist/meta.mjs'), `export default ${JSON.stringify(meta)}${EOL}`)
`25`		`-`
`26`	`24`	`await copyFile(resolve(_dirname, './meta.d.ts'), resolve(_dirname, '../dist/meta.d.ts'))`
`27`	`25`	`}`
`28`	`26`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`import { defineConfig } from 'vite'`
`2`	`2`
`3`		`-export default defineConfig({ optimizeDeps: { exclude: ['@privyid/ghoulscript'] } })`
	`3`	`+export default defineConfig({})`