@equicord/publish-browser-extension 4.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Aaron Klinker
+
+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/README.md

@@ -0,0 +1,108 @@
+<h1 align="center">Publish Browser Extension</h1>
+<p align="center">Publish an extension to all the extension stores in a single command!</p>
+
+https://github.com/aklinker1/publish-browser-extension/assets/10101283/b0e856ca-4e26-4c7e-9ff8-c900e203cab5
+
+## Features
+
+- Publish to the **Chrome Web Store**, **Firefox Addon Store**, and **Edge Addon Store**
+- Helper script to generate secrets and configure options
+- **Upload sources ZIP** to the Firefox Addon Store
+
+> [!IMPORTANT]
+>
+> You are responsible for uploading and submitting an extension for the first time by hand. `publish-browser-extension` does not provide tools for creating a new extension.
+
+## Install
+
+```sh
+npm i -D publish-browser-extension
+pnpm i -D publish-browser-extension
+bun i -D publish-browser-extension
+```
+
+## CLI Usage
+
+To get started, run the init command. It will walk you through generating all the necessary environment variables/CLI flags, saving them to a `.env.submit` file:
+
+```sh
+publish-extension init
+```
+
+> All CLI flags can be passed as environment variables instead. For example, setting the `CHROME_CLIENT_ID` environment variable is equivalent to passing `--chrome-client-id`. Just convert the flag to UPPER_SNAKE_CASE.
+
+Then, just run the submit command, passing the ZIP files you want to submit:
+
+```sh
+publish-extension \
+  --chrome-zip dist/chrome.zip \
+  --firefox-zip dist/firefox.zip --firefox-sources-zip dist/sources.zip \
+  --edge-zip dist/chrome.zip
+```
+
+`publish-extension` will automatically look for a `.env.submit` file and load it if it exists.
+
+## JS Usage
+
+<!-- prettier-ignore -->
+```js
+import { publishExtension } from 'publish-browser-extension';
+
+publishExtension({
+  dryRun: true,
+  chrome: {
+    zip: 'dist/chrome.zip',
+    extensionId: '<cws-extension-id>',
+    clientId: '<gcp-client-id>',
+    clientSecret: '<gcp-client-secret>',
+    refreshToken: '<gcp-refresh-token>',
+    publishTarget: '<default|trustedTesters>',
+    skipSubmitReview: false,
+  },
+  firefox: {
+    zip: 'dist/firefox.zip',
+    sourcesZip: 'dist/sources.zip',
+    extensionId: '<addons-extension-id>',
+    jwtIssuer: '<addons-jwt-issuer>',
+    jwtSecret: '<addons-jwt-secret>',
+    channel: '<listed|unlisted>',
+  },
+  edge: {
+    zip: 'dist/chrome.zip',
+    productId: "<edge-product-id>",
+    clientId: "<edge-client-id>",
+    apiKey: "<edge-api-key>",
+    skipSubmitReview: false,
+  },
+})
+  .then(results => console.log(results))
+  .catch(err => console.error(err));
+```
+
+## Contributing
+
+<a href="https://github.com/aklinker1/publish-browser-extension/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=aklinker1/publish-browser-extension" />
+</a>
+
+### Contributor Setup
+
+1. Install [bun](https://bun.sh/)
+2. Install dependencies
+   ```sh
+   bun i
+   ```
+3. Run the `init` command to generate a `.env.submit` file for testing
+   ```sh
+   bun publish-extension init
+   ```
+   > [!WARNING]
+   >
+   > Make sure to set the Firefox channel to "unlisted", chrome's publish target to "trustedTesters", and don't submit the extension for review for Chrome or Edge. This will prevent you from accidentally releasing one of the test extensions publicly.
+4. Run the dev commands to upload a test extension to the stores:
+   ```sh
+   bun dev:all
+   bun dev:chrome
+   bun dev:firefox
+   bun dev:edge
+   ```

package/bin/publish-extension.mjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../dist/cli.js';

package/dist/cli.d.ts

@@ -0,0 +1 @@
+export { };

package/dist/cli.js

@@ -0,0 +1,156 @@
+import { d as chromeStatus, n as submit, t as init, u as chromeSetDeployPercentage } from "./init-CL9ikrQH.js";
+import { cac } from "cac";
+import { consola as consola$1 } from "consola";
+import { config } from "dotenv";
+
+//#region package.json
+var version = "4.0.0";
+
+//#endregion
+//#region src/cli.ts
+config({
+	path: ".env.submit",
+	quiet: true
+});
+const cli = cac("publish-extension");
+cli.version(version);
+cli.help();
+cli.option("--dry-run", "Check authentication, but don't upload the zip or submit for review");
+cli.option("--chrome-zip [chromeZip]", "Path to extension zip to upload");
+cli.option("--chrome-extension-id [chromeExtensionId]", "The ID of the extension to be submitted");
+cli.option("--chrome-publisher-id [chromePublisherId]", "The publisher ID from the Chrome Web Store Developer Dashboard");
+cli.option("--chrome-client-id [chromeClientId]", "Client ID used for authorizing requests to the Chrome Web Store");
+cli.option("--chrome-client-secret [chromeClientSecret]", "Client secret used for authorizing requests to the Chrome Web Store");
+cli.option("--chrome-refresh-token [chromeRefreshToken]", "Refresh token used for authorizing requests to the Chrome Web Store");
+cli.option("--chrome-deploy-percentage [chromeDeployPercentage]", "An integer from 1-100");
+cli.option("--chrome-skip-submit-review", "Just upload the extension zip, don't submit it for review or publish it");
+cli.option("--chrome-cancel-pending", "Cancel any pending submission before uploading");
+cli.option("--chrome-skip-review", "Attempt to skip review if the item qualifies");
+cli.option("--chrome-publish-type [chromePublishType]", "Publish type: \"DEFAULT_PUBLISH\" or \"STAGED_PUBLISH\"");
+cli.option("--firefox-zip [firefoxZip]", "Path to extension zip to upload");
+cli.option("--firefox-sources-zip [firefoxSourcesZip]", "Path to sources zip to upload");
+cli.option("--firefox-extension-id [firefoxExtensionId]", "The ID of the extension to be submitted");
+cli.option("--firefox-jwt-issuer [firefoxJwtIssuer]", "Issuer used for authorizing requests to Addon Store APIs");
+cli.option("--firefox-jwt-secret [firefoxJwtSecret]", "Secret used for authorizing requests to Addon Store APIs");
+cli.option("--firefox-channel [firefoxChannel]", "The channel to publish to, \"listed\" or \"unlisted\"");
+cli.option("--edge-zip [edgeZip]", "Path to extension zip to upload");
+cli.option("--edge-product-id [edgeProductId]", "Product ID listed on the developer dashboard");
+cli.option("--edge-client-id [edgeClientId]", "Client ID used for authorizing requests to Microsofts addon API");
+cli.option("--edge-api-key [edgeApiKey]", "API key used for authorizing requests to Microsofts addon API v1.1");
+cli.option("--edge-client-secret [edgeClientSecret]", "DEPRECATED: Client secret used for authorizing requests to Microsofts addon API v1.0 (no longer available)");
+cli.option("--edge-access-token-url [edgeAccessTokenUrl]", "DEPRECATED: Access token URL used for authorizing requests to Microsofts addon API v1.0 (no longer available)");
+cli.option("--edge-skip-submit-review", "Just upload the extension zip, don't submit it for review or publish it");
+function configFromFlags(flags) {
+	return {
+		dryRun: flags.dryRun,
+		chrome: {
+			zip: flags.chromeZip,
+			extensionId: flags.chromeExtensionId,
+			publisherId: flags.chromePublisherId,
+			clientId: flags.chromeClientId,
+			clientSecret: flags.chromeClientSecret,
+			refreshToken: flags.chromeRefreshToken,
+			deployPercentage: flags.chromeDeployPercentage,
+			skipSubmitReview: flags.chromeSkipSubmitReview,
+			cancelPending: flags.chromeCancelPending,
+			skipReview: flags.chromeSkipReview,
+			publishType: flags.chromePublishType
+		},
+		firefox: {
+			zip: flags.firefoxZip,
+			sourcesZip: flags.firefoxSourcesZip,
+			extensionId: flags.firefoxExtensionId,
+			jwtIssuer: flags.firefoxJwtIssuer,
+			jwtSecret: flags.firefoxJwtSecret,
+			channel: flags.firefoxChannel
+		},
+		edge: {
+			zip: flags.edgeZip,
+			productId: flags.edgeProductId,
+			clientId: flags.edgeClientId,
+			apiKey: flags.edgeApiKey,
+			clientSecret: flags.edgeClientSecret,
+			accessTokenUrl: flags.edgeAccessTokenUrl,
+			skipSubmitReview: flags.edgeSkipSubmitReview
+		}
+	};
+}
+cli.command("", "Submit an extension to multiple stores for review").action(async (flags) => {
+	const config$1 = configFromFlags(flags);
+	try {
+		await submit(config$1);
+	} catch (err) {
+		consola$1.error(err);
+		process.exit(1);
+	}
+});
+cli.command("init", "Interactive walkthrough to initialize or update secrets and options for each store").action(async (flags) => {
+	const config$1 = configFromFlags({
+		chromeZip: "...",
+		firefoxZip: "...",
+		edgeZip: "...",
+		...flags
+	});
+	try {
+		await init(config$1);
+	} catch (err) {
+		consola$1.error(err);
+		process.exit(1);
+	}
+});
+cli.command("status", "Fetch the status of a Chrome extension").option("--chrome-extension-id [chromeExtensionId]", "The ID of the extension").option("--chrome-publisher-id [chromePublisherId]", "The publisher ID from the Chrome Web Store Developer Dashboard").option("--chrome-client-id [chromeClientId]", "Client ID used for authorizing requests").option("--chrome-client-secret [chromeClientSecret]", "Client secret used for authorizing requests").option("--chrome-refresh-token [chromeRefreshToken]", "Refresh token used for authorizing requests").action(async (flags) => {
+	const extensionId = flags.chromeExtensionId ?? process.env.CHROME_EXTENSION_ID;
+	const publisherId = flags.chromePublisherId ?? process.env.CHROME_PUBLISHER_ID;
+	const clientId = flags.chromeClientId ?? process.env.CHROME_CLIENT_ID;
+	const clientSecret = flags.chromeClientSecret ?? process.env.CHROME_CLIENT_SECRET;
+	const refreshToken = flags.chromeRefreshToken ?? process.env.CHROME_REFRESH_TOKEN;
+	if (!extensionId || !publisherId || !clientId || !clientSecret || !refreshToken) {
+		consola$1.error("Missing required options: --chrome-extension-id, --chrome-publisher-id, --chrome-client-id, --chrome-client-secret, --chrome-refresh-token");
+		process.exit(1);
+	}
+	try {
+		await chromeStatus({
+			extensionId,
+			publisherId,
+			clientId,
+			clientSecret,
+			refreshToken
+		});
+	} catch (err) {
+		consola$1.error(err);
+		process.exit(1);
+	}
+});
+cli.command("set-deploy-percentage", "Update deployment percentage for a published Chrome extension").option("--chrome-extension-id [chromeExtensionId]", "The ID of the extension").option("--chrome-publisher-id [chromePublisherId]", "The publisher ID from the Chrome Web Store Developer Dashboard").option("--chrome-client-id [chromeClientId]", "Client ID used for authorizing requests").option("--chrome-client-secret [chromeClientSecret]", "Client secret used for authorizing requests").option("--chrome-refresh-token [chromeRefreshToken]", "Refresh token used for authorizing requests").option("--chrome-deploy-percentage <chromeDeployPercentage>", "Deploy percentage (1-100)").action(async (flags) => {
+	const extensionId = flags.chromeExtensionId ?? process.env.CHROME_EXTENSION_ID;
+	const publisherId = flags.chromePublisherId ?? process.env.CHROME_PUBLISHER_ID;
+	const clientId = flags.chromeClientId ?? process.env.CHROME_CLIENT_ID;
+	const clientSecret = flags.chromeClientSecret ?? process.env.CHROME_CLIENT_SECRET;
+	const refreshToken = flags.chromeRefreshToken ?? process.env.CHROME_REFRESH_TOKEN;
+	const deployPercentage = flags.chromeDeployPercentage ? parseInt(flags.chromeDeployPercentage, 10) : void 0;
+	if (!extensionId || !publisherId || !clientId || !clientSecret || !refreshToken) {
+		consola$1.error("Missing required options: --chrome-extension-id, --chrome-publisher-id, --chrome-client-id, --chrome-client-secret, --chrome-refresh-token");
+		process.exit(1);
+	}
+	if (!deployPercentage || deployPercentage < 1 || deployPercentage > 100) {
+		consola$1.error("Missing or invalid --chrome-deploy-percentage (must be 1-100)");
+		process.exit(1);
+	}
+	try {
+		await chromeSetDeployPercentage({
+			extensionId,
+			publisherId,
+			clientId,
+			clientSecret,
+			refreshToken,
+			deployPercentage
+		});
+	} catch (err) {
+		consola$1.error(err);
+		process.exit(1);
+	}
+});
+cli.parse();
+
+//#endregion
+export {  };