@aws-amplify/api-graphql 4.0.1-unstable.cfbde4c.0 → 4.0.2-unstable.b778a9e.0

package/src/types/index.ts

@@ -1,6 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import { AmplifyClassV6, ResourcesConfig } from '@aws-amplify/core';
+import { ModelTypes } from '@aws-amplify/data-schema-types';
 import { Source, DocumentNode, GraphQLError } from 'graphql';
 export { OperationTypeNode } from 'graphql';
 import { Observable } from 'rxjs';
@@ -12,6 +13,11 @@ import {
 import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
 
 export { CONTROL_MSG, ConnectionState } from './PubSub';
+
+export { SelectionSet } from '@aws-amplify/data-schema-types';
+
+export { CommonPublicClientOptions } from '../internals/types';
+
 /**
  * Loose/Unknown options for raw GraphQLAPICategory `graphql()`.
  */
@@ -349,25 +355,45 @@ export type GeneratedSubscription<InputType, OutputType> = string & {
 type FilteredKeys<T> = {
 	[P in keyof T]: T[P] extends never ? never : P;
 }[keyof T];
+
 type ExcludeNeverFields<O> = {
 	[K in FilteredKeys<O>]: O[K];
 };
 
 export const __amplify = Symbol('amplify');
+export const __authMode = Symbol('authMode');
+export const __authToken = Symbol('authToken');
 
 export type V6Client<T extends Record<any, any> = never> = ExcludeNeverFields<{
 	[__amplify]: AmplifyClassV6;
+	[__authMode]?: GraphQLAuthMode;
+	[__authToken]?: string;
 	graphql: GraphQLMethod;
 	cancel: (promise: Promise<any>, message?: string) => boolean;
 	isCancelError: (error: any) => boolean;
+	models: ModelTypes<T>;
 }>;
 
-export type V6ClientSSR<T extends Record<any, any> = never> =
+export type V6ClientSSRRequest<T extends Record<any, any> = never> =
 	ExcludeNeverFields<{
 		[__amplify]: AmplifyClassV6;
+		[__authMode]?: GraphQLAuthMode;
+		[__authToken]?: string;
 		graphql: GraphQLMethodSSR;
 		cancel: (promise: Promise<any>, message?: string) => boolean;
 		isCancelError: (error: any) => boolean;
+		models: ModelTypes<T, 'REQUEST'>;
+	}>;
+
+export type V6ClientSSRCookies<T extends Record<any, any> = never> =
+	ExcludeNeverFields<{
+		[__amplify]: AmplifyClassV6;
+		[__authMode]?: GraphQLAuthMode;
+		[__authToken]?: string;
+		graphql: GraphQLMethod;
+		cancel: (promise: Promise<any>, message?: string) => boolean;
+		isCancelError: (error: any) => boolean;
+		models: ModelTypes<T, 'COOKIES'>;
 	}>;
 
 export type GraphQLMethod = <
@@ -404,7 +430,7 @@ export type ServerClientGenerationParams = {
 	amplify:
 		| null // null expected when used with `generateServerClient`
 		// closure expected with `generateServerClientUsingCookies`
-		| ((fn: (amplify: any) => Promise<any>) => Promise<AmplifyClassV6>);
+		| ((fn: (amplify: AmplifyClassV6) => Promise<any>) => Promise<any>);
 	// global env-sourced config use for retrieving modelIntro
 	config: ResourcesConfig;
 };

package/src/utils/findIndexByFields.ts

@@ -0,0 +1,29 @@
+// 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.
+ */
+export function findIndexByFields<T>(
+	needle: T,
+	haystack: T[],
+	keyFields: Array<keyof T>
+): number {
+	const searchObject = Object.fromEntries(
+		keyFields.map(fieldName => [fieldName, needle[fieldName]])
+	);
+
+	for (let i = 0; i < haystack.length; i++) {
+		if (
+			Object.keys(searchObject).every(k => searchObject[k] === haystack[i][k])
+		) {
+			return i;
+		}
+	}
+
+	return -1;
+}

package/src/utils/index.ts

@@ -3,3 +3,5 @@
 
 export { resolveConfig } from './resolveConfig';
 export { resolveLibraryOptions } from './resolveLibraryOptions';
+export { resolvePKFields } from './resolvePKFields';
+export { findIndexByFields } from './findIndexByFields';

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;
+}

package/src/utils/resolvePKFields.ts

@@ -0,0 +1,22 @@
+// 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 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 function resolvePKFields(model: SchemaModel) {
+	const { primaryKeyFieldName, sortKeyFieldNames } = model.primaryKeyInfo;
+	return [primaryKeyFieldName, ...sortKeyFieldNames];
+}

package/lib/GraphQLAPI.d.ts

@@ -1,38 +0,0 @@
-import { AmplifyClassV6 } from '@aws-amplify/core';
-import { GraphQLOptions, GraphQLResult } from './types';
-import { InternalGraphQLAPIClass } from './internals';
-import { Observable } from 'rxjs';
-export declare const graphqlOperation: (query: any, variables?: {}, authToken?: string | undefined) => {
-    query: any;
-    variables: {};
-    authToken: string | undefined;
-};
-/**
- * Export Cloud Logic APIs
- */
-export declare class GraphQLAPIClass extends InternalGraphQLAPIClass {
-    getModuleName(): string;
-    /**
-     * Executes a GraphQL operation
-     *
-     * @param options - GraphQL Options
-     * @param [additionalHeaders] - headers to merge in after any `graphql_headers` set in the config
-     * @returns An Observable if the query is a subscription query, else a promise of the graphql result.
-     */
-    graphql<T = any>(amplify: AmplifyClassV6 | (() => Promise<AmplifyClassV6>), options: GraphQLOptions, additionalHeaders?: {
-        [key: string]: string;
-    }): Observable<GraphQLResult<T>> | Promise<GraphQLResult<T>>;
-    /**
-     * Checks to see if an error thrown is from an api request cancellation
-     * @param error - Any error
-     * @returns A boolean indicating if the error was from an api request cancellation
-     */
-    isCancelError(error: any): boolean;
-    /**
-     * Cancels an inflight request. Only applicable for graphql queries and mutations
-     * @param {any} request - request to cancel
-     * @returns A boolean indicating if the request was cancelled
-     */
-    cancel(request: Promise<any>, message?: string): boolean;
-}
-export declare const GraphQLAPI: GraphQLAPIClass;

package/lib/Providers/constants.d.ts

@@ -1,95 +0,0 @@
-export { AMPLIFY_SYMBOL } from '@aws-amplify/core/internals/utils';
-export declare const MAX_DELAY_MS = 5000;
-export declare const NON_RETRYABLE_CODES: number[];
-export declare const CONNECTION_STATE_CHANGE = "ConnectionStateChange";
-export declare enum MESSAGE_TYPES {
-    /**
-     * Client -> Server message.
-     * This message type is the first message after handshake and this will initialize AWS AppSync RealTime communication
-     */
-    GQL_CONNECTION_INIT = "connection_init",
-    /**
-     * Server -> Client message
-     * This message type is in case there is an issue with AWS AppSync RealTime when establishing connection
-     */
-    GQL_CONNECTION_ERROR = "connection_error",
-    /**
-     * Server -> Client message.
-     * This message type is for the ack response from AWS AppSync RealTime for GQL_CONNECTION_INIT message
-     */
-    GQL_CONNECTION_ACK = "connection_ack",
-    /**
-     * Client -> Server message.
-     * This message type is for register subscriptions with AWS AppSync RealTime
-     */
-    GQL_START = "start",
-    /**
-     * Server -> Client message.
-     * This message type is for the ack response from AWS AppSync RealTime for GQL_START message
-     */
-    GQL_START_ACK = "start_ack",
-    /**
-     * Server -> Client message.
-     * This message type is for subscription message from AWS AppSync RealTime
-     */
-    GQL_DATA = "data",
-    /**
-     * Server -> Client message.
-     * This message type helps the client to know is still receiving messages from AWS AppSync RealTime
-     */
-    GQL_CONNECTION_KEEP_ALIVE = "ka",
-    /**
-     * Client -> Server message.
-     * This message type is for unregister subscriptions with AWS AppSync RealTime
-     */
-    GQL_STOP = "stop",
-    /**
-     * Server -> Client message.
-     * This message type is for the ack response from AWS AppSync RealTime for GQL_STOP message
-     */
-    GQL_COMPLETE = "complete",
-    /**
-     * Server -> Client message.
-     * This message type is for sending error messages from AWS AppSync RealTime to the client
-     */
-    GQL_ERROR = "error"
-}
-export declare enum SUBSCRIPTION_STATUS {
-    PENDING = 0,
-    CONNECTED = 1,
-    FAILED = 2
-}
-export declare enum SOCKET_STATUS {
-    CLOSED = 0,
-    READY = 1,
-    CONNECTING = 2
-}
-export declare const AWS_APPSYNC_REALTIME_HEADERS: {
-    accept: string;
-    'content-encoding': string;
-    'content-type': string;
-};
-/**
- * Time in milleseconds to wait for GQL_CONNECTION_INIT message
- */
-export declare const CONNECTION_INIT_TIMEOUT = 15000;
-/**
- * Time in milleseconds to wait for GQL_START_ACK message
- */
-export declare const START_ACK_TIMEOUT = 15000;
-/**
- * Default Time in milleseconds to wait for GQL_CONNECTION_KEEP_ALIVE message
- */
-export declare const DEFAULT_KEEP_ALIVE_TIMEOUT: number;
-/**
- * Default Time in milleseconds to alert for missed GQL_CONNECTION_KEEP_ALIVE message
- */
-export declare const DEFAULT_KEEP_ALIVE_ALERT_TIMEOUT: number;
-/**
- * Default delay time in milleseconds between when reconnect is triggered vs when it is attempted
- */
-export declare const RECONNECT_DELAY: number;
-/**
- * Default interval time in milleseconds between when reconnect is re-attempted
- */
-export declare const RECONNECT_INTERVAL: number;

package/lib/index.d.ts

@@ -1,3 +0,0 @@
-export { GraphQLAPI, GraphQLAPIClass, graphqlOperation } from './GraphQLAPI';
-export * from './types';
-export { CONNECTION_STATE_CHANGE } from './Providers/constants';

package/lib/index.js

@@ -1,12 +0,0 @@
-"use strict";
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-var GraphQLAPI_1 = require("./GraphQLAPI");
-exports.GraphQLAPI = GraphQLAPI_1.GraphQLAPI;
-exports.GraphQLAPIClass = GraphQLAPI_1.GraphQLAPIClass;
-exports.graphqlOperation = GraphQLAPI_1.graphqlOperation;
-tslib_1.__exportStar(require("./types"), exports);
-var constants_1 = require("./Providers/constants");
-exports.CONNECTION_STATE_CHANGE = constants_1.CONNECTION_STATE_CHANGE;

package/lib/internals/index.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-var InternalGraphQLAPI_1 = require("./InternalGraphQLAPI");
-exports.InternalGraphQLAPI = InternalGraphQLAPI_1.InternalGraphQLAPI;
-exports.InternalGraphQLAPIClass = InternalGraphQLAPI_1.InternalGraphQLAPIClass;
-var v6_1 = require("./v6");
-exports.graphql = v6_1.graphql;
-exports.cancel = v6_1.cancel;
-exports.isCancelError = v6_1.isCancelError;

package/lib/internals/v6.d.ts

@@ -1,101 +0,0 @@
-import { V6Client, GraphQLOptionsV6, GraphQLResponseV6 } from '../types';
-/**
- * Invokes graphql operations against a graphql service, providing correct input and
- * output types if Amplify-generated graphql from a recent version of the CLI/codegen
- * are used *or* correct typing is provided via the type argument.
- *
- * Amplify-generated "branded" graphql queries will look similar to this:
- *
- * ```ts
- *                               //
- *                               // |-- branding
- *                               // v
- * export const getModel = `...` as GeneratedQuery<
- * 	GetModelQueryVariables,
- * 	GetModelQuery
- * >;
- * ```
- *
- * If this branding is not in your generated graphql, update to a newer version of
- * CLI/codegen and regenerate your graphql using `amplify codegen`.
- *
- * ## Using Amplify-generated graphql
- *
- * ```ts
- * import * as queries from './graphql/queries';
- *
- * //
- * //    |-- correctly typed graphql response containing a Widget
- * //    v
- * const queryResult = await graphql({
- * 	query: queries.getWidget,
- * 	variables: {
- * 		id: "abc", // <-- type hinted/enforced
- * 	},
- * });
- *
- * //
- * //    |-- a correctly typed Widget
- * //    v
- * const fetchedWidget = queryResult.data?.getWidget!;
- * ```
- *
- * ## Custom input + result types
- *
- * To provide input types (`variables`) and result types:
- *
- * ```ts
- * type GetById_NameOnly = {
- * 	variables: {
- * 		id: string
- * 	},
- * 	result: Promise<{
- * 		data: { getWidget: { name: string } }
- * 	}>
- * }
- *
- * //
- * //    |-- type is GetById_NameOnly["result"]
- * //    v
- * const result = graphql<GetById_NameOnly>({
- * 	query: "...",
- * 	variables: { id: "abc" }  // <-- type of GetById_NameOnly["variables"]
- * });
- * ```
- *
- * ## Custom result type only
- *
- * To specify result types only, use a type that is *not* in the `{variables, result}` shape:
- *
- * ```ts
- * type MyResultType = Promise<{
- * 	data: {
- * 		getWidget: { name: string }
- * 	}
- * }>
- *
- * //
- * //    |-- type is MyResultType
- * //    v
- * const result = graphql<MyResultType>({query: "..."});
- * ```
- *
- * @param options
- * @param additionalHeaders
- */
-export declare function graphql<FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(this: V6Client, options: GraphQLOptionsV6<FALLBACK_TYPES, TYPED_GQL_STRING>, additionalHeaders?: {
-    [key: string]: string;
-}): GraphQLResponseV6<FALLBACK_TYPES, TYPED_GQL_STRING>;
-/**
- * Cancels an inflight request. Only applicable for graphql queries and mutations
- * @param {any} request - request to cancel
- * @returns - A boolean indicating if the request was cancelled
- */
-export declare function cancel(this: V6Client, promise: Promise<any>, message?: string): boolean;
-/**
- * Checks to see if an error thrown is from an api request cancellation
- * @param {any} error - Any error
- * @returns - A boolean indicating if the error was from an api request cancellation
- */
-export declare function isCancelError(this: V6Client, error: any): boolean;
-export { GraphQLOptionsV6, GraphQLResponseV6 };