publications.js

/**
 * `modules/reader-revenue-manager` data store: publications.
 *
 * Site Kit by Google, Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * External dependencies
 */
import invariant from 'invariant';
import { isPlainObject } from 'lodash';

/**
 * Internal dependencies.
 */
import { get, set } from 'googlesitekit-api';
import {
	commonActions,
	combineStores,
	createReducer,
	createRegistrySelector,
} from 'googlesitekit-data';
import { createFetchStore } from '@/js/googlesitekit/data/create-fetch-store';
import { createValidatedAction } from '@/js/googlesitekit/data/utils';
import { CORE_USER } from '@/js/googlesitekit/datastore/user/constants';
import {
	MODULES_READER_REVENUE_MANAGER,
	PUBLICATION_ONBOARDING_STATES,
} from './constants';
import { MODULE_SLUG_READER_REVENUE_MANAGER } from '@/js/modules/reader-revenue-manager/constants';
import { actions as errorStoreActions } from '@/js/googlesitekit/data/create-error-store';
import {
	getProductIDs,
	getPaymentOption,
} from '@/js/modules/reader-revenue-manager/utils/settings';

const fetchGetPublicationsStore = createFetchStore( {
	baseName: 'getPublications',
	controlCallback: () =>
		get(
			'modules',
			MODULE_SLUG_READER_REVENUE_MANAGER,
			'publications',
			{},
			{ useCache: false }
		),
	reducerCallback: createReducer( ( state, publications ) => {
		state.publications = publications;

		if ( state.settings?.publicationID ) {
			const publication = publications?.find(
				// eslint-disable-next-line sitekit/acronym-case
				( { publicationId: id } ) => id === state.settings.publicationID
			);

			if ( publication ) {
				const newSettings = {
					publicationOnboardingState: publication.onboardingState,
					productIDs: getProductIDs( publication.products ),
					paymentOption: getPaymentOption(
						publication.paymentOptions
					),
				};

				if ( publication.contentPolicyStatus ) {
					newSettings.contentPolicyState =
						publication.contentPolicyStatus.contentPolicyState;
					newSettings.policyInfoLink =
						publication.contentPolicyStatus.policyInfoLink || '';
				}

				Object.assign( state.settings, newSettings );

				if ( state.savedSettings ) {
					Object.assign( state.savedSettings, newSettings );
				}
			}
		}
	} ),
} );

const fetchGetSyncPublicationOnboardingStateStore = createFetchStore( {
	baseName: 'getSyncPublicationOnboardingState',
	controlCallback: ( { publicationID, publicationOnboardingState } ) =>
		set(
			'modules',
			MODULE_SLUG_READER_REVENUE_MANAGER,
			'sync-publication-onboarding-state',
			{
				publicationID,
				publicationOnboardingState,
			}
		),
	argsToParams: ( { publicationID, publicationOnboardingState } ) => {
		return { publicationID, publicationOnboardingState };
	},
	validateParams: ( { publicationID, publicationOnboardingState } = {} ) => {
		invariant(
			typeof publicationID === 'string' && publicationID.length > 0,
			'publicationID is required and must be string.'
		);

		invariant(
			typeof publicationOnboardingState === 'string' &&
				publicationOnboardingState.length > 0,
			'publicationOnboardingState is required and must be string.'
		);
	},
	reducerCallback: createReducer(
		( state, { publicationID, publicationOnboardingState } ) => {
			if ( ! publicationID ) {
				return;
			}

			// eslint-disable-next-line sitekit/no-direct-date
			const publicationOnboardingStateLastSyncedAtMs = Date.now();

			if ( state.settings.publicationID === publicationID ) {
				state.settings.publicationOnboardingState =
					publicationOnboardingState;
				state.settings.publicationOnboardingStateLastSyncedAtMs =
					publicationOnboardingStateLastSyncedAtMs;
			}

			if ( state.savedSettings.publicationID === publicationID ) {
				state.savedSettings.publicationOnboardingState =
					publicationOnboardingState;
				state.savedSettings.publicationOnboardingStateLastSyncedAtMs =
					publicationOnboardingStateLastSyncedAtMs;
			}

			const publication = state.publications?.find(
				// eslint-disable-next-line sitekit/acronym-case
				( { publicationId: id } ) => id === publicationID
			);

			if ( publication ) {
				publication.onboardingState = publicationOnboardingState;
			}
		}
	),
} );

const baseInitialState = {
	publications: undefined,
};

const baseActions = {
	/**
	 * Synchronizes the onboarding state of the publication with the API.
	 * Updates the settings on the server.
	 *
	 * @since 1.132.0
	 *
	 * @return {void}
	 */
	*syncPublicationOnboardingState() {
		const registry = yield commonActions.getRegistry();

		yield commonActions.await(
			registry
				.resolveSelect( MODULES_READER_REVENUE_MANAGER )
				.getSettings()
		);

		const publicationID = registry
			.select( MODULES_READER_REVENUE_MANAGER )
			.getPublicationID();

		const publicationOnboardingState = registry
			.select( MODULES_READER_REVENUE_MANAGER )
			.getPublicationOnboardingState();

		// If there is no publication ID in state, do not attempt to sync
		// the onboarding state.
		if (
			publicationID === undefined ||
			publicationOnboardingState === undefined
		) {
			return {};
		}

		return yield fetchGetSyncPublicationOnboardingStateStore.actions.fetchGetSyncPublicationOnboardingState(
			{
				publicationID,
				publicationOnboardingState,
			}
		);
	},

	/**
	 * Finds a matched publication.
	 *
	 * @since 1.132.0
	 *
	 * @return {Object|null} Matched publication; `null` if none found.
	 */
	*findMatchedPublication() {
		const { resolveSelect } = yield commonActions.getRegistry();
		const publications = yield commonActions.await(
			resolveSelect( MODULES_READER_REVENUE_MANAGER ).getPublications()
		);

		if ( publications.length === 0 ) {
			return null;
		}

		if ( publications.length === 1 ) {
			return publications[ 0 ];
		}

		const completedOnboardingPublication = publications.find(
			( publication ) =>
				publication.onboardingState ===
				PUBLICATION_ONBOARDING_STATES.ONBOARDING_COMPLETE
		);

		return completedOnboardingPublication || publications[ 0 ];
	},

	/**
	 * Resets the publications data in the store.
	 *
	 * @since 1.133.0
	 *
	 * @return {Object} The dispatched action results.
	 */
	*resetPublications() {
		const registry = yield commonActions.getRegistry();

		yield {
			type: 'RESET_PUBLICATIONS',
		};

		yield errorStoreActions.clearErrors( 'getPublications' );

		return registry
			.dispatch( MODULES_READER_REVENUE_MANAGER )
			.invalidateResolutionForStoreSelector( 'getPublications' );
	},

	/**
	 * Sets the given publication in the store.
	 *
	 * @since 1.133.0
	 *
	 * @param {Object} publication The publiation object.
	 * @return {Object} A Generator function.
	 */
	selectPublication: createValidatedAction(
		( publication ) => {
			invariant(
				isPlainObject( publication ),
				'A valid publication object is required.'
			);

			[ 'publicationId', 'onboardingState' ].forEach( ( key ) => {
				invariant(
					publication.hasOwnProperty( key ),
					`The publication object must contain ${ key }`
				);
			} );
		},
		function* ( {
			// `publicationId` is the identifier used by the API.
			// eslint-disable-next-line sitekit/acronym-case
			publicationId: publicationID,
			onboardingState,
			paymentOptions,
			products,
			contentPolicyStatus,
		} ) {
			const registry = yield commonActions.getRegistry();

			const settings = {
				publicationID,
				publicationOnboardingState: onboardingState,
				publicationOnboardingStateChanged: false,
				productIDs: getProductIDs( products ),
				paymentOption: getPaymentOption( paymentOptions ),
				productID: 'openaccess',
			};

			if ( contentPolicyStatus ) {
				settings.contentPolicyState =
					contentPolicyStatus.contentPolicyState;
				settings.policyInfoLink =
					contentPolicyStatus.policyInfoLink || '';
			}

			return registry
				.dispatch( MODULES_READER_REVENUE_MANAGER )
				.setSettings( settings );
		}
	),
};

const baseControls = {};

const baseReducer = createReducer( ( state, { type } ) => {
	switch ( type ) {
		case 'RESET_PUBLICATIONS':
			state.publications = baseInitialState.publications;
			break;

		default:
			break;
	}
} );

const baseResolvers = {
	*getPublications() {
		const registry = yield commonActions.getRegistry();
		// Only fetch publications if there are none in the store.
		const publications = registry
			.select( MODULES_READER_REVENUE_MANAGER )
			.getPublications();
		if ( publications === undefined ) {
			yield fetchGetPublicationsStore.actions.fetchGetPublications();
		}
	},
};

const baseSelectors = {
	/**
	 * Gets list of publications associated with the account.
	 *
	 * @since 1.132.0
	 *
	 * @param {Object} state Data store's state.
	 * @return {(Array.<Object>|undefined)} An array of publications; `undefined` if not loaded.
	 */
	getPublications( state ) {
		return state.publications;
	},

	/**
	 * Gets the current publication IDs.
	 *
	 * @since 1.150.0
	 *
	 * @param {Object} state Data store's state.
	 * @return {(Array.<string> | undefined)} An array of product IDs; `undefined` if publications are not loaded.
	 */
	getCurrentProductIDs: createRegistrySelector( ( select ) => ( state ) => {
		const publications = select(
			MODULES_READER_REVENUE_MANAGER
		).getPublications();

		if ( publications === undefined ) {
			return undefined;
		}

		const publicationID = select(
			MODULES_READER_REVENUE_MANAGER
		).getPublicationID();

		if ( ! publicationID ) {
			return [];
		}

		const selectedPublication = state.publications.find(
			// eslint-disable-next-line sitekit/acronym-case
			( { publicationId: id } ) => id === publicationID
		);

		if ( ! selectedPublication || ! selectedPublication.products ) {
			return [];
		}

		return selectedPublication.products.map( ( product ) => product.name );
	} ),

	/**
	 * Gets the policy info URL wrapped with the account chooser URL.
	 *
	 * @since 1.171.0
	 *
	 * @param {Object} state Data store's state.
	 * @return {(string|null|undefined)} The policy info URL wrapped with the account chooser URL; `null` if `policyInfoLink` is empty; `undefined` if not available.
	 */
	getPolicyInfoURL: createRegistrySelector( ( select ) => () => {
		const settings = select( MODULES_READER_REVENUE_MANAGER ).getSettings();

		if ( ! settings ) {
			return undefined;
		}

		const { policyInfoLink } = settings;

		if ( policyInfoLink === undefined ) {
			return undefined;
		}

		if ( ! policyInfoLink ) {
			return null;
		}

		return select( CORE_USER ).getAccountChooserURL( policyInfoLink );
	} ),
};

const store = combineStores(
	fetchGetPublicationsStore,
	fetchGetSyncPublicationOnboardingStateStore,
	{
		initialState: baseInitialState,
		actions: baseActions,
		controls: baseControls,
		reducer: baseReducer,
		resolvers: baseResolvers,
		selectors: baseSelectors,
	}
);

export const initialState = store.initialState;
export const actions = store.actions;
export const controls = store.controls;
export const reducer = store.reducer;
export const resolvers = store.resolvers;
export const selectors = store.selectors;

export default store;