@decocms/apps-commerce 7.2.0

package/src/utils/canonical.ts

@@ -0,0 +1,8 @@
+import type { BreadcrumbList } from "../types/commerce";
+
+export const canonicalFromBreadcrumblist = (b?: BreadcrumbList) => {
+	const items = b?.itemListElement ?? [];
+	if (!Array.isArray(items) || items.length === 0) return undefined;
+
+	return items.reduce((acc, curr) => (acc.position < curr.position ? curr : acc)).item;
+};

package/src/utils/constants.ts

@@ -0,0 +1,8 @@
+import type { ImageObject } from "../types/commerce";
+
+export const DEFAULT_IMAGE: ImageObject = {
+	"@type": "ImageObject",
+	encodingFormat: "image",
+	alternateName: "Default Image Placeholder",
+	url: "https://ozksgdmyrqcxcwhnbepg.supabase.co/storage/v1/object/public/assets/1818/ff6bb37e-0eab-40e1-a454-86856efc278e",
+};

package/src/utils/filters.test.ts

@@ -0,0 +1,34 @@
+import { describe, expect, it } from "vitest";
+import { formatRange, parseRange } from "./filters";
+
+describe("parseRange", () => {
+	it("parses valid range", () => {
+		expect(parseRange("10:50")).toEqual({ from: 10, to: 50 });
+	});
+
+	it("parses decimal range", () => {
+		expect(parseRange("34.90:56.90")).toEqual({ from: 34.9, to: 56.9 });
+	});
+
+	it("returns null for invalid range", () => {
+		expect(parseRange("abc:def")).toBeNull();
+	});
+
+	it("returns null for empty string", () => {
+		expect(parseRange("")).toBeNull();
+	});
+
+	it("returns null for single value", () => {
+		expect(parseRange("10")).toBeNull();
+	});
+});
+
+describe("formatRange", () => {
+	it("formats range correctly", () => {
+		expect(formatRange(10, 50)).toBe("10:50");
+	});
+
+	it("formats decimal range", () => {
+		expect(formatRange(34.9, 56.9)).toBe("34.9:56.9");
+	});
+});

package/src/utils/filters.ts

@@ -0,0 +1,10 @@
+export const parseRange = (price: string) => {
+	const splitted = price.split(":");
+
+	const from = Number(splitted?.[0]);
+	const to = Number(splitted?.[1]);
+
+	return Number.isNaN(from) || Number.isNaN(to) ? null : { from, to };
+};
+
+export const formatRange = (from: number, to: number) => `${from}:${to}`;

package/src/utils/productToAnalyticsItem.ts

@@ -0,0 +1,63 @@
+import type { AnalyticsItem, BreadcrumbList, Product } from "../types/commerce";
+
+export const mapCategoriesToAnalyticsCategories = (
+	categories: string[],
+): Record<`item_category${number | ""}`, string> => {
+	return categories.slice(0, 5).reduce(
+		(result, category, index) => {
+			result[`item_category${index === 0 ? "" : index + 1}`] = category;
+			return result;
+		},
+		{} as Record<`item_category${number | ""}`, string>,
+	);
+};
+
+export const mapProductCategoryToAnalyticsCategories = (category: string) => {
+	return category.split(">").reduce(
+		(result, category, index) => {
+			result[`item_category${index === 0 ? "" : index + 1}`] = category.trim();
+			return result;
+		},
+		{} as Record<`item_category${number | ""}`, string>,
+	);
+};
+
+export const mapProductToAnalyticsItem = ({
+	product,
+	breadcrumbList,
+	price,
+	listPrice,
+	index = 0,
+	quantity = 1,
+	coupon = "",
+}: {
+	product: Product;
+	breadcrumbList?: BreadcrumbList;
+	price?: number;
+	listPrice?: number;
+	index?: number;
+	quantity?: number;
+	coupon?: string;
+}): AnalyticsItem => {
+	const { name, productID, inProductGroupWithID, isVariantOf, url } = product;
+	const categories = breadcrumbList?.itemListElement
+		? mapCategoriesToAnalyticsCategories(
+				breadcrumbList?.itemListElement.map(({ name: _name }) => _name ?? "").filter(Boolean) ?? [],
+			)
+		: mapProductCategoryToAnalyticsCategories(product.category ?? "");
+
+	return {
+		item_id: productID,
+		item_group_id: inProductGroupWithID,
+		quantity,
+		coupon,
+		price,
+		index,
+		discount: Number((price && listPrice ? listPrice - price : 0).toFixed(2)),
+		item_name: isVariantOf?.name ?? name ?? "",
+		item_variant: name,
+		item_brand: product.brand?.name ?? "",
+		item_url: url,
+		...categories,
+	};
+};

package/src/utils/stateByZip.test.ts

@@ -0,0 +1,56 @@
+import { describe, expect, it } from "vitest";
+import getStateFromZip from "./stateByZip";
+
+describe("getStateFromZip", () => {
+	it("returns SP for São Paulo ZIP", () => {
+		expect(getStateFromZip("01001000")).toBe("SP");
+	});
+
+	it("returns RJ for Rio de Janeiro ZIP", () => {
+		expect(getStateFromZip("20000000")).toBe("RJ");
+	});
+
+	it("returns MG for Minas Gerais ZIP", () => {
+		expect(getStateFromZip("30000000")).toBe("MG");
+	});
+
+	it("returns RS for Rio Grande do Sul ZIP", () => {
+		expect(getStateFromZip("90000000")).toBe("RS");
+	});
+
+	it("strips non-numeric characters", () => {
+		expect(getStateFromZip("01001-000")).toBe("SP");
+		expect(getStateFromZip("01.001-000")).toBe("SP");
+	});
+
+	it("returns empty string for invalid ZIP", () => {
+		expect(getStateFromZip("00000000")).toBe("");
+		expect(getStateFromZip("")).toBe("");
+	});
+
+	it("handles boundary: AM upper range", () => {
+		expect(getStateFromZip("69299999")).toBe("AM");
+	});
+
+	it("handles boundary: RR range", () => {
+		expect(getStateFromZip("69300000")).toBe("RR");
+		expect(getStateFromZip("69399999")).toBe("RR");
+	});
+
+	it("handles boundary: AM second range", () => {
+		expect(getStateFromZip("69400000")).toBe("AM");
+	});
+
+	it("handles boundary: AC range", () => {
+		expect(getStateFromZip("69900000")).toBe("AC");
+		expect(getStateFromZip("69999999")).toBe("AC");
+	});
+
+	it("returns BA for Bahia ZIP", () => {
+		expect(getStateFromZip("40000000")).toBe("BA");
+	});
+
+	it("returns DF for Brasília ZIP", () => {
+		expect(getStateFromZip("70000000")).toBe("DF");
+	});
+});

package/src/utils/stateByZip.ts

@@ -0,0 +1,50 @@
+const getStateFromZip = (cep: string) => {
+	// Remove non-numeric characters
+	cep = cep.replace(/\D/g, "");
+
+	// zip range by: https://buscacepinter.correios.com.br/app/faixa_cep_uf_localidade/index.php
+	const zipRange = [
+		{ state: "AC", startRange: 69900000, endRange: 69999999 },
+		{ state: "AL", startRange: 57000000, endRange: 57999999 },
+		{ state: "AM", startRange: 69000000, endRange: 69299999 },
+		{ state: "AM", startRange: 69400000, endRange: 69899999 },
+		{ state: "AP", startRange: 68900000, endRange: 68999999 },
+		{ state: "BA", startRange: 40000000, endRange: 48999999 },
+		{ state: "CE", startRange: 60000000, endRange: 63999999 },
+		{ state: "DF", startRange: 70000000, endRange: 72799999 },
+		{ state: "DF", startRange: 73000000, endRange: 73699999 },
+		{ state: "ES", startRange: 29000000, endRange: 29999999 },
+		{ state: "GO", startRange: 72800000, endRange: 72999999 },
+		{ state: "GO", startRange: 73700000, endRange: 76799999 },
+		{ state: "MA", startRange: 65000000, endRange: 65999999 },
+		{ state: "MG", startRange: 30000000, endRange: 39999999 },
+		{ state: "MS", startRange: 79000000, endRange: 79999999 },
+		{ state: "MT", startRange: 78000000, endRange: 78899999 },
+		{ state: "PA", startRange: 66000000, endRange: 68899999 },
+		{ state: "PB", startRange: 58000000, endRange: 58999999 },
+		{ state: "PE", startRange: 50000000, endRange: 56999999 },
+		{ state: "PI", startRange: 64000000, endRange: 64999999 },
+		{ state: "PR", startRange: 80000000, endRange: 87999999 },
+		{ state: "RJ", startRange: 20000000, endRange: 28999999 },
+		{ state: "RN", startRange: 59000000, endRange: 59999999 },
+		{ state: "RO", startRange: 76800000, endRange: 76999999 },
+		{ state: "RR", startRange: 69300000, endRange: 69399999 },
+		{ state: "RS", startRange: 90000000, endRange: 99999999 },
+		{ state: "SC", startRange: 88000000, endRange: 89999999 },
+		{ state: "SE", startRange: 49000000, endRange: 49999999 },
+		{ state: "SP", startRange: 1000000, endRange: 19999999 },
+		{ state: "TO", startRange: 77000000, endRange: 77999999 },
+	];
+
+	const zipCode = parseInt(cep, 10);
+
+	for (const range of zipRange) {
+		if (zipCode >= range.startRange && zipCode <= range.endRange) {
+			return range.state;
+		}
+	}
+
+	return "";
+};
+
+export default getStateFromZip;

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist"
+  },
+  "include": ["src/**/*"]
+}