@hibi_10000/crx 0.5.1

package/dist/index.d.ts

@@ -0,0 +1,87 @@
+import crypto from "node:crypto";
+
+//#region src/index.d.ts
+/** @enum {number} CrxVersion */
+declare const CrxVersion: {
+  readonly VERSION_2: 2;
+  readonly VERSION_3: 3;
+};
+interface BrowserManifest {
+  minimum_chrome_version?: string;
+  version: string;
+}
+type BrowserExtensionOptions = { [K in keyof Omit<ChromeExtension, "loaded"> as ChromeExtension[K] extends Function ? never : K]?: ChromeExtension[K] };
+declare class ChromeExtension {
+  appId?: string;
+  rootDirectory: string;
+  publicKey?: Buffer;
+  privateKey?: crypto.KeyLike;
+  codebase?: string;
+  path?: string;
+  src: string;
+  ignore: string[];
+  version: number;
+  loaded: boolean;
+  manifest?: BrowserManifest;
+  constructor(attrs: BrowserExtensionOptions);
+  /**
+  * Packs the content of the extension in a crx file.
+  *
+  * @example
+  *
+  * crx.pack().then(function(crxContent){
+  *  // do something with the crxContent binary data
+  * });
+  *
+  */
+  pack(contentsBuffer?: Buffer): Promise<Buffer>;
+  /**
+  * Loads extension manifest and copies its content to a workable path.
+  */
+  load(path?: string | string[]): Promise<ChromeExtension>;
+  /**
+  * Generates a public key.
+  *
+  * BC BREAK `this.publicKey` is not stored anymore (since 1.0.0)
+  * BC BREAK callback parameter has been removed in favor to the promise interface.
+  *
+  * @returns Resolves to {Buffer} containing the public key
+  * @example
+  *
+  * crx.generatePublicKey(function(publicKey){
+  *   // do something with publicKey
+  * });
+  */
+  generatePublicKey(): Promise<Buffer>;
+  /**
+  * BC BREAK `this.contents` is not stored anymore (since 1.0.0)
+  */
+  loadContents(): Promise<Buffer>;
+  /**
+  * Generates an appId from the publicKey.
+  * Public key has to be set for this to work, otherwise an error is thrown.
+  *
+  * BC BREAK `this.appId` is not stored anymore (since 1.0.0)
+  * BC BREAK introduced `publicKey` parameter as it is not stored any more since 2.0.0
+  *
+  * @param keyOrPath the public key to use to generate the app ID
+  */
+  generateAppId(keyOrPath?: Buffer | string): string;
+  /**
+  * Generates an updateXML file from the extension content.
+  *
+  * If manifest does not include `minimum_chrome_version`, defaults to:
+  * - '29.0.0' for CRX2, which is earliest extensions API available
+  * - '64.0.3242' for CRX3, which is when Chrome etension packager switched to CRX3
+  *
+  * BC BREAK `this.updateXML` is not stored anymore (since 1.0.0)
+  *
+  * [Chrome Extensions APIs]{@link https://developer.chrome.com/extensions/api_index}
+  * [Chrome verions]{@link https://en.wikipedia.org/wiki/Google_Chrome_version_history}
+  * [Chromium switches to CRX3]{@link https://chromium.googlesource.com/chromium/src.git/+/b8bc9f99ef4ad6223dfdcafd924051561c05ac75}
+  */
+  generateUpdateXML(): Buffer;
+}
+//#endregion
+export { CrxVersion, ChromeExtension as default, ChromeExtension as "module.exports" };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,157 @@
+import resolve from "./resolver.js";
+import generatePackage from "./crx2.js";
+import generatePackage$1 from "./crx3.js";
+import { join } from "node:path";
+import fs from "node:fs";
+import crypto from "node:crypto";
+import archiver from "archiver";
+
+//#region src/index.ts
+/** @enum {number} CrxVersion */
+const CrxVersion = {
+	VERSION_2: 2,
+	VERSION_3: 3
+};
+var ChromeExtension = class {
+	appId;
+	rootDirectory = "";
+	publicKey;
+	privateKey;
+	codebase;
+	path;
+	src = "**";
+	ignore = ["*.crx"];
+	version = CrxVersion.VERSION_3;
+	loaded;
+	manifest;
+	constructor(attrs) {
+		Object.assign(this, attrs);
+		this.loaded = false;
+	}
+	/**
+	* Packs the content of the extension in a crx file.
+	*
+	* @example
+	*
+	* crx.pack().then(function(crxContent){
+	*  // do something with the crxContent binary data
+	* });
+	*
+	*/
+	async pack(contentsBuffer) {
+		if (!this.loaded) return this.load().then(this.pack.bind(this, contentsBuffer));
+		const publicKey = await this.generatePublicKey();
+		const contents = contentsBuffer || await this.loadContents();
+		this.publicKey = publicKey;
+		if (this.version === 2) return generatePackage(this.privateKey, publicKey, contents);
+		return generatePackage$1(this.privateKey, publicKey, contents);
+	}
+	/**
+	* Loads extension manifest and copies its content to a workable path.
+	*/
+	async load(path$1) {
+		const metadata = await resolve(path$1 || this.rootDirectory);
+		this.path = metadata.path;
+		this.src = metadata.src;
+		const manifestPath = join(this.path, "manifest.json");
+		this.manifest = JSON.parse(fs.readFileSync(manifestPath, "utf-8"));
+		this.loaded = true;
+		return this;
+	}
+	/**
+	* Generates a public key.
+	*
+	* BC BREAK `this.publicKey` is not stored anymore (since 1.0.0)
+	* BC BREAK callback parameter has been removed in favor to the promise interface.
+	*
+	* @returns Resolves to {Buffer} containing the public key
+	* @example
+	*
+	* crx.generatePublicKey(function(publicKey){
+	*   // do something with publicKey
+	* });
+	*/
+	async generatePublicKey() {
+		const privateKey = this.privateKey;
+		if (!privateKey) throw new Error("Impossible to generate a public key: privateKey option has not been defined or is empty.");
+		return crypto.createPublicKey(privateKey).export({
+			type: "spki",
+			format: "der"
+		});
+	}
+	/**
+	* BC BREAK `this.contents` is not stored anymore (since 1.0.0)
+	*/
+	loadContents() {
+		return new Promise((resolve$1, reject) => {
+			const archive = archiver("zip", { zlib: { level: 9 } });
+			let contents = Buffer.from("");
+			if (!this.loaded) throw new Error("crx.load needs to be called first in order to prepare the workspace.");
+			archive.on("error", reject);
+			archive.on("data", (buf) => {
+				contents = Buffer.concat([contents, buf]);
+			});
+			archive.on("finish", () => {
+				resolve$1(contents);
+			});
+			archive.glob(this.src, {
+				cwd: this.path,
+				matchBase: true,
+				ignore: [
+					"*.pem",
+					".git",
+					...this.ignore
+				]
+			}).finalize();
+		});
+	}
+	/**
+	* Generates an appId from the publicKey.
+	* Public key has to be set for this to work, otherwise an error is thrown.
+	*
+	* BC BREAK `this.appId` is not stored anymore (since 1.0.0)
+	* BC BREAK introduced `publicKey` parameter as it is not stored any more since 2.0.0
+	*
+	* @param keyOrPath the public key to use to generate the app ID
+	*/
+	generateAppId(keyOrPath) {
+		keyOrPath = keyOrPath || this.publicKey;
+		if (typeof keyOrPath !== "string" && !(keyOrPath instanceof Buffer)) throw new Error("Public key is neither set, nor given");
+		if (typeof keyOrPath === "string") {
+			const charCode = keyOrPath.charCodeAt(0);
+			if (charCode >= 65 && charCode <= 122 && keyOrPath[1] === ":") {
+				keyOrPath = keyOrPath[0].toUpperCase() + keyOrPath.slice(1);
+				keyOrPath = Buffer.from(keyOrPath, "utf16le");
+			}
+		}
+		return crypto.createHash("sha256").update(keyOrPath).digest().toString("hex").split("").map((x) => (parseInt(x, 16) + 10).toString(26)).join("").slice(0, 32);
+	}
+	/**
+	* Generates an updateXML file from the extension content.
+	*
+	* If manifest does not include `minimum_chrome_version`, defaults to:
+	* - '29.0.0' for CRX2, which is earliest extensions API available
+	* - '64.0.3242' for CRX3, which is when Chrome etension packager switched to CRX3
+	*
+	* BC BREAK `this.updateXML` is not stored anymore (since 1.0.0)
+	*
+	* [Chrome Extensions APIs]{@link https://developer.chrome.com/extensions/api_index}
+	* [Chrome verions]{@link https://en.wikipedia.org/wiki/Google_Chrome_version_history}
+	* [Chromium switches to CRX3]{@link https://chromium.googlesource.com/chromium/src.git/+/b8bc9f99ef4ad6223dfdcafd924051561c05ac75}
+	*/
+	generateUpdateXML() {
+		if (!this.codebase) throw new Error("No URL provided for update.xml.");
+		if (!this.loaded) throw new Error("crx.load needs to be called first in order to generate update.xml.");
+		const browserVersion = this.manifest.minimum_chrome_version || (this.version < 3 ? "29.0.0" : void 0) || "64.0.3242";
+		return Buffer.from(`<?xml version='1.0' encoding='UTF-8'?>
+<gupdate xmlns='http://www.google.com/update2/response' protocol='2.0'>
+  <app appid='${this.appId || this.generateAppId()}'>
+    <updatecheck codebase='${this.codebase}' version='${this.manifest.version}' prodversionmin='${browserVersion}' />
+  </app>
+</gupdate>`);
+	}
+};
+
+//#endregion
+export { CrxVersion, ChromeExtension as default, ChromeExtension as "module.exports" };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["crx2","crx3","path"],"sources":["../src/index.ts"],"sourcesContent":["\"use strict\";\n\nimport fs from \"node:fs\";\nimport { join } from \"node:path\";\nimport crypto from \"node:crypto\";\nimport archiver from \"archiver\";\nimport resolve from \"./resolver.ts\";\nimport crx2 from \"./crx2.ts\";\nimport crx3 from \"./crx3.ts\";\n\n/** @enum {number} CrxVersion */\nexport const CrxVersion = {\n  VERSION_2: 2,\n  VERSION_3: 3,\n} as const;\n\ninterface BrowserManifest {\n  minimum_chrome_version?: string;\n  version: string;\n}\n\ntype BrowserExtensionOptions = {\n  // eslint-disable-next-line @typescript-eslint/no-unsafe-function-type\n  [K in keyof Omit<ChromeExtension, \"loaded\"> as ChromeExtension[K] extends Function ? never : K]?: ChromeExtension[K];\n};\n\nclass ChromeExtension {\n  appId?: string;\n  rootDirectory: string = \"\";\n  publicKey?: Buffer;\n  privateKey?: crypto.KeyLike;\n  codebase?: string;\n  path?: string;\n  src: string = \"**\";\n  ignore: string[] = [\"*.crx\"];\n  version: number = CrxVersion.VERSION_3;\n  loaded: boolean;\n  manifest?: BrowserManifest;\n\n  constructor(attrs: BrowserExtensionOptions) {\n    Object.assign(this, attrs);\n    this.loaded = false;\n  }\n\n  /**\n   * Packs the content of the extension in a crx file.\n   *\n   * @example\n   *\n   * crx.pack().then(function(crxContent){\n   *  // do something with the crxContent binary data\n   * });\n   *\n   */\n  async pack(contentsBuffer?: Buffer): Promise<Buffer> {\n    if (!this.loaded) {\n      return this.load().then(this.pack.bind(this, contentsBuffer));\n    }\n\n    const publicKey = await this.generatePublicKey();\n    const contents = contentsBuffer || await this.loadContents();\n\n    this.publicKey = publicKey;\n\n    if (this.version === 2) {\n      return crx2(this.privateKey!, publicKey, contents);\n    }\n\n    return crx3(this.privateKey!, publicKey, contents);\n  }\n\n  /**\n   * Loads extension manifest and copies its content to a workable path.\n   */\n  async load(path?: string | string[]): Promise<ChromeExtension> {\n    const metadata = await resolve(path || this.rootDirectory);\n    this.path = metadata.path;\n    this.src = metadata.src;\n\n    const manifestPath = join(this.path, \"manifest.json\");\n\n    this.manifest = JSON.parse(fs.readFileSync(manifestPath, \"utf-8\")) as BrowserManifest;\n    this.loaded = true;\n\n    return this;\n  }\n\n  /**\n   * Generates a public key.\n   *\n   * BC BREAK `this.publicKey` is not stored anymore (since 1.0.0)\n   * BC BREAK callback parameter has been removed in favor to the promise interface.\n   *\n   * @returns Resolves to {Buffer} containing the public key\n   * @example\n   *\n   * crx.generatePublicKey(function(publicKey){\n   *   // do something with publicKey\n   * });\n   */\n  // eslint-disable-next-line @typescript-eslint/require-await\n  async generatePublicKey(): Promise<Buffer> {\n    const privateKey = this.privateKey;\n\n    if (!privateKey) {\n      throw new Error(\"Impossible to generate a public key: privateKey option has not been defined or is empty.\");\n    }\n\n    const key = crypto.createPublicKey(privateKey);\n\n    return key.export({ type: \"spki\", format: \"der\" });\n  }\n\n  /**\n   * BC BREAK `this.contents` is not stored anymore (since 1.0.0)\n   */\n  loadContents(): Promise<Buffer> {\n    return new Promise((resolve, reject) => {\n      const archive = archiver(\"zip\", { zlib: { level: 9 } });\n      let contents = Buffer.from(\"\");\n\n      if (!this.loaded) {\n        throw new Error(\n          \"crx.load needs to be called first in order to prepare the workspace.\",\n        );\n      }\n\n      archive.on(\"error\", reject);\n\n      /*\n        TODO: Remove in v4.\n        It will be better to resolve an archive object\n        rather than fitting everything in memory.\n\n        @see https://github.com/oncletom/crx/issues/61\n      */\n      archive.on(\"data\", (buf) => {\n        contents = Buffer.concat([contents, buf]);\n      });\n\n      archive.on(\"finish\", () => {\n        resolve(contents);\n      });\n\n      void archive\n        .glob(this.src, {\n          cwd: this.path,\n          matchBase: true,\n          ignore: [\"*.pem\", \".git\", ...this.ignore],\n        })\n        .finalize();\n    });\n  }\n\n  /**\n   * Generates an appId from the publicKey.\n   * Public key has to be set for this to work, otherwise an error is thrown.\n   *\n   * BC BREAK `this.appId` is not stored anymore (since 1.0.0)\n   * BC BREAK introduced `publicKey` parameter as it is not stored any more since 2.0.0\n   *\n   * @param keyOrPath the public key to use to generate the app ID\n   */\n  generateAppId(keyOrPath?: Buffer | string): string {\n    keyOrPath = keyOrPath || this.publicKey;\n\n    if (typeof keyOrPath !== \"string\" && !(keyOrPath instanceof Buffer)) {\n      throw new Error(\"Public key is neither set, nor given\");\n    }\n\n    // Handling Windows Path\n    // Possibly to be moved in a different method\n    if (typeof keyOrPath === \"string\") {\n      const charCode = keyOrPath.charCodeAt(0);\n\n      // 65 (A) < charCode < 122 (z)\n      if (charCode >= 65 && charCode <= 122 && keyOrPath[1] === \":\") {\n        keyOrPath = keyOrPath[0].toUpperCase() + keyOrPath.slice(1);\n\n        keyOrPath = Buffer.from(keyOrPath, \"utf16le\");\n      }\n    }\n\n    return crypto\n      .createHash(\"sha256\")\n      .update(keyOrPath)\n      .digest()\n      .toString(\"hex\")\n      .split(\"\")\n      .map((x) => (parseInt(x, 16) + 0x0a).toString(26))\n      .join(\"\")\n      .slice(0, 32);\n  }\n\n  /**\n   * Generates an updateXML file from the extension content.\n   *\n   * If manifest does not include `minimum_chrome_version`, defaults to:\n   * - '29.0.0' for CRX2, which is earliest extensions API available\n   * - '64.0.3242' for CRX3, which is when Chrome etension packager switched to CRX3\n   *\n   * BC BREAK `this.updateXML` is not stored anymore (since 1.0.0)\n   *\n   * [Chrome Extensions APIs]{@link https://developer.chrome.com/extensions/api_index}\n   * [Chrome verions]{@link https://en.wikipedia.org/wiki/Google_Chrome_version_history}\n   * [Chromium switches to CRX3]{@link https://chromium.googlesource.com/chromium/src.git/+/b8bc9f99ef4ad6223dfdcafd924051561c05ac75}\n   */\n  generateUpdateXML(): Buffer {\n    if (!this.codebase) {\n      throw new Error(\"No URL provided for update.xml.\");\n    }\n    if (!this.loaded) {\n      throw new Error(\n        \"crx.load needs to be called first in order to generate update.xml.\",\n      );\n    }\n\n    const browserVersion = this.manifest!.minimum_chrome_version\n      || (this.version < 3 ? \"29.0.0\" : undefined) // Earliest version with extensions API\n      || \"64.0.3242\"; // Chrome started generating CRX3 packages\n\n    return Buffer.from(`<?xml version='1.0' encoding='UTF-8'?>\n<gupdate xmlns='http://www.google.com/update2/response' protocol='2.0'>\n  <app appid='${this.appId || this.generateAppId()}'>\n    <updatecheck codebase='${this.codebase}' version='${this.manifest!.version}' prodversionmin='${browserVersion}' />\n  </app>\n</gupdate>`);\n  }\n}\n\nexport { ChromeExtension as default, ChromeExtension as \"module.exports\" };\n"],"mappings":";;;;;;;;;;AAWA,MAAa,aAAa;CACxB,WAAW;CACX,WAAW;CACZ;AAYD,IAAM,kBAAN,MAAsB;CACpB;CACA,gBAAwB;CACxB;CACA;CACA;CACA;CACA,MAAc;CACd,SAAmB,CAAC,QAAQ;CAC5B,UAAkB,WAAW;CAC7B;CACA;CAEA,YAAY,OAAgC;AAC1C,SAAO,OAAO,MAAM,MAAM;AAC1B,OAAK,SAAS;;;;;;;;;;;;CAahB,MAAM,KAAK,gBAA0C;AACnD,MAAI,CAAC,KAAK,OACR,QAAO,KAAK,MAAM,CAAC,KAAK,KAAK,KAAK,KAAK,MAAM,eAAe,CAAC;EAG/D,MAAM,YAAY,MAAM,KAAK,mBAAmB;EAChD,MAAM,WAAW,kBAAkB,MAAM,KAAK,cAAc;AAE5D,OAAK,YAAY;AAEjB,MAAI,KAAK,YAAY,EACnB,QAAOA,gBAAK,KAAK,YAAa,WAAW,SAAS;AAGpD,SAAOC,kBAAK,KAAK,YAAa,WAAW,SAAS;;;;;CAMpD,MAAM,KAAK,QAAoD;EAC7D,MAAM,WAAW,MAAM,QAAQC,UAAQ,KAAK,cAAc;AAC1D,OAAK,OAAO,SAAS;AACrB,OAAK,MAAM,SAAS;EAEpB,MAAM,eAAe,KAAK,KAAK,MAAM,gBAAgB;AAErD,OAAK,WAAW,KAAK,MAAM,GAAG,aAAa,cAAc,QAAQ,CAAC;AAClE,OAAK,SAAS;AAEd,SAAO;;;;;;;;;;;;;;;CAiBT,MAAM,oBAAqC;EACzC,MAAM,aAAa,KAAK;AAExB,MAAI,CAAC,WACH,OAAM,IAAI,MAAM,2FAA2F;AAK7G,SAFY,OAAO,gBAAgB,WAAW,CAEnC,OAAO;GAAE,MAAM;GAAQ,QAAQ;GAAO,CAAC;;;;;CAMpD,eAAgC;AAC9B,SAAO,IAAI,SAAS,WAAS,WAAW;GACtC,MAAM,UAAU,SAAS,OAAO,EAAE,MAAM,EAAE,OAAO,GAAG,EAAE,CAAC;GACvD,IAAI,WAAW,OAAO,KAAK,GAAG;AAE9B,OAAI,CAAC,KAAK,OACR,OAAM,IAAI,MACR,uEACD;AAGH,WAAQ,GAAG,SAAS,OAAO;AAS3B,WAAQ,GAAG,SAAS,QAAQ;AAC1B,eAAW,OAAO,OAAO,CAAC,UAAU,IAAI,CAAC;KACzC;AAEF,WAAQ,GAAG,gBAAgB;AACzB,cAAQ,SAAS;KACjB;AAEF,GAAK,QACF,KAAK,KAAK,KAAK;IACd,KAAK,KAAK;IACV,WAAW;IACX,QAAQ;KAAC;KAAS;KAAQ,GAAG,KAAK;KAAO;IAC1C,CAAC,CACD,UAAU;IACb;;;;;;;;;;;CAYJ,cAAc,WAAqC;AACjD,cAAY,aAAa,KAAK;AAE9B,MAAI,OAAO,cAAc,YAAY,EAAE,qBAAqB,QAC1D,OAAM,IAAI,MAAM,uCAAuC;AAKzD,MAAI,OAAO,cAAc,UAAU;GACjC,MAAM,WAAW,UAAU,WAAW,EAAE;AAGxC,OAAI,YAAY,MAAM,YAAY,OAAO,UAAU,OAAO,KAAK;AAC7D,gBAAY,UAAU,GAAG,aAAa,GAAG,UAAU,MAAM,EAAE;AAE3D,gBAAY,OAAO,KAAK,WAAW,UAAU;;;AAIjD,SAAO,OACJ,WAAW,SAAS,CACpB,OAAO,UAAU,CACjB,QAAQ,CACR,SAAS,MAAM,CACf,MAAM,GAAG,CACT,KAAK,OAAO,SAAS,GAAG,GAAG,GAAG,IAAM,SAAS,GAAG,CAAC,CACjD,KAAK,GAAG,CACR,MAAM,GAAG,GAAG;;;;;;;;;;;;;;;CAgBjB,oBAA4B;AAC1B,MAAI,CAAC,KAAK,SACR,OAAM,IAAI,MAAM,kCAAkC;AAEpD,MAAI,CAAC,KAAK,OACR,OAAM,IAAI,MACR,qEACD;EAGH,MAAM,iBAAiB,KAAK,SAAU,2BAChC,KAAK,UAAU,IAAI,WAAW,WAC/B;AAEL,SAAO,OAAO,KAAK;;gBAEP,KAAK,SAAS,KAAK,eAAe,CAAC;6BACtB,KAAK,SAAS,aAAa,KAAK,SAAU,QAAQ,oBAAoB,eAAe;;YAEtG"}

package/dist/package.js

@@ -0,0 +1,6 @@
+//#region package.json
+var version = "5.0.1";
+
+//#endregion
+export { version };
+//# sourceMappingURL=package.js.map

package/dist/package.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.js","names":[],"sources":["../package.json"],"sourcesContent":["{\n  \"author\": \"Jed Schmidt <tr@nslator.jp> (http://jed.is)\",\n  \"name\": \"crx\",\n  \"description\": \"crx is a utility to package Google Chrome extensions via a Node API and the command line\",\n  \"version\": \"5.0.1\",\n  \"license\": \"MIT\",\n  \"homepage\": \"https://github.com/oncletom/crx\",\n  \"repository\": {\n    \"type\": \"git\",\n    \"url\": \"git://github.com/oncletom/crx.git\"\n  },\n  \"type\": \"module\",\n  \"main\": \"./dist/index.js\",\n  \"types\": \"./dist/index.d.ts\",\n  \"exports\": {\n    \"require\": {\n      \"types\": \"./dist/index.d.ts\",\n      \"default\": \"./dist/index.js\"\n    },\n    \"import\": {\n      \"types\": \"./dist/index.d.ts\",\n      \"default\": \"./dist/index.js\"\n    }\n  },\n  \"bin\": {\n    \"crx\": \"./dist/cli.js\"\n  },\n  \"engines\": {\n    \"node\": \">=18.20\",\n    \"pnpm\": \">=10.16\"\n  },\n  \"scripts\": {\n    \"build\": \"tsdown\",\n    \"typecheck\": \"tsc\",\n    \"lint\": \"eslint .\",\n    \"format\": \"eslint --fix .\",\n    \"test\": \"node --experimental-test-coverage --test-coverage-exclude=src/crx3.pb.js --test ./test/index.test.ts\"\n  },\n  \"dependencies\": {\n    \"archiver\": \"^7.0.1\",\n    \"commander\": \"^14.0.2\",\n    \"pbf\": \"^4.0.1\"\n  },\n  \"devEngines\": {\n    \"runtime\": {\n      \"name\": \"node\",\n      \"version\": \"^24.11\",\n      \"onFail\": \"download\"\n    }\n  },\n  \"devDependencies\": {\n    \"@eslint/js\": \"^9.38.0\",\n    \"@stylistic/eslint-plugin\": \"^5.5.0\",\n    \"@types/adm-zip\": \"^0.5.7\",\n    \"@types/archiver\": \"^7.0.0\",\n    \"@types/node\": \"^24.10.1\",\n    \"adm-zip\": \"^0.4.13\",\n    \"eslint\": \"^9.38.0\",\n    \"globals\": \"^16.4.0\",\n    \"tsdown\": \"^0.16.5\",\n    \"typescript\": \"^5.9.3\",\n    \"typescript-eslint\": \"^8.55.0\"\n  }\n}\n"],"mappings":";cAIa"}

package/dist/resolver.js

@@ -0,0 +1,41 @@
+import path from "node:path";
+
+//#region src/resolver.ts
+function resolve(pathOrFiles) {
+	return new Promise((resolve$1, reject) => {
+		if (typeof pathOrFiles === "string") {
+			resolve$1({
+				path: path.resolve(pathOrFiles),
+				src: "**"
+			});
+			return;
+		} else if (Array.isArray(pathOrFiles)) {
+			let manifestFile = "";
+			pathOrFiles.some((f) => {
+				if (/(^|\/)manifest.json$/.test(f)) {
+					manifestFile = f;
+					return true;
+				}
+			});
+			if (!manifestFile) {
+				reject(/* @__PURE__ */ new Error("Unable to locate a manifest file in your list of files."));
+				return;
+			}
+			const manifestDir = path.dirname(manifestFile);
+			resolve$1({
+				path: path.resolve(manifestDir),
+				src: `{${pathOrFiles.map((f) => {
+					return path.relative(manifestDir, f);
+				}).join(",")}}`
+			});
+			return;
+		} else {
+			reject(/* @__PURE__ */ new Error("load path is none of a folder location nor a list of files to pack"));
+			return;
+		}
+	});
+}
+
+//#endregion
+export { resolve as default };
+//# sourceMappingURL=resolver.js.map

package/dist/resolver.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolver.js","names":["resolve"],"sources":["../src/resolver.ts"],"sourcesContent":["\"use strict\";\n\nimport path from \"node:path\";\n\ninterface PathMetadata {\n  path: string;\n  src: string;\n}\n\nexport default function resolve(pathOrFiles: string | string[]): Promise<PathMetadata> {\n  return new Promise((resolve, reject) => {\n    // legacy and original mode\n    if (typeof pathOrFiles === \"string\") {\n      return void resolve({\n        path: path.resolve(pathOrFiles),\n        src: \"**\",\n      });\n    }\n\n    // new mode, with a list of files\n    else if (Array.isArray(pathOrFiles)) {\n      let manifestFile = \"\";\n\n      pathOrFiles.some((f) => {\n        if (/(^|\\/)manifest.json$/.test(f)) {\n          manifestFile = f;\n          return true;\n        }\n      });\n\n      if (!manifestFile) {\n        return void reject(\n          new Error(\"Unable to locate a manifest file in your list of files.\"),\n        );\n      }\n\n      const manifestDir = path.dirname(manifestFile);\n\n      return void resolve({\n        path: path.resolve(manifestDir),\n        src: `{${\n          pathOrFiles\n            .map((f) => {\n              return path.relative(manifestDir, f);\n            })\n            .join(\",\")\n        }}`,\n      });\n    }\n\n    //\n    else {\n      return void reject(\n        new Error(\n          \"load path is none of a folder location nor a list of files to pack\",\n        ),\n      );\n    }\n  });\n};\n"],"mappings":";;;AASA,SAAwB,QAAQ,aAAuD;AACrF,QAAO,IAAI,SAAS,WAAS,WAAW;AAEtC,MAAI,OAAO,gBAAgB,UAAU;AAC5B,GAAKA,UAAQ;IAClB,MAAM,KAAK,QAAQ,YAAY;IAC/B,KAAK;IACN,CAAC;AAHF;aAOO,MAAM,QAAQ,YAAY,EAAE;GACnC,IAAI,eAAe;AAEnB,eAAY,MAAM,MAAM;AACtB,QAAI,uBAAuB,KAAK,EAAE,EAAE;AAClC,oBAAe;AACf,YAAO;;KAET;AAEF,OAAI,CAAC,cAAc;AACV,IAAK,uBACV,IAAI,MAAM,0DAA0D,CACrE;AAFD;;GAKF,MAAM,cAAc,KAAK,QAAQ,aAAa;AAEvC,GAAKA,UAAQ;IAClB,MAAM,KAAK,QAAQ,YAAY;IAC/B,KAAK,IACH,YACG,KAAK,MAAM;AACV,YAAO,KAAK,SAAS,aAAa,EAAE;MACpC,CACD,KAAK,IAAI,CACb;IACF,CAAC;AATF;SAaG;AACI,GAAK,uBACV,IAAI,MACF,qEACD,CACF;AAJD;;GAMF"}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "author": "Hibi_10000",
+  "name": "@hibi_10000/crx",
+  "description": "crx is a utility to package Google Chrome extensions via a Node API and the command line",
+  "version": "0.5.1",
+  "license": "MIT",
+  "contributors": [
+    "Jed Schmidt <tr@nslator.jp> (http://jed.is)"
+  ],
+  "homepage": "https://github.com/Hibi-10000/crx",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/Hibi-10000/crx.git"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "require": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "import": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "bin": {
+    "crx": "dist/cli.js"
+  },
+  "engines": {
+    "node": "^18.20 || >=20.10"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "typecheck": "tsc",
+    "lint": "eslint .",
+    "format": "eslint --fix .",
+    "test": "node --experimental-test-coverage --test-coverage-exclude=src/crx3.pb.js --test ./test/index.test.ts"
+  },
+  "dependencies": {
+    "archiver": "^7.0.1",
+    "commander": "^14.0.2",
+    "pbf": "^4.0.1"
+  },
+  "devEngines": {
+    "runtime": {
+      "name": "node",
+      "version": "^24.11",
+      "onFail": "download"
+    },
+    "packageManager": {
+      "name": "pnpm",
+      "version": ">=10.16",
+      "onFail": "warn"
+    }
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.38.0",
+    "@stylistic/eslint-plugin": "^5.5.0",
+    "@types/adm-zip": "^0.5.7",
+    "@types/archiver": "^7.0.0",
+    "@types/node": "^24.10.1",
+    "adm-zip": "^0.4.13",
+    "eslint": "^9.38.0",
+    "globals": "^16.4.0",
+    "tsdown": "^0.16.5",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.55.0"
+  }
+}

package/src/cli.ts

@@ -0,0 +1,175 @@
+#!/usr/bin/env node
+
+import path from "node:path";
+import fs from "node:fs";
+import crypto from "node:crypto";
+
+import { program } from "commander";
+import ChromeExtension from "./index.ts";
+
+import packageJson from "../package.json" with { type: "json" };
+
+const cwd = process.cwd();
+
+program.version(packageJson.version);
+// coming soon
+// .option("-x, --xml", "output autoupdate xml instead of extension ")
+
+interface InterfaceCli {
+  crxVersion?: number;
+  force: boolean;
+  privateKey: string;
+  output?: string;
+  zipOutput?: string;
+  //maxBuffer?: number;
+}
+
+program
+  .command("keygen [directory]")
+  .option("--force", "overwrite the private key if it exists")
+  .option(
+    "-c, --crx-version [number]",
+    "CRX format version, can be either 2 or 3, defaults to 3",
+    parseInt,
+  )
+  .description("generate a private key in [directory]/key.pem")
+  .action(keygen);
+
+program
+  .command("pack [directory]")
+  .description("pack [directory] into a .crx extension")
+  .option(
+    "-o, --output <file>",
+    "write the crx content to <file> instead of stdout",
+  )
+  .option("--zip-output <file>", "write the zip content to <file>")
+  .option(
+    "-p, --private-key <file>",
+    "relative path to private key [key.pem], defaults to [directory/../key.pem]")
+  //.option(
+  //  "-b, --max-buffer <total>",
+  //  "max amount of memory allowed to generate the crx, in byte",
+  //)
+  .option(
+    "-c, --crx-version [number]",
+    "CRX format version, can be either 2 or 3, defaults to 3",
+    parseInt,
+  )
+  .action(pack);
+
+program.parse(process.argv);
+
+/**
+ * Generate a new key file
+ * @param keyPath path of the key file to create
+ * @param opts
+ */
+function generateKeyFile(keyPath: string, opts: InterfaceCli): Promise<void> {
+  const { privateKey } = crypto.generateKeyPairSync("rsa", {
+    modulusLength: 2048,
+    publicKeyEncoding: {
+      type: "spki",
+      format: "der",
+    },
+    privateKeyEncoding: {
+      // Chromium (tested on 72.0.3626.109) which generates CRX v3 files requires pkcs8 key
+      type: `pkcs${opts.crxVersion === 2 ? "1" : "8"}`,
+      format: "pem",
+    },
+  });
+  return fs.promises.writeFile(keyPath, privateKey);
+}
+
+/**
+ * Generates a Private Key
+ */
+async function keygen(dir: string, opts: InterfaceCli) {
+  dir = dir ? path.resolve(cwd, dir) : cwd;
+
+  const keyPath = path.join(dir, "key.pem");
+
+  try {
+    fs.accessSync(keyPath);
+    if (!opts.force) {
+      throw new Error("key.pem already exists in the given location.");
+    }
+  }
+  catch (_err) {
+    await generateKeyFile(keyPath, opts);
+  }
+}
+
+async function pack(dir: string, opts: InterfaceCli) {
+  const input = dir ? path.resolve(cwd, dir) : cwd;
+  const keyPath = opts.privateKey
+    ? path.resolve(cwd, opts.privateKey)
+    : path.join(input, "..", "key.pem");
+  let output: string;
+
+  if (opts.output) {
+    if (path.extname(opts.output) !== ".crx") {
+      throw new Error(
+        `-o file is expected to have a \`.crx\` suffix: [${opts.output}] was given.`,
+      );
+    }
+  }
+
+  if (opts.zipOutput) {
+    if (path.extname(opts.zipOutput) !== ".zip") {
+      throw new Error(
+        `--zip-output file is expected to have a \`.zip\` suffix: [${opts.zipOutput}] was given.`,
+      );
+    }
+  }
+
+  const crx = new ChromeExtension({
+    rootDirectory: input,
+    //maxBuffer: opts.maxBuffer,
+    version: opts.crxVersion || 3,
+  });
+
+  await fs.promises.readFile(keyPath)
+    .then(null, async (err: unknown) => {
+      // If the key file doesn't exist, create one
+      if ((err as NodeJS.ErrnoException).code === "ENOENT") {
+        await generateKeyFile(keyPath, opts);
+        process.stderr.write(`Created new private key at: ${keyPath}.\n`);
+        return fs.readFileSync(keyPath);
+      }
+      else {
+        throw err;
+      }
+    })
+    .then(async (key) => {
+      crx.privateKey = key;
+      await crx.load();
+      const fileBuffer = await crx.loadContents();
+      if (opts.zipOutput) {
+        const outFile = path.resolve(cwd, opts.zipOutput);
+
+        fs.createWriteStream(outFile).end(fileBuffer);
+      }
+      else {
+        const crxBuffer = await crx.pack(fileBuffer);
+        if (opts.zipOutput) {
+          return;
+        }
+        else if (opts.output) {
+          output = opts.output;
+        }
+        else {
+          output = `${path.basename(cwd)}.crx`;
+        }
+
+        const outFile = path.resolve(cwd, output);
+        if (outFile) {
+          fs.createWriteStream(outFile).end(crxBuffer);
+        }
+        else {
+          process.stdout.end(crxBuffer);
+        }
+      }
+    });
+}
+
+export default program;

package/src/crx2.ts

@@ -0,0 +1,43 @@
+"use strict";
+
+import crypto from "node:crypto";
+
+/**
+ * Generates and returns a signed package from extension content.
+ *
+ * BC BREAK `this.package` is not stored anymore (since 1.0.0)
+ */
+export default function generatePackage(privateKey: crypto.KeyLike, publicKey: Buffer, contents: Buffer): Buffer {
+  const signature = generateSignature(privateKey, contents);
+
+  const keyLength = publicKey.length;
+  const sigLength = signature.length;
+  const zipLength = contents.length;
+  const length = 16 + keyLength + sigLength + zipLength;
+
+  const crx = Buffer.alloc(length);
+
+  crx.write("Cr24" + new Array(13).join("\x00"), "binary");
+
+  crx[4] = 2;
+  crx.writeUInt32LE(keyLength, 8);
+  crx.writeUInt32LE(sigLength, 12);
+
+  publicKey.copy(crx, 16);
+  signature.copy(crx, 16 + keyLength);
+  contents.copy(crx, 16 + keyLength + sigLength);
+
+  return crx;
+};
+
+/**
+ * Generates a SHA1 package signature.
+ *
+ * BC BREAK `this.signature` is not stored anymore (since 1.0.0)
+ */
+function generateSignature(privateKey: crypto.KeyLike, contents: Buffer): Buffer {
+  return crypto
+    .createSign("sha1")
+    .update(contents)
+    .sign(privateKey);
+}

package/src/crx3.pb.d.ts

@@ -0,0 +1,22 @@
+import type Pbf from "pbf";
+
+interface CrxFileHeader {
+  sha256_with_rsa?: AsymmetricKeyProof[];
+  sha256_with_ecdsa?: AsymmetricKeyProof[];
+  signed_header_data?: Uint8Array;
+}
+export function readCrxFileHeader(pbf: Pbf, end?: number): CrxFileHeader;
+export function writeCrxFileHeader(obj: CrxFileHeader, pbf: Pbf): void;
+
+interface AsymmetricKeyProof {
+  public_key?: Uint8Array;
+  signature?: Uint8Array;
+}
+export function readAsymmetricKeyProof(pbf: Pbf, end?: number): AsymmetricKeyProof;
+export function writeAsymmetricKeyProof(obj: AsymmetricKeyProof, pbf: Pbf): void;
+
+interface SignedData {
+  crx_id?: Uint8Array;
+}
+export function readSignedData(pbf: Pbf, end?: number): SignedData;
+export function writeSignedData(obj: SignedData, pbf: Pbf): void;

package/src/crx3.pb.js

@@ -0,0 +1,37 @@
+// code generated by pbf v4.0.1 from https://github.com/chromium/chromium/blob/e4a3bada6aab7aed90460ec7d27f8c7167c5666e/components/crx_file/crx3.proto
+
+export function readCrxFileHeader(pbf, end) {
+    return pbf.readFields(readCrxFileHeaderField, {sha256_with_rsa: [], sha256_with_ecdsa: [], signed_header_data: undefined}, end);
+}
+function readCrxFileHeaderField(tag, obj, pbf) {
+    if (tag === 2) obj.sha256_with_rsa.push(readAsymmetricKeyProof(pbf, pbf.readVarint() + pbf.pos));
+    else if (tag === 3) obj.sha256_with_ecdsa.push(readAsymmetricKeyProof(pbf, pbf.readVarint() + pbf.pos));
+    else if (tag === 10000) obj.signed_header_data = pbf.readBytes();
+}
+export function writeCrxFileHeader(obj, pbf) {
+    if (obj.sha256_with_rsa) for (const item of obj.sha256_with_rsa) pbf.writeMessage(2, writeAsymmetricKeyProof, item);
+    if (obj.sha256_with_ecdsa) for (const item of obj.sha256_with_ecdsa) pbf.writeMessage(3, writeAsymmetricKeyProof, item);
+    if (obj.signed_header_data != null) pbf.writeBytesField(10000, obj.signed_header_data);
+}
+
+export function readAsymmetricKeyProof(pbf, end) {
+    return pbf.readFields(readAsymmetricKeyProofField, {public_key: undefined, signature: undefined}, end);
+}
+function readAsymmetricKeyProofField(tag, obj, pbf) {
+    if (tag === 1) obj.public_key = pbf.readBytes();
+    else if (tag === 2) obj.signature = pbf.readBytes();
+}
+export function writeAsymmetricKeyProof(obj, pbf) {
+    if (obj.public_key != null) pbf.writeBytesField(1, obj.public_key);
+    if (obj.signature != null) pbf.writeBytesField(2, obj.signature);
+}
+
+export function readSignedData(pbf, end) {
+    return pbf.readFields(readSignedDataField, {crx_id: undefined}, end);
+}
+function readSignedDataField(tag, obj, pbf) {
+    if (tag === 1) obj.crx_id = pbf.readBytes();
+}
+export function writeSignedData(obj, pbf) {
+    if (obj.crx_id != null) pbf.writeBytesField(1, obj.crx_id);
+}