chrome-webstore-upload 3.0.3 → 3.1.1

package/index.d.ts

@@ -0,0 +1,25 @@
+import { type JsonObject } from 'type-fest';
+export declare const refreshTokenURI = "https://www.googleapis.com/oauth2/v4/token";
+export type APIClientOptions = {
+    extensionId: string;
+    clientId: string;
+    refreshToken: string;
+    clientSecret: string | undefined;
+};
+declare class APIClient {
+    extensionId: string;
+    clientId: string;
+    refreshToken: string;
+    clientSecret: string | undefined;
+    constructor(options: APIClientOptions);
+    uploadExisting(readStream: ReadableStream, token?: Promise<string>): Promise<JsonObject>;
+    publish(target?: string, token?: Promise<string>, deployPercentage?: number | undefined): Promise<JsonObject>;
+    get(projection?: string, token?: Promise<string>): Promise<JsonObject>;
+    fetchToken(): Promise<string>;
+    _headers(token: string): {
+        Authorization: string;
+        'x-goog-api-version': string;
+    };
+}
+export default function chromeWebstoreUpload(options: APIClientOptions): APIClient;
+export {};

package/index.js

@@ -1,18 +1,19 @@
 // API documentation:
 // https://developer.chrome.com/docs/webstore/api
 // https://developer.chrome.com/docs/webstore/using-api
-
 const rootURI = 'https://www.googleapis.com';
 export 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 getURI = (id, projection) =>
-    `${rootURI}/chromewebstore/v1.1/items/${id}?projection=${projection}`;
-
+const uploadExistingURI = (id) => `${rootURI}/upload/chromewebstore/v1.1/items/${id}`;
+const publishURI = ({ extensionId, target = 'default', deployPercentage }) => {
+    const url = new URL(`${rootURI}/chromewebstore/v1.1/items/${extensionId}/publish`);
+    url.searchParams.set('publishTarget', target);
+    if (deployPercentage !== undefined) {
+        url.searchParams.set('deployPercentage', String(deployPercentage));
+    }
+    return url.href;
+};
+const getURI = (id, projection) => `${rootURI}/chromewebstore/v1.1/items/${id}?projection=${projection}`;
 const requiredFields = ['extensionId', 'clientId', 'refreshToken'];
-
 function throwIfNotOk(request, response) {
     if (!request.ok) {
         const error = new Error(request.statusText ?? 'Unknown error');
@@ -20,89 +21,75 @@ function throwIfNotOk(request, response) {
         throw error;
     }
 }
-
 class APIClient {
+    extensionId;
+    clientId;
+    refreshToken;
+    clientSecret;
     constructor(options) {
         if (typeof fetch !== 'function') {
-            throw new TypeError('`chrome-webstore-upload` requires Node.js 18.0 or newer because it relies on the global `fetch` function.');
+            throw new TypeError('`chrome-webstore-upload` requires Node.js 18.17 or newer because it relies on the global `fetch` function.');
+        }
+        if (typeof options !== 'object') {
+            throw new TypeError('The options object is required');
         }
-
         for (const field of requiredFields) {
             if (!options[field]) {
                 throw new Error(`Option "${field}" is required`);
             }
-
-            this[field] = options[field];
-        }
-
-        if ('clientSecret' in options) {
-            this.clientSecret = options.clientSecret;
         }
+        this.extensionId = options.extensionId;
+        this.clientId = options.clientId;
+        this.refreshToken = options.refreshToken;
+        this.clientSecret = options.clientSecret;
     }
-
     async uploadExisting(readStream, token = this.fetchToken()) {
         if (!readStream) {
             throw new Error('Read stream missing');
         }
-
         const { extensionId } = this;
-
         const request = await fetch(uploadExistingURI(extensionId), {
             method: 'PUT',
             headers: this._headers(await token),
+            // @ts-expect-error Node extension? 🤷‍♂️ Required https://github.com/nodejs/node/issues/46221
             duplex: 'half',
             body: readStream,
         });
-
         const response = await request.json();
-
         throwIfNotOk(request, response);
-
         return response;
     }
-
-    async publish(target = 'default', token = this.fetchToken()) {
+    async publish(target = 'default', token = this.fetchToken(), deployPercentage = undefined) {
         const { extensionId } = this;
-
-        const request = await fetch(publishURI(extensionId, target), {
+        const request = await fetch(publishURI({ extensionId, target, deployPercentage }), {
             method: 'POST',
             headers: this._headers(await token),
         });
-
         const response = await request.json();
-
         throwIfNotOk(request, response);
-
         return response;
     }
-
     async get(projection = 'DRAFT', token = this.fetchToken()) {
         const { extensionId } = this;
-
         const request = await fetch(getURI(extensionId, projection), {
             method: 'GET',
             headers: this._headers(await token),
         });
-
         const response = await request.json();
-
         throwIfNotOk(request, response);
-
         return response;
     }
-
     async fetchToken() {
         const { clientId, clientSecret, refreshToken } = this;
         const json = {
             client_id: clientId,
             refresh_token: refreshToken,
             grant_type: 'refresh_token',
+            client_secret: clientSecret,
         };
-
-        if (clientSecret) {
-            json.client_secret = clientSecret;
+        if (!clientSecret) {
+            delete json.client_secret;
         }
-
         const request = await fetch(refreshTokenURI, {
             method: 'POST',
             body: JSON.stringify(json),
@@ -110,14 +97,10 @@ class APIClient {
                 'Content-Type': 'application/json',
             },
         });
-
-        await throwIfNotOk(request);
-
         const response = await request.json();
-
-        return response.access_token;
+        throwIfNotOk(request, response);
+        return response['access_token'];
     }
-
     _headers(token) {
         return {
             Authorization: `Bearer ${token}`,
@@ -125,7 +108,6 @@ class APIClient {
         };
     }
 }
-
-export default function chromeWebstoreUpload(...args) {
-    return new APIClient(...args);
+export default function chromeWebstoreUpload(options) {
+    return new APIClient(options);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chrome-webstore-upload",
-  "version": "3.0.3",
+  "version": "3.1.1",
   "description": "Upload Chrome Extensions to the Chrome Web Store",
   "keywords": [
     "chrome",
@@ -21,16 +21,21 @@
   ],
   "type": "module",
   "exports": "./index.js",
+  "types": "./index.d.ts",
   "files": [
-    "index.js"
+    "index.js",
+    "index.d.ts"
   ],
   "scripts": {
-    "test": "xo && vitest run",
-    "upload": "npm run bundle && npm run test:upload",
     "prebundle": "dot-json test/extension/manifest.json version $(utc-version)",
     "bundle": "web-ext build --filename live-test.zip --overwrite-dest",
     "postbundle": "git restore test/extension/manifest.json",
-    "test:upload": "eval $(cat .env) node test/live-test.js"
+    "build": "tsc",
+    "watch": "tsc -w",
+    "prepack": "npm run build",
+    "test": "xo && vitest run && tsc",
+    "test:upload": "eval $(cat .env) node test/live-test.js",
+    "upload": "npm run bundle && npm run test:upload"
   },
   "xo": {
     "rules": {
@@ -40,15 +45,32 @@
         "always"
       ]
     },
+    "overrides": [
+      {
+        "files": [
+          "**/*.ts"
+        ],
+        "rules": {
+          "@typescript-eslint/naming-convention": "off",
+          "@typescript-eslint/object-curly-spacing": [
+            "error",
+            "always"
+          ]
+        }
+      }
+    ],
     "space": 4
   },
   "devDependencies": {
+    "@sindresorhus/tsconfig": "^5.0.0",
     "dot-json": "^1.3.0",
     "fetch-mock": "^9.11.0",
     "node-fetch": "^2.7.0",
+    "type-fest": "^4.9.0",
+    "typescript": "^5.3.3",
     "utc-version": "^2.0.2",
-    "vitest": "^1.0.4",
-    "xo": "^0.56.0"
+    "vitest": "^1.6.0",
+    "xo": "^0.58.0"
   },
   "engines": {
     "node": ">=18"

package/readme.md

@@ -38,10 +38,9 @@ import fs from 'fs';
 
 const myZipFile = fs.createReadStream('./mypackage.zip');
 const token = 'xxxx'; // optional. One will be fetched if not provided
-store.uploadExisting(myZipFile, token).then(res => {
-  // Response is a Resource Representation
-  // https://developer.chrome.com/webstore/webstore_api/items#resource
-});
+const response = await store.uploadExisting(myZipFile, token);
+// response is a Resource Representation
+// https://developer.chrome.com/webstore/webstore_api/items#resource
 ```
 
 ### Publish extension
@@ -49,10 +48,10 @@ store.uploadExisting(myZipFile, token).then(res => {
 ```javascript
 const target = 'default'; // optional. Can also be 'trustedTesters'
 const token = 'xxxx'; // optional. One will be fetched if not provided
-store.publish(target, token).then(res => {
-  // Response is documented here:
-  // https://developer.chrome.com/webstore/webstore_api/items/publish
-});
+const deployPercentage = 25; // optional. Will default to 100%.
+const response = await store.publish(target, token, deployPercentage);
+// response is documented here:
+// https://developer.chrome.com/webstore/webstore_api/items#publish
 ```
 
 ### Get a Chrome Web Store item
@@ -60,18 +59,16 @@ store.publish(target, token).then(res => {
 ```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
-});
+const response = await store.get(projection, token);
+// response is documented here:
+// https://developer.chrome.com/docs/webstore/webstore_api/items#get
 ```
 
 ### Fetch token
 
 ```javascript
-store.fetchToken().then(token => {
-  // Token is a string
-});
+const token = store.fetchToken();
+// token is  astring
 ```
 
 ## Tips