fix(core): fix notice to support type (#375)

Co-authored-by: Wasuwat Limsuparhat <[email protected]>
Refinitiv · Jun 28, 2022 · cd41db3 · cd41db3
1 parent ccd76a0
commit cd41db3
Show file tree

Hide file tree

Showing 7 changed files with 41 additions and 12 deletions.
diff --git a/packages/core/__snapshots__/TestDeprecationNotice.md b/packages/core/__snapshots__/TestDeprecationNotice.md
@@ -0,0 +1,20 @@
+# `TestDeprecationNotice`
+
+#### `Test generate simple message`
+
+```html
+Deprecation notice:
+test
+
+```
+
+#### `Test generate message with url`
+
+```html
+Deprecation notice:
+test
+
+url
+
+```
+
diff --git a/packages/core/__snapshots__/TestWarningNotice.md b/packages/core/__snapshots__/TestWarningNotice.md
@@ -3,15 +3,15 @@
 #### `Test generate simple message`
 
 ```html
-Information notice:
+Warning notice:
 test
 
 ```
 
 #### `Test generate message with url`
 
 ```html
-Information notice:
+Warning notice:
 test
 
 url

diff --git a/packages/core/__test__/notices/DeprecationNotice.test.js b/packages/core/__test__/notices/DeprecationNotice.test.js
@@ -1,7 +1,7 @@
 import { expect } from '@refinitiv-ui/test-helpers';
 import { DeprecationNotice } from '../../lib/notices/DeprecationNotice';
 
-describe('TestWarningNotice', () => {
+describe('TestDeprecationNotice', () => {
   let originFunc;
   let shownMessage = '';
   let callCount = 0;

diff --git a/packages/core/src/notices/DeprecationNotice.ts b/packages/core/src/notices/DeprecationNotice.ts
@@ -1,9 +1,12 @@
 import { WarningNotice } from './WarningNotice.js';
+import { MESSAGE_TYPE } from './constants.js';
 
 /**
  * **Deprecation Notice**\
  * Used to show deprecation warnings in the console.
  */
 export class DeprecationNotice extends WarningNotice {
-  protected type = 'Deprecation';
+  constructor (message: string, supportURL?: string, type = MESSAGE_TYPE.DEPRECATION) {
+    super(message, supportURL, type);
+  }
 }
diff --git a/packages/core/src/notices/Notice.ts b/packages/core/src/notices/Notice.ts
@@ -1,3 +1,5 @@
+import { MESSAGE_TYPE } from './constants.js';
+
 const generateMessage = (type: string, message: string, supportURL?: string): string =>
   `${type} notice:\n${!supportURL ? message : `${message}\n\n${supportURL}\n`}`;
 
@@ -13,11 +15,6 @@ export class Notice {
    */
   public shown = false;
 
-  /**
-   * Type of notice
-   */
-  protected type = 'Information';
-
   /**
    * The message to be used for the
    * warning notice.
@@ -28,9 +25,10 @@ export class Notice {
    * Create a warning notice to show in the console.
    * @param message Warning message to show in the console
    * @param supportURL Support URL to show additional information
+   * @param type Type of Notice to show at top of message
    */
-  constructor (message: string, supportURL?: string) {
-    this.message = generateMessage(this.type, message, supportURL);
+  constructor (message: string, supportURL?: string, type = MESSAGE_TYPE.NOTICE) {
+    this.message = generateMessage(type, message, supportURL);
   }
 
   /**

diff --git a/packages/core/src/notices/WarningNotice.ts b/packages/core/src/notices/WarningNotice.ts
@@ -1,12 +1,15 @@
 import { Notice } from './Notice.js';
+import { MESSAGE_TYPE } from './constants.js';
 
 /**
  * **Warning Notice**\
  * Used to show warning notices in the console.
  */
 export class WarningNotice extends Notice {
 
-  protected type = 'Warning';
+  constructor (message: string, supportURL?: string, type = MESSAGE_TYPE.WARNING) {
+    super(message, supportURL, type);
+  }
 
   public show (): void {
     /* eslint-disable-next-line no-console */

diff --git a/packages/core/src/notices/constants.ts b/packages/core/src/notices/constants.ts
@@ -0,0 +1,5 @@
+export enum MESSAGE_TYPE {
+  NOTICE = 'Information',
+  DEPRECATION = 'Deprecation',
+  WARNING = 'Warning'
+}