Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@amanda-mitchell/biblia-api
Advanced tools
@amanda-mitchell/biblia-api - npm Package Compare versions
Comparing version 2.1.1 to 3.0.0
301
index.js
@@ -1,300 +0,1 @@ | ||
| const baseUrl = 'https://api.biblia.com/v1/'; | ||
| module.exports.usageAcknowledgment = `<a href="https://biblia.com/"><img src="https://api.biblia.com/v1/PoweredByBiblia_small.png" alt="Powered by Biblia" /></a> | ||
| This site uses the <a href="https://biblia.com/">Biblia</a> web services from <a href="https://www.logos.com/">Logos Bible Software</a>.`; | ||
| function createEndpoint(fetch, validateOptions, renderUrl) { | ||
| return async options => { | ||
| validateOptions(options); | ||
| const response = await fetch(renderUrl(options)); | ||
| // TODO: Add a richer vocabulary of errors. | ||
| if (response.status !== 200) { | ||
| throw response; | ||
| } | ||
| const contentType = (response.headers.get('Content-Type') || '').split( | ||
| ';', | ||
| 2 | ||
| )[0]; | ||
| switch (contentType) { | ||
| case 'application/json': | ||
| return await response.json(); | ||
| case 'text/html': | ||
| case 'text/plain': | ||
| return await response.text(); | ||
| case 'image/jpeg': | ||
| return await response.blob(); | ||
| default: | ||
| throw new Error(`Unexpected response Content-Type: ${contentType}`); | ||
| } | ||
| }; | ||
| } | ||
| function createOptionsValidator(validators) { | ||
| const validateFunctions = Object.assign( | ||
| {}, | ||
| ...Object.entries(validators).map(([key, createValidator]) => ({ | ||
| [key]: createValidator(key), | ||
| })) | ||
| ); | ||
| return function validate(options) { | ||
| if (!options) { | ||
| throw new Error('Options is required.'); | ||
| } | ||
| for (const key in options) { | ||
| if (!validateFunctions[key]) { | ||
| throw new Error(`Option ${key} is not supported.`); | ||
| } | ||
| } | ||
| for (const [key, validate] of Object.entries(validateFunctions)) { | ||
| const value = options[key]; | ||
| validate(value); | ||
| } | ||
| }; | ||
| } | ||
| function allowOptional(fn) { | ||
| fn.optional = optionName => { | ||
| const validate = fn(optionName); | ||
| return value => { | ||
| if (value !== undefined) { | ||
| validate(value); | ||
| } | ||
| }; | ||
| }; | ||
| return fn; | ||
| } | ||
| function validateEnumMembership(...values) { | ||
| const valuesHash = Object.assign( | ||
| {}, | ||
| ...values.map(value => ({ [value.toLowerCase()]: true })) | ||
| ); | ||
| return allowOptional(optionName => { | ||
| const errorMessage = `Option ${optionName} must be one of ${values.join( | ||
| ', ' | ||
| )}.`; | ||
| return function validate(value) { | ||
| if (!valuesHash[value.toLowerCase()]) { | ||
| throw new Error(errorMessage); | ||
| } | ||
| }; | ||
| }); | ||
| } | ||
| function validateTypeOf(expectedType) { | ||
| return allowOptional(optionName => { | ||
| const errorMessage = `Option ${optionName} must be a ${expectedType}.`; | ||
| return function validate(value) { | ||
| if (typeof value !== expectedType) { | ||
| throw new Error(errorMessage); | ||
| } | ||
| }; | ||
| }); | ||
| } | ||
| const availableBibles = [ | ||
| 'asv', | ||
| 'arvandyke', | ||
| 'kjv', | ||
| 'lsg', | ||
| 'byz', | ||
| 'darby', | ||
| 'elzevir', | ||
| 'itdiodati1649', | ||
| 'emphbbl', | ||
| 'kjv1900', | ||
| 'kjvapoc', | ||
| 'leb', | ||
| 'scrmorph', | ||
| 'fi-raamattu', | ||
| 'rvr60', | ||
| 'rva', | ||
| 'bb-sbb-rusbt', | ||
| 'eo-zamenbib', | ||
| 'tr1881', | ||
| 'tr1894mr', | ||
| 'svv', | ||
| 'stephens', | ||
| 'tanakh', | ||
| 'wbtc-ptbrnt', | ||
| 'wh1881mr', | ||
| 'ylt', | ||
| ]; | ||
| const bibleVersionValidator = validateEnumMembership(...availableBibles); | ||
| const validateBibleContentOptions = createOptionsValidator({ | ||
| bible: bibleVersionValidator, | ||
| passage: validateTypeOf('string'), | ||
| format: validateEnumMembership('txt', 'html', 'txt.json', 'html.json'), | ||
| style: validateEnumMembership( | ||
| 'fullyFormatted', | ||
| 'oneVersePerLine', | ||
| 'oneVersePerLineFullReference', | ||
| 'quotation', | ||
| 'simpleParagraphs', | ||
| 'bibleTextOnly', | ||
| 'orationOneParagraph', | ||
| 'orationOneVersePerLine', | ||
| 'orationBibleParagraphs', | ||
| 'fullyFormattedWithFootnotes' | ||
| ).optional, | ||
| formatting: validateTypeOf('string').optional, | ||
| redLetter: validateTypeOf('boolean').optional, | ||
| footnotes: validateTypeOf('boolean').optional, | ||
| citation: validateTypeOf('boolean').optional, | ||
| paragraphs: validateTypeOf('boolean').optional, | ||
| fullText: validateTypeOf('boolean').optional, | ||
| header: validateTypeOf('string').optional, | ||
| eachVerse: validateTypeOf('string').optional, | ||
| footer: validateTypeOf('string').optional, | ||
| }); | ||
| const pagingOptions = { | ||
| start: validateTypeOf('number').optional, | ||
| limit: validateTypeOf('number').optional, | ||
| }; | ||
| const validateSearchOptions = createOptionsValidator({ | ||
| bible: bibleVersionValidator, | ||
| query: validateTypeOf('string'), | ||
| mode: validateEnumMembership('verse', 'fuzzy').optional, | ||
| passages: validateTypeOf('string').optional, | ||
| preview: validateEnumMembership('none', 'text', 'html').optional, | ||
| sort: validateEnumMembership('relevance', 'passage').optional, | ||
| ...pagingOptions, | ||
| }); | ||
| const validateSpecificBibleOptions = createOptionsValidator({ | ||
| bible: bibleVersionValidator, | ||
| }); | ||
| const validateFindOptions = createOptionsValidator({ | ||
| query: validateTypeOf('string').optional, | ||
| strictQuery: validateTypeOf('boolean').optional, | ||
| ...pagingOptions, | ||
| }); | ||
| const validateParseOptions = createOptionsValidator({ | ||
| passage: validateTypeOf('string'), | ||
| style: validateEnumMembership('short', 'medium', 'long').optional, | ||
| }); | ||
| const validateScanOptions = createOptionsValidator({ | ||
| text: validateTypeOf('string'), | ||
| tagChapters: validateTypeOf('boolean').optional, | ||
| }); | ||
| const validateTagOptions = createOptionsValidator({ | ||
| text: validateTypeOf('string').optional, | ||
| url: validateTypeOf('string').optional, | ||
| tagFormat: validateTypeOf('string').optional, | ||
| tagChapters: validateTypeOf('boolean').optional, | ||
| }); | ||
| const validateCompareOptions = createOptionsValidator({ | ||
| first: validateTypeOf('string'), | ||
| second: validateTypeOf('string'), | ||
| }); | ||
| module.exports.createBibliaApiClient = ({ apiKey, fetch }) => { | ||
| function createUrlTemplate(urlParts, ...names) { | ||
| for (const name of names) { | ||
| if (typeof name !== 'string') { | ||
| throw new Error(`All names must be strings, but ${name} is not.`); | ||
| } | ||
| } | ||
| const beginning = baseUrl + urlParts[0]; | ||
| const namesHash = Object.assign( | ||
| {}, | ||
| ...names.map(name => ({ [name]: true })) | ||
| ); | ||
| return function renderUrl(options) { | ||
| const path = names | ||
| .map( | ||
| (name, index) => | ||
| encodeURIComponent(options[name]) + urlParts[index + 1] | ||
| ) | ||
| .join(''); | ||
| const queryParameters = Object.entries(options) | ||
| .filter(([key]) => !namesHash[key]) | ||
| .concat([['key', apiKey]]) | ||
| .map( | ||
| ([key, value]) => | ||
| `${encodeURIComponent(key)}=${encodeURIComponent(value)}` | ||
| ) | ||
| .join('&'); | ||
| return `${beginning}${path}?${queryParameters}`; | ||
| }; | ||
| } | ||
| return { | ||
| content: createEndpoint( | ||
| fetch, | ||
| validateBibleContentOptions, | ||
| createUrlTemplate`bible/content/${'bible'}.${'format'}` | ||
| ), | ||
| tableOfContents: createEndpoint( | ||
| fetch, | ||
| validateSpecificBibleOptions, | ||
| createUrlTemplate`bible/contents/${'bible'}` | ||
| ), | ||
| search: createEndpoint( | ||
| fetch, | ||
| validateSearchOptions, | ||
| createUrlTemplate`bible/search/${'bible'}` | ||
| ), | ||
| findBible: createEndpoint( | ||
| fetch, | ||
| validateSpecificBibleOptions, | ||
| createUrlTemplate`bible/find/${'bible'}` | ||
| ), | ||
| find: createEndpoint( | ||
| fetch, | ||
| validateFindOptions, | ||
| createUrlTemplate`bible/find` | ||
| ), | ||
| image: createEndpoint( | ||
| fetch, | ||
| validateSpecificBibleOptions, | ||
| createUrlTemplate`bible/image/${'bible'}` | ||
| ), | ||
| parse: createEndpoint( | ||
| fetch, | ||
| validateParseOptions, | ||
| createUrlTemplate`bible/parse` | ||
| ), | ||
| scan: createEndpoint( | ||
| fetch, | ||
| validateScanOptions, | ||
| createUrlTemplate`bible/scan` | ||
| ), | ||
| tag: createEndpoint( | ||
| fetch, | ||
| validateTagOptions, | ||
| createUrlTemplate`bible/tag` | ||
| ), | ||
| compare: createEndpoint( | ||
| fetch, | ||
| validateCompareOptions, | ||
| createUrlTemplate`bible/compare` | ||
| ), | ||
| }; | ||
| }; | ||
| module.exports = require('./dist'); |
| { | ||
| "name": "@amanda-mitchell/biblia-api", | ||
| "version": "2.1.1", | ||
| "version": "3.0.0", | ||
| "description": "A Javascript wrapper for the Biblia API.", | ||
| "main": "index.js", | ||
| "files": [ | ||
| "index.js" | ||
| "index.js", | ||
| "dist/**/*.js", | ||
| "dist/**/*.map", | ||
| "dist/**/*.d.ts", | ||
| "!**/__tests__" | ||
| ], | ||
@@ -18,6 +22,13 @@ "publishConfig": { | ||
| "@amanda-mitchell/node-project-scripts": "^2.4.2", | ||
| "@tsconfig/node12": "^1.0.7", | ||
| "@types/jest": "^26.0.20", | ||
| "@types/node-fetch": "^2.5.8", | ||
| "@typescript-eslint/eslint-plugin": "^4.14.0", | ||
| "@typescript-eslint/parser": "^4.14.0", | ||
| "dotenv": "^8.2.0", | ||
| "jest": "^26.6.3", | ||
| "node-fetch": "^2.6.1" | ||
| "node-fetch": "^2.6.1", | ||
| "ts-jest": "^26.4.4", | ||
| "typescript": "^4.1.3" | ||
| } | ||
| } |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by288.37%
44426
- Number of package files
- increased by200%
12
- Lines of code
- increased by54.17%
407
Worsened metrics
- Dev dependency count
- increased by175%
11
- Number of medium supply chain risk alerts
- increased by9.09%
12
No dependency changes