officeparser 3.3.0 → 4.0.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "officeparser",
-  "version": "3.3.0",
-  "description": "A Node.js library to parse text out of any office file. Currently supports docx, pptx, xlsx, odt, odp and ods files.",
+  "version": "4.0.0",
+  "description": "A Node.js library to parse text out of any office file. Currently supports docx, pptx, xlsx, odt, odp, ods, pdf files.",
   "main": "officeParser.js",
   "files": [
     "officeParser.js",
@@ -24,6 +24,7 @@
     "odt",
     "odp",
     "ods",
+    "pdf",
     "parser",
     "text",
     "extract text",
@@ -44,10 +45,13 @@
     "decompress": "^4.2.0",
     "file-type": "^16.5.4",
     "rimraf": "^2.6.3",
-    "xml2js": "^0.5.0"
+    "xmldom": "^0.6.0",
+    "pdf-parse": "^1.1.1"
   },
   "devDependencies": {
+    "@types/decompress": "^4.2.6",
     "@types/node": "^18.16.1",
+    "@types/xmldom": "^0.1.33",
     "typescript": "^5.0.3"
   }
 }

package/typings/officeParser.d.ts

@@ -1,82 +1,44 @@
 #!/usr/bin/env node
-/** Main function for parsing text from word files
- * @param {string} filename File path
- * @param {function} callback Callback function that returns value or error
- * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {void}
- */
-export function parseWord(filename: string, callback: Function, deleteOfficeDist?: boolean): void;
-/** Main function for parsing text from PowerPoint files
- * @param {string} filename File path
- * @param {function} callback Callback function that returns value or error
- * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {void}
- */
-export function parsePowerPoint(filename: string, callback: Function, deleteOfficeDist?: boolean): void;
-/** Main function for parsing text from Excel files
- * @param {string} filename File path
- * @param {function} callback Callback function that returns value or error
- * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {void}
- */
-export function parseExcel(filename: string, callback: Function, deleteOfficeDist?: boolean): void;
-/** Main function for parsing text from open office files
- * @param {string} filename File path
- * @param {function} callback Callback function that returns value or error
- * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {void}
- */
-export function parseOpenOffice(filename: string, callback: Function, deleteOfficeDist?: boolean): void;
+export type OfficeParserConfig = {
+    /**
+     * Flag to not delete the internal content files and the duplicate temp files that it uses after unzipping office files. Default is false. It deletes all of those files.
+     */
+    preserveTempFiles: boolean;
+    /**
+     * Flag to show all the logs to console in case of an error irrespective of your own handling.
+     */
+    outputErrorToConsole: boolean;
+    /**
+     * The delimiter used for every new line in places that allow multiline text like word. Default is \n.
+     */
+    newlineDelimiter: string;
+    /**
+     * Flag to ignore notes from parsing in files like powerpoint. Default is false. It includes notes in the parsed text by default.
+     */
+    ignoreNotes: boolean;
+    /**
+     * Flag, if set to true, will collectively put all the parsed text from notes at last in files like powerpoint. Default is false. It puts each notes right after its main slide content. If ignoreNotes is set to true, this flag is also ignored.
+     */
+    putNotesAtLast: boolean;
+};
 /** Main async function with callback to execute parseOffice for supported files
- * @param {string | Buffer} file File path or file buffers
- * @param {function} callback Callback function that returns value or error
- * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
+ * @param {string | Buffer}    file     File path or file buffers
+ * @param {function}           callback Callback function that returns value or error
+ * @param {OfficeParserConfig} config   [OPTIONAL]: Config Object for officeParser
  * @returns {void}
  */
-export function parseOffice(file: string | Buffer, callback: Function, deleteOfficeDist?: boolean): void;
-/** Async function that can be used with await to execute parseWord. Or it can be used with promises.
- * @param {string} filename File path
- * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {Promise<string>}
- */
-export function parseWordAsync(filename: string, deleteOfficeDist?: boolean): Promise<string>;
-/** Async function that can be used with await to execute parsePowerPoint. Or it can be used with promises.
- * @param {string} filename File path
- * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {Promise<string>}
- */
-export function parsePowerPointAsync(filename: string, deleteOfficeDist?: boolean): Promise<string>;
-/** Async function that can be used with await to execute parseExcel. Or it can be used with promises.
- * @param {string} filename File path
- * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {Promise<string>}
- */
-export function parseExcelAsync(filename: string, deleteOfficeDist?: boolean): Promise<string>;
-/** Async function that can be used with await to execute parseOpenOffice. Or it can be used with promises.
- * @param {string} filename File path
- * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
- * @returns {Promise<string>}
- */
-export function parseOpenOfficeAsync(filename: string, deleteOfficeDist?: boolean): Promise<string>;
+export function parseOffice(file: string | Buffer, callback: Function, config?: OfficeParserConfig): void;
 /**
  * Main async function that can be used with await to execute parseOffice. Or it can be used with promises.
- * @param {string | Buffer} file File path or file buffers
- * @param {boolean} [deleteOfficeDist=true] Optional: Delete the officeDist directory created while unarchiving the doc file to get its content underneath. By default, we delete those files after we are done reading them.
+ * @param {string | Buffer}    file   File path or file buffers
+ * @param {OfficeParserConfig} config [OPTIONAL]: Config Object for officeParser
  * @returns {Promise<string>}
  */
-export function parseOfficeAsync(file: string | Buffer, deleteOfficeDist?: boolean): Promise<string>;
+export function parseOfficeAsync(file: string | Buffer, config: OfficeParserConfig): Promise<string>;
 /**
  * Set decompression directory. The final decompressed data will be put inside officeDist folder within your directory
  * @param {string} newLocation Relative path to the directory that will contain officeDist folder with decompressed data
  * @returns {void}
  */
 export function setDecompressionLocation(newLocation: string): void;
-/** Enable console output
- * @returns {void}
- */
-export function enableConsoleOutput(): void;
-/** Disabled console output
- * @returns {void}
- */
-export function disableConsoleOutput(): void;
 //# sourceMappingURL=officeParser.d.ts.map