@wxt-dev/browser 0.0.310-alpha1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Aaron
+
+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,58 @@
+# `@wxt-dev/browser`
+
+Provides access to the `browser` or `chrome` extension APIs and related types.
+
+```ts
+import { browser, Browser } from '@wxt-dev/browser';
+// Or if you're using WXT:
+// import { browser, Browser } from 'wxt/browser';
+
+console.log(browser.runtime.id);
+
+const onMessage = (message: any, sender: Browser.runtime.MessageSender) => {
+  console.log(message);
+};
+browser.runtime.onMessage.addListener(onMessage);
+```
+
+## Installation
+
+If you're using WXT, this package is already installed, you don't need to install it manually.
+
+Otherwise, you can install the package from NPM:
+
+```sh
+pnpm install @wxt-dev/browser
+```
+
+## Upgrading to Latest Types
+
+Just run:
+
+```sh
+pnpm upgrade @wxt-dev/browser
+```
+
+This should update both the manually installed version and the subdependency inside WXT.
+
+## Contributing
+
+### Code Generation
+
+Types are generated based on the `@types/chrome` package, and with modifications specifically for use with WXT.
+
+### Updating `@types/chrome` Version
+
+You don't need to do anything! A github action is ran every day to generate and publish this package using the latest `@types/chrome` version.
+
+You can manually generate types via:
+
+```sh
+pnpm gen
+```
+
+### Why not just use `@types/chrome`?
+
+With WXT, you must import the `browser` variable to use the extension APIs. The way `@types/chrome` is implemented forces you to define a global `chrome` variable. With WXT, this isn't acceptable, we don't want to pollute the global (type) scope or introduce conflicts with auto-imports.
+
+Additionally, WXT overrides types to provide additional type safety for some APIs, like `browser.runtime.getURL` and `browser.i18n.getMessage`. With `@types/chrome`'s nested namespace approach, it's not possible to override the types for those functions.

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@wxt-dev/browser",
+  "description": "Provides a cross-browser API for using extension APIs and types based on @types/chrome",
+  "version": "0.0.310-alpha1",
+  "type": "module",
+  "module": "src/index.mjs",
+  "types": "src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.mjs"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/wxt-dev/wxt.git",
+    "directory": "packages/browser"
+  },
+  "author": {
+    "name": "Aaron Klinker",
+    "email": "aaronklinker1+wxt@gmail.com"
+  },
+  "license": "MIT",
+  "files": [
+    "src"
+  ],
+  "devDependencies": {
+    "@aklinker1/check": "^1.4.5",
+    "@types/chrome": "0.0.310",
+    "fs-extra": "^11.2.0",
+    "nano-spawn": "^0.2.0",
+    "publint": "^0.2.12",
+    "tsx": "4.19.3",
+    "typescript": "^5.6.3",
+    "vitest": "^3.0.7"
+  },
+  "dependencies": {
+    "@types/filesystem": "*",
+    "@types/har-format": "*"
+  },
+  "peerDependencies": {},
+  "scripts": {
+    "gen": "tsx scripts/generate.ts",
+    "check": "check"
+  }
+}

package/src/__tests__/index.test.ts

@@ -0,0 +1,23 @@
+/// <reference types="chrome" />
+import { describe, expectTypeOf, it } from 'vitest';
+import { browser, Browser } from '../index';
+
+describe('browser', () => {
+  describe('types', () => {
+    it('should provide types via the Browser import', () => {
+      expectTypeOf<Browser.runtime.MessageSender>().toMatchTypeOf<chrome.runtime.MessageSender>();
+      expectTypeOf<Browser.storage.AreaName>().toMatchTypeOf<chrome.storage.AreaName>();
+      expectTypeOf<Browser.i18n.LanguageDetectionResult>().toMatchTypeOf<chrome.i18n.LanguageDetectionResult>();
+    });
+
+    it('should provide values via the browser import', () => {
+      expectTypeOf(browser.runtime.id).toMatchTypeOf<string>();
+      expectTypeOf(
+        browser.storage.local,
+      ).toMatchTypeOf<Browser.storage.StorageArea>();
+      expectTypeOf(
+        browser.i18n.detectLanguage('Hello, world!'),
+      ).resolves.toMatchTypeOf<chrome.i18n.LanguageDetectionResult>();
+    });
+  });
+});