@bringweb3/chrome-extension-kit 1.0.2 → 1.0.3

package/dist/index.d.mts

@@ -0,0 +1,77 @@
+interface Configuration$1 {
+    iframeEndpoint: string;
+    getWalletAddress: () => Promise<WalletAddress>;
+    promptLogin: () => Promise<WalletAddress>;
+    walletAddressListeners: string[];
+    customTheme?: Style;
+}
+/**
+ * Initializes the content script for the Bring extension.
+ *
+ * @async
+ * @function bringInitContentScript
+ * @param {Object} configuration - The configuration object.
+ * @param {Function} configuration.getWalletAddress - A function that returns a Promise resolving to the wallet address.
+ * @param {Function} configuration.promptLogin - A function to prompt the user to login.
+ * @param {string[]} configuration.walletAddressListeners - An array of strings representing wallet address listeners.
+ * @param {Object} [configuration.customTheme] - Optional custom theme settings.
+ * @param {string} configuration.iframeEndpoint - The endpoint URL for the iframe.
+ * @throws {Error} Throws an error if any required configuration is missing.
+ * @returns {Promise<void>}
+ *
+ * @description
+ * This function sets up event listeners for wallet address changes, iframe messages,
+ * and Chrome runtime messages. It handles actions such as getting the wallet address
+ * and injecting iframes based on received messages.
+ *
+ * @example
+ * bringInitContentScript({
+ *   getWalletAddress: async () => '0x1234...',
+ *   promptLogin: () => { ... },
+ *   walletAddressListeners: ["listener1", "listener2"],
+ *   iframeEndpoint: 'https://example.com/iframe'
+ * });
+ */
+declare const bringInitContentScript: ({ getWalletAddress, promptLogin, walletAddressListeners, customTheme, iframeEndpoint }: Configuration$1) => Promise<void>;
+
+interface Configuration {
+    identifier: string;
+    apiEndpoint: string;
+    cashbackPagePath?: string;
+}
+/**
+ * Initializes the background script for the Bring extension.
+ *
+ * @async
+ * @function bringInitBackground
+ * @param {Object} configuration - The configuration object.
+ * @param {string} configuration.identifier - The identifier for the extension.
+ * @param {string} configuration.apiEndpoint - The API endpoint ('prod' or 'sandbox').
+ * @param {string} [configuration.cashbackPagePath] - Optional path to the cashback page.
+ * @throws {Error} Throws an error if identifier or apiEndpoint is missing, or if apiEndpoint is invalid.
+ * @returns {Promise<void>}
+ *
+ * @description
+ * This function sets up the background processes for the Bring extension. It initializes
+ * the API endpoint, sets up listeners for alarms, runtime messages, and tab updates.
+ * It handles various actions such as opting out, closing notifications, injecting content
+ * based on URL changes, and managing quiet domains.
+ *
+ * The function performs the following tasks:
+ * - Validates and sets the API endpoint
+ * - Updates the cache
+ * - Sets up listeners for alarms to update cache periodically
+ * - Handles runtime messages for opting out and closing notifications
+ * - Monitors tab updates to inject content or show notifications based on URL changes
+ * - Validates domains and manages quiet domains
+ *
+ * @example
+ * bringInitBackground({
+ *   identifier: 'my-extension-id',
+ *   apiEndpoint: 'sandbox',
+ *   cashbackPagePath: '/cashback.html'
+ * });
+ */
+declare const bringInitBackground: ({ identifier, apiEndpoint, cashbackPagePath }: Configuration) => Promise<void>;
+
+export { bringInitBackground, bringInitContentScript };

package/dist/index.d.ts

@@ -0,0 +1,77 @@
+interface Configuration$1 {
+    iframeEndpoint: string;
+    getWalletAddress: () => Promise<WalletAddress>;
+    promptLogin: () => Promise<WalletAddress>;
+    walletAddressListeners: string[];
+    customTheme?: Style;
+}
+/**
+ * Initializes the content script for the Bring extension.
+ *
+ * @async
+ * @function bringInitContentScript
+ * @param {Object} configuration - The configuration object.
+ * @param {Function} configuration.getWalletAddress - A function that returns a Promise resolving to the wallet address.
+ * @param {Function} configuration.promptLogin - A function to prompt the user to login.
+ * @param {string[]} configuration.walletAddressListeners - An array of strings representing wallet address listeners.
+ * @param {Object} [configuration.customTheme] - Optional custom theme settings.
+ * @param {string} configuration.iframeEndpoint - The endpoint URL for the iframe.
+ * @throws {Error} Throws an error if any required configuration is missing.
+ * @returns {Promise<void>}
+ *
+ * @description
+ * This function sets up event listeners for wallet address changes, iframe messages,
+ * and Chrome runtime messages. It handles actions such as getting the wallet address
+ * and injecting iframes based on received messages.
+ *
+ * @example
+ * bringInitContentScript({
+ *   getWalletAddress: async () => '0x1234...',
+ *   promptLogin: () => { ... },
+ *   walletAddressListeners: ["listener1", "listener2"],
+ *   iframeEndpoint: 'https://example.com/iframe'
+ * });
+ */
+declare const bringInitContentScript: ({ getWalletAddress, promptLogin, walletAddressListeners, customTheme, iframeEndpoint }: Configuration$1) => Promise<void>;
+
+interface Configuration {
+    identifier: string;
+    apiEndpoint: string;
+    cashbackPagePath?: string;
+}
+/**
+ * Initializes the background script for the Bring extension.
+ *
+ * @async
+ * @function bringInitBackground
+ * @param {Object} configuration - The configuration object.
+ * @param {string} configuration.identifier - The identifier for the extension.
+ * @param {string} configuration.apiEndpoint - The API endpoint ('prod' or 'sandbox').
+ * @param {string} [configuration.cashbackPagePath] - Optional path to the cashback page.
+ * @throws {Error} Throws an error if identifier or apiEndpoint is missing, or if apiEndpoint is invalid.
+ * @returns {Promise<void>}
+ *
+ * @description
+ * This function sets up the background processes for the Bring extension. It initializes
+ * the API endpoint, sets up listeners for alarms, runtime messages, and tab updates.
+ * It handles various actions such as opting out, closing notifications, injecting content
+ * based on URL changes, and managing quiet domains.
+ *
+ * The function performs the following tasks:
+ * - Validates and sets the API endpoint
+ * - Updates the cache
+ * - Sets up listeners for alarms to update cache periodically
+ * - Handles runtime messages for opting out and closing notifications
+ * - Monitors tab updates to inject content or show notifications based on URL changes
+ * - Validates domains and manages quiet domains
+ *
+ * @example
+ * bringInitBackground({
+ *   identifier: 'my-extension-id',
+ *   apiEndpoint: 'sandbox',
+ *   cashbackPagePath: '/cashback.html'
+ * });
+ */
+declare const bringInitBackground: ({ identifier, apiEndpoint, cashbackPagePath }: Configuration) => Promise<void>;
+
+export { bringInitBackground, bringInitContentScript };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bringweb3/chrome-extension-kit",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
   "types": "dist/index.d.ts",
@@ -14,7 +14,7 @@
     "build": "tsup index.ts --format cjs,esm --dts --minify",
     "lint": "tsc",
     "test": "vitest --coverage",
-    "release": "yarn build & changeset publish"
+    "release": "yarn build && changeset publish"
   },
   "files": [
     "dist",