From 7706b282000cd767ec0d8d0e76a65c4206604614 Mon Sep 17 00:00:00 2001
From: Eric Liu <ericyl.us@gmail.com>
Date: Fri, 22 Jan 2021 12:20:19 -0800
Subject: [PATCH] feat(notification): update TS signature for dispatched close
 event

---
 COMPONENT_INDEX.md                         | 28 +++++++++++-----------
 docs/src/COMPONENT_API.json                | 16 +++++++++----
 src/Notification/InlineNotification.svelte |  4 ++++
 src/Notification/ToastNotification.svelte  |  4 ++++
 tests/InlineNotification.test.svelte       |  3 +++
 tests/ToastNotification.test.svelte        |  3 +++
 types/Notification/InlineNotification.d.ts |  2 +-
 types/Notification/ToastNotification.d.ts  |  2 +-
 8 files changed, 42 insertions(+), 20 deletions(-)

diff --git a/COMPONENT_INDEX.md b/COMPONENT_INDEX.md
index 6d4e8b89..f0012a7b 100644
--- a/COMPONENT_INDEX.md
+++ b/COMPONENT_INDEX.md
@@ -1755,13 +1755,13 @@ None.
 
 ### Events
 
-| Event name | Type       | Detail |
-| :--------- | :--------- | :----- |
-| click      | forwarded  | --     |
-| mouseover  | forwarded  | --     |
-| mouseenter | forwarded  | --     |
-| mouseleave | forwarded  | --     |
-| close      | dispatched | --     |
+| Event name | Type       | Detail                            |
+| :--------- | :--------- | :-------------------------------- |
+| close      | dispatched | <code>{ timeout: boolean }</code> |
+| click      | forwarded  | --                                |
+| mouseover  | forwarded  | --                                |
+| mouseenter | forwarded  | --                                |
+| mouseleave | forwarded  | --                                |
 
 ## `Link`
 
@@ -3892,13 +3892,13 @@ None.
 
 ### Events
 
-| Event name | Type       | Detail |
-| :--------- | :--------- | :----- |
-| click      | forwarded  | --     |
-| mouseover  | forwarded  | --     |
-| mouseenter | forwarded  | --     |
-| mouseleave | forwarded  | --     |
-| close      | dispatched | --     |
+| Event name | Type       | Detail                            |
+| :--------- | :--------- | :-------------------------------- |
+| close      | dispatched | <code>{ timeout: boolean }</code> |
+| click      | forwarded  | --                                |
+| mouseover  | forwarded  | --                                |
+| mouseenter | forwarded  | --                                |
+| mouseleave | forwarded  | --                                |
 
 ## `Toggle`
 
diff --git a/docs/src/COMPONENT_API.json b/docs/src/COMPONENT_API.json
index fc1025a9..6564f1f6 100644
--- a/docs/src/COMPONENT_API.json
+++ b/docs/src/COMPONENT_API.json
@@ -5772,11 +5772,15 @@
       ],
       "slots": [{ "name": "__default__", "default": true, "slot_props": "{}" }],
       "events": [
+        {
+          "type": "dispatched",
+          "name": "close",
+          "detail": "{ timeout: boolean }"
+        },
         { "type": "forwarded", "name": "click", "element": "div" },
         { "type": "forwarded", "name": "mouseover", "element": "div" },
         { "type": "forwarded", "name": "mouseenter", "element": "div" },
-        { "type": "forwarded", "name": "mouseleave", "element": "div" },
-        { "type": "dispatched", "name": "close" }
+        { "type": "forwarded", "name": "mouseleave", "element": "div" }
       ],
       "typedefs": [],
       "rest_props": { "type": "Element", "name": "div" }
@@ -5871,11 +5875,15 @@
         { "name": "actions", "default": false, "slot_props": "{}" }
       ],
       "events": [
+        {
+          "type": "dispatched",
+          "name": "close",
+          "detail": "{ timeout: boolean }"
+        },
         { "type": "forwarded", "name": "click", "element": "div" },
         { "type": "forwarded", "name": "mouseover", "element": "div" },
         { "type": "forwarded", "name": "mouseenter", "element": "div" },
-        { "type": "forwarded", "name": "mouseleave", "element": "div" },
-        { "type": "dispatched", "name": "close" }
+        { "type": "forwarded", "name": "mouseleave", "element": "div" }
       ],
       "typedefs": [],
       "rest_props": { "type": "Element", "name": "div" }
diff --git a/src/Notification/InlineNotification.svelte b/src/Notification/InlineNotification.svelte
index 6de004fb..3a290f21 100644
--- a/src/Notification/InlineNotification.svelte
+++ b/src/Notification/InlineNotification.svelte
@@ -1,4 +1,8 @@
 <script>
+  /**
+   * @event {{ timeout: boolean }} close
+   */
+
   /**
    * Specify the kind of notification
    * @type {"error" | "info" | "info-square" | "success" | "warning" | "warning-alt"}
diff --git a/src/Notification/ToastNotification.svelte b/src/Notification/ToastNotification.svelte
index d02f59b5..84b33b15 100644
--- a/src/Notification/ToastNotification.svelte
+++ b/src/Notification/ToastNotification.svelte
@@ -1,4 +1,8 @@
 <script>
+  /**
+   * @event {{ timeout: boolean }} close
+   */
+
   /**
    * Specify the kind of notification
    * @type {"error" | "info" | "info-square" | "success" | "warning" | "warning-alt"}
diff --git a/tests/InlineNotification.test.svelte b/tests/InlineNotification.test.svelte
index 74d884a1..6eacee66 100644
--- a/tests/InlineNotification.test.svelte
+++ b/tests/InlineNotification.test.svelte
@@ -8,6 +8,9 @@
   hideCloseButton
   kind="warning"
   title="Upcoming scheduled maintenance"
+  on:close="{(e) => {
+    console.log(e.detail.timeout);
+  }}"
 />
 
 <InlineNotification kind="warning" title="Upcoming scheduled maintenance">
diff --git a/tests/ToastNotification.test.svelte b/tests/ToastNotification.test.svelte
index de2c3176..17a84883 100644
--- a/tests/ToastNotification.test.svelte
+++ b/tests/ToastNotification.test.svelte
@@ -8,6 +8,9 @@
   hideCloseButton
   kind="warning"
   title="Upcoming scheduled maintenance"
+  on:close="{(e) => {
+    console.log(e.detail.timeout);
+  }}"
 />
 
 <ToastNotification kind="error" />
diff --git a/types/Notification/InlineNotification.d.ts b/types/Notification/InlineNotification.d.ts
index 67614bad..9e48a5fd 100644
--- a/types/Notification/InlineNotification.d.ts
+++ b/types/Notification/InlineNotification.d.ts
@@ -57,10 +57,10 @@ export default class InlineNotification {
     actions: {};
   };
 
+  $on(eventname: "close", cb: (event: CustomEvent<{ timeout: boolean }>) => void): () => void;
   $on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
   $on(eventname: "mouseover", cb: (event: WindowEventMap["mouseover"]) => void): () => void;
   $on(eventname: "mouseenter", cb: (event: WindowEventMap["mouseenter"]) => void): () => void;
   $on(eventname: "mouseleave", cb: (event: WindowEventMap["mouseleave"]) => void): () => void;
-  $on(eventname: "close", cb: (event: CustomEvent<any>) => void): () => void;
   $on(eventname: string, cb: (event: Event) => void): () => void;
 }
diff --git a/types/Notification/ToastNotification.d.ts b/types/Notification/ToastNotification.d.ts
index b34d7333..8037b08b 100644
--- a/types/Notification/ToastNotification.d.ts
+++ b/types/Notification/ToastNotification.d.ts
@@ -62,10 +62,10 @@ export default class ToastNotification {
     default: {};
   };
 
+  $on(eventname: "close", cb: (event: CustomEvent<{ timeout: boolean }>) => void): () => void;
   $on(eventname: "click", cb: (event: WindowEventMap["click"]) => void): () => void;
   $on(eventname: "mouseover", cb: (event: WindowEventMap["mouseover"]) => void): () => void;
   $on(eventname: "mouseenter", cb: (event: WindowEventMap["mouseenter"]) => void): () => void;
   $on(eventname: "mouseleave", cb: (event: WindowEventMap["mouseleave"]) => void): () => void;
-  $on(eventname: "close", cb: (event: CustomEvent<any>) => void): () => void;
   $on(eventname: string, cb: (event: Event) => void): () => void;
 }