@aws-amplify/api-graphql 4.0.1-api-v6-models.6720ee0.0 → 4.0.1-api-v6-models.13c9b49.0

package/lib/internals/APIClient.d.ts

@@ -1,121 +0,0 @@
-import { GraphQLAuthMode } from '@aws-amplify/core/internals/utils';
-import { V6Client } from '../types';
-type ListArgs = {
-    selectionSet?: string[];
-    filter?: {};
-};
-/**
- *
- * @param GraphQL response object
- * @returns response object with `items` properties flattened
- */
-export declare const flattenItems: (obj: Record<string, any>) => Record<string, any>;
-export declare function initializeModel(client: any, modelName: string, result: any[], modelIntrospection: any, authMode: GraphQLAuthMode | undefined, authToken: string | undefined, context?: boolean): any[];
-export declare const graphQLOperationsInfo: {
-    CREATE: {
-        operationPrefix: "create";
-        usePlural: boolean;
-    };
-    READ: {
-        operationPrefix: "get";
-        usePlural: boolean;
-    };
-    UPDATE: {
-        operationPrefix: "update";
-        usePlural: boolean;
-    };
-    DELETE: {
-        operationPrefix: "delete";
-        usePlural: boolean;
-    };
-    LIST: {
-        operationPrefix: "list";
-        usePlural: boolean;
-    };
-    ONCREATE: {
-        operationPrefix: "onCreate";
-        usePlural: boolean;
-    };
-    ONUPDATE: {
-        operationPrefix: "onUpdate";
-        usePlural: boolean;
-    };
-    ONDELETE: {
-        operationPrefix: "onDelete";
-        usePlural: boolean;
-    };
-    OBSERVE_QUERY: {
-        operationPrefix: "observeQuery";
-        usePlural: boolean;
-    };
-};
-export type ModelOperation = keyof typeof graphQLOperationsInfo;
-/**
- * Generates nested Custom Selection Set IR from path
- *
- * @param modelIntrospection
- * @param modelName
- * @param selectionSet - array of object paths
- * @example
- * ### Given
- * `selectionSet = ['id', 'comments.post.id']`
- * ### Returns
- * ```ts
- * {
- *   id: '',
- *   comments: {
- *     items: { post: { id: '' } }
- *   }
- * }
- * ```
- */
-export declare function customSelectionSetToIR(modelIntrospection: any, modelName: string, selectionSet: string[]): Record<string, string | object>;
-/**
- * Stringifies selection set IR
- * * @example
- * ### Given
- * ```ts
- * {
- *   id: '',
- *   comments: {
- *     items: { post: { id: '' } }
- *   }
- * }
- * ```
- * ### Returns
- * `'id comments { items { post { id } } }'`
- */
-export declare function selectionSetIRToString(obj: Record<string, string | any>): string;
-export declare function generateSelectionSet(modelIntrospection: any, modelName: string, selectionSet?: string[]): string;
-export declare function generateGraphQLDocument(modelIntrospection: any, modelName: string, modelOperation: ModelOperation, listArgs?: ListArgs): string;
-export declare function buildGraphQLVariables(modelDefinition: any, operation: ModelOperation, arg: any, modelIntrospection: any): object;
-/**
- * Iterates over mutation input values and resolves any model inputs to their corresponding join fields/values
- *
- * @example
- * ### Usage
- * ```ts
- * const result = normalizeMutationInput({ post: post }, model, modelDefinition);
- * ```
- * ### Result
- * ```ts
- * { postId: "abc123" }
- * ```
- *
- */
-export declare function normalizeMutationInput(mutationInput: any, model: any, modelDefinition: any): Record<string, unknown>;
-type AuthModeParams = {
-    authMode?: GraphQLAuthMode;
-    authToken?: string;
-};
-/**
- * Produces a parameter object that can contains auth mode/token overrides
- * only if present in either `options` (first) or configured on the `client`
- * as a fallback.
- *
- * @param client Configured client from `generateClient`
- * @param options Args/Options obect from call site.
- * @returns
- */
-export declare function authModeParams(client: V6Client, options?: AuthModeParams): AuthModeParams;
-export {};

package/lib/internals/InternalGraphQLAPI.d.ts

@@ -1,58 +0,0 @@
-import { OperationTypeNode } from 'graphql';
-import { Observable } from 'rxjs';
-import { AmplifyClassV6 } from '@aws-amplify/core';
-import { CustomUserAgentDetails } from '@aws-amplify/core/internals/utils';
-import { GraphQLResult, GraphQLOperation, GraphQLOptions } from '../types';
-export declare const graphqlOperation: (query: any, variables?: {}, authToken?: string) => {
-    query: any;
-    variables: {};
-    authToken: string | undefined;
-};
-/**
- * Export Cloud Logic APIs
- */
-export declare class InternalGraphQLAPIClass {
-    /**
-     * @private
-     */
-    private _options;
-    private appSyncRealTime;
-    private _api;
-    /**
-     * Initialize GraphQL API with AWS configuration
-     * @param {Object} options - Configuration object for API
-     */
-    constructor(options: any);
-    getModuleName(): string;
-    private _headerBasedAuth;
-    /**
-     * to get the operation type
-     * @param operation
-     */
-    getGraphqlOperationType(operation: GraphQLOperation): OperationTypeNode;
-    /**
-     * 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 | ((fn: (amplify: any) => Promise<any>) => Promise<AmplifyClassV6>), { query: paramQuery, variables, authMode, authToken }: GraphQLOptions, additionalHeaders?: {
-        [key: string]: string;
-    }, customUserAgentDetails?: CustomUserAgentDetails): Observable<GraphQLResult<T>> | Promise<GraphQLResult<T>>;
-    private _graphql;
-    /**
-     * Checks to see if an error thrown is from an api request cancellation
-     * @param {any} error - Any error
-     * @return {boolean} - 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;
-    private _graphqlSubscribe;
-}
-export declare const InternalGraphQLAPI: InternalGraphQLAPIClass;

package/lib/internals/generateClient.d.ts

@@ -1,12 +0,0 @@
-import { V6Client } from '../types';
-import { ClientGenerationParams } from './types';
-/**
- * @private
- *
- * Creates a client that can be used to make GraphQL requests, using a provided `AmplifyClassV6`
- * compatible context object for config and auth fetching.
- *
- * @param params
- * @returns
- */
-export declare function generateClient<T extends Record<any, any> = never>(params: ClientGenerationParams): V6Client<T>;

package/lib/internals/generateModelsProperty.d.ts

@@ -1,4 +0,0 @@
-import { ModelTypes } from '@aws-amplify/amplify-api-next-types-alpha';
-import { ClientGenerationParams } from './types';
-import { V6Client } from '../types';
-export declare function generateModelsProperty<T extends Record<any, any> = never>(client: V6Client, params: ClientGenerationParams): ModelTypes<T>;

package/lib/internals/index.d.ts

@@ -1,3 +0,0 @@
-export { InternalGraphQLAPI, InternalGraphQLAPIClass, } from './InternalGraphQLAPI';
-export { graphql, cancel, isCancelError } from './v6';
-export { generateClient } from './generateClient';

package/lib/internals/operations/get.d.ts

@@ -1,2 +0,0 @@
-import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
-export declare function getFactory(client: any, modelIntrospection: any, model: any, operation: any, context?: boolean): (contextSpec: AmplifyServer.ContextSpec, arg?: any, options?: any) => Promise<any>;

package/lib/internals/operations/list.d.ts

@@ -1,2 +0,0 @@
-import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
-export declare function listFactory(client: any, modelIntrospection: any, model: any, context?: boolean): (contextSpec: AmplifyServer.ContextSpec, args?: any) => Promise<any>;

package/lib/internals/operations/observeQuery.d.ts

@@ -1,2 +0,0 @@
-import { Observable } from 'rxjs';
-export declare function observeQueryFactory(models: any, model: any): (arg?: any) => Observable<unknown>;

package/lib/internals/operations/subscription.d.ts

@@ -1 +0,0 @@
-export declare function subscriptionFactory(client: any, modelIntrospection: any, model: any, operation: any): (args?: any) => import("rxjs").Observable<any>;

package/lib/internals/server/generateClient.d.ts

@@ -1,11 +0,0 @@
-import { V6ClientSSRRequest, V6ClientSSRCookies, ServerClientGenerationParams, CommonPublicClientOptions } from '../../types';
-/**
- * @private
- *
- * Creates a client that can be used to make GraphQL requests, using a provided `AmplifyClassV6`
- * compatible context object for config and auth fetching.
- *
- * @param params
- * @returns
- */
-export declare function generateClient<T extends Record<any, any> = never, ClientType extends V6ClientSSRRequest<T> | V6ClientSSRCookies<T> = V6ClientSSRCookies<T>>(params: ServerClientGenerationParams & CommonPublicClientOptions): ClientType;

package/lib/internals/server/generateModelsProperty.d.ts

@@ -1,3 +0,0 @@
-import { ServerClientGenerationParams } from '../../types/';
-import { V6ClientSSRRequest, V6ClientSSRCookies } from '../../types';
-export declare function generateModelsProperty<T extends Record<any, any> = never, ClientType extends V6ClientSSRRequest<T> | V6ClientSSRCookies<T> = V6ClientSSRCookies<T>>(client: ClientType, params: ServerClientGenerationParams): ClientType;

package/lib/internals/server/index.d.ts

@@ -1 +0,0 @@
-export { generateClient } from './generateClient';

package/lib/internals/types.d.ts

@@ -1,17 +0,0 @@
-import { AmplifyClassV6 } from '@aws-amplify/core';
-import { GraphQLAuthMode } from '@aws-amplify/core/internals/utils';
-/**
- * @private
- *
- * The knobs available for configuring `generateClient` internally.
- */
-export type ClientGenerationParams = {
-    amplify: AmplifyClassV6;
-} & CommonPublicClientOptions;
-/**
- * Common options that can be used on public `generateClient()` interfaces.
- */
-export type CommonPublicClientOptions = {
-    authMode?: GraphQLAuthMode;
-    authToken?: string;
-};

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