woocommerce/plugins/woocommerce-blocks/assets/js/base/context/event-emit/utils.ts

/**
 * External dependencies
 */
import { FieldValidationStatus, isObject } from '@woocommerce/types';

/**
 * Internal dependencies
 */
import type { EventObserversType, ObserverType } from './types';

export const getObserversByPriority = (
	observers: EventObserversType,
	eventType: string
): ObserverType[] => {
	return observers[ eventType ]
		? Array.from( observers[ eventType ].values() ).sort( ( a, b ) => {
				return a.priority - b.priority;
		  } )
		: [];
};

export enum responseTypes {
	SUCCESS = 'success',
	FAIL = 'failure',
	ERROR = 'error',
}

export enum noticeContexts {
	CART = 'wc/cart',
	CHECKOUT = 'wc/checkout',
	PAYMENTS = 'wc/checkout/payments',
	EXPRESS_PAYMENTS = 'wc/checkout/express-payments',
	CONTACT_INFORMATION = 'wc/checkout/contact-information',
	SHIPPING_ADDRESS = 'wc/checkout/shipping-address',
	BILLING_ADDRESS = 'wc/checkout/billing-address',
	SHIPPING_METHODS = 'wc/checkout/shipping-methods',
	CHECKOUT_ACTIONS = 'wc/checkout/checkout-actions',
}

export interface ResponseType extends Record< string, unknown > {
	type: responseTypes;
	retry?: boolean;
}

/**
 * Observers of checkout/cart events can return a response object to indicate success/error/failure. They may also
 * optionally pass metadata.
 */
export interface ObserverResponse {
	type: responseTypes;
	meta?: Record< string, unknown > | undefined;
	validationErrors?: Record< string, FieldValidationStatus > | undefined;
}

const isResponseOf = (
	response: unknown,
	type: string
): response is ResponseType => {
	return isObject( response ) && 'type' in response && response.type === type;
};

export const isSuccessResponse = (
	response: unknown
): response is ObserverFailResponse => {
	return isResponseOf( response, responseTypes.SUCCESS );
};
interface ObserverSuccessResponse extends ObserverResponse {
	type: responseTypes.SUCCESS;
}
export const isErrorResponse = (
	response: unknown
): response is ObserverSuccessResponse => {
	return isResponseOf( response, responseTypes.ERROR );
};
interface ObserverErrorResponse extends ObserverResponse {
	type: responseTypes.ERROR;
}

interface ObserverFailResponse extends ObserverResponse {
	type: responseTypes.FAIL;
}
export const isFailResponse = (
	response: unknown
): response is ObserverErrorResponse => {
	return isResponseOf( response, responseTypes.FAIL );
};

export const shouldRetry = ( response: unknown ): boolean => {
	return (
		! isObject( response ) ||
		typeof response.retry === 'undefined' ||
		response.retry === true
	);
};