@aws-amplify/ui-react-core 2.1.29 → 2.1.31

package/dist/esm/index.mjs

@@ -8,4 +8,3 @@ export { default as RenderNothing } from './components/RenderNothing/RenderNothi
 export { default as useDeprecationWarning } from './hooks/useDeprecationWarning.mjs';
 export { default as useHasValueUpdated } from './hooks/useHasValueUpdated.mjs';
 export { default as usePreviousValue } from './hooks/usePreviousValue.mjs';
-export { templateJoin } from './utils/index.mjs';

package/dist/index.js

@@ -528,15 +528,10 @@ function useHasValueUpdated(value, ignoreFirstRender = false) {
     return previous !== value;
 }
 
-function templateJoin(values, template) {
-    return values.reduce((acc, curr) => `${acc}${ui.isString(curr) ? template(curr) : ''}`, '');
-}
-
 exports.AuthenticatorProvider = AuthenticatorProvider;
 exports.RenderNothing = RenderNothing;
 exports.isAuthenticatorComponentRouteKey = isComponentRouteKey;
 exports.resolveAuthenticatorComponents = resolveAuthenticatorComponents;
-exports.templateJoin = templateJoin;
 exports.useAuthenticator = useAuthenticator;
 exports.useAuthenticatorInitMachine = useAuthenticatorInitMachine;
 exports.useAuthenticatorRoute = useAuthenticatorRoute;

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
 export { AuthenticatorComponentDefaults, AuthenticatorComponentDefaultProps, AuthenticatorComponentOverrides, AuthenticatorFooterComponent, AuthenticatorFormFieldsComponent, AuthenticatorHeaderComponent, AuthenticatorLegacyField, AuthenticatorMachineContext, AuthenticatorProvider, AuthenticatorRouteComponentKey, AuthenticatorRouteComponentName, isAuthenticatorComponentRouteKey, resolveAuthenticatorComponents, useAuthenticator, useAuthenticatorRoute, UseAuthenticator, useAuthenticatorInitMachine, UseAuthenticatorRoute, } from './Authenticator';
 export { RenderNothing } from './components';
 export { useDeprecationWarning, UseDeprecationWarning, useHasValueUpdated, usePreviousValue, } from './hooks';
-export { templateJoin } from './utils';
+export { MergeProps } from './types';

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

@@ -0,0 +1 @@
+export { MergeProps } from './types';

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

@@ -0,0 +1 @@
+export type MergeProps<C, P> = C & Omit<P, keyof C>;

package/dist/types/utils/createContextUtilities.d.ts

@@ -0,0 +1,59 @@
+import React from 'react';
+export declare const INVALID_OPTIONS_MESSAGE = "an `errorMessage` or a `defaultValue` must be provided in `options`";
+type OptionsWithDefaultValue<ContextType extends {}> = {
+    contextName: string;
+    defaultValue: ContextType;
+};
+type OptionsWithErrorMessage = {
+    contextName: string;
+    errorMessage: string;
+};
+type ContextOptions<ContextType extends {}> = OptionsWithDefaultValue<ContextType> | OptionsWithErrorMessage;
+/**
+ * Use a `ContextType` generic and `options` to create:
+ * - `Context`: React Context of type `ContextType`
+ * - `Provider`: React Context `Provider` component exposing the `ContextType`
+ *   as optional props
+ * - `useContext`: Utility Hook exposing the values of `ContextType`
+ *
+ * @template ContextType Type definition of the Context.
+ * > For most use cases the keys of `ContextType` should not be optional in
+ * preference of explicit `undefined` to avoid having optional types on the
+ * Utility Hook return
+ *
+ * @param options Context utility options. Requires a `contextName`, and either
+ * a `defaultValue` of `ContextType` or `errorMessage` allowing for differing
+ * behaviors of the Utility Hook when used outside a parent `Provider`:
+ *
+ * - `defaultValue`: Ensures the Utility Hook returns a default value for
+ *   scenarios **where the missing context values should not impact usage**
+ * - `errorMessage`: Ensures the Utility Hook throws an error for
+ *   scenarios **where the missing context values should prevent** usage
+ *
+ * @returns `Context`, `Provider` Component and `useContext` Utility Hook
+ *
+ * @usage
+ * ```ts
+ * interface StuffContextType {
+ *   things: number;
+ * }
+ *
+ * // with `defaultValue`
+ * const [StuffProvider, useStuff] = createContextUtilities<StuffContextType>({
+ *   contextName: 'Stuff',
+ *   defaultValue: { things: 7 }
+ * });
+ *
+ * // with `errorMessage`
+ * const [StuffProvider, useStuff] = createContextUtilities<StuffContextType>({
+ *   contextName: 'Stuff',
+ *   errorMessage: '`useStuff` must be used in a `StuffProvider`'
+ * });
+ * ```
+ */
+export default function createContextUtilities<ContextType extends {}>(options: ContextOptions<ContextType>): {
+    Provider: React.ComponentType<React.PropsWithChildren<Partial<ContextType>>>;
+    useContext: () => ContextType;
+    Context: React.Context<ContextType | undefined>;
+};
+export {};

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

@@ -1 +1 @@
-export declare function templateJoin(values: string[], template: (value: string) => string): string;
+export { default as createContextUtilities } from './createContextUtilities';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/ui-react-core",
-  "version": "2.1.29",
+  "version": "2.1.31",
   "main": "dist/index.js",
   "module": "dist/esm/index.mjs",
   "react-native": "dist/index.js",
@@ -31,7 +31,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@aws-amplify/ui": "5.7.0",
+    "@aws-amplify/ui": "5.7.2",
     "@xstate/react": "3.0.1",
     "lodash": "4.17.21",
     "xstate": "^4.33.6"

package/dist/esm/utils/index.mjs

@@ -1,7 +0,0 @@
-import { isString } from '@aws-amplify/ui';
-
-function templateJoin(values, template) {
-    return values.reduce((acc, curr) => `${acc}${isString(curr) ? template(curr) : ''}`, '');
-}
-
-export { templateJoin };