docsmith

⚠ BREAKING CHANGES

• routes: /healthcheck moved to /admin/healthcheck

Features

• routes/docx/html: add language query string param (befbe1f)
• routes/pdf/html: add language query string param (baf74c7)
• routes/rtf/html: add language query string param (db783d8)

Bug Fixes

• app: logging grammar fixes (31e6f26)
• config: allow for empty logger env variables (b3d3567)
• config: defaults for undeclared variables (737e0b2)
• routes/docx/html: restrict strings accepted in query string params (880f1f9)
• routes/pdf/html: restrict strings accepted in query string params (248b96f)
• routes/rtf/html: restrict strings accepted in query string params (19292ef)

Improvements

• config: consolidate logger pretty print conditional (6682344)
• config: consolidate tesseract conditional (6ed41c9)
• replace http-errors with fastify-sensible plugin (e5b8578)
• routes: /healthcheck moved to /admin/healthcheck (c91bf23)

Miscellaneous

• env: document default logger values (6d340c5)
• env: standardise, sort, and group env variables (72f86f1)
• package: update description (#343) (d5d9b38)

Dependencies

• deps-dev: bump eslint-plugin-jsdoc from 36.0.6 to 36.0.7 (a6f29c9)
• deps: bump env-schema from 3.2.0 to 3.3.0 (d7b8156)
• deps: bump fastify from 3.20.1 to 3.20.2 (df203e4)
• deps: bump jsdom from 16.7.0 to 17.0.0 (d149b72)
• deps: bump pino-pretty from 5.1.2 to 5.1.3 (886f5f9)
• docker: bump curl from 7.52.1+deb9u14 to 7.52.1+deb9u15 (7283bba)

Features

• routes/docx/html: support more query string params (60b56b9)
• routes/docx/html: support removealt query string param (72017a8)
• routes/healthcheck: add cors header support (3f0b9b7)
• routes: add docx-to-html route (98f4e64)
• routes: add docx-to-txt route (25a01b4)

Bug Fixes

• plugins/docx-to-html: set content-type meta; fix utf-8 (1bccb7b)

Improvements

• plugins/pdf: lowercase charset in content-type res header (38809e1)
• plugins/tidy-html: convert string param to object (2f863df)
• plugins: move alt attribute manipulation to appropriate plugin (2168c7e)

Documentation

• readme: update feature list (15912b8)

Miscellaneous

• add example docx route requests (f0dc009)
• inline comment spelling and grammar fixes (e960246)
• routes/docx/txt: fix description (1e41394)

Dependencies

• deps-dev: bump eslint-plugin-import from 2.23.4 to 2.24.0 (3cfb576)
• deps: add mammoth (01b9f3a)
• deps: bump actions/setup-node from 2.3.0 to 2.4.0 (7460de7)
• deps: bump env-schema from 3.1.0 to 3.2.0 (15126c0)
• deps: bump fastify from 3.19.2 to 3.20.1 (0cb82d3)
• deps: bump fastify-swagger from 4.8.3 to 4.8.4 (dd47683)
• deps: bump file-type from 16.5.2 to 16.5.3 (959e67c)
• deps: bump tesseract.js from 2.1.4 to 2.1.5 (be7c659)

⚠ BREAKING CHANGES

• minimum required version of node increased from 12 to 14 to allow for new ECMAScript syntax to be used
• routes/pdf-to-txt: additional trained data must now be provided for OCR before deployment

Features

• config: add ability to disable ocr functionality (7ba9b43)
• config: add ability to specify number of tesseract ocr workers (8a13c93)

Bug Fixes

• config: fall back to default if CORS_ORIGIN env variable not set (63431f1)
• docker-compose: wrap variables in quotes (05afefe)
• docker: downgrade from buster to stretch; stop corrupted html gen (c67663a)
• plugins/image-to-txt: await scheduler termination on close (f59732a)
• routes/pdf-to-txt: use local trained data; stop cache corruption (7a3d128)
• routes/pdf/txt: remove ocr query string param if ocr disabled (#332) (6b512c1)
• server: ensure doc route also inherits plugins (#310) (76826b1)

Improvements

• plugins/image-to-txt: convert req-level tesseract util to server-level plugin (#311) (52e9993)
• plugins/image-to-txt: create workers on physical core count (f04109d)
• plugins/image-to-txt: use local scripts over cdn downloads (870ee3c)
• plugins/pdf-to-txt: increase ppi to 300 to improve ocr accuracy (99e9e24)
• plugins/pdf-to-txt: use optional chaining over multiple checks (6bc7ac5)

Miscellaneous

• dockerfile: indent script (0d951e7)
• eslintrc: support latest ecmascript features (cf90012)
• eslint: use ecmascript 2020 globals (#329) (0a48280)
• grammar fixes for jsdoc tags (#327) (c07dfaa)
• increase minimum required version of node from 12 to 14 (931fa62)
• plugins/pdf-to-txt: remove redundant jsdoc param tag (74a799d)

Dependencies

• deps-dev: bump eslint from 7.31.0 to 7.32.0 (f264f06)
• deps-dev: bump eslint-plugin-jest from 24.3.6 to 24.4.0 (#315) (cf791e7)
• deps-dev: bump eslint-plugin-jsdoc from 35.4.5 to 36.0.6 (83c1ca5)
• deps: bump actions/setup-node from 2.2.0 to 2.3.0 (#314) (a8bbda5)
• deps: bump dependencies (#325) (e383c7d)
• deps: bump GoogleCloudPlatform/release-please-action (#326) (7bc9fad)
• deps: bump jsdom from 16.6.0 to 16.7.0 (84bc485)
• deps: bump node-poppler from 4.1.0 to 4.1.1 (0259049)
• deps: bump pino from 6.12.0 to 6.13.0 (5b6a85e)
• deps: bump pino-pretty from 5.1.1 to 5.1.2 (512a196)

Bug Fixes

• package: move pino-pretty to production dependency list (#298) (55ec7e7)

Improvements

• routes/healthcheck: do not treat route as plugin (02e6dcb)

Dependencies

• deps-dev: bump eslint from 7.30.0 to 7.31.0 (4be0b56)
• deps-dev: bump eslint-plugin-jsdoc from 35.4.3 to 35.4.5 (f64026b)
• deps: bump fastify from 3.19.0 to 3.19.1 (c385a56)
• deps: bump fastify-cors from 6.0.1 to 6.0.2 (6f6365f)
• deps: bump wagoid/commitlint-github-action from 3.1.4 to 4.1.1 (c5c22ca)

Miscellaneous

• change mentions of "MIME type" to "media type" (#295) (854759d)
• test_resources: add Insomnia REST client test requests (7859d41)
• test_resources: minor header tweaks (d43fd2e)
• update jsdoc tag comments (#304) (bd683f3)
• update plugin metadata for server dependency graph (13aaf44)

Bug Fixes

• routes: Accept header handling encapsulation (#292) (d8e3d3d)

Miscellaneous

• vscode: remove user space config setting (#283) (28135bb)

Dependencies

• deps-dev: bump eslint-plugin-jsdoc from 35.4.2 to 35.4.3 (a933b32)
• deps-dev: bump nodemon from 2.0.10 to 2.0.12 (da50881)
• deps: bump env-schema from 3.0.1 to 3.1.0 (d0ee9f7)
• deps: bump fastify-swagger from 4.8.2 to 4.8.3 (7e0d077)
• deps: bump file-type from 16.5.0 to 16.5.1 (7616311)
• deps: bump fluent-json-schema from 3.0.0 to 3.0.1 (0ebe587)
• deps: bump pino from 6.11.3 to 6.12.0 (dd61325)

Continuous Integration

• ci: disable homebrew analytics for macos builds (#293) (ad32eae)

Bug Fixes

• plugins: check conv object is present before removing temp files (1fb4eb9)
• routes: add Accept request header handling (#281) (89e05c0)

Improvements

• config: use same tempdirectory variable across config (ac27c45)
• plugins/embed-html-images: uncouple from server config (8caf594)
• plugins/pdf-to-html: uncouple from server config (ab9701b)
• plugins/pdf-to-txt: uncouple from server config (1cacd0f)
• plugins/rtf-to-html: uncouple from server config (96eb122)
• plugins/rtf-to-txt: uncouple from server config (2514206)
• plugins: create new instances of unrtf earlier (fe9f637)
• plugins: create result object before being blocked by asyncs (e989620)

Miscellaneous

• env.template: replace incorrect double quote (e6626fc)
• env.template: replace incorrect double quote (b2695fe)
• plugins: remove old reference to expressjs middleware (70cb821)
• standardise result object name in req (0b7b51d)
• utils: standardise util function naming (2a5a220)
• vscode: disable red hat telemetry (91082b2)

Dependencies

• deps-dev: bump autocannon from 7.3.0 to 7.4.0 (64a43cb)
• deps-dev: bump eslint from 7.29.0 to 7.30.0 (7244266)
• deps-dev: bump eslint-plugin-jsdoc from 35.4.1 to 35.4.2 (b098fb5)
• deps-dev: bump husky from 6.0.0 to 7.0.1 (fc9c6ff)
• deps-dev: bump nodemon from 2.0.9 to 2.0.10 (f5b3f6f)
• deps-dev: bump pino-pretty from 5.1.0 to 5.1.1 (044f857)
• deps: bump coverallsapp/github-action from 1.1.2 to 1.1.3 (d9885bf)
• deps: bump fastify from 3.18.1 to 3.19.0 (209c4aa)
• deps: bump fastify-helmet from 5.3.1 to 5.3.2 (ef0ee57)

Features

• routes/pdf/txt: add ocr query string param for ocr support (44c44f7)

Documentation

• readme: update supported features list (300785f)

Miscellaneous

• env.template: use double quotes (#258) (0512d1f)
• ignore tesseract trained data (ba13eab)

Dependencies

• deps-dev: bump eslint-plugin-jsdoc from 35.4.0 to 35.4.1 (16453a1)
• deps-dev: bump jest from 27.0.5 to 27.0.6 (7ad4be8)
• deps-dev: bump nodemon from 2.0.7 to 2.0.9 (a9be956)
• deps-dev: bump pino-pretty from 5.0.2 to 5.1.0 (ff307a5)
• deps-dev: bump prettier from 2.3.1 to 2.3.2 (fb23ddb)
• deps: bump actions/setup-node from 2.1.5 to 2.2.0 (6074121)
• deps: bump fastify from 3.18.0 to 3.18.1 (a949c21)
• deps: bump fastify-swagger from 4.8.0 to 4.8.2 (7aa3e31)

Bug Fixes

• server: add "base-uri" directive to Content-Security-Policy (#244) (f4a12e6)
• server: increase Strict-Transport-Security max age to 365 days (1c9f303)
• server: revert Referrer-Policy directives to "no-referrer" only (b2c1023)
• server: use stricter Content-Security-Policy values (b833c6b)

Continuous Integration

• link-check: reduce frequency from weekly to monthly (#241) (3a3c13f)

Miscellaneous

• server: clarify on what each registered plugin does (673bdfe)

Dependencies

• deps-dev: bump eslint from 7.28.0 to 7.29.0 (9db5421)
• deps-dev: bump eslint-plugin-jsdoc from 35.3.0 to 35.4.0 (2aefbbb)
• deps-dev: bump jest from 27.0.4 to 27.0.5 (849f75e)
• deps: bump cssom from 0.4.4 to 0.5.0 (de2e5b0)
• deps: bump fastify-autoload from 3.7.1 to 3.8.0 (a8b5a4e)
• deps: bump fastify-bearer-auth from 5.1.0 to 6.0.0 (a90a6af)
• deps: bump fastify-swagger from 4.7.0 to 4.8.0 (192324a)
• deps: bump under-pressure from 5.6.0 to 5.7.0 (ca77149)

Dependencies

• deps: bump actions/upload-artifact from 2.2.3 to 2.2.4 (6b66fb1)
• deps: bump fastify from 3.17.0 to 3.18.0 (de705a6)
• deps: bump fastify-disablecache from 2.0.1 to 2.0.2 (#238) (c96c2b4)

Bug Fixes

• config: add NODE_ENV to env schema validation (4d7fa47)
• config: prettyprint conditional (101a520)
• plugins: return response object from onResponse hook (b29af02)
• server: allow bearer token auth to be disabled (#228) (80e9ce1)

Documentation

• readme: revamp why section (82a037b)

Improvements

• plugins: remove rtf body checks; now handled by node-unrtf (#233) (9d1351d)

Miscellaneous

• plugins/pdf-to-txt: remove unused variable (b05c885)
• scripts: benchmark conversion route (#235) (d1c92c3)

Dependencies

• deps-dev: bump eslint-plugin-jsdoc from 35.1.3 to 35.2.0 (2f6b017)
• deps-dev: bump eslint-plugin-jsdoc from 35.2.0 to 35.3.0 (8028579)
• deps: bump fastify-compress from 3.5.0 to 3.6.0 (#230) (03f711c)
• deps: bump fastify-disablecache from 2.0.0 to 2.0.1 (#236) (7b05aaa)
• deps: bump node-unrtf from 2.0.0 to 2.0.1 (6410751)

Features

• routes/rtf/html: add removeAlt query string param (#222) (08a9c02)
• server: add content-encoding support (4b03b8e)

Bug Fixes

• plugins: return full serialization of HTML document (#219) (f924996)

Miscellaneous

• routes: chain .register() functions (7fd53f8)

Dependencies

• deps: bump normalize-url from 4.5.0 to 4.5.1 (7beaf5f)

Improvements

• plugins: remove redundant use of this keyword (3eb8931)
• server: use helmet default csp directives (bad981c)

Bug Fixes

• plugins: await Object.assign() and fixUtf8() (d3bdbc3)
• routes/pdf/html: hardcoded removealt query param (6e96a29)

Features

• config: add env variable for setting req body size limit (53b97b8)

Bug Fixes

• plugins: outputencoding query param use (768161e)

Bug Fixes

• config: redact request authorization header from logs (9300384)
• server: remove swagger from csp for all routes apart from doc route (5be469d)
• server: set frame-ancestors csp to 'none'; add child-src csp (2d85a0f)

Documentation

• readme: flesh out intro section further (97cbc09)

Dependencies

• update vulnerable dependencies (f1297b9)

Bug Fixes

• plugins/tidy-css: incomplete multi-character sanitization (9abf965)

Documentation

• readme: revamp intro section (#207) (04265e1)

Dependencies

• deps-dev: bump eslint from 7.27.0 to 7.28.0 (8152f90)
• deps-dev: bump eslint-plugin-jsdoc from 35.1.2 to 35.1.3 (964b374)
• deps-dev: bump prettier from 2.3.0 to 2.3.1 (96133ff)
• deps-dev: remove glob from dev list; already prod dep (ee6b6ba)
• update vulnerable dependency (b142a49)

Documentation

• readme: grammar and wordiness fixes (d92af9c)
• readme: grammar fix (ef33bda)
• readme: update contributing section (208beac)

Miscellaneous

• .env.template: remove comment re docker and log files (66ba536)
• dockerignore: ignore all temp directories (33495d4)

Continuous Integration

• remove redundant docker build job (78e3abd)

Dependencies

• deps-dev: bump eslint-plugin-import from 2.23.3 to 2.23.4 (9bc0cd7)
• deps-dev: bump eslint-plugin-jsdoc from 35.0.0 to 35.1.2 (e0d7dd2)
• deps-dev: bump jest from 27.0.1 to 27.0.3 (fe2f6c7)
• deps-dev: bump jest from 27.0.3 to 27.0.4 (c1a8d11)
• deps-dev: bump pino-pretty from 5.0.0 to 5.0.1 (8a0a640)
• deps-dev: bump pino-pretty from 5.0.1 to 5.0.2 (bce5af7)
• deps: bump actions/cache from 2.1.5 to 2.1.6 (97bbbb6)
• deps: bump fastify from 3.16.2 to 3.17.0 (ea6516b)
• deps: bump file-type from 16.4.0 to 16.5.0 (f4d2dbf)
• deps: bump node-poppler from 4.0.0 to 4.1.0 (5203ac5)
• deps: bump ws from 7.4.5 to 7.4.6 (334cc18)
• docker: add missing dependencies and env variables (fac4517)
• docker: clean list after install; ignore recommended packages (61159cd)
• dockerignore: add test and dev files (573e477)
• docker: pin binary versions (d237673)
• docker: update workdir; install curl (338bf2d)
• docker: use native logging, healthcheck, restart and res handling (23600da)
• docker: use smaller, more secure base image (bf2f4e0)

Miscellaneous

• gitignore: ignore all temp directories (a418e02)
• prettierignore: ignore all temp directories (0c373cd)
• remove resolved todo comments (d0b5c92)
• test_resources: standardize test file names (3b6d16c)

Improvements

• routes: mimetype detection (2ef53e0)
• routes: mimetype detection payload return (1db2c3a)

Continuous Integration

• cd: move perf optimizations and refactoring into same section (b5e1b23)

Dependencies

• deps-dev: bump jest from 27.0.0 to 27.0.1 (e64fa9b)
• deps-dev: bump pino-pretty from 4.8.0 to 5.0.0 (008d6e1)
• deps: bump fastify from 3.15.1 to 3.16.2 (e926a09)

Features

• routes/rtf/html: add rtf-to-html route (#177) (8b0fdd4)
• routes/rtf/txt: add rtf-to-txt route (#179) (0ad64bd)

Miscellaneous

• workflows: remove stale.yml (ae47b74)

Miscellaneous

• docker-compose: update container_name (970f6b9)
• env: add comments to clarify process load handling (5313d90)
• env: remove pre-filled process load env values in template (4cbd96f)
• rename repo (ee2a247)

Dependencies

• deps-dev: bump eslint from 7.26.0 to 7.27.0 (c9c2afc)
• deps-dev: bump eslint-plugin-import from 2.23.2 to 2.23.3 (297021f)
• deps-dev: bump eslint-plugin-jsdoc from 34.8.2 to 35.0.0 (311f05c)
• deps-dev: bump jest from 26.6.3 to 27.0.0 (7926c95)
• deps: bump dotenv from 9.0.2 to 10.0.0 (bab8464)
• deps: bump jsdom from 16.5.3 to 16.6.0 (12be151)