@aws-amplify/pubsub 5.5.6-api-v6-models.b3abc9b.0 → 6.0.0

package/package.json

@@ -1,128 +1,148 @@
 {
-  "name": "@aws-amplify/pubsub",
-  "version": "5.5.6-api-v6-models.b3abc9b.0+b3abc9b",
-  "description": "Pubsub category of aws-amplify",
-  "main": "./lib/index.js",
-  "module": "./lib-esm/index.js",
-  "typings": "./lib-esm/index.d.ts",
-  "react-native": {
-    "./lib/index": "./lib-esm/index.js"
-  },
-  "sideEffects": [
-    "./lib/PubSub.js",
-    "./lib-esm/PubSub.js"
-  ],
-  "publishConfig": {
-    "access": "public"
-  },
-  "scripts": {
-    "test": "npm run lint && jest -w 1 --coverage",
-    "test:size": "size-limit",
-    "build-with-test": "npm run clean && npm test && tsc && webpack",
-    "build:cjs": "node ./build es5 && cp src/vendor/* lib/vendor && webpack && webpack --config ./webpack.config.dev.js",
-    "build:esm": "node ./build es6 && cp src/vendor/* lib-esm/vendor",
-    "build:cjs:watch": "node ./build es5 --watch",
-    "build:esm:watch": "node ./build es6 --watch",
-    "build": "npm run clean && npm run build:esm && npm run build:cjs",
-    "clean": "npm run clean:size && rimraf lib-esm lib dist",
-    "clean:size": "rimraf dual-publish-tmp tmp*",
-    "format": "echo \"Not implemented\"",
-    "lint": "tslint 'src/**/*.ts' && npm run ts-coverage",
-    "ts-coverage": "typescript-coverage-report -p ./tsconfig.build.json -t 93.0 -i src/vendor/paho-mqtt.js"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/aws-amplify/amplify-js.git"
-  },
-  "author": "Amazon Web Services",
-  "license": "Apache-2.0",
-  "bugs": {
-    "url": "https://github.com/aws/aws-amplify/issues"
-  },
-  "homepage": "https://aws-amplify.github.io/",
-  "devDependencies": {
-    "@types/zen-observable": "^0.8.0"
-  },
-  "files": [
-    "lib",
-    "lib-esm",
-    "src",
-    "internals"
-  ],
-  "dependencies": {
-    "@aws-amplify/auth": "5.6.6-api-v6-models.b3abc9b.0+b3abc9b",
-    "@aws-amplify/cache": "5.1.12-api-v6-models.b3abc9b.0+b3abc9b",
-    "@aws-amplify/core": "5.8.6-api-v6-models.b3abc9b.0+b3abc9b",
-    "buffer": "4.9.2",
-    "graphql": "15.8.0",
-    "tslib": "^1.8.0",
-    "url": "0.11.0",
-    "uuid": "^3.2.1",
-    "zen-observable-ts": "0.8.19"
-  },
-  "size-limit": [
-    {
-      "name": "PubSub (IoT provider)",
-      "path": "./lib-esm/index.js",
-      "import": "{ Amplify, PubSub, AWSIoTProvider }",
-      "limit": "81.39 kB"
-    },
-    {
-      "name": "PubSub (Mqtt provider)",
-      "path": "./lib-esm/index.js",
-      "import": "{ Amplify, PubSub, MqttOverWSProvider }",
-      "limit": "81.26 kB"
-    }
-  ],
-  "jest": {
-    "globals": {
-      "ts-jest": {
-        "diagnostics": false,
-        "tsConfig": {
-          "lib": [
-            "es5",
-            "es2015",
-            "dom",
-            "esnext.asynciterable",
-            "es2017.object"
-          ],
-          "allowJs": true
-        }
-      },
-      "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(tsx?|jsx?)$",
-      "testPathIgnorePatterns": [
-        "__tests__/helpers.ts"
-      ]
-    },
-    "transform": {
-      "^.+\\.(js|jsx|ts|tsx)$": "ts-jest"
-    },
-    "testPathIgnorePatterns": [
-      "__tests__/helpers.ts"
-    ],
-    "moduleFileExtensions": [
-      "ts",
-      "tsx",
-      "js",
-      "json",
-      "jsx"
-    ],
-    "testEnvironment": "jsdom",
-    "testURL": "http://localhost/",
-    "coverageThreshold": {
-      "global": {
-        "branches": 0,
-        "functions": 0,
-        "lines": 0,
-        "statements": 0
-      }
-    },
-    "coveragePathIgnorePatterns": [
-      "/node_modules/",
-      "dist",
-      "lib",
-      "lib-esm"
-    ]
-  },
-  "gitHead": "b3abc9b75f6f1353f4c2fbc10cd3369be498e9fc"
+	"name": "@aws-amplify/pubsub",
+	"version": "6.0.0",
+	"description": "Pubsub category of aws-amplify",
+	"main": "./lib/index.js",
+	"module": "./lib-esm/index.js",
+	"typings": "./lib-esm/index.d.ts",
+	"react-native": {
+		"./lib/index": "./lib-esm/index.js"
+	},
+	"sideEffects": false,
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"test": "npm run lint && jest -w 1 --coverage",
+		"test:size": "size-limit",
+		"build-with-test": "npm run clean && npm test && tsc && webpack",
+		"build:cjs": "rimraf lib && tsc -m commonjs --outDir lib && cp -R src/vendor lib/vendor && webpack && webpack --config ./webpack.config.dev.js",
+		"build:esm": "rimraf lib-esm && tsc -m esnext --outDir lib-esm && cp -R src/vendor lib-esm/vendor",
+		"build:cjs:watch": "rimraf lib && tsc -m commonjs --outDir lib --watch",
+		"build:esm:watch": "rimraf lib-esm && tsc -m esnext --outDir lib-esm --watch",
+		"build": "npm run clean && npm run build:esm && npm run build:cjs",
+		"clean": "npm run clean:size && rimraf lib-esm lib dist",
+		"clean:size": "rimraf dual-publish-tmp tmp*",
+		"format": "echo \"Not implemented\"",
+		"lint": "tslint 'src/**/*.ts' && npm run ts-coverage",
+		"ts-coverage": "typescript-coverage-report -p ./tsconfig.json -t 93.0 -i src/vendor/paho-mqtt.js"
+	},
+	"typesVersions": {
+		">=4.2": {
+			"iot": [
+				"./lib-esm/clients/iot.d.ts"
+			],
+			"mqtt": [
+				"./lib-esm/clients/mqtt.d.ts"
+			]
+		}
+	},
+	"exports": {
+		".": {
+			"types": "./lib-esm/index.d.ts",
+			"import": "./lib-esm/index.js",
+			"require": "./lib/index.js"
+		},
+		"./iot": {
+			"types": "./lib-esm/clients/iot.d.ts",
+			"import": "./lib-esm/clients/iot.js",
+			"require": "./lib/clients/iot.js"
+		},
+		"./mqtt": {
+			"types": "./lib-esm/clients/mqtt.d.ts",
+			"import": "./lib-esm/clients/mqtt.js",
+			"require": "./lib/clients/mqtt.js"
+		}
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/aws-amplify/amplify-js.git"
+	},
+	"author": "Amazon Web Services",
+	"license": "Apache-2.0",
+	"bugs": {
+		"url": "https://github.com/aws/aws-amplify/issues"
+	},
+	"homepage": "https://aws-amplify.github.io/",
+	"files": [
+		"lib",
+		"lib-esm",
+		"src",
+		"iot",
+		"mqtt"
+	],
+	"dependencies": {
+		"@aws-amplify/auth": "6.0.0",
+		"buffer": "4.9.2",
+		"graphql": "15.8.0",
+		"rxjs": "^7.8.1",
+		"tslib": "^2.5.0",
+		"url": "0.11.0"
+	},
+	"peerDependencies": {
+		"@aws-amplify/core": "^6.0.0"
+	},
+	"devDependencies": {
+		"@aws-amplify/core": "6.0.0",
+		"typescript": "5.0.2"
+	},
+	"size-limit": [
+		{
+			"name": "PubSub (IoT provider)",
+			"path": "./lib-esm/index.js",
+			"import": "{ generateClient }",
+			"limit": "1.2 kB"
+		},
+		{
+			"name": "PubSub (Mqtt provider)",
+			"path": "./lib-esm/clients/mqtt.js",
+			"import": "{ generateClient }",
+			"limit": "1.07 kB"
+		}
+	],
+	"jest": {
+		"globals": {
+			"ts-jest": {
+				"diagnostics": false,
+				"tsConfig": {
+					"allowJs": true,
+					"noEmitOnError": false
+				}
+			},
+			"testRegex": "(/__tests__/.*|\\.(test|spec))\\.(tsx?|jsx?)$",
+			"testPathIgnorePatterns": [
+				"__tests__/helpers.ts"
+			]
+		},
+		"transform": {
+			"^.+\\.(js|jsx|ts|tsx)$": "ts-jest"
+		},
+		"testPathIgnorePatterns": [
+			"__tests__/helpers.ts"
+		],
+		"moduleFileExtensions": [
+			"ts",
+			"tsx",
+			"js",
+			"json",
+			"jsx"
+		],
+		"testEnvironment": "jsdom",
+		"testURL": "http://localhost/",
+		"coverageThreshold": {
+			"global": {
+				"branches": 0,
+				"functions": 0,
+				"lines": 0,
+				"statements": 0
+			}
+		},
+		"coveragePathIgnorePatterns": [
+			"node_modules",
+			"dist",
+			"lib",
+			"lib-esm"
+		]
+	},
+	"gitHead": "d505105326d7f6214f6bd1e06eb20be3a3651377"
 }

package/src/Providers/{AWSIotProvider.ts → AWSIot.ts}

@@ -1,41 +1,43 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-import { MqttOverWSProvider, MqttProviderOptions } from './MqttOverWSProvider';
-import { Signer, Credentials } from '@aws-amplify/core';
-
+import { MqttOverWS, MqttOptions } from './MqttOverWS';
+import { Signer } from '@aws-amplify/core/internals/utils';
+import { fetchAuthSession } from '@aws-amplify/core';
 const SERVICE_NAME = 'iotdevicegateway';
 
-export interface AWSIoTProviderOptions extends MqttProviderOptions {
-	aws_pubsub_region?: string;
-	aws_pubsub_endpoint?: string;
+export interface AWSIoTOptions extends MqttOptions {
+	region?: string;
+	endpoint?: string;
 }
 
-export class AWSIoTProvider extends MqttOverWSProvider {
-	constructor(options: AWSIoTProviderOptions = {}) {
+export class AWSIoT extends MqttOverWS {
+	constructor(options: AWSIoTOptions = {}) {
 		super(options);
 	}
 
 	protected get region(): string | undefined {
-		return this.options['aws_pubsub_region'];
-	}
-
-	public getProviderName() {
-		return 'AWSIoTProvider';
+		return this.options?.region;
 	}
 
 	protected get endpoint() {
 		return (async () => {
-			const endpoint = this.options.aws_pubsub_endpoint;
+			const endpoint = this.options.endpoint;
 
 			const serviceInfo = {
 				service: SERVICE_NAME,
 				region: this.region,
 			};
+			const session = await fetchAuthSession();
+
+			if (!session.credentials) {
+				throw new Error('No auth session credentials');
+			}
+
 			const {
 				accessKeyId: access_key,
 				secretAccessKey: secret_key,
 				sessionToken: session_token,
-			} = await Credentials.get();
+			} = session.credentials;
 
 			const result = Signer.signUrl(
 				endpoint,

package/src/Providers/{MqttOverWSProvider.ts → MqttOverWS.ts}

@@ -1,17 +1,21 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+
+// @ts-ignore
 import * as Paho from '../vendor/paho-mqtt';
-import { v4 as uuid } from 'uuid';
-import Observable, { ZenObservable } from 'zen-observable-ts';
+import { Observable, SubscriptionLike as Subscription, Observer } from 'rxjs';
 
-import { AbstractPubSubProvider } from './PubSubProvider';
+import { AbstractPubSub } from './PubSub';
 import {
 	ConnectionState,
 	PubSubContentObserver,
 	PubSubContent,
+	PubSubOptions,
+	PublishInput,
+	SubscribeInput,
 } from '../types/PubSub';
-import { ProviderOptions } from '../types/Provider';
-import { ConsoleLogger as Logger, Hub } from '@aws-amplify/core';
+import { Hub, HubPayload, ConsoleLogger as Logger } from '@aws-amplify/core';
+import { amplifyUuid } from '@aws-amplify/core/internals/utils';
 import {
 	ConnectionStateMonitor,
 	CONNECTION_CHANGE,
@@ -22,7 +26,7 @@ import {
 } from '../utils/ReconnectionMonitor';
 import { AMPLIFY_SYMBOL, CONNECTION_STATE_CHANGE } from './constants';
 
-const logger = new Logger('MqttOverWSProvider');
+const logger = new Logger('MqttOverWS');
 
 export function mqttTopicMatch(filter: string, topic: string) {
 	const filterArray = filter.split('/');
@@ -38,10 +42,10 @@ export function mqttTopicMatch(filter: string, topic: string) {
 	return length === topicArray.length;
 }
 
-export interface MqttProviderOptions extends ProviderOptions {
+export interface MqttOptions extends PubSubOptions {
 	clientId?: string;
 	url?: string;
-	aws_pubsub_endpoint?: string;
+	endpoint?: string;
 }
 
 interface PahoClient {
@@ -57,7 +61,7 @@ interface PahoClient {
 	isConnected: () => boolean;
 	subscribe: (topic: string) => void;
 	unsubscribe: (topic: string) => void;
-	send(topic: string, message: string);
+	send(topic: string, message: string): void;
 }
 
 class ClientsQueue {
@@ -89,36 +93,32 @@ class ClientsQueue {
 	}
 }
 
-const dispatchPubSubEvent = (
-	event: string,
-	data: Record<string, unknown>,
-	message: string
-) => {
-	Hub.dispatch('pubsub', { event, data, message }, 'PubSub', AMPLIFY_SYMBOL);
+const dispatchPubSubEvent = (payload: HubPayload) => {
+	Hub.dispatch('pubsub', payload, 'PubSub', AMPLIFY_SYMBOL);
 };
 
 const topicSymbol = typeof Symbol !== 'undefined' ? Symbol('topic') : '@@topic';
 
-export class MqttOverWSProvider extends AbstractPubSubProvider<MqttProviderOptions> {
+export class MqttOverWS extends AbstractPubSub<MqttOptions> {
 	private _clientsQueue = new ClientsQueue();
-	private connectionState: ConnectionState;
+	private connectionState?: ConnectionState;
 	private readonly connectionStateMonitor = new ConnectionStateMonitor();
 	private readonly reconnectionMonitor = new ReconnectionMonitor();
 
-	constructor(options: MqttProviderOptions = {}) {
-		super({ ...options, clientId: options.clientId || uuid() });
+	constructor(options: MqttOptions = {}) {
+		super({ ...options, clientId: options.clientId || amplifyUuid() });
 
 		// Monitor the connection health state and pass changes along to Hub
 		this.connectionStateMonitor.connectionStateObservable.subscribe(
 			connectionStateChange => {
-				dispatchPubSubEvent(
-					CONNECTION_STATE_CHANGE,
-					{
+				dispatchPubSubEvent({
+					event: CONNECTION_STATE_CHANGE,
+					data: {
 						provider: this,
 						connectionState: connectionStateChange,
 					},
-					`Connection state is ${connectionStateChange}`
-				);
+					message: `Connection state is ${connectionStateChange}`,
+				});
 
 				this.connectionState = connectionStateChange;
 
@@ -138,7 +138,7 @@ export class MqttOverWSProvider extends AbstractPubSubProvider<MqttProviderOptio
 	}
 
 	protected get endpoint(): Promise<string | undefined> {
-		return Promise.resolve(this.options.aws_pubsub_endpoint);
+		return Promise.resolve(this.options.endpoint);
 	}
 
 	protected get clientsQueue() {
@@ -151,10 +151,6 @@ export class MqttOverWSProvider extends AbstractPubSubProvider<MqttProviderOptio
 		];
 	}
 
-	getProviderName() {
-		return 'MqttOverWSProvider';
-	}
-
 	public onDisconnect({
 		clientId,
 		errorCode,
@@ -177,10 +173,7 @@ export class MqttOverWSProvider extends AbstractPubSubProvider<MqttProviderOptio
 		}
 	}
 
-	public async newClient({
-		url,
-		clientId,
-	}: MqttProviderOptions): Promise<PahoClient> {
+	public async newClient({ url, clientId }: MqttOptions): Promise<PahoClient> {
 		logger.debug('Creating new MQTT client', clientId);
 
 		this.connectionStateMonitor.record(CONNECTION_CHANGE.OPENING_CONNECTION);
@@ -230,7 +223,7 @@ export class MqttOverWSProvider extends AbstractPubSubProvider<MqttProviderOptio
 
 	protected async connect(
 		clientId: string,
-		options: MqttProviderOptions = {}
+		options: MqttOptions = {}
 	): Promise<PahoClient | undefined> {
 		return await this.clientsQueue.get(clientId, async clientId => {
 			const client = await this.newClient({ ...options, clientId });
@@ -238,10 +231,7 @@ export class MqttOverWSProvider extends AbstractPubSubProvider<MqttProviderOptio
 			if (client) {
 				// Once connected, subscribe to all topics registered observers
 				this._topicObservers.forEach(
-					(
-						_value: Set<ZenObservable.SubscriptionObserver<any>>,
-						key: string
-					) => {
+					(_value: Set<PubSubContentObserver>, key: string) => {
 						client.subscribe(key);
 					}
 				);
@@ -260,15 +250,15 @@ export class MqttOverWSProvider extends AbstractPubSubProvider<MqttProviderOptio
 		this.connectionStateMonitor.record(CONNECTION_CHANGE.CLOSED);
 	}
 
-	async publish(topics: string[] | string, msg: PubSubContent) {
+	async publish({ topics, message }: PublishInput) {
 		const targetTopics = ([] as string[]).concat(topics);
-		const message = JSON.stringify(msg);
+		const msg = JSON.stringify(message);
 
 		const client = await this.clientsQueue.get(this.clientId);
 
 		if (client) {
 			logger.debug('Publishing to topic(s)', targetTopics.join(','), message);
-			targetTopics.forEach(topic => client.send(topic, message));
+			targetTopics.forEach(topic => client.send(topic, msg));
 		} else {
 			logger.debug(
 				'Publishing to topic(s) failed',
@@ -286,9 +276,7 @@ export class MqttOverWSProvider extends AbstractPubSubProvider<MqttProviderOptio
 
 	private _onMessage(topic: string, msg: string) {
 		try {
-			const matchedTopicObservers: Set<
-				ZenObservable.SubscriptionObserver<any>
-			>[] = [];
+			const matchedTopicObservers: Set<PubSubContentObserver>[] = [];
 			this._topicObservers.forEach((observerForTopic, observerTopic) => {
 				if (mqttTopicMatch(observerTopic, topic)) {
 					matchedTopicObservers.push(observerForTopic);
@@ -309,13 +297,13 @@ export class MqttOverWSProvider extends AbstractPubSubProvider<MqttProviderOptio
 		}
 	}
 
-	subscribe(
-		topics: string[] | string,
-		options: MqttProviderOptions = {}
-	): Observable<PubSubContent> {
+	subscribe({
+		topics,
+		options = {},
+	}: SubscribeInput & { options?: MqttOptions }): Observable<PubSubContent> {
 		const targetTopics = ([] as string[]).concat(topics);
 		logger.debug('Subscribing to topic(s)', targetTopics.join(','));
-		let reconnectSubscription: ZenObservable.Subscription;
+		let reconnectSubscription: Subscription;
 
 		return new Observable(observer => {
 			targetTopics.forEach(topic => {
@@ -388,7 +376,7 @@ export class MqttOverWSProvider extends AbstractPubSubProvider<MqttProviderOptio
 					targetTopics.forEach(topic => {
 						const observersForTopic =
 							this._topicObservers.get(topic) ||
-							(new Set() as Set<ZenObservable.SubscriptionObserver<any>>);
+							(new Set() as Set<Observer<any>>);
 
 						observersForTopic.delete(observer);
 

package/src/Providers/PubSub.ts

@@ -0,0 +1,40 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import { Observable } from 'rxjs';
+import {
+	PubSubBase,
+	PubSubOptions,
+	PubSubContent,
+	PublishInput,
+	SubscribeInput,
+} from '../types/PubSub';
+import { ConsoleLogger as Logger } from '@aws-amplify/core';
+const logger = new Logger('AbstractPubSubProvider');
+
+export abstract class AbstractPubSub<T extends PubSubOptions>
+	implements PubSubBase
+{
+	private _config: T;
+
+	constructor(options: T) {
+		this._config = options;
+	}
+
+	configure(config: T): T {
+		this._config = { ...config, ...this._config };
+
+		logger.debug(`configure`, this._config);
+
+		return this.options;
+	}
+
+	protected get options(): T {
+		return { ...this._config };
+	}
+
+	public abstract newClient(clientOptions: T): Promise<any>;
+
+	public abstract publish(input: PublishInput): void;
+
+	public abstract subscribe(input: SubscribeInput): Observable<PubSubContent>;
+}

package/src/Providers/constants.ts

@@ -1,5 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
+export { AMPLIFY_SYMBOL } from '@aws-amplify/core/internals/utils';
+
 export const MAX_DELAY_MS = 5000;
 
 export const NON_RETRYABLE_CODES = [400, 401, 403];
@@ -71,12 +73,6 @@ export enum SOCKET_STATUS {
 	CONNECTING,
 }
 
-export const AMPLIFY_SYMBOL = (
-	typeof Symbol !== 'undefined' && typeof Symbol.for === 'function'
-		? Symbol.for('amplify_default')
-		: '@@amplify_default'
-) as Symbol;
-
 export const AWS_APPSYNC_REALTIME_HEADERS = {
 	accept: 'application/json, text/javascript',
 	'content-encoding': 'amz-1.0',

package/src/Providers/index.ts

@@ -1,14 +1,5 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
-export { AbstractPubSubProvider } from './PubSubProvider';
-export {
-	AWSAppSyncRealTimeProvider,
-	AWSAppSyncRealTimeProviderOptions,
-	ObserverQuery,
-} from './AWSAppSyncRealTimeProvider';
-export { AWSIoTProvider, AWSIoTProviderOptions } from './AWSIotProvider';
-export {
-	MqttProviderOptions,
-	MqttOverWSProvider,
-	mqttTopicMatch,
-} from './MqttOverWSProvider';
+export { AbstractPubSub } from './PubSub';
+export { AWSIoT, AWSIoTOptions } from './AWSIot';
+export { MqttOptions, MqttOverWS, mqttTopicMatch } from './MqttOverWS';

package/src/clients/iot.ts

@@ -0,0 +1,4 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export { AWSIoT as PubSub, AWSIoTOptions as PubSubOptions } from '../Providers';

package/src/clients/mqtt.ts

@@ -0,0 +1,7 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+export {
+	MqttOverWS as PubSub,
+	MqttOptions as PubSubOptions,
+} from '../Providers';