@aws-amplify/ui-react-core-notifications 2.2.8 → 2.2.9

package/README.md

@@ -1,3 +1,35 @@
-# Amplify UI React Core
+# Amplify UI React Core Notifications
 
 `@aws-amplify/ui-react-core-notifications` is a React platform agnostic utility library for Amplify UI internal usage in the `@aws-amplify/ui-react-notifications` package.
+
+## Contents
+
+### Providers and Hooks
+
+- `InAppMessagingProvider` - Provider component for in-app messaging context
+- `useInAppMessaging` - Hook for accessing in-app messaging functionality
+- `useMessage` - Hook for accessing message functionality
+- `handleMessageAction` - Utility function for handling message actions
+
+### Type Definitions
+
+- `InAppMessage` - Core message type definition
+- `InAppMessageAction` - Type for message actions
+- `InAppMessageButton` - Type for message buttons
+- `InAppMessageContent` - Type for message content
+- `InAppMessageImage` - Type for message images
+- `InAppMessageLayout` - Type for message layouts
+- `InAppMessageStyle` - Type for message styling
+- `InAppMessageTextAlign` - Type for text alignment options
+
+### Message Component Types
+
+- `BannerMessageComponent` - Type for banner message components
+- `CarouselMessageComponent` - Type for carousel message components
+- `FullScreenMessageComponent` - Type for full-screen message components
+- `ModalMessageComponent` - Type for modal message components
+- `MessageButtonProps` - Props for message buttons
+- `MessageCommonProps` - Common props for messages
+- `MessageComponentBaseProps` - Base props for message components
+- `MessageContentProps` - Props for message content
+- `MessagePayloadStyle` - Style for message payload

package/dist/types/InAppMessaging/context/InAppMessagingContext/InAppMessagingContext.d.ts

@@ -1,5 +1,5 @@
 import React from 'react';
-import { InAppMessage } from '../../types';
+import type { InAppMessage } from '../../types';
 export interface InAppMessagingContextType {
     clearMessage: () => void;
     displayMessage: (message: InAppMessage) => void;

package/dist/types/InAppMessaging/context/InAppMessagingContext/index.d.ts

@@ -1 +1,2 @@
-export { default as InAppMessagingContext, InAppMessagingContextType, InAppMessagingProviderProps, InAppMessagingProvider, useInAppMessaging, UseInAppMessaging, } from './InAppMessagingContext';
+export type { InAppMessagingContextType, InAppMessagingProviderProps, UseInAppMessaging, } from './InAppMessagingContext';
+export { default as InAppMessagingContext, InAppMessagingProvider, useInAppMessaging, } from './InAppMessagingContext';

package/dist/types/InAppMessaging/context/InAppMessagingContext/useInAppMessagingState.d.ts

@@ -1,2 +1,2 @@
-import { InAppMessagingContextType } from '../InAppMessagingContext';
+import type { InAppMessagingContextType } from '../InAppMessagingContext';
 export declare function useInAppMessagingState(): InAppMessagingContextType;

package/dist/types/InAppMessaging/hooks/useMessage/types.d.ts

@@ -1,4 +1,4 @@
-import { BannerMessageCommonProps, BannerMessageComponent, CarouselMessageCommonProps, CarouselMessageComponent, FullScreenMessageCommonProps, FullScreenMessageComponent, ModalMessageCommonProps, ModalMessageComponent, OnMessageAction } from '../../types';
+import type { BannerMessageCommonProps, BannerMessageComponent, CarouselMessageCommonProps, CarouselMessageComponent, FullScreenMessageCommonProps, FullScreenMessageComponent, ModalMessageCommonProps, ModalMessageComponent, OnMessageAction } from '../../types';
 interface Components<PlatformStyleProps> {
     BannerMessage: BannerMessageComponent<PlatformStyleProps>;
     CarouselMessage: CarouselMessageComponent<PlatformStyleProps>;

package/dist/types/InAppMessaging/hooks/useMessage/useMessage.d.ts

@@ -1,4 +1,4 @@
-import { UseMessage, UseMessageParams } from './types';
+import type { UseMessage, UseMessageParams } from './types';
 export declare const EMPTY_PROPS: Readonly<{}>;
 /**
  * Utility hook for parsing a message and retrieving its corresponding UI component and props

package/dist/types/InAppMessaging/hooks/useMessage/utils.d.ts

@@ -1,4 +1,4 @@
-import { BannerMessageLayouts, InAppMessageAction, MessageComponentPosition, InAppMessageContent, MessageContentProps, OnMessageAction } from '../../types';
+import type { BannerMessageLayouts, InAppMessageAction, MessageComponentPosition, InAppMessageContent, MessageContentProps, OnMessageAction } from '../../types';
 export declare const getPositionProp: (layout: BannerMessageLayouts) => MessageComponentPosition;
 export declare const getActionHandler: (actionParams: {
     action: InAppMessageAction;

package/dist/types/InAppMessaging/types.d.ts

@@ -1,5 +1,5 @@
-import React from 'react';
-import { InAppMessage as InAppMessageBase, InAppMessageAction as InAppMessageActionBase, InAppMessageButton as InAppMessageButtonBase, InAppMessageContent as InAppMessageContentBase, InAppMessageImage as InAppMessageImageBase, InAppMessageLayout as InAppMessageLayoutBase, InAppMessageStyle as InAppMessageStyleBase, InAppMessageTextAlign as InAppMessageTextAlignBase } from 'aws-amplify/in-app-messaging';
+import type React from 'react';
+import type { InAppMessage as InAppMessageBase, InAppMessageAction as InAppMessageActionBase, InAppMessageButton as InAppMessageButtonBase, InAppMessageContent as InAppMessageContentBase, InAppMessageImage as InAppMessageImageBase, InAppMessageLayout as InAppMessageLayoutBase, InAppMessageStyle as InAppMessageStyleBase, InAppMessageTextAlign as InAppMessageTextAlignBase } from 'aws-amplify/in-app-messaging';
 export type InAppMessage = InAppMessageBase;
 export type InAppMessageAction = InAppMessageActionBase;
 export type InAppMessageButton = InAppMessageButtonBase;

package/dist/types/InAppMessaging/utils/handleMessageAction.d.ts

@@ -1,4 +1,4 @@
-import { InAppMessageAction } from '../types';
+import type { InAppMessageAction } from '../types';
 export type HandleMessageLinkAction = (url: string) => void | Promise<void>;
 interface HandleMessageActionParams {
     action: InAppMessageAction;

package/dist/types/InAppMessaging/utils/index.d.ts

@@ -1 +1,2 @@
-export { default as handleMessageAction, HandleMessageLinkAction, } from './handleMessageAction';
+export type { HandleMessageLinkAction } from './handleMessageAction';
+export { default as handleMessageAction } from './handleMessageAction';

package/dist/types/index.d.ts

@@ -1 +1,2 @@
-export { BannerMessageCommonProps, BannerMessageComponent, CarouselMessageCommonProps, CarouselMessageComponent, FullScreenMessageCommonProps, FullScreenMessageComponent, handleMessageAction, HandleMessageLinkAction, InAppMessage, InAppMessageAction, InAppMessageButton, InAppMessageContent, InAppMessageImage, InAppMessageLayout, InAppMessageStyle, InAppMessagingProviderProps, InAppMessagingProvider, InAppMessageTextAlign, MessageButtonProps, MessageCommonProps, MessageComponentBaseProps, MessageContentProps, MessagePayloadStyle, ModalMessageCommonProps, ModalMessageComponent, OnMessageAction, UseInAppMessaging, useInAppMessaging, useMessage, } from './InAppMessaging';
+export type { BannerMessageCommonProps, BannerMessageComponent, CarouselMessageCommonProps, CarouselMessageComponent, FullScreenMessageCommonProps, FullScreenMessageComponent, HandleMessageLinkAction, InAppMessage, InAppMessageAction, InAppMessageButton, InAppMessageContent, InAppMessageImage, InAppMessageLayout, InAppMessageStyle, InAppMessagingProviderProps, InAppMessageTextAlign, MessageButtonProps, MessageCommonProps, MessageComponentBaseProps, MessageContentProps, MessagePayloadStyle, ModalMessageCommonProps, ModalMessageComponent, OnMessageAction, UseInAppMessaging, } from './InAppMessaging';
+export { handleMessageAction, InAppMessagingProvider, useInAppMessaging, useMessage, } from './InAppMessaging';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/ui-react-core-notifications",
-  "version": "2.2.8",
+  "version": "2.2.9",
   "main": "dist/index.js",
   "module": "dist/esm/index.mjs",
   "exports": {
@@ -35,8 +35,8 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@aws-amplify/ui": "6.10.2",
-    "@aws-amplify/ui-react-core": "3.4.2"
+    "@aws-amplify/ui": "6.10.3",
+    "@aws-amplify/ui-react-core": "3.4.3"
   },
   "peerDependencies": {
     "aws-amplify": "^6.14.3",