chrome-webstore-upload 0.5.0 → 1.0.0

package/index.js

@@ -1,17 +1,15 @@
-const got = require('got');
+import got from 'got';
 
 const rootURI = 'https://www.googleapis.com';
 const refreshTokenURI = 'https://www.googleapis.com/oauth2/v4/token';
-const uploadExistingURI = id => `${rootURI}/upload/chromewebstore/v1.1/items/${id}`;
-const publishURI = (id, target) => (
-    `${rootURI}/chromewebstore/v1.1/items/${id}/publish?publishTarget=${target}`
-);
+const uploadExistingURI = id =>
+    `${rootURI}/upload/chromewebstore/v1.1/items/${id}`;
+const publishURI = (id, target) =>
+    `${rootURI}/chromewebstore/v1.1/items/${id}/publish?publishTarget=${target}`;
+const getURI = (id, projection) =>
+    `${rootURI}/chromewebstore/v1.1/items/${id}?projection=${projection}`;
 
-const requiredFields = [
-    'extensionId',
-    'clientId',
-    'refreshToken',
-];
+const requiredFields = ['extensionId', 'clientId', 'refreshToken'];
 
 class APIClient {
     constructor(options) {
@@ -35,18 +33,32 @@ class APIClient {
 
         const { extensionId } = this;
 
-        return got.put(uploadExistingURI(extensionId), {
-            headers: this._headers(await token),
-            body: readStream,
-        }).json();
+        return got
+            .put(uploadExistingURI(extensionId), {
+                headers: this._headers(await token),
+                body: readStream,
+            })
+            .json();
     }
 
     async publish(target = 'default', token = this.fetchToken()) {
         const { extensionId } = this;
 
-        return got.post(publishURI(extensionId, target), {
-            headers: this._headers(await token),
-        }).json();
+        return got
+            .post(publishURI(extensionId, target), {
+                headers: this._headers(await token),
+            })
+            .json();
+    }
+
+    async get(projection = 'DRAFT', token = this.fetchToken()) {
+        const { extensionId } = this;
+
+        return got
+            .get(getURI(extensionId, projection), {
+                headers: this._headers(await token),
+            })
+            .json();
     }
 
     async fetchToken() {
@@ -74,6 +86,6 @@ class APIClient {
     }
 }
 
-module.exports = function (...args) {
+export default function chromeWebstoreUpload(...args) {
     return new APIClient(...args);
-};
+}

package/license

@@ -0,0 +1,10 @@
+The MIT License (MIT)
+
+Copyright (c) Federico Brigante <me@fregante.com> (https://fregante.com)
+Copyright (c) 2020 Andrew Levine
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -1,16 +1,7 @@
 {
   "name": "chrome-webstore-upload",
-  "version": "0.5.0",
-  "license": "MIT",
-  "description": "Programatically upload + publish changes to the Chrome Webstore",
-  "repository": "fregante/chrome-webstore-upload",
-  "funding": "https://github.com/sponsors/fregante",
-  "engines": {
-    "node": ">=12.20"
-  },
-  "scripts": {
-    "test": "xo && ava"
-  },
+  "version": "1.0.0",
+  "description": "Upload Chrome Extensions to the Chrome Web Store",
   "keywords": [
     "chrome",
     "publish",
@@ -21,10 +12,31 @@
     "update",
     "upload"
   ],
+  "repository": "fregante/chrome-webstore-upload",
+  "funding": "https://github.com/sponsors/fregante",
+  "license": "MIT",
+  "author": "Andrew Levine",
   "contributors": [
-    "Andrew Levine",
     "Federico Brigante <me@fregante.com> (https://fregante.com)"
   ],
+  "type": "module",
+  "exports": "./index.js",
+  "files": [
+    "index.js"
+  ],
+  "scripts": {
+    "test": "xo && ava"
+  },
+  "xo": {
+    "rules": {
+      "camelcase": "off",
+      "object-curly-spacing": [
+        "error",
+        "always"
+      ]
+    },
+    "space": 4
+  },
   "dependencies": {
     "got": "^11.8.2"
   },
@@ -33,17 +45,7 @@
     "sinon": "^11.1.2",
     "xo": "^0.44.0"
   },
-  "xo": {
-    "space": 4,
-    "rules": {
-      "camelcase": "off",
-      "func-names": "off",
-      "object-curly-spacing": [
-        "error",
-        "always"
-      ],
-      "unicorn/filename-case": "off",
-      "unicorn/prefer-module": "off"
-    }
+  "engines": {
+    "node": "^12.20.0 || ^14.13.1 || >=16.0.0"
   }
 }

package/{README.md → readme.md}

@@ -5,6 +5,7 @@
 If you're looking to upload/publish from the CLI, then use [chrome-webstore-upload-cli](https://github.com/fregante/chrome-webstore-upload-cli).
 
 ## Install
+
 ```
 npm install --save-dev chrome-webstore-upload
 ```
@@ -20,40 +21,57 @@ Note: If you created the APIs before version 0.5.0 (September 2021), you might h
 All methods return an ES2015-compliant promise.
 
 ### Create a new client
+
 ```javascript
-const webStore = require('chrome-webstore-upload')({
-    extensionId: 'ecnglinljpjkbgmdpeiglonddahpbkeb',
-    clientId: 'xxxxxxxxxx',
-    refreshToken: 'xxxxxxxxxx'
+import chromeWebstoreUpload from 'chrome-webstore-upload';
+
+const store = chromeWebstoreUpload({
+  extensionId: 'ecnglinljpjkbgmdpeiglonddahpbkeb',
+  clientId: 'xxxxxxxxxx',
+  refreshToken: 'xxxxxxxxxx',
 });
 ```
 
 ### Upload to existing extension
+
 ```javascript
-const fs = require('fs');
+import fs from 'fs';
 
 const myZipFile = fs.createReadStream('./mypackage.zip');
 const token = 'xxxx'; // optional. One will be fetched if not provided
-webStore.uploadExisting(myZipFile, token).then(res => {
-    // Response is a Resource Representation
-    // https://developer.chrome.com/webstore/webstore_api/items#resource
+store.uploadExisting(myZipFile, token).then(res => {
+  // Response is a Resource Representation
+  // https://developer.chrome.com/webstore/webstore_api/items#resource
 });
 ```
 
 ### Publish extension
+
 ```javascript
 const target = 'default'; // optional. Can also be 'trustedTesters'
 const token = 'xxxx'; // optional. One will be fetched if not provided
-webStore.publish(target, token).then(res => {
-   // Response is documented here:
-   // https://developer.chrome.com/webstore/webstore_api/items/publish
+store.publish(target, token).then(res => {
+  // Response is documented here:
+  // https://developer.chrome.com/webstore/webstore_api/items/publish
+});
+```
+
+### Get a Chrome Web Store item
+
+```javascript
+const projection = "DRAFT"; // optional. Can also be 'PUBLISHED' but only "DRAFT" is supported at this time.
+const token = "xxxx"; // optional. One will be fetched if not provided
+store.get(projection, token).then((res) => {
+  // Response is documented here:
+  // https://developer.chrome.com/docs/webstore/webstore_api/items/get
 });
 ```
 
 ### Fetch token
+
 ```javascript
-webStore.fetchToken().then(token => {
-   // Token is a string
+store.fetchToken().then(token => {
+  // Token is a string
 });
 ```
 
@@ -61,6 +79,9 @@ webStore.fetchToken().then(token => {
 
 - If you plan to upload _and_ publish at the same time, use the `fetchToken` method, and pass it to both `uploadExisting` and `publish` as the optional second parameter. This will avoid those methods making duplicate calls for new tokens.
 
-## Prior Art
-- [grunt-webstore-upload](https://github.com/c301/grunt-webstore-upload)
-- [chrome-webstore-manager](https://github.com/pastak/chrome-webstore-manager)
+## Related
+
+- [webext-storage-cache](https://github.com/fregante/webext-storage-cache) - Map-like promised cache storage with expiration. Chrome and Firefox
+- [webext-dynamic-content-scripts](https://github.com/fregante/webext-dynamic-content-scripts) - Automatically registers your content_scripts on domains added via permission.request
+- [Awesome-WebExtensions](https://github.com/fregante/Awesome-WebExtensions) - A curated list of awesome resources for WebExtensions development.
+- [More…](https://github.com/fregante/webext-fun)

package/.github/workflows/ci.yml

@@ -1,22 +0,0 @@
-name: CI
-on:
-  - push
-  - pull_request
-jobs:
-  test:
-    name: Node.js ${{ matrix.node-version }}
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        node-version:
-          - 16
-          - 14
-          - 12
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-      - run: npm install
-      - run: npm test

package/How to generate Google API keys.md

@@ -1,89 +0,0 @@
-# How to generate Google API keys
-
-[chrome-webstore-upload](https://github.com/fregante/chrome-webstore-upload) uses the Chrome Web Store API.
-
-Here's how to get its 2 access keys: `clientId`, `refreshToken`
-
-Version below v0.5.0 used `clientSecret`, but this is no longer used, as long as you create a "Chrome App" OAuth.
-
-*Note:* the names you enter here don't really matter. It's an app that only you will have access to. This will take approximately 10 minutes and Google likes to change these screens often. Sorry.
-
-0. Visit https://console.developers.google.com/apis/credentials
-0. Create a project:
-
-	<img width="772" alt="Google APIs: Create project" src="https://user-images.githubusercontent.com/1402241/77865620-9a8a3680-722f-11ea-99cb-b09e5c0c11ec.png">
-
-0. Enter `chrome-webstore-upload` and **Create**
-0. Visit https://console.cloud.google.com/apis/credentials/consent
-0. Select on **External** and **Create**
-
-	> <img width="804" alt="OAuth Consent Screen" src="https://user-images.githubusercontent.com/1402241/133878019-f159f035-2b76-4686-a461-0e0005355da6.png">
-
-0. Only enter the Application name (e.g. `chrome-webstore-upload`) and required email fields, and click **Save**
-
-	> <img width="475" alt="Consent screen configuration" src="https://user-images.githubusercontent.com/1402241/77865809-82ff7d80-7230-11ea-8a96-e381d55524c5.png">
-
-0. On the 3rd screen, add your own email address:
-
-	> <img width="632" alt="Test users selection" src="https://user-images.githubusercontent.com/1402241/106213510-7c180300-6192-11eb-97b4-b4ae92424bf1.png">
-
-0. Visit https://console.developers.google.com/apis/library/chromewebstore.googleapis.com
-0. Click **Enable**
-0. Visit https://console.developers.google.com/apis/credentials
-0. Click **Create credentials** > **OAuth client ID**:
-
-	> <img width="771" alt="Create credentials" src="https://user-images.githubusercontent.com/1402241/77865679-e89f3a00-722f-11ea-942d-5245091f22b8.png">
-
-0. Select **Chrome app**, enter `Chrome Webstore Upload`, your extension’s ID, and click **Create**
-
-	> <img width="547" alt="Create OAuth client ID" src="https://user-images.githubusercontent.com/1402241/106205904-de6a0700-6184-11eb-8591-984e69c5e82a.png">
-
-0. Save your ✅ `clientId`; This is 1 of the 2 keys you will need
-
-	> <img width="567" alt="OAuth client created" src="https://user-images.githubusercontent.com/1402241/133878131-9303a024-3f8e-4037-9816-cdf042a91d84.png">
-
-0. Visit https://console.cloud.google.com/apis/credentials/consent
-0. Click **PUBLISH APP** and confirm
-
-	<img width="771" alt="Publish app" src="https://user-images.githubusercontent.com/27696701/114265946-2da2a280-9a26-11eb-9567-c4e00f572500.png">
-
-0. Place your `clientId` in this URL and open it:
-
-	`https://accounts.google.com/o/oauth2/auth?response_type=code&scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fchromewebstore&redirect_uri=urn%3Aietf%3Awg%3Aoauth%3A2.0%3Aoob&access_type=offline&approval_prompt=force&client_id=YOUR_CLIENT_ID_HERE`
-
-0. Follow its steps and warnings (this is your own personal app)
-0. Wait on this page:
-
-	<img width="521" alt="Last page of OAuth" src="https://user-images.githubusercontent.com/1402241/77866731-79781480-7234-11ea-8f81-c533846d89ea.png">
-
-0. Run this in your browser console **on that last page**. It's a wizard to create your `refresh_token`:
-
-```js
-(async () => {
-  const response = await fetch('https://accounts.google.com/o/oauth2/token', {
-    method: "POST",
-    body: new URLSearchParams([
-      ['client_id', prompt('Enter your clientId')],
-      ['code', new URLSearchParams(location.search).get('approvalCode')],
-      ['grant_type', 'authorization_code'],
-      ['redirect_uri', 'urn:ietf:wg:oauth:2.0:oob']
-    ]),
-    headers: {
-      'Content-Type': 'application/x-www-form-urlencoded'
-    }
-  });
-  const json = await response.json();
-  console.log(json);
-  if (!json.error) {
-    if (typeof copy === 'function') {
-      copy(json.refresh_token);
-      alert('The refresh_token has been copied into your clipboard. You’re done!');
-    } else {
-      console.log('Copy your token:', json.refresh_token);
-      alert('Copy your refresh_token from the console output. You’re done!');
-    }
-  }
-})();
-```
-
-9001. Done. Now you should have ✅ `clientId` and ✅ `refreshToken`. You can use these for all your extensions, but don't share them!

package/LICENSE.md

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 Andrew Levine
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.