@aws-amplify/core 5.8.18 → 5.8.19

package/src/Util/Constants.ts

@@ -2,12 +2,47 @@
 // SPDX-License-Identifier: Apache-2.0
 
 // Logging constants
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 const AWS_CLOUDWATCH_BASE_BUFFER_SIZE = 26;
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 const AWS_CLOUDWATCH_MAX_BATCH_EVENT_SIZE = 1048576;
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 const AWS_CLOUDWATCH_MAX_EVENT_SIZE = 256000;
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 const AWS_CLOUDWATCH_CATEGORY = 'Logging';
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 const AWS_CLOUDWATCH_PROVIDER_NAME = 'AWSCloudWatch';
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 const NO_CREDS_ERROR_STRING = 'No credentials';
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 const RETRY_ERROR_CODES = [
 	'ResourceNotFoundException',
 	'InvalidSequenceTokenException',

package/src/Util/DateUtils.ts

@@ -11,6 +11,11 @@
 
 const FIVE_MINUTES_IN_MS = 1000 * 60 * 5;
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export const DateUtils = {
 	/**
 	 * Milliseconds to offset the date to compensate for clock skew between device & services

package/src/Util/Mutex.ts

@@ -42,6 +42,11 @@ namespace MutexInterface {
 	}
 }
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 class Mutex implements MutexInterface {
 	isLocked(): boolean {
 		return this._pending;

package/src/Util/Reachability.ts

@@ -7,6 +7,11 @@ type NetworkStatus = {
 	online: boolean;
 };
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export default class ReachabilityNavigator implements Reachability {
 	private static _observers: Array<
 		ZenObservable.SubscriptionObserver<NetworkStatus>

package/src/Util/Retry.ts

@@ -4,6 +4,11 @@ import { DelayFunction } from '../types';
 import { ConsoleLogger as Logger } from '../Logger/ConsoleLogger';
 const logger = new Logger('Util');
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export class NonRetryableError extends Error {
 	public readonly nonRetryable = true;
 	constructor(message: string) {
@@ -11,6 +16,11 @@ export class NonRetryableError extends Error {
 	}
 }
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export const isNonRetryableError = (obj: any): obj is NonRetryableError => {
 	const key: keyof NonRetryableError = 'nonRetryable';
 	return obj && obj[key];
@@ -19,6 +29,9 @@ export const isNonRetryableError = (obj: any): obj is NonRetryableError => {
 /**
  * @private
  * Internal use of Amplify only
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
  */
 export async function retry<T>(
 	functionToRetry: (...args: any[]) => T,
@@ -95,6 +108,9 @@ const MAX_DELAY_MS = 5 * 60 * 1000;
 /**
  * @private
  * Internal use of Amplify only
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
  */
 export function jitteredBackoff(
 	maxDelayMs: number = MAX_DELAY_MS
@@ -111,6 +127,9 @@ export function jitteredBackoff(
 /**
  * @private
  * Internal use of Amplify only
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
  */
 export const jitteredExponentialRetry = <T>(
 	functionToRetry: (...args: any[]) => T,

package/src/Util/StringUtils.ts

@@ -1,5 +1,10 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export function urlSafeEncode(str: string) {
 	return str
 		.split('')
@@ -12,6 +17,11 @@ export function urlSafeEncode(str: string) {
 		.join('');
 }
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export function urlSafeDecode(hex: string) {
 	return hex
 		.match(/.{2}/g)

package/src/constants.ts

@@ -8,8 +8,18 @@
 const hasSymbol =
 	typeof Symbol !== 'undefined' && typeof Symbol.for === 'function';
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export const INTERNAL_AWS_APPSYNC_REALTIME_PUBSUB_PROVIDER = hasSymbol
 	? Symbol.for('INTERNAL_AWS_APPSYNC_REALTIME_PUBSUB_PROVIDER')
 	: '@@INTERNAL_AWS_APPSYNC_REALTIME_PUBSUB_PROVIDER';
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export const USER_AGENT_HEADER = 'x-amz-user-agent';

package/src/index.ts

@@ -61,6 +61,11 @@ export {
 	USER_AGENT_HEADER,
 } from './constants';
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export const Constants = {
 	userAgent: Platform.userAgent,
 };

package/src/parseAWSExports.ts

@@ -5,6 +5,11 @@ import { ConsoleLogger as Logger } from './Logger';
 
 const logger = new Logger('Parser');
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export const parseAWSExports = (config): AmplifyConfig => {
 	const amplifyConfig: AmplifyConfig = {};
 	// Analytics

package/src/types/types.ts

@@ -17,6 +17,11 @@ export interface AmplifyConfig {
 	ssr?: boolean;
 }
 
+/**
+ * @deprecated Amplify JavaScript v5 is in maintenance mode. Upgrade to v6.
+ * See the migration guide:
+ * https://docs.amplify.aws/gen1/javascript/build-a-backend/troubleshooting/migrate-from-javascript-v5-to-v6/
+ */
 export interface ICredentials {
 	accessKeyId: string;
 	sessionToken: string;