@aws-amplify/api-graphql 3.4.3 → 3.4.4-graphql-api-functional-options.2

package/src/types/facade-iterable-paging.ts

@@ -0,0 +1,200 @@
+// import { Observable } from 'zen-observable-ts';
+// import { GraphQLOptions } from './index';
+import { GraphQLError } from 'graphql';
+import { Auth, API } from 'aws-amplify';
+
+// #region shared API types ... probably to be pulled from core or something later.
+
+// original
+// export interface GraphQLResult<T = object> {
+// 	data?: T;
+// 	errors?: GraphQLError[];
+// 	extensions?: {
+// 		[key: string]: any;
+// 	};
+// }
+
+/**
+ *
+ * ```
+ * type T = UnionOfKeysOf<{x: string, y: string}>;
+ *      ^
+ *      "x" | "y"
+ * ```
+ */
+type UnionOfKeysOf<T> = {
+	[K in keyof T]: T extends Record<K, any> ? K : never;
+}[keyof T];
+
+/**
+ * Digs down a layer into an object to extract a union of all the property
+ * types.
+ *
+ * ```
+ * type T = Dig<{ x: { a: string, b: number }, y: { c: boolean } }>;
+ *      ^
+ *      {
+ *        a: string;
+ *        b: number;
+ *      } | {
+ *        c: boolean;
+ *      }
+ * ```
+ *
+ * This is particularly useful for extracting the type when a single property
+ * exists on an object and we just want to "skip" it or "dig it out".
+ *
+ * ```
+ * type T = Dig<{x: { a: string, b: number }}>;
+ *      ^
+ *      {
+ *        a: string;
+ *        b: number;
+ *      }
+ * ```
+ *
+ */
+type Dig<T> = T[keyof T];
+
+type Iterated<T> = T extends Array<infer IT>
+	? AsyncGenerator<Exclude<IT, null>>
+	: T;
+
+type WithIterablesInsteadOfArrays<T> = T extends { items: infer IT }
+	? Iterated<IT>
+	: T;
+
+export type GraphQLResult<T = object> = {
+	data: WithIterablesInsteadOfArrays<Dig<T>>;
+	errors?: GraphQLError[];
+	extensions?: {
+		[key: string]: any;
+	};
+};
+
+type UnionKeys<T> = T extends T ? keyof T : never;
+type StrictUnionHelper<T, TAll> = T extends any
+	? T & Partial<Record<Exclude<UnionKeys<TAll>, keyof T>, undefined>>
+	: never;
+export type StrictUnion<T> = StrictUnionHelper<T, T>;
+export type SimpleAuthMode = {
+	authMode?: 'AMAZON_COGNITO_USERPOOLS' | 'API_KEY' | 'AWS_IAM';
+};
+
+export type LambdaAuthMode = {
+	authMode: 'AWS_LAMBDA';
+	authToken: string;
+};
+
+export type AuthMode = StrictUnion<SimpleAuthMode | LambdaAuthMode>;
+
+// #endregion
+
+export type GeneratedQuery<InputType, OutputType> = string & {
+	__generatedQueryInput: InputType;
+	__generatedQueryOutput: OutputType;
+};
+
+export type GraphqlQueryOverrides<IN extends {}, OUT extends {}> = {
+	variables: IN;
+	result: OUT;
+};
+
+export type GraphqlQueryParams<
+	TYPED_GQL_STRING extends string,
+	FALLBACK_TYPES
+> = AuthMode & {
+	variables: TYPED_GQL_STRING extends GeneratedQuery<infer IN, infer OUT>
+		? IN
+		: FALLBACK_TYPES extends GraphqlQueryOverrides<infer IN, infer OUT>
+		? IN
+		: any;
+};
+
+export type GraphqlQueryResult<T extends string, S> = T extends GeneratedQuery<
+	infer IN,
+	infer OUT
+>
+	? GraphQLResult<OUT>
+	: S extends GraphqlQueryOverrides<infer IN, infer OUT>
+	? GraphQLResult<OUT>
+	: any;
+
+// e.g.
+export type ListThreadsQuery = {
+	listThreads?: {
+		__typename: 'ModelThreadConnection';
+		items: Array<{
+			__typename: 'Thread';
+			id: string;
+			topic?: string | null;
+			comments?: {
+				__typename: 'ModelCommentConnection';
+				nextToken?: string | null;
+			} | null;
+			createdAt?: string | null;
+			updatedAt: string;
+			owner?: string | null;
+		} | null>;
+		nextToken?: string | null;
+	} | null;
+};
+
+/** GraphQL mutate */
+
+export type GeneratedMutation<InputType, OutputType> = string & {
+	__generatedMutationInput: InputType;
+	__generatedMutationOutput: OutputType;
+};
+
+export type GraphqlMutationParams<
+	TYPED_GQL_STRING extends string,
+	OVERRIDE_TYPE
+> = AuthMode & {
+	variables: TYPED_GQL_STRING extends GeneratedMutation<infer IN, infer OUT>
+		? IN
+		: OVERRIDE_TYPE extends GraphqlQueryOverrides<infer OVERRIDE_IN, infer OUT>
+		? OVERRIDE_IN
+		: any;
+};
+
+export type GraphqlMutationResult<
+	TYPED_GQL_STRING extends string,
+	FALLBACK_TYPES
+> = TYPED_GQL_STRING extends GeneratedMutation<infer IN, infer OUT>
+	? GraphQLResult<OUT>
+	: FALLBACK_TYPES extends GraphqlQueryOverrides<infer IN, infer OUT>
+	? GraphQLResult<OUT>
+	: any;
+
+/** GraphQL subscribe */
+
+export type GeneratedSubscription<InputType, OutputType> = string & {
+	__generatedSubscriptionInput: InputType;
+	__generatedSubscriptionOutput: OutputType;
+};
+
+export type GraphqlSubscriptionParams<
+	TYPED_GQL_STRING extends string,
+	FALLBACK_TYPES
+> = AuthMode & {
+	variables: TYPED_GQL_STRING extends GeneratedSubscription<infer IN, infer OUT>
+		? IN
+		: FALLBACK_TYPES extends GraphqlQueryOverrides<infer IN, infer OUT>
+		? IN
+		: any;
+};
+
+export type GraphqlSubscriptionResult<
+	TYPED_GQL_STRING extends string,
+	FALLBACK_TYPES
+> = {
+	value: {
+		data: TYPED_GQL_STRING extends GeneratedSubscription<infer IN, infer OUT>
+			? Dig<OUT>
+			: FALLBACK_TYPES extends GraphqlQueryOverrides<infer IN, infer OUT>
+			? Dig<OUT>
+			: any;
+	};
+	provider: any;
+};

package/src/types/facade-light-flattening.ts

@@ -0,0 +1,171 @@
+// import { Observable } from 'zen-observable-ts';
+// import { GraphQLOptions } from './index';
+import { GraphQLError } from 'graphql';
+
+// #region shared API types ... probably to be pulled from core or something later.
+
+// original
+// export interface GraphQLResult<T = object> {
+// 	data?: T;
+// 	errors?: GraphQLError[];
+// 	extensions?: {
+// 		[key: string]: any;
+// 	};
+// }
+
+/**
+ *
+ * ```
+ * type T = UnionOfKeysOf<{x: string, y: string}>;
+ *      ^
+ *      "x" | "y"
+ * ```
+ */
+type UnionOfKeysOf<T> = {
+	[K in keyof T]: T extends Record<K, any> ? K : never;
+}[keyof T];
+
+/**
+ * Digs down a layer into an object to extract a union of all the property
+ * types.
+ *
+ * ```
+ * type T = Dig<{ x: { a: string, b: number }, y: { c: boolean } }>;
+ *      ^
+ *      {
+ *        a: string;
+ *        b: number;
+ *      } | {
+ *        c: boolean;
+ *      }
+ * ```
+ *
+ * This is particularly useful for extracting the type when a single property
+ * exists on an object and we just want to "skip" it or "dig it out".
+ *
+ * ```
+ * type T = Dig<{x: { a: string, b: number }}>;
+ *      ^
+ *      {
+ *        a: string;
+ *        b: number;
+ *      }
+ * ```
+ *
+ */
+type Dig<T> = T[keyof T];
+
+export type GraphQLResult<T = object> = {
+	data: Dig<T>;
+	errors?: GraphQLError[];
+	extensions?: {
+		[key: string]: any;
+	};
+};
+
+type UnionKeys<T> = T extends T ? keyof T : never;
+type StrictUnionHelper<T, TAll> = T extends any
+	? T & Partial<Record<Exclude<UnionKeys<TAll>, keyof T>, undefined>>
+	: never;
+export type StrictUnion<T> = StrictUnionHelper<T, T>;
+export type SimpleAuthMode = {
+	authMode?: 'AMAZON_COGNITO_USERPOOLS' | 'API_KEY' | 'AWS_IAM';
+};
+
+export type LambdaAuthMode = {
+	authMode: 'AWS_LAMBDA';
+	authToken: string;
+};
+
+export type AuthMode = StrictUnion<SimpleAuthMode | LambdaAuthMode>;
+
+// #endregion
+
+export type GeneratedQuery<InputType, OutputType> = string & {
+	__generatedQueryInput: InputType;
+	__generatedQueryOutput: OutputType;
+};
+
+export type GraphqlQueryOverrides<IN extends {}, OUT extends {}> = {
+	variables: IN;
+	result: OUT;
+};
+
+export type GraphqlQueryParams<
+	TYPED_GQL_STRING extends string,
+	FALLBACK_TYPES
+> = AuthMode & {
+	variables: TYPED_GQL_STRING extends GeneratedQuery<infer IN, infer OUT>
+		? IN
+		: FALLBACK_TYPES extends GraphqlQueryOverrides<infer IN, infer OUT>
+		? IN
+		: any;
+};
+
+export type GraphqlQueryResult<T extends string, S> = T extends GeneratedQuery<
+	infer IN,
+	infer OUT
+>
+	? GraphQLResult<OUT>
+	: S extends GraphqlQueryOverrides<infer IN, infer OUT>
+	? GraphQLResult<OUT>
+	: any;
+
+/** GraphQL mutate */
+
+export type GeneratedMutation<InputType, OutputType> = string & {
+	__generatedMutationInput: InputType;
+	__generatedMutationOutput: OutputType;
+};
+
+export type GraphqlMutationParams<
+	TYPED_GQL_STRING extends string,
+	OVERRIDE_TYPE
+> = AuthMode & {
+	variables: TYPED_GQL_STRING extends GeneratedMutation<infer IN, infer OUT>
+		? IN
+		: OVERRIDE_TYPE extends GraphqlQueryOverrides<infer OVERRIDE_IN, infer OUT>
+		? OVERRIDE_IN
+		: any;
+};
+
+export type GraphqlMutationResult<
+	TYPED_GQL_STRING extends string,
+	FALLBACK_TYPES
+> = TYPED_GQL_STRING extends GeneratedMutation<infer IN, infer OUT>
+	? GraphQLResult<OUT>
+	: FALLBACK_TYPES extends GraphqlQueryOverrides<infer IN, infer OUT>
+	? GraphQLResult<OUT>
+	: any;
+
+/** GraphQL subscribe */
+
+export type GeneratedSubscription<InputType, OutputType> = string & {
+	__generatedSubscriptionInput: InputType;
+	__generatedSubscriptionOutput: OutputType;
+};
+
+export type GraphqlSubscriptionParams<
+	TYPED_GQL_STRING extends string,
+	FALLBACK_TYPES
+> = AuthMode & {
+	variables: TYPED_GQL_STRING extends GeneratedSubscription<infer IN, infer OUT>
+		? IN
+		: FALLBACK_TYPES extends GraphqlQueryOverrides<infer IN, infer OUT>
+		? IN
+		: any;
+};
+
+export type GraphqlSubscriptionResult<
+	TYPED_GQL_STRING extends string,
+	FALLBACK_TYPES
+> = {
+	value: {
+		data: TYPED_GQL_STRING extends GeneratedSubscription<infer IN, infer OUT>
+			? Dig<OUT>
+			: FALLBACK_TYPES extends GraphqlQueryOverrides<infer IN, infer OUT>
+			? Dig<OUT>
+			: any;
+	};
+	provider: any;
+};

package/src/types/facade-no-flattening.ts

@@ -0,0 +1,110 @@
+import { GraphQLResult } from './index';
+
+// #region shared API types ... probably to be pulled from core or something later.
+
+type UnionKeys<T> = T extends T ? keyof T : never;
+type StrictUnionHelper<T, TAll> = T extends any
+	? T & Partial<Record<Exclude<UnionKeys<TAll>, keyof T>, undefined>>
+	: never;
+export type StrictUnion<T> = StrictUnionHelper<T, T>;
+export type SimpleAuthMode = {
+	authMode?: 'AMAZON_COGNITO_USERPOOLS' | 'API_KEY' | 'AWS_IAM';
+};
+
+export type LambdaAuthMode = {
+	authMode: 'AWS_LAMBDA';
+	authToken: string;
+};
+
+export type AuthMode = StrictUnion<SimpleAuthMode | LambdaAuthMode>;
+
+// #endregion
+
+export type GeneratedQuery<InputType, OutputType> = string & {
+	__generatedQueryInput: InputType;
+	__generatedQueryOutput: OutputType;
+};
+
+export type GraphqlQueryOverrides<IN extends {}, OUT extends {}> = {
+	variables: IN;
+	result: OUT;
+};
+
+export type GraphqlQueryParams<
+	TYPED_GQL_STRING extends string,
+	FALLBACK_TYPES
+> = AuthMode & {
+	variables: TYPED_GQL_STRING extends GeneratedQuery<infer IN, infer OUT>
+		? IN
+		: FALLBACK_TYPES extends GraphqlQueryOverrides<infer IN, infer OUT>
+		? IN
+		: any;
+};
+
+export type GraphqlQueryResult<T extends string, S> = T extends GeneratedQuery<
+	infer IN,
+	infer OUT
+>
+	? GraphQLResult<OUT>
+	: S extends GraphqlQueryOverrides<infer IN, infer OUT>
+	? GraphQLResult<OUT>
+	: any;
+
+/** GraphQL mutate */
+
+export type GeneratedMutation<InputType, OutputType> = string & {
+	__generatedMutationInput: InputType;
+	__generatedMutationOutput: OutputType;
+};
+
+export type GraphqlMutationParams<
+	TYPED_GQL_STRING extends string,
+	OVERRIDE_TYPE
+> = AuthMode & {
+	variables: TYPED_GQL_STRING extends GeneratedMutation<infer IN, infer OUT>
+		? IN
+		: OVERRIDE_TYPE extends GraphqlQueryOverrides<infer OVERRIDE_IN, infer OUT>
+		? OVERRIDE_IN
+		: any;
+};
+
+export type GraphqlMutationResult<
+	TYPED_GQL_STRING extends string,
+	FALLBACK_TYPES
+> = TYPED_GQL_STRING extends GeneratedMutation<infer IN, infer OUT>
+	? GraphQLResult<OUT>
+	: FALLBACK_TYPES extends GraphqlQueryOverrides<infer IN, infer OUT>
+	? GraphQLResult<OUT>
+	: any;
+
+/** GraphQL subscribe */
+
+export type GeneratedSubscription<InputType, OutputType> = string & {
+	__generatedSubscriptionInput: InputType;
+	__generatedSubscriptionOutput: OutputType;
+};
+
+export type GraphqlSubscriptionParams<
+	TYPED_GQL_STRING extends string,
+	FALLBACK_TYPES
+> = AuthMode & {
+	variables: TYPED_GQL_STRING extends GeneratedSubscription<infer IN, infer OUT>
+		? IN
+		: FALLBACK_TYPES extends GraphqlQueryOverrides<infer IN, infer OUT>
+		? IN
+		: any;
+};
+
+export type GraphqlSubscriptionResult<
+	TYPED_GQL_STRING extends string,
+	FALLBACK_TYPES
+> = {
+	provider: any;
+	value: {
+		data: TYPED_GQL_STRING extends GeneratedSubscription<infer IN, infer OUT>
+			? OUT
+			: FALLBACK_TYPES extends GraphqlQueryOverrides<infer IN, infer OUT>
+			? OUT
+			: any;
+	};
+};

package/src/types/v6.ts

@@ -0,0 +1,110 @@
+import { GraphQLResult } from './index';
+
+// #region shared API types ... probably to be pulled from core or something later.
+
+type UnionKeys<T> = T extends T ? keyof T : never;
+type StrictUnionHelper<T, TAll> = T extends any
+	? T & Partial<Record<Exclude<UnionKeys<TAll>, keyof T>, undefined>>
+	: never;
+export type StrictUnion<T> = StrictUnionHelper<T, T>;
+export type SimpleAuthMode = {
+	authMode?: 'AMAZON_COGNITO_USERPOOLS' | 'API_KEY' | 'AWS_IAM';
+};
+
+export type LambdaAuthMode = {
+	authMode: 'AWS_LAMBDA';
+	authToken: string;
+};
+
+export type AuthMode = StrictUnion<SimpleAuthMode | LambdaAuthMode>;
+
+// #endregion
+
+export type GeneratedQuery<InputType, OutputType> = string & {
+	__generatedQueryInput: InputType;
+	__generatedQueryOutput: OutputType;
+};
+
+export type GraphqlQueryOverrides<IN extends {}, OUT extends {}> = {
+	variables: IN;
+	result: OUT;
+};
+
+export type GraphqlQueryParams<
+	TYPED_GQL_STRING extends string,
+	FALLBACK_TYPES
+> = AuthMode & {
+	variables: TYPED_GQL_STRING extends GeneratedQuery<infer IN, infer OUT>
+		? IN
+		: FALLBACK_TYPES extends GraphqlQueryOverrides<infer IN, infer OUT>
+		? IN
+		: any;
+};
+
+export type GraphqlQueryResult<T extends string, S> = T extends GeneratedQuery<
+	infer IN,
+	infer OUT
+>
+	? GraphQLResult<OUT>
+	: S extends GraphqlQueryOverrides<infer IN, infer OUT>
+	? GraphQLResult<OUT>
+	: any;
+
+/** GraphQL mutate */
+
+export type GeneratedMutation<InputType, OutputType> = string & {
+	__generatedMutationInput: InputType;
+	__generatedMutationOutput: OutputType;
+};
+
+export type GraphqlMutationParams<
+	TYPED_GQL_STRING extends string,
+	OVERRIDE_TYPE
+> = AuthMode & {
+	variables: TYPED_GQL_STRING extends GeneratedMutation<infer IN, infer OUT>
+		? IN
+		: OVERRIDE_TYPE extends GraphqlQueryOverrides<infer OVERRIDE_IN, infer OUT>
+		? OVERRIDE_IN
+		: any;
+};
+
+export type GraphqlMutationResult<
+	TYPED_GQL_STRING extends string,
+	FALLBACK_TYPES
+> = TYPED_GQL_STRING extends GeneratedMutation<infer IN, infer OUT>
+	? GraphQLResult<OUT>
+	: FALLBACK_TYPES extends GraphqlQueryOverrides<infer IN, infer OUT>
+	? GraphQLResult<OUT>
+	: any;
+
+/** GraphQL subscribe */
+
+export type GeneratedSubscription<InputType, OutputType> = string & {
+	__generatedSubscriptionInput: InputType;
+	__generatedSubscriptionOutput: OutputType;
+};
+
+export type GraphqlSubscriptionParams<
+	TYPED_GQL_STRING extends string,
+	FALLBACK_TYPES
+> = AuthMode & {
+	variables: TYPED_GQL_STRING extends GeneratedSubscription<infer IN, infer OUT>
+		? IN
+		: FALLBACK_TYPES extends GraphqlQueryOverrides<infer IN, infer OUT>
+		? IN
+		: any;
+};
+
+export type GraphqlSubscriptionResult<
+	TYPED_GQL_STRING extends string,
+	FALLBACK_TYPES
+> = {
+	provider: any;
+	value: {
+		data: TYPED_GQL_STRING extends GeneratedSubscription<infer IN, infer OUT>
+			? OUT
+			: FALLBACK_TYPES extends GraphqlQueryOverrides<infer IN, infer OUT>
+			? OUT
+			: any;
+	};
+};

package/src/v6.ts

@@ -0,0 +1,103 @@
+import { GraphQLAPI } from './GraphQLAPI';
+import { Observable } from 'zen-observable-ts';
+import { parse, print, OperationDefinitionNode } from 'graphql';
+
+import {
+	GraphqlQueryParams,
+	GraphqlQueryResult,
+	GraphqlMutationParams,
+	GraphqlMutationResult,
+	GraphqlSubscriptionParams,
+	GraphqlSubscriptionResult,
+} from './types/v6';
+
+import { GraphQLOptions, GraphQLResult } from './types';
+
+/**
+ * The proposed interface additions to the TypeBeast
+ */
+class V6Client {
+	graphql<T = any>(
+		options: GraphQLOptions,
+		additionalHeaders?: { [key: string]: string }
+	): Observable<GraphqlSubscriptionResult<'', T>> | Promise<GraphQLResult<T>> {
+		const parsedQuery =
+			typeof options.query === 'string'
+				? parse(options.query)
+				: parse(print(options.query));
+
+		const [operationDef = {}] = parsedQuery.definitions.filter(
+			def => def.kind === 'OperationDefinition'
+		);
+		const { operation: operationType } =
+			operationDef as OperationDefinitionNode;
+
+		const childOptions = {
+			...options,
+			query: print(parsedQuery),
+		} as any; // todo
+
+		switch (operationType) {
+			case 'query':
+				return this.query(childOptions.query, childOptions, additionalHeaders);
+			case 'mutation':
+				return this.mutate(childOptions.query, childOptions, additionalHeaders);
+			case 'subscription':
+				return this.subscribe(
+					childOptions.query,
+					childOptions,
+					additionalHeaders
+				);
+			default:
+				throw new Error(`invalid operation type: ${operationType}`);
+		}
+	}
+
+	query<FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(
+		document: TYPED_GQL_STRING,
+		queryParams?: GraphqlQueryParams<TYPED_GQL_STRING, FALLBACK_TYPES>,
+		additionalHeaders?: { [key: string]: string }
+	): Promise<GraphqlQueryResult<TYPED_GQL_STRING, FALLBACK_TYPES>> {
+		return GraphQLAPI.graphql(
+			{
+				...((queryParams || {}) as any), // todo
+				query: document,
+			},
+			additionalHeaders
+		) as Promise<GraphqlQueryResult<TYPED_GQL_STRING, FALLBACK_TYPES>>;
+	}
+
+	mutate<FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(
+		document: TYPED_GQL_STRING,
+		queryParams?: GraphqlMutationParams<TYPED_GQL_STRING, FALLBACK_TYPES>,
+		additionalHeaders?: { [key: string]: string }
+	): Promise<GraphqlMutationResult<TYPED_GQL_STRING, FALLBACK_TYPES>> {
+		return GraphQLAPI.graphql(
+			{
+				...((queryParams || {}) as any), // todo
+				query: document,
+			},
+			additionalHeaders
+		) as Promise<GraphqlMutationResult<TYPED_GQL_STRING, FALLBACK_TYPES>>;
+	}
+
+	subscribe<FALLBACK_TYPES = unknown, TYPED_GQL_STRING extends string = string>(
+		document: TYPED_GQL_STRING,
+		queryParams?: GraphqlSubscriptionParams<TYPED_GQL_STRING, FALLBACK_TYPES>,
+		additionalHeaders?: { [key: string]: string }
+	): Observable<GraphqlSubscriptionResult<TYPED_GQL_STRING, FALLBACK_TYPES>> {
+		return GraphQLAPI.graphql(
+			{
+				...((queryParams || {}) as any), // todo
+				query: document,
+			},
+			additionalHeaders
+		) as Observable<
+			GraphqlSubscriptionResult<TYPED_GQL_STRING, FALLBACK_TYPES>
+		>;
+	}
+}
+
+export function generateClient() {
+	return new V6Client();
+}