chrome-webstore-upload 3.2.0 → 4.0.0

package/index.d.ts

@@ -1,34 +1,15 @@
 import { type ReadStream } from 'node:fs';
+import type { APIClientOptions, ItemResource, PublishResponse } from './types.js';
 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[];
-};
+export type { APIClientOptions, ItemResource, PublishResponse } from './types.js';
+export { CWSError } from './errors.js';
 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>;
+    uploadExisting(streamOrPath: ReadStream | ReadableStream | string, 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>;
@@ -39,4 +20,3 @@ declare class APIClient {
     };
 }
 export default function chromeWebstoreUpload(options: APIClientOptions): APIClient;
-export {};

package/index.js

@@ -1,6 +1,9 @@
 // API documentation:
 // https://developer.chrome.com/docs/webstore/api
 // https://developer.chrome.com/docs/webstore/using-api
+import fs from 'node:fs';
+import { throwIfNotOk } from './errors.js';
+import zipStreamFromDirectory from './zip-dir.js';
 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}`;
@@ -15,13 +18,13 @@ const publishURI = ({ extensionId, target = 'default', deployPercentage }) => {
 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;
-    }
+async function getStreamFromPath(filepath) {
+    const stats = await fs.promises.stat(filepath);
+    return stats.isFile()
+        ? fs.createReadStream(filepath)
+        : zipStreamFromDirectory(filepath);
 }
+export { CWSError } from './errors.js';
 class APIClient {
     extensionId;
     clientId;
@@ -44,10 +47,14 @@ class APIClient {
         this.refreshToken = options.refreshToken;
         this.clientSecret = options.clientSecret;
     }
-    async uploadExisting(readStream, token = this.fetchToken(), maxAwaitInProgressResponseSeconds = 0) {
-        if (!readStream) {
+    async uploadExisting(streamOrPath, token = this.fetchToken(), maxAwaitInProgressResponseSeconds = 0) {
+        if (!streamOrPath) {
             throw new Error('Read stream missing');
         }
+        // Convert string path (file or directory) to stream
+        const readStream = typeof streamOrPath === 'string'
+            ? await getStreamFromPath(streamOrPath)
+            : streamOrPath;
         const { extensionId } = this;
         const request = await fetch(uploadExistingURI(extensionId), {
             method: 'PUT',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chrome-webstore-upload",
-  "version": "3.2.0",
+  "version": "4.0.0",
   "description": "Upload Chrome Extensions to the Chrome Web Store",
   "keywords": [
     "chrome",
@@ -24,7 +24,9 @@
   "types": "./index.d.ts",
   "files": [
     "index.js",
-    "index.d.ts"
+    "index.d.ts",
+    "zip-dir.js",
+    "zip-dir.d.ts"
   ],
   "scripts": {
     "prebundle": "dot-json test/extension/manifest.json version $(utc-version)",
@@ -63,6 +65,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 +75,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/zip-dir.d.ts

@@ -0,0 +1 @@
+export default function zipStreamFromDirectory(directory: string): Promise<NodeJS.ReadableStream>;

package/zip-dir.js

@@ -0,0 +1,17 @@
+import { readdir } from 'node:fs/promises';
+import { basename, join } from 'node:path';
+import { isNotJunk } from 'junk';
+import yazl from 'yazl';
+export default async function zipStreamFromDirectory(directory) {
+    const allFiles = await readdir(directory, { recursive: true });
+    const files = allFiles.filter(file => isNotJunk(basename(file)));
+    if (!files.includes('manifest.json')) {
+        throw new Error(`manifest.json was not found in ${directory}`);
+    }
+    const zip = new yazl.ZipFile();
+    for (const file of files) {
+        zip.addFile(join(directory, file), file);
+    }
+    zip.end();
+    return zip.outputStream;
+}