rewrite: make it modular

[gamemaker1]

Checklist

• The issues that this pull request is related to/fixes are mentioned.
• The purpose of this pull request is explained.
• The changes made to the code, as well as the documentation have been explained.
• The tests, lint & style checks all pass.
• The documentation has been updated to reflect the changes made in this pull request.

Related Issues

• Fixes Cant use external url/path #4 and Read file from base64 string #5.

Overview

This pull request rewrites the library to make it easier to add more text extraction methods. It also allows extraction from a file, buffer or a url.

The API is now as follows -

import { getTextExtractor } from 'office-text-extractor'

const extractor = getTextExtractor()

const location = 'https://raw.githubusercontent.com/gamemaker1/office-text-extractor/rewrite/test/fixtures/test-pdf.pdf'
const text = await extractor.extractText({
	input: location,
	type: 'url'
})

console.log(text)

[kibertoad]

Looking forward to this being finished!

[gamemaker1]

It should be done in the next few days :)

[kibertoad]

@gamemaker1 Any chance you could publish an RC/beta version, if it's already working to some extent? We are doing feasibility study right now, and if we can confirm that this works, we can stop exploring other libraries.

[gamemaker1]

Sure, I could release a beta version right now.

It only works on pdf and docx files yet, though.

[kibertoad]

@gamemaker1 Perfect, this is exactly the formats that we are interested in!

[gamemaker1]

@kibertoad I published the version in this PR as v3.0.0-beta.1, you can install it via npm install office-text-extractor@next.

[kibertoad]

much appreciated!

[kibertoad]

@gamemaker1 Types seem to be not included in the bundle, was that intentional?

[gamemaker1]

No, let me check it out

[gamemaker1]

Re-published with types! I hadn't added the declaration: true option to the tsconfig file, so Typescript didn't generate types. Sorry about that :(

[kibertoad]

It works! thank you so much

[gamemaker1]

Yay!

[wllvns]

this is great! Any timeline on the pptx. (etc) support in v3? Thank you!

[gamemaker1]

@wllvns released v3.0.1 right now, with pdf, docx, pptx and xlsx support.