@aws-amplify/datastore 3.11.4-unstable.2 → 3.12.1-unstable.1

package/CHANGELOG.md

@@ -3,6 +3,24 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.12.0](https://github.com/aws-amplify/amplify-js/compare/@aws-amplify/datastore@3.11.3...@aws-amplify/datastore@3.12.0) (2022-06-15)
+
+
+### Bug Fixes
+
+* **@aws-amplify/datastore:** adds missing fields to items sent through observe/observeQuery ([#9973](https://github.com/aws-amplify/amplify-js/issues/9973)) ([ca2a11b](https://github.com/aws-amplify/amplify-js/commit/ca2a11b5bc987e71ce3344058a4886bf067cb17b))
+* merge patches for consecutive copyOf ([#9936](https://github.com/aws-amplify/amplify-js/issues/9936)) ([d5dd9cb](https://github.com/aws-amplify/amplify-js/commit/d5dd9cb5bf46131fb046cfe55e4899444f9d789e))
+* **@aws-amplify/datastore:** fixes observeQuery not removing newly-filtered items from snapshot ([#9879](https://github.com/aws-amplify/amplify-js/issues/9879)) ([d1356b1](https://github.com/aws-amplify/amplify-js/commit/d1356b1e498eb71a4902892afbb41f6ff88abb6f))
+
+
+### Features
+
+* **datastore:** add error maps for error handler ([#9918](https://github.com/aws-amplify/amplify-js/issues/9918)) ([3a27096](https://github.com/aws-amplify/amplify-js/commit/3a270969b6e097eeed73368091ace191cbc05511))
+
+
+
+
+
 ## [3.11.3](https://github.com/aws-amplify/amplify-js/compare/@aws-amplify/datastore@3.11.2...@aws-amplify/datastore@3.11.3) (2022-05-24)
 
 **Note:** Version bump only for package @aws-amplify/datastore

package/dist/aws-amplify-datastore.js

@@ -71160,7 +71160,7 @@ var getAmplifyUserAgent = function getAmplifyUserAgent() {
 __webpack_require__.r(__webpack_exports__);
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "version", function() { return version; });
 // generated by genversion
-var version = '4.5.6';
+var version = '4.5.7';
 
 /***/ }),
 
@@ -82313,10 +82313,21 @@ var createModelClass = function createModelClass(modelDefinition) {
       }, function (p) {
         return patches = p;
       });
+      var hasExistingPatches = modelPatchesMap.has(source);
 
-      if (patches.length) {
-        modelPatchesMap.set(model, [patches, source]);
-        checkReadOnlyPropertyOnUpdate(patches, modelDefinition);
+      if (patches.length || hasExistingPatches) {
+        if (hasExistingPatches) {
+          var _a = __read(modelPatchesMap.get(source), 2),
+              existingPatches = _a[0],
+              existingSource = _a[1];
+
+          var mergedPatches = Object(_util__WEBPACK_IMPORTED_MODULE_9__["mergePatches"])(existingSource, existingPatches, patches);
+          modelPatchesMap.set(model, [mergedPatches, existingSource]);
+          checkReadOnlyPropertyOnUpdate(mergedPatches, modelDefinition);
+        } else {
+          modelPatchesMap.set(model, [patches, source]);
+          checkReadOnlyPropertyOnUpdate(patches, modelDefinition);
+        }
       }
 
       return model;
@@ -83026,6 +83037,8 @@ function () {
 
         (function () {
           return __awaiter(_this, void 0, void 0, function () {
+            var _this = this;
+
             return __generator(this, function (_a) {
               switch (_a.label) {
                 case 0:
@@ -83041,24 +83054,44 @@ function () {
                   handle = this.storage.observe(modelConstructor, predicate).filter(function (_a) {
                     var model = _a.model;
                     return namespaceResolver(model) === _util__WEBPACK_IMPORTED_MODULE_9__["USER"];
-                  }).map(function (event) {
-                    // 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.
-                    var opType = event.opType,
-                        model = event.model,
-                        condition = event.condition,
-                        element = event.element,
-                        savedElement = event.savedElement;
-                    return {
-                      opType: opType,
-                      element: savedElement || element,
-                      model: model,
-                      condition: condition
-                    };
-                  }).subscribe(observer);
+                  }).subscribe({
+                    next: function next(item) {
+                      return __awaiter(_this, void 0, void 0, function () {
+                        var message, freshElement;
+                        return __generator(this, function (_a) {
+                          switch (_a.label) {
+                            case 0:
+                              message = item;
+                              if (!(item.opType !== 'DELETE')) return [3
+                              /*break*/
+                              , 2];
+                              return [4
+                              /*yield*/
+                              , this.query(item.model, item.element.id)];
+
+                            case 1:
+                              freshElement = _a.sent();
+                              message = __assign(__assign({}, message), {
+                                element: freshElement
+                              });
+                              _a.label = 2;
+
+                            case 2:
+                              observer.next(message);
+                              return [2
+                              /*return*/
+                              ];
+                          }
+                        });
+                      });
+                    },
+                    error: function error(err) {
+                      return observer.error(err);
+                    },
+                    complete: function complete() {
+                      return observer.complete();
+                    }
+                  });
                   return [2
                   /*return*/
                   ];
@@ -83081,6 +83114,17 @@ function () {
         var itemsChanged = new Map();
         var deletedItemIds = [];
         var handle;
+        var predicate;
+        /**
+         * As the name suggests, this geneates a snapshot in the form of
+         * 	`{items: T[], isSynced: boolean}`
+         * and sends it to the observer.
+         *
+         * SIDE EFFECT: The underlying generation and emission methods may touch:
+         * `items`, `itemsChanged`, and `deletedItemIds`.
+         *
+         * Refer to `generateSnapshot` and `emitSnapshot` for more details.
+         */
 
         var generateAndEmitSnapshot = function generateAndEmitSnapshot() {
           var snapshot = generateSnapshot();
@@ -83098,6 +83142,24 @@ function () {
         var sortOptions = sort ? {
           sort: sort
         } : undefined;
+        var modelDefinition = getModelDefinition(model);
+
+        if (isQueryOne(criteria)) {
+          predicate = _predicates__WEBPACK_IMPORTED_MODULE_5__["ModelPredicateCreator"].createForId(modelDefinition, criteria);
+        } else {
+          if (Object(_predicates__WEBPACK_IMPORTED_MODULE_5__["isPredicatesAll"])(criteria)) {
+            // Predicates.ALL means "all records", so no predicate (undefined)
+            predicate = undefined;
+          } else {
+            predicate = _predicates__WEBPACK_IMPORTED_MODULE_5__["ModelPredicateCreator"].createFromExisting(modelDefinition, criteria);
+          }
+        }
+
+        var _a = _predicates__WEBPACK_IMPORTED_MODULE_5__["ModelPredicateCreator"].getPredicates(predicate, false) || {},
+            predicates = _a.predicates,
+            predicateGroupType = _a.type;
+
+        var hasPredicate = !!predicates;
 
         (function () {
           return __awaiter(_this, void 0, void 0, function () {
@@ -83118,16 +83180,31 @@ function () {
                   // first, query and return any locally-available records
                   _a.sent().forEach(function (item) {
                     return items.set(item.id, item);
-                  }); // observe the model and send a stream of updates (debounced)
+                  }); // Observe the model and send a stream of updates (debounced).
+                  // We need to post-filter results instead of passing criteria through
+                  // to have visibility into items that move from in-set to out-of-set.
+                  // We need to explicitly remove those items from the existing snapshot.
 
 
-                  handle = this.observe(model, // @ts-ignore TODO: fix this TSlint error
-                  criteria).subscribe(function (_a) {
+                  handle = this.observe(model).subscribe(function (_a) {
                     var element = _a.element,
                         model = _a.model,
                         opType = _a.opType;
 
-                    var _b, _c; // Flag items which have been recently deleted
+                    var _b, _c;
+
+                    if (hasPredicate && !Object(_util__WEBPACK_IMPORTED_MODULE_9__["validatePredicate"])(element, predicateGroupType, predicates)) {
+                      if (opType === 'UPDATE' && (items.has(element.id) || itemsChanged.has(element.id))) {
+                        // tracking as a "deleted item" will include the item in
+                        // page limit calculations and ensure it is removed from the
+                        // final items collection, regardless of which collection(s)
+                        // it is currently in. (I mean, it could be in both, right!?)
+                        deletedItemIds.push(element.id);
+                      } else {
+                        // ignore updates for irrelevant/filtered items.
+                        return;
+                      }
+                    } // Flag items which have been recently deleted
                     // NOTE: Merging of separate operations to the same model instance is handled upstream
                     // in the `mergePage` method within src/sync/merger.ts. The final state of a model instance
                     // depends on the LATEST record (for a given id).
@@ -83169,7 +83246,13 @@ function () {
               }
             });
           });
-        })(); // TODO: abstract this function into a util file to be able to write better unit tests
+        })();
+        /**
+         * Combines the `items`, `itemsChanged`, and `deletedItemIds` collections into
+         * a snapshot in the form of `{ items: T[], isSynced: boolean}`.
+         *
+         * SIDE EFFECT: The shared `items` collection is recreated.
+         */
 
 
         var generateSnapshot = function generateSnapshot() {
@@ -83196,6 +83279,15 @@ function () {
             isSynced: isSynced
           };
         };
+        /**
+         * Emits the list of items to the observer.
+         *
+         * SIDE EFFECT: `itemsChanged` and `deletedItemIds` are cleared to prepare
+         * for the next snapshot.
+         *
+         * @param snapshot The generated items data to emit.
+         */
+
 
         var emitSnapshot = function emitSnapshot(snapshot) {
           // send the generated snapshot to the primary subscription
@@ -83204,6 +83296,13 @@ function () {
           itemsChanged.clear();
           deletedItemIds = [];
         };
+        /**
+         * Sorts an `Array` of `T` according to the sort instructions given in the
+         * original  `observeQuery()` call.
+         *
+         * @param itemsToSort A array of model type.
+         */
+
 
         var sortItems = function sortItems(itemsToSort) {
           var modelDefinition = getModelDefinition(model);
@@ -83216,7 +83315,15 @@ function () {
             var compareFn = Object(_util__WEBPACK_IMPORTED_MODULE_9__["sortCompareFunction"])(sortPredicates);
             itemsToSort.sort(compareFn);
           }
-        }; // send one last snapshot when the model is fully synced
+        };
+        /**
+         * Force one last snapshot when the model is fully synced.
+         *
+         * This reduces latency for that last snapshot, which will otherwise
+         * wait for the configured timeout.
+         *
+         * @param payload The payload from the Hub event.
+         */
 
 
         var hubCallback = function hubCallback(_a) {
@@ -92381,57 +92488,85 @@ var __values = undefined && undefined.__values || function (o) {
   throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
 };
 
+var connectionTimeout = function connectionTimeout(error) {
+  return /^Connection failed: Connection Timeout/.test(error.message);
+};
+
+var serverError = function serverError(error) {
+  return /^Error: Request failed with status code 5\d\d/.test(error.message);
+};
+
 var mutationErrorMap = {
+  BadModel: function BadModel() {
+    return false;
+  },
   BadRecord: function BadRecord(error) {
-    return /^Cannot return \w+ for [\w-_]+ type/.test(error.message);
+    var message = error.message;
+    return /^Cannot return \w+ for [\w-_]+ type/.test(message) || /^Variable '.+' has coerced Null value for NonNull type/.test(message); // newly required field, out of date client
   },
   ConfigError: function ConfigError() {
     return false;
   },
-  Transient: function Transient() {
-    return false;
+  Transient: function Transient(error) {
+    return connectionTimeout(error) || serverError(error);
   },
-  Unauthorized: function Unauthorized() {
-    return false;
+  Unauthorized: function Unauthorized(error) {
+    return /^Request failed with status code 401/.test(error.message);
   }
 };
 var subscriptionErrorMap = {
+  BadModel: function BadModel() {
+    return false;
+  },
   BadRecord: function BadRecord() {
     return false;
   },
   ConfigError: function ConfigError() {
     return false;
   },
-  Transient: function Transient() {
-    return false;
+  Transient: function Transient(observableError) {
+    var error = unwrapObservableError(observableError);
+    return connectionTimeout(error) || serverError(error);
   },
-  Unauthorized: function Unauthorized(givenError) {
-    var _a = givenError.error,
-        _b = __read((_a === void 0 ? {
-      errors: []
-    } : _a).errors, 1),
-        _c = _b[0],
-        _d = (_c === void 0 ? {} : _c).message,
-        message = _d === void 0 ? '' : _d;
-
-    var regex = /Connection failed.+Unauthorized/;
-    return regex.test(message);
+  Unauthorized: function Unauthorized(observableError) {
+    var error = unwrapObservableError(observableError);
+    return /Connection failed.+Unauthorized/.test(error.message);
   }
 };
 var syncErrorMap = {
+  BadModel: function BadModel() {
+    return false;
+  },
   BadRecord: function BadRecord(error) {
     return /^Cannot return \w+ for [\w-_]+ type/.test(error.message);
   },
   ConfigError: function ConfigError() {
     return false;
   },
-  Transient: function Transient() {
-    return false;
+  Transient: function Transient(error) {
+    return connectionTimeout(error) || serverError(error);
   },
   Unauthorized: function Unauthorized() {
     return false;
   }
 };
+/**
+ * Get the first error reason of an observable.
+ * Allows for error maps to be easily applied to observable errors
+ *
+ * @param observableError an error from ZenObservable subscribe error callback
+ */
+
+function unwrapObservableError(observableError) {
+  var _a = observableError.error,
+      _b = __read((_a === void 0 ? {
+    errors: []
+  } : _a).errors, 1),
+      error = _b[0];
+
+  return error;
+}
+
 function getMutationErrorType(error) {
   return mapErrorToType(mutationErrorMap, error);
 }
@@ -96169,7 +96304,7 @@ var LimitTimerRaceResolvedValues;
 /*!*************************!*\
   !*** ./lib-esm/util.js ***!
   \*************************/
-/*! exports provided: exhaustiveCheck, isNullOrUndefined, validatePredicate, validatePredicateField, isModelConstructor, registerNonModelClass, isNonModelConstructor, processCompositeKeys, establishRelationAndKeys, traverseModel, getIndex, getIndexFromAssociation, NAMESPACES, USER, SYNC, STORAGE, DATASTORE, isPrivateMode, monotonicUlidFactory, getNow, sortCompareFunction, valuesEqual, isAWSDate, isAWSTime, isAWSDateTime, isAWSTimestamp, isAWSEmail, isAWSJSON, isAWSURL, isAWSPhone, isAWSIPAddress, DeferredPromise, DeferredCallbackResolver */
+/*! exports provided: exhaustiveCheck, isNullOrUndefined, validatePredicate, validatePredicateField, isModelConstructor, registerNonModelClass, isNonModelConstructor, processCompositeKeys, establishRelationAndKeys, traverseModel, getIndex, getIndexFromAssociation, NAMESPACES, USER, SYNC, STORAGE, DATASTORE, isPrivateMode, monotonicUlidFactory, getNow, sortCompareFunction, valuesEqual, isAWSDate, isAWSTime, isAWSDateTime, isAWSTimestamp, isAWSEmail, isAWSJSON, isAWSURL, isAWSPhone, isAWSIPAddress, DeferredPromise, DeferredCallbackResolver, mergePatches */
 /***/ (function(module, __webpack_exports__, __webpack_require__) {
 
 "use strict";
@@ -96207,13 +96342,15 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "isAWSIPAddress", function() { return isAWSIPAddress; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "DeferredPromise", function() { return DeferredPromise; });
 /* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "DeferredCallbackResolver", function() { return DeferredCallbackResolver; });
+/* harmony export (binding) */ __webpack_require__.d(__webpack_exports__, "mergePatches", function() { return mergePatches; });
 /* harmony import */ var buffer__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! buffer */ "../../node_modules/buffer/index.js");
 /* harmony import */ var buffer__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(buffer__WEBPACK_IMPORTED_MODULE_0__);
 /* harmony import */ var ulid__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! ulid */ "../../node_modules/ulid/dist/index.esm.js");
 /* harmony import */ var uuid__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! uuid */ "./node_modules/uuid/index.js");
 /* harmony import */ var uuid__WEBPACK_IMPORTED_MODULE_2___default = /*#__PURE__*/__webpack_require__.n(uuid__WEBPACK_IMPORTED_MODULE_2__);
-/* harmony import */ var _types__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! ./types */ "./lib-esm/types.js");
-/* harmony import */ var amazon_cognito_identity_js__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! amazon-cognito-identity-js */ "../amazon-cognito-identity-js/es/index.js");
+/* harmony import */ var immer__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! immer */ "./node_modules/immer/dist/immer.esm.js");
+/* harmony import */ var _types__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! ./types */ "./lib-esm/types.js");
+/* harmony import */ var amazon_cognito_identity_js__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(/*! amazon-cognito-identity-js */ "../amazon-cognito-identity-js/es/index.js");
 function _typeof(obj) {
   "@babel/helpers - typeof";
 
@@ -96424,6 +96561,7 @@ var __values = undefined && undefined.__values || function (o) {
 
 
 
+
 var exhaustiveCheck = function exhaustiveCheck(obj, throwOnError) {
   if (throwOnError === void 0) {
     throwOnError = true;
@@ -96463,7 +96601,7 @@ var validatePredicate = function validatePredicate(model, groupType, predicatesO
   }
 
   var result = predicatesOrGroups[filterType](function (predicateOrGroup) {
-    if (Object(_types__WEBPACK_IMPORTED_MODULE_3__["isPredicateObj"])(predicateOrGroup)) {
+    if (Object(_types__WEBPACK_IMPORTED_MODULE_4__["isPredicateObj"])(predicateOrGroup)) {
       var field = predicateOrGroup.field,
           operator = predicateOrGroup.operator,
           operand = predicateOrGroup.operand;
@@ -96471,7 +96609,7 @@ var validatePredicate = function validatePredicate(model, groupType, predicatesO
       return validatePredicateField(value, operator, operand);
     }
 
-    if (Object(_types__WEBPACK_IMPORTED_MODULE_3__["isPredicateGroup"])(predicateOrGroup)) {
+    if (Object(_types__WEBPACK_IMPORTED_MODULE_4__["isPredicateGroup"])(predicateOrGroup)) {
       var type = predicateOrGroup.type,
           predicates = predicateOrGroup.predicates;
       return validatePredicate(model, type, predicates);
@@ -96574,7 +96712,7 @@ var processCompositeKeys = function processCompositeKeys(attributes) {
     return sortKeyFields;
   };
 
-  var compositeKeyFields = attributes.filter(_types__WEBPACK_IMPORTED_MODULE_3__["isModelAttributeCompositeKey"]).map(extractCompositeSortKey);
+  var compositeKeyFields = attributes.filter(_types__WEBPACK_IMPORTED_MODULE_4__["isModelAttributeCompositeKey"]).map(extractCompositeSortKey);
   /*
       if 2 sets of fields have any intersecting fields => combine them into 1 union set
       e.g., ['a', 'b', 'c'] and ['a', 'b', 'd'] => ['a', 'b', 'c', 'd']
@@ -96653,11 +96791,11 @@ var establishRelationAndKeys = function establishRelationAndKeys(namespace) {
         for (var _e = __values(model.attributes), _f = _e.next(); !_f.done; _f = _e.next()) {
           var attribute = _f.value;
 
-          if (!Object(_types__WEBPACK_IMPORTED_MODULE_3__["isModelAttributeKey"])(attribute)) {
+          if (!Object(_types__WEBPACK_IMPORTED_MODULE_4__["isModelAttributeKey"])(attribute)) {
             continue;
           }
 
-          if (Object(_types__WEBPACK_IMPORTED_MODULE_3__["isModelAttributePrimaryKey"])(attribute)) {
+          if (Object(_types__WEBPACK_IMPORTED_MODULE_4__["isModelAttributePrimaryKey"])(attribute)) {
             keys[mKey].primaryKey = attribute.properties.fields;
           }
 
@@ -96884,7 +97022,7 @@ var isPrivateMode = function isPrivateMode() {
 };
 
 var randomBytes = function randomBytes(nBytes) {
-  return buffer__WEBPACK_IMPORTED_MODULE_0__["Buffer"].from(new amazon_cognito_identity_js__WEBPACK_IMPORTED_MODULE_4__["WordArray"]().random(nBytes).toString(), 'hex');
+  return buffer__WEBPACK_IMPORTED_MODULE_0__["Buffer"].from(new amazon_cognito_identity_js__WEBPACK_IMPORTED_MODULE_5__["WordArray"]().random(nBytes).toString(), 'hex');
 };
 
 var prng = function prng() {
@@ -96929,7 +97067,7 @@ function sortCompareFunction(sortPredicates) {
         var field = predicate.field,
             sortDirection = predicate.sortDirection; // reverse result when direction is descending
 
-        var sortMultiplier = sortDirection === _types__WEBPACK_IMPORTED_MODULE_3__["SortDirection"].ASCENDING ? 1 : -1;
+        var sortMultiplier = sortDirection === _types__WEBPACK_IMPORTED_MODULE_4__["SortDirection"].ASCENDING ? 1 : -1;
 
         if (a[field] < b[field]) {
           return -1 * sortMultiplier;
@@ -97118,7 +97256,7 @@ function () {
 
     this.timerPromise = new Promise(function (resolve, reject) {
       _this.timer = setTimeout(function () {
-        resolve(_types__WEBPACK_IMPORTED_MODULE_3__["LimitTimerRaceResolvedValues"].TIMER);
+        resolve(_types__WEBPACK_IMPORTED_MODULE_4__["LimitTimerRaceResolvedValues"].TIMER);
       }, _this.maxInterval);
     });
   };
@@ -97178,13 +97316,41 @@ function () {
   };
 
   DeferredCallbackResolver.prototype.resolve = function () {
-    this.limitPromise.resolve(_types__WEBPACK_IMPORTED_MODULE_3__["LimitTimerRaceResolvedValues"].LIMIT);
+    this.limitPromise.resolve(_types__WEBPACK_IMPORTED_MODULE_4__["LimitTimerRaceResolvedValues"].LIMIT);
   };
 
   return DeferredCallbackResolver;
 }();
 
 
+/**
+ * merge two sets of patches created by immer produce.
+ * newPatches take precedent over oldPatches for patches modifying the same path.
+ * In the case many consecutive pathces are merged the original model should
+ * always be the root model.
+ *
+ * Example:
+ * A -> B, patches1
+ * B -> C, patches2
+ *
+ * mergePatches(A, patches1, patches2) to get patches for A -> C
+ *
+ * @param originalSource the original Model the patches should be applied to
+ * @param oldPatches immer produce patch list
+ * @param newPatches immer produce patch list (will take precedence)
+ * @return merged patches
+ */
+
+function mergePatches(originalSource, oldPatches, newPatches) {
+  var patchesToMerge = oldPatches.concat(newPatches);
+  var patches;
+  Object(immer__WEBPACK_IMPORTED_MODULE_3__["produce"])(originalSource, function (draft) {
+    Object(immer__WEBPACK_IMPORTED_MODULE_3__["applyPatches"])(draft, patchesToMerge);
+  }, function (p) {
+    patches = p;
+  });
+  return patches;
+}
 
 /***/ }),