expose fire-button messages to documentation

duckduckgo · Nov 29, 2023 · 3d3ef9a · 3d3ef9a
1 parent 84f247c
commit 3d3ef9a
Show file tree

Hide file tree

Showing 3 changed files with 66 additions and 4 deletions.
diff --git a/build/app/public/js/base.js b/build/app/public/js/base.js
@@ -10682,6 +10682,9 @@
         }
       };
       BurnMessage = class extends Msg {
+        /**
+         * @param {import('../../../schema/__generated__/schema.types').FireOption} opts
+         */
         constructor(opts) {
           super();
           Object.assign(this, opts);
@@ -10690,6 +10693,9 @@
       FetchBurnOptions = class extends Msg {
       };
       SetBurnDefaultOption = class extends Msg {
+        /**
+         * @param {import('../../../schema/__generated__/schema.types').FireOption['name']} name
+         */
         constructor(name) {
           super();
           this.defaultOption = name;
@@ -11021,10 +11027,12 @@
     doBurn: () => doBurn,
     fetch: () => fetch,
     getBackgroundTabData: () => getBackgroundTabData,
+    getBurnOptions: () => getBurnOptions,
     getPrivacyDashboardData: () => getPrivacyDashboardData,
     openOptions: () => openOptions,
     refreshAlias: () => refreshAlias,
     search: () => search,
+    setBurnDefaultOption: () => setBurnDefaultOption,
     setLists: () => setLists,
     setup: () => setup,
     submitBrokenSiteReport: () => submitBrokenSiteReport
@@ -11055,10 +11063,10 @@
       return doBurn(message);
     }
     if (message instanceof FetchBurnOptions) {
-      return toExtensionMessage("getBurnOptions");
+      return getBurnOptions();
     }
     if (message instanceof SetBurnDefaultOption) {
-      return toExtensionMessage("setBurnDefaultOption", message);
+      return setBurnDefaultOption(message);
     }
     return new Promise((resolve) => {
       window.chrome.runtime.sendMessage(message, (result) => {
@@ -11098,6 +11106,12 @@
   async function openOptions() {
     return toExtensionMessage("openOptions");
   }
+  function getBurnOptions() {
+    return toExtensionMessage("getBurnOptions");
+  }
+  function setBurnDefaultOption(message) {
+    return toExtensionMessage("setBurnDefaultOption", message);
+  }
   async function doBurn(message) {
     const browsingDataPermissions = {
       permissions: ["browsingData"]

diff --git a/shared/js/browser/browser-communication.js b/shared/js/browser/browser-communication.js
@@ -61,10 +61,10 @@ export async function fetch(message) {
         return doBurn(message)
     }
     if (message instanceof FetchBurnOptions) {
-        return toExtensionMessage('getBurnOptions')
+        return getBurnOptions()
     }
     if (message instanceof SetBurnDefaultOption) {
-        return toExtensionMessage('setBurnDefaultOption', message)
+        return setBurnDefaultOption(message)
     }
     return new Promise((resolve) => {
         // console.log('🚀 [OUTGOING]', JSON.stringify(message, null, 2))
@@ -198,6 +198,48 @@ export async function openOptions() {
     return toExtensionMessage('openOptions')
 }
 
+/**
+ * @category Dashboard -> Extension Messages
+ * @return {Promise<import('../../../schema/__generated__/schema.types').FireButtonData>}
+ * @example
+ * ```javascript
+ * window.chrome.runtime.sendMessage({
+ *    messageType: 'getBurnOptions',
+ *    options: {}
+ * })
+ * ```
+ */
+export function getBurnOptions() {
+    return toExtensionMessage('getBurnOptions')
+}
+
+/**
+ * @category Dashboard -> Extension Messages
+ * @param {SetBurnDefaultOption} message
+ * @example
+ * ```javascript
+ * window.chrome.runtime.sendMessage({
+ *    messageType: 'setBurnDefaultOption',
+ *    options: {
+ *        defaultOption: "CurrentSite"
+ *    }
+ * })
+ * ```
+ */
+export function setBurnDefaultOption(message) {
+    return toExtensionMessage('setBurnDefaultOption', message)
+}
+
+/**
+ * @param {BurnMessage} message
+ * @category Dashboard -> Extension Messages
+ * @example
+ * ```javascript
+ * window.chrome.runtime.sendMessage({
+ *    messageType: 'doBurn'
+ * })
+ * ```
+ */
 export async function doBurn(message) {
     const browsingDataPermissions = {
         permissions: ['browsingData'],

diff --git a/shared/js/browser/common.js b/shared/js/browser/common.js
@@ -348,6 +348,9 @@ export class OpenSettingsMessages extends Msg {
 }
 
 export class BurnMessage extends Msg {
+    /**
+     * @param {import('../../../schema/__generated__/schema.types').FireOption} opts
+     */
     constructor(opts) {
         super()
         Object.assign(this, opts)
@@ -357,6 +360,9 @@ export class BurnMessage extends Msg {
 export class FetchBurnOptions extends Msg {}
 
 export class SetBurnDefaultOption extends Msg {
+    /**
+     * @param {import('../../../schema/__generated__/schema.types').FireOption['name']} name
+     */
     constructor(name) {
         super()
         this.defaultOption = name