@aws-amplify/api-graphql 3.4.12-api-v6-models.b3abc9b.0 → 4.0.0

package/lib/Providers/constants.d.ts

@@ -0,0 +1,95 @@
+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/Providers/constants.js

@@ -0,0 +1,103 @@
+"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 utils_1 = require("@aws-amplify/core/internals/utils");
+exports.AMPLIFY_SYMBOL = utils_1.AMPLIFY_SYMBOL;
+exports.MAX_DELAY_MS = 5000;
+exports.NON_RETRYABLE_CODES = [400, 401, 403];
+exports.CONNECTION_STATE_CHANGE = 'ConnectionStateChange';
+var MESSAGE_TYPES;
+(function (MESSAGE_TYPES) {
+    /**
+     * Client -> Server message.
+     * This message type is the first message after handshake and this will initialize AWS AppSync RealTime communication
+     */
+    MESSAGE_TYPES["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
+     */
+    MESSAGE_TYPES["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
+     */
+    MESSAGE_TYPES["GQL_CONNECTION_ACK"] = "connection_ack";
+    /**
+     * Client -> Server message.
+     * This message type is for register subscriptions with AWS AppSync RealTime
+     */
+    MESSAGE_TYPES["GQL_START"] = "start";
+    /**
+     * Server -> Client message.
+     * This message type is for the ack response from AWS AppSync RealTime for GQL_START message
+     */
+    MESSAGE_TYPES["GQL_START_ACK"] = "start_ack";
+    /**
+     * Server -> Client message.
+     * This message type is for subscription message from AWS AppSync RealTime
+     */
+    MESSAGE_TYPES["GQL_DATA"] = "data";
+    /**
+     * Server -> Client message.
+     * This message type helps the client to know is still receiving messages from AWS AppSync RealTime
+     */
+    MESSAGE_TYPES["GQL_CONNECTION_KEEP_ALIVE"] = "ka";
+    /**
+     * Client -> Server message.
+     * This message type is for unregister subscriptions with AWS AppSync RealTime
+     */
+    MESSAGE_TYPES["GQL_STOP"] = "stop";
+    /**
+     * Server -> Client message.
+     * This message type is for the ack response from AWS AppSync RealTime for GQL_STOP message
+     */
+    MESSAGE_TYPES["GQL_COMPLETE"] = "complete";
+    /**
+     * Server -> Client message.
+     * This message type is for sending error messages from AWS AppSync RealTime to the client
+     */
+    MESSAGE_TYPES["GQL_ERROR"] = "error";
+})(MESSAGE_TYPES = exports.MESSAGE_TYPES || (exports.MESSAGE_TYPES = {}));
+var SUBSCRIPTION_STATUS;
+(function (SUBSCRIPTION_STATUS) {
+    SUBSCRIPTION_STATUS[SUBSCRIPTION_STATUS["PENDING"] = 0] = "PENDING";
+    SUBSCRIPTION_STATUS[SUBSCRIPTION_STATUS["CONNECTED"] = 1] = "CONNECTED";
+    SUBSCRIPTION_STATUS[SUBSCRIPTION_STATUS["FAILED"] = 2] = "FAILED";
+})(SUBSCRIPTION_STATUS = exports.SUBSCRIPTION_STATUS || (exports.SUBSCRIPTION_STATUS = {}));
+var SOCKET_STATUS;
+(function (SOCKET_STATUS) {
+    SOCKET_STATUS[SOCKET_STATUS["CLOSED"] = 0] = "CLOSED";
+    SOCKET_STATUS[SOCKET_STATUS["READY"] = 1] = "READY";
+    SOCKET_STATUS[SOCKET_STATUS["CONNECTING"] = 2] = "CONNECTING";
+})(SOCKET_STATUS = exports.SOCKET_STATUS || (exports.SOCKET_STATUS = {}));
+exports.AWS_APPSYNC_REALTIME_HEADERS = {
+    accept: 'application/json, text/javascript',
+    'content-encoding': 'amz-1.0',
+    'content-type': 'application/json; charset=UTF-8',
+};
+/**
+ * Time in milleseconds to wait for GQL_CONNECTION_INIT message
+ */
+exports.CONNECTION_INIT_TIMEOUT = 15000;
+/**
+ * Time in milleseconds to wait for GQL_START_ACK message
+ */
+exports.START_ACK_TIMEOUT = 15000;
+/**
+ * Default Time in milleseconds to wait for GQL_CONNECTION_KEEP_ALIVE message
+ */
+exports.DEFAULT_KEEP_ALIVE_TIMEOUT = 5 * 60 * 1000;
+/**
+ * Default Time in milleseconds to alert for missed GQL_CONNECTION_KEEP_ALIVE message
+ */
+exports.DEFAULT_KEEP_ALIVE_ALERT_TIMEOUT = 65 * 1000;
+/**
+ * Default delay time in milleseconds between when reconnect is triggered vs when it is attempted
+ */
+exports.RECONNECT_DELAY = 5 * 1000;
+/**
+ * Default interval time in milleseconds between when reconnect is re-attempted
+ */
+exports.RECONNECT_INTERVAL = 60 * 1000;

package/lib/index.d.ts

@@ -1,5 +1,3 @@
-import { GraphQLAPI } from './GraphQLAPI';
-export { GraphQLResult, GraphQLAuthError, GRAPHQL_AUTH_MODE } from './types';
 export { GraphQLAPI, GraphQLAPIClass, graphqlOperation } from './GraphQLAPI';
 export * from './types';
-export default GraphQLAPI;
+export { CONNECTION_STATE_CHANGE } from './Providers/constants';

package/lib/index.js

@@ -2,15 +2,11 @@
 // 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");
+const tslib_1 = require("tslib");
 var GraphQLAPI_1 = require("./GraphQLAPI");
-var types_1 = require("./types");
-exports.GraphQLAuthError = types_1.GraphQLAuthError;
-exports.GRAPHQL_AUTH_MODE = types_1.GRAPHQL_AUTH_MODE;
-var GraphQLAPI_2 = require("./GraphQLAPI");
-exports.GraphQLAPI = GraphQLAPI_2.GraphQLAPI;
-exports.GraphQLAPIClass = GraphQLAPI_2.GraphQLAPIClass;
-exports.graphqlOperation = GraphQLAPI_2.graphqlOperation;
+exports.GraphQLAPI = GraphQLAPI_1.GraphQLAPI;
+exports.GraphQLAPIClass = GraphQLAPI_1.GraphQLAPIClass;
+exports.graphqlOperation = GraphQLAPI_1.graphqlOperation;
 tslib_1.__exportStar(require("./types"), exports);
-exports.default = GraphQLAPI_1.GraphQLAPI;
-//# sourceMappingURL=index.js.map
+var constants_1 = require("./Providers/constants");
+exports.CONNECTION_STATE_CHANGE = constants_1.CONNECTION_STATE_CHANGE;

package/lib/internals/InternalGraphQLAPI.d.ts

@@ -1,11 +1,12 @@
 import { OperationTypeNode } from 'graphql';
-import Observable from 'zen-observable-ts';
-import { CustomUserAgentDetails } from '@aws-amplify/core';
-import { GraphQLOptions, GraphQLResult, GraphQLOperation } from '../types';
-export declare const graphqlOperation: (query: any, variables?: {}, authToken?: string) => {
+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 | undefined) => {
     query: any;
     variables: {};
-    authToken: string;
+    authToken: string | undefined;
 };
 /**
  * Export Cloud Logic APIs
@@ -15,27 +16,14 @@ export declare class InternalGraphQLAPIClass {
      * @private
      */
     private _options;
+    private appSyncRealTime;
     private _api;
-    Auth: import("@aws-amplify/auth/lib-esm/Auth").AuthClass;
-    Cache: import("@aws-amplify/cache/lib-esm/types").ICache;
-    Credentials: import("@aws-amplify/core").CredentialsClass;
     /**
      * Initialize GraphQL API with AWS configuration
      * @param {Object} options - Configuration object for API
      */
     constructor(options: any);
     getModuleName(): string;
-    /**
-     * Configure API
-     * @param {Object} config - Configuration of the API
-     * @return {Object} - The current configuration
-     */
-    configure(options: any): any;
-    /**
-     * Create an instance of API for the library
-     * @return - A promise of true if Success
-     */
-    createInstance(): true | Promise<never>;
     private _headerBasedAuth;
     /**
      * to get the operation type
@@ -49,33 +37,22 @@ export declare class InternalGraphQLAPIClass {
      * @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>({ query: paramQuery, variables, authMode, authToken }: GraphQLOptions, additionalHeaders?: {
+    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;
-    createInstanceIfNotCreated(): Promise<void>;
     /**
      * 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
      */
-    isCancel(error: any): any;
+    isCancelError(error: any): boolean;
     /**
      * Cancels an inflight request. Only applicable for graphql queries and mutations
      * @param {any} request - request to cancel
-     * @return {boolean} - A boolean indicating if the request was cancelled
+     * @returns - A boolean indicating if the request was cancelled
      */
-    cancel(request: Promise<any>, message?: string): any;
-    /**
-     * Check if the request has a corresponding cancel token in the WeakMap.
-     * @params request - The request promise
-     * @return if the request has a corresponding cancel token.
-     */
-    hasCancelToken(request: Promise<any>): any;
+    cancel(request: Promise<any>, message?: string): boolean;
     private _graphqlSubscribe;
-    /**
-     * @private
-     */
-    _ensureCredentials(): any;
 }
 export declare const InternalGraphQLAPI: InternalGraphQLAPIClass;