Improve consumer type checking and simplify test setup

.github/workflows/ci.yml

@@ -77,6 +77,9 @@ jobs:
       - name: Build
         run: npm run build
 
+      - name: Consumer typecheck
+        run: npm run test:consumer-types
+
       - name: Upload coverage artifact
         if: always()
         uses: actions/upload-artifact@v4

package.json

@@ -48,15 +48,19 @@
     "dist"
   ],
   "sideEffects": false,
+  "dependencies": {
+    "@types/chrome": "^0.2.2"
+  },
   "scripts": {
     "prepare": "husky",
-    "build": "tsup",
+    "build": "tsup && node ./scripts/copy-api-types.mjs",
     "prepublishOnly": "npm run build",
     "dev": "tsup --watch",
     "lint": "biome check .",
     "fix": "biome check --write --unsafe .",
     "test": "jest",
     "test:ci": "jest --ci --passWithNoTests --coverage",
+    "test:consumer-types": "npm run build && node ./tests/consumer-types/check.mjs",
     "test:related": "jest --bail --passWithNoTests",
     "typecheck": "tsc -p tsconfig.json --noEmit",
     "release": "release-it",
@@ -67,7 +71,6 @@
     "@commitlint/cli": "^20.0.0",
     "@commitlint/config-conventional": "^20.0.0",
     "@release-it/conventional-changelog": "^10.0.1",
-    "@types/chrome": "^0.1.36",
     "@types/jest": "^30.0.0",
     "husky": "^9.1.7",
     "jest": "^30.1.3",
@@ -76,9 +79,6 @@
     "tsup": "^8.5.0",
     "typescript": "^5.9.2"
   },
-  "peerDependencies": {
-    "@types/chrome": "*"
-  },
   "overrides": {
     "test-exclude": {
       "glob": "^9.3.5"

scripts/copy-api-types.mjs

@@ -0,0 +1,7 @@
+import {copyFileSync} from "node:fs";
+import {dirname, join} from "node:path";
+import {fileURLToPath} from "node:url";
+
+const rootDirectory = join(dirname(fileURLToPath(import.meta.url)), "..");
+
+copyFileSync(join(rootDirectory, "src/api.d.ts"), join(rootDirectory, "dist/api.d.ts"));

tests/consumer-types/check.mjs

@@ -0,0 +1,51 @@
+import assert from "node:assert/strict";
+import {execFileSync} from "node:child_process";
+import {cpSync, existsSync, mkdtempSync, readFileSync, rmSync, writeFileSync} from "node:fs";
+import {tmpdir} from "node:os";
+import {dirname, join} from "node:path";
+import {fileURLToPath} from "node:url";
+
+const fixtureDirectory = dirname(fileURLToPath(import.meta.url));
+const packageDirectory = join(fixtureDirectory, "../..");
+const temporaryDirectory = mkdtempSync(join(tmpdir(), "addon-core-browser-consumer-"));
+const npm = process.platform === "win32" ? "npm.cmd" : "npm";
+
+try {
+    const [{filename}] = JSON.parse(
+        execFileSync(npm, ["pack", "--ignore-scripts", "--json", "--pack-destination", temporaryDirectory], {
+            cwd: packageDirectory,
+            encoding: "utf8",
+        })
+    );
+    const archive = join(temporaryDirectory, filename);
+    const consumerDirectory = join(temporaryDirectory, "consumer");
+
+    cpSync(fixtureDirectory, consumerDirectory, {recursive: true});
+    writeFileSync(join(consumerDirectory, "package.json"), '{"private":true,"type":"module"}\n');
+    execFileSync(npm, ["install", "--ignore-scripts", "--no-package-lock", "--no-save", archive], {
+        cwd: consumerDirectory,
+        stdio: "inherit",
+    });
+
+    const installedPackageDirectory = join(consumerDirectory, "node_modules/@addon-core/browser");
+    const installedPackage = JSON.parse(readFileSync(join(installedPackageDirectory, "package.json"), "utf8"));
+
+    assert.equal(installedPackage.dependencies?.["@types/chrome"], "^0.2.2");
+    assert.equal(installedPackage.peerDependencies?.["@types/chrome"], undefined);
+    assert.equal(installedPackage.types, "dist/index.d.ts");
+
+    const declarations = readFileSync(join(installedPackageDirectory, installedPackage.types), "utf8");
+
+    assert.match(declarations, /^\/\/\/ <reference types="chrome" \/>/);
+    assert.equal(existsSync(join(consumerDirectory, "node_modules/@types/chrome")), true);
+
+    execFileSync(
+        process.execPath,
+        [join(packageDirectory, "node_modules/typescript/bin/tsc"), "--project", consumerDirectory],
+        {
+            stdio: "inherit",
+        }
+    );
+} finally {
+    rmSync(temporaryDirectory, {force: true, recursive: true});
+}

tests/consumer-types/index.ts

@@ -0,0 +1,11 @@
+import {onTabUpdated} from "@addon-core/browser";
+
+onTabUpdated((tabId, changeInfo, tab) => {
+    const id: number = tabId;
+    const info: chrome.tabs.OnUpdatedInfo = changeInfo;
+    const currentTab: chrome.tabs.Tab = tab;
+
+    void id;
+    void info;
+    void currentTab;
+});

tests/consumer-types/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "module": "NodeNext",
+    "moduleResolution": "NodeNext",
+    "noEmit": true,
+    "strict": true,
+    "target": "ESNext"
+  }
+}

tsup.config.ts

@@ -11,7 +11,9 @@ export default defineConfig([
     {
         ...common,
         format: ["esm"],
-        dts: true,
+        dts: {
+            banner: '/// <reference types="chrome" />\n/// <reference path="./api.d.ts" />',
+        },
         outExtension() {
             return {js: ".js"};
         },