@aws-amplify/api-graphql 4.0.1-api-v6-models.572a7b5.0 → 4.0.1-api-v6-models.9493d4d.0

package/lib/utils/resolveOwnerFields.d.ts

@@ -0,0 +1,12 @@
+import { ResourcesConfig } from '@aws-amplify/core';
+type GraphQLConfig = Exclude<ResourcesConfig['API'], undefined>['GraphQL'];
+type ModelIntrospectionSchema = Exclude<Exclude<GraphQLConfig, undefined>['modelIntrospection'], undefined>;
+type Model = ModelIntrospectionSchema['models'][string];
+/**
+ * Given an introspection schema model, returns all owner fields.
+ *
+ * @param model Model from an introspection schema
+ * @returns List of owner field names
+ */
+export declare function resolveOwnerFields(model: Model): string[];
+export {};

package/lib/utils/resolveOwnerFields.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolveOwnerFields = void 0;
+var tslib_1 = require("tslib");
+/**
+ * Given an introspection schema model, returns all owner fields.
+ *
+ * @param model Model from an introspection schema
+ * @returns List of owner field names
+ */
+function resolveOwnerFields(model) {
+    var e_1, _a, e_2, _b;
+    var ownerFields = new Set();
+    try {
+        for (var _c = tslib_1.__values(model.attributes || []), _d = _c.next(); !_d.done; _d = _c.next()) {
+            var attr = _d.value;
+            if (isAuthAttribute(attr)) {
+                try {
+                    for (var _e = (e_2 = void 0, tslib_1.__values(attr.properties.rules)), _f = _e.next(); !_f.done; _f = _e.next()) {
+                        var rule = _f.value;
+                        if (rule.allow === 'owner') {
+                            ownerFields.add(rule.ownerField || 'owner');
+                        }
+                    }
+                }
+                catch (e_2_1) { e_2 = { error: e_2_1 }; }
+                finally {
+                    try {
+                        if (_f && !_f.done && (_b = _e.return)) _b.call(_e);
+                    }
+                    finally { if (e_2) throw e_2.error; }
+                }
+            }
+        }
+    }
+    catch (e_1_1) { e_1 = { error: e_1_1 }; }
+    finally {
+        try {
+            if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
+        }
+        finally { if (e_1) throw e_1.error; }
+    }
+    return Array.from(ownerFields);
+}
+exports.resolveOwnerFields = resolveOwnerFields;
+/**
+ * Type guard that identifies an auth attribute with an attached rules list that
+ * specifies an `allow` attribute at a minimum.
+ *
+ * @param attribute Any object. Ideally a model introspection schema model attribute
+ * @returns True if given object is an auth attribute
+ */
+function isAuthAttribute(attribute) {
+    var _a, _b;
+    if ((attribute === null || attribute === void 0 ? void 0 : attribute.type) === 'auth') {
+        if (typeof (attribute === null || attribute === void 0 ? void 0 : attribute.properties) === 'object') {
+            if (Array.isArray((_a = attribute === null || attribute === void 0 ? void 0 : attribute.properties) === null || _a === void 0 ? void 0 : _a.rules)) {
+                return ((_b = attribute === null || attribute === void 0 ? void 0 : attribute.properties) === null || _b === void 0 ? void 0 : _b.rules).every(function (rule) { return !!rule.allow; });
+            }
+        }
+    }
+    return false;
+}

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

@@ -30,6 +30,18 @@ export declare const graphQLOperationsInfo: {
         operationPrefix: "list";
         usePlural: boolean;
     };
+    ONCREATE: {
+        operationPrefix: "onCreate";
+        usePlural: boolean;
+    };
+    ONUPDATE: {
+        operationPrefix: "onUpdate";
+        usePlural: boolean;
+    };
+    ONDELETE: {
+        operationPrefix: "onDelete";
+        usePlural: boolean;
+    };
 };
 export type ModelOperation = keyof typeof graphQLOperationsInfo;
 /**

package/lib-esm/internals/APIClient.js

@@ -1,4 +1,7 @@
 import { __assign, __read, __spreadArray, __values } from "tslib";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { resolveOwnerFields } from '../utils/resolveOwnerFields';
 var connectionType = {
     HAS_ONE: 'HAS_ONE',
     HAS_MANY: 'HAS_MANY',
@@ -134,17 +137,26 @@ export var graphQLOperationsInfo = {
     UPDATE: { operationPrefix: 'update', usePlural: false },
     DELETE: { operationPrefix: 'delete', usePlural: false },
     LIST: { operationPrefix: 'list', usePlural: true },
+    ONCREATE: { operationPrefix: 'onCreate', usePlural: false },
+    ONUPDATE: { operationPrefix: 'onUpdate', usePlural: false },
+    ONDELETE: { operationPrefix: 'onDelete', 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.
     var fields = modelDefinition.fields;
-    return Object.values(fields)
+    var explicitFields = Object.values(fields)
         .map(function (_a) {
         var type = _a.type, name = _a.name;
         return typeof type === 'string' && name;
     }) // Default selection set omits model fields
         .filter(Boolean);
+    // fields used for owner auth rules that may or may not also
+    // be explicit on the model.
+    var ownerFields = resolveOwnerFields(modelDefinition);
+    return Array.from(new Set(explicitFields.concat(ownerFields)));
 }
 var FIELD_IR = '';
 /**
@@ -167,70 +179,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
@@ -317,6 +312,14 @@ export function generateGraphQLDocument(modelIntrospection, modelName, modelOper
             });
             graphQLOperationType !== null && graphQLOperationType !== void 0 ? graphQLOperationType : (graphQLOperationType = 'query');
             graphQLSelectionSet !== null && graphQLSelectionSet !== void 0 ? graphQLSelectionSet : (graphQLSelectionSet = "items { ".concat(selectionSetFields, " }"));
+        case 'ONCREATE':
+        case 'ONUPDATE':
+        case 'ONDELETE':
+            graphQLArguments !== null && graphQLArguments !== void 0 ? graphQLArguments : (graphQLArguments = {
+                filter: "ModelSubscription".concat(name, "FilterInput"),
+            });
+            graphQLOperationType !== null && graphQLOperationType !== void 0 ? graphQLOperationType : (graphQLOperationType = 'subscription');
+            graphQLSelectionSet !== null && graphQLSelectionSet !== void 0 ? graphQLSelectionSet : (graphQLSelectionSet = selectionSetFields);
     }
     var graphQLDocument = "".concat(graphQLOperationType).concat(graphQLArguments
         ? "(".concat(Object.entries(graphQLArguments).map(function (_a) {
@@ -364,6 +367,9 @@ export function buildGraphQLVariables(modelDefinition, operation, arg, modelIntr
             }
             break;
         case 'LIST':
+        case 'ONCREATE':
+        case 'ONUPDATE':
+        case 'ONDELETE':
             if (arg === null || arg === void 0 ? void 0 : arg.filter) {
                 variables = { filter: arg.filter };
             }

package/lib-esm/internals/generateModelsProperty.js

@@ -1,5 +1,6 @@
 import { __awaiter, __generator, __read, __values } from "tslib";
 import { initializeModel, generateGraphQLDocument, buildGraphQLVariables, graphQLOperationsInfo, flattenItems, } from './APIClient';
+import { map } from 'rxjs';
 export function generateModelsProperty(client, params) {
     var e_1, _a;
     var _this = this;
@@ -78,6 +79,20 @@ export function generateModelsProperty(client, params) {
                     });
                 }); };
             }
+            else if (['ONCREATE', 'ONUPDATE', 'ONDELETE'].includes(operation)) {
+                models[name_1][operationPrefix] = function (arg, options) {
+                    var query = generateGraphQLDocument(modelIntrospection.models, name_1, operation);
+                    var variables = buildGraphQLVariables(model, operation, arg, modelIntrospection);
+                    var observable = client.graphql({
+                        query: query,
+                        variables: variables,
+                    });
+                    return observable.pipe(map(function (value) {
+                        var _a = __read(Object.keys(value.data), 1), key = _a[0];
+                        return value.data[key];
+                    }));
+                };
+            }
             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;