https://github.com/caleb531/youversion-suggest-api - v3.0.0

YVS v3 is a major release which extends the library compatibility to runtimes beyond Node, including Cloudflare Workers and even in a web browser. There are no changes to the JavaScript API, so v3 should be a drop-in replacement for v2.

This new version requires WASM and Fetch API support in your JavaScript runtime.

- TypeScript
Published by caleb531 almost 2 years ago

https://github.com/caleb531/youversion-suggest-api - v3.0.0-beta.4

• Replaced the htmlrewriter package with \@worker-tools/html-rewriter's base64 WASM loader
  • This should hopefully fix the import issues with NextJS, as my testing has indicated (UPDATE: it definitely does—thank you, Jesus!)

- TypeScript
Published by caleb531 almost 2 years ago

https://github.com/caleb531/youversion-suggest-api - v3.0.0-beta.3

• Properly externalized htmlrewriter and html-entities so they can be handled by consuming applications
  • This ensures that your consuming application's JS runtime generates code that is more specific to the environment you're targeting

- TypeScript
Published by caleb531 almost 2 years ago

https://github.com/caleb531/youversion-suggest-api - v3.0.0-beta.2

• Attempt to fix WASM issues

- TypeScript
Published by caleb531 almost 2 years ago

https://github.com/caleb531/youversion-suggest-api - v3.0.0-beta.1

YVS v3 is a major release which extends the library compatibility to runtimes beyond Node, including Cloudflare Workers and even in a web browser. There are no changes to the JavaScript API, so v3 should be a drop-in replacement for v2.

This release is an initial beta to ensure that the changes in v3 do not break existing applications.

- TypeScript
Published by caleb531 almost 2 years ago

https://github.com/caleb531/youversion-suggest-api - v2.2.0

• Added language support for Filipino (tgl)
  • The default version is Magandang Balita Biblia 2005 (MBB05)

- TypeScript
Published by caleb531 about 2 years ago

https://github.com/caleb531/youversion-suggest-api - v2.1.3

• Fixed a bug where some line breaks (e.g. with verses like Obadiah 1:4) would not be rendered correctly
• Added support for more types of line breaks used by YouVersion
• Updated project dependencies to latest versions

- TypeScript
Published by caleb531 about 2 years ago

https://github.com/caleb531/youversion-suggest-api - v2.1.2

• Fixed a serious bug where Copy to Clipboard functionality broke completely due to recent changes YouVersion made to their web app

- TypeScript
Published by caleb531 over 2 years ago

https://github.com/caleb531/youversion-suggest-api - v2.1.1

• Fixed a bug where the library might fail to fetch verses containing line breaks (e.g. Psalm 23:1 NASB1995)

- TypeScript
Published by caleb531 over 2 years ago

https://github.com/caleb531/youversion-suggest-api - v2.1.0

No changes from RC1; reposting RC1 release notes

New Features

• Added support for the native Fetch API available in Node 18 and newer; if the node-fetch package is installed, it will be used instead
• Added language support for Ukrainian (ukr)
  • CUV has been set as the default version/translation

Under-the-Hood

• Migrated entire test suite from AVA to Vitest
  • This will result in faster tests and better compatibility with Node 20
• Updated various other tests to better ensure the resilience of the library

- TypeScript
Published by caleb531 over 2 years ago

https://github.com/caleb531/youversion-suggest-api - v2.1.0-rc.1

New Features

• Added support for the native Fetch API available in Node 18 and newer; if the node-fetch package is installed, it will be used instead
• Added language support for Ukrainian (ukr)
  • CUV has been set as the default version/translation

Under-the-Hood

• Migrated entire test suite from AVA to Vitest
  • This will result in faster tests and better compatibility with Node 20
• Updated various other tests to better ensure the resilience of the library

- TypeScript
Published by caleb531 over 2 years ago

https://github.com/caleb531/youversion-suggest-api - v2.0.1

• Added links to GitHub repository to npm package page
• No API changes otherwise

- TypeScript
Published by caleb531 about 3 years ago

https://github.com/caleb531/youversion-suggest-api - v2.0.0

Includes release notes from v2 betas

• Bumped minimum required Node version to v18
• The Bible data is now bundled with the library, making the library must less dependent on the directory structure of your final application
  • Because of this, the setBibleDataDirBase() method is no longer needed and therefore has been removed

Under-the-hood

• Switched the entire testing infrastructure from Mocha to AVA
  • This enables better coverage reporting and test isolation
  • All unit tests have been rewritten to use AVA's API
• The fetchReferenceContent() now has improved error handling if you pass an invalid Bible reference

- TypeScript
Published by caleb531 about 3 years ago

https://github.com/caleb531/youversion-suggest-api - v2.0.0-beta.2

• Bumped minimum required Node version to v18
• Switched the entire testing infrastructure from Mocha to AVA
  • This enables better coverage reporting and test isolation
  • All unit tests have been rewritten to use AVA's API
• Improved code coverage in various places

- TypeScript
Published by caleb531 about 3 years ago

https://github.com/caleb531/youversion-suggest-api - v2.0.0-beta.1

• The Bible data is now bundled with the library, making the library must less dependent on the directory structure of your final application
  • Because of this, the setBibleDataDirBase() method is no longer needed and therefore has bee removed

- TypeScript
Published by caleb531 about 3 years ago

https://github.com/caleb531/youversion-suggest-api - v1.3.0

• Fixed a bug where the content for individual verses and verse ranges could not be copied to the clipboard
• The fetchReferenceContent() now throws more specific errors: BibleReferenceNotFoundError and BibleReferenceEmptyContentError, respectively (instead of just Error)
• Other minor improvements to the code

- TypeScript
Published by caleb531 about 3 years ago

https://github.com/caleb531/youversion-suggest-api - v1.2.1

• Fixed a surprising bug in which the fetchReferenceContent() function would throw a Fetched reference content is empty error if the reference content consisted entirely of the red-lettered words of Jesus
  • It's sad, but you can't make this stuff up 😅

- TypeScript
Published by caleb531 about 3 years ago

https://github.com/caleb531/youversion-suggest-api - v1.2.0

• Added new includeVerseNumbers and includeLineBreaks options for the fetchReferenceContent() function
  • If includeVerseNumbers is true (default: false), the verse number labels will be included in reference content; this works even for translations like The Message (MSG) which condenses multiple verses into one
  • If includeLineBreaks is false (default: true), the reference content will be formatted onto a single line (this is useful for books like Psalms or Proverbs)
• Added additional tests and improved code coverage
• Refactored various areas of the codebase to be cleaner and leaner

- TypeScript
Published by caleb531 about 3 years ago

https://github.com/caleb531/youversion-suggest-api - v1.1.0

• Added a new setBibleDataDirBase() function, which is useful when your consuming application is unable to find the path to any of the Bible data files

- TypeScript
Published by caleb531 about 3 years ago

https://github.com/caleb531/youversion-suggest-api - v1.0.1

• Fixed a critical bug where all Bible data was missing in the package published to npm. So sorry about that!

- TypeScript
Published by caleb531 about 3 years ago

https://github.com/caleb531/youversion-suggest-api - v1.0.0

• Official 1.0 release; the public API is now stable!
  • No API changes since v0.6.0
• Improvements to documentation and tests

- TypeScript
Published by caleb531 about 3 years ago

https://github.com/caleb531/youversion-suggest-api - v0.6.0

• Added a new getLanguages() function to the public API
• Added missing documentation for the getReferencesMatchingPhrase() function
• Eliminated lodash-es as a dependency
• Added many additional tests to ensure the proper functioning of the API; code coverage is now at 95%
• The priority/metadata fields have been removed from the Bible book object
  • The priority field was only ever meant for internal use
  • The metadata field was removed to keep the resulting objects smaller (in case you decide to JSON-serialize them); the getBibleBookMetadata() is now the preferred and only way to retrieve this metadata

- TypeScript
Published by caleb531 about 3 years ago

https://github.com/caleb531/youversion-suggest-api - v0.5.0

• Fixed support for non-ASCII characters and languages other than English
• Added comprehensive test suite (mostly migrated from youversion-suggest-alfred codebase)

- TypeScript
Published by caleb531 about 3 years ago

https://github.com/caleb531/youversion-suggest-api - v0.4.0

• Switch package to ESM-only; CommonJS is no longer supported

- TypeScript
Published by caleb531 about 3 years ago

https://github.com/caleb531/youversion-suggest-api - v0.3.0

• Renamed the fallback_version option to fallbackVersion for all relevant API functions

- TypeScript
Published by caleb531 about 3 years ago

https://github.com/caleb531/youversion-suggest-api - v0.2.0

• The fetchReferenceContent() function now returns a BibleReference object (with the contents of the verse stored in a content property) rather than the formatted contents; this exposes more information about the matched Bible reference for use by consuming applications
• The format option to the fetchReferenceContent() function has been removed; applications using youversion-suggest should now perform the formatting logic themselves using the additional information they receive from the BibleReference object

- TypeScript
Published by caleb531 about 3 years ago

https://github.com/caleb531/youversion-suggest-api - v0.1.1

• Initial development release

- TypeScript
Published by caleb531 about 3 years ago