Provide type def for AuthClass returned from withSSRContext

[jeferson-sb]

Before opening, please confirm:

• I have searched for duplicate or closed issues and discussions.
• I have read the guide for submitting bug reports.
• I have done my best to include a minimal, self-contained set of instructions for consistently reproducing the issue.

JavaScript Framework

Next.js

Amplify APIs

Authentication

Amplify Categories

auth

Environment information

# Put output below this line
Next.js 12.1.6
React 18.1.0
aws-amplify 4.3.24
node 16.15

Describe the bug

When I use the withSSRContext function I don't get any type definitions from the AuthClass object returned, so I don't know which methods to call when using the Auth module.

When I tried to inspect the type def of withSSRContext this is what I get:

Expected behavior

The method withSSRContext should return an object with type definitions for most modules/classes.

Reproduction steps

• npm i aws-amplify@^4.3.24 [email protected] [email protected] [email protected]
• Add the follwing to any page with serverSideProps

import { withSSRContext } from 'aws-amplify'
const { Auth } = withSSRContext({ req })

Code Snippet

// Put your code below this line.
const { Auth } = withSSRContext({ req })
const user = await Auth.currentAuthenticatedUser()

Log output

// Put your logs below this line

aws-exports.js

No response

Manual configuration

No response

Additional configuration

No response

Mobile Device

No response

Mobile Operating System

No response

Mobile Browser

No response

Mobile Browser Version

No response

Additional information and screenshots

No response

[chrisbonifacio]

Hi @jeferson-sb 👋 Thanks for opening this issue. I was able to reproduce it consistently and have labeled it a bug for the JS team. I will note that the team is actively working on improving TypeScript support so this is very helpful to document and track what exactly needs improvement.

[amehi0index]

Hi @jeferson-sb,

To use the AuthClass type on the Auth provided by the withSSRContext utility, you can implement the following workaround solution from @quinnturner found here: #7426

import { withSSRContext } from "aws-amplify";
import { Auth } from '@aws-amplify/auth';

export const getServerSideProps: GetServerSideProps = async (ctx) => {
  const auth = withSSRContext(ctx).Auth as typeof Auth;

  let user: any;
  try {
    user = await auth.currentAuthenticatedUser();
    console.log('user is authenticated');
    // fetch some data and assign it to the data variable
  } catch (err) {
    console.log('error: no authenticated user');
  }
};

[jeferson-sb]

@amehi0index Thanks, that works!

[tannerabread]

Going to close this as a duplicate of #7426