@aws-amplify/api-graphql 4.0.16-unstable.5e30055.0 → 4.0.16

package/src/internals/operations/indexQuery.ts

@@ -0,0 +1,169 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
+import {
+	initializeModel,
+	generateGraphQLDocument,
+	buildGraphQLVariables,
+	flattenItems,
+	authModeParams,
+	getCustomHeaders,
+} from '../APIClient';
+import {
+	AuthModeParams,
+	ClientWithModels,
+	ListArgs,
+	V6ClientSSRRequest,
+	GraphQLResult,
+	QueryArgs,
+} from '../../types';
+import {
+	ModelIntrospectionSchema,
+	SchemaModel,
+} from '@aws-amplify/core/internals/utils';
+
+export type IndexMeta = {
+	queryField: string;
+	pk: string;
+	sk?: string[];
+};
+
+export function indexQueryFactory(
+	client: ClientWithModels,
+	modelIntrospection: ModelIntrospectionSchema,
+	model: SchemaModel,
+	indexMeta: IndexMeta,
+	context = false,
+) {
+	const indexQueryWithContext = async (
+		contextSpec: AmplifyServer.ContextSpec,
+		args: QueryArgs,
+		options?: ListArgs,
+	) => {
+		return _indexQuery(
+			client,
+			modelIntrospection,
+			model,
+			indexMeta,
+			{
+				...args,
+				...options,
+			},
+			contextSpec,
+		);
+	};
+
+	const indexQuery = async (args: QueryArgs, options?: ListArgs) => {
+		return _indexQuery(client, modelIntrospection, model, indexMeta, {
+			...args,
+			...options,
+		});
+	};
+
+	return context ? indexQueryWithContext : indexQuery;
+}
+
+function processGraphQlResponse(
+	result: GraphQLResult<any>,
+	selectionSet: undefined | string[],
+	modelInitializer: (flattenedResult: any[]) => any[],
+) {
+	const { data, extensions } = result;
+
+	const [key] = Object.keys(data);
+
+	if (data[key].items) {
+		const flattenedResult = flattenItems(data)[key];
+
+		return {
+			data: selectionSet ? flattenedResult : modelInitializer(flattenedResult),
+			nextToken: data[key].nextToken,
+			extensions,
+		};
+	}
+
+	return {
+		data: data[key],
+		nextToken: data[key].nextToken,
+		extensions,
+	};
+}
+
+function handleGraphQlError(error: any) {
+	if (error.errors) {
+		// graphql errors pass through
+		return error as any;
+	} else {
+		// non-graphql errors re re-thrown
+		throw error;
+	}
+}
+
+async function _indexQuery(
+	client: ClientWithModels,
+	modelIntrospection: ModelIntrospectionSchema,
+	model: SchemaModel,
+	indexMeta: IndexMeta,
+	args?: ListArgs & AuthModeParams,
+	contextSpec?: AmplifyServer.ContextSpec,
+) {
+	const { name } = model;
+
+	const query = generateGraphQLDocument(
+		modelIntrospection.models,
+		name,
+		'INDEX_QUERY',
+		args,
+		indexMeta,
+	);
+	const variables = buildGraphQLVariables(
+		model,
+		'INDEX_QUERY',
+		args,
+		modelIntrospection,
+		indexMeta,
+	);
+
+	const auth = authModeParams(client, args);
+
+	const modelInitializer = (flattenedResult: any[]) =>
+		initializeModel(
+			client,
+			name,
+			flattenedResult,
+			modelIntrospection,
+			auth.authMode,
+			auth.authToken,
+			!!contextSpec,
+		);
+
+	try {
+		const headers = getCustomHeaders(client, args?.headers);
+
+		const graphQlParams = {
+			...auth,
+			query,
+			variables,
+		};
+
+		const requestArgs: [any, any] = [graphQlParams, headers];
+
+		if (contextSpec !== undefined) {
+			requestArgs.unshift(contextSpec);
+		}
+
+		const response = (await (
+			client as V6ClientSSRRequest<Record<string, any>>
+		).graphql(...requestArgs)) as GraphQLResult<any>;
+
+		if (response.data !== undefined) {
+			return processGraphQlResponse(
+				response,
+				args?.selectionSet,
+				modelInitializer,
+			);
+		}
+	} catch (error: any) {
+		return handleGraphQlError(error);
+	}
+}

package/src/internals/server/generateModelsProperty.ts

@@ -7,7 +7,9 @@ import { V6ClientSSRRequest, V6ClientSSRCookies } from '../../types';
 import { ModelIntrospectionSchema } from '@aws-amplify/core/internals/utils';
 
 import { listFactory } from '../operations/list';
+import { indexQueryFactory } from '../operations/indexQuery';
 import { getFactory } from '../operations/get';
+import { getSecondaryIndexesFromSchemaModel } from '../clientUtils';
 
 export function generateModelsProperty<
 	_T extends Record<any, any> = never,
@@ -59,7 +61,7 @@ export function generateModelsProperty<
 						client,
 						modelIntrospection,
 						model,
-						useContext
+						useContext,
 					);
 				} else {
 					models[name][operationPrefix] = getFactory(
@@ -67,11 +69,22 @@ export function generateModelsProperty<
 						modelIntrospection,
 						model,
 						operation,
-						useContext
+						useContext,
 					);
 				}
-			}
+			},
 		);
+
+		const secondaryIdxs = getSecondaryIndexesFromSchemaModel(model);
+
+		for (const idx of secondaryIdxs) {
+			models[name][idx.queryField] = indexQueryFactory(
+				client,
+				modelIntrospection,
+				model,
+				idx,
+			);
+		}
 	}
 
 	return models;