@aws-amplify/api-graphql 4.0.1-api-v6-models.3eb7748.0 → 4.0.1-api-v6-models.01b2bb8.0

package/lib/utils/findIndexByFields.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Iterates through a collection to find a matching item and returns the index.
+ *
+ * @param needle The item to search for
+ * @param haystack The collection to search
+ * @param keyFields The fields used to indicate a match
+ * @returns Index of `needle` in `haystack`, otherwise -1 if not found.
+ */
+export declare function findIndexByFields<T>(needle: T, haystack: T[], keyFields: Array<keyof T>): number;

package/lib/utils/findIndexByFields.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findIndexByFields = void 0;
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+/**
+ * Iterates through a collection to find a matching item and returns the index.
+ *
+ * @param needle The item to search for
+ * @param haystack The collection to search
+ * @param keyFields The fields used to indicate a match
+ * @returns Index of `needle` in `haystack`, otherwise -1 if not found.
+ */
+function findIndexByFields(needle, haystack, keyFields) {
+    var searchObject = Object.fromEntries(keyFields.map(function (fieldName) { return [fieldName, needle[fieldName]]; }));
+    var _loop_1 = function (i) {
+        if (Object.keys(searchObject).every(function (k) { return searchObject[k] === haystack[i][k]; })) {
+            return { value: i };
+        }
+    };
+    for (var i = 0; i < haystack.length; i++) {
+        var state_1 = _loop_1(i);
+        if (typeof state_1 === "object")
+            return state_1.value;
+    }
+    return -1;
+}
+exports.findIndexByFields = findIndexByFields;

package/lib/utils/index.d.ts

@@ -1,2 +1,4 @@
 export { resolveConfig } from './resolveConfig';
 export { resolveLibraryOptions } from './resolveLibraryOptions';
+export { resolvePKFields } from './resolvePKFields';
+export { findIndexByFields } from './findIndexByFields';

package/lib/utils/index.js

@@ -2,8 +2,12 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveLibraryOptions = exports.resolveConfig = void 0;
+exports.findIndexByFields = exports.resolvePKFields = exports.resolveLibraryOptions = exports.resolveConfig = void 0;
 var resolveConfig_1 = require("./resolveConfig");
 Object.defineProperty(exports, "resolveConfig", { enumerable: true, get: function () { return resolveConfig_1.resolveConfig; } });
 var resolveLibraryOptions_1 = require("./resolveLibraryOptions");
 Object.defineProperty(exports, "resolveLibraryOptions", { enumerable: true, get: function () { return resolveLibraryOptions_1.resolveLibraryOptions; } });
+var resolvePKFields_1 = require("./resolvePKFields");
+Object.defineProperty(exports, "resolvePKFields", { enumerable: true, get: function () { return resolvePKFields_1.resolvePKFields; } });
+var findIndexByFields_1 = require("./findIndexByFields");
+Object.defineProperty(exports, "findIndexByFields", { enumerable: true, get: function () { return findIndexByFields_1.findIndexByFields; } });

package/lib/utils/resolvePKFields.d.ts

@@ -0,0 +1,13 @@
+import { ResourcesConfig } from '@aws-amplify/core';
+type GraphQLConfig = Exclude<ResourcesConfig['API'], undefined>['GraphQL'];
+type ModelIntrospectionSchema = Exclude<Exclude<GraphQLConfig, undefined>['modelIntrospection'], undefined>;
+type SchemaModel = ModelIntrospectionSchema['models'][string];
+/**
+ * Given a SchemaModel from a ModelIntrospectionSchema, returns the primary key
+ * as an array of field names.
+ *
+ * @param model The model object
+ * @returns Array of field names
+ */
+export declare function resolvePKFields(model: SchemaModel): string[];
+export {};

package/lib/utils/resolvePKFields.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolvePKFields = void 0;
+var tslib_1 = require("tslib");
+/**
+ * Given a SchemaModel from a ModelIntrospectionSchema, returns the primary key
+ * as an array of field names.
+ *
+ * @param model The model object
+ * @returns Array of field names
+ */
+function resolvePKFields(model) {
+    var _a = model.primaryKeyInfo, primaryKeyFieldName = _a.primaryKeyFieldName, sortKeyFieldNames = _a.sortKeyFieldNames;
+    return tslib_1.__spreadArray([primaryKeyFieldName], tslib_1.__read(sortKeyFieldNames), false);
+}
+exports.resolvePKFields = resolvePKFields;

package/lib-esm/internals/APIClient.d.ts

@@ -42,6 +42,10 @@ export declare const graphQLOperationsInfo: {
         operationPrefix: "onDelete";
         usePlural: boolean;
     };
+    OBSERVE_QUERY: {
+        operationPrefix: "observeQuery";
+        usePlural: boolean;
+    };
 };
 export type ModelOperation = keyof typeof graphQLOperationsInfo;
 /**

package/lib-esm/internals/APIClient.js

@@ -140,9 +140,10 @@ export var graphQLOperationsInfo = {
     ONCREATE: { operationPrefix: 'onCreate', usePlural: false },
     ONUPDATE: { operationPrefix: 'onUpdate', usePlural: false },
     ONDELETE: { operationPrefix: 'onDelete', usePlural: false },
+    OBSERVE_QUERY: { operationPrefix: 'observeQuery', usePlural: false },
 };
 var graphQLDocumentsCache = new Map();
-var SELECTION_SET_ALL_NESTED = '*';
+var SELECTION_SET_WILDCARD = '*';
 function defaultSelectionSetForModel(modelDefinition) {
     // fields that are explicitly part of the graphql schema; not
     // inferred from owner auth rules.
@@ -179,70 +180,53 @@ var FIELD_IR = '';
  * ```
  */
 export function customSelectionSetToIR(modelIntrospection, modelName, selectionSet) {
-    var e_2, _a;
-    var _b, _c, _d, _e;
     var modelDefinition = modelIntrospection[modelName];
-    var fields = modelDefinition.fields;
-    var intermediateSelectionSet = {};
-    try {
-        for (var selectionSet_1 = __values(selectionSet), selectionSet_1_1 = selectionSet_1.next(); !selectionSet_1_1.done; selectionSet_1_1 = selectionSet_1.next()) {
-            var f = selectionSet_1_1.value;
-            var nested = f.includes('.');
-            if (nested) {
-                var _f = __read(f.split('.'), 2), modelFieldName = _f[0], selectedField = _f[1];
-                var relatedModel = (_c = (_b = fields[modelFieldName]) === null || _b === void 0 ? void 0 : _b.type) === null || _c === void 0 ? void 0 : _c.model;
-                if (!relatedModel) {
-                    // TODO: may need to change this to support custom types
-                    throw Error("".concat(modelFieldName, " is not a model field"));
-                }
-                if (selectedField === SELECTION_SET_ALL_NESTED) {
-                    var relatedModelDefinition = modelIntrospection[relatedModel];
-                    var defaultSelectionSet = defaultSelectionSetForModel(relatedModelDefinition);
-                    var reduced = defaultSelectionSet.reduce(function (acc, curVal) {
-                        acc[curVal] = FIELD_IR;
-                        return acc;
-                    }, {});
-                    if ((_d = fields[modelFieldName]) === null || _d === void 0 ? void 0 : _d.isArray) {
-                        intermediateSelectionSet[modelFieldName] = {
-                            items: reduced,
-                        };
-                    }
-                    else {
-                        intermediateSelectionSet[modelFieldName] = reduced;
-                    }
-                }
-                else {
-                    var getNestedSelSet = customSelectionSetToIR(modelIntrospection, relatedModel, [selectedField]);
-                    if ((_e = fields[modelFieldName]) === null || _e === void 0 ? void 0 : _e.isArray) {
-                        var existing = intermediateSelectionSet[modelFieldName] || { items: {} };
-                        var merged = __assign(__assign({}, existing.items), getNestedSelSet);
-                        intermediateSelectionSet[modelFieldName] = { items: merged };
-                    }
-                    else {
-                        var existingItems = intermediateSelectionSet[modelFieldName] || {};
-                        var merged = __assign(__assign({}, existingItems), getNestedSelSet);
-                        intermediateSelectionSet[modelFieldName] = merged;
-                    }
-                }
+    var modelFields = modelDefinition.fields;
+    return selectionSet.reduce(function (resultObj, path) {
+        var _a, _b, _c;
+        var _d = __read(path.split('.')), fieldName = _d[0], nested = _d[1], rest = _d.slice(2);
+        if (nested) {
+            var relatedModel = (_b = (_a = modelFields[fieldName]) === null || _a === void 0 ? void 0 : _a.type) === null || _b === void 0 ? void 0 : _b.model;
+            if (!relatedModel) {
+                // TODO: may need to change this to support custom types
+                throw Error("".concat(fieldName, " is not a model field"));
             }
-            else {
-                var exists = Boolean(fields[f]);
-                if (!exists) {
-                    throw Error("".concat(f, " is not a field of model ").concat(modelName));
-                }
-                intermediateSelectionSet[f] = FIELD_IR;
+            var relatedModelDefinition = modelIntrospection[relatedModel];
+            var selectionSet_1 = nested === SELECTION_SET_WILDCARD
+                ? defaultSelectionSetIR(relatedModelDefinition)
+                : // if we have a path like 'field.anotherField' recursively build up selection set IR
+                    customSelectionSetToIR(modelIntrospection, relatedModel, [
+                        __spreadArray([nested], __read(rest), false).join('.'),
+                    ]);
+            if ((_c = modelFields[fieldName]) === null || _c === void 0 ? void 0 : _c.isArray) {
+                var existing = resultObj[fieldName] || {
+                    items: {},
+                };
+                var merged_1 = __assign(__assign({}, existing.items), selectionSet_1);
+                resultObj[fieldName] = { items: merged_1 };
+                return resultObj;
             }
+            var existingItems = resultObj[fieldName] || {};
+            var merged = __assign(__assign({}, existingItems), selectionSet_1);
+            resultObj[fieldName] = merged;
+            return resultObj;
         }
-    }
-    catch (e_2_1) { e_2 = { error: e_2_1 }; }
-    finally {
-        try {
-            if (selectionSet_1_1 && !selectionSet_1_1.done && (_a = selectionSet_1.return)) _a.call(selectionSet_1);
+        var exists = Boolean(modelFields[fieldName]);
+        if (!exists) {
+            throw Error("".concat(fieldName, " is not a field of model ").concat(modelName));
         }
-        finally { if (e_2) throw e_2.error; }
-    }
-    return intermediateSelectionSet;
+        resultObj[fieldName] = FIELD_IR;
+        return resultObj;
+    }, {});
 }
+var defaultSelectionSetIR = function (relatedModelDefinition) {
+    var defaultSelectionSet = defaultSelectionSetForModel(relatedModelDefinition);
+    var reduced = defaultSelectionSet.reduce(function (acc, curVal) {
+        acc[curVal] = FIELD_IR;
+        return acc;
+    }, {});
+    return reduced;
+};
 /**
  * Stringifies selection set IR
  * * @example
@@ -326,9 +310,11 @@ export function generateGraphQLDocument(modelIntrospection, modelName, modelOper
         case 'LIST':
             graphQLArguments !== null && graphQLArguments !== void 0 ? graphQLArguments : (graphQLArguments = {
                 filter: "Model".concat(name, "FilterInput"),
+                limit: 'Int',
+                nextToken: 'String',
             });
             graphQLOperationType !== null && graphQLOperationType !== void 0 ? graphQLOperationType : (graphQLOperationType = 'query');
-            graphQLSelectionSet !== null && graphQLSelectionSet !== void 0 ? graphQLSelectionSet : (graphQLSelectionSet = "items { ".concat(selectionSetFields, " }"));
+            graphQLSelectionSet !== null && graphQLSelectionSet !== void 0 ? graphQLSelectionSet : (graphQLSelectionSet = "items { ".concat(selectionSetFields, " } nextToken __typename"));
         case 'ONCREATE':
         case 'ONUPDATE':
         case 'ONDELETE':
@@ -337,6 +323,10 @@ export function generateGraphQLDocument(modelIntrospection, modelName, modelOper
             });
             graphQLOperationType !== null && graphQLOperationType !== void 0 ? graphQLOperationType : (graphQLOperationType = 'subscription');
             graphQLSelectionSet !== null && graphQLSelectionSet !== void 0 ? graphQLSelectionSet : (graphQLSelectionSet = selectionSetFields);
+            break;
+        case 'OBSERVE_QUERY':
+        default:
+            throw new Error('Internal error: Attempted to generate graphql document for observeQuery. Please report this error.');
     }
     var graphQLDocument = "".concat(graphQLOperationType).concat(graphQLArguments
         ? "(".concat(Object.entries(graphQLArguments).map(function (_a) {
@@ -384,6 +374,13 @@ export function buildGraphQLVariables(modelDefinition, operation, arg, modelIntr
             }
             break;
         case 'LIST':
+            if (arg === null || arg === void 0 ? void 0 : arg.filter) {
+                variables.filter = arg.filter;
+            }
+            if (arg === null || arg === void 0 ? void 0 : arg.nextToken) {
+                variables.nextToken = arg.nextToken;
+            }
+            break;
         case 'ONCREATE':
         case 'ONUPDATE':
         case 'ONDELETE':
@@ -391,6 +388,9 @@ export function buildGraphQLVariables(modelDefinition, operation, arg, modelIntr
                 variables = { filter: arg.filter };
             }
             break;
+        case 'OBSERVE_QUERY':
+            throw new Error('Internal error: Attempted to build variables for observeQuery. Please report this error.');
+            break;
         default:
             var exhaustiveCheck = operation;
             throw new Error("Unhandled operation case: ".concat(exhaustiveCheck));

package/lib-esm/internals/generateModelsProperty.js

@@ -1,6 +1,7 @@
-import { __awaiter, __generator, __read, __values } from "tslib";
+import { __assign, __awaiter, __generator, __read, __spreadArray, __values } from "tslib";
 import { initializeModel, generateGraphQLDocument, buildGraphQLVariables, graphQLOperationsInfo, flattenItems, } from './APIClient';
-import { map } from 'rxjs';
+import { findIndexByFields, resolvePKFields } from '../utils';
+import { Observable, map } from 'rxjs';
 export function generateModelsProperty(client, params) {
     var e_1, _a;
     var _this = this;
@@ -19,7 +20,7 @@ export function generateModelsProperty(client, params) {
             var operation = key;
             if (operation === 'LIST') {
                 models[name_1][operationPrefix] = function (args) { return __awaiter(_this, void 0, void 0, function () {
-                    var query, variables, _a, data, nextToken, extensions, _b, key_1, flattenedResult, initialized, error_1;
+                    var query, variables, _a, data, extensions, _b, key_1, flattenedResult, initialized, error_1;
                     return __generator(this, function (_c) {
                         switch (_c.label) {
                             case 0:
@@ -33,7 +34,7 @@ export function generateModelsProperty(client, params) {
                                         variables: variables,
                                     })];
                             case 2:
-                                _a = (_c.sent()), data = _a.data, nextToken = _a.nextToken, extensions = _a.extensions;
+                                _a = (_c.sent()), data = _a.data, extensions = _a.extensions;
                                 // flatten response
                                 if (data !== undefined) {
                                     _b = __read(Object.keys(data), 1), key_1 = _b[0];
@@ -43,7 +44,7 @@ export function generateModelsProperty(client, params) {
                                         if (args === null || args === void 0 ? void 0 : args.selectionSet) {
                                             return [2 /*return*/, {
                                                     data: flattenedResult,
-                                                    nextToken: nextToken,
+                                                    nextToken: data[key_1].nextToken,
                                                     extensions: extensions,
                                                 }];
                                         }
@@ -51,14 +52,14 @@ export function generateModelsProperty(client, params) {
                                             initialized = initializeModel(client, name_1, flattenedResult, modelIntrospection);
                                             return [2 /*return*/, {
                                                     data: initialized,
-                                                    nextToken: nextToken,
+                                                    nextToken: data[key_1].nextToken,
                                                     extensions: extensions,
                                                 }];
                                         }
                                     }
                                     return [2 /*return*/, {
                                             data: data[key_1],
-                                            nextToken: nextToken,
+                                            nextToken: data[key_1].nextToken,
                                             extensions: extensions,
                                         }];
                                 }
@@ -93,6 +94,163 @@ export function generateModelsProperty(client, params) {
                     }));
                 };
             }
+            else if (operation === 'OBSERVE_QUERY') {
+                models[name_1][operationPrefix] = function (arg, options) {
+                    return new Observable(function (subscriber) {
+                        // what we'll be sending to our subscribers
+                        var items = [];
+                        // To enqueue subscription messages while we collect our initial
+                        // result set.
+                        var messageQueue = [];
+                        // operation to take when message(s) arrive.
+                        // this operation will be swapped out once initial "sync" is complete
+                        // to immediately ingest messsages.
+                        var receiveMessages = function () {
+                            var messages = [];
+                            for (var _i = 0; _i < arguments.length; _i++) {
+                                messages[_i] = arguments[_i];
+                            }
+                            return messageQueue.push.apply(messageQueue, __spreadArray([], __read(messages), false));
+                        };
+                        // start subscriptions
+                        var onCreateSub = models[name_1]
+                            .onCreate(arg, options)
+                            .subscribe({
+                            next: function (item) {
+                                receiveMessages({ item: item, type: 'create' });
+                            },
+                            error: function (error) {
+                                subscriber.error({ type: 'onCreate', error: error });
+                            },
+                        });
+                        var onUpdateSub = models[name_1]
+                            .onUpdate(arg, options)
+                            .subscribe({
+                            next: function (item) {
+                                receiveMessages({ item: item, type: 'update' });
+                            },
+                            error: function (error) {
+                                subscriber.error({ type: 'onUpdate', error: error });
+                            },
+                        });
+                        var onDeleteSub = models[name_1]
+                            .onDelete(arg, options)
+                            .subscribe({
+                            next: function (item) {
+                                receiveMessages({ item: item, type: 'delete' });
+                            },
+                            error: function (error) {
+                                subscriber.error({ type: 'onDelete', error: error });
+                            },
+                        });
+                        // consumes a list of messages and sends a snapshot
+                        function ingestMessages(messages) {
+                            var e_2, _a;
+                            try {
+                                for (var messages_1 = __values(messages), messages_1_1 = messages_1.next(); !messages_1_1.done; messages_1_1 = messages_1.next()) {
+                                    var message = messages_1_1.value;
+                                    var idx = findIndexByFields(message.item, items, pkFields);
+                                    switch (message.type) {
+                                        case 'create':
+                                            if (idx < 0)
+                                                items.push(message.item);
+                                            break;
+                                        case 'update':
+                                            if (idx >= 0)
+                                                items[idx] = message.item;
+                                            break;
+                                        case 'delete':
+                                            if (idx >= 0)
+                                                items.splice(idx, 1);
+                                            break;
+                                        default:
+                                            console.error('Unrecognized message in observeQuery.', message);
+                                    }
+                                }
+                            }
+                            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+                            finally {
+                                try {
+                                    if (messages_1_1 && !messages_1_1.done && (_a = messages_1.return)) _a.call(messages_1);
+                                }
+                                finally { if (e_2) throw e_2.error; }
+                            }
+                            subscriber.next({
+                                items: items,
+                                isSynced: true,
+                            });
+                        }
+                        var pkFields = resolvePKFields(model);
+                        // initial results
+                        (function () { return __awaiter(_this, void 0, void 0, function () {
+                            var firstPage, nextToken, _a, page, errors, _nextToken, isSynced, errors_1, errors_1_1, error;
+                            var e_3, _b;
+                            return __generator(this, function (_c) {
+                                switch (_c.label) {
+                                    case 0:
+                                        firstPage = true;
+                                        nextToken = null;
+                                        _c.label = 1;
+                                    case 1:
+                                        if (!(!subscriber.closed && (firstPage || nextToken))) return [3 /*break*/, 3];
+                                        firstPage = false;
+                                        return [4 /*yield*/, models[name_1].list(__assign(__assign({}, arg), { nextToken: nextToken }), options)];
+                                    case 2:
+                                        _a = _c.sent(), page = _a.data, errors = _a.errors, _nextToken = _a.nextToken;
+                                        nextToken = _nextToken;
+                                        items.push.apply(items, __spreadArray([], __read(page), false));
+                                        isSynced = messageQueue.length === 0 &&
+                                            (nextToken === null || nextToken === undefined);
+                                        subscriber.next({
+                                            items: items,
+                                            isSynced: isSynced,
+                                        });
+                                        if (Array.isArray(errors)) {
+                                            try {
+                                                for (errors_1 = (e_3 = void 0, __values(errors)), errors_1_1 = errors_1.next(); !errors_1_1.done; errors_1_1 = errors_1.next()) {
+                                                    error = errors_1_1.value;
+                                                    subscriber.error(error);
+                                                }
+                                            }
+                                            catch (e_3_1) { e_3 = { error: e_3_1 }; }
+                                            finally {
+                                                try {
+                                                    if (errors_1_1 && !errors_1_1.done && (_b = errors_1.return)) _b.call(errors_1);
+                                                }
+                                                finally { if (e_3) throw e_3.error; }
+                                            }
+                                        }
+                                        return [3 /*break*/, 1];
+                                    case 3:
+                                        // play through the queue
+                                        if (messageQueue.length > 0) {
+                                            ingestMessages(messageQueue);
+                                        }
+                                        // switch the queue to write directly to the items collection
+                                        receiveMessages = function () {
+                                            var messages = [];
+                                            for (var _i = 0; _i < arguments.length; _i++) {
+                                                messages[_i] = arguments[_i];
+                                            }
+                                            ingestMessages(messages);
+                                            return items.length;
+                                        };
+                                        return [2 /*return*/];
+                                }
+                            });
+                        }); })();
+                        // when subscriber unsubscribes, tear down internal subs
+                        return function () {
+                            // 1. tear down internal subs
+                            onCreateSub.unsubscribe();
+                            onUpdateSub.unsubscribe();
+                            onDeleteSub.unsubscribe();
+                            // 2. there is no need to explicitly stop paging. instead, we
+                            // just check `subscriber.closed` above before fetching each page.
+                        };
+                    });
+                };
+            }
             else {
                 models[name_1][operationPrefix] = function (arg, options) { return __awaiter(_this, void 0, void 0, function () {
                     var query, variables, _a, data, extensions, _b, key_2, flattenedResult, _c, initialized, error_2;