update types for internal / external subscription messages; minor upd…

…ate to datastore 'observe'
aws-amplify · Mar 29, 2022 · eb8a29d · eb8a29d
1 parent 8d2500c
commit eb8a29d
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 22 deletions.
diff --git a/packages/datastore/src/datastore/datastore.ts b/packages/datastore/src/datastore/datastore.ts
@@ -43,6 +43,7 @@ import {
 	SchemaModel,
 	SchemaNamespace,
 	SchemaNonModel,
+	InternalSubscriptionMessage,
 	SubscriptionMessage,
 	DataStoreSnapshot,
 	SyncConflict,
@@ -1128,23 +1129,23 @@ class DataStore {
 				handle = this.storage
 					.observe(modelConstructor, predicate)
 					.filter(({ model }) => namespaceResolver(model) === USER)
-					.map((event: SubscriptionMessage<T>): SubscriptionMessage<T> => {
-						// The `element` returned by storage only contains updated fields.
-						// Intercept the event to send the `savedElement` so that the first
-						// snapshot returned to the consumer contains all fields.
-						// In the event of a delete we return `element`, as `savedElement`
-						// here is undefined.
-						const { opType, model, condition, element, savedElement } = event;
-
-						const updated = {
-							opType,
-							element: savedElement || element,
-							model,
-							condition,
-						};
-
-						return updated;
-					})
+					.map(
+						(event: InternalSubscriptionMessage<T>): SubscriptionMessage<T> => {
+							// The `element` returned by storage only contains updated fields.
+							// Intercept the event to send the `savedElement` so that the first
+							// snapshot returned to the consumer contains all fields.
+							// In the event of a delete we return `element`, as `savedElement`
+							// here is undefined.
+							const { opType, model, condition, element, savedElement } = event;
+
+							return {
+								opType,
+								element: savedElement || element,
+								model,
+								condition,
+							};
+						}
+					)
 					.subscribe(observer);
 			})();
 

diff --git a/packages/datastore/src/storage/storage.ts b/packages/datastore/src/storage/storage.ts
@@ -16,6 +16,7 @@ import {
 	PredicatesGroup,
 	QueryOne,
 	SchemaNamespace,
+	InternalSubscriptionMessage,
 	SubscriptionMessage,
 	isTargetNameAssociation,
 } from '../types';
@@ -29,7 +30,7 @@ import { Adapter } from './adapter';
 import getDefaultAdapter from './adapter/getDefaultAdapter';
 
 export type StorageSubscriptionMessage<T extends PersistentModel> =
-	SubscriptionMessage<T> & {
+	InternalSubscriptionMessage<T> & {
 		mutator?: Symbol;
 	};
 
@@ -134,9 +135,8 @@ class StorageClass implements StorageFacade {
 
 			const element = updateMutationInput || savedElement;
 
-			const modelConstructor = (
-				Object.getPrototypeOf(savedElement) as Object
-			).constructor as PersistentModelConstructor<T>;
+			const modelConstructor = (Object.getPrototypeOf(savedElement) as Object)
+				.constructor as PersistentModelConstructor<T>;
 
 			this.pushStream.next({
 				model: modelConstructor,

diff --git a/packages/datastore/src/types.ts b/packages/datastore/src/types.ts
@@ -392,7 +392,12 @@ export enum OpType {
 	DELETE = 'DELETE',
 }
 
-export type SubscriptionMessage<T extends PersistentModel> = {
+export type SubscriptionMessage<T extends PersistentModel> = Pick<
+	InternalSubscriptionMessage<T>,
+	'opType' | 'element' | 'model' | 'condition'
+>;
+
+export type InternalSubscriptionMessage<T extends PersistentModel> = {
 	opType: OpType;
 	element: T;
 	model: PersistentModelConstructor<T>;