@aws-amplify/datastore 5.0.32 → 5.0.33-s-auth.30d0cd2.0

package/src/util.ts

@@ -1,40 +1,41 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { monotonicFactory, ULID } from 'ulid';
+import { ULID, monotonicFactory } from 'ulid';
 import {
-	amplifyUuid,
 	AmplifyUrl,
 	WordArray,
+	amplifyUuid,
 } from '@aws-amplify/core/internals/utils';
-import { produce, applyPatches, Patch } from 'immer';
+import { Patch, applyPatches, produce } from 'immer';
+
 import { ModelInstanceCreator } from './datastore/datastore';
 import {
 	AllOperators,
-	isPredicateGroup,
-	isPredicateObj,
+	DeferredCallbackResolverOptions,
+	IndexesType,
+	LimitTimerRaceResolvedValues,
+	ModelAssociation,
+	ModelAttribute,
+	ModelAttributes,
+	ModelKeys,
+	NonModelTypeConstructor,
+	PaginationInput,
 	PersistentModel,
 	PersistentModelConstructor,
 	PredicateGroups,
 	PredicateObject,
 	PredicatesGroup,
-	RelationshipType,
 	RelationType,
-	ModelKeys,
-	ModelAttributes,
+	RelationshipType,
+	SchemaModel,
 	SchemaNamespace,
-	SortPredicatesGroup,
 	SortDirection,
+	SortPredicatesGroup,
+	isModelAttributeCompositeKey,
 	isModelAttributeKey,
 	isModelAttributePrimaryKey,
-	isModelAttributeCompositeKey,
-	NonModelTypeConstructor,
-	PaginationInput,
-	DeferredCallbackResolverOptions,
-	LimitTimerRaceResolvedValues,
-	SchemaModel,
-	ModelAttribute,
-	IndexesType,
-	ModelAssociation,
+	isPredicateGroup,
+	isPredicateObj,
 } from './types';
 import { ModelSortPredicateCreator } from './predicates';
 
@@ -73,14 +74,14 @@ export enum NAMESPACES {
 	STORAGE = 'storage',
 }
 
-const DATASTORE = NAMESPACES.DATASTORE;
-const USER = NAMESPACES.USER;
-const SYNC = NAMESPACES.SYNC;
-const STORAGE = NAMESPACES.STORAGE;
+const { DATASTORE } = NAMESPACES;
+const { USER } = NAMESPACES;
+const { SYNC } = NAMESPACES;
+const { STORAGE } = NAMESPACES;
 
 export { USER, SYNC, STORAGE, DATASTORE };
 
-export const exhaustiveCheck = (obj: never, throwOnError: boolean = true) => {
+export const exhaustiveCheck = (obj: never, throwOnError = true) => {
 	if (throwOnError) {
 		throw new Error(`Invalid ${obj}`);
 	}
@@ -127,6 +128,7 @@ export const validatePredicate = <T extends PersistentModel>(
 
 		if (isPredicateGroup(predicateOrGroup)) {
 			const { type, predicates } = predicateOrGroup;
+
 			return validatePredicate(model, type, predicates);
 		}
 
@@ -154,23 +156,26 @@ export const validatePredicateField = <T>(
 			return value >= operand;
 		case 'gt':
 			return value > operand;
-		case 'between':
-			const [min, max] = <[T, T]>operand;
+		case 'between': {
+			const [min, max] = operand as [T, T];
+
 			return value >= min && value <= max;
+		}
 		case 'beginsWith':
 			return (
 				!isNullOrUndefined(value) &&
-				(<string>(<unknown>value)).startsWith(<string>(<unknown>operand))
+				(value as unknown as string).startsWith(operand as unknown as string)
 			);
 		case 'contains':
 			return (
 				!isNullOrUndefined(value) &&
-				(<string>(<unknown>value)).indexOf(<string>(<unknown>operand)) > -1
+				(value as unknown as string).indexOf(operand as unknown as string) > -1
 			);
 		case 'notContains':
 			return (
 				isNullOrUndefined(value) ||
-				(<string>(<unknown>value)).indexOf(<string>(<unknown>operand)) === -1
+				(value as unknown as string).indexOf(operand as unknown as string) ===
+					-1
 			);
 		default:
 			return false;
@@ -181,7 +186,7 @@ export const isModelConstructor = <T extends PersistentModel>(
 	obj: any,
 ): obj is PersistentModelConstructor<T> => {
 	return (
-		obj && typeof (<PersistentModelConstructor<T>>obj).copyOf === 'function'
+		obj && typeof (obj as PersistentModelConstructor<T>).copyOf === 'function'
 	);
 };
 
@@ -220,7 +225,9 @@ export const traverseModel = <T extends PersistentModel>(
 		instance: T;
 	}[] = [];
 
-	const newInstance = modelConstructor.copyOf(instance, () => {});
+	const newInstance = modelConstructor.copyOf(instance, () => {
+		// no-op
+	});
 
 	result.unshift({
 		modelName: srcModelName,
@@ -251,6 +258,7 @@ let privateModeCheckResult;
 export const isPrivateMode = () => {
 	return new Promise(resolve => {
 		const dbname = amplifyUuid();
+		// eslint-disable-next-line prefer-const
 		let db;
 
 		const isPrivate = () => {
@@ -268,7 +276,7 @@ export const isPrivateMode = () => {
 
 			privateModeCheckResult = true;
 
-			return resolve(false);
+			resolve(false);
 		};
 
 		if (privateModeCheckResult === true) {
@@ -276,10 +284,16 @@ export const isPrivateMode = () => {
 		}
 
 		if (privateModeCheckResult === false) {
-			return isPrivate();
+			isPrivate();
+
+			return;
 		}
 
-		if (indexedDB === null) return isPrivate();
+		if (indexedDB === null) {
+			isPrivate();
+
+			return;
+		}
 
 		db = indexedDB.open(dbname);
 		db.onerror = isPrivate;
@@ -313,19 +327,23 @@ export const isSafariCompatabilityMode: () => Promise<boolean> = async () => {
 
 		const db: IDBDatabase | false = await new Promise(resolve => {
 			const dbOpenRequest = indexedDB.open(dbName);
-			dbOpenRequest.onerror = () => resolve(false);
+			dbOpenRequest.onerror = () => {
+				resolve(false);
+			};
 
 			dbOpenRequest.onsuccess = () => {
-				const db = dbOpenRequest.result;
-				resolve(db);
+				const openedDb = dbOpenRequest.result;
+				resolve(openedDb);
 			};
 
 			dbOpenRequest.onupgradeneeded = (event: any) => {
-				const db = event?.target?.result;
+				const upgradedDb = event?.target?.result;
 
-				db.onerror = () => resolve(false);
+				upgradedDb.onerror = () => {
+					resolve(false);
+				};
 
-				const store = db.createObjectStore(storeName, {
+				const store = upgradedDb.createObjectStore(storeName, {
 					autoIncrement: true,
 				});
 
@@ -352,7 +370,9 @@ export const isSafariCompatabilityMode: () => Promise<boolean> = async () => {
 
 			const getRequest = index.get([1]);
 
-			getRequest.onerror = () => resolve(false);
+			getRequest.onerror = () => {
+				resolve(false);
+			};
 
 			getRequest.onsuccess = (event: any) => {
 				resolve(event?.target?.result);
@@ -360,6 +380,7 @@ export const isSafariCompatabilityMode: () => Promise<boolean> = async () => {
 		});
 
 		if (db && typeof db.close === 'function') {
+			// eslint-disable-next-line @typescript-eslint/no-confusing-void-expression
 			await db.close();
 		}
 
@@ -486,7 +507,7 @@ export function sortCompareFunction<T extends PersistentModel>(
 export function directedValueEquality(
 	fromObject: object,
 	againstObject: object,
-	nullish: boolean = false,
+	nullish = false,
 ) {
 	const aKeys = Object.keys(fromObject);
 
@@ -507,11 +528,7 @@ export function directedValueEquality(
 // returns true if equal by value
 // if nullish is true, treat undefined and null values as equal
 // to normalize for GQL response values for undefined fields
-export function valuesEqual(
-	valA: any,
-	valB: any,
-	nullish: boolean = false,
-): boolean {
+export function valuesEqual(valA: any, valB: any, nullish = false): boolean {
 	let a = valA;
 	let b = valB;
 
@@ -610,6 +627,7 @@ export function inMemoryPagination<T extends PersistentModel>(
 
 		return records.slice(start, end);
 	}
+
 	return records;
 }
 
@@ -629,6 +647,7 @@ export async function asyncSome(
 			return true;
 		}
 	}
+
 	return false;
 }
 
@@ -648,6 +667,7 @@ export async function asyncEvery(
 			return false;
 		}
 	}
+
 	return true;
 }
 
@@ -669,6 +689,7 @@ export async function asyncFilter<T>(
 			results.push(item);
 		}
 	}
+
 	return results;
 }
 
@@ -701,6 +722,7 @@ export const isAWSEmail = (val: string): boolean => {
 export const isAWSJSON = (val: string): boolean => {
 	try {
 		JSON.parse(val);
+
 		return true;
 	} catch {
 		return false;
@@ -730,6 +752,7 @@ export class DeferredPromise {
 	public resolve: (value: string | PromiseLike<string>) => void;
 	public reject: () => void;
 	constructor() {
+		// eslint-disable-next-line @typescript-eslint/no-this-alias
 		const self = this;
 		this.promise = new Promise(
 			(resolve: (value: string | PromiseLike<string>) => void, reject) => {
@@ -746,7 +769,10 @@ export class DeferredCallbackResolver {
 	private maxInterval: number;
 	private timer: ReturnType<typeof setTimeout>;
 	private raceInFlight = false;
-	private callback = () => {};
+	private callback = () => {
+		// no-op
+	};
+
 	private errorHandler: (error: string) => void;
 	private defaultErrorHandler = (
 		msg = 'DeferredCallbackResolver error',
@@ -761,7 +787,7 @@ export class DeferredCallbackResolver {
 	}
 
 	private startTimer(): void {
-		this.timerPromise = new Promise((resolve, reject) => {
+		this.timerPromise = new Promise((resolve, _reject) => {
 			this.timer = setTimeout(() => {
 				resolve(LimitTimerRaceResolvedValues.TIMER);
 			}, this.maxInterval);
@@ -786,6 +812,7 @@ export class DeferredCallbackResolver {
 			this.raceInFlight = false;
 			this.limitPromise = new DeferredPromise();
 
+			// eslint-disable-next-line no-unsafe-finally
 			return winner!;
 		}
 	}
@@ -836,6 +863,7 @@ export function mergePatches<T>(
 			patches = p;
 		},
 	);
+
 	return patches!;
 }
 
@@ -845,7 +873,7 @@ export const getStorename = (namespace: string, modelName: string) => {
 	return storeName;
 };
 
-//#region Key Utils
+// #region Key Utils
 
 /*
   When we have GSI(s) with composite sort keys defined on a model
@@ -903,6 +931,7 @@ export const processCompositeKeys = (
 
 			if (combined.length === 0) {
 				combined.push(sortKeyFieldsSet);
+
 				return combined;
 			}
 
@@ -966,6 +995,7 @@ export const extractPrimaryKeysAndValues = <T extends PersistentModel>(
 ): any => {
 	const primaryKeysAndValues = {};
 	keyFields.forEach(key => (primaryKeysAndValues[key] = model[key]));
+
 	return primaryKeysAndValues;
 };
 
@@ -1012,13 +1042,14 @@ export const establishRelationAndKeys = (
 				typeof fieldAttribute.type === 'object' &&
 				'model' in fieldAttribute.type
 			) {
-				const connectionType = fieldAttribute.association!.connectionType;
+				const { connectionType } = fieldAttribute.association!;
 				relationship[mKey].relationTypes.push({
 					fieldName: fieldAttribute.name,
 					modelName: fieldAttribute.type.model,
 					relationType: connectionType,
-					targetName: fieldAttribute.association!['targetName'],
-					targetNames: fieldAttribute.association!['targetNames'],
+					targetName: fieldAttribute.association!.targetName,
+					targetNames: fieldAttribute.association!.targetNames,
+					// eslint-disable-next-line dot-notation
 					associatedWith: fieldAttribute.association!['associatedWith'],
 				});
 
@@ -1089,13 +1120,16 @@ export const getIndex = (
 	src: string,
 ): string | undefined => {
 	let indexName;
+	// eslint-disable-next-line array-callback-return
 	rel.some((relItem: RelationType) => {
 		if (relItem.modelName === src) {
 			const targetNames = extractTargetNamesFromSrc(relItem);
 			indexName = targetNames && indexNameFromKeys(targetNames);
+
 			return true;
 		}
 	});
+
 	return indexName;
 };
 
@@ -1112,6 +1146,7 @@ export const getIndexFromAssociation = (
 	}
 
 	const associationIndex = indexes.find(([idxName]) => idxName === indexName);
+
 	return associationIndex && associationIndex[0];
 };
 
@@ -1144,6 +1179,7 @@ export const indexNameFromKeys = (keys: string[]): string => {
 		if (idx === 0) {
 			return cur;
 		}
+
 		return `${prev}${IDENTIFIER_KEY_SEPARATOR}${cur}`;
 	}, '');
 };
@@ -1170,7 +1206,7 @@ export const getIndexKeys = (
 	return [ID];
 };
 
-//#endregion
+// #endregion
 
 /**
  * Determine what the managed timestamp field names are for the given model definition