Features

• Added Basic HTTP Authentication
  • all clients need to 'register' themselves with the server by making a POST request to the /clients endpoint
    • this returns a client ID - API key pair that must be sent in all subsequent requests in the X-Credentials header encoded as follows: base64(<client id>:<api key>)
    • provider-specific credentials like access tokens can be sent in the X-Provider-Credentials header
  • API keys can be replaced by making a POST request with the current API key to the /clients/:clientId endpoint
    • this returns the current client ID and a new API key
  • The client can be deleted by making a DELETE request to /clients/:clientId endpoint
• Add an option (extract-info endpoint) for the user to specify keywords or regex, that when found in the text, should associate the given topic with that file in addition to already identified topics

Changes

• Typescript rewrite
• Remove non-function one-pager endpoint
• Add helmet middleware for basic security
• Add a logger
  • Logs are stored locally ONLY, in the config directory
    • Windows: %APPDATA%\Dabbu Files API Server\logs\files-api-server.log
    • MacOS: /Users/<username>/Library/Dabbu Files API Server/logs/files-api-server.log
    • Linux: ($HOME OR $XDG_CONFIG_HOME)/.config/Dabbu Files API Server/logs/files-api-server.log
  • Logger still doesn't currently log anything, but it will in future versions. These logs may contain sensitive information, please be careful to remove sensitive information while posting them publicly. We will work towards masking this sensitive information.

Docs

• Add API docs
• Add guide for running server on your own
• Add getting started guide for using the APIs in your own client

Builds/CI

• Automatic releases only from the develop branch
• Add bash scripts for all jobs

Tests

• Use jest for tests
  • Add dummy tests
  • Tests are not yet implemented, PRs welcome.

Style/Format

• Add ts files to .editorconfig
• Use ESLint to lint typescript files

Maintenance

• Enable dependabot.
• Update the following dependencies:
  • pkg
  • office-text-extractor

Commits since last release:

• chore: release v0.6.5 dc3c59a
• style: format dependabot config file 9150c70
• vendor: bump pkg from 4.4.9 to 4.5.1 (#7) 0a82234
• vendor: bump office-text-extractor from 1.0.2 to 1.3.1 (#6) 3e8be6a
• vendor: add dependabot config file (#1) f0c8f46
• chore(deps-dev): bump pkg from 4.4.9 to 4.5.1 f94d27f
• chore(deps): bump office-text-extractor from 1.0.2 to 1.3.1 ff03c3e
• Create Dependabot config file b7dc38a

Changes to server

• Log files now have a .log extension instead of .txt.

Builds and CI

• Added support for Alpine Linux.
• Completely revamp CI to build executables and release versions automatically based on CHANGELOG.md and version file.

Documentation

• Updated README, CONTRIBUTING and .github/*TEMPLATE.

Commits since last release:

• chore: release v0.6.4 dab94be
• docs: update README and CONTRIBUTING f49662e
• ci: add support for alpine linux 0f1fa94
• ci: revamp workflow to build and release executables automatically e71e4ac
• docs: update pr and issue templates 6bdd1ce
• chore: release v0.6.3 8fe42e4
• fix: change log file ext to .log 38d94be
• vendor: switch back to node 14.16.0 1f98b17
• chore: release v0.6.1 fa0abea
• vendor: use node v15.11.0 75e81bb

First stable release, supports topic, person and place extraction

• docs: fix typo in README 097b707
• feat: change path of .cache to _dabbu 47345a3
• chore: release v0.6.0 4e11dfa
• docs: update README install instructions c7ffdd6
• docs: point users to website for install instructions a532870

Extraction of topics, people (emails) and places from documents (docx, pptx, xlsx, pdf, plaint text content)

• feat: add place extraction 801d292
• fix: check if text extracted is null 7513ab5
• fix: results overwritten with multiple files 72f0ba8
• feat: use lda to extract key terms from text b9ac99c
• feat: add topic, email (person) parsing using retext 800d0c5
• feat: add basic extraction feature 9f24dce
• init: add base server 875f745