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

package/src/Providers/PubSubProvider.ts

@@ -1,53 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-import Observable from 'zen-observable-ts';
-import { PubSubProvider, ProviderOptions } from '../types/Provider';
-import {
-	CustomUserAgentDetails,
-	ConsoleLogger as Logger,
-} from '@aws-amplify/core';
-import { PubSubContent } from '../types/PubSub';
-
-const logger = new Logger('AbstractPubSubProvider');
-
-export abstract class AbstractPubSubProvider<T extends ProviderOptions>
-	implements PubSubProvider
-{
-	private _config: T;
-
-	constructor(options: T) {
-		this._config = options;
-	}
-
-	configure(config: T): T {
-		this._config = { ...config, ...this._config };
-
-		logger.debug(`configure ${this.getProviderName()}`, this._config);
-
-		return this.options;
-	}
-
-	getCategory() {
-		return 'PubSub';
-	}
-
-	abstract getProviderName(): string;
-
-	protected get options(): T {
-		return { ...this._config };
-	}
-
-	public abstract newClient(clientOptions: T): Promise<any>;
-
-	public abstract publish(
-		topics: string[] | string,
-		msg: PubSubContent,
-		options?: T
-	): void;
-
-	public abstract subscribe(
-		topics: string[] | string,
-		options?: T,
-		customUserAgentDetails?: CustomUserAgentDetails
-	): Observable<PubSubContent>;
-}

package/src/PubSub.ts

@@ -1,33 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-// import '../Common/Polyfills';
-import Observable from 'zen-observable-ts';
-
-import {
-	Amplify,
-	browserOrNode,
-	ConsoleLogger as Logger,
-} from '@aws-amplify/core';
-import { PubSubProvider, ProviderOptions } from './types';
-import { InternalPubSubClass } from './internals';
-
-type PubSubObservable = {
-	provider: PubSubProvider;
-	value: string | Record<string, unknown>;
-};
-
-export class PubSubClass extends InternalPubSubClass {
-	public getModuleName() {
-		return 'PubSub';
-	}
-
-	subscribe(
-		topics: string[] | string,
-		options?: ProviderOptions
-	): Observable<PubSubObservable> {
-		return super.subscribe(topics, options);
-	}
-}
-
-export const PubSub = new PubSubClass();
-Amplify.register(PubSub);

package/src/internals/InternalPubSub.ts

@@ -1,185 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-import {
-	Amplify,
-	browserOrNode,
-	Category,
-	ConsoleLogger as Logger,
-	CustomUserAgentDetails,
-	INTERNAL_AWS_APPSYNC_REALTIME_PUBSUB_PROVIDER,
-	PubSubAction,
-} from '@aws-amplify/core';
-import { PubSubProvider, PubSubOptions, ProviderOptions } from '../types';
-import { AWSAppSyncRealTimeProvider } from '../Providers';
-import { PubSubContent } from '../types/PubSub';
-import Observable from 'zen-observable-ts';
-
-const { isNode } = browserOrNode();
-const logger = new Logger('PubSub');
-
-type PubSubObservable = {
-	provider: PubSubProvider;
-	value: string | Record<string, unknown>;
-};
-
-export class InternalPubSubClass {
-	private _options: PubSubOptions;
-
-	private _pluggables: PubSubProvider[];
-
-	/**
-	 * Internal instance of AWSAppSyncRealTimeProvider used by the API category to subscribe to AppSync
-	 */
-	private _awsAppSyncRealTimeProvider?: AWSAppSyncRealTimeProvider;
-
-	/**
-	 * Lazy instantiate AWSAppSyncRealTimeProvider when it is required by the API category
-	 */
-	private get awsAppSyncRealTimeProvider() {
-		if (!this._awsAppSyncRealTimeProvider) {
-			this._awsAppSyncRealTimeProvider = new AWSAppSyncRealTimeProvider(
-				this._options
-			);
-		}
-		return this._awsAppSyncRealTimeProvider;
-	}
-
-	/**
-	 * Initialize PubSub with AWS configurations
-	 *
-	 * @param {PubSubOptions} options - Configuration object for PubSub
-	 */
-	constructor(options?: PubSubOptions) {
-		this._options = options ?? {};
-		logger.debug('PubSub Options', this._options);
-		this._pluggables = [];
-		this.subscribe = this.subscribe.bind(this);
-	}
-
-	public getModuleName() {
-		return 'InternalPubSub';
-	}
-
-	/**
-	 * Configure PubSub part with configurations
-	 *
-	 * @param {PubSubOptions} config - Configuration for PubSub
-	 * @return {Object} - The current configuration
-	 */
-	configure(options: PubSubOptions) {
-		const opt: Record<string, unknown> = options
-			? options.PubSub || options
-			: {};
-		logger.debug('configure PubSub', { opt });
-
-		this._options = Object.assign({}, this._options, opt);
-
-		this._pluggables.map(pluggable => pluggable.configure(this._options));
-
-		return this._options;
-	}
-
-	/**
-	 * add plugin into Analytics category
-	 * @param {Object} pluggable - an instance of the plugin
-	 */
-	public async addPluggable(pluggable: PubSubProvider) {
-		if (pluggable && pluggable.getCategory() === 'PubSub') {
-			this._pluggables.push(pluggable);
-
-			const config = pluggable.configure(this._options);
-
-			return config;
-		}
-	}
-
-	/**
-	 * remove plugin from PubSub category
-	 * @param providerName - the name of the plugin
-	 */
-	removePluggable(providerName: string): void {
-		this._pluggables = this._pluggables.filter(
-			pluggable => pluggable.getProviderName() !== providerName
-		);
-	}
-
-	private getProviderByName(providerName: string | symbol) {
-		if (providerName === INTERNAL_AWS_APPSYNC_REALTIME_PUBSUB_PROVIDER) {
-			return this.awsAppSyncRealTimeProvider;
-		}
-
-		return this._pluggables.find(
-			pluggable => pluggable.getProviderName() === providerName
-		);
-	}
-
-	private getProviders(options: ProviderOptions = {}) {
-		const providerName = options.provider;
-		if (!providerName) {
-			return this._pluggables;
-		}
-
-		const provider = this.getProviderByName(providerName);
-		if (!provider) {
-			throw new Error(`Could not find provider named ${String(providerName)}`);
-		}
-
-		return [provider];
-	}
-
-	async publish(
-		topics: string[] | string,
-		msg: PubSubContent,
-		options?: ProviderOptions
-	) {
-		return Promise.all(
-			this.getProviders(options).map(provider =>
-				provider.publish(topics, msg, options)
-			)
-		);
-	}
-
-	subscribe(
-		topics: string[] | string,
-		options?: ProviderOptions,
-		customUserAgentDetails?: CustomUserAgentDetails
-	): Observable<PubSubObservable> {
-		if (isNode && this._options && this._options.ssr) {
-			throw new Error(
-				'Subscriptions are not supported for Server-Side Rendering (SSR)'
-			);
-		}
-
-		logger.debug('subscribe options', options);
-
-		const providers = this.getProviders(options);
-
-		const pubSubUserAgentDetails: CustomUserAgentDetails = {
-			category: Category.PubSub,
-			action: PubSubAction.Subscribe,
-			...customUserAgentDetails,
-		};
-
-		return new Observable<PubSubObservable>(observer => {
-			const observables = providers.map(provider => ({
-				provider,
-				observable: provider.subscribe(topics, options, pubSubUserAgentDetails),
-			}));
-
-			const subscriptions = observables.map(({ provider, observable }) =>
-				observable.subscribe({
-					start: console.error,
-					next: (value: PubSubContent) => observer.next({ provider, value }),
-					error: (error: unknown) => observer.error({ provider, error }),
-					// complete: observer.complete, // TODO: when all completed, complete the outer one
-				})
-			);
-
-			return () =>
-				subscriptions.forEach(subscription => subscription.unsubscribe());
-		});
-	}
-}
-
-export const InternalPubSub = new InternalPubSubClass();
-Amplify.register(InternalPubSub);

package/src/types/Provider.ts

@@ -1,37 +0,0 @@
-// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
-// SPDX-License-Identifier: Apache-2.0
-import Observable from 'zen-observable-ts';
-import { PubSubContent } from './PubSub';
-
-export interface PubSubOptions {
-	[key: string]: any;
-	ssr?: boolean;
-	PubSub?: {};
-}
-
-export interface ProviderOptions {
-	[key: string]: any;
-	provider?: string | symbol;
-}
-
-export interface PubSubProvider {
-	// configure your provider
-	configure(config: Record<string, unknown>): Record<string, unknown>;
-
-	// return 'Analytics';
-	getCategory(): string;
-
-	// return the name of you provider
-	getProviderName(): string;
-
-	publish(
-		topics: string[] | string,
-		msg: PubSubContent,
-		options?: ProviderOptions
-	): void;
-
-	subscribe(
-		topics: string[] | string,
-		options?: ProviderOptions
-	): Observable<PubSubContent>;
-}