Clean code

Author: sheepzh

global.d.ts

@@ -431,4 +431,36 @@ declare namespace timer {
             iconUrl?: string
         }
     }
+
+    /**
+     * Message queue
+     */
+    namespace mq {
+        type ReqCode =
+            | 'openLimitPage'
+            | 'limitTimeMeet'
+            // @since 0.9.0
+            | 'limitWaking'
+        type ResCode = "success" | "fail" | "ignore"
+
+        /**
+         * @since 0.2.2
+         */
+        type Request<T = any> = {
+            code: ReqCode
+            data: T
+        }
+        /**
+         * @since 0.8.4
+         */
+        type Response<T = any> = {
+            code: ResCode,
+            msg?: string
+            data?: T
+        }
+        /**
+         * @since 0.8.4
+         */
+        type Callback<T = any> = (result?: Response<T>) => void
+    }
 }

src/background/message-listener.ts

@@ -7,7 +7,6 @@
 
 import { getAppPageUrl } from "@util/constant/url"
 import { LIMIT_ROUTE } from "../app/router/constants"
-import { ChromeMessage, ChromeResult } from "@util/message"
 import TimeLimitItem from "@entity/dto/time-limit-item"
 
 function processLimitWaking(rules: TimeLimitItem[], tab: chrome.tabs.Tab) {
@@ -16,7 +15,7 @@ function processLimitWaking(rules: TimeLimitItem[], tab: chrome.tabs.Tab) {
     if (!anyMatch) {
         return
     }
-    chrome.tabs.sendMessage<ChromeMessage<timer.limit.Item[]>, ChromeResult>(tab.id, {
+    chrome.tabs.sendMessage<timer.mq.Request<timer.limit.Item[]>, timer.mq.Response>(tab.id, {
         code: "limitWaking",
         data: rules
     }, result => {
@@ -28,7 +27,7 @@ function processLimitWaking(rules: TimeLimitItem[], tab: chrome.tabs.Tab) {
     })
 }
 
-function listen(message: ChromeMessage<any>, _sender: chrome.runtime.MessageSender, sendResponse: (response?: any) => void) {
+function listen(message: timer.mq.Request<any>, _sender: chrome.runtime.MessageSender, sendResponse: (response?: any) => void) {
     if (message.code === 'openLimitPage') {
         const url: string = message.data as string
         const pageUrl = getAppPageUrl(true, LIMIT_ROUTE, { url: encodeURI(url) })

src/background/timer/save.ts

@@ -9,13 +9,12 @@ import TimeLimitItem from "@entity/dto/time-limit-item"
 import limitService from "@service/limit-service"
 import periodService from "@service/period-service"
 import timerService from "@service/timer-service"
-import { ChromeMessage, ChromeResult } from "@util/message"
 import CollectionContext from "./collection-context"
 
 function sendLimitedMessage(item: TimeLimitItem[]) {
     chrome.tabs.query({ status: "complete" }, tabs => {
         tabs.forEach(tab => {
-            chrome.tabs.sendMessage<ChromeMessage<timer.limit.Item[]>, ChromeResult>(tab.id, {
+            chrome.tabs.sendMessage<timer.mq.Request<timer.limit.Item[]>, timer.mq.Response>(tab.id, {
                 code: "limitTimeMeet",
                 data: item
             }, result => {

src/content-script/limit.ts

@@ -8,7 +8,6 @@
 import TimeLimitItem from "@entity/dto/time-limit-item"
 import limitService from "@service/limit-service"
 import { t2Chrome } from "@util/i18n/chrome/t"
-import { ChromeCallback, ChromeMessage, ChromeResult } from "@util/message"
 
 class _Modal {
     url: string
@@ -41,7 +40,7 @@ class _Modal {
                 const wakingRules = delayRules
                     .map(like => TimeLimitItem.of(like))
                     .filter(rule => !rule.hasLimited())
-                chrome.runtime.sendMessage<ChromeMessage<timer.limit.Item[]>, ChromeResult>(wakingMessage(wakingRules))
+                chrome.runtime.sendMessage<timer.mq.Request<timer.limit.Item[]>, timer.mq.Response>(wakingMessage(wakingRules))
                 this.hideModal()
             }
             this.delayContainer.append(link)
@@ -77,7 +76,7 @@ class _Modal {
     }
 }
 
-function wakingMessage(rules: timer.limit.Item[]): ChromeMessage<timer.limit.Item[]> {
+function wakingMessage(rules: timer.limit.Item[]): timer.mq.Request<timer.limit.Item[]> {
     return { code: 'limitWaking', data: rules }
 }
 
@@ -101,7 +100,7 @@ const linkStyle: Partial<CSSStyleDeclaration> = {
     fontSize: '16px !important'
 }
 
-function openLimitPageMessage(url: string): ChromeMessage<string> {
+function openLimitPageMessage(url: string): timer.mq.Request<string> {
     return { code: 'openLimitPage', data: encodeURIComponent(url) }
 }
 
@@ -124,7 +123,7 @@ export default async function processLimit(url: string) {
     if (limitedRules?.length) {
         window.onload = () => modal.showModal(!!limitedRules?.filter?.(item => item.allowDelay).length)
     }
-    chrome.runtime.onMessage.addListener((msg: ChromeMessage<timer.limit.Item[]>, _sender, sendResponse: ChromeCallback) => {
+    chrome.runtime.onMessage.addListener((msg: timer.mq.Request<timer.limit.Item[]>, _sender, sendResponse: timer.mq.Callback) => {
         if (msg.code !== "limitTimeMeet") {
             sendResponse({ code: "ignore" })
             return
@@ -138,7 +137,7 @@ export default async function processLimit(url: string) {
         modal.process(items)
         sendResponse({ code: "success" })
     })
-    chrome.runtime.onMessage.addListener((msg: ChromeMessage<timer.limit.Item[]>, _sender, sendResponse: ChromeCallback) => {
+    chrome.runtime.onMessage.addListener((msg: timer.mq.Request<timer.limit.Item[]>, _sender, sendResponse: timer.mq.Callback) => {
         if (msg.code !== "limitWaking") {
             sendResponse({ code: "ignore" })
             return