@aws-amplify/pubsub 4.2.11 → 4.3.0

package/src/Providers/MqttOverWSProvider.ts

@@ -15,7 +15,7 @@ import { v4 as uuid } from 'uuid';
 import Observable from 'zen-observable-ts';
 
 import { AbstractPubSubProvider } from './PubSubProvider';
-import { ProvidertOptions, SubscriptionObserver } from '../types';
+import { ProviderOptions, SubscriptionObserver } from '../types';
 import { ConsoleLogger as Logger } from '@aws-amplify/core';
 
 const logger = new Logger('MqttOverWSProvider');
@@ -34,11 +34,16 @@ export function mqttTopicMatch(filter: string, topic: string) {
 	return length === topicArray.length;
 }
 
-export interface MqttProvidertOptions extends ProvidertOptions {
+export interface MqttProviderOptions extends ProviderOptions {
 	clientId?: string;
 	url?: string;
 }
 
+/**
+ * @deprecated Migrated to MqttProviderOptions
+ */
+export type MqttProvidertOptions = MqttProviderOptions;
+
 class ClientsQueue {
 	private promises: Map<string, Promise<any>> = new Map();
 
@@ -69,7 +74,7 @@ const topicSymbol = typeof Symbol !== 'undefined' ? Symbol('topic') : '@@topic';
 export class MqttOverWSProvider extends AbstractPubSubProvider {
 	private _clientsQueue = new ClientsQueue();
 
-	constructor(options: MqttProvidertOptions = {}) {
+	constructor(options: MqttProviderOptions = {}) {
 		super({ ...options, clientId: options.clientId || uuid() });
 	}
 
@@ -128,10 +133,7 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 		}
 	}
 
-	public async newClient({
-		url,
-		clientId,
-	}: MqttProvidertOptions): Promise<any> {
+	public async newClient({ url, clientId }: MqttProviderOptions): Promise<any> {
 		logger.debug('Creating new MQTT client', clientId);
 
 		// @ts-ignore
@@ -161,7 +163,7 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 
 	protected async connect(
 		clientId: string,
-		options: MqttProvidertOptions = {}
+		options: MqttProviderOptions = {}
 	): Promise<any> {
 		return await this.clientsQueue.get(clientId, clientId =>
 			this.newClient({ ...options, clientId })
@@ -189,15 +191,11 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 		targetTopics.forEach(topic => client.send(topic, message));
 	}
 
-	protected _topicObservers: Map<
-		string,
-		Set<SubscriptionObserver<any>>
-	> = new Map();
+	protected _topicObservers: Map<string, Set<SubscriptionObserver<any>>> =
+		new Map();
 
-	protected _clientIdObservers: Map<
-		string,
-		Set<SubscriptionObserver<any>>
-	> = new Map();
+	protected _clientIdObservers: Map<string, Set<SubscriptionObserver<any>>> =
+		new Map();
 
 	private _onMessage(topic: string, msg: any) {
 		try {
@@ -223,7 +221,7 @@ export class MqttOverWSProvider extends AbstractPubSubProvider {
 
 	subscribe(
 		topics: string[] | string,
-		options: MqttProvidertOptions = {}
+		options: MqttProviderOptions = {}
 	): Observable<any> {
 		const targetTopics = ([] as string[]).concat(topics);
 		logger.debug('Subscribing to topic(s)', targetTopics.join(','));

package/src/Providers/PubSubProvider.ts

@@ -11,19 +11,19 @@
  * and limitations under the License.
  */
 import Observable from 'zen-observable-ts';
-import { PubSubProvider, ProvidertOptions } from '../types';
+import { PubSubProvider, ProviderOptions } from '../types';
 import { ConsoleLogger as Logger } from '@aws-amplify/core';
 
 const logger = new Logger('AbstractPubSubProvider');
 
 export abstract class AbstractPubSubProvider implements PubSubProvider {
-	private _config: ProvidertOptions;
+	private _config: ProviderOptions;
 
-	constructor(options: ProvidertOptions = {}) {
+	constructor(options: ProviderOptions = {}) {
 		this._config = options;
 	}
 
-	configure(config: ProvidertOptions = {}): ProvidertOptions {
+	configure(config: ProviderOptions = {}): ProviderOptions {
 		this._config = { ...config, ...this._config };
 
 		logger.debug(`configure ${this.getProviderName()}`, this._config);
@@ -37,20 +37,20 @@ export abstract class AbstractPubSubProvider implements PubSubProvider {
 
 	abstract getProviderName(): string;
 
-	protected get options(): ProvidertOptions {
+	protected get options(): ProviderOptions {
 		return { ...this._config };
 	}
 
-	public abstract newClient(clientOptions: ProvidertOptions): Promise<any>;
+	public abstract newClient(clientOptions: ProviderOptions): Promise<any>;
 
 	public abstract publish(
 		topics: string[] | string,
 		msg: any,
-		options?: ProvidertOptions
+		options?: ProviderOptions
 	): void;
 
 	public abstract subscribe(
 		topics: string[] | string,
-		options?: ProvidertOptions
+		options?: ProviderOptions
 	): Observable<any>;
 }

package/src/PubSub.ts

@@ -20,7 +20,7 @@ import {
 	INTERNAL_AWS_APPSYNC_PUBSUB_PROVIDER,
 	INTERNAL_AWS_APPSYNC_REALTIME_PUBSUB_PROVIDER,
 } from '@aws-amplify/core';
-import { PubSubProvider, PubSubOptions, ProvidertOptions } from './types';
+import { PubSubProvider, PubSubOptions, ProviderOptions } from './types';
 import { AWSAppSyncProvider, AWSAppSyncRealTimeProvider } from './Providers';
 
 const { isNode } = browserOrNode();
@@ -133,7 +133,7 @@ export class PubSubClass {
 		);
 	}
 
-	private getProviders(options: ProvidertOptions = {}) {
+	private getProviders(options: ProviderOptions = {}) {
 		const { provider: providerName } = options;
 		if (!providerName) {
 			return this._pluggables;
@@ -150,7 +150,7 @@ export class PubSubClass {
 	async publish(
 		topics: string[] | string,
 		msg: any,
-		options?: ProvidertOptions
+		options?: ProviderOptions
 	) {
 		return Promise.all(
 			this.getProviders(options).map(provider =>
@@ -161,7 +161,7 @@ export class PubSubClass {
 
 	subscribe(
 		topics: string[] | string,
-		options?: ProvidertOptions
+		options?: ProviderOptions
 	): Observable<any> {
 		if (isNode && this._options && this._options.ssr) {
 			throw new Error(

package/src/types/Provider.ts

@@ -11,7 +11,7 @@
  * and limitations under the License.
  */
 import Observable from 'zen-observable-ts';
-import { ProvidertOptions } from './PubSub';
+import { ProviderOptions } from './PubSub';
 
 export interface PubSubProvider {
 	// configure your provider
@@ -23,14 +23,10 @@ export interface PubSubProvider {
 	// return the name of you provider
 	getProviderName(): string;
 
-	publish(
-		topics: string[] | string,
-		msg: any,
-		options?: ProvidertOptions
-	): void;
+	publish(topics: string[] | string, msg: any, options?: ProviderOptions): void;
 
 	subscribe(
 		topics: string[] | string,
-		options?: ProvidertOptions
+		options?: ProviderOptions
 	): Observable<any>;
 }

package/src/types/PubSub.ts

@@ -14,6 +14,11 @@ export interface PubSubOptions {
 	[key: string]: any;
 }
 
-export interface ProvidertOptions {
+export interface ProviderOptions {
 	[key: string]: any;
 }
+
+/**
+ * @deprecated Migrated to ProviderOptions
+ */
+export type ProvidertOptions = ProviderOptions;