@mirawision/chrome-api/notifications.js

A comprehensive TypeScript library for Chrome Extension API, providing type-safe wrappers and utilities for bookmarks, commands, context menus, cookies, downloads, storage, notifications, runtime, scripting, and side panel functionalities.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Notifications = void 0;
/**
 * A class that provides a type-safe wrapper around Chrome's notifications API.
 * This class allows you to create, update, and manage system notifications,
 * as well as handle user interactions with notifications.
 */
class Notifications {
    /**
     * Creates a new notification.
     * @param options - The notification options including type, title, message, etc.
     * @returns A promise that resolves to the notification ID
     * @throws {Error} If there's an error creating the notification
     */
    static async create(options) {
        return new Promise((resolve, reject) => {
            chrome.notifications.create('', options, (notificationId) => {
                if (chrome.runtime.lastError) {
                    reject(chrome.runtime.lastError);
                }
                else {
                    resolve(notificationId);
                }
            });
        });
    }
    /**
     * Updates an existing notification.
     * @param notificationId - The ID of the notification to update
     * @param options - The new notification options
     * @returns A promise that resolves to true if the notification was updated
     * @throws {Error} If there's an error updating the notification
     */
    static async update(notificationId, options) {
        return new Promise((resolve, reject) => {
            chrome.notifications.update(notificationId, options, (wasUpdated) => {
                if (chrome.runtime.lastError) {
                    reject(chrome.runtime.lastError);
                }
                else {
                    resolve(wasUpdated);
                }
            });
        });
    }
    /**
     * Clears an existing notification.
     * @param notificationId - The ID of the notification to clear
     * @returns A promise that resolves to true if the notification was cleared
     * @throws {Error} If there's an error clearing the notification
     */
    static async clear(notificationId) {
        return new Promise((resolve, reject) => {
            chrome.notifications.clear(notificationId, (wasCleared) => {
                if (chrome.runtime.lastError) {
                    reject(chrome.runtime.lastError);
                }
                else {
                    resolve(wasCleared);
                }
            });
        });
    }
    /**
     * Retrieves all active notifications.
     * @returns A promise that resolves to an array of notification IDs
     * @throws {Error} If there's an error retrieving the notifications
     */
    static async getAll() {
        return new Promise((resolve, reject) => {
            chrome.notifications.getAll((notifications) => {
                if (chrome.runtime.lastError) {
                    reject(chrome.runtime.lastError);
                }
                else {
                    resolve(Object.keys(notifications));
                }
            });
        });
    }
    /**
     * Gets the current permission level for notifications.
     * @returns A promise that resolves to the permission level
     * @throws {Error} If there's an error retrieving the permission level
     */
    static async getPermissionLevel() {
        return new Promise((resolve, reject) => {
            chrome.notifications.getPermissionLevel((level) => {
                if (chrome.runtime.lastError) {
                    reject(chrome.runtime.lastError);
                }
                else {
                    resolve(level);
                }
            });
        });
    }
    /**
     * Adds a listener for notification click events.
     * @param callback - Function called when a notification is clicked
     * @returns A function that removes the listener when called
     */
    static addClickedListener(callback) {
        chrome.notifications.onClicked.addListener(callback);
        return () => chrome.notifications.onClicked.removeListener(callback);
    }
    /**
     * Adds a listener for notification button click events.
     * @param callback - Function called when a notification button is clicked
     * @returns A function that removes the listener when called
     */
    static addButtonClickedListener(callback) {
        chrome.notifications.onButtonClicked.addListener(callback);
        return () => chrome.notifications.onButtonClicked.removeListener(callback);
    }
    /**
     * Adds a listener for notification close events.
     * @param callback - Function called when a notification is closed
     * @returns A function that removes the listener when called
     */
    static addClosedListener(callback) {
        chrome.notifications.onClosed.addListener(callback);
        return () => chrome.notifications.onClosed.removeListener(callback);
    }
}
exports.Notifications = Notifications;