feed-common 1.36.1 → 1.37.0

package/src/utils/feed-templates/google.template.ts

@@ -0,0 +1,960 @@
+/* eslint-disable quotes */
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable max-len */
+import { dateRangeSchema, measureUnitsSchema, validateIfNoMacro } from './index.js';
+import { SOURCE_LANGUAGE, XmlFeedFormat } from '../../constants/profile.constants.js';
+import { XmlFeedTemplateType } from '../../types/profile.types.js';
+import { z } from 'zod';
+import { ulid } from 'ulid';
+
+const additionalImageLinkMapping = {
+    attribute: 'additional_image_link',
+    label: 'Additional image link',
+    description:
+        'The URL of an additional image for your product. Submit up to 10 additional product images by including this attribute multiple times. Max 2000 characters. Example: http:// www.example.com/image1.jpg',
+    required: false,
+    type: 'macro-input' as any,
+    validator: (v: string | number) =>
+        validateIfNoMacro(
+            v,
+            z
+                .string()
+                .max(2000)
+                .refine(v => !v || z.string().url().safeParse(v).success, { message: 'invalid URL' })
+        ),
+    defaultValue: '',
+    rules: { sections: [] },
+};
+
+const availabilityMapping = {
+    attribute: 'availability',
+    label: 'Availability',
+    description:
+        "Your product's availability. Supported values: in_stock, out_of_stock, preorder, backorder. Accurately submit the product's availability and match the availability from your landing page and checkout pages. Example: in_stock",
+    required: true,
+    type: 'macro-input' as any,
+    validator: (v: string | number) =>
+        validateIfNoMacro(v, z.enum(['in_stock', 'out_of_stock', 'preorder', 'backorder'])),
+};
+
+const customLabelMapping = {
+    description:
+        'Label that you assign to a product to help organize bidding and reporting in Shopping campaigns. Max 100 characters. Example: Seasonal',
+    required: true,
+    type: 'macro-input' as any,
+    validator: (v: string | number) => validateIfNoMacro(v, z.string().max(100)),
+};
+
+export const googleFeedTemplate: XmlFeedTemplateType = {
+    formats: [XmlFeedFormat.XML],
+    documentation: 'https://support.google.com/merchants/answer/7052112',
+    mapping: [
+        {
+            attribute: 'id',
+            label: 'ID',
+            description: 'Your product’s unique identifier. Max 50 characters. Example: A2B4',
+            required: true,
+            type: 'macro-input',
+            validator: v => validateIfNoMacro(v, z.string().max(50).min(1)),
+            defaultValue: '{{shopify.id}}-{{shopify.variant_id}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'title',
+            label: 'Title',
+            description: 'Your product’s name.  Plain text.Max 150 characters. Example: Mens Pique Polo Shirt',
+            required: true,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().max(150).min(1)),
+            defaultValue: '{{shopify.title}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'description',
+            label: 'Description',
+            description:
+                'Your product’s description. Plain Text. Max 5000 characters. Example: Made from 100% organic cotton, this classic red men’s polo has a slim fit and signature logo embroidered on the left chest. Machine wash cold; imported.',
+            required: true,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().max(5000).min(1)),
+            defaultValue: '{{shopify.description}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'link',
+            label: 'Link',
+            description:
+                'Your product’s landing page. Links must begin with http:// or https://. http://www.example.com/asp/sp.asp?cat=12&id=1030',
+            required: true,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().url()),
+            defaultValue: 'https://{{shopify.shop_domain}}/products/{{shopify.handle}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'image_link',
+            label: 'Image link',
+            description: 'The URL of your product’s main image. Example: http:// www.example.com/image1.jpg',
+            required: true,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().url()),
+            defaultValue: '{{shopify.image}}',
+            rules: { sections: [] },
+        },
+        ...[0, 1, 2, 3, 4, 5, 6, 7, 8, 9].map(() => ({
+            ...(additionalImageLinkMapping as any),
+        })),
+        {
+            attribute: 'virtual_model_link',
+            label: '3D model link',
+            description:
+                'Additional link to show a 3D model of your product. Available only in the US. This attribute is only available in the classic experience of Merchant Center. Limitation: valid URL, no more than 2000 characters long. Example: https://www.google.com/products/xyz.glb',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) =>
+                validateIfNoMacro(
+                    v,
+                    z
+                        .string()
+                        .max(2000)
+                        .refine(v => !v || z.string().url().safeParse(v).success, { message: 'invalid URL' })
+                ),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'mobile_link',
+            label: 'Mobile link',
+            description:
+                'Your product’s mobile-optimized landing page when you have a different URL for mobile and desktop traffic. Limitation: valid URL, no more than 2000 characters long. Example: http://www.m.example.com/asp/ sp.asp?cat=12 id=1030',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) =>
+                validateIfNoMacro(
+                    v,
+                    z
+                        .string()
+                        .max(2000)
+                        .refine(v => !v || z.string().url().safeParse(v).success, { message: 'invalid URL' })
+                ),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            ...availabilityMapping,
+            defaultValue: 'in_stock',
+            rules: { sections: [] },
+        },
+        {
+            ...availabilityMapping,
+            defaultValue: 'out_of_stock',
+            rules: {
+                sections: [
+                    {
+                        id: ulid(),
+                        ruleItems: [
+                            {
+                                id: ulid(),
+                                attribute: 'inventory_quantity',
+                                operator: 'equals',
+                                value: 0,
+                            },
+                        ],
+                    },
+                    {
+                        id: ulid(),
+                        ruleItems: [
+                            {
+                                id: ulid(),
+                                attribute: 'inventory_policy',
+                                operator: 'equals',
+                                value: 'deny',
+                            },
+                        ],
+                    },
+                ],
+            },
+        },
+        {
+            attribute: 'availability_date',
+            label: 'Availability date',
+            description:
+                'Required if product availability is set to preorder. The date a preordered product becomes available for delivery. Provide a value up to one year in the future. The availability date should also be added to the product’s landing page and be clear to your customers (for example, “May 6, 2023”). Example: 2016-02-24T11:07+0100',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) =>
+                // TODO: make required if availability is preorder
+                validateIfNoMacro(
+                    v,
+                    z
+                        .string()
+                        .refine(v => !v || z.string().date().safeParse(v).success, { message: 'invalid date' })
+                        .refine(v => !v || new Date(v).getTime() + 1000 * 60 * 60 * 24 * 365 > new Date().getTime(), {
+                            message: 'The date should be up to one year in the future',
+                        })
+                ),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'cost_of_goods_sold',
+            label: 'Cost of goods sold',
+            description:
+                'The costs associated with the sale of a particular product as defined by the accounting convention you set up. These costs may include material, labor, freight, or other overhead expenses. By submitting the COGS for your products, you gain insights about other metrics, such as your gross margin and the amount of revenue generated by your ads and free listings. The currency must be in the ISO 4217 format. For example, USD for US dollars. The decimal point must be a period (.). Example, 10.00 USD',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'expiration_date',
+            label: 'Expiration date',
+            description:
+                'The date that your product should stop showing. Use a date less than 30 days in the future. Example: 2016-07-11T11:07+0100',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) =>
+                validateIfNoMacro(
+                    v,
+                    z
+                        .string()
+                        .refine(v => !v || z.string().datetime().safeParse(v).success, { message: 'invalid date' })
+                        .refine(v => !v || new Date(v).getTime() + 1000 * 60 * 60 * 24 * 30 > new Date().getTime(), {
+                            message: 'The date should be less than 30 days in the future',
+                        })
+                ),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        // TODO: add condition, checking if sale price is set
+        {
+            attribute: 'price',
+            label: 'Price',
+            description:
+                "Your products price. Accurately submit the product's price and currency, and match with the price from your landing page and at checkout. Example: 15.00 USD",
+            required: true,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().min(1)),
+            defaultValue: '{{shopify.price}} {{shopify.shop_currency}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'sale_price',
+            label: 'Sale price',
+            description:
+                "Your product's sale price. Accurately submit the product's sale price, and match the sale price with your landing page and the checkout pages. Example: 15.00 USD",
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'sale_price_effective_date',
+            label: 'Sale price effective date',
+            description:
+                "The date range during which the sale price applies. Use a date less than 30 days in the future. Use together with the sale price. If you don't submit this attribute (sale price effective date), the sale price always applies. Separate start date and end date with /. Use a start date before the end date. Example: 2016-07-11T11:07+0100/2016-08-11T11:07+0100",
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, dateRangeSchema),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'unit_pricing_measure',
+            label: 'Unit pricing measure',
+            description:
+                'The measure and dimension of your product as it is sold. Optional (except when required by local laws or regulations). Use the measure or dimension of the product without packaging. Example: 1.5kg',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) =>
+                validateIfNoMacro(
+                    v,
+                    measureUnitsSchema([
+                        'oz',
+                        'lb',
+                        'mg',
+                        'g',
+                        'kg',
+                        'floz',
+                        'pt',
+                        'qt',
+                        'gal',
+                        'ml',
+                        'cl',
+                        'l',
+                        'cbm',
+                        'in',
+                        'ft',
+                        'yd',
+                        'cm',
+                        'm',
+                        'sqft',
+                        'sqm',
+                        'ct',
+                    ])
+                ),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'unit_pricing_base_measure',
+            label: 'Unit pricing base measure',
+            description:
+                'The product’s base measure for pricing (for example, 100ml means the price is calculated based on a 100ml units). Optional (except when required by local laws or regulations). Example: 100g',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) =>
+                validateIfNoMacro(
+                    v,
+                    measureUnitsSchema([
+                        'oz',
+                        'lb',
+                        'mg',
+                        'g',
+                        'kg',
+                        'floz',
+                        'pt',
+                        'qt',
+                        'gal',
+                        'ml',
+                        'cl',
+                        'l',
+                        'cbm',
+                        'in',
+                        'ft',
+                        'yd',
+                        'cm',
+                        'm',
+                        'sqft',
+                        'sqm',
+                        'ct',
+                    ])
+                ),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'installment',
+            label: 'Installment',
+            description:
+                "Details of an installment payment plan. This attribute uses 4 sub-attributes: Months [months] (Required) Integer, the number of installments the buyer has to pay. Amount [amount] (Required) ISO 4217, the amount the buyer has to pay per month. Downpayment [downpayment] (Optional) ISO 4217, the amount the buyer has to pay upfront as a one time payment. Note: if you don't submit the sub-attribute, the default value is 0 or “no down payment”. Credit type [credit_type] (Optional). This sub-attributes uses the following supported values: Finance [finance], Lease [lease]. Example: 6:30 EUR or 6:30 EUR:10 EUR:finance",
+            required: false,
+            type: 'macro-input',
+            // TODO: add validator
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'subscription_cost',
+            label: 'Subscription cost',
+            description:
+                'Details a monthly or annual payment plan that bundles a communications service contract with a wireless product. Optional (available in certain countries for showing wireless products and services only). Syntax: Period [period] (Required), The duration of a single subscription period. This sub-attribute uses the following supported values:  Month [month] Year [year]. Period length [period_length] (Required), Integer, the number of subscription periods (months or years) that the buyer must pay. Amount [amount] (Required), ISO 4217, the amount the buyer has to pay per subscription period. Example: month:12:30.00EUR',
+            required: false,
+            type: 'macro-input',
+            // TODO: add validator
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'loyalty_program',
+            label: 'Loyalty program',
+            description:
+                'Allows setting up of member prices and loyalty points. Optional (available for Japan and the United States only). This attribute uses 6 sub-attributes: Program label [program_label] (Required). The loyalty program label set in your loyalty program settings in Merchant Center. Tier label [tier_label] (Required), The tier label set in your program settings in Merchant Center, used to differentiate benefits between each tier. Price [price] (Optional) The member specific price for the program and tier. This will display alongside the non-member price to give shoppers an idea of the benefits of joining your program. Only available in the United States. Cashback [cashback_for_future_use] (Optional) Currently not available. Loyalty points [loyalty_points] (Optional) The points that the members gain on purchasing the product on your website. This needs to be a whole number. Member price effective date [member_price_effective_date] (optional): This sub-attribute allows merchants to specify when their member pricing benefit begins and ends. Example: my_loyalty_program:silver:10 USD::10:',
+            required: false,
+            type: 'macro-input',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'auto_pricing_min_price',
+            label: 'Minimum price',
+            description:
+                "The lowest price to which a product's price can be reduced. Google uses this information for features such as sale price suggestions, automated discounts or dynamic promotions. Example: 15.00 USD",
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'google_product_category',
+            label: 'Google product category',
+            description:
+                'Google-defined product category for your product. Example: Apparel & Accessories > Clothing > Outerwear > Coats & Jackets or 371',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'product_type',
+            label: 'Product type',
+            description:
+                'Product category that you define for your product. Max 750 alphanumeric character. Example: Home > Women > Dresses > Maxi Dresses',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().max(750)),
+            defaultValue: '{{shopify.category}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'brand',
+            label: 'Brand',
+            description: 'Your product’s brand name. Plain text. Max 70 characters. Example: Google',
+            required: true,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().max(70).min(1)),
+            defaultValue: '{{shopify.vendor}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'gtin',
+            label: 'GTIN',
+            description:
+                'Your product’s Global Trade Item Number (GTIN). Required (For all products with a known GTIN to enable full offer performance). Max 50 numeric characters. Example: 3234567890126',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().max(50)),
+            defaultValue: '{{shopify.barcode}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'mpn',
+            label: 'MPN',
+            description:
+                'Your product’s Manufacturer Part Number (MPN). Required (Only if your product does not have a manufacturer assigned GTIN). Only submit MPNs assigned by a manufacturer. Max 70 alphanumeric characters. Example: GO12345OOGLE',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().max(70)),
+            defaultValue: '{{shopify.sku}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'identifier_exists',
+            label: 'Identifier exists',
+            description:
+                'Use to indicate whether or not the unique product identifiers (UPIs) GTIN, MPN, and brand are available for your product. Submit "no" if: Your product is a media item and the GTIN is unavailable (Note: ISBN and SBN codes are accepted as GTINs or Your product is an apparel (clothing) item and the brand is unavailable or In all other categories, your product doesn’t have a GTIN, or a combination of MPN and brand. If a product does have unique product identifiers, don’t submit this attribute with a value of “no” or the product may be disapproved. Example: no',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.enum(['yes', 'no', ''])),
+            defaultValue: 'yes',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'condition',
+            label: 'Condition',
+            description:
+                'The condition of your product at time of sale. Required if your product is used or refurbished. Supported values: new, refurbished, used. Example: new',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.enum(['new', 'refurbished', 'used', ''])),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'adult',
+            label: 'Adult',
+            description:
+                'Indicate a product includes sexually suggestive content. Required (If a product contains adult content). Supported values: yes, no. Example: yes',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.enum(['yes', 'no', ''])),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'multipack',
+            label: 'Multipack',
+            description:
+                "The number of identical products sold within a merchant-defined multipack. Required (For multipack products in Australia, Brazil, Czechia, France, Germany, Italy, Japan, Netherlands, Spain, Switzerland, the UK and the US). Required for free listings on Google if you’ve created a multipack. Submit this attribute if you defined a custom group of identical products and are selling them as a single unit of sale (for example, you're selling 6 bars of soap together). If the product's manufacturer assembled the multipack instead of you, don't submit this attribute. Example: 6",
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.coerce.number().min(0)),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'is_bundle',
+            label: 'Bundle',
+            description:
+                'Indicates a product is a merchant-defined custom group of different products featuring one main product. Required (For bundles in Australia, Brazil, Czechia, France, Germany, Italy, Japan, Netherlands, Spain, Switzerland, the UK and the US). Required for free listings on Google if you’ve created a bundle containing a main product. Supported values: yes, no. Example: yes',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.enum(['yes', 'no', ''])),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'certification',
+            label: 'Certification',
+            description:
+                'Certifications, such as energy efficiency ratings, associated with your product. Available for the EU and EFTA countries and the UK. Required for products that require certain certification information to be shown in your Shopping ads or free listings, for example due to local energy efficiency labeling regulations. Example: EC:EPREL:123456',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'energy_efficiency_class',
+            label: 'Energy efficiency class',
+            description:
+                'Your product’s energy label. Available for the EU and EFTA countries and the UK. Note: This attribute is being deprecated. Please use the certification attribute instead to show the EU energy efficiency class. Supported values: A, A+, A++, A+++, B, C, D, E, F, G. Example: A+',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) =>
+                validateIfNoMacro(v, z.enum(['A', 'A+', 'A++', 'A+++', 'B', 'C', 'D', 'E', 'F', 'G', ''])),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'age_group',
+            label: 'Age group',
+            description:
+                'The demographic for which your product is intended. Required (For all apparel products that are targeted to people in Brazil, France, Germany, Japan, the UK, and the US as well as all products with assigned age groups). Required for free listings for all Apparel & Accessories (ID: 166) products. Supported values: newborn, infant, toddler, kids, adult. Example: adult',
+            required: false,
+            type: 'macro-input',
+            // TODO: add to check if product is apparel
+            validator: (v: string | number) =>
+                validateIfNoMacro(v, z.enum(['newborn', 'infant', 'toddler', 'kids', 'adult', ''])),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'color',
+            label: 'Color',
+            description:
+                'Your product’s color(s). Required (For all apparel products that are targeted to people in Brazil, France, Germany, Japan, the UK, and the US). Required for free listings for all Apparel & Accessories (ID: 166) products. Max 100 alphanumeric characters (max 40 characters per color). Example: Black',
+            required: false,
+            type: 'macro-input',
+            // TODO: add to check if product is apparel
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().max(100)),
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'gender',
+            label: 'Gender',
+            description:
+                'The gender for which your product is intended. Required (Required for all apparel items that are targeted to people in Brazil, France, Germany, Japan, the UK, and the US as well as all gender-specific products). Required for free listings for all Google Apparel & Accessories (ID: 166) products. Supported values: male, female, unisex. Example: unisex',
+            required: false,
+            type: 'macro-input',
+            // TODO: add to check if product is apparel
+            validator: (v: string | number) => validateIfNoMacro(v, z.enum(['male', 'female', 'unisex', ''])),
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'material',
+            label: 'Material',
+            description:
+                'Your product’s fabric or material. Required (if relevant for distinguishing different products in a set of variants). Max 200 characters. Example: leather',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().max(200)),
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'pattern',
+            label: 'Pattern',
+            description:
+                'Your product’s pattern or graphic print. Required (if relevant for distinguishing different products in a set of variants). Max 100 characters. Example: polka dot',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().max(100)),
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'size',
+            label: 'Size',
+            description:
+                'Your product’s size. Required (Required for all apparel products in Apparel & Accessories > Clothing (ID:1604) and Apparel & Accessories > Shoes (ID:187) categories targeted to people in Brazil, France, Germany, Japan, the UK, and the US as well as all products available in different sizes). Required for free listings for all Apparel & Accessories > Clothing (ID:1604) and Apparel & Accessories > Shoes (ID:187) products. Max 100 characters. Example: XL',
+            required: false,
+            type: 'macro-input',
+            // TODO: add to check if product is apparel
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().max(100)),
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'size_type',
+            label: 'Size type',
+            description:
+                'Your apparel product’s cut. Available for apparel products only. Submit up to 2 values. Supported values: regular, petite, maternity, big, tall, plus. Example: maternity',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) =>
+                validateIfNoMacro(
+                    v,
+                    z
+                        .string()
+                        .refine(
+                            v =>
+                                !v ||
+                                (v.split(/\s+/).length < 3 &&
+                                    v
+                                        .split(/\s+/)
+                                        .every(st =>
+                                            ['regular', 'petite', 'maternity', 'big', 'tall', 'plus'].includes(st)
+                                        )),
+                            {
+                                message: `Only 'regular', 'petite', 'maternity', 'big', 'tall', 'plus' supported. Max 2 values`,
+                            }
+                        )
+                ),
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'size_system',
+            label: 'Size system',
+            description:
+                "The country of the size system used by your product. If you don't submit the attribute, the default value is your target country. Supported values: US, EU, UK, DE, FR, JP, CN, IT, BR, MEX, AU. Example: US",
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) =>
+                validateIfNoMacro(v, z.enum(['US', 'EU', 'UK', 'DE', 'FR', 'JP', 'CN', 'IT', 'BR', 'MEX', 'AU', ''])),
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'item_group_id',
+            label: 'Item group ID',
+            description:
+                'ID for a group of products that come in different versions (variants). Required (Brazil, France, Germany, Japan, the United Kingdom, and the US if the product is a variant). Required for free listings for all product variants. Max 50 alphanumeric characters. Example: AB12345',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().max(50)),
+            defaultValue: '{{shopify.id}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'product_length',
+            label: 'Product length',
+            description:
+                "Your product's length. Supported values: 0-3000. Syntax: Number + unit. Supported units: cm, in. Example: 20 in",
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, measureUnitsSchema(['cm', 'in'])),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'product_width',
+            label: 'Product width',
+            description:
+                "Your product's width. Supported values: 0-3000. Syntax: Number + unit. Supported units: cm, in. Example: 20 in",
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, measureUnitsSchema(['cm', 'in'])),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'product_height',
+            label: 'Product height',
+            description:
+                "Your product's height. Supported values: 0-3000. Syntax: Number + unit. Supported units: cm, in. Example: 20 in",
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, measureUnitsSchema(['cm', 'in'])),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'product_weight',
+            label: 'Product weight',
+            description:
+                "Your product's weight. Supported values: 0-2000. Syntax: Number + unit. Supported units: lb, oz, g, kb. Example: 3.5 lb",
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, measureUnitsSchema(['lb', 'oz', 'g', 'kg'])),
+            defaultValue: '{{shopify.weight}} {{shopify.weight_unit}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'product_detail',
+            label: 'Product detail',
+            description:
+                "Technical specifications or additional details of your product. This attribute uses 3 sub-attributes: Section name: Max 140 characters. Attribute name: Max 140 characters. Attribute value: Max 1000 characters. Don't add information covered in other attributes, all capital letters, gimmicky foreign characters, promotion text, or list keywords or search terms. Example: General:Product Type:Digital player",
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().max(1280)),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'product_highlight',
+            label: 'Product highlight',
+            description:
+                'The most relevant highlights of your products. Max 150 characters. Example: Supports thousands of apps, including Netflix, YouTube, and HBO Max',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().max(150)),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'ads_redirect',
+            label: 'Ads redirect',
+            description:
+                'A URL used to specify additional parameters for your product page. Customers will be sent to this URL rather than the value that you submit for the link or mobile link attributes. Submit the same registered domain as for the link attribute (and the mobile link attribute, if present). Max 2000 characters. Example: http://www.example.com/product.html',
+            required: false,
+            type: 'macro-input',
+            // TODO: check for the same domain with link and mobile link
+            validator: z
+                .string()
+                .max(2000)
+                .refine(v => !v || z.string().url().safeParse(v).success, { message: 'invalid URL' }),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        ...[0, 1, 2, 3, 4].map(i => ({
+            ...customLabelMapping,
+            attribute: `custom_label_${i}`,
+            label: `Custom Label ${i + 1}`,
+        })),
+        {
+            attribute: 'promotion_id',
+            label: 'Promotion ID',
+            description:
+                'An identifier that allows you to match products to promotions. Required for promotions in Australia, France, Germany, India, the UK and the US. Max 50 characters. Example: ABC123',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().max(15)),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'lifestyle_image_link',
+            label: 'Lifestyle image link',
+            description:
+                'Attribute used to include the URL for a lifestyle image for your product. Only available for browsy surfaces. Max 2000 characters. Example: https://www.example.com/image1.jpg',
+            required: false,
+            type: 'macro-input',
+            validator: z
+                .string()
+                .max(2000)
+                .refine(v => !v || z.string().url().safeParse(v).success, { message: 'invalid URL' }),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'external_seller_id',
+            label: 'External seller ID',
+            description:
+                'Note: Marketplaces is currently only available in the classic version of Merchant Center.Required for multi-seller account. Used by a marketplace to externally identify a seller. (For example, on a website). 1 - 50 characters. Example: SellerPublicName1991',
+            required: false,
+            type: 'macro-input',
+            validator: z.string().max(50),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'exclude_destination',
+            label: 'Exclude destination',
+            description:
+                'A setting that you can use to exclude a product from participating in a specific type of advertising campaign. Supported values: Shopping_ads, Buy_on_Google_listings, Display_ads, Local_inventory_ads, Free_listings, Free_local_listings, YouTube_Shopping. Example: Shopping_ads',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) =>
+                validateIfNoMacro(
+                    v,
+                    z.array(
+                        z.enum([
+                            'Shopping_ads',
+                            'Buy_on_Google_listings',
+                            'Display_ads',
+                            'Local_inventory_ads',
+                            'Free_listings',
+                            'Free_local_listings',
+                            'YouTube_Shopping',
+                            '',
+                        ])
+                    )
+                ),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'included_destination',
+            label: 'Included destination',
+            description:
+                'A setting that you can use to include a product in a specific type of advertising campaign. Supported values: Shopping_ads, Buy_on_Google_listings, Display_ads, Local_inventory_ads, Free_listings, Free_local_listings, YouTube_Shopping. Example: Shopping_ads',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) =>
+                validateIfNoMacro(
+                    v,
+                    z.array(
+                        z.enum([
+                            'Shopping_ads',
+                            'Buy_on_Google_listings',
+                            'Display_ads',
+                            'Local_inventory_ads',
+                            'Free_listings',
+                            'Free_local_listings',
+                            'YouTube_Shopping',
+                            '',
+                        ])
+                    )
+                ),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'shopping_ads_excluded_country',
+            label: 'Shopping ads excluded country',
+            description:
+                'A setting that allows you to exclude countries where your products are advertised on Shopping ads. 2 characters. Must be an ISO_3166-1_alpha-2 country code. Only available for Shopping ads. Example: DE',
+            required: false,
+            type: 'select',
+            choices: [SOURCE_LANGUAGE],
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'pause',
+            label: 'Pause',
+            description:
+                'A setting you can use to pause and quickly reactivate a product for all ads (including Shopping ads, Display ads, and local inventory ads). A product can be paused for up to 14 days. If a product is paused for more than 14 days it will be disapproved. To re-approve, remove the attribute.. Supported values: ads, no. Example: ads',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.enum(['ads', ''])),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'shipping',
+            label: 'Shipping',
+            description:
+                "Your product's shipping cost, shipping speeds, and the locations your product ships to. Shipping costs are required for Shopping ads and free listings for the following countries: Australia, Austria, Belgium, Canada, Czechia, France, Germany, India, Ireland, Israel, Italy, New Zealand, Japan, the Netherlands, Poland, Romania, South Korea, Spain, Switzerland, the UK, and the US. This attribute uses the following sub-attributes: Country (Required) ISO 3166 country code. Region (Optional). Postal code (Optional). Location ID (Optional). Location group name (Optional). Service (Optional) Service class or shipping speed. Price (Optional) Fixed shipping cost, including VAT if required. Minimum handling time and maximum handling time (Optional) To specify handling time. Minimum transit time and maximum transit time (Optional) To specify transit time. Supported prices: 0-1000 USD. Example: US:CA:Overnight:16.00 USD:1:1:2:3",
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'shipping_label',
+            label: 'Shipping label',
+            description:
+                'Label that you assign to a product to help assign correct shipping costs in Merchant Center account settings. Max 100 characters. Example: perishable',
+            type: 'macro-input',
+            defaultValue: '',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().max(100)),
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'shipping_weight',
+            label: 'Shipping weight',
+            description:
+                'The weight of the product used to calculate the shipping cost. Required for carrier-calculated rates in your account shipping settings. Supported weights: 9-2000 lbs for imperial, 0-1000 kg from metric. Supported units: lb, oz, g, kg. Syntax: Number + unit. Example: 3 kg',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, measureUnitsSchema(['lb', 'oz', 'g', 'kg'])),
+            defaultValue: '{{shopify.weight}} {{shopify.weight_unit}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'shipping_length',
+            label: 'Shipping length',
+            description:
+                'The length of the product used to calculate the shipping cost by dimensional weight. Supported values: 0-150 for inches, 1-400 for cm. Syntax: Number + unit. Supported units: cm, in. Example: 20 in',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, measureUnitsSchema(['cm', 'in'])),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'shipping_width',
+            label: 'Shipping width',
+            description:
+                'The width of the product used to calculate the shipping cost by dimensional weight. Required for carrier-calculated rates in your account shipping settings. Supported values: 0-3000. Syntax: Number + unit. Supported units: cm, in. Example: 20 in',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, measureUnitsSchema(['cm', 'in'])),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'shipping_height',
+            label: 'Shipping height',
+            description:
+                'The height of the product used to calculate the shipping cost by dimensional weight. Required for carrier-calculated rates in your account shipping settings. Supported values: 0-3000. Syntax: Number + unit. Supported units: cm, in. Example: 20 in',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, measureUnitsSchema(['cm', 'in'])),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'ships_from_country',
+            label: 'Ships from country',
+            description:
+                'A setting that allows you to provide the country from which your product will typically ship. 2 characters. Must be an ISO_3166-1_alpha-2 country code. Example: DE',
+            required: false,
+            type: 'select',
+            choices: [SOURCE_LANGUAGE],
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'max_handling_time',
+            label: 'Max handling time',
+            description:
+                'The longest amount of time between when an order is placed for a product and when the product ships. Submit the number of business days. For products ready to be shipped the same day, submit 0. Integer, greater than or equal to 0. Example: 3',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.coerce.number().min(0).int()),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'transit_time_label',
+            label: 'Transit time label',
+            description:
+                'Label that you assign to a product to help assign different transit times in Merchant Center account settings. Max 100 characters. Example: From Seattle',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().max(100)),
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'min_handling_time',
+            label: 'Min handling time',
+            description:
+                'The shortest amount of time between when an order is placed for a product and when the product ships. Submit the number of business days. For products ready to be shipped the same day, submit 0. Integer, greater than or equal to 0. Example: 1',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.coerce.number().min(0).int()),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'free_shipping_threshold',
+            label: 'Free shipping threshold',
+            description:
+                'Order cost above which shipping is free. This attribute uses the following sub-attributes: Country (Required) ISO 3166 country code. Price threshold (Required) Order cost above which shipping is free. Example: US:16.00 USD',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'tax',
+            label: 'Tax',
+            description:
+                'Your product’s sales tax rate in percent. Required (Available for the US only). This attribute uses 4 sub-attributes: Country (optional) ISO 3166 country code. Region or postal code or location ID (optional). Rate (required) Tax rate as a percentage. Shipping tax (optional) Specify if you charge tax on shipping, supported values: yes, no. Example: US:CA:5.00:y',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            // TODO: add validator to check if US
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'tax_category',
+            label: 'Tax category',
+            description:
+                'A category that classifies your product by specific tax rules. Recommended for custom tax rates at the account level. Max 100 characters. Example: Apparel',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().max(100)),
+            rules: { sections: [] },
+        },
+    ],
+};