chrome-webstore - npm Package Compare versions

Comparing version 0.0.4 to 1.0.0

index.js

 
 var request = require('request-compose').client
 
-var extract = require('./lib/extract')
-var format = require('./lib/format')
+var item = require('./lib/item')
+var detail = require('./lib/detail')
 
+var config = require('./config/webstore')
 
+
 module.exports = {
 
-  extension: ({url, id}) =>
+  items: ({search, category, rating, features, count, offset, version}) =>
     request({
-      url: url || `https://chrome.google.com/webstore/detail/${id}`
+      method: 'POST',
+      url: 'https://chrome.google.com/webstore/ajax/item',
+      qs: {
+        searchTerm: search,
+        category,
+        features: (features || []).map((key) => config.features[key])
+          .concat(config.rating[rating]).filter(Boolean),
+        count: count || 5,
+        token: offset ? `${offset}@${offset}` : undefined,
+        pv: version || config.version,
+      },
     })
-    .then(({body}) => format(extract(id, body)))
+    .then(({body}) =>
+      JSON.parse(body.slice(5))[1][1].map((i) => item.transform(item.extract(i))))
+  ,
 
+  detail: ({id, related, more, version}) =>
+    request({
+      method: 'POST',
+      url: 'https://chrome.google.com/webstore/ajax/detail',
+      qs: {
+        id,
+        pv: version || config.version,
+      },
+    })
+    .then(({body}) => ((json = JSON.parse(body.slice(5))) => Object.assign(
+      detail.transform(detail.extract(json[1][1])),
+      related && {related: json[1][2].map((i) => item.transform(item.extract(i)))},
+      more && {more: json[1][3].map((i) => item.transform(item.extract(i)))},
+    ))())
+  ,
+
 }

package.json

 {
   "name": "chrome-webstore",
-  "version": "0.0.4",
-  "description": "Chrome WebStore Tools",
+  "version": "1.0.0",
+  "description": "Google Chrome Web Store HTTP Client",
   "keywords": [
@@ -18,9 +18,8 @@ "chrome",
   "dependencies": {
-    "html-entities": "^1.2.1",
-    "request-compose": "0.0.18"
+    "request-compose": "0.0.19"
   },
   "devDependencies": {
-    "coveralls": "^3.0.1",
+    "coveralls": "^3.0.2",
     "istanbul": "^1.1.0-alpha.1",
-    "mocha": "^5.1.1",
+    "mocha": "^5.2.0",
     "request-logs": "0.0.5"
@@ -31,2 +30,3 @@ },
   "files": [
+    "config/",
     "lib/",
@@ -33,0 +33,0 @@ "index.js",

README.md

 
 # chrome-webstore
 
-[![npm-version]][npm] [![travis-ci]][travis] [![coveralls-status]][coveralls]
+[![npm-version]][npm]
 
+> Google Chrome Web Store HTTP Client
+
+## Table of Contents
+
+- **[API](#api)**
+  - [detail](#detail) / [items](#items)
+- **[Items Filter Parameters](#items-filter-parameters)**
+  - [search](#search) / [category](#category) / [rating](#rating) / [features](#features)  / [count](#count) / [offset](#offset)
+- **[Examples](#examples)**
+
+# API
+
+Method     | Arguments | Returns    | Description
+---        | ---       | ---        | ---
+**detail** | `{id, related, more}`  | `{Object}` | Get full details about a Web Store item
+**items**  | `{search, category, rating, features, count, offset}` | `[Array]` | Get list of Web Store items
+
+## detail
+
+Get details for a Web Store item:
+
 ```js
-var chrome = require('chrome-webstore')
+var webstore = require('chrome-webstore')
 
 ;(async () => {
-  var meta = await chrome.extension({id: 'ckkdlimhmcjmikdlpkmbgfkaikojcbjk'})
-  // or
-  var meta = await chrome.extension({
-    url: 'https://chrome.google.com/webstore/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk'
-  })
+  var meta = await webstore.detail({id: 'ckkdlimhmcjmikdlpkmbgfkaikojcbjk'})
   console.log(meta)
@@ -19,23 +36,252 @@ })()
 
-```json
+Returns all available data for an item:
+
+```js
 {
-  "id": "ckkdlimhmcjmikdlpkmbgfkaikojcbjk",
-  "name": "Markdown Viewer",
-  "url": "https://chrome.google.com/webstore/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk",
-  "image": "https://lh3.googleusercontent.com/78nux4sjd5uRGIB1oaSFT_zkiktsy-GX_HAGTrKlxnOiw1Jc7Fwhx8IijRpoqYgeiuuPxzQa=w128-h128-e365",
-  "version": "3.5",
-  "price": "0",
-  "priceCurrency": "USD",
-  "interactionCount": "41,639",
-  "operatingSystem": "Chrome",
-  "ratingValue": "4.38",
-  "ratingCount": "120",
-  "updated": "April 16, 2018",
-  "size": "219KiB",
-  "website": "https://github.com/simov/markdown-viewer",
-  "description": "✔ No special permissions required for file URLs\n✔ Full control over the allowed origins\n✔ Supports multiple markdown parsers\n✔ Full control over the compiler options\n✔ Themes support (including GitHub theme)\n✔ Supports GitHub Flavored Markdown\n✔ Syntax highlighted code blocks\n✔ Generates Table of Contents (TOC)\n✔ Remembers scroll position\n✔ Emoji support\n✔ MathJax support\n✔ Settings synchronization\n✔ Raw and rendered markdown views\n✔ Detects markdown by header and path\n✔ Toggle Content Security Policy\n✔ Override page encoding\n✔ Free and Open Source\n\n✚ Local Files\n\n1. Navigate to chrome://extensions\n2. Make sure that the 'Allow access to file URLs' checkbox is checked for the Markdown Viewer extension\n\n✚ Remote Files\n\n1. Click on the Markdown Viewer icon and select 'Advanced Options'\n2. Add the origin that you want enabled for the Markdown Viewer extension\n\n✚ Compiler Options\n\n✔ Compilers: Marked, Remark\n✔ Documentation: https://github.com/simov/markdown-viewer#compiler-options\n\n✚ Content Options\n\n✔ Features: TOC, Scroll, Emoji, Mathjax\n✔ Documentation: https://github.com/simov/markdown-viewer#content-options\n\n✚ Full Documentation\n\n✔ https://github.com/simov/markdown-viewer"
+  id: 'ckkdlimhmcjmikdlpkmbgfkaikojcbjk',
+  name: 'Markdown Viewer',
+  title: 'Markdown Viewer',
+  slug: 'markdown-viewer',
+  url: 'https://chrome.google.com/webstore/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk',
+  author: { name: 'simov.github.io', domain: null, url: null },
+  description: '✔ Renders local and remote URLs\n✔ Granular access to remote origins\n✔ Multiple markdown parsers\n✔ Full control over the compiler options\n✔ Themes (including GitHub theme)\n✔ GitHub Flavored Markdown (GFM)\n✔ Auto reload on file change\n✔ Syntax highlighted code blocks\n✔ Table of Contents (TOC)\n✔ MathJax and Emoji support\n✔ Remembers scroll position\n✔ Markdown Content-Type detection\n✔ URL detection using RegExp\n✔ Toggle Content Security Policy (CSP)\n✔ Override page encoding\n✔ Settings synchronization\n✔ Raw and rendered markdown views\n✔ Free and Open Source\n\n✚ Local Files\n\n1. Navigate to `chrome://extensions`\n2. Locate Markdown Viewer and click on the `DETAILS` button\n3. Make sure that the `Allow access to file URLs` switch is turned on\n\n✚ Remote Files\n\n1. Click on the Markdown Viewer icon and select `Advanced Options`\n2. Add the origin that you want enabled for the Markdown Viewer extension\n\n✚ Compiler Options\n\n✔ Compilers: Marked, Remark\n✔ Documentation: https://github.com/simov/markdown-viewer#compiler-options\n\n✚ Content Options\n\n✔ Features: Autoreload, TOC, Mathjax, Emoji, Scroll\n✔ Documentation: https://github.com/simov/markdown-viewer#content-options\n\n✚ Full Documentation\n\n✔ https://github.com/simov/markdown-viewer',
+  website: 'https://github.com/simov/markdown-viewer',
+  support: 'https://github.com/simov/markdown-viewer/issues',
+  version: '3.6',
+  size: '223KiB',
+  published: 'July 7, 2018',
+  users: '46,860',
+  rating: { average: 4.328467153284672, count: 137 },
+  price: 'Free',
+  purchases: null,
+  category: { name: 'Productivity', slug: 'ext/7-productivity' },
+  images:
+   { '26x26': 'https://lh3.googleusercontent.com/78nux4sjd5uRGIB1oaSFT_zkiktsy-GX_HAGTrKlxnOiw1Jc7Fwhx8IijRpoqYgeiuuPxzQa=w26-h26-e365',
+     '128x128': 'https://lh3.googleusercontent.com/78nux4sjd5uRGIB1oaSFT_zkiktsy-GX_HAGTrKlxnOiw1Jc7Fwhx8IijRpoqYgeiuuPxzQa=w128-h128-e365',
+     '141x90': 'https://lh3.googleusercontent.com/vWHnrFwI1i8--kb0_A9UO4_6xMd0GJOpNvu1iTrh1F0gIbrSkdW1ALzvStVbK6lChDVjAjKG=w141-h90-e365',
+     '220x140': 'https://lh3.googleusercontent.com/vWHnrFwI1i8--kb0_A9UO4_6xMd0GJOpNvu1iTrh1F0gIbrSkdW1ALzvStVbK6lChDVjAjKG=w220-h140-e365',
+     '440x280': 'https://lh3.googleusercontent.com/vWHnrFwI1i8--kb0_A9UO4_6xMd0GJOpNvu1iTrh1F0gIbrSkdW1ALzvStVbK6lChDVjAjKG=w440-h280-e365',
+     '460x340': null },
+  languages: [ 'English' ],
+  developer: { email: null, address: null, policy: null },
+  type: 'Extension',
+  status: 'Published',
+  manifest: '{\n"update_url": "https://clients2.google.com/service/update2/crx",\n\n  "manifest_version": 2,\n  "name"            : "Markdown Viewer",\n  "version"         : "3.6",\n  "description"     : "Markdown Viewer",\n\n  "browser_action": {\n    "default_icon": {\n      "19" : "/images/icon19.png",\n      "38" : "/images/icon38.png"\n    },\n    "default_title": "Markdown Viewer",\n    "default_popup": "/content/popup.html"\n  },\n\n  "options_page": "/content/options.html",\n\n  "background" : {\n    "scripts": [\n      "/vendor/marked.min.js",\n      "/vendor/remark.min.js",\n      "/vendor/remark-html.min.js",\n      "/vendor/remark-slug.min.js",\n      "/vendor/remark-frontmatter.min.js",\n\n      "/background/compilers/marked.js",\n      "/background/compilers/remark.js",\n\n      "/background/storage.js",\n      "/background/webrequest.js",\n      "/background/detect.js",\n      "/background/inject.js",\n      "/background/messages.js",\n      "/background/mathjax.js",\n\n      "/background/index.js"\n    ],\n    "persistent": false\n  },\n\n  "web_accessible_resources": [\n    "/themes/github.css",\n    "/themes/github-dark.css",\n\n    "/themes/godspeed.css",\n    "/themes/new-modern.css",\n    "/themes/torpedo.css",\n    "/themes/vostok.css",\n\n    "/themes/ghostwriter.css",\n    "/themes/radar.css",\n    "/themes/foghorn.css",\n    "/themes/markdown.css",\n    "/themes/markedapp-byword.css",\n    "/themes/solarized-dark.css",\n    "/themes/solarized-light.css",\n\n    "/themes/screen.css",\n    "/themes/markdown5.css",\n    "/themes/markdown6.css",\n    "/themes/markdown7.css",\n    "/themes/markdown8.css",\n    "/themes/markdown9.css",\n    "/themes/markdown-alt.css"\n  ],\n\n  "icons": {\n    "16" : "/images/icon16.png",\n    "48" : "/images/icon48.png",\n    "128": "/images/icon128.png"\n  },\n\n  "homepage_url": "https://chrome.google.com/webstore/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk",\n\n  "permissions": [\n    "storage",\n    "file:///*"\n  ],\n\n  "optional_permissions": [\n    "https://*/",\n    "http://*/",\n    "*://*/",\n    "webRequest",\n    "webRequestBlocking"\n  ]\n}\n'
 }
 ```
 
+Additionally a list of `related` extensions and `more` from the same developer can be included in the result set:
 
+```js
+var webstore = require('chrome-webstore')
+
+;(async () => {
+  var meta = await webstore.detail({id: 'ckkdlimhmcjmikdlpkmbgfkaikojcbjk', related: true, more: true})
+  console.log(meta)
+})()
+```
+
+
+## items
+
+Get a list of items from Chrome Web Store:
+
+```js
+var webstore = require('chrome-webstore')
+
+;(async () => {
+  var meta = await webstore.items({search: 'markdown', category: 'extensions', count: 2})
+  console.log(meta)
+})()
+```
+
+Returns a list of items (only a subset of the detail data):
+
+```js
+[
+  { id: 'elifhakcjgalahccnjkneoccemfahfoa',
+    name: 'Markdown Here',
+    title: 'Write your email in Markdown, then make it pretty.',
+    slug: 'markdown-here',
+    url: 'https://chrome.google.com/webstore/detail/markdown-here/elifhakcjgalahccnjkneoccemfahfoa',
+    author: { name: 'Adam Pritchard', domain: null, url: null },
+    users: '80,395',
+    rating: { average: 4.530864197530864, count: 324 },
+    price: 'Free',
+    category: { name: 'Productivity', slug: 'ext/7-productivity' },
+    images:
+     { '26x26': 'https://lh3.googleusercontent.com/8MnGCOk0daD0BIo1KPOICczj9L1gioa-v4wFIFgIZw5uWRdhDh2UoFZvlcsgisLIgb2o4j484w=w26-h26-e365',
+       '128x128': 'https://lh3.googleusercontent.com/8MnGCOk0daD0BIo1KPOICczj9L1gioa-v4wFIFgIZw5uWRdhDh2UoFZvlcsgisLIgb2o4j484w=w128-h128-e365',
+       '141x90': 'https://lh3.googleusercontent.com/0kFPdu9d7f3WZeQjQcNdzpy-vwVh6V_7HSXWQEKR4qV7W-9neRr7zIctUNHCMKo5huzRU0yu-Q=w141-h90-e365',
+       '220x140': 'https://lh3.googleusercontent.com/0kFPdu9d7f3WZeQjQcNdzpy-vwVh6V_7HSXWQEKR4qV7W-9neRr7zIctUNHCMKo5huzRU0yu-Q=w220-h140-e365',
+       '440x280': 'https://lh3.googleusercontent.com/0kFPdu9d7f3WZeQjQcNdzpy-vwVh6V_7HSXWQEKR4qV7W-9neRr7zIctUNHCMKo5huzRU0yu-Q=w440-h280-e365',
+       '460x340': null },
+    status: 'Published' },
+  { id: 'ckkdlimhmcjmikdlpkmbgfkaikojcbjk',
+    name: 'Markdown Viewer',
+    title: 'Markdown Viewer',
+    slug: 'markdown-viewer',
+    url: 'https://chrome.google.com/webstore/detail/markdown-viewer/ckkdlimhmcjmikdlpkmbgfkaikojcbjk',
+    author: { name: 'simov.github.io', domain: null, url: null },
+    users: '46,860',
+    rating: { average: 4.328467153284672, count: 137 },
+    price: 'Free',
+    category: { name: 'Productivity', slug: 'ext/7-productivity' },
+    images:
+     { '26x26': 'https://lh3.googleusercontent.com/78nux4sjd5uRGIB1oaSFT_zkiktsy-GX_HAGTrKlxnOiw1Jc7Fwhx8IijRpoqYgeiuuPxzQa=w26-h26-e365',
+       '128x128': 'https://lh3.googleusercontent.com/78nux4sjd5uRGIB1oaSFT_zkiktsy-GX_HAGTrKlxnOiw1Jc7Fwhx8IijRpoqYgeiuuPxzQa=w128-h128-e365',
+       '141x90': 'https://lh3.googleusercontent.com/vWHnrFwI1i8--kb0_A9UO4_6xMd0GJOpNvu1iTrh1F0gIbrSkdW1ALzvStVbK6lChDVjAjKG=w141-h90-e365',
+       '220x140': 'https://lh3.googleusercontent.com/vWHnrFwI1i8--kb0_A9UO4_6xMd0GJOpNvu1iTrh1F0gIbrSkdW1ALzvStVbK6lChDVjAjKG=w220-h140-e365',
+       '440x280': 'https://lh3.googleusercontent.com/vWHnrFwI1i8--kb0_A9UO4_6xMd0GJOpNvu1iTrh1F0gIbrSkdW1ALzvStVbK6lChDVjAjKG=w440-h280-e365',
+       '460x340': null },
+    status: 'Published' }
+]
+```
+
+# Items Filter Parameters
+
+The `items` method supports the following parameters:
+
+Parameter    | Example        | Description
+---          | :---:          | ---
+**search**   | `'markdown'`   | Search term to filter by
+**category** | `'extensions'` | Category name to filter by
+**rating**   | `4`            | Filter items by number of stars
+**features** | `['free', 'gdrive']` | Filter items by feature set
+**count**    | `15`           | Number of results to return
+**offset**   | `15`           | Return up to results `count` starting from `offset`
+
+## search
+
+Search the store by string:
+
+```js
+var webstore = require('chrome-webstore')
+
+;(async () => {
+  var meta = await webstore.items({search: 'markdown', category: 'extensions'})
+  console.log(meta)
+})()
+```
+
+## category
+
+Filter by category name:
+
+```js
+var webstore = require('chrome-webstore')
+
+;(async () => {
+  var meta = await webstore.items({category: 'collection/new_noteworthy_extensions'})
+  console.log(meta)
+})()
+```
+
+The following category names are available:
+
+Category            | Description
+---                 | ---
+`extensions`        | All extensions
+`ext/[NAME]`        | Specific extension's category
+`themes`            | All themes
+`theme/[NAME]`      | Specific theme's category
+`collection/[NAME]` | Specific collection
+
+### Extension Categories `ext/[NAME]`
+
+`22-accessibility` | `10-blogging` | `15-by-google` | `11-web-development` | `14-fun` | `6-news` | `28-photos` | `7-productivity` | `38-search-tools` | `12-shopping` | `1-communication` | `13-sports`
+
+### Extension Collections `collection/[NAME]`
+
+`new_noteworthy_extensions` | `editors_picks_extensions` | `chrome_toolkit` | `screen_capture` | `social` | `personalize_chrome` | `tabs_control` | `artistic_extension` | `calendars_planners` | `chat_with_chrome` | `games_extension` | `everyday_extensions` | `3p_accessibility_extensions` | `customize_your_new_tab_page` | `get_started` | `change_the_way_you_work` | `news_weather` | `pdf_extensions` | `lifehacker` | `blogger_extensions` | `online_tools` | `cyber_monday` | `annotate_the_web` | `music_extensions` | `writing_essentials` | `get_organized` | `pomodoro_extensions` | `save_it_for_later` | `ph` | `job_hunting` | `online_productivity` | `quotes_extensions` | `weather_extensions` | `procrastination_station` | `bad_day` | `relax_extensions`
+
+### Extension Top Picks Collections `collection/[NAME]`
+
+`3p_accessibility_extensions` | `top_picks_blogging` | `top_picks_web-development` | `top_picks_fun` | `top_picks_news` | `top_picks_photos` | `top_picks_productivity` | `top_picks_search-tools` | `top_picks_shopping` | `top_picks_communication` | `top_picks_sports`
+
+### Theme Categories `theme/[NAME]`
+
+`48-by-artists` | `15-by-google`
+
+### Theme Collections `collection/[NAME]`
+
+`editors_picks_themes` | `dark_themes` | `space_exploration` | `minimalist_themes` | `enchanting_places` | `heroes_themes` | `pretty_patterns` | `colorful_themes` | `car_themes` | `sunny_themes` | `blue_themes` | `flower_themes`
+
+## rating
+
+Filter by number of stars, one of: `5`, `4`, `3` or `2` stars:
+
+```js
+var webstore = require('chrome-webstore')
+
+;(async () => {
+  var meta = await webstore.items({category: 'extensions', rating: 4})
+  console.log(meta)
+})()
+```
+
+## features
+
+Filter by set of features:
+
+```js
+var webstore = require('chrome-webstore')
+
+;(async () => {
+  var meta = await webstore.items({category: 'extensions', features: ['offline', 'gdrive']})
+  console.log(meta)
+})()
+```
+
+Pick any number of the following:
+
+Value       | Description
+---         | ---
+`'offline'` | Runs Offline
+`'google'`  | By Google
+`'free'`    | Free
+`'android'` | Available for Android
+`'gdrive'`  | Works with Google Drive
+
+## count
+
+Request specific number of records (defaults to 5):
+
+```js
+var webstore = require('chrome-webstore')
+
+;(async () => {
+  var meta = await webstore.items({search: 'markdown', category: 'extensions', count: 15})
+  console.log(meta)
+})()
+```
+
+## offset
+
+Return up to results `count` starting from `offset` (useful for pagination):
+
+```js
+var webstore = require('chrome-webstore')
+
+;(async () => {
+  var meta = await webstore.items({
+    search: 'markdown', category: 'extensions', count: 10, offset: 10
+  })
+  console.log(meta)
+})()
+```
+
+> **Requires the `category` parameter!**
+
+## Examples
+
+- [detail](https://github.com/simov/chrome-webstore/blob/master/examples/detail.js)
+- [items](https://github.com/simov/chrome-webstore/blob/master/examples/items.js)
+
+```bash
+node examples/detail.js [example index]
+node examples/items.js [example index]
+```
+
+
   [npm-version]: https://img.shields.io/npm/v/chrome-webstore.svg?style=flat-square (NPM Package Version)
@@ -42,0 +288,0 @@ [travis-ci]: https://img.shields.io/travis/simov/chrome-webstore/master.svg?style=flat-square (Build Status - Travis CI)

New alerts

Major refactor

Supply chain risk

Package 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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

21200

increased by209.53%

Dependency count

1

decreased by-50%

Number of package files

7

increased by16.67%

Lines of code

188

increased by208.2%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

295

increased by502.04%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedrequest-compose@0.0.19(transitive)

• - Removedhtml-entities@^1.2.1

• - Removedhtml-entities@1.4.0(transitive)

• - Removedrequest-compose@0.0.18(transitive)

• Updatedrequest-compose@0.0.19