chore(types): expose CodeDeliveryDetails, HubCapsule types (#12501)

* chore(types): expose CodeDeliveryDetails, HubCapsule types * resolve conflicts --------- Co-authored-by: Ashwin Kumar <[email protected]> Co-authored-by: erinleigh90 <[email protected]>
aws-amplify · Nov 3, 2023 · 3ae78c7 · 3ae78c7
1 parent e1d88c2
commit 3ae78c7
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 3 deletions.
diff --git a/packages/auth/src/index.ts b/packages/auth/src/index.ts
@@ -30,6 +30,9 @@ export {
 	fetchDevices,
 	autoSignIn,
 	AuthUser,
+	CodeDeliveryDetails,
+	UserAttributeKey,
+	VerifiableUserAttributeKey,
 } from './providers/cognito';
 
 export {

diff --git a/packages/auth/src/providers/cognito/index.ts b/packages/auth/src/providers/cognito/index.ts
@@ -47,7 +47,6 @@ export {
 	DeleteUserAttributesInput,
 	ForgetDeviceInput,
 } from './types/inputs';
-
 export {
 	FetchUserAttributesOutput,
 	GetCurrentUserOutput,
@@ -64,7 +63,12 @@ export {
 	SendUserAttributeVerificationCodeOutput,
 	FetchDevicesOutput,
 } from './types/outputs';
-export { AuthUser } from './types/models';
+export {
+	AuthUser,
+	CodeDeliveryDetails,
+	UserAttributeKey,
+	VerifiableUserAttributeKey,
+} from './types/models';
 export {
 	cognitoCredentialsProvider,
 	CognitoAWSCredentialsAndIdentityIdProvider,

diff --git a/packages/auth/src/providers/cognito/types/index.ts b/packages/auth/src/providers/cognito/types/index.ts
@@ -11,6 +11,7 @@ export {
 	AWSAuthDevice,
 	AuthUser,
 	CognitoAuthSignInDetails,
+	CodeDeliveryDetails,
 } from './models';
 
 export {

diff --git a/packages/auth/src/providers/cognito/types/models.ts b/packages/auth/src/providers/cognito/types/models.ts
@@ -5,7 +5,14 @@ import {
 	AuthStandardAttributeKey,
 	AuthVerifiableAttributeKey,
 } from '@aws-amplify/core/internals/utils';
-import { AuthUserAttribute, AuthDevice, AWSAuthUser } from '../../../types';
+
+import {
+	AuthUserAttribute,
+	AuthDevice,
+	AWSAuthUser,
+	AuthCodeDeliveryDetails,
+} from '../../../types';
+
 import { AuthProvider } from '../../../types/inputs';
 import { SignUpOutput } from './outputs';
 
@@ -95,3 +102,10 @@ export type CognitoAuthSignInDetails = {
 export interface AuthUser extends AWSAuthUser {
 	signInDetails?: CognitoAuthSignInDetails;
 }
+
+/**
+ * Holds data describing the dispatch of a confirmation code.
+ */
+export type CodeDeliveryDetails<
+	CognitoUserAttributeKey extends UserAttributeKey = UserAttributeKey
+> = AuthCodeDeliveryDetails<CognitoUserAttributeKey>;
diff --git a/packages/aws-amplify/src/utils/index.ts b/packages/aws-amplify/src/utils/index.ts
@@ -6,6 +6,7 @@ This file maps exports from `aws-amplify/utils`.
 */
 export {
 	Hub,
+	HubCapsule,
 	I18n,
 	Cache,
 	ConsoleLogger,
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,6 +6,7 @@ This file maps exports from `aws-amplify/utils`. @@
     */
     export {
     	Hub,
+    	HubCapsule,
     	I18n,
     	Cache,
     	ConsoleLogger,
@@ Expand Down @@