Split lib/products-values

client/lib/domains/cart-utils.js

@@ -7,7 +7,7 @@ import { isEmpty, find, values } from 'lodash';
  * Internal dependencies
  */
 import { hasDomainRegistration, getDomainRegistrations } from 'lib/cart-values/cart-items';
-import { isDomainRegistration } from 'lib/products-values';
+import { isDomainRegistration } from 'lib/products-values/is-domain-registration';
 
 /**
  * Depending on the current step in checkout, the user's domain can be found in

client/lib/plans/index.js

@@ -7,7 +7,9 @@ import { difference, get, includes, pick, values, isFunction } from 'lodash';
  * Internal dependencies
  */
 import { isEnabled } from 'config';
-import { isFreeJetpackPlan, isJetpackPlan, isMonthly } from 'lib/products-values';
+import { isFreeJetpackPlan } from 'lib/products-values/is-free-jetpack-plan';
+import { isJetpackPlan } from 'lib/products-values/is-jetpack-plan';
+import { isMonthly } from 'lib/products-values/is-monthly';
 import { format as formatUrl, getUrlParts, getUrlFromParts, determineUrlType } from 'lib/url';
 import {
 	PLAN_FREE,

client/lib/products-values/allowed-product-attributes.js

@@ -0,0 +1,13 @@
+/**
+ * External dependencies
+ */
+import { pick } from 'lodash';
+
+/**
+ * Internal dependencies
+ */
+import schema from 'lib/products-values/schema.json';
+
+export function allowedProductAttributes( product ) {
+	return pick( product, Object.keys( schema.properties ) );
+}

client/lib/products-values/constants.js

@@ -1,9 +1,3 @@
-/**
- * External dependencies
- */
-import React from 'react';
-import { numberFormat, translate } from 'i18n-calypso';
-
 /**
  * Internal dependencies
  */
@@ -94,286 +88,3 @@ export const JETPACK_PRODUCT_PRICE_MATRIX = {
 		ratio: 12,
 	},
 };
-
-// Translatable strings
-export const getJetpackProductsShortNames = () => {
-	return {
-		[ PRODUCT_JETPACK_BACKUP_DAILY ]: translate( 'Daily Backups' ),
-		[ PRODUCT_JETPACK_BACKUP_DAILY_MONTHLY ]: translate( 'Daily Backups' ),
-		[ PRODUCT_JETPACK_BACKUP_REALTIME ]: translate( 'Real-Time Backups' ),
-		[ PRODUCT_JETPACK_BACKUP_REALTIME_MONTHLY ]: translate( 'Real-Time Backups' ),
-		[ PRODUCT_JETPACK_SEARCH ]: translate( 'Search' ),
-		[ PRODUCT_JETPACK_SEARCH_MONTHLY ]: translate( 'Search' ),
-		[ PRODUCT_WPCOM_SEARCH ]: translate( 'Search' ),
-		[ PRODUCT_WPCOM_SEARCH_MONTHLY ]: translate( 'Search' ),
-		[ PRODUCT_JETPACK_SCAN ]: translate( 'Daily Scan' ),
-		[ PRODUCT_JETPACK_SCAN_MONTHLY ]: translate( 'Daily Scan' ),
-		[ PRODUCT_JETPACK_ANTI_SPAM ]: translate( 'Anti-Spam' ),
-		[ PRODUCT_JETPACK_ANTI_SPAM_MONTHLY ]: translate( 'Anti-Spam' ),
-	};
-};
-
-export const getJetpackProductsDisplayNames = () => {
-	const backupDaily = (
-		<>
-			{ translate( 'Jetpack Backup {{em}}Daily{{/em}}', {
-				components: {
-					em: <em />,
-				},
-			} ) }{ ' ' }
-		</>
-	);
-	const backupRealtime = (
-		<>
-			{ ' ' }
-			{ translate( 'Jetpack Backup {{em}}Real-Time{{/em}}', {
-				components: {
-					em: <em />,
-				},
-			} ) }{ ' ' }
-		</>
-	);
-	const search = translate( 'Jetpack Search' );
-	const scanDaily = (
-		<>
-			{ translate( 'Jetpack Scan {{em}}Daily{{/em}}', {
-				components: {
-					em: <em />,
-				},
-			} ) }{ ' ' }
-		</>
-	);
-
-	const antiSpam = <>{ translate( 'Jetpack Anti-Spam' ) }</>;
-	return {
-		[ PRODUCT_JETPACK_BACKUP_DAILY ]: backupDaily,
-		[ PRODUCT_JETPACK_BACKUP_DAILY_MONTHLY ]: backupDaily,
-		[ PRODUCT_JETPACK_BACKUP_REALTIME ]: backupRealtime,
-		[ PRODUCT_JETPACK_BACKUP_REALTIME_MONTHLY ]: backupRealtime,
-		[ PRODUCT_JETPACK_SEARCH ]: search,
-		[ PRODUCT_JETPACK_SEARCH_MONTHLY ]: search,
-		[ PRODUCT_WPCOM_SEARCH ]: search,
-		[ PRODUCT_WPCOM_SEARCH_MONTHLY ]: search,
-		[ PRODUCT_JETPACK_SCAN ]: scanDaily,
-		[ PRODUCT_JETPACK_SCAN_MONTHLY ]: scanDaily,
-		[ PRODUCT_JETPACK_ANTI_SPAM ]: antiSpam,
-		[ PRODUCT_JETPACK_ANTI_SPAM_MONTHLY ]: antiSpam,
-	};
-};
-export const getJetpackProductsTaglines = () => {
-	const searchTagline = translate( 'Search your site.' );
-	const scanTagline = translate( 'Scan your site.' );
-	const antiSpamTagline = translate( 'Automatically clear spam from comments and forms.' );
-	return {
-		[ PRODUCT_JETPACK_BACKUP_DAILY ]: translate(
-			'Your data is being securely backed up every day with a 30-day archive.'
-		),
-		[ PRODUCT_JETPACK_BACKUP_DAILY_MONTHLY ]: translate(
-			'Your data is being securely backed up every day with a 30-day archive.'
-		),
-		[ PRODUCT_JETPACK_BACKUP_REALTIME ]: translate(
-			'Your data is being securely backed up as you edit.'
-		),
-		[ PRODUCT_JETPACK_BACKUP_REALTIME_MONTHLY ]: translate(
-			'Your data is being securely backed up as you edit.'
-		),
-		[ PRODUCT_JETPACK_SEARCH ]: searchTagline,
-		[ PRODUCT_JETPACK_SEARCH_MONTHLY ]: searchTagline,
-		[ PRODUCT_WPCOM_SEARCH ]: searchTagline,
-		[ PRODUCT_WPCOM_SEARCH_MONTHLY ]: searchTagline,
-		[ PRODUCT_JETPACK_SCAN ]: scanTagline,
-		[ PRODUCT_JETPACK_SCAN_MONTHLY ]: scanTagline,
-		[ PRODUCT_JETPACK_ANTI_SPAM ]: antiSpamTagline,
-		[ PRODUCT_JETPACK_ANTI_SPAM_MONTHLY ]: antiSpamTagline,
-	};
-};
-
-export const getJetpackProductsDescriptions = () => {
-	const searchDescription = translate(
-		'Incredibly powerful and customizable, Jetpack Search helps your visitors instantly find the right content – right when they need it.'
-	);
-	const scanDescription = translate(
-		'Automatic scanning and one-click fixes keep your site one step ahead of security threats.'
-	);
-	const antiSpamDescription = translate(
-		'Automatically clear spam from comments and forms. Save time, get more responses, give your visitors a better experience – all without lifting a finger.'
-	);
-	return {
-		[ PRODUCT_JETPACK_BACKUP_DAILY ]: translate(
-			'Always-on backups ensure you never lose your site. Your changes are saved every day with a 30-day archive.'
-		),
-		[ PRODUCT_JETPACK_BACKUP_DAILY_MONTHLY ]: translate(
-			'Always-on backups ensure you never lose your site. Your changes are saved every day with a 30-day archive.'
-		),
-		[ PRODUCT_JETPACK_BACKUP_REALTIME ]: translate(
-			'Always-on backups ensure you never lose your site. Your changes are saved as you edit and you have unlimited backup archives.'
-		),
-		[ PRODUCT_JETPACK_BACKUP_REALTIME_MONTHLY ]: translate(
-			'Always-on backups ensure you never lose your site. Your changes are saved as you edit and you have unlimited backup archives.'
-		),
-		[ PRODUCT_JETPACK_SEARCH ]: searchDescription,
-		[ PRODUCT_JETPACK_SEARCH_MONTHLY ]: searchDescription,
-		[ PRODUCT_JETPACK_SCAN ]: scanDescription,
-		[ PRODUCT_JETPACK_SCAN_MONTHLY ]: scanDescription,
-		[ PRODUCT_JETPACK_ANTI_SPAM ]: antiSpamDescription,
-		[ PRODUCT_JETPACK_ANTI_SPAM_MONTHLY ]: antiSpamDescription,
-	};
-};
-
-export const getJetpackProducts = () => {
-	const output = [
-		{
-			title: translate( 'Jetpack Backup' ),
-			description: translate(
-				'Always-on backups ensure you never lose your site. Choose from real-time or daily backups.'
-			),
-			hasPromo: true,
-			id: PRODUCT_JETPACK_BACKUP,
-			link: {
-				label: translate( 'Which backup option is best for me?' ),
-				props: {
-					location: 'product_jetpack_backup_description',
-					slug: 'which-one-do-i-need',
-				},
-				url: JETPACK_BACKUP_PRODUCT_LANDING_PAGE_URL,
-			},
-			options: {
-				yearly: JETPACK_BACKUP_PRODUCTS_YEARLY,
-				monthly: JETPACK_BACKUP_PRODUCTS_MONTHLY,
-			},
-			optionShortNames: getJetpackProductsShortNames(),
-			optionDisplayNames: getJetpackProductsDisplayNames(),
-			optionDescriptions: getJetpackProductsDescriptions(),
-			optionsLabel: translate( 'Select a backup option:' ),
-			slugs: JETPACK_BACKUP_PRODUCTS,
-		},
-	];
-	isEnabled( 'jetpack/scan-product' ) &&
-		output.push( {
-			title: translate( 'Jetpack Scan' ),
-			description: getJetpackProductsDescriptions()[ PRODUCT_JETPACK_SCAN ],
-			// There is only one option per billing interval, but this
-			// component still needs the full display with radio buttons.
-			forceRadios: true,
-			hasPromo: false,
-			id: PRODUCT_JETPACK_SCAN,
-			link: {
-				label: translate( 'Learn more' ),
-				props: {
-					location: 'product_jetpack_scan_description',
-					slug: 'learn-more-scan',
-				},
-				url: JETPACK_SCAN_PRODUCT_LANDING_PAGE_URL,
-			},
-			options: {
-				yearly: [ PRODUCT_JETPACK_SCAN ],
-				monthly: [ PRODUCT_JETPACK_SCAN_MONTHLY ],
-			},
-			optionShortNames: getJetpackProductsShortNames(),
-			optionDisplayNames: getJetpackProductsDisplayNames(),
-			optionDescriptions: getJetpackProductsDescriptions(),
-			optionsLabel: translate( 'Select a product option:' ),
-			slugs: JETPACK_SCAN_PRODUCTS,
-		} );
-	isEnabled( 'jetpack/anti-spam-product' ) &&
-		output.push( {
-			title: translate( 'Jetpack Anti-Spam' ),
-			description: getJetpackProductsDescriptions()[ PRODUCT_JETPACK_ANTI_SPAM ],
-			// There is only one option per billing interval, but this
-			// component still needs the full display with radio buttons.
-			forceRadios: true,
-			hasPromo: false,
-			id: PRODUCT_JETPACK_ANTI_SPAM,
-			link: {
-				label: translate( 'Learn more' ),
-				props: {
-					location: 'product_jetpack_anti_spam_description',
-					slug: 'learn-more-anti-spam',
-				},
-				url: JETPACK_ANTI_SPAM_PRODUCT_LANDING_PAGE_URL,
-			},
-			options: {
-				yearly: [ PRODUCT_JETPACK_ANTI_SPAM ],
-				monthly: [ PRODUCT_JETPACK_ANTI_SPAM_MONTHLY ],
-			},
-			optionShortNames: getJetpackProductsShortNames(),
-			optionDisplayNames: getJetpackProductsDisplayNames(),
-			optionDescriptions: getJetpackProductsDescriptions(),
-			optionsLabel: translate( 'Select a product option:' ),
-			slugs: JETPACK_ANTI_SPAM_PRODUCTS,
-		} );
-	isEnabled( 'jetpack/search-product' ) &&
-		output.push( {
-			title: translate( 'Jetpack Search' ),
-			description: getJetpackProductsDescriptions()[ PRODUCT_JETPACK_SEARCH ],
-			// There is only one option per billing interval, but this
-			// component still needs the full display with radio buttons.
-			forceRadios: true,
-			hasPromo: false,
-			id: PRODUCT_JETPACK_SEARCH,
-			link: {
-				label: translate( 'Learn more' ),
-				props: {
-					location: 'product_jetpack_search_description',
-					slug: 'learn-more-search',
-				},
-				url: JETPACK_SEARCH_PRODUCT_LANDING_PAGE_URL,
-			},
-			options: {
-				yearly: [ PRODUCT_JETPACK_SEARCH ],
-				monthly: [ PRODUCT_JETPACK_SEARCH_MONTHLY ],
-			},
-			optionShortNamesCallback: ( productObject ) => {
-				const numberOfDefinedTiers = 5;
-				switch ( productObject.price_tier_slug ) {
-					case JETPACK_SEARCH_TIER_UP_TO_100_RECORDS:
-						return translate( 'Tier 1: Up to 100 records' );
-					case JETPACK_SEARCH_TIER_UP_TO_1K_RECORDS:
-						return translate( 'Tier 2: Up to 1,000 records' );
-					case JETPACK_SEARCH_TIER_UP_TO_10K_RECORDS:
-						return translate( 'Tier 3: Up to 10,000 records' );
-					case JETPACK_SEARCH_TIER_UP_TO_100K_RECORDS:
-						return translate( 'Tier 4: Up to 100,000 records' );
-					case JETPACK_SEARCH_TIER_UP_TO_1M_RECORDS:
-						return translate( 'Tier 5: Up to 1,000,000 records' );
-					case JETPACK_SEARCH_TIER_MORE_THAN_1M_RECORDS: {
-						// This is a catch-all tier with prices increasing
-						// proportionally per million records, so define fake
-						// tiers here to show the user what they will actually
-						// pay and why.
-						const tierNumber =
-							numberOfDefinedTiers +
-							Math.floor( productObject.price_tier_usage_quantity / 1000000 );
-						const tierMaximumRecords =
-							1000000 * Math.ceil( productObject.price_tier_usage_quantity / 1000000 );
-						return translate( 'Tier %(tierNumber)d: Up to %(tierMaximumRecords)s records', {
-							args: {
-								tierNumber,
-								tierMaximumRecords: numberFormat( tierMaximumRecords ),
-							},
-						} );
-					}
-					default:
-						return null;
-				}
-			},
-			optionActionButtonNames: getJetpackProductsShortNames(),
-			optionDisplayNames: getJetpackProductsDisplayNames(),
-			optionDescriptions: getJetpackProductsDescriptions(),
-			optionsLabelCallback: ( productObject ) => {
-				return translate(
-					'Your current site record size: %(numberOfRecords)s record',
-					'Your current site record size: %(numberOfRecords)s records',
-					{
-						count: productObject.price_tier_usage_quantity,
-						args: {
-							numberOfRecords: numberFormat( productObject.price_tier_usage_quantity ),
-						},
-					}
-				);
-			},
-			slugs: JETPACK_SEARCH_PRODUCTS,
-		} );
-
-	return output;
-};

client/lib/products-values/format-product.js

@@ -0,0 +1,18 @@
+/**
+ * External dependencies
+ */
+import { assign } from 'lodash';
+
+export function formatProduct( product ) {
+	return assign( {}, product, {
+		product_slug: product.product_slug || product.productSlug,
+		product_type: product.product_type || product.productType,
+		included_domain_purchase_amount:
+			product.included_domain_purchase_amount || product.includedDomainPurchaseAmount,
+		is_domain_registration:
+			product.is_domain_registration !== undefined
+				? product.is_domain_registration
+				: product.isDomainRegistration,
+		free_trial: product.free_trial || product.freeTrial,
+	} );
+}

client/lib/products-values/get-domain-product-ranking.js

@@ -0,0 +1,18 @@
+/**
+ * Internal dependencies
+ */
+import { assertValidProduct } from 'lib/products-values/utils/assert-valid-product';
+import { formatProduct } from 'lib/products-values/format-product';
+import { isDomainRegistration } from 'lib/products-values/is-domain-registration';
+import { isDomainMapping } from 'lib/products-values/is-domain-mapping';
+
+export function getDomainProductRanking( product ) {
+	product = formatProduct( product );
+	assertValidProduct( product );
+
+	if ( isDomainRegistration( product ) ) {
+		return 0;
+	} else if ( isDomainMapping( product ) ) {
+		return 1;
+	}
+}

client/lib/products-values/get-domain.js

@@ -0,0 +1,22 @@
+/**
+ * External dependencies
+ */
+import { get } from 'lodash';
+
+/**
+ * Internal dependencies
+ */
+import { assertValidProduct } from 'lib/products-values/utils/assert-valid-product';
+import { formatProduct } from 'lib/products-values/format-product';
+
+export function getDomain( product ) {
+	product = formatProduct( product );
+	assertValidProduct( product );
+
+	const domainToBundle = get( product, 'extra.domain_to_bundle', false );
+	if ( domainToBundle ) {
+		return domainToBundle;
+	}
+
+	return product.meta;
+}