npm - @aws-amplify/datastore-storage-adapter - Versions diffs - 2.0.72 → 2.0.73 - Mend

@aws-amplify/datastore-storage-adapter 2.0.72 → 2.0.73

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (72) hide show

package/coverage-ts/files/src/common/CommonSQLiteAdapter.ts.html ADDED Viewed

@@ -0,0 +1,460 @@
+  <!DOCTYPE html>
+  <html>
+    <head>
+      <title>CommonSQLiteAdapter.ts</title>
+      <link href="https://cdn.jsdelivr.net/npm/semantic-ui@2.4.2/dist/semantic.min.css" type="text/css" rel="stylesheet">
+      <script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.58.2/codemirror.min.js" type="text/javascript" charset="utf-8"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.58.2/mode/javascript/javascript.min.js" type="text/javascript" charset="utf-8"></script>
+<link href="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.58.2/codemirror.min.css" type="text/css" rel="stylesheet">
+<script src="../../../assets/source-file.js" type="text/javascript" charset="utf-8"></script>
+<link href="../../../assets/source-file.css" type="text/css" rel="stylesheet">
+    </head>
+    <body>
+    <div style="margin-top:3em" class="ui container"><h1 class="ui header"><a href="../../../index.html">TypeScript coverage report</a></h1><table style="margin-top:2em" class="ui celled table"><thead class=""><tr class=""><th class="">Filename</th><th class="">Percent</th><th class="">Threshold</th><th class="">Total</th><th class="">Covered</th><th class="">Uncovered</th></tr></thead><tbody class=""><tr class="positive"><td class="">src/common/CommonSQLiteAdapter.ts</td><td class="">96.60%</td><td class="">94.16%</td><td class="">765</td><td class="">739</td><td class="">26</td></tr></tbody></table><textarea id="editor" readonly="" style="margin-top:3em">// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { ConsoleLogger as Logger } from &#x27;@aws-amplify/core&#x27;;
+import {
+	generateSchemaStatements,
+	queryByIdStatement,
+	modelUpdateStatement,
+	modelInsertStatement,
+	queryAllStatement,
+	queryOneStatement,
+	deleteByIdStatement,
+	deleteByPredicateStatement,
+} from &#x27;../common/SQLiteUtils&#x27;;
+import {
+	StorageAdapter,
+	ModelInstanceCreator,
+	ModelPredicateCreator,
+	ModelSortPredicateCreator,
+	InternalSchema,
+	isPredicateObj,
+	ModelPredicate,
+	NamespaceResolver,
+	NAMESPACES,
+	OpType,
+	PaginationInput,
+	PersistentModel,
+	PersistentModelConstructor,
+	PredicateObject,
+	PredicatesGroup,
+	QueryOne,
+	utils,
+} from &#x27;@aws-amplify/datastore&#x27;;
+import {
+	CommonSQLiteDatabase,
+	ParameterizedStatement,
+	ModelInstanceMetadataWithId,
+} from &#x27;./types&#x27;;
+const { traverseModel, validatePredicate, isModelConstructor } = utils;
+const logger = new Logger(&#x27;DataStore&#x27;);
+export class CommonSQLiteAdapter implements StorageAdapter {
+	private schema: InternalSchema;
+	private namespaceResolver: NamespaceResolver;
+	private modelInstanceCreator: ModelInstanceCreator;
+	private getModelConstructorByModelName: (
+		namsespaceName: string,
+		modelName: string
+	) =&gt; PersistentModelConstructor&lt;any&gt;;
+	private db: CommonSQLiteDatabase;
+	private initPromise: Promise&lt;void&gt;;
+	private resolve: (value?: any) =&gt; void;
+	private reject: (value?: any) =&gt; void;
+	constructor(db: CommonSQLiteDatabase) {
+		this.db = db;
+	}
+	public async setUp(
+		theSchema: InternalSchema,
+		namespaceResolver: NamespaceResolver,
+		modelInstanceCreator: ModelInstanceCreator,
+		getModelConstructorByModelName: (
+			namsespaceName: NAMESPACES,
+			modelName: string
+		) =&gt; PersistentModelConstructor&lt;any&gt;
+	) {
+		if (!this.initPromise) {
+			this.initPromise = new Promise((res, rej) =&gt; {
+				this.resolve = res;
+				this.reject = rej;
+			});
+		} else {
+			await this.initPromise;
+			return;
+		}
+		this.schema = theSchema;
+		this.namespaceResolver = namespaceResolver;
+		this.modelInstanceCreator = modelInstanceCreator;
+		this.getModelConstructorByModelName = getModelConstructorByModelName;
+		try {
+			const usesCPKCodegen = Object.values(
+				this.schema.namespaces.user.models
+			).some(model =&gt;
+				Object.values(model.fields).some(field =&gt;
+					field.association?.hasOwnProperty(&#x27;targetNames&#x27;)
+				)
+			);
+			if (usesCPKCodegen) {
+				logger.error(
+					&#x27;The SQLite adapter does not support schemas using custom primary key. Set `graphQLTransformer.respectPrimaryKeyAttributesOnConnectionField in `amplify/cli.json` to false to disable custom primary key. To regenerate your API, add or remove an empty newline to your GraphQL schema (to change the computed hash) then run `amplify push`.&#x27;
+				);
+			}
+			await this.db.init();
+			const statements = generateSchemaStatements(this.schema);
+			await this.db.createSchema(statements);
+			this.resolve();
+		} catch (error) {
+			this.reject(error);
+		}
+	}
+	async clear(): Promise&lt;void&gt; {
+		await this.db.clear();
+		this.initPromise = undefined;
+	}
+	async save&lt;T extends PersistentModel&gt;(
+		model: T,
+		condition?: ModelPredicate&lt;T&gt;
+	): Promise&lt;[T, OpType.INSERT | OpType.UPDATE][]&gt; {
+		const modelConstructor = Object.getPrototypeOf(model)
+			.constructor as PersistentModelConstructor&lt;T&gt;;
+		const { name: tableName } = modelConstructor;
+		const connectedModels = traverseModel(
+			modelConstructor.name,
+			model,
+			this.schema.namespaces[this.namespaceResolver(modelConstructor)],
+			this.modelInstanceCreator,
+			this.getModelConstructorByModelName
+		);
+		const connectionStoreNames = Object.values(connectedModels).map(
+			({ modelName, item, instance }) =&gt; {
+				return { modelName, item, instance };
+			}
+		);
+		const [queryStatement, params] = queryByIdStatement(model.id, tableName);
+		const fromDB = await this.db.get(queryStatement, params);
+		if (condition &amp;&amp; fromDB) {
+			const predicates = ModelPredicateCreator.getPredicates(condition);
+			const { predicates: predicateObjs, type } = predicates;
+			const isValid = validatePredicate(fromDB, type, predicateObjs);
+			if (!isValid) {
+				const msg = &#x27;Conditional update failed&#x27;;
+				logger.error(msg, { model: fromDB, condition: predicateObjs });
+				throw new Error(msg);
+			}
+		}
+		const result: [T, OpType.INSERT | OpType.UPDATE][] = [];
+		const saveStatements = new Set&lt;ParameterizedStatement&gt;();
+		for await (const resItem of connectionStoreNames) {
+			const { modelName, item, instance } = resItem;
+			const { id } = item;
+			const [queryStatement, params] = queryByIdStatement(id, modelName);
+			const fromDB = await this.db.get(queryStatement, params);
+			const opType: OpType =
+				fromDB === undefined ? OpType.INSERT : OpType.UPDATE;
+			const saveStatement = fromDB
+				? modelUpdateStatement(instance, modelName)
+				: modelInsertStatement(instance, modelName);
+			if (id === model.id || opType === OpType.INSERT) {
+				saveStatements.add(saveStatement);
+				result.push([instance, opType]);
+			}
+		}
+		await this.db.batchSave(saveStatements);
+		return result;
+	}
+	private async load&lt;T&gt;(
+		namespaceName: string,
+		srcModelName: string,
+		records: T[]
+	): Promise&lt;T[]&gt; {
+		const namespace = this.schema.namespaces[namespaceName];
+		const relations = namespace.relationships[srcModelName].relationTypes;
+		const connectionTableNames = relations.map(({ modelName }) =&gt; modelName);
+		const modelConstructor = this.getModelConstructorByModelName(
+			namespaceName,
+			srcModelName
+		);
+		if (connectionTableNames.length === 0) {
+			return records.map(record =&gt;
+				this.modelInstanceCreator(modelConstructor, record)
+			);
+		}
+		// Remove related-model fields. They&#x27;re all `null` in the database,
+		// and any that happen to be required will result in a false validation
+		// error when DataStore attempts to initialize with `null`.
+		// These fields aren&#x27;t actually needed here. DataStore will use the FK&#x27;s
+		// from the schema model.
+		return records.map(record =&gt; {
+			for (const r of relations) {
+				delete record[r.fieldName];
+			}
+			return this.modelInstanceCreator(modelConstructor, record);
+		});
+	}
+	async query&lt;T extends PersistentModel&gt;(
+		modelConstructor: PersistentModelConstructor&lt;T&gt;,
+		predicate?: ModelPredicate&lt;T&gt;,
+		pagination?: PaginationInput&lt;T&gt;
+	): Promise&lt;T[]&gt; {
+		const { name: tableName } = modelConstructor;
+		const namespaceName = this.namespaceResolver(modelConstructor);
+		const predicates =
+			predicate &amp;&amp; ModelPredicateCreator.getPredicates(predicate);
+		const sortPredicates =
+			pagination &amp;&amp;
+			pagination.sort &amp;&amp;
+			ModelSortPredicateCreator.getPredicates(pagination.sort);
+		const limit = pagination &amp;&amp; pagination.limit;
+		const page = limit &amp;&amp; pagination.page;
+		const queryById = predicates &amp;&amp; this.idFromPredicate(predicates);
+		const records: T[] = &lt;T[]&gt;await (async () =&gt; {
+			if (queryById) {
+				const record = await this.getById(tableName, queryById);
+				return record ? [record] : [];
+			}
+			const [queryStatement, params] = queryAllStatement(
+				tableName,
+				predicates,
+				sortPredicates,
+				limit,
+				page
+			);
+			return await this.db.getAll(queryStatement, params);
+		})();
+		return await this.load(namespaceName, modelConstructor.name, records);
+	}
+	private async getById&lt;T extends PersistentModel&gt;(
+		tableName: string,
+		id: string
+	): Promise&lt;T&gt; {
+		const [queryStatement, params] = queryByIdStatement(id, tableName);
+		const record = await this.db.get&lt;T&gt;(queryStatement, params);
+		return record;
+	}
+	private idFromPredicate&lt;T extends PersistentModel&gt;(
+		predicates: PredicatesGroup&lt;T&gt;
+	) {
+		const { predicates: predicateObjs } = predicates;
+		const idPredicate =
+			predicateObjs.length === 1 &amp;&amp;
+			(predicateObjs.find(
+				p =&gt; isPredicateObj(p) &amp;&amp; p.field === &#x27;id&#x27; &amp;&amp; p.operator === &#x27;eq&#x27;
+			) as PredicateObject&lt;T&gt;);
+		return idPredicate &amp;&amp; idPredicate.operand;
+	}
+	async queryOne&lt;T extends PersistentModel&gt;(
+		modelConstructor: PersistentModelConstructor&lt;T&gt;,
+		firstOrLast: QueryOne = QueryOne.FIRST
+	): Promise&lt;T | undefined&gt; {
+		const { name: tableName } = modelConstructor;
+		const [queryStatement, params] = queryOneStatement(firstOrLast, tableName);
+		const result = await this.db.get&lt;T&gt;(queryStatement, params);
+		const modelInstance =
+			result &amp;&amp; this.modelInstanceCreator(modelConstructor, result);
+		return modelInstance;
+	}
+	// Currently does not cascade
+	// TODO: use FKs in relations and have `ON DELETE CASCADE` set
+	// For Has Many and Has One relations to have SQL handle cascades automatically
+	async delete&lt;T extends PersistentModel&gt;(
+		modelOrModelConstructor: T | PersistentModelConstructor&lt;T&gt;,
+		condition?: ModelPredicate&lt;T&gt;
+	): Promise&lt;[T[], T[]]&gt; {
+		if (isModelConstructor(modelOrModelConstructor)) {
+			const modelConstructor = modelOrModelConstructor;
+			const namespaceName = this.namespaceResolver(modelConstructor);
+			const { name: tableName } = modelConstructor;
+			const predicates =
+				condition &amp;&amp; ModelPredicateCreator.getPredicates(condition);
+			const queryStatement = queryAllStatement(tableName, predicates);
+			const deleteStatement = deleteByPredicateStatement(tableName, predicates);
+			const models = await this.db.selectAndDelete(
+				queryStatement,
+				deleteStatement
+			);
+			const modelInstances = await this.load(
+				namespaceName,
+				modelConstructor.name,
+				models
+			);
+			return [modelInstances, modelInstances];
+		} else {
+			const model = modelOrModelConstructor as T;
+			const modelConstructor = Object.getPrototypeOf(model)
+				.constructor as PersistentModelConstructor&lt;T&gt;;
+			const { name: tableName } = modelConstructor;
+			if (condition) {
+				const [queryStatement, params] = queryByIdStatement(
+					model.id,
+					tableName
+				);
+				const fromDB = await this.db.get(queryStatement, params);
+				if (fromDB === undefined) {
+					const msg = &#x27;Model instance not found in storage&#x27;;
+					logger.warn(msg, { model });
+					return [[model], []];
+				}
+				const predicates = ModelPredicateCreator.getPredicates(condition);
+				const { predicates: predicateObjs, type } = predicates;
+				const isValid = validatePredicate(fromDB, type, predicateObjs);
+				if (!isValid) {
+					const msg = &#x27;Conditional update failed&#x27;;
+					logger.error(msg, { model: fromDB, condition: predicateObjs });
+					throw new Error(msg);
+				}
+				const [deleteStatement, deleteParams] = deleteByIdStatement(
+					model.id,
+					tableName
+				);
+				await this.db.save(deleteStatement, deleteParams);
+				return [[model], [model]];
+			} else {
+				const [deleteStatement, params] = deleteByIdStatement(
+					model.id,
+					tableName
+				);
+				await this.db.save(deleteStatement, params);
+				return [[model], [model]];
+			}
+		}
+	}
+	async batchSave&lt;T extends PersistentModel&gt;(
+		modelConstructor: PersistentModelConstructor&lt;any&gt;,
+		items: ModelInstanceMetadataWithId[]
+	): Promise&lt;[T, OpType][]&gt; {
+		const { name: tableName } = modelConstructor;
+		const result: [T, OpType][] = [];
+		const itemsToSave: T[] = [];
+		// To determine whether an item should result in an insert or update operation
+		// We first need to query the local DB on the item id
+		const queryStatements = new Set&lt;ParameterizedStatement&gt;();
+		// Deletes don&#x27;t need to be queried first, because if the item doesn&#x27;t exist,
+		// the delete operation will be a no-op
+		const deleteStatements = new Set&lt;ParameterizedStatement&gt;();
+		const saveStatements = new Set&lt;ParameterizedStatement&gt;();
+		for (const item of items) {
+			const connectedModels = traverseModel(
+				modelConstructor.name,
+				this.modelInstanceCreator(modelConstructor, item),
+				this.schema.namespaces[this.namespaceResolver(modelConstructor)],
+				this.modelInstanceCreator,
+				this.getModelConstructorByModelName
+			);
+			const { id, _deleted } = item;
+			const { instance } = connectedModels.find(
+				({ instance }) =&gt; instance.id === id
+			);
+			if (_deleted) {
+				// create the delete statements right away
+				const deleteStatement = deleteByIdStatement(instance.id, tableName);
+				deleteStatements.add(deleteStatement);
+				result.push([&lt;T&gt;(&lt;unknown&gt;item), OpType.DELETE]);
+			} else {
+				// query statements for the saves at first
+				const queryStatement = queryByIdStatement(id, tableName);
+				queryStatements.add(queryStatement);
+				// combination of insert and update items
+				itemsToSave.push(instance);
+			}
+		}
+		// returns the query results for each of the save items
+		const queryResponses = await this.db.batchQuery(queryStatements);
+		queryResponses.forEach((response, idx) =&gt; {
+			if (response === undefined) {
+				const insertStatement = modelInsertStatement(
+					itemsToSave[idx],
+					tableName
+				);
+				saveStatements.add(insertStatement);
+				result.push([&lt;T&gt;(&lt;unknown&gt;itemsToSave[idx]), OpType.INSERT]);
+			} else {
+				const updateStatement = modelUpdateStatement(
+					itemsToSave[idx],
+					tableName
+				);
+				saveStatements.add(updateStatement);
+				result.push([&lt;T&gt;(&lt;unknown&gt;itemsToSave[idx]), OpType.UPDATE]);
+			}
+		});
+		// perform all of the insert/update/delete operations in a single transaction
+		await this.db.batchSave(saveStatements, deleteStatements);
+		return result;
+	}
+}
+</textarea><pre id="annotations" style="display:none">[{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:53,&quot;character&quot;:19,&quot;text&quot;:&quot;value&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:54,&quot;character&quot;:18,&quot;text&quot;:&quot;value&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:102,&quot;character&quot;:15,&quot;text&quot;:&quot;error&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:101,&quot;character&quot;:11,&quot;text&quot;:&quot;error&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:132,&quot;character&quot;:60,&quot;text&quot;:&quot;id&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:140,&quot;character&quot;:9,&quot;text&quot;:&quot;isValid&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:142,&quot;character&quot;:8,&quot;text&quot;:&quot;isValid&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:155,&quot;character&quot;:11,&quot;text&quot;:&quot;id&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:167,&quot;character&quot;:7,&quot;text&quot;:&quot;id&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:167,&quot;character&quot;:20,&quot;text&quot;:&quot;id&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:228,&quot;character&quot;:8,&quot;text&quot;:&quot;queryById&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:231,&quot;character&quot;:7,&quot;text&quot;:&quot;queryById&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:270,&quot;character&quot;:36,&quot;text&quot;:&quot;operand&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:326,&quot;character&quot;:11,&quot;text&quot;:&quot;id&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:342,&quot;character&quot;:10,&quot;text&quot;:&quot;isValid&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:344,&quot;character&quot;:9,&quot;text&quot;:&quot;isValid&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:352,&quot;character&quot;:11,&quot;text&quot;:&quot;id&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:360,&quot;character&quot;:11,&quot;text&quot;:&quot;id&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:397,&quot;character&quot;:11,&quot;text&quot;:&quot;instance&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:398,&quot;character&quot;:7,&quot;text&quot;:&quot;instance&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:398,&quot;character&quot;:22,&quot;text&quot;:&quot;instance&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:398,&quot;character&quot;:31,&quot;text&quot;:&quot;id&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:403,&quot;character&quot;:48,&quot;text&quot;:&quot;instance&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:403,&quot;character&quot;:57,&quot;text&quot;:&quot;id&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:418,&quot;character&quot;:26,&quot;text&quot;:&quot;response&quot;,&quot;kind&quot;:1},{&quot;file&quot;:&quot;src/common/CommonSQLiteAdapter.ts&quot;,&quot;line&quot;:419,&quot;character&quot;:7,&quot;text&quot;:&quot;response&quot;,&quot;kind&quot;:1}]</pre></div>
+    <p class="footer-text">TypeScript Coverage Report generated by <a href="https://github.com/plantain-00/type-coverage">type-coverage</a> and <a href="https://github.com/alexcanessa/typescript-coverage-report">typescript-coverage-report</a> at Mon, 20 Apr 2026 10:42:30 GMT</p>
+    </body>
+  </html>