@aws-amplify/api-graphql 4.0.1-console-preview.d745d43.0 → 4.0.1-mjs-test.6f5dab7.0

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 });
-var 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/InternalGraphQLAPI.js

@@ -1,316 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var tslib_1 = require("tslib");
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-var graphql_1 = require("graphql");
-var core_1 = require("@aws-amplify/core");
-var utils_1 = require("@aws-amplify/core/internals/utils");
-var types_1 = require("../types");
-var api_rest_1 = require("@aws-amplify/api-rest");
-var internals_1 = require("@aws-amplify/api-rest/internals");
-var AWSAppSyncRealTimeProvider_1 = require("../Providers/AWSAppSyncRealTimeProvider");
-var utils_2 = require("../utils");
-var USER_AGENT_HEADER = 'x-amz-user-agent';
-var logger = new core_1.ConsoleLogger('GraphQLAPI');
-exports.graphqlOperation = function (query, variables, authToken) {
-    if (variables === void 0) { variables = {}; }
-    return ({
-        query: query,
-        variables: variables,
-        authToken: authToken,
-    });
-};
-/**
- * Export Cloud Logic APIs
- */
-var InternalGraphQLAPIClass = /** @class */ (function () {
-    /**
-     * Initialize GraphQL API with AWS configuration
-     * @param {Object} options - Configuration object for API
-     */
-    function InternalGraphQLAPIClass(options) {
-        this._api = {
-            post: internals_1.post,
-            cancelREST: internals_1.cancel,
-            isCancelErrorREST: api_rest_1.isCancelError,
-            updateRequestToBeCancellable: internals_1.updateRequestToBeCancellable,
-        };
-        this._options = options;
-        logger.debug('API Options', this._options);
-    }
-    InternalGraphQLAPIClass.prototype.getModuleName = function () {
-        return 'InternalGraphQLAPI';
-    };
-    InternalGraphQLAPIClass.prototype._headerBasedAuth = function (amplify, authMode, additionalHeaders) {
-        if (additionalHeaders === void 0) { additionalHeaders = {}; }
-        var _a;
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var config, _b, region, appSyncGraphqlEndpoint, apiKey, defaultAuthMode, authenticationType, headers, _c, session, token, e_1;
-            return tslib_1.__generator(this, function (_d) {
-                switch (_d.label) {
-                    case 0:
-                        config = amplify.getConfig();
-                        _b = utils_2.resolveConfig(amplify), region = _b.region, appSyncGraphqlEndpoint = _b.endpoint, apiKey = _b.apiKey, defaultAuthMode = _b.defaultAuthMode;
-                        authenticationType = authMode || defaultAuthMode || 'iam';
-                        headers = {};
-                        _c = authenticationType;
-                        switch (_c) {
-                            case 'apiKey': return [3 /*break*/, 1];
-                            case 'iam': return [3 /*break*/, 2];
-                            case 'oidc': return [3 /*break*/, 4];
-                            case 'userPool': return [3 /*break*/, 4];
-                            case 'lambda': return [3 /*break*/, 8];
-                            case 'none': return [3 /*break*/, 9];
-                        }
-                        return [3 /*break*/, 10];
-                    case 1:
-                        if (!apiKey) {
-                            throw new Error(types_1.GraphQLAuthError.NO_API_KEY);
-                        }
-                        headers = {
-                            'X-Api-Key': apiKey,
-                        };
-                        return [3 /*break*/, 11];
-                    case 2: return [4 /*yield*/, amplify.Auth.fetchAuthSession()];
-                    case 3:
-                        session = _d.sent();
-                        if (session.credentials === undefined) {
-                            throw new Error(types_1.GraphQLAuthError.NO_CREDENTIALS);
-                        }
-                        return [3 /*break*/, 11];
-                    case 4:
-                        _d.trys.push([4, 6, , 7]);
-                        token = void 0;
-                        return [4 /*yield*/, amplify.Auth.fetchAuthSession()];
-                    case 5:
-                        token = (_a = (_d.sent()).tokens) === null || _a === void 0 ? void 0 : _a.accessToken.toString();
-                        if (!token) {
-                            throw new Error(types_1.GraphQLAuthError.NO_FEDERATED_JWT);
-                        }
-                        headers = {
-                            Authorization: token,
-                        };
-                        return [3 /*break*/, 7];
-                    case 6:
-                        e_1 = _d.sent();
-                        throw new Error(types_1.GraphQLAuthError.NO_CURRENT_USER);
-                    case 7: return [3 /*break*/, 11];
-                    case 8:
-                        if (!additionalHeaders.Authorization) {
-                            throw new Error(types_1.GraphQLAuthError.NO_AUTH_TOKEN);
-                        }
-                        headers = {
-                            Authorization: additionalHeaders.Authorization,
-                        };
-                        return [3 /*break*/, 11];
-                    case 9: return [3 /*break*/, 11];
-                    case 10: return [3 /*break*/, 11];
-                    case 11: return [2 /*return*/, headers];
-                }
-            });
-        });
-    };
-    /**
-     * to get the operation type
-     * @param operation
-     */
-    InternalGraphQLAPIClass.prototype.getGraphqlOperationType = function (operation) {
-        var doc = graphql_1.parse(operation);
-        var definitions = doc.definitions;
-        var _a = tslib_1.__read(definitions, 1), operationType = _a[0].operation;
-        return operationType;
-    };
-    /**
-     * 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.
-     */
-    InternalGraphQLAPIClass.prototype.graphql = function (amplify, _a, additionalHeaders, customUserAgentDetails) {
-        var paramQuery = _a.query, _b = _a.variables, variables = _b === void 0 ? {} : _b, authMode = _a.authMode, authToken = _a.authToken;
-        var query = typeof paramQuery === 'string'
-            ? graphql_1.parse(paramQuery)
-            : graphql_1.parse(graphql_1.print(paramQuery));
-        var _c = tslib_1.__read(query.definitions.filter(function (def) { return def.kind === 'OperationDefinition'; }), 1), _d = _c[0], operationDef = _d === void 0 ? {} : _d;
-        var operationType = operationDef.operation;
-        var headers = additionalHeaders || {};
-        // if an authorization header is set, have the explicit authToken take precedence
-        if (authToken) {
-            headers.Authorization = authToken;
-        }
-        switch (operationType) {
-            case 'query':
-            case 'mutation':
-                var abortController = new AbortController();
-                var responsePromise = this._graphql(amplify, { query: query, variables: variables, authMode: authMode }, headers, abortController, customUserAgentDetails);
-                this._api.updateRequestToBeCancellable(responsePromise, abortController);
-                return responsePromise;
-            case 'subscription':
-                return this._graphqlSubscribe(amplify, { query: query, variables: variables, authMode: authMode }, headers, customUserAgentDetails);
-            default:
-                throw new Error("invalid operation type: " + operationType);
-        }
-    };
-    InternalGraphQLAPIClass.prototype._graphql = function (amplify, _a, additionalHeaders, abortController, customUserAgentDetails) {
-        var query = _a.query, variables = _a.variables, authMode = _a.authMode;
-        if (additionalHeaders === void 0) { additionalHeaders = {}; }
-        return tslib_1.__awaiter(this, void 0, void 0, function () {
-            var _b, region, appSyncGraphqlEndpoint, customEndpoint, customEndpointRegion, _c, customHeaders, withCredentials, headers, _d, _e, _f, _g, _h, _j, _k, body, signingServiceInfo, endpoint, error, response, responseBody, result, err_1, errors;
-            var _l;
-            return tslib_1.__generator(this, function (_m) {
-                switch (_m.label) {
-                    case 0:
-                        _b = utils_2.resolveConfig(amplify), region = _b.region, appSyncGraphqlEndpoint = _b.endpoint, customEndpoint = _b.customEndpoint, customEndpointRegion = _b.customEndpointRegion;
-                        _c = utils_2.resolveLibraryOptions(amplify), customHeaders = _c.headers, withCredentials = _c.withCredentials;
-                        _d = [{}];
-                        _e = !customEndpoint;
-                        if (!_e) return [3 /*break*/, 2];
-                        return [4 /*yield*/, this._headerBasedAuth(amplify, authMode, additionalHeaders)];
-                    case 1:
-                        _e = (_m.sent());
-                        _m.label = 2;
-                    case 2:
-                        _f = [tslib_1.__assign.apply(void 0, _d.concat([(_e)]))];
-                        _g = customEndpoint;
-                        if (!_g) return [3 /*break*/, 6];
-                        if (!customEndpointRegion) return [3 /*break*/, 4];
-                        return [4 /*yield*/, this._headerBasedAuth(amplify, authMode, additionalHeaders)];
-                    case 3:
-                        _h = _m.sent();
-                        return [3 /*break*/, 5];
-                    case 4:
-                        _h = {};
-                        _m.label = 5;
-                    case 5:
-                        _g = (_h);
-                        _m.label = 6;
-                    case 6:
-                        _j = [tslib_1.__assign.apply(void 0, _f.concat([((_g) ||
-                                    {})]))];
-                        _k = customHeaders;
-                        if (!_k) return [3 /*break*/, 8];
-                        return [4 /*yield*/, customHeaders({
-                                query: graphql_1.print(query),
-                                variables: variables,
-                            })];
-                    case 7:
-                        _k = (_m.sent());
-                        _m.label = 8;
-                    case 8:
-                        headers = tslib_1.__assign.apply(void 0, [tslib_1.__assign.apply(void 0, [tslib_1.__assign.apply(void 0, _j.concat([(_k)])), additionalHeaders]), (!customEndpoint && (_l = {},
-                                _l[USER_AGENT_HEADER] = utils_1.getAmplifyUserAgent(customUserAgentDetails),
-                                _l))]);
-                        body = {
-                            query: graphql_1.print(query),
-                            variables: variables || null,
-                        };
-                        /**
-                         * We do not send the signing service info to the REST API under the
-                         * following conditions (i.e. it will not sign the request):
-                         *   - there is a custom endpoint but no region
-                         *   - the auth mode is `none`, or `apiKey`
-                         *   - the auth mode is a type other than the types listed below
-                         */
-                        if ((customEndpoint && !customEndpointRegion) ||
-                            (authMode !== 'oidc' &&
-                                authMode !== 'userPool' &&
-                                authMode !== 'iam' &&
-                                authMode !== 'lambda')) {
-                            signingServiceInfo = null;
-                        }
-                        else {
-                            signingServiceInfo = {
-                                service: !customEndpointRegion ? 'appsync' : 'execute-api',
-                                region: !customEndpointRegion ? region : customEndpointRegion,
-                            };
-                        }
-                        endpoint = customEndpoint || appSyncGraphqlEndpoint;
-                        if (!endpoint) {
-                            error = new graphql_1.GraphQLError('No graphql endpoint provided.');
-                            throw {
-                                data: {},
-                                errors: [error],
-                            };
-                        }
-                        _m.label = 9;
-                    case 9:
-                        _m.trys.push([9, 12, , 13]);
-                        return [4 /*yield*/, this._api.post({
-                                url: new utils_1.AmplifyUrl(endpoint),
-                                options: {
-                                    headers: headers,
-                                    body: body,
-                                    signingServiceInfo: signingServiceInfo,
-                                    withCredentials: withCredentials,
-                                },
-                                abortController: abortController,
-                            })];
-                    case 10:
-                        responseBody = (_m.sent()).body;
-                        return [4 /*yield*/, responseBody.json()];
-                    case 11:
-                        result = _m.sent();
-                        response = result;
-                        return [3 /*break*/, 13];
-                    case 12:
-                        err_1 = _m.sent();
-                        // If the exception is because user intentionally
-                        // cancelled the request, do not modify the exception
-                        // so that clients can identify the exception correctly.
-                        if (this.isCancelError(err_1)) {
-                            throw err_1;
-                        }
-                        response = {
-                            data: {},
-                            errors: [new graphql_1.GraphQLError(err_1.message, null, null, null, null, err_1)],
-                        };
-                        return [3 /*break*/, 13];
-                    case 13:
-                        errors = response.errors;
-                        if (errors && errors.length) {
-                            throw response;
-                        }
-                        return [2 /*return*/, response];
-                }
-            });
-        });
-    };
-    /**
-     * 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
-     */
-    InternalGraphQLAPIClass.prototype.isCancelError = function (error) {
-        return this._api.isCancelErrorREST(error);
-    };
-    /**
-     * 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
-     */
-    InternalGraphQLAPIClass.prototype.cancel = function (request, message) {
-        return this._api.cancelREST(request, message);
-    };
-    InternalGraphQLAPIClass.prototype._graphqlSubscribe = function (amplify, _a, additionalHeaders, customUserAgentDetails) {
-        var query = _a.query, variables = _a.variables, authMode = _a.authMode;
-        if (additionalHeaders === void 0) { additionalHeaders = {}; }
-        var config = utils_2.resolveConfig(amplify);
-        if (!this.appSyncRealTime) {
-            this.appSyncRealTime = new AWSAppSyncRealTimeProvider_1.AWSAppSyncRealTimeProvider();
-        }
-        return this.appSyncRealTime.subscribe({
-            query: graphql_1.print(query),
-            variables: variables,
-            appSyncGraphqlEndpoint: config === null || config === void 0 ? void 0 : config.endpoint,
-            region: config === null || config === void 0 ? void 0 : config.region,
-            authenticationType: config === null || config === void 0 ? void 0 : config.defaultAuthMode,
-            apiKey: config === null || config === void 0 ? void 0 : config.apiKey,
-            additionalHeaders: additionalHeaders,
-        }, customUserAgentDetails);
-    };
-    return InternalGraphQLAPIClass;
-}());
-exports.InternalGraphQLAPIClass = InternalGraphQLAPIClass;
-exports.InternalGraphQLAPI = new InternalGraphQLAPIClass(null);

package/lib/internals/index.d.ts

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

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