Merge pull request #2023 from hashicorp/HDS-2717/convert-toast-ts

HDS-2717: `Hds::Toast` - Converts to Typescript
hashicorp · Apr 9, 2024 · f2a8b91 · f2a8b91
2 parents e47261d + 9abb66b
commit f2a8b91
Show file tree

Hide file tree

Showing 8 changed files with 29 additions and 3 deletions.
diff --git a/.changeset/soft-buttons-burn.md b/.changeset/soft-buttons-burn.md
@@ -0,0 +1,5 @@
+---
+"@hashicorp/design-system-components": minor
+---
+
+`Toast` - Converted component to TypeScript
diff --git a/packages/components/package.json b/packages/components/package.json
@@ -257,6 +257,7 @@
       "./components/hds/text/index.js": "./dist/_app_/components/hds/text/index.js",
       "./components/hds/text/types.js": "./dist/_app_/components/hds/text/types.js",
       "./components/hds/toast/index.js": "./dist/_app_/components/hds/toast/index.js",
+      "./components/hds/toast/types.js": "./dist/_app_/components/hds/toast/types.js",
       "./components/hds/tooltip-button/index.js": "./dist/_app_/components/hds/tooltip-button/index.js",
       "./components/hds/yield/index.js": "./dist/_app_/components/hds/yield/index.js",
       "./components/hds/yield/types.js": "./dist/_app_/components/hds/yield/types.js",

diff --git a/packages/components/src/components/hds/alert/types.ts b/packages/components/src/components/hds/alert/types.ts
@@ -29,7 +29,8 @@ export interface HdsAlertSignature {
     type: HdsAlertTypes;
     color?: HdsAlertColors;
     icon?: string | false;
-    onDismiss?: () => void;
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    onDismiss?: (event: MouseEvent, ...args: any[]) => void;
   };
   Blocks: {
     default: [

diff --git a/packages/components/src/components/hds/toast/index.hbs b/packages/components/src/components/hds/toast/index.hbs
@@ -1,4 +1,3 @@
-{{! @glint-nocheck: not typesafe yet }}
 {{!
   Copyright (c) HashiCorp, Inc.
   SPDX-License-Identifier: MPL-2.0

diff --git a/packages/components/src/components/hds/toast/index.ts b/packages/components/src/components/hds/toast/index.ts
@@ -0,0 +1,6 @@
+import TemplateOnlyComponent from '@ember/component/template-only';
+import type { HdsToastSignature } from './types.ts';
+
+const HdsToastComponent = TemplateOnlyComponent<HdsToastSignature>();
+
+export default HdsToastComponent;
diff --git a/packages/components/src/components/hds/toast/types.ts b/packages/components/src/components/hds/toast/types.ts
@@ -0,0 +1,5 @@
+import type { HdsAlertSignature } from '../alert/types.ts';
+
+export interface HdsToastSignature extends Omit<HdsAlertSignature, 'Args'> {
+  Args: Omit<HdsAlertSignature['Args'], 'type'>;
+}
diff --git a/packages/components/src/template-registry.ts b/packages/components/src/template-registry.ts
@@ -7,6 +7,7 @@ import type HdsAlertIndexComponent from './components/hds/alert';
 import type HdsAlertDescriptionComponent from './components/hds/alert/description';
 import type HdsAlertTitleComponent from './components/hds/alert/title';
 import type HdsButtonIndexComponent from './components/hds/button';
+import type HdsCardContainerComponent from './components/hds/card/container.ts';
 import type HdsDismissButtonIndexComponent from './components/hds/dismiss-button';
 import type HdsIconTileIndexComponent from './components/hds/icon-tile';
 import type HdsInteractiveIndexComponent from './components/hds/interactive';
@@ -15,11 +16,11 @@ import type HdsLinkStandaloneComponent from './components/hds/link/standalone';
 import type HdsTextIndexComponent from './components/hds/text';
 import type HdsTextBodyComponent from './components/hds/text/body';
 import type HdsTextDisplayComponent from './components/hds/text/display';
+import type HdsToastComponent from './components/hds/toast';
 import type HdsTextCodeComponent from './components/hds/text/code';
 import type HdsYieldComponent from './components/hds/yield';
 import type HdsLinkToModelsHelper from './helpers/hds-link-to-models';
 import type HdsLinkToQueryHelper from './helpers/hds-link-to-query';
-import type HdsCardContainerComponent from './components/hds/card/container.ts';
 
 export default interface HdsComponentsRegistry {
   // Alert
@@ -87,6 +88,11 @@ export default interface HdsComponentsRegistry {
   'hds/text/code': typeof HdsTextCodeComponent;
   HdsTextCode: typeof HdsTextCodeComponent;
 
+  // Toast
+  'Hds::Toast': typeof HdsToastComponent;
+  'hds/toast': typeof HdsToastComponent;
+  HdsToast: typeof HdsToastComponent;
+
   // Yield
   'Hds::Yield': typeof HdsYieldComponent;
   'hds/yield': typeof HdsYieldComponent;

diff --git a/packages/components/tsconfig.json b/packages/components/tsconfig.json
@@ -20,6 +20,9 @@
       "@hashicorp/design-system-components/*": [
         "src/*"
       ],
+      "@ember/component/template-only": [
+        "../../../node_modules/ember-source/types/stable/@ember/component/template-only"
+      ],
       "*": [
         "types/*"
       ]