643 lines
16 KiB
TypeScript
643 lines
16 KiB
TypeScript
/**
|
|
* External dependencies
|
|
*/
|
|
import { __ } from '@wordpress/i18n';
|
|
import { WC_BLOCKS_IMAGE_URL } from '@woocommerce/block-settings';
|
|
import { CartResponse } from '@woocommerce/types';
|
|
import { getSetting } from '@woocommerce/settings';
|
|
|
|
/**
|
|
* Internal dependencies
|
|
*/
|
|
import { previewShippingRates } from './shipping-rates';
|
|
|
|
/**
|
|
* Prices from the API may change because of this display setting. This makes the response use either
|
|
* wc_get_price_including_tax or wc_get_price_excluding_tax. It is correct that this setting changes the cart preview
|
|
* data.
|
|
*
|
|
* WooCommerce core has 2 settings which control this, one for cart (displayCartPricesIncludingTax), and one for the
|
|
* rest of the store (displayProductPricesIncludingTax). Because of this, Cart endpoints use displayCartPricesIncludingTax
|
|
* which is the most appropriate.
|
|
*
|
|
* Handling the display settings server-side helps work around rounding/display issues that can arise from manually
|
|
* adding tax to a price.
|
|
*/
|
|
const displayWithTax = getSetting( 'displayCartPricesIncludingTax', false );
|
|
|
|
// Sample data for cart block.
|
|
// This closely resembles the data returned from the Store API /cart endpoint.
|
|
// https://github.com/woocommerce/woocommerce-gutenberg-products-block/blob/trunk/src/StoreApi/docs/cart.md#cart-response
|
|
export const previewCart: CartResponse = {
|
|
coupons: [],
|
|
shipping_rates:
|
|
getSetting( 'shippingMethodsExist', false ) ||
|
|
getSetting( 'localPickupEnabled', false )
|
|
? previewShippingRates
|
|
: [],
|
|
items: [
|
|
{
|
|
key: '1',
|
|
id: 1,
|
|
quantity: 2,
|
|
catalog_visibility: 'visible',
|
|
name: __( 'Beanie', 'woo-gutenberg-products-block' ),
|
|
summary: __( 'Beanie', 'woo-gutenberg-products-block' ),
|
|
short_description: __(
|
|
'Warm hat for winter',
|
|
'woo-gutenberg-products-block'
|
|
),
|
|
description:
|
|
'Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.',
|
|
sku: 'woo-beanie',
|
|
permalink: 'https://example.org',
|
|
low_stock_remaining: 2,
|
|
backorders_allowed: false,
|
|
show_backorder_badge: false,
|
|
sold_individually: false,
|
|
quantity_limits: {
|
|
minimum: 1,
|
|
maximum: 99,
|
|
multiple_of: 1,
|
|
editable: true,
|
|
},
|
|
images: [
|
|
{
|
|
id: 10,
|
|
src: WC_BLOCKS_IMAGE_URL + 'previews/beanie.jpg',
|
|
thumbnail: WC_BLOCKS_IMAGE_URL + 'previews/beanie.jpg',
|
|
srcset: '',
|
|
sizes: '',
|
|
name: '',
|
|
alt: '',
|
|
},
|
|
],
|
|
variation: [
|
|
{
|
|
attribute: __( 'Color', 'woo-gutenberg-products-block' ),
|
|
value: __( 'Yellow', 'woo-gutenberg-products-block' ),
|
|
},
|
|
{
|
|
attribute: __( 'Size', 'woo-gutenberg-products-block' ),
|
|
value: __( 'Small', 'woo-gutenberg-products-block' ),
|
|
},
|
|
],
|
|
prices: {
|
|
currency_code: 'USD',
|
|
currency_symbol: '$',
|
|
currency_minor_unit: 2,
|
|
currency_decimal_separator: '.',
|
|
currency_thousand_separator: ',',
|
|
currency_prefix: '$',
|
|
currency_suffix: '',
|
|
price: displayWithTax ? '12000' : '10000',
|
|
regular_price: displayWithTax ? '12000' : '10000',
|
|
sale_price: displayWithTax ? '12000' : '10000',
|
|
price_range: null,
|
|
raw_prices: {
|
|
precision: 6,
|
|
price: displayWithTax ? '12000000' : '10000000',
|
|
regular_price: displayWithTax ? '12000000' : '10000000',
|
|
sale_price: displayWithTax ? '12000000' : '10000000',
|
|
},
|
|
},
|
|
totals: {
|
|
currency_code: 'USD',
|
|
currency_symbol: '$',
|
|
currency_minor_unit: 2,
|
|
currency_decimal_separator: '.',
|
|
currency_thousand_separator: ',',
|
|
currency_prefix: '$',
|
|
currency_suffix: '',
|
|
line_subtotal: '2000',
|
|
line_subtotal_tax: '400',
|
|
line_total: '2000',
|
|
line_total_tax: '400',
|
|
},
|
|
extensions: {},
|
|
item_data: [],
|
|
},
|
|
{
|
|
key: '2',
|
|
id: 2,
|
|
quantity: 1,
|
|
catalog_visibility: 'visible',
|
|
name: __( 'Cap', 'woo-gutenberg-products-block' ),
|
|
summary: __( 'Cap', 'woo-gutenberg-products-block' ),
|
|
short_description: __(
|
|
'Lightweight baseball cap',
|
|
'woo-gutenberg-products-block'
|
|
),
|
|
description:
|
|
'Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum tortor quam, feugiat vitae, ultricies eget, tempor sit amet, ante. Donec eu libero sit amet quam egestas semper. Aenean ultricies mi vitae est. Mauris placerat eleifend leo.',
|
|
sku: 'woo-cap',
|
|
low_stock_remaining: null,
|
|
permalink: 'https://example.org',
|
|
backorders_allowed: false,
|
|
show_backorder_badge: false,
|
|
sold_individually: false,
|
|
quantity_limits: {
|
|
minimum: 1,
|
|
maximum: 99,
|
|
multiple_of: 1,
|
|
editable: true,
|
|
},
|
|
images: [
|
|
{
|
|
id: 11,
|
|
src: WC_BLOCKS_IMAGE_URL + 'previews/cap.jpg',
|
|
thumbnail: WC_BLOCKS_IMAGE_URL + 'previews/cap.jpg',
|
|
srcset: '',
|
|
sizes: '',
|
|
name: '',
|
|
alt: '',
|
|
},
|
|
],
|
|
variation: [
|
|
{
|
|
attribute: __( 'Color', 'woo-gutenberg-products-block' ),
|
|
value: __( 'Orange', 'woo-gutenberg-products-block' ),
|
|
},
|
|
],
|
|
prices: {
|
|
currency_code: 'USD',
|
|
currency_symbol: '$',
|
|
currency_minor_unit: 2,
|
|
currency_decimal_separator: '.',
|
|
currency_thousand_separator: ',',
|
|
currency_prefix: '$',
|
|
currency_suffix: '',
|
|
price: displayWithTax ? '2400' : '2000',
|
|
regular_price: displayWithTax ? '2400' : '2000',
|
|
sale_price: displayWithTax ? '2400' : '2000',
|
|
price_range: null,
|
|
raw_prices: {
|
|
precision: 6,
|
|
price: displayWithTax ? '24000000' : '20000000',
|
|
regular_price: displayWithTax ? '24000000' : '20000000',
|
|
sale_price: displayWithTax ? '24000000' : '20000000',
|
|
},
|
|
},
|
|
totals: {
|
|
currency_code: 'USD',
|
|
currency_symbol: '$',
|
|
currency_minor_unit: 2,
|
|
currency_decimal_separator: '.',
|
|
currency_thousand_separator: ',',
|
|
currency_prefix: '$',
|
|
currency_suffix: '',
|
|
line_subtotal: '2000',
|
|
line_subtotal_tax: '400',
|
|
line_total: '2000',
|
|
line_total_tax: '400',
|
|
},
|
|
extensions: {},
|
|
item_data: [],
|
|
},
|
|
],
|
|
cross_sells: [
|
|
{
|
|
id: 1,
|
|
name: __( 'Polo', 'woo-gutenberg-products-block' ),
|
|
parent: 0,
|
|
type: 'simple',
|
|
variation: '',
|
|
permalink: 'https://example.org',
|
|
sku: 'woo-polo',
|
|
short_description: __( 'Polo', 'woo-gutenberg-products-block' ),
|
|
description: __( 'Polo', 'woo-gutenberg-products-block' ),
|
|
on_sale: false,
|
|
prices: {
|
|
currency_code: 'USD',
|
|
currency_symbol: '$',
|
|
currency_minor_unit: 2,
|
|
currency_decimal_separator: '.',
|
|
currency_thousand_separator: ',',
|
|
currency_prefix: '$',
|
|
currency_suffix: '',
|
|
price: displayWithTax ? '24000' : '20000',
|
|
regular_price: displayWithTax ? '24000' : '20000',
|
|
sale_price: displayWithTax ? '12000' : '10000',
|
|
price_range: null,
|
|
},
|
|
price_html: '',
|
|
average_rating: '4.5',
|
|
review_count: 2,
|
|
images: [
|
|
{
|
|
id: 17,
|
|
src: WC_BLOCKS_IMAGE_URL + 'previews/polo.jpg',
|
|
thumbnail: WC_BLOCKS_IMAGE_URL + 'previews/polo.jpg',
|
|
srcset: '',
|
|
sizes: '',
|
|
name: '',
|
|
alt: '',
|
|
},
|
|
],
|
|
categories: [],
|
|
tags: [],
|
|
attributes: [],
|
|
variations: [],
|
|
has_options: false,
|
|
is_purchasable: true,
|
|
is_in_stock: true,
|
|
is_on_backorder: false,
|
|
low_stock_remaining: null,
|
|
sold_individually: false,
|
|
add_to_cart: {
|
|
text: '',
|
|
description: '',
|
|
url: '',
|
|
minimum: 1,
|
|
maximum: 99,
|
|
multiple_of: 1,
|
|
},
|
|
},
|
|
{
|
|
id: 2,
|
|
name: __( 'Long Sleeve Tee', 'woo-gutenberg-products-block' ),
|
|
parent: 0,
|
|
type: 'simple',
|
|
variation: '',
|
|
permalink: 'https://example.org',
|
|
sku: 'woo-long-sleeve-tee',
|
|
short_description: __(
|
|
'Long Sleeve Tee',
|
|
'woo-gutenberg-products-block'
|
|
),
|
|
description: __(
|
|
'Long Sleeve Tee',
|
|
'woo-gutenberg-products-block'
|
|
),
|
|
on_sale: false,
|
|
prices: {
|
|
currency_code: 'USD',
|
|
currency_symbol: '$',
|
|
currency_minor_unit: 2,
|
|
currency_decimal_separator: '.',
|
|
currency_thousand_separator: ',',
|
|
currency_prefix: '$',
|
|
currency_suffix: '',
|
|
price: displayWithTax ? '30000' : '25000',
|
|
regular_price: displayWithTax ? '30000' : '25000',
|
|
sale_price: displayWithTax ? '30000' : '25000',
|
|
price_range: null,
|
|
},
|
|
price_html: '',
|
|
average_rating: '4',
|
|
review_count: 2,
|
|
images: [
|
|
{
|
|
id: 17,
|
|
src: WC_BLOCKS_IMAGE_URL + 'previews/long-sleeve-tee.jpg',
|
|
thumbnail:
|
|
WC_BLOCKS_IMAGE_URL + 'previews/long-sleeve-tee.jpg',
|
|
srcset: '',
|
|
sizes: '',
|
|
name: '',
|
|
alt: '',
|
|
},
|
|
],
|
|
categories: [],
|
|
tags: [],
|
|
attributes: [],
|
|
variations: [],
|
|
has_options: false,
|
|
is_purchasable: true,
|
|
is_in_stock: true,
|
|
is_on_backorder: false,
|
|
low_stock_remaining: null,
|
|
sold_individually: false,
|
|
add_to_cart: {
|
|
text: '',
|
|
description: '',
|
|
url: '',
|
|
minimum: 1,
|
|
maximum: 99,
|
|
multiple_of: 1,
|
|
},
|
|
},
|
|
{
|
|
id: 3,
|
|
name: __( 'Hoodie with Zipper', 'woo-gutenberg-products-block' ),
|
|
parent: 0,
|
|
type: 'simple',
|
|
variation: '',
|
|
permalink: 'https://example.org',
|
|
sku: 'woo-hoodie-with-zipper',
|
|
short_description: __(
|
|
'Hoodie with Zipper',
|
|
'woo-gutenberg-products-block'
|
|
),
|
|
description: __(
|
|
'Hoodie with Zipper',
|
|
'woo-gutenberg-products-block'
|
|
),
|
|
on_sale: true,
|
|
prices: {
|
|
currency_code: 'USD',
|
|
currency_symbol: '$',
|
|
currency_minor_unit: 2,
|
|
currency_decimal_separator: '.',
|
|
currency_thousand_separator: ',',
|
|
currency_prefix: '$',
|
|
currency_suffix: '',
|
|
price: displayWithTax ? '15000' : '12500',
|
|
regular_price: displayWithTax ? '30000' : '25000',
|
|
sale_price: displayWithTax ? '15000' : '12500',
|
|
price_range: null,
|
|
},
|
|
price_html: '',
|
|
average_rating: '1',
|
|
review_count: 2,
|
|
images: [
|
|
{
|
|
id: 17,
|
|
src:
|
|
WC_BLOCKS_IMAGE_URL + 'previews/hoodie-with-zipper.jpg',
|
|
thumbnail:
|
|
WC_BLOCKS_IMAGE_URL + 'previews/hoodie-with-zipper.jpg',
|
|
srcset: '',
|
|
sizes: '',
|
|
name: '',
|
|
alt: '',
|
|
},
|
|
],
|
|
categories: [],
|
|
tags: [],
|
|
attributes: [],
|
|
variations: [],
|
|
has_options: false,
|
|
is_purchasable: true,
|
|
is_in_stock: true,
|
|
is_on_backorder: false,
|
|
low_stock_remaining: null,
|
|
sold_individually: false,
|
|
add_to_cart: {
|
|
text: '',
|
|
description: '',
|
|
url: '',
|
|
minimum: 1,
|
|
maximum: 99,
|
|
multiple_of: 1,
|
|
},
|
|
},
|
|
{
|
|
id: 4,
|
|
name: __( 'Hoodie with Logo', 'woo-gutenberg-products-block' ),
|
|
parent: 0,
|
|
type: 'simple',
|
|
variation: '',
|
|
permalink: 'https://example.org',
|
|
sku: 'woo-hoodie-with-logo',
|
|
short_description: __( 'Polo', 'woo-gutenberg-products-block' ),
|
|
description: __( 'Polo', 'woo-gutenberg-products-block' ),
|
|
on_sale: false,
|
|
prices: {
|
|
currency_code: 'USD',
|
|
currency_symbol: '$',
|
|
currency_minor_unit: 2,
|
|
currency_decimal_separator: '.',
|
|
currency_thousand_separator: ',',
|
|
currency_prefix: '$',
|
|
currency_suffix: '',
|
|
price: displayWithTax ? '4500' : '4250',
|
|
regular_price: displayWithTax ? '4500' : '4250',
|
|
sale_price: displayWithTax ? '4500' : '4250',
|
|
price_range: null,
|
|
},
|
|
price_html: '',
|
|
average_rating: '5',
|
|
review_count: 2,
|
|
images: [
|
|
{
|
|
id: 17,
|
|
src: WC_BLOCKS_IMAGE_URL + 'previews/hoodie-with-logo.jpg',
|
|
thumbnail:
|
|
WC_BLOCKS_IMAGE_URL + 'previews/hoodie-with-logo.jpg',
|
|
srcset: '',
|
|
sizes: '',
|
|
name: '',
|
|
alt: '',
|
|
},
|
|
],
|
|
categories: [],
|
|
tags: [],
|
|
attributes: [],
|
|
variations: [],
|
|
has_options: false,
|
|
is_purchasable: true,
|
|
is_in_stock: true,
|
|
is_on_backorder: false,
|
|
low_stock_remaining: null,
|
|
sold_individually: false,
|
|
add_to_cart: {
|
|
text: '',
|
|
description: '',
|
|
url: '',
|
|
minimum: 1,
|
|
maximum: 99,
|
|
multiple_of: 1,
|
|
},
|
|
},
|
|
{
|
|
id: 5,
|
|
name: __( 'Hoodie with Pocket', 'woo-gutenberg-products-block' ),
|
|
parent: 0,
|
|
type: 'simple',
|
|
variation: '',
|
|
permalink: 'https://example.org',
|
|
sku: 'woo-hoodie-with-pocket',
|
|
short_description: __(
|
|
'Hoodie with Pocket',
|
|
'woo-gutenberg-products-block'
|
|
),
|
|
description: __(
|
|
'Hoodie with Pocket',
|
|
'woo-gutenberg-products-block'
|
|
),
|
|
on_sale: true,
|
|
prices: {
|
|
currency_code: 'USD',
|
|
currency_symbol: '$',
|
|
currency_minor_unit: 2,
|
|
currency_decimal_separator: '.',
|
|
currency_thousand_separator: ',',
|
|
currency_prefix: '$',
|
|
currency_suffix: '',
|
|
price: displayWithTax ? '3500' : '3250',
|
|
regular_price: displayWithTax ? '4500' : '4250',
|
|
sale_price: displayWithTax ? '3500' : '3250',
|
|
price_range: null,
|
|
},
|
|
price_html: '',
|
|
average_rating: '3.75',
|
|
review_count: 4,
|
|
images: [
|
|
{
|
|
id: 17,
|
|
src:
|
|
WC_BLOCKS_IMAGE_URL + 'previews/hoodie-with-pocket.jpg',
|
|
thumbnail:
|
|
WC_BLOCKS_IMAGE_URL + 'previews/hoodie-with-pocket.jpg',
|
|
srcset: '',
|
|
sizes: '',
|
|
name: '',
|
|
alt: '',
|
|
},
|
|
],
|
|
categories: [],
|
|
tags: [],
|
|
attributes: [],
|
|
variations: [],
|
|
has_options: false,
|
|
is_purchasable: true,
|
|
is_in_stock: true,
|
|
is_on_backorder: false,
|
|
low_stock_remaining: null,
|
|
sold_individually: false,
|
|
add_to_cart: {
|
|
text: '',
|
|
description: '',
|
|
url: '',
|
|
minimum: 1,
|
|
maximum: 99,
|
|
multiple_of: 1,
|
|
},
|
|
},
|
|
{
|
|
id: 6,
|
|
name: __( 'T-Shirt', 'woo-gutenberg-products-block' ),
|
|
parent: 0,
|
|
type: 'simple',
|
|
variation: '',
|
|
permalink: 'https://example.org',
|
|
sku: 'woo-t-shirt',
|
|
short_description: __( 'T-Shirt', 'woo-gutenberg-products-block' ),
|
|
description: __( 'T-Shirt', 'woo-gutenberg-products-block' ),
|
|
on_sale: false,
|
|
prices: {
|
|
currency_code: 'USD',
|
|
currency_symbol: '$',
|
|
currency_minor_unit: 2,
|
|
currency_decimal_separator: '.',
|
|
currency_thousand_separator: ',',
|
|
currency_prefix: '$',
|
|
currency_suffix: '',
|
|
price: displayWithTax ? '1800' : '1500',
|
|
regular_price: displayWithTax ? '1800' : '1500',
|
|
sale_price: displayWithTax ? '1800' : '1500',
|
|
price_range: null,
|
|
},
|
|
price_html: '',
|
|
average_rating: '3',
|
|
review_count: 2,
|
|
images: [
|
|
{
|
|
id: 17,
|
|
src: WC_BLOCKS_IMAGE_URL + 'previews/tshirt.jpg',
|
|
thumbnail: WC_BLOCKS_IMAGE_URL + 'previews/tshirt.jpg',
|
|
srcset: '',
|
|
sizes: '',
|
|
name: '',
|
|
alt: '',
|
|
},
|
|
],
|
|
categories: [],
|
|
tags: [],
|
|
attributes: [],
|
|
variations: [],
|
|
has_options: false,
|
|
is_purchasable: true,
|
|
is_in_stock: true,
|
|
is_on_backorder: false,
|
|
low_stock_remaining: null,
|
|
sold_individually: false,
|
|
add_to_cart: {
|
|
text: '',
|
|
description: '',
|
|
url: '',
|
|
minimum: 1,
|
|
maximum: 99,
|
|
multiple_of: 1,
|
|
},
|
|
},
|
|
],
|
|
fees: [
|
|
{
|
|
id: 'fee',
|
|
name: __( 'Fee', 'woo-gutenberg-products-block' ),
|
|
totals: {
|
|
currency_code: 'USD',
|
|
currency_symbol: '$',
|
|
currency_minor_unit: 2,
|
|
currency_decimal_separator: '.',
|
|
currency_thousand_separator: ',',
|
|
currency_prefix: '$',
|
|
currency_suffix: '',
|
|
total: '100',
|
|
total_tax: '20',
|
|
},
|
|
},
|
|
],
|
|
items_count: 3,
|
|
items_weight: 0,
|
|
needs_payment: true,
|
|
needs_shipping: getSetting( 'shippingEnabled', true ),
|
|
has_calculated_shipping: true,
|
|
shipping_address: {
|
|
first_name: '',
|
|
last_name: '',
|
|
company: '',
|
|
address_1: '',
|
|
address_2: '',
|
|
city: '',
|
|
state: '',
|
|
postcode: '',
|
|
country: '',
|
|
phone: '',
|
|
},
|
|
billing_address: {
|
|
first_name: '',
|
|
last_name: '',
|
|
company: '',
|
|
address_1: '',
|
|
address_2: '',
|
|
city: '',
|
|
state: '',
|
|
postcode: '',
|
|
country: '',
|
|
email: '',
|
|
phone: '',
|
|
},
|
|
totals: {
|
|
currency_code: 'USD',
|
|
currency_symbol: '$',
|
|
currency_minor_unit: 2,
|
|
currency_decimal_separator: '.',
|
|
currency_thousand_separator: ',',
|
|
currency_prefix: '$',
|
|
currency_suffix: '',
|
|
total_items: '4000',
|
|
total_items_tax: '800',
|
|
total_fees: '100',
|
|
total_fees_tax: '20',
|
|
total_discount: '0',
|
|
total_discount_tax: '0',
|
|
total_shipping: '0',
|
|
total_shipping_tax: '0',
|
|
total_tax: '820',
|
|
total_price: '4920',
|
|
tax_lines: [
|
|
{
|
|
name: __( 'Sales tax', 'woo-gutenberg-products-block' ),
|
|
rate: '20%',
|
|
price: '820',
|
|
},
|
|
],
|
|
},
|
|
errors: [],
|
|
payment_requirements: [ 'products' ],
|
|
extensions: {},
|
|
};
|