@aws-amplify/pubsub 4.5.8-unstable.2 → 4.5.8

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.5.8](https://github.com/aws-amplify/amplify-js/compare/@aws-amplify/pubsub@4.5.7...@aws-amplify/pubsub@4.5.8) (2022-10-25)
+
+
+### Bug Fixes
+
+* **@aws-amplify/datastore:** introduce "settlement" guarantees to stop() and clear() ([#10450](https://github.com/aws-amplify/amplify-js/issues/10450)) ([16c535b](https://github.com/aws-amplify/amplify-js/commit/16c535beda9386a027c2805f29a359fbeb8bac15)), closes [#10449](https://github.com/aws-amplify/amplify-js/issues/10449)
+
+
+
+
+
 ## [4.5.7](https://github.com/aws-amplify/amplify-js/compare/@aws-amplify/pubsub@4.5.6...@aws-amplify/pubsub@4.5.7) (2022-10-14)
 
 **Note:** Version bump only for package @aws-amplify/pubsub

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aws-amplify/pubsub",
-  "version": "4.5.8-unstable.2+89bdeb1e4",
+  "version": "4.5.8",
   "description": "Pubsub category of aws-amplify",
   "main": "./lib/index.js",
   "module": "./lib-esm/index.js",
@@ -45,9 +45,9 @@
     "cpx": "^1.5.0"
   },
   "dependencies": {
-    "@aws-amplify/auth": "4.6.11-unstable.2+89bdeb1e4",
-    "@aws-amplify/cache": "4.0.60-unstable.2+89bdeb1e4",
-    "@aws-amplify/core": "4.7.9-unstable.2+89bdeb1e4",
+    "@aws-amplify/auth": "4.6.11",
+    "@aws-amplify/cache": "4.0.60",
+    "@aws-amplify/core": "4.7.9",
     "graphql": "15.8.0",
     "paho-mqtt": "^1.1.0",
     "uuid": "^3.2.1",
@@ -103,5 +103,5 @@
       "lib-esm"
     ]
   },
-  "gitHead": "89bdeb1e4ec45c1a34e7dfe960b341de99906ed3"
+  "gitHead": "be5bf2dc68c9c011c3876f003c14bc98b392c82d"
 }

package/lib/Providers/AWSAppSyncProvider.d.ts

@@ -1,21 +0,0 @@
-import Observable from 'zen-observable-ts';
-import { MqttOverWSProvider } from './MqttOverWSProvider';
-/**
- * @deprecated Unused, all usecases have migrated to AWSAppSyncRealtimeProvider
- */
-export declare class AWSAppSyncProvider extends MqttOverWSProvider {
-    protected get endpoint(): void;
-    getProviderName(): string;
-    publish(topics: string[] | string, msg: any, options?: any): Promise<void>;
-    private _cleanUp;
-    private _cleanUpForTopic;
-    onDisconnect({ clientId, errorCode, ...args }: {
-        [x: string]: any;
-        clientId: any;
-        errorCode: any;
-    }): void;
-    private _topicClient;
-    private _topicAlias;
-    protected disconnect(clientId: string): Promise<void>;
-    subscribe(topics: string[] | string, options?: any): Observable<any>;
-}

package/lib/Providers/AWSAppSyncRealTimeProvider/index.d.ts

@@ -1,67 +0,0 @@
-import Observable, { ZenObservable } from 'zen-observable-ts';
-import { ProviderOptions } from '../../types/Provider';
-import { GRAPHQL_AUTH_MODE } from '@aws-amplify/auth';
-import { AbstractPubSubProvider } from '../PubSubProvider';
-import { SUBSCRIPTION_STATUS } from '../constants';
-export declare type ObserverQuery = {
-    observer: ZenObservable.SubscriptionObserver<any>;
-    query: string;
-    variables: object;
-    subscriptionState: SUBSCRIPTION_STATUS;
-    subscriptionReadyCallback?: Function;
-    subscriptionFailedCallback?: Function;
-    startAckTimeoutId?: ReturnType<typeof setTimeout>;
-};
-declare type GraphqlAuthModes = keyof typeof GRAPHQL_AUTH_MODE;
-export interface AWSAppSyncRealTimeProviderOptions extends ProviderOptions {
-    appSyncGraphqlEndpoint?: string;
-    authenticationType?: GraphqlAuthModes;
-    query?: string;
-    variables?: object;
-    apiKey?: string;
-    region?: string;
-    graphql_headers?: () => {} | (() => Promise<{}>);
-    additionalHeaders?: {
-        [key: string]: string;
-    };
-}
-export declare class AWSAppSyncRealTimeProvider extends AbstractPubSubProvider {
-    private awsRealTimeSocket?;
-    private socketStatus;
-    private keepAliveTimeoutId?;
-    private keepAliveTimeout;
-    private keepAliveAlertTimeoutId?;
-    private subscriptionObserverMap;
-    private promiseArray;
-    private readonly connectionStateMonitor;
-    constructor(options?: ProviderOptions);
-    getNewWebSocket(url: any, protocol: any): WebSocket;
-    getProviderName(): string;
-    newClient(): Promise<any>;
-    publish(_topics: string[] | string, _msg: any, _options?: any): Promise<void>;
-    private isCustomDomain;
-    subscribe(_topics: string[] | string, options?: AWSAppSyncRealTimeProviderOptions): Observable<any>;
-    protected get isSSLEnabled(): boolean;
-    private _startSubscriptionWithAWSAppSyncRealTime;
-    private _waitForSubscriptionToBeConnected;
-    private _sendUnsubscriptionMessage;
-    private _removeSubscriptionObserver;
-    private _closeSocketIfRequired;
-    private _handleIncomingSubscriptionMessage;
-    private _errorDisconnect;
-    private _timeoutStartSubscriptionAck;
-    private _initializeWebSocketConnection;
-    private _initializeRetryableHandshake;
-    private _initializeHandshake;
-    private _awsRealTimeHeaderBasedAuth;
-    private _awsRealTimeCUPHeader;
-    private _awsRealTimeOPENIDHeader;
-    private _awsRealTimeApiKeyHeader;
-    private _awsRealTimeIAMHeader;
-    private _customAuthHeader;
-    /**
-     * @private
-     */
-    _ensureCredentials(): any;
-}
-export {};

package/lib/Providers/AWSIotProvider.d.ts

@@ -1,11 +0,0 @@
-import { MqttOverWSProvider, MqttProviderOptions } from './MqttOverWSProvider';
-export interface AWSIoTProviderOptions extends MqttProviderOptions {
-    aws_pubsub_region?: string;
-    aws_pubsub_endpoint?: string;
-}
-export declare class AWSIoTProvider extends MqttOverWSProvider {
-    constructor(options?: AWSIoTProviderOptions);
-    protected get region(): any;
-    getProviderName(): string;
-    protected get endpoint(): Promise<string>;
-}

package/lib/Providers/MqttOverWSProvider.d.ts

@@ -1,43 +0,0 @@
-import Observable from 'zen-observable-ts';
-import { AbstractPubSubProvider } from './PubSubProvider';
-import { SubscriptionObserver } from '../types/PubSub';
-import { ProviderOptions } from '../types/Provider';
-export declare function mqttTopicMatch(filter: string, topic: string): boolean;
-export interface MqttProviderOptions extends ProviderOptions {
-    clientId?: string;
-    url?: string;
-}
-/**
- * @deprecated Migrated to MqttProviderOptions
- */
-export declare type MqttProvidertOptions = MqttProviderOptions;
-declare class ClientsQueue {
-    private promises;
-    get(clientId: string, clientFactory?: (input: string) => Promise<any>): Promise<any>;
-    get allClients(): string[];
-    remove(clientId: string): void;
-}
-export declare class MqttOverWSProvider extends AbstractPubSubProvider {
-    private _clientsQueue;
-    private readonly connectionStateMonitor;
-    constructor(options?: MqttProviderOptions);
-    protected get clientId(): any;
-    protected get endpoint(): any;
-    protected get clientsQueue(): ClientsQueue;
-    protected get isSSLEnabled(): boolean;
-    protected getTopicForValue(value: any): any;
-    getProviderName(): string;
-    onDisconnect({ clientId, errorCode, ...args }: {
-        clientId?: string;
-        errorCode?: number;
-    }): void;
-    newClient({ url, clientId }: MqttProviderOptions): Promise<any>;
-    protected connect(clientId: string, options?: MqttProviderOptions): Promise<any>;
-    protected disconnect(clientId: string): Promise<void>;
-    publish(topics: string[] | string, msg: any): Promise<void>;
-    protected _topicObservers: Map<string, Set<SubscriptionObserver<any>>>;
-    protected _clientIdObservers: Map<string, Set<SubscriptionObserver<any>>>;
-    private _onMessage;
-    subscribe(topics: string[] | string, options?: MqttProviderOptions): Observable<any>;
-}
-export {};

package/lib/Providers/PubSubProvider.d.ts

@@ -1,13 +0,0 @@
-import Observable from 'zen-observable-ts';
-import { PubSubProvider, ProviderOptions } from '../types/Provider';
-export declare abstract class AbstractPubSubProvider implements PubSubProvider {
-    private _config;
-    constructor(options?: ProviderOptions);
-    configure(config?: ProviderOptions): ProviderOptions;
-    getCategory(): string;
-    abstract getProviderName(): string;
-    protected get options(): ProviderOptions;
-    abstract newClient(clientOptions: ProviderOptions): Promise<any>;
-    abstract publish(topics: string[] | string, msg: any, options?: ProviderOptions): void;
-    abstract subscribe(topics: string[] | string, options?: ProviderOptions): Observable<any>;
-}

package/lib/Providers/constants.d.ts

@@ -1,87 +0,0 @@
-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 AMPLIFY_SYMBOL: Symbol;
-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;

package/lib/Providers/index.d.ts

@@ -1,5 +0,0 @@
-export * from './PubSubProvider';
-export * from './AWSAppSyncProvider';
-export * from './AWSAppSyncRealTimeProvider';
-export * from './AWSIotProvider';
-export * from './MqttOverWSProvider';

package/lib/PubSub.d.ts

@@ -1,51 +0,0 @@
-import Observable from 'zen-observable-ts';
-import { PubSubProvider, PubSubOptions, ProviderOptions } from './types';
-export declare class PubSubClass {
-    private _options;
-    private _pluggables;
-    /**
-     * Internal instance of AWSAppSyncProvider used by the API category to subscribe to AppSync
-     */
-    private _awsAppSyncProvider?;
-    /**
-     * Internal instance of AWSAppSyncRealTimeProvider used by the API category to subscribe to AppSync
-     */
-    private _awsAppSyncRealTimeProvider?;
-    /**
-     * Lazy instantiate AWSAppSyncProvider when it is required by the API category
-     */
-    private get awsAppSyncProvider();
-    /**
-     * Lazy instantiate AWSAppSyncRealTimeProvider when it is required by the API category
-     */
-    private get awsAppSyncRealTimeProvider();
-    /**
-     * Initialize PubSub with AWS configurations
-     *
-     * @param {PubSubOptions} options - Configuration object for PubSub
-     */
-    constructor(options?: PubSubOptions);
-    getModuleName(): string;
-    /**
-     * Configure PubSub part with configurations
-     *
-     * @param {PubSubOptions} config - Configuration for PubSub
-     * @return {Object} - The current configuration
-     */
-    configure(options: PubSubOptions): PubSubOptions;
-    /**
-     * add plugin into Analytics category
-     * @param {Object} pluggable - an instance of the plugin
-     */
-    addPluggable(pluggable: PubSubProvider): Promise<object>;
-    /**
-     * remove plugin from PubSub category
-     * @param providerName - the name of the plugin
-     */
-    removePluggable(providerName: string): void;
-    private getProviderByName;
-    private getProviders;
-    publish(topics: string[] | string, msg: any, options?: ProviderOptions): Promise<void[]>;
-    subscribe(topics: string[] | string, options?: ProviderOptions): Observable<any>;
-}
-export declare const PubSub: PubSubClass;

package/lib/index.d.ts

@@ -1,9 +0,0 @@
-import { PubSub } from './PubSub';
-export * from './Providers';
-export { CONNECTION_STATE_CHANGE } from './Providers/constants';
-export { ConnectionState, CONTROL_MSG } from './types';
-export { PubSub };
-/**
- * @deprecated use named import
- */
-export default PubSub;

package/lib/types/Provider.d.ts

@@ -1,18 +0,0 @@
-import Observable from 'zen-observable-ts';
-export interface PubSubOptions {
-    [key: string]: any;
-}
-export interface ProviderOptions {
-    [key: string]: any;
-}
-/**
- * @deprecated Migrated to ProviderOptions
- */
-export declare type ProvidertOptions = ProviderOptions;
-export interface PubSubProvider {
-    configure(config: object): object;
-    getCategory(): string;
-    getProviderName(): string;
-    publish(topics: string[] | string, msg: any, options?: ProviderOptions): void;
-    subscribe(topics: string[] | string, options?: ProviderOptions): Observable<any>;
-}

package/lib/types/PubSub.d.ts

@@ -1,24 +0,0 @@
-export interface SubscriptionObserver<T> {
-    closed: boolean;
-    next(value: T): void;
-    error(errorValue: any): void;
-    complete(): void;
-}
-export declare enum CONTROL_MSG {
-    CONNECTION_CLOSED = "Connection closed",
-    CONNECTION_FAILED = "Connection failed",
-    REALTIME_SUBSCRIPTION_INIT_ERROR = "AppSync Realtime subscription init error",
-    SUBSCRIPTION_ACK = "Subscription ack",
-    TIMEOUT_DISCONNECT = "Timeout disconnect"
-}
-/** @enum {string} */
-export declare enum ConnectionState {
-    Connected = "Connected",
-    ConnectedPendingNetwork = "ConnectedPendingNetwork",
-    ConnectionDisrupted = "ConnectionDisrupted",
-    ConnectionDisruptedPendingNetwork = "ConnectionDisruptedPendingNetwork",
-    Connecting = "Connecting",
-    ConnectedPendingDisconnect = "ConnectedPendingDisconnect",
-    Disconnected = "Disconnected",
-    ConnectedPendingKeepAlive = "ConnectedPendingKeepAlive"
-}

package/lib/types/index.d.ts

@@ -1,2 +0,0 @@
-export * from './Provider';
-export * from './PubSub';

package/lib/utils/ConnectionStateMonitor.d.ts

@@ -1,40 +0,0 @@
-import Observable from 'zen-observable-ts';
-import { ConnectionState } from '../types/PubSub';
-declare type LinkedConnectionState = 'connected' | 'disconnected';
-declare type LinkedHealthState = 'healthy' | 'unhealthy';
-declare type LinkedConnectionStates = {
-    networkState: LinkedConnectionState;
-    connectionState: LinkedConnectionState | 'connecting';
-    intendedConnectionState: LinkedConnectionState;
-    keepAliveState: LinkedHealthState;
-};
-export declare const CONNECTION_CHANGE: {
-    [key in 'KEEP_ALIVE_MISSED' | 'KEEP_ALIVE' | 'CONNECTION_ESTABLISHED' | 'CONNECTION_FAILED' | 'CLOSING_CONNECTION' | 'OPENING_CONNECTION' | 'CLOSED' | 'ONLINE' | 'OFFLINE']: Partial<LinkedConnectionStates>;
-};
-export declare class ConnectionStateMonitor {
-    /**
-     * @private
-     */
-    private _linkedConnectionState;
-    private _linkedConnectionStateObservable;
-    private _linkedConnectionStateObserver;
-    private _networkMonitoringSubscription?;
-    constructor();
-    /**
-     * Turn network state monitoring on if it isn't on already
-     */
-    private enableNetworkMonitoring;
-    /**
-     * Turn network state monitoring off if it isn't off already
-     */
-    private disableNetworkMonitoring;
-    /**
-     * Get the observable that allows us to monitor the connection state
-     *
-     * @returns {Observable<ConnectionState>} - The observable that emits ConnectionState updates
-     */
-    get connectionStateObservable(): Observable<ConnectionState>;
-    record(statusUpdates: Partial<LinkedConnectionStates>): void;
-    private connectionStatesTranslator;
-}
-export {};

package/lib/utils/ReachabilityMonitor/index.d.ts

@@ -1,3 +0,0 @@
-export declare const ReachabilityMonitor: () => import("zen-observable-ts").default<{
-    online: boolean;
-}>;

package/lib/utils/ReachabilityMonitor/index.native.d.ts

@@ -1,3 +0,0 @@
-export declare const ReachabilityMonitor: () => import("zen-observable-ts").default<{
-    online: boolean;
-}>;