@kernocal/validate-store 0.1.1

package/README.md

@@ -0,0 +1,43 @@
+# wxt-validate-store
+
+WXT module for validating Chrome Web Store and Edge Add-ons store listing data before publishing.
+
+## Features
+
+- Validates image assets (screenshots, promo tiles, icons) exist and have correct dimensions
+- Validates Chrome permission justifications match manifest permissions
+- Validates Edge search term limits (count, word count, character length)
+- Generates a `details.txt` export with all store listing data to copy/paste easier
+
+## Usage
+
+Install the package:
+
+```sh
+pnpm i -D @kernocal/wxt-validate-store
+```
+
+Add the module to `wxt.config.ts`:
+
+```ts
+export default defineConfig({
+  modules: ['@kernocal/wxt-validate-store'],
+});
+```
+
+## Configuration
+
+```ts
+export default defineConfig({
+  modules: ['@kernocal/wxt-validate-store'],
+  validateStore: {
+    enabled: true,
+    storeDataSrc: './store/storeData',
+    storeExportsDir: './store/exports',
+  },
+});
+```
+
+## Store Data
+
+Your `storeData` module should export a `storeData` object conforming to the `StoreDetails` type. See the exported types for the full schema.

package/dist/index-CFiWzfYo.d.ts

@@ -0,0 +1,71 @@
+import * as wxt0 from "wxt";
+
+//#region src/types.d.ts
+type ChromeCategory = 'Communication' | 'Developer Tools' | 'Education' | 'Tools' | 'Workflow & Planning' | 'Art & Design' | 'Entertainment' | 'Games' | 'Household' | 'Just for Fun' | 'News & Weather' | 'Shopping' | 'Social Networking' | 'Travel' | 'Well-being' | 'Accessibility' | 'Functionality & UI' | 'Privacy & Security';
+type EdgeCategory = 'Accessibility' | 'Blogging' | 'Communication' | 'Developer tools' | 'Entertainment' | 'News & weather' | 'Photos' | 'Productivity' | 'Search tools' | 'Shopping' | 'Social' | 'Sports';
+interface ImageAsset<W extends number = number, H extends number = number> {
+  path: string;
+  width: W;
+  height: H;
+}
+type Screenshot = ImageAsset<1280, 800> | ImageAsset<640, 400>;
+interface CommonDetails {
+  privacyPolicyUrl: string;
+  screenshots: [Screenshot, ...Screenshot[]];
+  smallPromoTile: ImageAsset<440, 280>;
+  largePromoTile: ImageAsset<1400, 560> | null;
+  promoVideoUrl: string | null;
+  websiteUrl: string;
+  matureContent: boolean;
+  locales: Record<string, {
+    description: string;
+  }>;
+}
+interface ChromeDetails {
+  category: ChromeCategory;
+  icon: ImageAsset<128, 128>;
+  officialUrl: string | null;
+  supportUrl: string;
+  singlePurpose: string;
+  permissionJustifications: Record<string, string>;
+  remoteCode: boolean;
+}
+interface EdgeDetails {
+  category: EdgeCategory;
+  icon: ImageAsset<300, 300>;
+  searchTerms: string[];
+  supportContact: string;
+  collectsPersonalData: boolean;
+}
+interface StoreDetails {
+  common: CommonDetails;
+  chrome: ChromeDetails;
+  edge: EdgeDetails;
+}
+//#endregion
+//#region src/index.d.ts
+declare const _default: wxt0.WxtModule<ValidateStoreOptions>;
+interface ValidateStoreOptions {
+  /**
+   * Enable publish validation
+   *
+   * @default true
+   */
+  enabled?: boolean;
+  /**
+   * Path to the store data module (without extension), resolved from root
+   *
+   * @default '<root>/store/storeData'
+   */
+  storeDataSrc?: string;
+  /**
+   * Directory for store exports (screenshots, icons, details.txt output)
+   *
+   * @default '<root>/store/exports'
+   */
+  storeExportsDir?: string;
+}
+sideEffect();
+
+//#endregion
+export { ChromeCategory, ChromeDetails, CommonDetails, EdgeCategory, EdgeDetails, ImageAsset, StoreDetails, type ValidateStoreOptions, _default as default };

package/dist/index.js

@@ -0,0 +1,128 @@
+import "wxt";
+import { defineWxtModule } from "wxt/modules";
+import { resolve } from "node:path";
+import { access, mkdir, writeFile } from "node:fs/promises";
+import defu from "defu";
+import sharp from "sharp";
+//#region src/util.ts
+const WHITESPACE_RE = /\s+/;
+async function validateImageAsset(asset, label, issues, srcDir) {
+	const fullPath = resolve(srcDir, asset.path);
+	try {
+		await access(fullPath);
+	} catch {
+		issues.push(`${label}: file not found — ${asset.path}`);
+		return;
+	}
+	if (!asset.path.endsWith(".png")) {
+		issues.push(`${label}: expected .png format — ${asset.path}`);
+		return;
+	}
+	const { width, height } = await sharp(fullPath).metadata();
+	if (width !== asset.width) issues.push(`${label}: expected width ${asset.width}, got ${width}`);
+	if (height !== asset.height) issues.push(`${label}: expected height ${asset.height}, got ${height}`);
+}
+async function validateChrome(chrome, manifestPermissions, issues, srcDir) {
+	await validateImageAsset(chrome.icon, "chrome.icon", issues, srcDir);
+	const justified = Object.keys(chrome.permissionJustifications);
+	for (const perm of manifestPermissions) if (!justified.includes(perm)) issues.push(`Permission "${perm}" in manifest but missing justification in storeData`);
+	for (const perm of justified) if (!manifestPermissions.includes(perm)) issues.push(`Justification for "${perm}" but not in manifest permissions`);
+}
+async function validateEdge(edge, issues, srcDir) {
+	await validateImageAsset(edge.icon, "edge.icon", issues, srcDir);
+	const { searchTerms } = edge;
+	const totalWords = searchTerms.reduce((sum, term) => sum + term.split(WHITESPACE_RE).length, 0);
+	if (totalWords > 21) issues.push(`Edge search terms: max 21 words total, got ${totalWords}`);
+	if (searchTerms.length > 7) issues.push(`Edge search terms: max 7 terms, got ${searchTerms.length}`);
+	for (const term of searchTerms) if (term.length > 30) issues.push(`Edge search term "${term}" exceeds 30 char limit (${term.length})`);
+}
+function buildDetailsText(data) {
+	return [
+		"=== Common ===",
+		"",
+		...Object.entries(data.common.locales || {}).flatMap(([locale, info]) => [
+			`Description (${locale}):`,
+			info.description,
+			""
+		]),
+		"Privacy Policy URL:",
+		data.common.privacyPolicyUrl,
+		"",
+		"Website URL:",
+		data.common.websiteUrl,
+		"",
+		"Mature Content:",
+		`${data.common.matureContent}`,
+		"",
+		"=== Chrome ===",
+		"",
+		"Category:",
+		data.chrome.category,
+		"",
+		"Official URL:",
+		data.chrome.officialUrl ?? "(none)",
+		"",
+		"Support URL:",
+		data.chrome.supportUrl,
+		"",
+		"Single Purpose:",
+		data.chrome.singlePurpose,
+		"",
+		"Remote Code:",
+		`${data.chrome.remoteCode}`,
+		"",
+		"Permission Justifications:",
+		...Object.entries(data.chrome.permissionJustifications).flatMap(([k, v]) => [
+			`  ${k}:`,
+			`  ${v}`,
+			""
+		]),
+		"",
+		"=== Edge ===",
+		"",
+		"Category:",
+		data.edge.category,
+		"",
+		"Search Terms:",
+		...data.edge.searchTerms,
+		"",
+		"Support Contact:",
+		data.edge.supportContact,
+		"",
+		"Collects Personal Data:",
+		`${data.edge.collectsPersonalData}`
+	].join("\n");
+}
+//#endregion
+//#region src/index.ts
+var src_default = defineWxtModule({
+	name: "validateStore",
+	configKey: "validateStore",
+	async setup(wxt, options) {
+		const parsedOptions = defu(options, {
+			enabled: true,
+			storeDataSrc: resolve(wxt.config.root, "store/storeData"),
+			storeExportsDir: resolve(wxt.config.root, "store/exports")
+		});
+		if (!parsedOptions.enabled) return wxt.logger.warn("`[validate-store]` module disabled");
+		const { storeData } = await import(parsedOptions.storeDataSrc);
+		wxt.hook("build:manifestGenerated", async (_wxt, manifest) => {
+			if (_wxt.config.mode === "development") return;
+			const issues = [];
+			const { root } = _wxt.config;
+			const { screenshots, largePromoTile, smallPromoTile } = storeData.common;
+			for (const [i, screenshot] of screenshots.entries()) await validateImageAsset(screenshot, `screenshots[${i}]`, issues, root);
+			if (screenshots.length > 5) issues.push(`Max 5 screenshots allowed, got ${screenshots.length}`);
+			await validateImageAsset(smallPromoTile, "smallPromoTile", issues, root);
+			if (largePromoTile) await validateImageAsset(largePromoTile, "largePromoTile", issues, root);
+			await validateChrome(storeData.chrome, manifest.permissions ?? [], issues, root);
+			await validateEdge(storeData.edge, issues, root);
+			if (issues.length > 0) for (const issue of issues) _wxt.logger.warn(`\`[validate-store]\` ${issue}`);
+			await mkdir(parsedOptions.storeExportsDir, { recursive: true });
+			await writeFile(resolve(parsedOptions.storeExportsDir, "details.txt"), buildDetailsText(storeData), "utf-8");
+			_wxt.logger.info("`[validate-store]` details.txt generated");
+		});
+	}
+});
+//#endregion
+export { src_default as default };

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@kernocal/validate-store",
+  "description": "WXT module for validating Chrome and Edge store listing data before publishing",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Kernocal/validate-store.git"
+  },
+  "homepage": "https://github.com/Kernocal/validate-store#readme",
+  "keywords": [
+    "wxt-module"
+  ],
+  "license": "MIT",
+  "version": "0.1.1",
+  "type": "module",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist"
+  ],
+  "peerDependencies": {
+    "wxt": ">=0.19.0"
+  },
+  "dependencies": {
+    "defu": "^6.1.4",
+    "sharp": "^0.34.5"
+  },
+  "devDependencies": {
+    "tsdown": "^0.12.4",
+    "typescript": "^5.9.3"
+  },
+  "scripts": {
+    "build": "tsdown"
+  }
+}