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

package/lib-esm/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-esm/utils/resolveOwnerFields.js

@@ -0,0 +1,59 @@
+import { __values } from "tslib";
+/**
+ * Given an introspection schema model, returns all owner fields.
+ *
+ * @param model Model from an introspection schema
+ * @returns List of owner field names
+ */
+export function resolveOwnerFields(model) {
+    var e_1, _a, e_2, _b;
+    var ownerFields = new Set();
+    try {
+        for (var _c = __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, __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);
+}
+/**
+ * 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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@aws-amplify/api-graphql",
-	"version": "4.0.1-api-v6-models.572a7b5.0+572a7b5",
+	"version": "4.0.1-api-v6-models.9493d4d.0+9493d4d",
 	"description": "Api-graphql category of aws-amplify",
 	"main": "./lib/index.js",
 	"module": "./lib-esm/index.js",
@@ -52,9 +52,9 @@
 	],
 	"dependencies": {
 		"@aws-amplify/amplify-api-next-types-alpha": "^0.2.0",
-		"@aws-amplify/api-rest": "4.0.1-api-v6-models.572a7b5.0+572a7b5",
-		"@aws-amplify/auth": "6.0.1-api-v6-models.572a7b5.0+572a7b5",
-		"@aws-amplify/core": "6.0.1-api-v6-models.572a7b5.0+572a7b5",
+		"@aws-amplify/api-rest": "4.0.1-api-v6-models.9493d4d.0+9493d4d",
+		"@aws-amplify/auth": "6.0.1-api-v6-models.9493d4d.0+9493d4d",
+		"@aws-amplify/core": "6.0.1-api-v6-models.9493d4d.0+9493d4d",
 		"@aws-sdk/types": "3.387.0",
 		"graphql": "15.8.0",
 		"rxjs": "^7.8.1",
@@ -126,5 +126,5 @@
 			"<rootDir>/__tests__"
 		]
 	},
-	"gitHead": "572a7b56d9e87ca779038254de3d68b5c607af07"
+	"gitHead": "9493d4d9a9fb9bfa104c0cf56e5a1d3154daa088"
 }

package/src/internals/APIClient.ts

@@ -1,5 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+import { resolveOwnerFields } from '../utils/resolveOwnerFields';
+
 type ListArgs = { selectionSet?: string[]; filter?: {} };
 
 const connectionType = {
@@ -152,6 +154,9 @@ export const graphQLOperationsInfo = {
 	UPDATE: { operationPrefix: 'update' as const, usePlural: false },
 	DELETE: { operationPrefix: 'delete' as const, usePlural: false },
 	LIST: { operationPrefix: 'list' as const, usePlural: true },
+	ONCREATE: { operationPrefix: 'onCreate' as const, usePlural: false },
+	ONUPDATE: { operationPrefix: 'onUpdate' as const, usePlural: false },
+	ONDELETE: { operationPrefix: 'onDelete' as const, usePlural: false },
 };
 export type ModelOperation = keyof typeof graphQLOperationsInfo;
 
@@ -159,13 +164,21 @@ type OperationPrefix =
 	(typeof graphQLOperationsInfo)[ModelOperation]['operationPrefix'];
 
 const graphQLDocumentsCache = new Map<string, Map<ModelOperation, string>>();
-const SELECTION_SET_ALL_NESTED = '*';
+const SELECTION_SET_WILDCARD = '*';
 
 function defaultSelectionSetForModel(modelDefinition: any): string[] {
+	// fields that are explicitly part of the graphql schema; not
+	// inferred from owner auth rules.
 	const { fields } = modelDefinition;
-	return Object.values<any>(fields)
+	const explicitFields = Object.values<any>(fields)
 		.map(({ type, name }) => 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.
+	const ownerFields = resolveOwnerFields(modelDefinition);
+
+	return Array.from(new Set(explicitFields.concat(ownerFields)));
 }
 
 const FIELD_IR = '';
@@ -195,78 +208,70 @@ export function customSelectionSetToIR(
 	selectionSet: string[]
 ): Record<string, string | object> {
 	const modelDefinition = modelIntrospection[modelName];
-	const { fields } = modelDefinition;
+	const { fields: modelFields } = modelDefinition;
 
-	const intermediateSelectionSet: Record<string, string | object> = {};
-
-	for (const f of selectionSet) {
-		const nested = f.includes('.');
+	return selectionSet.reduce((resultObj, path) => {
+		const [fieldName, nested, ...rest] = path.split('.');
 
 		if (nested) {
-			const [modelFieldName, selectedField] = f.split('.');
-
-			const relatedModel = fields[modelFieldName]?.type?.model;
+			const relatedModel = modelFields[fieldName]?.type?.model;
 
 			if (!relatedModel) {
 				// TODO: may need to change this to support custom types
-				throw Error(`${modelFieldName} is not a model field`);
+				throw Error(`${fieldName} is not a model field`);
 			}
 
-			if (selectedField === SELECTION_SET_ALL_NESTED) {
-				const relatedModelDefinition = modelIntrospection[relatedModel];
+			const relatedModelDefinition = modelIntrospection[relatedModel];
 
-				const defaultSelectionSet = defaultSelectionSetForModel(
-					relatedModelDefinition
-				);
+			const selectionSet =
+				nested === SELECTION_SET_WILDCARD
+					? defaultSelectionSetIR(relatedModelDefinition)
+					: // if we have a path like 'field.anotherField' recursively build up selection set IR
+					  customSelectionSetToIR(modelIntrospection, relatedModel, [
+							[nested, ...rest].join('.'),
+					  ]);
 
-				const reduced = defaultSelectionSet.reduce((acc, curVal) => {
-					acc[curVal] = FIELD_IR;
-					return acc;
-				}, {});
+			if (modelFields[fieldName]?.isArray) {
+				const existing = resultObj[fieldName] || {
+					items: {},
+				};
+				const merged = { ...existing.items, ...selectionSet };
 
-				if (fields[modelFieldName]?.isArray) {
-					intermediateSelectionSet[modelFieldName] = {
-						items: reduced,
-					};
-				} else {
-					intermediateSelectionSet[modelFieldName] = reduced;
-				}
-			} else {
-				const getNestedSelSet = customSelectionSetToIR(
-					modelIntrospection,
-					relatedModel,
-					[selectedField]
-				);
-
-				if (fields[modelFieldName]?.isArray) {
-					const existing = (intermediateSelectionSet as any)[
-						modelFieldName
-					] || { items: {} };
-					const merged = { ...existing.items, ...getNestedSelSet };
+				resultObj[fieldName] = { items: merged };
+				return resultObj;
+			}
 
-					intermediateSelectionSet[modelFieldName] = { items: merged };
-				} else {
-					const existingItems =
-						(intermediateSelectionSet as any)[modelFieldName] || {};
-					const merged = { ...existingItems, ...getNestedSelSet };
+			const existingItems = resultObj[fieldName] || {};
+			const merged = { ...existingItems, ...selectionSet };
 
-					intermediateSelectionSet[modelFieldName] = merged;
-				}
-			}
-		} else {
-			const exists = Boolean(fields[f]);
+			resultObj[fieldName] = merged;
+			return resultObj;
+		}
 
-			if (!exists) {
-				throw Error(`${f} is not a field of model ${modelName}`);
-			}
+		const exists = Boolean(modelFields[fieldName]);
 
-			intermediateSelectionSet[f] = FIELD_IR;
+		if (!exists) {
+			throw Error(`${fieldName} is not a field of model ${modelName}`);
 		}
-	}
 
-	return intermediateSelectionSet;
+		resultObj[fieldName] = FIELD_IR;
+		return resultObj;
+	}, {});
 }
 
+const defaultSelectionSetIR = relatedModelDefinition => {
+	const defaultSelectionSet = defaultSelectionSetForModel(
+		relatedModelDefinition
+	);
+
+	const reduced = defaultSelectionSet.reduce((acc, curVal) => {
+		acc[curVal] = FIELD_IR;
+		return acc;
+	}, {});
+
+	return reduced;
+};
+
 /**
  * Stringifies selection set IR
  * * @example
@@ -365,7 +370,7 @@ export function generateGraphQLDocument(
 	}
 
 	const graphQLFieldName = `${operationPrefix}${usePlural ? pluralName : name}`;
-	let graphQLOperationType: 'mutation' | 'query' | undefined;
+	let graphQLOperationType: 'mutation' | 'query' | 'subscription' | undefined;
 	let graphQLSelectionSet: string | undefined;
 	let graphQLArguments: Record<string, any> | undefined;
 
@@ -410,6 +415,15 @@ export function generateGraphQLDocument(
 			graphQLOperationType ?? (graphQLOperationType = 'query');
 			graphQLSelectionSet ??
 				(graphQLSelectionSet = `items { ${selectionSetFields} }`);
+		case 'ONCREATE':
+		case 'ONUPDATE':
+		case 'ONDELETE':
+			graphQLArguments ??
+				(graphQLArguments = {
+					filter: `ModelSubscription${name}FilterInput`,
+				});
+			graphQLOperationType ?? (graphQLOperationType = 'subscription');
+			graphQLSelectionSet ?? (graphQLSelectionSet = selectionSetFields);
 	}
 
 	const graphQLDocument = `${graphQLOperationType}${
@@ -488,6 +502,9 @@ export function buildGraphQLVariables(
 			}
 			break;
 		case 'LIST':
+		case 'ONCREATE':
+		case 'ONUPDATE':
+		case 'ONDELETE':
 			if (arg?.filter) {
 				variables = { filter: arg.filter };
 			}

package/src/internals/generateModelsProperty.ts

@@ -10,7 +10,8 @@ import {
 	flattenItems,
 } from './APIClient';
 import { ClientGenerationParams } from './types';
-import { V6Client } from '../types';
+import { V6Client, GraphqlSubscriptionResult } from '../types';
+import { Observable, map } from 'rxjs';
 
 export function generateModelsProperty<T extends Record<any, any> = never>(
 	client: V6Client,
@@ -102,6 +103,32 @@ export function generateModelsProperty<T extends Record<any, any> = never>(
 							}
 						}
 					};
+				} else if (['ONCREATE', 'ONUPDATE', 'ONDELETE'].includes(operation)) {
+					models[name][operationPrefix] = (arg?: any, options?: any) => {
+						const query = generateGraphQLDocument(
+							modelIntrospection.models,
+							name,
+							operation
+						);
+						const variables = buildGraphQLVariables(
+							model,
+							operation,
+							arg,
+							modelIntrospection
+						);
+
+						const observable = client.graphql({
+							query,
+							variables,
+						}) as GraphqlSubscriptionResult<object>;
+
+						return observable.pipe(
+							map(value => {
+								const [key] = Object.keys(value.data);
+								return value.data[key];
+							})
+						);
+					};
 				} else {
 					models[name][operationPrefix] = async (arg?: any, options?: any) => {
 						const query = generateGraphQLDocument(

package/src/utils/resolveOwnerFields.ts

@@ -0,0 +1,65 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+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];
+
+type AuthAttribute = {
+	type: 'auth';
+	properties: {
+		rules: AuthRule[];
+	};
+};
+
+/**
+ * Only the portions of an Auth rule we care about.
+ */
+type AuthRule = {
+	allow: string;
+	ownerField?: string;
+};
+
+/**
+ * Given an introspection schema model, returns all owner fields.
+ *
+ * @param model Model from an introspection schema
+ * @returns List of owner field names
+ */
+export function resolveOwnerFields(model: Model): string[] {
+	const ownerFields = new Set<string>();
+	for (const attr of model.attributes || []) {
+		if (isAuthAttribute(attr)) {
+			for (const rule of attr.properties.rules) {
+				if (rule.allow === 'owner') {
+					ownerFields.add(rule.ownerField || 'owner');
+				}
+			}
+		}
+	}
+	return Array.from(ownerFields);
+}
+
+/**
+ * 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: any): attribute is AuthAttribute {
+	if (attribute?.type === 'auth') {
+		if (typeof attribute?.properties === 'object') {
+			if (Array.isArray(attribute?.properties?.rules)) {
+				return (attribute?.properties?.rules as Array<any>).every(
+					rule => !!rule.allow
+				);
+			}
+		}
+	}
+	return false;
+}