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

import { defaultStorage } from '@aws-amplify/core';

import { PINPOINT_KEY_PREFIX, STORAGE_KEY_SUFFIX } from '../utils';
import { InAppMessagingValidationErrorCode } from '../../../errors';
import { assertIsInitialized } from '../../../utils';

/**
 * Clear locally cached messages.
 *
 * @deprecated AWS will end support for Amazon Pinpoint on October 30, 2026.
 *
 * @throws validation: {@link InAppMessagingValidationErrorCode} - Thrown if In App messaging hasn't been initialized.
 * @returns A promise that will resolve when the operation is complete.
 * @example
 * ```ts
 * // Clear locally cached messages.
 * await clearMessages();
 *
 * ```
 */
export async function clearMessages(): Promise<void> {
	assertIsInitialized();
	const key = `${PINPOINT_KEY_PREFIX}${STORAGE_KEY_SUFFIX}`;

	await defaultStorage.removeItem(key);
}