@hitachivantara/app-shell-events 0.1.0 → 0.1.1

package/README.md

@@ -0,0 +1,18 @@
+# @hitachivantara/app-shell-events
+
+Hitachi Vantara App Shell Events. Type definitions for App Shell events ecosystem. 
+
+## Overview
+
+App Shell events mechanism is based at the usage of javascript's CustomEvent (for more detail check [here](https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent/CustomEvent)).
+This package defines the set of possible `type` values and `options.detail` type definition.
+
+## Installation
+
+The App Shell Events is available as an NPM package, and can be installed with:
+
+```bash
+npm install @hitachivantara/app-shell-events
+```
+
+More info about App Shell events is available in https://github.com/lumada-design/hv-app-shell/blob/main/docs/notifications.md#notifications and https://github.com/lumada-design/hv-app-shell/blob/main/docs/theming.md#triggering-color-mode-change.

package/dist/dts/index.d.ts

@@ -6,15 +6,15 @@ import { SyntheticEvent } from 'react';
 
 export declare type HvAppShellEventNotification = {
     type: HvAppShellEventNotificationType;
-    variant?: HvBannerVariant | HvSnackbarVariant;
     message?: string;
+    variant?: HvBannerVariant | HvSnackbarVariant;
     actions?: ReactNode | HvActionGeneric[];
     actionsCallback?: (event: SyntheticEvent<Element, Event>, id: string, action: HvActionGeneric) => void;
 };
 
 export declare const HvAppShellEventNotificationTrigger = "@hv/app-shell:notifications:trigger";
 
-declare type HvAppShellEventNotificationType = NOTIFICATION_TYPE.SNACKBAR | NOTIFICATION_TYPE.BANNER;
+export declare type HvAppShellEventNotificationType = "snackbar" | "banner";
 
 export declare type HvAppShellEventTheme = {
     theme?: string;
@@ -23,9 +23,4 @@ export declare type HvAppShellEventTheme = {
 
 export declare const HvAppShellEventThemeTrigger = "@hv/app-shell:theme:trigger";
 
-export declare enum NOTIFICATION_TYPE {
-    SNACKBAR = "SNACKBAR",
-    BANNER = "BANNER"
-}
-
 export { }

package/dist/esm/index.js

@@ -1,8 +1,7 @@
 import { HvAppShellEventThemeTrigger as o } from "./lib/types/theming.js";
-import { HvAppShellEventNotificationTrigger as t, NOTIFICATION_TYPE as T } from "./lib/types/notifications.js";
+import { HvAppShellEventNotificationTrigger as t } from "./lib/types/notifications.js";
 export {
   t as HvAppShellEventNotificationTrigger,
-  o as HvAppShellEventThemeTrigger,
-  T as NOTIFICATION_TYPE
+  o as HvAppShellEventThemeTrigger
 };
 //# sourceMappingURL=index.js.map

package/dist/esm/lib/types/notifications.js

@@ -1,7 +1,5 @@
-const r = "@hv/app-shell:notifications:trigger";
-var i = /* @__PURE__ */ ((t) => (t.SNACKBAR = "SNACKBAR", t.BANNER = "BANNER", t))(i || {});
+const i = "@hv/app-shell:notifications:trigger";
 export {
-  r as HvAppShellEventNotificationTrigger,
-  i as NOTIFICATION_TYPE
+  i as HvAppShellEventNotificationTrigger
 };
 //# sourceMappingURL=notifications.js.map

package/dist/esm/lib/types/notifications.js.map

@@ -1 +1 @@
-{"version":3,"file":"notifications.js","sources":["../../../../src/lib/types/notifications.ts"],"sourcesContent":["import {\n  HvActionGeneric,\n  HvBannerVariant,\n  HvSnackbarVariant\n} from \"@hitachivantara/uikit-react-core\";\nimport { ReactNode, SyntheticEvent } from \"react\";\n\nexport const HvAppShellEventNotificationTrigger =\n  \"@hv/app-shell:notifications:trigger\";\n\nexport enum NOTIFICATION_TYPE {\n  SNACKBAR = \"SNACKBAR\",\n  BANNER = \"BANNER\"\n}\n\ntype HvAppShellEventNotificationType =\n  | NOTIFICATION_TYPE.SNACKBAR\n  | NOTIFICATION_TYPE.BANNER;\n\nexport type HvAppShellEventNotification = {\n  type: HvAppShellEventNotificationType;\n  variant?: HvBannerVariant | HvSnackbarVariant;\n  message?: string;\n  actions?: ReactNode | HvActionGeneric[];\n  actionsCallback?: (\n    event: SyntheticEvent<Element, Event>,\n    id: string,\n    action: HvActionGeneric\n  ) => void;\n};\n"],"names":["HvAppShellEventNotificationTrigger","NOTIFICATION_TYPE","SNACKBAR","BANNER"],"mappings":"AAOO,MAAMA,IACX;AAEUC,IAAAA,sBAAAA,OACVC,EAAAA,WAAW,YACXC,EAAAA,SAAS,UAFCF,IAAAA,KAAAA,CAAAA,CAAAA;"}
+{"version":3,"file":"notifications.js","sources":["../../../../src/lib/types/notifications.ts"],"sourcesContent":["import {\n  HvActionGeneric,\n  HvBannerVariant,\n  HvSnackbarVariant\n} from \"@hitachivantara/uikit-react-core\";\nimport { ReactNode, SyntheticEvent } from \"react\";\n\nexport const HvAppShellEventNotificationTrigger =\n  \"@hv/app-shell:notifications:trigger\";\n\nexport type HvAppShellEventNotificationType = \"snackbar\" | \"banner\";\n\nexport type HvAppShellEventNotification = {\n  type: HvAppShellEventNotificationType;\n  message?: string;\n  variant?: HvBannerVariant | HvSnackbarVariant;\n  actions?: ReactNode | HvActionGeneric[];\n  actionsCallback?: (\n    event: SyntheticEvent<Element, Event>,\n    id: string,\n    action: HvActionGeneric\n  ) => void;\n};\n"],"names":["HvAppShellEventNotificationTrigger"],"mappings":"AAOO,MAAMA,IACX;"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hitachivantara/app-shell-events",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "AppShell Events",
   "author": "Hitachi Vantara - Boba Fett Team",
   "license": "Apache-2.0",
@@ -45,5 +45,5 @@
     "vite-plugin-dts": "^3.6.4",
     "vite-tsconfig-paths": "^4.0.5"
   },
-  "gitHead": "851f27979a0cd393a55e664d6c025839803ecfd4"
+  "gitHead": "5065d46d465674c03d798b3b3c58bf77e54a3e09"
 }