feed-common 1.34.2 → 1.35.1

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [1.35.1](https://github.com/advertikon/package-maxify-feed-common/compare/v1.35.0...v1.35.1) (2024-08-13)
+
+
+### Bug Fixes
+
+* fix import ([b29cd15](https://github.com/advertikon/package-maxify-feed-common/commit/b29cd15af07d3b2cbc787df49788406bf7e24e7a))
+
+# [1.35.0](https://github.com/advertikon/package-maxify-feed-common/compare/v1.34.2...v1.35.0) (2024-08-13)
+
+
+### Bug Fixes
+
+* fix bugs ([127d704](https://github.com/advertikon/package-maxify-feed-common/commit/127d704364f113830c1a9577749e1b2a11fc6016))
+* sync package-json ([b32eb9a](https://github.com/advertikon/package-maxify-feed-common/commit/b32eb9af810477f4679ac657e35a4fbcdddd205f))
+
+
+### Features
+
+* add facebook feed template ([ee2c896](https://github.com/advertikon/package-maxify-feed-common/commit/ee2c8960910f7848072d71c11acef168e42acbc4))
+* add template resolution funciton ([5a9d51e](https://github.com/advertikon/package-maxify-feed-common/commit/5a9d51e63e1b9be970d8ec7d766ebc4a28877d6b))
+
 ## [1.34.2](https://github.com/advertikon/package-maxify-feed-common/compare/v1.34.1...v1.34.2) (2024-08-09)
 
 

package/dist/index.d.ts

@@ -8,4 +8,5 @@ export * from './types/shopify.types.js';
 export * from './utils/profile.js';
 export * from './utils/utils.js';
 export * from './utils/company.js';
+export * from './utils/feed-templates/index.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iCAAiC,CAAC"}

package/dist/index.js

@@ -8,4 +8,5 @@ export * from './types/shopify.types.js';
 export * from './utils/profile.js';
 export * from './utils/utils.js';
 export * from './utils/company.js';
+export * from './utils/feed-templates/index.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,kCAAkC,CAAC;AAEjD,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AAEzC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC;AACjC,cAAc,oBAAoB,CAAC;AACnC,cAAc,iCAAiC,CAAC"}

package/dist/utils/feed-templates/custom.template.d.ts

@@ -0,0 +1,3 @@
+import { XmlFeedTemplateType } from '../../types/profile.types';
+export declare const customFeedTemplate: XmlFeedTemplateType;
+//# sourceMappingURL=custom.template.d.ts.map

package/dist/utils/feed-templates/custom.template.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom.template.d.ts","sourceRoot":"","sources":["../../../src/utils/feed-templates/custom.template.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,eAAO,MAAM,kBAAkB,EAAE,mBAGhC,CAAC"}

package/dist/utils/feed-templates/custom.template.js

@@ -0,0 +1,6 @@
+import { XmlFeedFormat } from '../../constants/profile.constants';
+export const customFeedTemplate = {
+    formats: [XmlFeedFormat.CSV, XmlFeedFormat.XMLS, XmlFeedFormat.TSV, XmlFeedFormat.XML],
+    mapping: [],
+};
+//# sourceMappingURL=custom.template.js.map

package/dist/utils/feed-templates/custom.template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"custom.template.js","sourceRoot":"","sources":["../../../src/utils/feed-templates/custom.template.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAGlE,MAAM,CAAC,MAAM,kBAAkB,GAAwB;IACnD,OAAO,EAAE,CAAC,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC,GAAG,CAAC;IACtF,OAAO,EAAE,EAAE;CACd,CAAC"}

package/dist/utils/feed-templates/fecebook.template.d.ts

@@ -0,0 +1,3 @@
+import { XmlFeedTemplateType } from '../../types/profile.types';
+export declare const facebookFeedTemplate: XmlFeedTemplateType;
+//# sourceMappingURL=fecebook.template.d.ts.map

package/dist/utils/feed-templates/fecebook.template.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fecebook.template.d.ts","sourceRoot":"","sources":["../../../src/utils/feed-templates/fecebook.template.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAiEhE,eAAO,MAAM,oBAAoB,EAAE,mBA6UlC,CAAC"}

package/dist/utils/feed-templates/fecebook.template.js

@@ -0,0 +1,368 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable quotes */
+import * as z from 'zod';
+import { ulid } from 'ulid';
+import { validate, validateIfNoMacro } from '.';
+import { XmlFeedFormat } from '../../constants/profile.constants';
+/* eslint-disable max-len */
+const availabilityMapping = {
+    attribute: 'availability',
+    label: 'Availability',
+    description: "The current availability of the item. Supported values: in stock, out of stock. Out of stock items don't appear in ads, which prevents advertising items that aren't available. They do still appear in shops on Facebook and Instagram, but are marked as sold out",
+    required: true,
+    type: 'macro-input',
+    validator: (v) => validate(v, z.enum(['in stock', 'out of stock']), false),
+};
+const conditionMapping = {
+    attribute: 'condition',
+    label: 'Condition',
+    description: 'The condition of the item. Supported values: new, refurbished, used',
+    required: true,
+    type: 'macro-input',
+    validator: (v) => validate(v, z.enum(['new', 'refurbished', 'used'])),
+};
+const videoMapping = {
+    attribute: 'video[0].url',
+    label: 'Video URL 1',
+    description: 'Up to 20 fields each containing a link to a product video. video[0].url will be your default video and a 4:5 aspect ratio is recommended. To add multiple videos per product, such as alternative 1:1 or 9:16 aspect ratios, add additional video fields',
+    required: false,
+    type: 'macro-input',
+    defaultValue: '',
+    rules: { sections: [] },
+    validator: (v) => validateIfNoMacro(v, z.string().url()),
+};
+const customLabelMapping = {
+    attribute: 'custom_label_0',
+    label: 'Custom Label 1',
+    description: 'Up to five custom fields. Use these fields to create custom labels for your items. For example, you can use custom labels to filter your products in your Facebook catalog. Supported values: 0-100 characters',
+    required: false,
+    type: 'macro-input',
+    defaultValue: '',
+    rules: { sections: [] },
+    validator: (v) => validate(v, z.string().max(100)),
+};
+const customNumberMapping = {
+    attribute: '',
+    label: '',
+    description: 'Up to five custom fields for any additional number-related information you want to filter items by when you create product sets. These fields allow you to filter by number ranges (is greater than and is less than) when you create a set. For example, you could use a custom number field to indicate the year each item was produced, and then filter a certain year range into a set. Supported whole number from 0 to 4294967295',
+    required: false,
+    type: 'macro-input',
+    defaultValue: '',
+    rules: { sections: [] },
+    validator: (v) => validateIfNoMacro(v, z.string().refine(v => Number(v) >= 0 && Number(v) <= 4294967295 && Number.isInteger(Number(v)), {
+        message: 'Must be a whole number from 0 to 4294967295',
+    })),
+};
+export const facebookFeedTemplate = {
+    formats: [XmlFeedFormat.CSV, XmlFeedFormat.XMLS, XmlFeedFormat.TSV, XmlFeedFormat.XML],
+    documentation: 'https://www.facebook.com/business/help/120325381656392',
+    mapping: [
+        {
+            attribute: 'id',
+            label: 'ID',
+            description: "A unique content ID for the item. Use the item's stock keeping unit (SKU) number if possible. Each content ID must appear only once in your catalog. If you use the same content ID for multiple items, none of them will be uploaded. Character limit: 100",
+            required: true,
+            type: 'macro-input',
+            validator: v => validate(v, z.string().max(100), false),
+            defaultValue: '{{shopify.sku}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'title',
+            label: 'Title',
+            description: 'A specific, relevant title for the item, written in title case. Character limit: 200, but we recommend 65 maximum to avoid longer titles being cut off',
+            required: true,
+            type: 'macro-input',
+            validator: (v) => validate(v, z.string().max(200), false),
+            defaultValue: '{{shopify.title}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'description',
+            label: 'Description',
+            description: "A detailed description of the item. Include specific and unique product features like material or color. Use plain text only (to use HTML, see rich_text description) and don't enter text in all capital letters. The description should be different from the title. We recommend not including any links. See product description specifications. Character limit: 9,999",
+            required: true,
+            type: 'macro-input',
+            validator: (v) => validate(v, z.string().max(9999), false),
+            defaultValue: '{{shopify.description}}',
+            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',
+                            },
+                        ],
+                    },
+                ],
+            },
+        },
+        {
+            ...conditionMapping,
+            defaultValue: 'new',
+            rules: {
+                sections: [],
+            },
+        },
+        {
+            attribute: 'price',
+            label: 'Price',
+            description: "The price of the item. Format the price as a number, followed by a space and then the 3-letter ISO 4217 currency code. Always use a period (.) as the decimal point, not a comma (,). Don't include currency symbols such as $, € or £. Only use one currency in your feed. To add prices in other currencies for selling in different countries, upload a country feed.",
+            required: true,
+            type: 'macro-input',
+            defaultValue: '{{shopify.price}} {{shopify.shop_currency}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'link',
+            label: 'Link',
+            description: "The link to the item's specific product page on your business's website where people can learn more about or buy the item. Links must begin with http:// or https://, be valid and be hosted on your business’s website domain",
+            required: true,
+            type: 'macro-input',
+            validator: (v) => validateIfNoMacro(v, z.string().url()),
+            defaultValue: '{{shopify.shop_domain}}/products/{{shopify.handle}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'image_link',
+            label: 'Image link',
+            description: 'The URL for the main image of your item. Images must be in JPEG or PNG format, at least 500 x 500 pixels and up to 8 MB',
+            required: true,
+            type: 'macro-input',
+            validator: (v) => validateIfNoMacro(v, z.string().url()),
+            defaultValue: '{{shopify.image}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'brand',
+            label: 'Brand',
+            description: 'The brand name of the item. Character limit: 100',
+            required: true,
+            type: 'macro-input',
+            validator: (v) => validate(v, z.string().max(100), false),
+            defaultValue: '{{shopify.vendor}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'quantity_to_sell_on_facebook',
+            label: 'Quantity to sell on Facebook',
+            description: "Checkout on Facebook and Instagram (US only). The quantity of this item that you have available to sell. Enter a whole number. To prevent overselling, an item's quantity is automatically reduced each time a purchase order is confirmed through checkout. When the quantity reaches 0, the item is marked as sold out in your shop on Facebook and Instagram. After 56 days, out of stock items stop appearing in your shop",
+            required: false,
+            type: 'macro-input',
+            validator: (v) => validateIfNoMacro(v, z.number().min(0)),
+            defaultValue: '{{shopify.inventory_quantity}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'size',
+            label: 'Size',
+            description: 'Required for items in specific product categories including clothing and shoes. The size of the item written as a word, abbreviation or number, such as "Small", "XL", "12" or "One size". Include a space between words and numbers (such as "US 12" or "15 months" instead of "US12" or "15months") and don\'t include the word "size" if not necessary (such as "XS" instead of "Size XS"). Character limit: 200',
+            required: false,
+            type: 'macro-input',
+            validator: (v) => validate(v, z.string().max(200)),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'sale_price',
+            label: 'Sale price',
+            description: 'If the item is on sale, enter its discounted price. Use the same formatting as the price field',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'sale_price_effective_date',
+            label: 'Sale price effective date',
+            description: "The date, time and time zone when your sale starts and ends. If you don't add this field, any items with a sale_price remain on sale until you remove their sale price. Use this format: YYYY-MM-DDT23:59+00:00/YYYY-MM-DDT23:59+00:00",
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'item_group_id',
+            label: 'Item group ID',
+            description: "Allows you to set up variants of the same product, such as different sizes, colors or patterns. Enter the same group ID in this field for all variants of the same product to indicate they're part of a group",
+            required: false,
+            type: 'macro-input',
+            defaultValue: '{{shopify.id}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'status',
+            label: 'Status',
+            description: 'Controls whether the item is active or archived in your catalog. Only active items can be seen by people in your ads, shops or any other channels. Supported values: active, archived. Items are active by default',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '{{shopify.status}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'additional_image_link',
+            label: 'Additional image link',
+            description: 'Links to up to 20 additional images of your item, separated by a comma (,), semicolon (;), space ( ) or vertical bar (|). Follow the same image specifications as image_link',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '{{shopify.images}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'gtin',
+            label: 'GTIN',
+            description: 'The item’s Global Trade Item Number (GTIN). Providing a GTIN is highly recommended to help classify the item. The GTIN may appear on the barcode, packaging or book cover. Not all items have a GTIN. Only provide one if you’re sure it’s correct. Don’t include dashes or spaces',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'mpn',
+            label: 'MPN',
+            description: 'The item’s manufacturer part number (MPN), a unique alphanumeric code assigned by the manufacturer in some industries to identify a specific item or part. It may appear on the packaging, label or etched directly onto the item. Providing a MPN is recommended to help classify the item if there is no GTIN. Not all items have a MPN. Only provide one if you’re sure it’s correct. Character limit: 100',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            validator: (v) => validate(v, z.string()),
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'google_product_category',
+            label: 'Google product category',
+            description: 'The category of the item according to the Google product taxonomy. Example: Apparel & Accessories > Clothing > Shirts & Tops or 212',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'fb_product_category',
+            label: 'Facebook product category',
+            description: "The category of the item according to Facebook's product taxonomy. Example: Clothing & Accessories > Clothing > Women's Clothing > Tops & T-Shirts or 430",
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'color',
+            label: 'Color',
+            description: 'The main color of the item. Describe the color in words, not a hex code. Character limit: 200',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            validator: (v) => validate(v, z.string()),
+        },
+        {
+            attribute: 'gender',
+            label: 'Gender',
+            description: 'The gender your item is targeted towards. Supported values: female, male, unisex',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            validator: v => validate(v, z.enum(['female', 'male', 'unisex'])),
+        },
+        {
+            attribute: 'age_group',
+            label: 'Age group',
+            description: 'The age group that the item is targeted towards. Supported values: adult, all ages, teen, kids, toddler, infant, newborn',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            validator: v => validate(v, z.enum(['adult', 'all ages', 'teen', 'kids', 'toddler', 'infant', 'newborn'])),
+        },
+        {
+            attribute: 'material',
+            label: 'Material',
+            description: 'The material the item is made from, such as cotton, polyester, denim or leather. Character limit: 200',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            validator: (v) => validate(v, z.string()),
+        },
+        {
+            attribute: 'pattern',
+            label: 'Pattern',
+            description: 'The pattern or graphic print on the item. Character limit: 100',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            validator: (v) => validate(v, z.string().max(100)),
+        },
+        {
+            attribute: 'rich_text_description',
+            label: 'Rich text description',
+            description: 'A description of the item containing rich text (HTML) formatting such as bullet points or multiple paragraphs. We recommend using rich text if the description is longer than 200 characters to help make it easier to read. If this field is provided, it will display instead of the description field wherever possible, but you must still provide description as a backup option. Character limit: 9,999',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '{{shopify.description_html}}',
+            rules: { sections: [] },
+            validator: (v) => validate(v, z.string()),
+        },
+        ...[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19].map(i => ({
+            ...videoMapping,
+            attribute: `video[${i}].url`,
+            label: `Video URL ${i + 1}`,
+        })),
+        {
+            attribute: 'shipping',
+            label: 'Shipping',
+            description: 'This field enables you to add the "free shipping" overlay in Advantage+ catalog ads. Enter shipping details for the item formatted as Country:Region:Service:Price Example: US:NY:Ground:9.99 USD, PH::Air:300 PHP',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'shipping_weight',
+            label: 'Shipping weight',
+            description: 'The shipping weight of the item in lb, oz, g or kg. Example: 0.3 kg',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '{{shopify.weight}} {{shopify.weight_unit}}',
+            rules: { sections: [] },
+        },
+        ...[0, 1, 2, 3, 4].map(i => ({
+            ...customLabelMapping,
+            attribute: `custom_label_${i}`,
+            label: `Custom Label ${i + 1}`,
+        })),
+        ...[0, 1, 2, 3, 4].map(i => ({
+            ...customNumberMapping,
+            attribute: `custom_number_${i}`,
+            label: `Custom Number ${i + 1}`,
+        })),
+    ],
+};
+//# sourceMappingURL=fecebook.template.js.map

package/dist/utils/feed-templates/fecebook.template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fecebook.template.js","sourceRoot":"","sources":["../../../src/utils/feed-templates/fecebook.template.ts"],"names":[],"mappings":"AAAA,uDAAuD;AACvD,2BAA2B;AAC3B,OAAO,KAAK,CAAC,MAAM,KAAK,CAAC;AACzB,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,GAAG,CAAC;AAEhD,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAC;AAElE,4BAA4B;AAC5B,MAAM,mBAAmB,GAAG;IACxB,SAAS,EAAE,cAAc;IACzB,KAAK,EAAE,cAAc;IACrB,WAAW,EACP,qQAAqQ;IACzQ,QAAQ,EAAE,IAAI;IACd,IAAI,EAAE,aAAoB;IAC1B,SAAS,EAAE,CAAC,CAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,cAAc,CAAC,CAAC,EAAE,KAAK,CAAC;CAC9F,CAAC;AAEF,MAAM,gBAAgB,GAAG;IACrB,SAAS,EAAE,WAAW;IACtB,KAAK,EAAE,WAAW;IAClB,WAAW,EAAE,qEAAqE;IAClF,QAAQ,EAAE,IAAI;IACd,IAAI,EAAE,aAAoB;IAC1B,SAAS,EAAE,CAAC,CAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,aAAa,EAAE,MAAM,CAAC,CAAC,CAAC;CACzF,CAAC;AAEF,MAAM,YAAY,GAAG;IACjB,SAAS,EAAE,cAAc;IACzB,KAAK,EAAE,aAAa;IACpB,WAAW,EACP,0PAA0P;IAC9P,QAAQ,EAAE,KAAK;IACf,IAAI,EAAE,aAAoB;IAC1B,YAAY,EAAE,EAAE;IAChB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;IACvB,SAAS,EAAE,CAAC,CAAkB,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;CAC5E,CAAC;AAEF,MAAM,kBAAkB,GAAG;IACvB,SAAS,EAAE,gBAAgB;IAC3B,KAAK,EAAE,gBAAgB;IACvB,WAAW,EACP,gNAAgN;IACpN,QAAQ,EAAE,KAAK;IACf,IAAI,EAAE,aAAoB;IAC1B,YAAY,EAAE,EAAE;IAChB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;IACvB,SAAS,EAAE,CAAC,CAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;CACtE,CAAC;AAEF,MAAM,mBAAmB,GAAG;IACxB,SAAS,EAAE,EAAE;IACb,KAAK,EAAE,EAAE;IACT,WAAW,EACP,yaAAya;IAC7a,QAAQ,EAAE,KAAK;IACf,IAAI,EAAE,aAAoB;IAC1B,YAAY,EAAE,EAAE;IAChB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;IACvB,SAAS,EAAE,CAAC,CAAkB,EAAE,EAAE,CAC9B,iBAAiB,CACb,CAAC,EACD,CAAC,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,IAAI,UAAU,IAAI,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE;QAC7F,OAAO,EAAE,6CAA6C;KACzD,CAAC,CACL;CACR,CAAC;AAEF,MAAM,CAAC,MAAM,oBAAoB,GAAwB;IACrD,OAAO,EAAE,CAAC,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC,IAAI,EAAE,aAAa,CAAC,GAAG,EAAE,aAAa,CAAC,GAAG,CAAC;IACtF,aAAa,EAAE,wDAAwD;IACvE,OAAO,EAAE;QACL;YACI,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,IAAI;YACX,WAAW,EACP,6PAA6P;YACjQ,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC;YACvD,YAAY,EAAE,iBAAiB;YAC/B,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,OAAO;YAClB,KAAK,EAAE,OAAO;YACd,WAAW,EACP,wJAAwJ;YAC5J,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,CAAC,CAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC;YAC1E,YAAY,EAAE,mBAAmB;YACjC,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,aAAa;YACxB,KAAK,EAAE,aAAa;YACpB,WAAW,EACP,6WAA6W;YACjX,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,CAAC,CAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC;YAC3E,YAAY,EAAE,yBAAyB;YACvC,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,GAAG,mBAAmB;YACtB,YAAY,EAAE,UAAU;YACxB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,GAAG,mBAAmB;YACtB,YAAY,EAAE,cAAc;YAC5B,KAAK,EAAE;gBACH,QAAQ,EAAE;oBACN;wBACI,EAAE,EAAE,IAAI,EAAE;wBACV,SAAS,EAAE;4BACP;gCACI,EAAE,EAAE,IAAI,EAAE;gCACV,SAAS,EAAE,oBAAoB;gCAC/B,QAAQ,EAAE,QAAQ;gCAClB,KAAK,EAAE,CAAC;6BACX;yBACJ;qBACJ;oBACD;wBACI,EAAE,EAAE,IAAI,EAAE;wBACV,SAAS,EAAE;4BACP;gCACI,EAAE,EAAE,IAAI,EAAE;gCACV,SAAS,EAAE,kBAAkB;gCAC7B,QAAQ,EAAE,QAAQ;gCAClB,KAAK,EAAE,MAAM;6BAChB;yBACJ;qBACJ;iBACJ;aACJ;SACJ;QACD;YACI,GAAG,gBAAgB;YACnB,YAAY,EAAE,KAAK;YACnB,KAAK,EAAE;gBACH,QAAQ,EAAE,EAAE;aACf;SACJ;QACD;YACI,SAAS,EAAE,OAAO;YAClB,KAAK,EAAE,OAAO;YACd,WAAW,EACP,0WAA0W;YAC9W,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,6CAA6C;YAC3D,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,MAAM;YACjB,KAAK,EAAE,MAAM;YACb,WAAW,EACP,gOAAgO;YACpO,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,CAAC,CAAkB,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;YACzE,YAAY,EAAE,qDAAqD;YACnE,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,YAAY;YACvB,KAAK,EAAE,YAAY;YACnB,WAAW,EACP,yHAAyH;YAC7H,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,CAAC,CAAkB,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;YACzE,YAAY,EAAE,mBAAmB;YACjC,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,OAAO;YAClB,KAAK,EAAE,OAAO;YACd,WAAW,EAAE,kDAAkD;YAC/D,QAAQ,EAAE,IAAI;YACd,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,CAAC,CAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC;YAC1E,YAAY,EAAE,oBAAoB;YAClC,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,8BAA8B;YACzC,KAAK,EAAE,8BAA8B;YACrC,WAAW,EACP,gaAAga;YACpa,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,CAAC,CAAkB,EAAE,EAAE,CAAC,iBAAiB,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC1E,YAAY,EAAE,gCAAgC;YAC9C,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,MAAM;YACjB,KAAK,EAAE,MAAM;YACb,WAAW,EACP,qZAAqZ;YACzZ,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,SAAS,EAAE,CAAC,CAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACnE,YAAY,EAAE,EAAE;YAChB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,YAAY;YACvB,KAAK,EAAE,YAAY;YACnB,WAAW,EACP,gGAAgG;YACpG,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,EAAE;YAChB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,2BAA2B;YACtC,KAAK,EAAE,2BAA2B;YAClC,WAAW,EACP,wOAAwO;YAC5O,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,EAAE;YAChB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,eAAe;YAC1B,KAAK,EAAE,eAAe;YACtB,WAAW,EACP,gNAAgN;YACpN,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,gBAAgB;YAC9B,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,QAAQ;YACnB,KAAK,EAAE,QAAQ;YACf,WAAW,EACP,oNAAoN;YACxN,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,oBAAoB;YAClC,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,uBAAuB;YAClC,KAAK,EAAE,uBAAuB;YAC9B,WAAW,EACP,8KAA8K;YAClL,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,oBAAoB;YAClC,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,MAAM;YACjB,KAAK,EAAE,MAAM;YACb,WAAW,EACP,oRAAoR;YACxR,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,EAAE;YAChB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,KAAK;YAChB,KAAK,EAAE,KAAK;YACZ,WAAW,EACP,+YAA+Y;YACnZ,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,EAAE;YAChB,SAAS,EAAE,CAAC,CAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;YAC1D,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,yBAAyB;YACpC,KAAK,EAAE,yBAAyB;YAChC,WAAW,EACP,qIAAqI;YACzI,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,EAAE;YAChB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,qBAAqB;YAChC,KAAK,EAAE,2BAA2B;YAClC,WAAW,EACP,2JAA2J;YAC/J,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,EAAE;YAChB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,OAAO;YAClB,KAAK,EAAE,OAAO;YACd,WAAW,EACP,+FAA+F;YACnG,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,EAAE;YAChB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;YACvB,SAAS,EAAE,CAAC,CAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;SAC7D;QACD;YACI,SAAS,EAAE,QAAQ;YACnB,KAAK,EAAE,QAAQ;YACf,WAAW,EAAE,kFAAkF;YAC/F,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,EAAE;YAChB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;YACvB,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,CAAC;SACpE;QACD;YACI,SAAS,EAAE,WAAW;YACtB,KAAK,EAAE,WAAW;YAClB,WAAW,EACP,0HAA0H;YAC9H,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,EAAE;YAChB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;YACvB,SAAS,EAAE,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,CAAC,CAAC,CAAC;SAC7G;QACD;YACI,SAAS,EAAE,UAAU;YACrB,KAAK,EAAE,UAAU;YACjB,WAAW,EACP,uGAAuG;YAC3G,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,EAAE;YAChB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;YACvB,SAAS,EAAE,CAAC,CAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;SAC7D;QACD;YACI,SAAS,EAAE,SAAS;YACpB,KAAK,EAAE,SAAS;YAChB,WAAW,EAAE,gEAAgE;YAC7E,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,EAAE;YAChB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;YACvB,SAAS,EAAE,CAAC,CAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;SACtE;QACD;YACI,SAAS,EAAE,uBAAuB;YAClC,KAAK,EAAE,uBAAuB;YAC9B,WAAW,EACP,+YAA+Y;YACnZ,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,8BAA8B;YAC5C,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;YACvB,SAAS,EAAE,CAAC,CAAkB,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC;SAC7D;QACD,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YAChF,GAAG,YAAY;YACf,SAAS,EAAE,SAAS,CAAC,OAAO;YAC5B,KAAK,EAAE,aAAa,CAAC,GAAG,CAAC,EAAE;SAC9B,CAAC,CAAC;QACH;YACI,SAAS,EAAE,UAAU;YACrB,KAAK,EAAE,UAAU;YACjB,WAAW,EACP,oNAAoN;YACxN,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,EAAE;YAChB,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD;YACI,SAAS,EAAE,iBAAiB;YAC5B,KAAK,EAAE,iBAAiB;YACxB,WAAW,EAAE,qEAAqE;YAClF,QAAQ,EAAE,KAAK;YACf,IAAI,EAAE,aAAa;YACnB,YAAY,EAAE,4CAA4C;YAC1D,KAAK,EAAE,EAAE,QAAQ,EAAE,EAAE,EAAE;SAC1B;QACD,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACzB,GAAG,kBAAkB;YACrB,SAAS,EAAE,gBAAgB,CAAC,EAAE;YAC9B,KAAK,EAAE,gBAAgB,CAAC,GAAG,CAAC,EAAE;SACjC,CAAC,CAAC;QACH,GAAG,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;YACzB,GAAG,mBAAmB;YACtB,SAAS,EAAE,iBAAiB,CAAC,EAAE;YAC/B,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,EAAE;SAClC,CAAC,CAAC;KACN;CACJ,CAAC"}

package/dist/utils/feed-templates/index.d.ts

@@ -0,0 +1,9 @@
+import { SafeParseReturnType, ZodType } from 'zod';
+import { XMLFeedType } from '../../constants/profile.constants';
+import { XmlFeedTemplateType } from '../../types/profile.types';
+export declare const hasMacro: (v: string) => boolean;
+export declare const removeMacro: (v: string) => string;
+export declare function validate(value: string | number, validator: ZodType<any, any>, skipEmpty?: boolean): SafeParseReturnType<any, any>;
+export declare function validateIfNoMacro(value: string | number, validator: ZodType<any, any>): SafeParseReturnType<any, any>;
+export declare function getTemplate(type: XMLFeedType): XmlFeedTemplateType;
+//# sourceMappingURL=index.d.ts.map

package/dist/utils/feed-templates/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/utils/feed-templates/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAGhE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAEhE,eAAO,MAAM,QAAQ,MAAO,MAAM,YAAwB,CAAC;AAC3D,eAAO,MAAM,WAAW,MAAO,MAAM,WAAmC,CAAC;AAEzE,wBAAgB,QAAQ,CACpB,KAAK,EAAE,MAAM,GAAG,MAAM,EACtB,SAAS,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,EAC5B,SAAS,UAAO,GACjB,mBAAmB,CAAC,GAAG,EAAE,GAAG,CAAC,CAY/B;AAED,wBAAgB,iBAAiB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,SAAS,EAAE,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,mBAAmB,CAAC,GAAG,EAAE,GAAG,CAAC,CAMrH;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,WAAW,GAAG,mBAAmB,CASlE"}

package/dist/utils/feed-templates/index.js

@@ -0,0 +1,32 @@
+import { XMLFeedType } from '../../constants/profile.constants';
+import { customFeedTemplate } from './custom.template';
+import { facebookFeedTemplate } from './fecebook.template';
+export const hasMacro = (v) => /{{[^}]+}}/.test(v);
+export const removeMacro = (v) => v.replaceAll(/{{[^}]+}}/g, '');
+export function validate(value, validator, skipEmpty = true) {
+    let valueToValidate = value;
+    if (typeof value === 'string') {
+        valueToValidate = removeMacro(value);
+    }
+    if (!value && skipEmpty) {
+        return { success: true, data: value };
+    }
+    return validator.safeParse(valueToValidate);
+}
+export function validateIfNoMacro(value, validator) {
+    if (typeof value === 'string' && hasMacro(value)) {
+        return { success: true, data: value };
+    }
+    return validator.safeParse(value);
+}
+export function getTemplate(type) {
+    switch (type) {
+        case XMLFeedType.Custom:
+            return customFeedTemplate;
+        case XMLFeedType.Facebook:
+            return facebookFeedTemplate;
+        default:
+            throw new Error(`Invalid feed type: ${type}`);
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/utils/feed-templates/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/utils/feed-templates/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAG3D,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAC3D,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;AAEzE,MAAM,UAAU,QAAQ,CACpB,KAAsB,EACtB,SAA4B,EAC5B,SAAS,GAAG,IAAI;IAEhB,IAAI,eAAe,GAAG,KAAK,CAAC;IAE5B,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,eAAe,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,CAAC,KAAK,IAAI,SAAS,EAAE,CAAC;QACtB,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAC1C,CAAC;IAED,OAAO,SAAS,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,KAAsB,EAAE,SAA4B;IAClF,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC/C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;IAC1C,CAAC;IAED,OAAO,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,IAAiB;IACzC,QAAQ,IAAI,EAAE,CAAC;QACX,KAAK,WAAW,CAAC,MAAM;YACnB,OAAO,kBAAkB,CAAC;QAC9B,KAAK,WAAW,CAAC,QAAQ;YACrB,OAAO,oBAAoB,CAAC;QAChC;YACI,MAAM,IAAI,KAAK,CAAC,sBAAsB,IAAI,EAAE,CAAC,CAAC;IACtD,CAAC;AACL,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "feed-common",
-  "version": "1.34.2",
+  "version": "1.35.1",
   "description": "Maxify feed common library",
   "main": "dist/index.js",
   "type": "module",
@@ -29,7 +29,8 @@
   },
   "peerDependencies": {
     "@shopify/shopify-api": "^9.2.0",
-    "zod": "^3.23.8"
+    "zod": "^3.23.8",
+    "ulid": "^2.3.0"
   },
   "repository": {
     "type": "git",

package/src/index.ts

@@ -9,4 +9,5 @@ export * from './types/shopify.types.js';
 
 export * from './utils/profile.js';
 export * from './utils/utils.js';
-export * from './utils/company.js';
+export * from './utils/company.js';
+export * from './utils/feed-templates/index.js';

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

@@ -0,0 +1,7 @@
+import { XmlFeedFormat } from '../../constants/profile.constants';
+import { XmlFeedTemplateType } from '../../types/profile.types';
+
+export const customFeedTemplate: XmlFeedTemplateType = {
+    formats: [XmlFeedFormat.CSV, XmlFeedFormat.XMLS, XmlFeedFormat.TSV, XmlFeedFormat.XML],
+    mapping: [],
+};

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

@@ -0,0 +1,404 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* eslint-disable quotes */
+import * as z from 'zod';
+import { ulid } from 'ulid';
+import { validate, validateIfNoMacro } from '.';
+import { XmlFeedTemplateType } from '../../types/profile.types';
+import { XmlFeedFormat } from '../../constants/profile.constants';
+
+/* eslint-disable max-len */
+const availabilityMapping = {
+    attribute: 'availability',
+    label: 'Availability',
+    description:
+        "The current availability of the item. Supported values: in stock, out of stock. Out of stock items don't appear in ads, which prevents advertising items that aren't available. They do still appear in shops on Facebook and Instagram, but are marked as sold out",
+    required: true,
+    type: 'macro-input' as any,
+    validator: (v: string | number) => validate(v, z.enum(['in stock', 'out of stock']), false),
+};
+
+const conditionMapping = {
+    attribute: 'condition',
+    label: 'Condition',
+    description: 'The condition of the item. Supported values: new, refurbished, used',
+    required: true,
+    type: 'macro-input' as any,
+    validator: (v: string | number) => validate(v, z.enum(['new', 'refurbished', 'used'])),
+};
+
+const videoMapping = {
+    attribute: 'video[0].url',
+    label: 'Video URL 1',
+    description:
+        'Up to 20 fields each containing a link to a product video. video[0].url will be your default video and a 4:5 aspect ratio is recommended. To add multiple videos per product, such as alternative 1:1 or 9:16 aspect ratios, add additional video fields',
+    required: false,
+    type: 'macro-input' as any,
+    defaultValue: '',
+    rules: { sections: [] },
+    validator: (v: string | number) => validateIfNoMacro(v, z.string().url()),
+};
+
+const customLabelMapping = {
+    attribute: 'custom_label_0',
+    label: 'Custom Label 1',
+    description:
+        'Up to five custom fields. Use these fields to create custom labels for your items. For example, you can use custom labels to filter your products in your Facebook catalog. Supported values: 0-100 characters',
+    required: false,
+    type: 'macro-input' as any,
+    defaultValue: '',
+    rules: { sections: [] },
+    validator: (v: string | number) => validate(v, z.string().max(100)),
+};
+
+const customNumberMapping = {
+    attribute: '',
+    label: '',
+    description:
+        'Up to five custom fields for any additional number-related information you want to filter items by when you create product sets. These fields allow you to filter by number ranges (is greater than and is less than) when you create a set. For example, you could use a custom number field to indicate the year each item was produced, and then filter a certain year range into a set. Supported whole number from 0 to 4294967295',
+    required: false,
+    type: 'macro-input' as any,
+    defaultValue: '',
+    rules: { sections: [] },
+    validator: (v: string | number) =>
+        validateIfNoMacro(
+            v,
+            z.string().refine(v => Number(v) >= 0 && Number(v) <= 4294967295 && Number.isInteger(Number(v)), {
+                message: 'Must be a whole number from 0 to 4294967295',
+            })
+        ),
+};
+
+export const facebookFeedTemplate: XmlFeedTemplateType = {
+    formats: [XmlFeedFormat.CSV, XmlFeedFormat.XMLS, XmlFeedFormat.TSV, XmlFeedFormat.XML],
+    documentation: 'https://www.facebook.com/business/help/120325381656392',
+    mapping: [
+        {
+            attribute: 'id',
+            label: 'ID',
+            description:
+                "A unique content ID for the item. Use the item's stock keeping unit (SKU) number if possible. Each content ID must appear only once in your catalog. If you use the same content ID for multiple items, none of them will be uploaded. Character limit: 100",
+            required: true,
+            type: 'macro-input',
+            validator: v => validate(v, z.string().max(100), false),
+            defaultValue: '{{shopify.sku}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'title',
+            label: 'Title',
+            description:
+                'A specific, relevant title for the item, written in title case. Character limit: 200, but we recommend 65 maximum to avoid longer titles being cut off',
+            required: true,
+            type: 'macro-input',
+            validator: (v: string | number) => validate(v, z.string().max(200), false),
+            defaultValue: '{{shopify.title}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'description',
+            label: 'Description',
+            description:
+                "A detailed description of the item. Include specific and unique product features like material or color. Use plain text only (to use HTML, see rich_text description) and don't enter text in all capital letters. The description should be different from the title. We recommend not including any links. See product description specifications. Character limit: 9,999",
+            required: true,
+            type: 'macro-input',
+            validator: (v: string | number) => validate(v, z.string().max(9999), false),
+            defaultValue: '{{shopify.description}}',
+            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',
+                            },
+                        ],
+                    },
+                ],
+            },
+        },
+        {
+            ...conditionMapping,
+            defaultValue: 'new',
+            rules: {
+                sections: [],
+            },
+        },
+        {
+            attribute: 'price',
+            label: 'Price',
+            description:
+                "The price of the item. Format the price as a number, followed by a space and then the 3-letter ISO 4217 currency code. Always use a period (.) as the decimal point, not a comma (,). Don't include currency symbols such as $, € or £. Only use one currency in your feed. To add prices in other currencies for selling in different countries, upload a country feed.",
+            required: true,
+            type: 'macro-input',
+            defaultValue: '{{shopify.price}} {{shopify.shop_currency}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'link',
+            label: 'Link',
+            description:
+                "The link to the item's specific product page on your business's website where people can learn more about or buy the item. Links must begin with http:// or https://, be valid and be hosted on your business’s website domain",
+            required: true,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().url()),
+            defaultValue: '{{shopify.shop_domain}}/products/{{shopify.handle}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'image_link',
+            label: 'Image link',
+            description:
+                'The URL for the main image of your item. Images must be in JPEG or PNG format, at least 500 x 500 pixels and up to 8 MB',
+            required: true,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.string().url()),
+            defaultValue: '{{shopify.image}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'brand',
+            label: 'Brand',
+            description: 'The brand name of the item. Character limit: 100',
+            required: true,
+            type: 'macro-input',
+            validator: (v: string | number) => validate(v, z.string().max(100), false),
+            defaultValue: '{{shopify.vendor}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'quantity_to_sell_on_facebook',
+            label: 'Quantity to sell on Facebook',
+            description:
+                "Checkout on Facebook and Instagram (US only). The quantity of this item that you have available to sell. Enter a whole number. To prevent overselling, an item's quantity is automatically reduced each time a purchase order is confirmed through checkout. When the quantity reaches 0, the item is marked as sold out in your shop on Facebook and Instagram. After 56 days, out of stock items stop appearing in your shop",
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validateIfNoMacro(v, z.number().min(0)),
+            defaultValue: '{{shopify.inventory_quantity}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'size',
+            label: 'Size',
+            description:
+                'Required for items in specific product categories including clothing and shoes. The size of the item written as a word, abbreviation or number, such as "Small", "XL", "12" or "One size". Include a space between words and numbers (such as "US 12" or "15 months" instead of "US12" or "15months") and don\'t include the word "size" if not necessary (such as "XS" instead of "Size XS"). Character limit: 200',
+            required: false,
+            type: 'macro-input',
+            validator: (v: string | number) => validate(v, z.string().max(200)),
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'sale_price',
+            label: 'Sale price',
+            description:
+                'If the item is on sale, enter its discounted price. Use the same formatting as the price field',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'sale_price_effective_date',
+            label: 'Sale price effective date',
+            description:
+                "The date, time and time zone when your sale starts and ends. If you don't add this field, any items with a sale_price remain on sale until you remove their sale price. Use this format: YYYY-MM-DDT23:59+00:00/YYYY-MM-DDT23:59+00:00",
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'item_group_id',
+            label: 'Item group ID',
+            description:
+                "Allows you to set up variants of the same product, such as different sizes, colors or patterns. Enter the same group ID in this field for all variants of the same product to indicate they're part of a group",
+            required: false,
+            type: 'macro-input',
+            defaultValue: '{{shopify.id}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'status',
+            label: 'Status',
+            description:
+                'Controls whether the item is active or archived in your catalog. Only active items can be seen by people in your ads, shops or any other channels. Supported values: active, archived. Items are active by default',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '{{shopify.status}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'additional_image_link',
+            label: 'Additional image link',
+            description:
+                'Links to up to 20 additional images of your item, separated by a comma (,), semicolon (;), space ( ) or vertical bar (|). Follow the same image specifications as image_link',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '{{shopify.images}}',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'gtin',
+            label: 'GTIN',
+            description:
+                'The item’s Global Trade Item Number (GTIN). Providing a GTIN is highly recommended to help classify the item. The GTIN may appear on the barcode, packaging or book cover. Not all items have a GTIN. Only provide one if you’re sure it’s correct. Don’t include dashes or spaces',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'mpn',
+            label: 'MPN',
+            description:
+                'The item’s manufacturer part number (MPN), a unique alphanumeric code assigned by the manufacturer in some industries to identify a specific item or part. It may appear on the packaging, label or etched directly onto the item. Providing a MPN is recommended to help classify the item if there is no GTIN. Not all items have a MPN. Only provide one if you’re sure it’s correct. Character limit: 100',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            validator: (v: string | number) => validate(v, z.string()),
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'google_product_category',
+            label: 'Google product category',
+            description:
+                'The category of the item according to the Google product taxonomy. Example: Apparel & Accessories > Clothing > Shirts & Tops or 212',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'fb_product_category',
+            label: 'Facebook product category',
+            description:
+                "The category of the item according to Facebook's product taxonomy. Example: Clothing & Accessories > Clothing > Women's Clothing > Tops & T-Shirts or 430",
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'color',
+            label: 'Color',
+            description:
+                'The main color of the item. Describe the color in words, not a hex code. Character limit: 200',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            validator: (v: string | number) => validate(v, z.string()),
+        },
+        {
+            attribute: 'gender',
+            label: 'Gender',
+            description: 'The gender your item is targeted towards. Supported values: female, male, unisex',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            validator: v => validate(v, z.enum(['female', 'male', 'unisex'])),
+        },
+        {
+            attribute: 'age_group',
+            label: 'Age group',
+            description:
+                'The age group that the item is targeted towards. Supported values: adult, all ages, teen, kids, toddler, infant, newborn',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            validator: v => validate(v, z.enum(['adult', 'all ages', 'teen', 'kids', 'toddler', 'infant', 'newborn'])),
+        },
+        {
+            attribute: 'material',
+            label: 'Material',
+            description:
+                'The material the item is made from, such as cotton, polyester, denim or leather. Character limit: 200',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            validator: (v: string | number) => validate(v, z.string()),
+        },
+        {
+            attribute: 'pattern',
+            label: 'Pattern',
+            description: 'The pattern or graphic print on the item. Character limit: 100',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+            validator: (v: string | number) => validate(v, z.string().max(100)),
+        },
+        {
+            attribute: 'rich_text_description',
+            label: 'Rich text description',
+            description:
+                'A description of the item containing rich text (HTML) formatting such as bullet points or multiple paragraphs. We recommend using rich text if the description is longer than 200 characters to help make it easier to read. If this field is provided, it will display instead of the description field wherever possible, but you must still provide description as a backup option. Character limit: 9,999',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '{{shopify.description_html}}',
+            rules: { sections: [] },
+            validator: (v: string | number) => validate(v, z.string()),
+        },
+        ...[0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19].map(i => ({
+            ...videoMapping,
+            attribute: `video[${i}].url`,
+            label: `Video URL ${i + 1}`,
+        })),
+        {
+            attribute: 'shipping',
+            label: 'Shipping',
+            description:
+                'This field enables you to add the "free shipping" overlay in Advantage+ catalog ads. Enter shipping details for the item formatted as Country:Region:Service:Price Example: US:NY:Ground:9.99 USD, PH::Air:300 PHP',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '',
+            rules: { sections: [] },
+        },
+        {
+            attribute: 'shipping_weight',
+            label: 'Shipping weight',
+            description: 'The shipping weight of the item in lb, oz, g or kg. Example: 0.3 kg',
+            required: false,
+            type: 'macro-input',
+            defaultValue: '{{shopify.weight}} {{shopify.weight_unit}}',
+            rules: { sections: [] },
+        },
+        ...[0, 1, 2, 3, 4].map(i => ({
+            ...customLabelMapping,
+            attribute: `custom_label_${i}`,
+            label: `Custom Label ${i + 1}`,
+        })),
+        ...[0, 1, 2, 3, 4].map(i => ({
+            ...customNumberMapping,
+            attribute: `custom_number_${i}`,
+            label: `Custom Number ${i + 1}`,
+        })),
+    ],
+};

package/src/utils/feed-templates/index.ts

@@ -0,0 +1,46 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+import { SafeParseReturnType, ZodType } from 'zod';
+import { XMLFeedType } from '../../constants/profile.constants';
+import { customFeedTemplate } from './custom.template';
+import { facebookFeedTemplate } from './fecebook.template';
+import { XmlFeedTemplateType } from '../../types/profile.types';
+
+export const hasMacro = (v: string) => /{{[^}]+}}/.test(v);
+export const removeMacro = (v: string) => v.replaceAll(/{{[^}]+}}/g, '');
+
+export function validate(
+    value: string | number,
+    validator: ZodType<any, any>,
+    skipEmpty = true
+): SafeParseReturnType<any, any> {
+    let valueToValidate = value;
+
+    if (typeof value === 'string') {
+        valueToValidate = removeMacro(value);
+    }
+
+    if (!value && skipEmpty) {
+        return { success: true, data: value };
+    }
+
+    return validator.safeParse(valueToValidate);
+}
+
+export function validateIfNoMacro(value: string | number, validator: ZodType<any, any>): SafeParseReturnType<any, any> {
+    if (typeof value === 'string' && hasMacro(value)) {
+        return { success: true, data: value };
+    }
+
+    return validator.safeParse(value);
+}
+
+export function getTemplate(type: XMLFeedType): XmlFeedTemplateType {
+    switch (type) {
+        case XMLFeedType.Custom:
+            return customFeedTemplate;
+        case XMLFeedType.Facebook:
+            return facebookFeedTemplate;
+        default:
+            throw new Error(`Invalid feed type: ${type}`);
+    }
+}