Merge branch 'release/v0.2.0'

Author: addon-owner

README.md

@@ -68,7 +68,7 @@ Use the `options(opts: Partial<InjectCssOptions>)` method to merge or override o
 
 ## API
 
-### `injectCss(options: InjectCssUnionOptions): InjectCssContract`
+### `injectCss(options: InjectCssOptions): InjectCssContract`
 
 Creates a new CSS injector instance. Detects the manifest version (V2 or V3) via `@adnbn/browser` and delegates to the appropriate implementation.
 
@@ -82,12 +82,14 @@ Creates a new CSS injector instance. Detects the manifest version (V2 or V3) via
 
 The injector accepts the following options (passed to `injectCss(options)` and/or `injector.options(opts)`):
 
-- `tabId` (number, required): Target browser tab ID.
-- `frameId` (boolean | number | number[], optional): Select frames to inject into. `true` for all frames; a number or array of numbers for specific frame IDs.
-- `matchAboutBlank` (boolean, optional): (Manifest V2 only) Include `about:blank` and similar subframes. Defaults to `true`.
-- `runAt` (`'document_start'` | `'document_end'` | `'document_idle'`, optional): (Manifest V2 only) Injection timing, matching Chrome's `runAt` in `insertCSS`.
-- `documentId` (string | string[], optional): (Manifest V3 only) Document IDs for scripting targets.
-- `origin` (`'author'` | `'user'`, optional): CSS origin matching Chrome's API (`cssOrigin` in V2, `origin` in V3).
+| Option          | Type                                                  | Description                                                                                  |
+| --------------- | ----------------------------------------------------- | -------------------------------------------------------------------------------------------- |
+| tabId           | number                                                | Required. Target browser tab ID.                                                             |
+| frameId         | boolean \| number \| number[]                         | Optional. Select frames to inject into: `true` for all frames; number or array for specific. |
+| matchAboutBlank | boolean                                               | Optional. (V2 only) Include `about:blank` and similar subframes. Defaults to `true`.         |
+| runAt           | 'document_start' \| 'document_end' \| 'document_idle' | Optional. (V2 only) Injection timing, matches Chrome's `runAt` in `insertCSS`.               |
+| documentId      | string \| string[]                                    | Optional. (V3 only) Document IDs for scripting targets.                                      |
+| origin          | 'author' \| 'user'                                    | Optional. CSS origin matching Chrome's API (`cssOrigin` in V2, `origin` in V3).              |
 
 ## Examples
 
@@ -112,9 +114,23 @@ await injector.file(["styles/reset.css", "styles/theme.css"]);
 
 ## Development
 
-- Build: `npm run build`
-- Watch: `npm run build:watch`
-- Format: `npm run format`
+### Build
+
+```bash
+npm run build
+```
+
+### Watch
+
+```bash
+npm run build:watch
+```
+
+### Format
+
+```bash
+npm run format
+```
 
 ## Contributing
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adnbn/inject-css",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "A lightweight TypeScript-friendly library to inject CSS into browser extensions (Manifest V2 & V3)",
   "keywords": [
     "browser",

src/InjectCssV2.ts

@@ -6,22 +6,17 @@ import {InjectCssOptions} from "./types";
 
 type CSSOrigin = chrome.extensionTypes.CSSOrigin;
 type InjectDetails = chrome.extensionTypes.InjectDetails;
-type RunAt = chrome.extensionTypes.RunAt;
-
-export interface InjectCssV2Options extends InjectCssOptions {
-    runAt?: RunAt;
-}
 
 export default class extends AbstractInjectCss {
-    public constructor(protected _options: InjectCssV2Options) {
-        super(_options);
+    public constructor(options: InjectCssOptions) {
+        super(options);
     }
 
-    public async insert(css: string): Promise<void> {
+    public async insert(code: string): Promise<void> {
         const {tabId, runAt} = this._options;
 
         const details: InjectDetails = {
-            code: css,
+            code,
             runAt,
             cssOrigin: this.cssOrigin,
             matchAboutBlank: this.matchAboutBlank,

src/InjectCssV3.ts

@@ -6,33 +6,30 @@ import {InjectCssOptions} from "./types";
 
 type InjectionTarget = chrome.scripting.InjectionTarget;
 
-export interface InjectCssV3Options extends InjectCssOptions {
-    documentId?: string | string[];
-}
-
 export default class extends AbstractInjectCss {
-    constructor(protected _options: InjectCssV3Options) {
-        super(_options);
+    constructor(options: InjectCssOptions) {
+        super(options);
     }
 
     public async insert(css: string): Promise<void> {
-        const {origin} = this._options;
-
-        return insertCss({target: this.target, css, origin});
+        await insertCss({
+            target: this.target,
+            origin: this._options.origin,
+            css,
+        });
     }
 
     public async file(fileList: string | string[]): Promise<void> {
-        const {origin} = this._options;
-        const files = typeof fileList === "string" ? [fileList] : fileList;
-
-        await insertCss({target: this.target, files, origin});
+        await insertCss({
+            target: this.target,
+            origin: this._options.origin,
+            files: typeof fileList === "string" ? [fileList] : fileList,
+        });
     }
 
     protected get target(): InjectionTarget {
-        const {tabId} = this._options;
-
         return {
-            tabId,
+            tabId: this._options.tabId,
             allFrames: this.allFrames,
             frameIds: this.frameIds,
             documentIds: this.documentIds,

src/index.ts

@@ -1,17 +1,12 @@
 import {isManifestVersion3} from "@adnbn/browser";
 
-import InjectCssV2, {InjectCssV2Options} from "./InjectCssV2";
-import InjectCssV3, {InjectCssV3Options} from "./InjectCssV3";
+import InjectCssV2 from "./InjectCssV2";
+import InjectCssV3 from "./InjectCssV3";
 
 import {InjectCssContract, InjectCssOptions} from "./types";
 
-export type InjectCssUnionOptions = InjectCssV2Options & InjectCssV3Options;
-
 export {type InjectCssContract, type InjectCssOptions};
 
-export default (options: InjectCssUnionOptions): InjectCssContract => {
-    const {runAt, ...optionsV3} = options;
-    const {documentId, ...optionsV2} = options;
-
-    return isManifestVersion3() ? new InjectCssV3(optionsV3) : new InjectCssV2(optionsV2);
+export default (options: InjectCssOptions): InjectCssContract => {
+    return isManifestVersion3() ? new InjectCssV3(options) : new InjectCssV2(options);
 };

src/types.ts

@@ -1,10 +1,17 @@
+type RunAt = chrome.extensionTypes.RunAt;
 type StyleOrigin = chrome.scripting.StyleOrigin;
 
 export interface InjectCssOptions {
     tabId: number;
     frameId?: boolean | number | number[];
     matchAboutBlank?: boolean;
     origin?: StyleOrigin;
+
+    // Options for MV2
+    runAt?: RunAt;
+
+    // Options for MV3
+    documentId?: string | string[];
 }
 
 export interface InjectCssContract {