@adtrackify/at-tracking-event-types 4.64.13 → 4.65.0

package/dist/esm/__tests__/cm4-measure-definitions.spec.js

@@ -1,183 +1,183 @@
-import { MEASURE } from '../types/api/measures/measures';
-import { MEASURES_MAP } from '../types/api/measures/definitions/measure-definitions';
-import { MEASURE_CATEGORY } from '../types/api/measures/measure-categories';
-import { MeasureValueType } from '../types/api/measures/measure-value-type';
-describe('CM4 Measure Definitions', () => {
-    describe('CM4 ROAS measures exist in MEASURE enum', () => {
-        it('should have ORDERS_CM4_ROAS defined', () => {
-            expect(MEASURE.ORDERS_CM4_ROAS).toBe('orders.cm4_roas');
-        });
-        it('should have ORDERS_NEW_CUSTOMER_CM4_ROAS defined', () => {
-            expect(MEASURE.ORDERS_NEW_CUSTOMER_CM4_ROAS).toBe('orders.new_customer_cm4_roas');
-        });
-        it('should have ORDERS_RETURNING_CUSTOMER_CM4_ROAS defined', () => {
-            expect(MEASURE.ORDERS_RETURNING_CUSTOMER_CM4_ROAS).toBe('orders.returning_customer_cm4_roas');
-        });
-    });
-    describe('CM4 MER measures exist in MEASURE enum', () => {
-        it('should have ORDERS_CM4_MER defined', () => {
-            expect(MEASURE.ORDERS_CM4_MER).toBe('orders.cm4_mer');
-        });
-        it('should have ORDERS_NEW_CUSTOMER_CM4_MER defined', () => {
-            expect(MEASURE.ORDERS_NEW_CUSTOMER_CM4_MER).toBe('orders.new_customer_cm4_mer');
-        });
-        it('should have ORDERS_RETURNING_CUSTOMER_CM4_MER defined', () => {
-            expect(MEASURE.ORDERS_RETURNING_CUSTOMER_CM4_MER).toBe('orders.returning_customer_cm4_mer');
-        });
-    });
-    describe('CM4 ROAS measure definitions', () => {
-        it('ORDERS_CM4_ROAS should have correct metadata', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_CM4_ROAS];
-            expect(def).toBeDefined();
-            expect(def.title).toBe('CM4 ROAS');
-            expect(def.shortTitle).toBe('CM4 ROAS');
-            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_AD_PERFORMANCE);
-            expect(def.valueType).toBe(MeasureValueType.MULTIPLIER);
-            expect(def.sumSuffix).toBe('x');
-            expect(def.avgSuffix).toBe('x');
-        });
-        it('ORDERS_NEW_CUSTOMER_CM4_ROAS should have correct metadata', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_NEW_CUSTOMER_CM4_ROAS];
-            expect(def).toBeDefined();
-            expect(def.title).toBe('New Customer CM4 ROAS');
-            expect(def.shortTitle).toBe('NC CM4 ROAS');
-            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_AD_PERFORMANCE);
-            expect(def.valueType).toBe(MeasureValueType.MULTIPLIER);
-        });
-        it('ORDERS_RETURNING_CUSTOMER_CM4_ROAS should have correct metadata', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_RETURNING_CUSTOMER_CM4_ROAS];
-            expect(def).toBeDefined();
-            expect(def.title).toBe('Returning Customer CM4 ROAS');
-            expect(def.shortTitle).toBe('RC CM4 ROAS');
-            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_AD_PERFORMANCE);
-            expect(def.valueType).toBe(MeasureValueType.MULTIPLIER);
-        });
-        it('CM4 ROAS tooltips should mention operating profit', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_CM4_ROAS];
-            expect(def.tooltip).toContain('operating profit');
-        });
-        it('CM4 ROAS formula should be cm4 / spend', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_CM4_ROAS];
-            expect(def.formula).toBe('cm4 / spend');
-            expect(def.formulaDisplay).toBe('CM4 ÷ Total Ad Spend');
-        });
-    });
-    describe('CM4 MER measure definitions', () => {
-        it('ORDERS_CM4_MER should have correct metadata', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_CM4_MER];
-            expect(def).toBeDefined();
-            expect(def.title).toBe('CM4 MER');
-            expect(def.shortTitle).toBe('CM4 MER');
-            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_AD_PERFORMANCE);
-            expect(def.valueType).toBe(MeasureValueType.PERCENTAGE);
-            expect(def.sumSuffix).toBe('%');
-            expect(def.avgSuffix).toBe('%');
-        });
-        it('ORDERS_NEW_CUSTOMER_CM4_MER should have correct metadata', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_NEW_CUSTOMER_CM4_MER];
-            expect(def).toBeDefined();
-            expect(def.title).toBe('New Customer CM4 MER');
-            expect(def.shortTitle).toBe('NC CM4 MER');
-            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_AD_PERFORMANCE);
-            expect(def.valueType).toBe(MeasureValueType.PERCENTAGE);
-        });
-        it('ORDERS_RETURNING_CUSTOMER_CM4_MER should have correct metadata', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_RETURNING_CUSTOMER_CM4_MER];
-            expect(def).toBeDefined();
-            expect(def.title).toBe('Returning Customer CM4 MER');
-            expect(def.shortTitle).toBe('RC CM4 MER');
-            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_AD_PERFORMANCE);
-            expect(def.valueType).toBe(MeasureValueType.PERCENTAGE);
-        });
-        it('CM4 MER tooltips should mention operating profit', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_CM4_MER];
-            expect(def.tooltip?.toLowerCase()).toContain('operating profit');
-        });
-        it('CM4 MER formula should be (cm4 / spend) * 100', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_CM4_MER];
-            expect(def.formula).toBe('(cm4 / spend) * 100');
-            expect(def.formulaDisplay).toBe('(CM4 ÷ Total Ad Spend) × 100');
-        });
-    });
-    describe('CM4 base measures have correct category', () => {
-        it('ORDERS_CM4_PERCENT should be in ORDERS_CONTRIBUTION_MARGIN category', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_CM4_PERCENT];
-            expect(def).toBeDefined();
-            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_CONTRIBUTION_MARGIN);
-        });
-        it('ORDERS_NEW_CUSTOMER_CM4_PERCENT should be in ORDERS_CONTRIBUTION_MARGIN category', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_NEW_CUSTOMER_CM4_PERCENT];
-            expect(def).toBeDefined();
-            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_CONTRIBUTION_MARGIN);
-        });
-        it('ORDERS_RETURNING_CUSTOMER_CM4_PERCENT should be in ORDERS_CONTRIBUTION_MARGIN category', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_RETURNING_CUSTOMER_CM4_PERCENT];
-            expect(def).toBeDefined();
-            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_CONTRIBUTION_MARGIN);
-        });
-    });
-    describe('CM3 tooltip correctness (should NOT say "all costs")', () => {
-        it('CM3 ROAS tooltip should mention "marketing and ad spend", not "all costs"', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_CM3_ROAS];
-            expect(def).toBeDefined();
-            expect(def.tooltip).not.toContain('all costs');
-            expect(def.tooltip).toContain('marketing and ad spend');
-        });
-        it('CM3 MER tooltip should mention "marketing and ad spend", not "all costs"', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_CM3_MER];
-            expect(def).toBeDefined();
-            expect(def.tooltip).not.toContain('all costs');
-            expect(def.tooltip).toContain('marketing and ad spend');
-        });
-        it('NC CM3 ROAS tooltip should mention "marketing and ad spend", not "all costs"', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_NEW_CUSTOMER_CM3_ROAS];
-            expect(def).toBeDefined();
-            expect(def.tooltip).not.toContain('all costs');
-            expect(def.tooltip).toContain('marketing and ad spend');
-        });
-        it('RC CM3 ROAS tooltip should mention "marketing and ad spend", not "all costs"', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_RETURNING_CUSTOMER_CM3_ROAS];
-            expect(def).toBeDefined();
-            expect(def.tooltip).not.toContain('all costs');
-            expect(def.tooltip).toContain('marketing and ad spend');
-        });
-    });
-    describe('CM Per-Order measures have shortTitle', () => {
-        it('CM2 per-order should have shortTitle with tip', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_CM2_PER_ORDER];
-            expect(def).toBeDefined();
-            expect(def.shortTitle).toBeDefined();
-            expect(def.shortTitle).toBe('CM2/Order (After Fulfillment)');
-        });
-        it('CM3 per-order should have shortTitle with tip', () => {
-            const def = MEASURES_MAP[MEASURE.ORDERS_CM3_PER_ORDER];
-            expect(def).toBeDefined();
-            expect(def.shortTitle).toBeDefined();
-            expect(def.shortTitle).toBe('CM3/Order (Contribution Margin)');
-        });
-    });
-    describe('Variable costs measures have unique priorities', () => {
-        it('ORDERS_VARIABLE_COSTS priority should not collide with PR8 cost columns', () => {
-            const variableCostsDef = MEASURES_MAP[MEASURE.ORDERS_VARIABLE_COSTS];
-            const otherCogsDef = MEASURES_MAP[MEASURE.ORDERS_OTHER_COGS];
-            expect(variableCostsDef).toBeDefined();
-            expect(otherCogsDef).toBeDefined();
-            expect(variableCostsDef.priority).not.toBe(otherCogsDef.priority);
-        });
-        it('ORDERS_VARIABLE_COSTS_PER_ORDER priority should not collide with ORDERS_TOTAL_COGS', () => {
-            const variableCostsPerOrderDef = MEASURES_MAP[MEASURE.ORDERS_VARIABLE_COSTS_PER_ORDER];
-            const totalCogsDef = MEASURES_MAP[MEASURE.ORDERS_TOTAL_COGS];
-            expect(variableCostsPerOrderDef).toBeDefined();
-            expect(totalCogsDef).toBeDefined();
-            expect(variableCostsPerOrderDef.priority).not.toBe(totalCogsDef.priority);
-        });
-        it('ORDERS_VARIABLE_COSTS_PERCENT priority should not collide with ORDERS_OTHER_FULFILLMENT_COST', () => {
-            const variableCostsPercentDef = MEASURES_MAP[MEASURE.ORDERS_VARIABLE_COSTS_PERCENT];
-            const otherFulfillmentDef = MEASURES_MAP[MEASURE.ORDERS_OTHER_FULFILLMENT_COST];
-            expect(variableCostsPercentDef).toBeDefined();
-            expect(otherFulfillmentDef).toBeDefined();
-            expect(variableCostsPercentDef.priority).not.toBe(otherFulfillmentDef.priority);
-        });
-    });
-});
+import { MEASURE } from '../types/api/measures/measures';
+import { MEASURES_MAP } from '../types/api/measures/definitions/measure-definitions';
+import { MEASURE_CATEGORY } from '../types/api/measures/measure-categories';
+import { MeasureValueType } from '../types/api/measures/measure-value-type';
+describe('CM4 Measure Definitions', () => {
+    describe('CM4 ROAS measures exist in MEASURE enum', () => {
+        it('should have ORDERS_CM4_ROAS defined', () => {
+            expect(MEASURE.ORDERS_CM4_ROAS).toBe('orders.cm4_roas');
+        });
+        it('should have ORDERS_NEW_CUSTOMER_CM4_ROAS defined', () => {
+            expect(MEASURE.ORDERS_NEW_CUSTOMER_CM4_ROAS).toBe('orders.new_customer_cm4_roas');
+        });
+        it('should have ORDERS_RETURNING_CUSTOMER_CM4_ROAS defined', () => {
+            expect(MEASURE.ORDERS_RETURNING_CUSTOMER_CM4_ROAS).toBe('orders.returning_customer_cm4_roas');
+        });
+    });
+    describe('CM4 MER measures exist in MEASURE enum', () => {
+        it('should have ORDERS_CM4_MER defined', () => {
+            expect(MEASURE.ORDERS_CM4_MER).toBe('orders.cm4_mer');
+        });
+        it('should have ORDERS_NEW_CUSTOMER_CM4_MER defined', () => {
+            expect(MEASURE.ORDERS_NEW_CUSTOMER_CM4_MER).toBe('orders.new_customer_cm4_mer');
+        });
+        it('should have ORDERS_RETURNING_CUSTOMER_CM4_MER defined', () => {
+            expect(MEASURE.ORDERS_RETURNING_CUSTOMER_CM4_MER).toBe('orders.returning_customer_cm4_mer');
+        });
+    });
+    describe('CM4 ROAS measure definitions', () => {
+        it('ORDERS_CM4_ROAS should have correct metadata', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_CM4_ROAS];
+            expect(def).toBeDefined();
+            expect(def.title).toBe('CM4 ROAS');
+            expect(def.shortTitle).toBe('CM4 ROAS');
+            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_AD_PERFORMANCE);
+            expect(def.valueType).toBe(MeasureValueType.MULTIPLIER);
+            expect(def.sumSuffix).toBe('x');
+            expect(def.avgSuffix).toBe('x');
+        });
+        it('ORDERS_NEW_CUSTOMER_CM4_ROAS should have correct metadata', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_NEW_CUSTOMER_CM4_ROAS];
+            expect(def).toBeDefined();
+            expect(def.title).toBe('New Customer CM4 ROAS');
+            expect(def.shortTitle).toBe('NC CM4 ROAS');
+            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_AD_PERFORMANCE);
+            expect(def.valueType).toBe(MeasureValueType.MULTIPLIER);
+        });
+        it('ORDERS_RETURNING_CUSTOMER_CM4_ROAS should have correct metadata', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_RETURNING_CUSTOMER_CM4_ROAS];
+            expect(def).toBeDefined();
+            expect(def.title).toBe('Returning Customer CM4 ROAS');
+            expect(def.shortTitle).toBe('RC CM4 ROAS');
+            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_AD_PERFORMANCE);
+            expect(def.valueType).toBe(MeasureValueType.MULTIPLIER);
+        });
+        it('CM4 ROAS tooltips should mention operating profit', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_CM4_ROAS];
+            expect(def.tooltip).toContain('operating profit');
+        });
+        it('CM4 ROAS formula should be cm4 / spend', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_CM4_ROAS];
+            expect(def.formula).toBe('cm4 / spend');
+            expect(def.formulaDisplay).toBe('CM4 ÷ Total Ad Spend');
+        });
+    });
+    describe('CM4 MER measure definitions', () => {
+        it('ORDERS_CM4_MER should have correct metadata', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_CM4_MER];
+            expect(def).toBeDefined();
+            expect(def.title).toBe('CM4 MER');
+            expect(def.shortTitle).toBe('CM4 MER');
+            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_AD_PERFORMANCE);
+            expect(def.valueType).toBe(MeasureValueType.PERCENTAGE);
+            expect(def.sumSuffix).toBe('%');
+            expect(def.avgSuffix).toBe('%');
+        });
+        it('ORDERS_NEW_CUSTOMER_CM4_MER should have correct metadata', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_NEW_CUSTOMER_CM4_MER];
+            expect(def).toBeDefined();
+            expect(def.title).toBe('New Customer CM4 MER');
+            expect(def.shortTitle).toBe('NC CM4 MER');
+            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_AD_PERFORMANCE);
+            expect(def.valueType).toBe(MeasureValueType.PERCENTAGE);
+        });
+        it('ORDERS_RETURNING_CUSTOMER_CM4_MER should have correct metadata', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_RETURNING_CUSTOMER_CM4_MER];
+            expect(def).toBeDefined();
+            expect(def.title).toBe('Returning Customer CM4 MER');
+            expect(def.shortTitle).toBe('RC CM4 MER');
+            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_AD_PERFORMANCE);
+            expect(def.valueType).toBe(MeasureValueType.PERCENTAGE);
+        });
+        it('CM4 MER tooltips should mention operating profit', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_CM4_MER];
+            expect(def.tooltip?.toLowerCase()).toContain('operating profit');
+        });
+        it('CM4 MER formula should be (cm4 / spend) * 100', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_CM4_MER];
+            expect(def.formula).toBe('(cm4 / spend) * 100');
+            expect(def.formulaDisplay).toBe('(CM4 ÷ Total Ad Spend) × 100');
+        });
+    });
+    describe('CM4 base measures have correct category', () => {
+        it('ORDERS_CM4_PERCENT should be in ORDERS_CONTRIBUTION_MARGIN category', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_CM4_PERCENT];
+            expect(def).toBeDefined();
+            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_CONTRIBUTION_MARGIN);
+        });
+        it('ORDERS_NEW_CUSTOMER_CM4_PERCENT should be in ORDERS_CONTRIBUTION_MARGIN category', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_NEW_CUSTOMER_CM4_PERCENT];
+            expect(def).toBeDefined();
+            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_CONTRIBUTION_MARGIN);
+        });
+        it('ORDERS_RETURNING_CUSTOMER_CM4_PERCENT should be in ORDERS_CONTRIBUTION_MARGIN category', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_RETURNING_CUSTOMER_CM4_PERCENT];
+            expect(def).toBeDefined();
+            expect(def.category).toBe(MEASURE_CATEGORY.ORDERS_CONTRIBUTION_MARGIN);
+        });
+    });
+    describe('CM3 tooltip correctness (should NOT say "all costs")', () => {
+        it('CM3 ROAS tooltip should mention "marketing and ad spend", not "all costs"', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_CM3_ROAS];
+            expect(def).toBeDefined();
+            expect(def.tooltip).not.toContain('all costs');
+            expect(def.tooltip).toContain('marketing and ad spend');
+        });
+        it('CM3 MER tooltip should mention "marketing and ad spend", not "all costs"', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_CM3_MER];
+            expect(def).toBeDefined();
+            expect(def.tooltip).not.toContain('all costs');
+            expect(def.tooltip).toContain('marketing and ad spend');
+        });
+        it('NC CM3 ROAS tooltip should mention "marketing and ad spend", not "all costs"', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_NEW_CUSTOMER_CM3_ROAS];
+            expect(def).toBeDefined();
+            expect(def.tooltip).not.toContain('all costs');
+            expect(def.tooltip).toContain('marketing and ad spend');
+        });
+        it('RC CM3 ROAS tooltip should mention "marketing and ad spend", not "all costs"', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_RETURNING_CUSTOMER_CM3_ROAS];
+            expect(def).toBeDefined();
+            expect(def.tooltip).not.toContain('all costs');
+            expect(def.tooltip).toContain('marketing and ad spend');
+        });
+    });
+    describe('CM Per-Order measures have shortTitle', () => {
+        it('CM2 per-order should have shortTitle with tip', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_CM2_PER_ORDER];
+            expect(def).toBeDefined();
+            expect(def.shortTitle).toBeDefined();
+            expect(def.shortTitle).toBe('CM2/Order (After Fulfillment)');
+        });
+        it('CM3 per-order should have shortTitle with tip', () => {
+            const def = MEASURES_MAP[MEASURE.ORDERS_CM3_PER_ORDER];
+            expect(def).toBeDefined();
+            expect(def.shortTitle).toBeDefined();
+            expect(def.shortTitle).toBe('CM3/Order (Contribution Margin)');
+        });
+    });
+    describe('Variable costs measures have unique priorities', () => {
+        it('ORDERS_VARIABLE_COSTS priority should not collide with PR8 cost columns', () => {
+            const variableCostsDef = MEASURES_MAP[MEASURE.ORDERS_VARIABLE_COSTS];
+            const otherCogsDef = MEASURES_MAP[MEASURE.ORDERS_OTHER_COGS];
+            expect(variableCostsDef).toBeDefined();
+            expect(otherCogsDef).toBeDefined();
+            expect(variableCostsDef.priority).not.toBe(otherCogsDef.priority);
+        });
+        it('ORDERS_VARIABLE_COSTS_PER_ORDER priority should not collide with ORDERS_TOTAL_COGS', () => {
+            const variableCostsPerOrderDef = MEASURES_MAP[MEASURE.ORDERS_VARIABLE_COSTS_PER_ORDER];
+            const totalCogsDef = MEASURES_MAP[MEASURE.ORDERS_TOTAL_COGS];
+            expect(variableCostsPerOrderDef).toBeDefined();
+            expect(totalCogsDef).toBeDefined();
+            expect(variableCostsPerOrderDef.priority).not.toBe(totalCogsDef.priority);
+        });
+        it('ORDERS_VARIABLE_COSTS_PERCENT priority should not collide with ORDERS_OTHER_FULFILLMENT_COST', () => {
+            const variableCostsPercentDef = MEASURES_MAP[MEASURE.ORDERS_VARIABLE_COSTS_PERCENT];
+            const otherFulfillmentDef = MEASURES_MAP[MEASURE.ORDERS_OTHER_FULFILLMENT_COST];
+            expect(variableCostsPercentDef).toBeDefined();
+            expect(otherFulfillmentDef).toBeDefined();
+            expect(variableCostsPercentDef.priority).not.toBe(otherFulfillmentDef.priority);
+        });
+    });
+});
 //# sourceMappingURL=cm4-measure-definitions.spec.js.map

package/dist/esm/__tests__/measure-alias-map.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};