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

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

@@ -1,14 +1,19 @@
 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;
+type ContextOptions<ContextType, ContextName extends string> = {
+    contextName: ContextName;
+} & (// exclude `errorMessage` if `defaultValue` is present
+{
     defaultValue: ContextType;
-};
-type OptionsWithErrorMessage = {
-    contextName: string;
+    errorMessage?: never;
+} | {
     errorMessage: string;
+    defaultValue?: never;
+});
+type UtilityKey<ContextName extends string> = `${ContextName}Provider` | `use${ContextName}` | `${ContextName}Context`;
+type CreateContextUtilitiesReturn<ContextType, ContextName extends string> = {
+    [Key in UtilityKey<ContextName>]: Key extends `${string}Provider` ? React.ComponentType<React.PropsWithChildren<Partial<ContextType>>> : Key extends `use${string}` ? () => ContextType : Key extends `${string}Context` ? React.Context<ContextType | undefined> : never;
 };
-type ContextOptions<ContextType extends {}> = OptionsWithDefaultValue<ContextType> | OptionsWithErrorMessage;
 /**
  * Use a `ContextType` generic and `options` to create:
  * - `Context`: React Context of type `ContextType`
@@ -18,7 +23,7 @@ type ContextOptions<ContextType extends {}> = OptionsWithDefaultValue<ContextTyp
  *
  * @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
+ * preference of explicit `undefined` to avoid optional types on the
  * Utility Hook return
  *
  * @param options Context utility options. Requires a `contextName`, and either
@@ -39,21 +44,17 @@ type ContextOptions<ContextType extends {}> = OptionsWithDefaultValue<ContextTyp
  * }
  *
  * // with `defaultValue`
- * const [StuffProvider, useStuff] = createContextUtilities<StuffContextType>({
+ * const { StuffProvider, useStuff } = createContextUtilities<StuffContextType>({
  *   contextName: 'Stuff',
  *   defaultValue: { things: 7 }
  * });
  *
  * // with `errorMessage`
- * const [StuffProvider, useStuff] = createContextUtilities<StuffContextType>({
+ * 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 default function createContextUtilities<ContextType, ContextName extends string = string>(options: ContextOptions<ContextType, ContextName>): CreateContextUtilitiesReturn<ContextType, ContextName>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/ui-react-core",
-  "version": "2.1.31",
+  "version": "2.1.32",
   "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.2",
+    "@aws-amplify/ui": "5.8.0",
     "@xstate/react": "3.0.1",
     "lodash": "4.17.21",
     "xstate": "^4.33.6"