libreoffice-convert 1.3.4 → 1.3.7

package/Readme.md

@@ -1,33 +1,38 @@
-# libreoffice-convert #
+# libreoffice-convert
 
 A simple and fast node.js module for converting office documents to different formats.
 
-## Dependency ##
+## Dependency
 
 Please install libreoffice in /Applications (Mac), with your favorite package manager (Linux), or with the msi (Windows).
 
+## Usage example
 
-## Usage example ##
 ```javascript
-const libre = require('libreoffice-convert');
+'use strict';
 
 const path = require('path');
-const fs = require('fs');
-
-const extend = '.pdf'
-const enterPath = path.join(__dirname, '/resources/example.docx');
-const outputPath = path.join(__dirname, `/resources/example${extend}`);
-
-// Read file
-const file = fs.readFileSync(enterPath);
-// Convert it to pdf format with undefined filter (see Libreoffice doc about filter)
-libre.convert(file, extend, undefined, (err, done) => {
-    if (err) {
-      console.log(`Error converting file: ${err}`);
-    }
+const fs = require('fs').promises;
+
+const libre = require('libreoffice-convert');
+libre.convertAsync = require('util').promisify(libre.convert);
+
+async function main() {
+    const ext = '.pdf'
+    const inputPath = path.join(__dirname, '/resources/example.docx');
+    const outputPath = path.join(__dirname, `/resources/example${ext}`);
+
+    // Read file
+    const docxBuf = await fs.readFile(inputPath);
+
+    // Convert it to pdf format with undefined filter (see Libreoffice docs about filter)
+    let pdfBuf = await libre.convertAsync(docxBuf, ext, undefined);
     
     // Here in done you have pdf file which you can save or transfer in another stream
-    fs.writeFileSync(outputPath, done);
+    await fs.writeFile(outputPath, pdfBuf);
+}
+
+main().catch(function (err) {
+    console.log(`Error converting file: ${err}`);
 });
 ```
-

package/index.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="node" />
+declare module "libreoffice-convert" {
+  function convert(
+    document: Buffer,
+    format: string,
+    filter: string | undefined,
+    callback: (err: NodeJS.ErrnoException | null, data: Buffer) => void
+  ): void;
+  function convertWithOptions(
+    document: Buffer,
+    format: string,
+    filter: string | undefined,
+    options: {
+      tmpOptions?: Record<string | number | symbol, unknown>;
+      asyncOptions?: { times?: number; interval?: number };
+    },
+    callback: (err: NodeJS.ErrnoException | null, data: Buffer) => void
+  ): void;
+}

package/index.js

@@ -2,6 +2,7 @@
 
 const fs = require('fs');
 const path = require('path');
+const url = require('url');
 const async = require('async');
 const tmp = require('tmp');
 const { execFile } = require('child_process');
@@ -43,7 +44,7 @@ const convertWithOptions = (document, format, filter, options, callback) => {
         },
         saveSource: callback => fs.writeFile(path.join(tempDir.name, 'source'), document, callback),
         convert: ['soffice', 'saveSource', (results, callback) => {
-            let command = `-env:UserInstallation=file://${installDir.name} --headless --convert-to ${format}`;
+            let command = `-env:UserInstallation=${url.pathToFileURL(installDir.name)} --headless --convert-to ${format}`;
             if (filter !== undefined) {
                 command += `:"${filter}"`;
             }

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "libreoffice-convert",
-  "version": "1.3.4",
+  "version": "1.3.7",
   "description": "A simple and fast node.js module for converting office documents to different formats",
   "main": "index.js",
+  "types": "index.d.ts",
   "repository": "https://github.com/elwerene/libreoffice-convert",
   "keywords": [
     "Libreoffice",
@@ -27,6 +28,7 @@
     "tmp": "^0.2.1"
   },
   "devDependencies": {
+    "@types/node": "^17.0.23",
     "jest": "^24.7.1"
   },
   "engines": {