chrome-webstore-upload 4.0.0-0 → 4.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chrome-webstore-upload",
-  "version": "4.0.0-0",
+  "version": "4.0.1",
   "description": "Upload Chrome Extensions to the Chrome Web Store",
   "keywords": [
     "chrome",
@@ -20,11 +20,10 @@
     "Federico Brigante <me@fregante.com> (https://fregante.com)"
   ],
   "type": "module",
-  "exports": "./index.js",
-  "types": "./index.d.ts",
+  "exports": "./distribution/index.js",
+  "types": "./distribution/index.d.ts",
   "files": [
-    "index.js",
-    "index.d.ts"
+    "distribution"
   ],
   "scripts": {
     "prebundle": "dot-json test/extension/manifest.json version $(utc-version)",
@@ -63,6 +62,7 @@
   },
   "devDependencies": {
     "@sindresorhus/tsconfig": "^5.0.0",
+    "@types/yazl": "^3.3.0",
     "dot-json": "^1.3.0",
     "fetch-mock": "^9.11.0",
     "node-fetch": "^2.7.0",
@@ -72,9 +72,13 @@
     "xo": "^0.58.0"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   },
   "webExt": {
     "sourceDir": "test/extension"
+  },
+  "dependencies": {
+    "junk": "^4.0.1",
+    "yazl": "^3.3.1"
   }
 }

package/readme.md

@@ -33,16 +33,33 @@ const store = chromeWebstoreUpload({
 
 ### Upload to existing extension
 
+You can upload a zip file, crx file, or a directory. If you provide a directory, it will be automatically zipped.
+
 ```javascript
 import fs from 'fs';
 
+// Upload a zip file
 const myZipFile = fs.createReadStream('./mypackage.zip');
 const token = 'xxxx'; // optional. One will be fetched if not provided
-const response = await store.uploadExisting(myZipFile, token);
+const maxAwaitInProgressResponseSeconds = 60; // optional. If the API response is IN_PROGRESS, this method will wait until it becomes successful, or until the specified timeout
+const response = await store.uploadExisting(myZipFile, token, maxAwaitInProgressResponseSeconds);
 // response is a Resource Representation
 // https://developer.chrome.com/webstore/webstore_api/items#resource
 ```
 
+```javascript
+// Upload a directory (it will be zipped automatically)
+const response = await store.uploadExisting('./path/to/extension-directory', token, maxAwaitInProgressResponseSeconds);
+// The directory must contain a manifest.json file
+```
+
+```javascript
+// Upload a .zip or .crx file by path
+const response = await store.uploadExisting('./path/to/extension.zip', token, maxAwaitInProgressResponseSeconds);
+// or
+const response = await store.uploadExisting('./path/to/extension.crx', token, maxAwaitInProgressResponseSeconds);
+```
+
 ### Publish extension
 
 ```javascript

package/index.d.ts

@@ -1,42 +0,0 @@
-import { type ReadStream } from 'node:fs';
-export declare const refreshTokenURI = "https://www.googleapis.com/oauth2/v4/token";
-export type APIClientOptions = {
-    extensionId: string;
-    clientId: string;
-    refreshToken: string;
-    clientSecret: string | undefined;
-};
-export type ItemResource = {
-    kind: 'chromewebstore#item';
-    id: string;
-    publicKey: string;
-    uploadState: 'FAILURE' | 'IN_PROGRESS' | 'NOT_FOUND' | 'SUCCESS';
-    itemError: Array<{
-        error_code: string;
-        error_detail: string;
-    }>;
-};
-export type PublishResponse = {
-    kind: 'chromewebstore#item';
-    item_id: string;
-    status: Array<'OK' | 'NOT_AUTHORIZED' | 'INVALID_DEVELOPER' | 'DEVELOPER_NO_OWNERSHIP' | 'DEVELOPER_SUSPENDED' | 'ITEM_NOT_FOUND' | 'ITEM_PENDING_REVIEW' | 'ITEM_TAKEN_DOWN' | 'PUBLISHER_SUSPENDED'>;
-    statusDetail: string[];
-};
-declare class APIClient {
-    extensionId: string;
-    clientId: string;
-    refreshToken: string;
-    clientSecret: string | undefined;
-    constructor(options: APIClientOptions);
-    uploadExisting(readStream: ReadStream | ReadableStream, token?: string | Promise<string>, maxAwaitInProgressResponseSeconds?: number): Promise<ItemResource>;
-    publish(target?: string, token?: string | Promise<string>, deployPercentage?: number | undefined): Promise<PublishResponse>;
-    get(projection?: string, token?: string | Promise<string>): Promise<ItemResource>;
-    fetchToken(): Promise<string>;
-    _waitUploadSuccess(response: ItemResource, maxAwaitInProgressResponseSeconds: number): Promise<ItemResource>;
-    _headers(token: string): {
-        Authorization: string;
-        'x-goog-api-version': string;
-    };
-}
-export default function chromeWebstoreUpload(options: APIClientOptions): APIClient;
-export {};

package/index.js

@@ -1,126 +0,0 @@
-// 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 = ({ 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'];
-const retryIntervalSeconds = 2;
-function throwIfNotOk(request, response) {
-    if (!request.ok) {
-        const error = new Error(request.statusText ?? 'Unknown error');
-        error.response = 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.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.extensionId = options.extensionId;
-        this.clientId = options.clientId;
-        this.refreshToken = options.refreshToken;
-        this.clientSecret = options.clientSecret;
-    }
-    async uploadExisting(readStream, token = this.fetchToken(), maxAwaitInProgressResponseSeconds = 0) {
-        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',
-            // Until they figure it out, this seems to work. Alternatively use https://stackoverflow.com/a/76780381/288906
-            body: readStream,
-        });
-        const response = await request.json();
-        throwIfNotOk(request, response);
-        return this._waitUploadSuccess(response, maxAwaitInProgressResponseSeconds);
-    }
-    async publish(target = 'default', token = this.fetchToken(), deployPercentage = undefined) {
-        const { extensionId } = this;
-        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) {
-            delete json.client_secret;
-        }
-        const request = await fetch(refreshTokenURI, {
-            method: 'POST',
-            body: JSON.stringify(json),
-            headers: {
-                'Content-Type': 'application/json',
-            },
-        });
-        const response = await request.json();
-        throwIfNotOk(request, response);
-        return response.access_token;
-    }
-    async _waitUploadSuccess(response, maxAwaitInProgressResponseSeconds) {
-        if (response.uploadState !== 'IN_PROGRESS' || maxAwaitInProgressResponseSeconds < retryIntervalSeconds) {
-            return response;
-        }
-        // Wait before checking again
-        await new Promise(resolve => {
-            setTimeout(resolve, retryIntervalSeconds * 1000);
-        });
-        // Retry fetching the item resource
-        return this._waitUploadSuccess(await this.get('DRAFT'), maxAwaitInProgressResponseSeconds - retryIntervalSeconds);
-    }
-    _headers(token) {
-        return {
-            Authorization: `Bearer ${token}`,
-            'x-goog-api-version': '2',
-        };
-    }
-}
-export default function chromeWebstoreUpload(options) {
-    return new APIClient(options);
-}