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

package/README.md

@@ -1,23 +1,33 @@
-# Amplify UI
+# Amplify UI React Notifications
 
-Amplify UI is an open-source UI library with cloud-connected components that are endlessly customizable, accessible, and can integrate into _any_ application. Amplify UI consists of:
+The React Notifications package provides components for in-app messaging in Amplify connected applications.
 
-1. Connected components that simplify complex cloud-connected workflows, like Authenticator.
-2. Primitive components that create consistency across Amplify UI and allow you to build complete applications that fit your brand, like Buttons and Badges.
-3. Data-bound components that make it easy to display dynamic data, like DataStoreCollections.
-4. Theming capabilities that allow you to customize the appearance of Amplify UI to match your brand.
+## Contents
 
-## React Documentation
+### Core Components
 
-- https://ui.docs.amplify.aws/react
+- `InAppMessageDisplay` - Component for displaying in-app messages
+- `withInAppMessaging` - Higher-order component for adding in-app messaging capabilities
 
-## Features 🚀
+### Providers and Hooks
 
-- **Better developer experience** Connected-components like Authenticator are being written with framework-specific implementations so that they follow framework conventions and are easier to integrate into your application.
-- **Endlessly customizable** Every detail of Amplify UI is customizable to match your brand. Style all of Amplify UI with themes, override components with your own, or build your own UI and use Amplify for complex state management.
-- **Accessible** Amplify UI components follow [WCAG](https://www.w3.org/WAI/standards-guidelines/wcag/) and [WAI-ARIA](https://www.w3.org/TR/wai-aria-1.2/) best practices and guidelines such as color contrast, keyboard navigation, accessible labels, and focus management.
-- **Primitive components (React only right now)** Primitive components are used in the connected components, like Authenticator, you can also customize them and use them to build the rest of your UI.
+- `InAppMessagingProvider` - Provider component for in-app messaging context
+- `useInAppMessaging` - Hook for accessing in-app messaging functionality
 
-## We love contributors!!
+### Props Types
 
-See our contributing guide [CONTRIBUTING.md](/CONTRIBUTING.md) to help us scale Amplify UI!
+- `BannerMessageProps` - Props for banner style messages
+- `FullScreenMessageProps` - Props for full-screen style messages
+- `ModalMessageProps` - Props for modal style messages
+- `MessageComponents` - Types for message components
+
+### 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

package/dist/esm/version.mjs

@@ -1,3 +1,3 @@
-const VERSION = '2.2.8';
+const VERSION = '2.2.9';
 
 export { VERSION };

package/dist/index.js

@@ -332,7 +332,7 @@ const handleMessageLinkAction = (input) => {
     window.open(input);
 };
 
-const VERSION = '2.2.8';
+const VERSION = '2.2.9';
 
 // TODO: replace below components incrementally as they become available
 function CarouselMessage(_) {

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

@@ -1,4 +1,4 @@
 import React from 'react';
-import { BackdropProps } from './types';
+import type { BackdropProps } from './types';
 export declare const BACKDROP_TEST_ID = "inappmessaging-backdrop";
 export declare function Backdrop({ onClick, ...rest }: BackdropProps): React.JSX.Element;

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

@@ -1,4 +1,4 @@
-import { ViewProps } from '@aws-amplify/ui-react';
+import type { ViewProps } from '@aws-amplify/ui-react';
 export interface BackdropProps extends ViewProps {
     /**
      * Function called when backdrop is clicked

package/dist/types/components/InAppMessaging/Backdrop/withBackdrop.d.ts

@@ -1,3 +1,3 @@
 import React from 'react';
-import { BackdropProps } from './types';
+import type { BackdropProps } from './types';
 export declare function withBackdrop<Props>(Content: (props: Props) => React.JSX.Element, options?: BackdropProps): (props: Props) => React.JSX.Element;

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

@@ -1,3 +1,3 @@
 import React from 'react';
-import { BannerMessageProps } from './types';
+import type { BannerMessageProps } from './types';
 export declare function BannerMessage(props: BannerMessageProps): React.JSX.Element | null;

package/dist/types/components/InAppMessaging/BannerMessage/index.d.ts

@@ -1,2 +1,2 @@
 export { BannerMessage } from './BannerMessage';
-export { BannerMessageProps } from './types';
+export type { BannerMessageProps } from './types';

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

@@ -1,5 +1,5 @@
-import { BannerMessageCommonProps } from '@aws-amplify/ui-react-core-notifications';
-import { MessageOverrideStyle } from '../hooks';
+import type { BannerMessageCommonProps } from '@aws-amplify/ui-react-core-notifications';
+import type { MessageOverrideStyle } from '../hooks';
 type BannerMessageAlignment = 'left' | 'center' | 'right';
 export interface BannerMessageProps extends BannerMessageCommonProps<MessageOverrideStyle | undefined> {
     alignment?: BannerMessageAlignment;

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

@@ -1,3 +1,3 @@
 import * as React from 'react';
-import { CloseIconButtonProps } from './types';
+import type { CloseIconButtonProps } from './types';
 export declare function CloseIconButton({ className, dismissButtonLabel, onClick, style, ...rest }: CloseIconButtonProps): React.JSX.Element;

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

@@ -1,4 +1,4 @@
-import { ButtonProps } from '@aws-amplify/ui-react';
+import type { ButtonProps } from '@aws-amplify/ui-react';
 export interface CloseIconButtonProps extends ButtonProps {
     /**
      * @description

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

@@ -1,3 +1,3 @@
 import * as React from 'react';
-import { FullScreenMessageProps } from './types';
+import type { FullScreenMessageProps } from './types';
 export declare function FullScreenMessage(props: FullScreenMessageProps): React.JSX.Element | null;

package/dist/types/components/InAppMessaging/FullScreenMessage/index.d.ts

@@ -1,2 +1,2 @@
 export { FullScreenMessage } from './FullScreenMessage';
-export { FullScreenMessageProps } from './types';
+export type { FullScreenMessageProps } from './types';

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

@@ -1,4 +1,4 @@
-import { FullScreenMessageCommonProps } from '@aws-amplify/ui-react-core-notifications';
-import { MessageOverrideStyle } from '../hooks';
+import type { FullScreenMessageCommonProps } from '@aws-amplify/ui-react-core-notifications';
+import type { MessageOverrideStyle } from '../hooks';
 export interface FullScreenMessageProps extends FullScreenMessageCommonProps<MessageOverrideStyle | undefined> {
 }

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

@@ -1,5 +1,5 @@
 import React from 'react';
-import { InAppMessageDisplayProps } from './types';
+import type { InAppMessageDisplayProps } from './types';
 declare function InAppMessageDisplay({ components: overrideComponents, }: InAppMessageDisplayProps): React.JSX.Element;
 declare namespace InAppMessageDisplay {
     var BannerMessage: typeof import("../BannerMessage").BannerMessage;

package/dist/types/components/InAppMessaging/InAppMessageDisplay/handleMessageLinkAction.d.ts

@@ -1,3 +1,3 @@
-import { HandleMessageLinkAction } from '@aws-amplify/ui-react-core-notifications';
+import type { HandleMessageLinkAction } from '@aws-amplify/ui-react-core-notifications';
 declare const handleMessageLinkAction: HandleMessageLinkAction;
 export default handleMessageLinkAction;

package/dist/types/components/InAppMessaging/InAppMessageDisplay/index.d.ts

@@ -1,2 +1,2 @@
 export { default as InAppMessageDisplay } from './InAppMessageDisplay';
-export { MessageComponents } from './types';
+export type { MessageComponents } from './types';

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

@@ -1,7 +1,7 @@
-import { BannerMessageComponent, CarouselMessageComponent, FullScreenMessageComponent, ModalMessageComponent } from '@aws-amplify/ui-react-core-notifications';
-import { BannerMessageProps } from '../BannerMessage';
-import { FullScreenMessageProps } from '../FullScreenMessage';
-import { ModalMessageProps } from '../ModalMessage';
+import type { BannerMessageComponent, CarouselMessageComponent, FullScreenMessageComponent, ModalMessageComponent } from '@aws-amplify/ui-react-core-notifications';
+import type { BannerMessageProps } from '../BannerMessage';
+import type { FullScreenMessageProps } from '../FullScreenMessage';
+import type { ModalMessageProps } from '../ModalMessage';
 type BannerStyle = BannerMessageProps['style'];
 type CarouselStyle = any;
 type FullScreenStyle = FullScreenMessageProps['style'];

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

@@ -1,3 +1,3 @@
 import * as React from 'react';
-import { MessageLayoutProps } from './types';
+import type { MessageLayoutProps } from './types';
 export declare function MessageLayout({ body, buttonSize, hasRenderableImage, header, image, onClose, orientation, primaryButton, secondaryButton, styles, }: MessageLayoutProps): React.JSX.Element;

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

@@ -1,6 +1,6 @@
-import { MessageComponentBaseProps } from '@aws-amplify/ui-react-core-notifications';
-import { ButtonProps } from '@aws-amplify/ui-react';
-import { MessageComponentStyles, MessageOverrideStyle, UseMessageProps } from '../hooks';
+import type { MessageComponentBaseProps } from '@aws-amplify/ui-react-core-notifications';
+import type { ButtonProps } from '@aws-amplify/ui-react';
+import type { MessageComponentStyles, MessageOverrideStyle, UseMessageProps } from '../hooks';
 type MessageLayoutOrientation = 'horizontal' | 'vertical';
 export type MessageLayoutButtonModifier = 'dark' | 'light';
 export interface MessageLayoutProps extends Omit<MessageComponentBaseProps<MessageOverrideStyle>, 'style'>, Omit<UseMessageProps, 'shouldRenderMessage' | 'styles'> {

package/dist/types/components/InAppMessaging/MessageLayout/utils.d.ts

@@ -1,5 +1,5 @@
-import { MessageComponentStyles } from '../hooks/useMessageProps';
-import { MessageLayoutButtonModifier } from './types';
+import type { MessageComponentStyles } from '../hooks/useMessageProps';
+import type { MessageLayoutButtonModifier } from './types';
 /**
  * Utility for determining the class modifier for an In-App Messaging button
  * based on its background color

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

@@ -1,3 +1,3 @@
 import * as React from 'react';
-import { ModalMessageProps } from './types';
+import type { ModalMessageProps } from './types';
 export declare function ModalMessage(props: ModalMessageProps): React.JSX.Element | null;

package/dist/types/components/InAppMessaging/ModalMessage/index.d.ts

@@ -1,2 +1,2 @@
 export { ModalMessage } from './ModalMessage';
-export { ModalMessageProps } from './types';
+export type { ModalMessageProps } from './types';

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

@@ -1,4 +1,4 @@
-import { ModalMessageCommonProps } from '@aws-amplify/ui-react-core-notifications';
-import { MessageOverrideStyle } from '../hooks';
+import type { ModalMessageCommonProps } from '@aws-amplify/ui-react-core-notifications';
+import type { MessageOverrideStyle } from '../hooks';
 export interface ModalMessageProps extends ModalMessageCommonProps<MessageOverrideStyle | undefined> {
 }

package/dist/types/components/InAppMessaging/hooks/index.d.ts

@@ -1,2 +1,3 @@
 export { useMessageImage } from './useMessageImage';
-export { MessageComponentStyles, MessageOverrideStyle, useMessageProps, UseMessageProps, } from './useMessageProps';
+export type { MessageComponentStyles, MessageOverrideStyle, UseMessageProps, } from './useMessageProps';
+export { useMessageProps } from './useMessageProps';

package/dist/types/components/InAppMessaging/hooks/useMessageImage/useMessageImage.d.ts

@@ -1,5 +1,5 @@
-import { InAppMessageImage } from '@aws-amplify/ui-react-core-notifications';
-import { UseMessageImage } from './types';
+import type { InAppMessageImage } from '@aws-amplify/ui-react-core-notifications';
+import type { UseMessageImage } from './types';
 /**
  * Handles prefetching for message images
  *

package/dist/types/components/InAppMessaging/hooks/useMessageProps/index.d.ts

@@ -1,2 +1,2 @@
 export { default as useMessageProps } from './useMessageProps';
-export { MessageComponentStyles, MessageOverrideStyle, UseMessageProps, } from './types';
+export type { MessageComponentStyles, MessageOverrideStyle, UseMessageProps, } from './types';

package/dist/types/components/InAppMessaging/hooks/useMessageProps/types.d.ts

@@ -1,4 +1,4 @@
-import { MessagePayloadStyle } from '@aws-amplify/ui-react-core-notifications';
+import type { MessagePayloadStyle } from '@aws-amplify/ui-react-core-notifications';
 /**
  * Inline style props for message components. Can be overridden by customer
  */

package/dist/types/components/InAppMessaging/hooks/useMessageProps/useMessageProps.d.ts

@@ -1,5 +1,5 @@
-import { MessageComponentBaseProps } from '@aws-amplify/ui-react-core-notifications';
-import { MessageOverrideStyle, UseMessageProps } from './types';
+import type { MessageComponentBaseProps } from '@aws-amplify/ui-react-core-notifications';
+import type { MessageOverrideStyle, UseMessageProps } from './types';
 /**
  * Handle common message UI component prop logic including render booleans, and
  * style resolving

package/dist/types/components/InAppMessaging/hooks/useMessageProps/utils.d.ts

@@ -1,5 +1,5 @@
-import { MessageComponentBaseProps, MessagePayloadStyle } from '@aws-amplify/ui-react-core-notifications';
-import { MessageComponentStyles, MessageStyleParams } from './types';
+import type { MessageComponentBaseProps, MessagePayloadStyle } from '@aws-amplify/ui-react-core-notifications';
+import type { MessageComponentStyles, MessageStyleParams } from './types';
 /**
  * Utility for extracting message payload style
  *

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

@@ -1,6 +1,8 @@
-export { InAppMessage, InAppMessageAction, InAppMessageButton, InAppMessageContent, InAppMessageImage, InAppMessageLayout, InAppMessagingProvider, InAppMessageStyle, InAppMessageTextAlign, useInAppMessaging, } from '@aws-amplify/ui-react-core-notifications';
-export { BannerMessageProps } from './BannerMessage';
-export { FullScreenMessageProps } from './FullScreenMessage';
-export { InAppMessageDisplay, MessageComponents } from './InAppMessageDisplay';
-export { ModalMessageProps } from './ModalMessage';
+export type { InAppMessage, InAppMessageAction, InAppMessageButton, InAppMessageContent, InAppMessageImage, InAppMessageLayout, InAppMessageStyle, InAppMessageTextAlign, } from '@aws-amplify/ui-react-core-notifications';
+export { InAppMessagingProvider, useInAppMessaging, } from '@aws-amplify/ui-react-core-notifications';
+export type { BannerMessageProps } from './BannerMessage';
+export type { FullScreenMessageProps } from './FullScreenMessage';
+export type { MessageComponents } from './InAppMessageDisplay';
+export { InAppMessageDisplay } from './InAppMessageDisplay';
+export type { ModalMessageProps } from './ModalMessage';
 export { withInAppMessaging } from './withInAppMessaging';

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

@@ -1,5 +1,5 @@
 import React from 'react';
-import { MessageComponents } from '../InAppMessageDisplay';
+import type { MessageComponents } from '../InAppMessageDisplay';
 export default function withInAppMessaging<Props = {}>(Component: React.ComponentType<Props>, options?: {
     components?: MessageComponents;
 }): (props: Props) => React.JSX.Element;

package/dist/types/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "2.2.8";
+export declare const VERSION = "2.2.9";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/ui-react-notifications",
-  "version": "2.2.8",
+  "version": "2.2.9",
   "main": "dist/index.js",
   "module": "dist/esm/index.mjs",
   "exports": {
@@ -39,10 +39,10 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@aws-amplify/ui": "6.10.2",
-    "@aws-amplify/ui-react": "6.11.1",
-    "@aws-amplify/ui-react-core": "3.4.2",
-    "@aws-amplify/ui-react-core-notifications": "2.2.8",
+    "@aws-amplify/ui": "6.10.3",
+    "@aws-amplify/ui-react": "6.11.2",
+    "@aws-amplify/ui-react-core": "3.4.3",
+    "@aws-amplify/ui-react-core-notifications": "2.2.9",
     "tinycolor2": "1.4.2"
   },
   "peerDependencies": {