Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
primo-explore-unpaywall
Advanced tools
primo-explore-unpaywall - npm Package Compare versions
Comparing version 0.9.19 to 1.0.0
| { | ||
| "name": "primo-explore-unpaywall", | ||
| "version": "0.9.19", | ||
| "version": "1.0.0", | ||
| "description": "Add 'Open Access available via unpaywall' link to search-result-avaliability-line-after in Primo New UI", | ||
@@ -5,0 +5,0 @@ "main": "src/unpaywall.module.js", |
@@ -42,3 +42,4 @@ # `primo-explore-unpaywall` | ||
| 1. look in its parentController (`prmSearchResultAvailability`) for the item info contained in it's `result` variable | ||
| 2. if there's a doi (`doi`) in there and it's not already marked as open access (`oa`) use it to make a call to the afore-mentioned unpaywall api. | ||
| 2. if there's a doi (`doi`) in there and it's not already marked as open access (`oa`) use it to make a call to the afore-mentioned | ||
| unpaywall api. | ||
| 3. if that call ends up being successful, look for an open access download link (`successResponse.data.best_oa_location`) | ||
@@ -49,2 +50,4 @@ 4. if it has that, grab the url for it and place it right beneath the other "Online Access Available" link. | ||
| _note: it appears the package only works if you're using the `--browserify` option using `main.js` instead of `custom.module.js`._ | ||
| #### Adding the Package to your view in `primo-explore` | ||
@@ -63,31 +66,29 @@ | ||
| and add the contents of this repository (at that npm version) into a `node_modules/primo-explore-unpaywall` directory | ||
| for your current view. the presence of this package should mean that the package was successfully installed and added to your project. | ||
| and add the contents of this repository (at that npm version) into a `node_modules/primo-explore-unpaywall` | ||
| directory for your current view. the presence of this package should mean that the package was successfully | ||
| installed and added to your project. | ||
| #### Configuring via `unpaywallConfiguration` | ||
| to afford you with as much control as possible (and since we needed you to add your email for the unpaywall API call to work anyway), | ||
| we've added some configuration options that you'll need to set up _before the package runs_. | ||
| to afford you with as much control as possible (and since we needed you to add your email for the unpaywall | ||
| API call to work anyway), we've added some configuration options that you'll need to set up in order to run the | ||
| package effectively | ||
| our package attempts to read its options as variables within a `constant` object attached to the primo angular `app`, so all you have to | ||
| do is add something that will be added to your `custom.js` file once it's built (either by created a `unpaywall.config.js` file or adding | ||
| to an existing js file you use for other configuration options). | ||
| our package attempts to read its options as variables within a `constant` object attached to the primo angular module (`app`). | ||
| to get this packaged to work, simply create a new constant with the name `unpaywallConfig`, specifying the `email` you'd | ||
| like us to append to your unpaywall request: | ||
| ```js | ||
| // unpaywall.config.js | ||
| app.constant('unpaywallConfig', { | ||
| "email":"<your_username>@<your_institution>.edu" | ||
| }); | ||
| // main.js | ||
| app.constant('unpaywallConfig', { "email":"<your_username>@<your_institution>.edu" }); | ||
| ``` | ||
| _note: only `email` is required, since unpaywall uses it to track requests and manage rate limits_ | ||
| #### Additional Customization | ||
| the following table describes describes some additional configuration options that are currently afforded to you by the package. | ||
| an example implementation of this section can be found within this repo at `src/custom.module.js`: | ||
| the following table describes describes some additional configuration options that are currently afforded to | ||
| you by the package. an example implementation of this section can be found within this repo at `src/.main.js`: | ||
| |name|default|description| | ||
| |:------|:-----|:----------| | ||
| |`logEvent`|_[see `src/custom.module.js`]_|here's an opportunity to hook in whatever event tracking you have, (we use google analytics)| | ||
| |`logEvent`|_see example_|here's an opportunity to hook in whatever event tracking you have, (we use google analytics)| | ||
| |`showOnResultsPage`|`true`|determine whether the link is added to each item in the list of results| | ||
@@ -99,3 +100,3 @@ |`showVersionLabel`|`true`|sometimes the unpaywall OA response qualifies the stage of publication the work was OA-available in (`Submitted`, `Published`, `Accepted`)| | ||
| _note: the default for `logEvent` can be found within this repo at `src/custom.module.js`. it assumes you're using google analytics and calls it via `window.ga`_ | ||
| _note: the default for `logEvent` can be found within this repo at `src/.main.js`. it assumes you're using google analytics and calls it via `window.ga`_ | ||
@@ -1,2 +0,2 @@ | ||
| let logEventToGoogleAnalytics = function(category, action, label){ | ||
| var logEventToGoogleAnalytics = function(category, action, label){ | ||
| window.ga('send', 'event', category, action, label); | ||
@@ -3,0 +3,0 @@ } |
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
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
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
Improved metrics
- Number of low quality alerts
- decreased by-100%
0
- Number of lines in readme file
- increased by1.02%
99
Worsened metrics
- Total package byte prevSize
- decreased by-1.69%
13185
- Lines of code
- decreased by-0.92%
108
No dependency changes