@aws-amplify/ui-react-native 1.2.19 → 1.2.20

package/CHANGELOG.md

@@ -1,5 +1,16 @@
 # @aws-amplify/ui-react-native
 
+## 1.2.20
+
+### Patch Changes
+
+- [#4168](https://github.com/aws-amplify/amplify-ui/pull/4168) [`d930e2ed1`](https://github.com/aws-amplify/amplify-ui/commit/d930e2ed17f3e638e2b62699ba2dd164b32f8118) Thanks [@calebpollman](https://github.com/calebpollman)! - chore(RWA/RNA): deprecate passwordSettings prop
+
+- Updated dependencies [[`b0e16e78c`](https://github.com/aws-amplify/amplify-ui/commit/b0e16e78c6a41945aa79f3e14fa3f9e6cb0e5e76), [`d930e2ed1`](https://github.com/aws-amplify/amplify-ui/commit/d930e2ed17f3e638e2b62699ba2dd164b32f8118)]:
+  - @aws-amplify/ui@5.6.6
+  - @aws-amplify/ui-react-core@2.1.25
+  - @aws-amplify/ui-react-core-notifications@1.0.2
+
 ## 1.2.19
 
 ### Patch Changes

package/dist/Authenticator/Authenticator.js

@@ -2,6 +2,7 @@ import React, { useMemo } from 'react';
 import { SafeAreaProvider } from 'react-native-safe-area-context';
 import { AuthenticatorProvider as Provider, resolveAuthenticatorComponents, useAuthenticator, useAuthenticatorRoute, useAuthenticatorInitMachine, } from '@aws-amplify/ui-react-core';
 import { configureComponent } from '@aws-amplify/ui';
+import { useDeprecationWarning } from '../hooks';
 import { DefaultContainer, InnerContainer } from './common';
 import { getRouteTypedFields } from './hooks';
 import { VERSION } from '../version';
@@ -23,6 +24,10 @@ const routePropSelector = ({ route, }) => [
     route,
 ];
 function Authenticator({ children, components: overrides, Container = DefaultContainer, Footer, Header, ...options }) {
+    useDeprecationWarning({
+        message: 'The `passwordSettings` prop has been deprecated and will be removed in a future major version of Amplify UI.',
+        shouldWarn: !!options?.passwordSettings,
+    });
     React.useEffect(() => {
         configureComponent({
             packageName: '@aws-amplify/ui-react-native',

package/dist/hooks/index.d.ts

@@ -1,2 +1,3 @@
+export { useDeprecationWarning } from './useDeprecationWarning';
 export { DeviceOrientation, useDeviceOrientation, } from './useDeviceOrientation';
 export { usePressableContainerStyles } from './usePressableContainerStyles';

package/dist/hooks/index.js

@@ -1,2 +1,3 @@
+export { useDeprecationWarning } from './useDeprecationWarning';
 export { useDeviceOrientation, } from './useDeviceOrientation';
 export { usePressableContainerStyles } from './usePressableContainerStyles';

package/dist/hooks/useDeprecationWarning/index.d.ts

@@ -0,0 +1 @@
+export { default as useDeprecationWarning } from './useDeprecationWarning';

package/dist/hooks/useDeprecationWarning/index.js

@@ -0,0 +1 @@
+export { default as useDeprecationWarning } from './useDeprecationWarning';

package/dist/hooks/useDeprecationWarning/useDeprecationWarning.d.ts

@@ -0,0 +1,6 @@
+import { UseDeprecationWarning } from '@aws-amplify/ui-react-core';
+/**
+ * Logs a deprecation warning `message` to the console.
+ */
+declare const useDeprecationWarning: UseDeprecationWarning;
+export default useDeprecationWarning;

package/dist/hooks/useDeprecationWarning/useDeprecationWarning.js

@@ -0,0 +1,11 @@
+import { useDeprecationWarning as useDeprecationWarningBase, } from '@aws-amplify/ui-react-core';
+import { platform } from '../../utils';
+/**
+ * Logs a deprecation warning `message` to the console.
+ */
+const useDeprecationWarning = ({ message, shouldWarn: _shouldWarn, }) => {
+    // only log warnings in dev
+    const shouldWarn = _shouldWarn && platform.IS_DEV;
+    useDeprecationWarningBase({ message, shouldWarn });
+};
+export default useDeprecationWarning;

package/dist/utils/platform.d.ts

@@ -1,5 +1,6 @@
 declare const _default: {
     IS_ANDROID: boolean;
+    IS_DEV: boolean;
     IS_IOS: boolean;
     PLATFORM_TOUCH_TARGET: number | undefined;
     constants: import("react-native").PlatformConstants & {
@@ -41,6 +42,7 @@ declare const _default: {
     }): T_1 | undefined;
 } | {
     IS_ANDROID: boolean;
+    IS_DEV: boolean;
     IS_IOS: boolean;
     PLATFORM_TOUCH_TARGET: number | undefined;
     constants: import("react-native").PlatformConstants & {
@@ -85,6 +87,7 @@ declare const _default: {
     }): T_1 | undefined;
 } | {
     IS_ANDROID: boolean;
+    IS_DEV: boolean;
     IS_IOS: boolean;
     PLATFORM_TOUCH_TARGET: number | undefined;
     OS: "windows";
@@ -121,6 +124,7 @@ declare const _default: {
     }): T_1 | undefined;
 } | {
     IS_ANDROID: boolean;
+    IS_DEV: boolean;
     IS_IOS: boolean;
     PLATFORM_TOUCH_TARGET: number | undefined;
     OS: "macos";
@@ -157,6 +161,7 @@ declare const _default: {
     }): T_1 | undefined;
 } | {
     IS_ANDROID: boolean;
+    IS_DEV: boolean;
     IS_IOS: boolean;
     PLATFORM_TOUCH_TARGET: number | undefined;
     OS: "web";

package/dist/utils/platform.js

@@ -1,4 +1,5 @@
 import { Platform } from 'react-native';
+const IS_DEV = __DEV__;
 const IS_ANDROID = Platform.OS === 'android';
 const IS_IOS = Platform.OS === 'ios';
 // https://material.io/design/layout/spacing-methods.html#touch-targets
@@ -12,6 +13,7 @@ const PLATFORM_TOUCH_TARGET = Platform.select({
 export default {
     ...Platform,
     IS_ANDROID,
+    IS_DEV,
     IS_IOS,
     PLATFORM_TOUCH_TARGET,
 };

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "1.2.19";
+export declare const VERSION = "1.2.20";

package/dist/version.js

@@ -1 +1 @@
-export const VERSION = '1.2.19';
+export const VERSION = '1.2.20';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/ui-react-native",
-  "version": "1.2.19",
+  "version": "1.2.20",
   "main": "dist/index.js",
   "module": "dist/esm/index.js",
   "types": "dist/index.d.ts",
@@ -29,6 +29,7 @@
     "@types/react-test-renderer": "^17.0.1",
     "babel-jest": "^28.0.3",
     "eslint": "^8.14.0",
+    "jest": "^27.0.4",
     "metro-react-native-babel-preset": "^0.70.2",
     "react": "^17.0.2",
     "react-native": "^0.68.1",
@@ -37,9 +38,9 @@
     "rimraf": "^3.0.2"
   },
   "dependencies": {
-    "@aws-amplify/ui": "5.6.5",
-    "@aws-amplify/ui-react-core": "2.1.24",
-    "@aws-amplify/ui-react-core-notifications": "1.0.1"
+    "@aws-amplify/ui": "5.6.6",
+    "@aws-amplify/ui-react-core": "2.1.25",
+    "@aws-amplify/ui-react-core-notifications": "1.0.2"
   },
   "peerDependencies": {
     "aws-amplify": ">= 5.0.1",

package/src/Authenticator/Authenticator.tsx

@@ -13,6 +13,7 @@ import {
 
 import { configureComponent } from '@aws-amplify/ui';
 
+import { useDeprecationWarning } from '../hooks';
 import { DefaultContainer, InnerContainer } from './common';
 import { TypedField, getRouteTypedFields } from './hooks';
 import { AuthenticatorProps } from './types';
@@ -61,6 +62,12 @@ function Authenticator({
   Header,
   ...options
 }: AuthenticatorProps): JSX.Element | null {
+  useDeprecationWarning({
+    message:
+      'The `passwordSettings` prop has been deprecated and will be removed in a future major version of Amplify UI.',
+    shouldWarn: !!options?.passwordSettings,
+  });
+
   React.useEffect(() => {
     configureComponent({
       packageName: '@aws-amplify/ui-react-native',

package/src/hooks/index.ts

@@ -1,3 +1,4 @@
+export { useDeprecationWarning } from './useDeprecationWarning';
 export {
   DeviceOrientation,
   useDeviceOrientation,

package/src/hooks/useDeprecationWarning/__tests__/useDeprecationWarning.spec.ts

@@ -0,0 +1,42 @@
+import { renderHook } from '@testing-library/react-hooks';
+
+import { platform } from '../../../utils';
+import useDeprecationWarning from '../useDeprecationWarning';
+
+const mockIsDev = jest.fn();
+jest.mock('../../../utils', () => ({
+  ...jest.requireActual('../../../utils'),
+  IS_DEV: mockIsDev,
+}));
+
+// add empty mockImplementation to prevent logging output to the console
+const consoleWarnSpy = jest.spyOn(console, 'warn').mockImplementation();
+
+const message = 'This component is deprecated, use X instead';
+const shouldWarn = true;
+
+describe('useDeprecationWarning', () => {
+  beforeAll(() => {
+    platform.IS_DEV = true;
+  });
+
+  beforeEach(() => {
+    consoleWarnSpy.mockClear();
+  });
+
+  it('should log an error if `shouldWarn` is set to `true` and `__DEV__` is `true`', () => {
+    renderHook(() => useDeprecationWarning({ shouldWarn, message }));
+    expect(consoleWarnSpy).toHaveBeenCalledTimes(1);
+    expect(consoleWarnSpy).toHaveBeenCalledWith(message);
+  });
+
+  it('should not log an error if `shouldWarn` is set to `true` and `__DEV__` is `false`', () => {
+    const message = 'This component is deprecated, use X instead';
+
+    platform.IS_DEV = false;
+
+    renderHook(() => useDeprecationWarning({ shouldWarn, message }));
+    expect(consoleWarnSpy).toHaveBeenCalledTimes(0);
+    expect(consoleWarnSpy).not.toHaveBeenCalledWith(message);
+  });
+});

package/src/hooks/useDeprecationWarning/index.ts

@@ -0,0 +1 @@
+export { default as useDeprecationWarning } from './useDeprecationWarning';

package/src/hooks/useDeprecationWarning/useDeprecationWarning.ts

@@ -0,0 +1,21 @@
+import {
+  useDeprecationWarning as useDeprecationWarningBase,
+  UseDeprecationWarning,
+} from '@aws-amplify/ui-react-core';
+
+import { platform } from '../../utils';
+
+/**
+ * Logs a deprecation warning `message` to the console.
+ */
+const useDeprecationWarning: UseDeprecationWarning = ({
+  message,
+  shouldWarn: _shouldWarn,
+}): void => {
+  // only log warnings in dev
+  const shouldWarn = _shouldWarn && platform.IS_DEV;
+
+  useDeprecationWarningBase({ message, shouldWarn });
+};
+
+export default useDeprecationWarning;

package/src/utils/platform.ts

@@ -1,5 +1,6 @@
 import { Platform } from 'react-native';
 
+const IS_DEV = __DEV__;
 const IS_ANDROID = Platform.OS === 'android';
 const IS_IOS = Platform.OS === 'ios';
 
@@ -16,6 +17,7 @@ const PLATFORM_TOUCH_TARGET = Platform.select({
 export default {
   ...Platform,
   IS_ANDROID,
+  IS_DEV,
   IS_IOS,
   PLATFORM_TOUCH_TARGET,
 };

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.2.19';
+export const VERSION = '1.2.20';