@aws-amplify/auth/src/providers/cognito/apis/rememberDevice.ts

Auth category of aws-amplify

// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
// SPDX-License-Identifier: Apache-2.0

import { AmplifyContext } from '@aws-amplify/core';
import {
	AuthAction,
	assertTokenProviderConfig,
	resolveCtxArgs,
} from '@aws-amplify/core/internals/utils';

import { assertAuthTokens, assertDeviceMetadata } from '../utils/types';
import { getRegionFromUserPoolId } from '../../../foundation/parsers';
import { resolveTokenOrchestrator } from '../tokenProvider';
import { UpdateDeviceStatusException } from '../../cognito/types/errors';
import { getAuthUserAgentValue } from '../../../utils';
import { createUpdateDeviceStatusClient } from '../../../foundation/factories/serviceClients/cognitoIdentityProvider';
import { createCognitoUserPoolEndpointResolver } from '../factories';

export async function rememberDevice(ctx: AmplifyContext): Promise<void>;

/**
 * Marks device as remembered while authenticated.
 *
 * @throws - {@link UpdateDeviceStatusException} - Cognito service errors thrown when
 * setting device status to remembered using an invalid device key.
 * @throws AuthTokenConfigException - Thrown when the token provider config is invalid.
 */
export async function rememberDevice(): Promise<void>;
export async function rememberDevice(...args: any[]): Promise<void> {
	const [ctx] = resolveCtxArgs<[]>(args);
	const authConfig = ctx.resourcesConfig.Auth?.Cognito;
	assertTokenProviderConfig(authConfig);
	const { userPoolEndpoint, userPoolId } = authConfig;
	const { tokens } = await ctx.fetchAuthSession();
	assertAuthTokens(tokens);

	const deviceMetadata =
		await resolveTokenOrchestrator(ctx).getDeviceMetadata();
	assertDeviceMetadata(deviceMetadata);
	const updateDeviceStatus = createUpdateDeviceStatusClient({
		endpointResolver: createCognitoUserPoolEndpointResolver({
			endpointOverride: userPoolEndpoint,
		}),
	});
	await updateDeviceStatus(
		{
			region: getRegionFromUserPoolId(userPoolId),
			userAgentValue: getAuthUserAgentValue(AuthAction.RememberDevice),
		},
		{
			AccessToken: tokens.accessToken.toString(),
			DeviceKey: deviceMetadata.deviceKey,
			DeviceRememberedStatus: 'remembered',
		},
	);
}