@adtrackify/at-tracking-event-types 4.17.3 → 4.17.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (17) hide show
  1. package/dist/cjs/types/api/measures/definitions/core-measure-definitions.js +101 -101
  2. package/dist/cjs/types/api/measures/definitions/core-measure-definitions.js.map +1 -1
  3. package/dist/cjs/types/api/measures/measures.d.ts +8 -8
  4. package/dist/cjs/types/api/measures/measures.js +8 -8
  5. package/dist/cjs/types/api/measures/measures.js.map +1 -1
  6. package/dist/cjs/types/costs/cost-types.d.ts +70 -75
  7. package/dist/cjs/types/costs/cost-types.js +25 -24
  8. package/dist/cjs/types/costs/cost-types.js.map +1 -1
  9. package/dist/esm/types/api/measures/definitions/core-measure-definitions.js +101 -101
  10. package/dist/esm/types/api/measures/definitions/core-measure-definitions.js.map +1 -1
  11. package/dist/esm/types/api/measures/measures.d.ts +8 -8
  12. package/dist/esm/types/api/measures/measures.js +8 -8
  13. package/dist/esm/types/api/measures/measures.js.map +1 -1
  14. package/dist/esm/types/costs/cost-types.d.ts +70 -75
  15. package/dist/esm/types/costs/cost-types.js +24 -23
  16. package/dist/esm/types/costs/cost-types.js.map +1 -1
  17. package/package.json +1 -1
package/dist/cjs/types/costs/cost-types.d.ts CHANGED
@@ -1,135 +1,130 @@
1
1
  export declare enum COST_TYPE {
2
2
  PRODUCT = "product",
3
- SHIPPING = "shipping",
4
3
  VARIABLE = "variable",
5
4
  FIXED = "fixed",
6
- DEFAULT_COGS = "default"
5
+ DEFAULT_COGS = "default_cogs",
6
+ SHIPPING_CONFIG = "shipping_config",
7
+ HANDLING = "handling",
8
+ GATEWAY = "gateway"
7
9
  }
8
10
  export declare enum COST_SUB_TYPE {
9
- FLAT = "flat",
10
- PERCENTAGE = "percentage"
11
+ PRODUCT_COST = "product_cost",
12
+ HANDLING_FEE = "handling_fee"
11
13
  }
12
14
  export declare enum COST_SOURCE {
13
- SHOPIFY = "shopify",
14
15
  MANUAL = "manual",
15
- USER = "user"
16
+ SHOPIFY = "shopify"
17
+ }
18
+ export declare enum COST_CHANNEL {
19
+ ONLINE = "online",
20
+ POS = "pos",
21
+ BOTH = "both"
22
+ }
23
+ export declare enum SHIPPING_METHOD {
24
+ SHOPIFY_CHARGES = "shopify_charges",
25
+ FIXED_RATE = "fixed_rate"
16
26
  }
17
27
  export declare enum VARIABLE_COST_TYPE {
18
28
  PER_ORDER = "per_order",
19
29
  PER_LINE_ITEM = "per_line_item",
30
+ PCT_TOTAL_SALES = "pct_total_sales",
31
+ PCT_GROSS_SALES = "pct_gross_sales",
32
+ PCT_NET_SALES = "pct_net_sales",
20
33
  PER_REFUND_ORDER = "per_refund_order",
21
34
  PER_REFUND_LINE_ITEM = "per_refund_line_item",
22
- PCT_SALES = "pct_sales",
23
- PCT_COGS = "pct_cogs",
24
- PCT_AD_SPEND = "pct_ad_spend",
25
- PCT_SHIPPING = "pct_shipping",
26
- PCT_GROSS_SALES = "pct_gross_sales",
27
- BY_WEIGHT = "by_weight",
28
- BY_QUANTITY = "by_quantity"
35
+ PCT_AD_SPEND = "pct_ad_spend"
29
36
  }
30
37
  export declare enum FIXED_COST_FREQUENCY {
31
38
  DAILY = "daily",
32
39
  WEEKLY = "weekly",
33
40
  MONTHLY = "monthly",
41
+ QUARTERLY = "quarterly",
34
42
  YEARLY = "yearly"
35
43
  }
36
44
  export declare enum VARIABLE_COST_CATEGORY {
37
- SHIPPING = "shipping",
38
- PAYMENT_FEES = "payment_fees",
39
- PACKAGING = "packaging",
40
- RETURNS = "returns",
41
45
  FULFILLMENT = "fulfillment",
46
+ TRANSACTION = "transaction",
47
+ MARKETING = "marketing",
42
48
  OTHER = "other"
43
49
  }
44
50
  export declare enum FIXED_COST_CATEGORY {
45
51
  RENT = "rent",
46
52
  SALARIES = "salaries",
47
53
  SOFTWARE = "software",
48
- UTILITIES = "utilities",
49
54
  INSURANCE = "insurance",
50
55
  OTHER = "other"
51
56
  }
52
- export declare enum COST_CHANNEL {
53
- ONLINE = "online",
54
- POS = "pos",
55
- BOTH = "both"
56
- }
57
- export interface VariableCostFilters {
58
- shippingTitleContains?: string;
59
- skipShopifyPayments?: boolean;
60
- paymentGateway?: string;
61
- countries?: string[];
62
- }
63
- export interface ProductCostHistoryRecord {
64
- id: string;
65
- isCurrent: boolean;
66
- costType: COST_TYPE;
67
- costSource: COST_SOURCE;
68
- price?: number;
69
- cost?: number;
70
- effectiveStartDate: string;
71
- effectiveEndDate: string | null;
72
- description: string;
73
- }
74
57
  export interface GenericCostRecord {
75
- pk: string;
76
- sk?: string;
77
- entityType: string;
78
- entityId: string;
79
- pixelId: string;
80
- shopifyAppInstallId: string;
58
+ id: string;
59
+ accountId: string;
81
60
  costType: COST_TYPE;
82
- costSubType: COST_SUB_TYPE;
83
- costSource: COST_SOURCE;
84
61
  createdAt: string;
85
62
  updatedAt: string;
86
63
  }
87
64
  export interface ProductCostRecord extends GenericCostRecord {
88
65
  entityType: 'product_cost';
89
66
  costType: COST_TYPE.PRODUCT;
90
- productId: string;
91
- variantId: string;
92
- sku: string;
93
- productTitle: string;
94
- variantTitle: string;
95
- imageUrls: string[];
96
- currentPrice?: number;
97
- currentCost?: number;
98
- currency: string;
99
- costHistory: ProductCostHistoryRecord[];
67
+ shopifyProductId: string;
68
+ shopifyVariantId?: string;
69
+ costSource: COST_SOURCE;
70
+ amount: number;
71
+ handlingFee?: number;
72
+ effectiveFrom: string;
73
+ effectiveTo?: string;
74
+ }
75
+ export interface DefaultCogsRecord extends GenericCostRecord {
76
+ entityType: 'default_cogs';
77
+ costType: COST_TYPE.DEFAULT_COGS;
78
+ percentage: number;
79
+ effectiveFrom: string;
80
+ effectiveTo?: string;
81
+ }
82
+ export interface HandlingFeeRecord extends GenericCostRecord {
83
+ entityType: 'handling_fee';
84
+ costType: COST_TYPE.HANDLING;
85
+ enabled: boolean;
86
+ amount: number;
87
+ effectiveFrom: string;
88
+ effectiveTo?: string;
89
+ }
90
+ export interface ShippingConfigRecord extends GenericCostRecord {
91
+ entityType: 'shipping_config';
92
+ costType: COST_TYPE.SHIPPING_CONFIG;
93
+ method: SHIPPING_METHOD;
94
+ amount?: number;
95
+ effectiveFrom: string;
96
+ effectiveTo?: string;
97
+ }
98
+ export interface PaymentGatewayRecord extends GenericCostRecord {
99
+ entityType: 'payment_gateway';
100
+ costType: COST_TYPE.GATEWAY;
101
+ name: string;
102
+ gatewayName: string;
103
+ flatFee: number;
104
+ percentFee: number;
105
+ effectiveFrom: string;
106
+ effectiveTo?: string;
100
107
  }
101
108
  export interface VariableCostRecord extends GenericCostRecord {
102
109
  entityType: 'variable_cost';
103
110
  costType: COST_TYPE.VARIABLE;
104
- costSource: COST_SOURCE.USER;
105
111
  name: string;
106
- variableType: VARIABLE_COST_TYPE;
107
- amount: number;
108
- channel: COST_CHANNEL;
112
+ variableCostType: VARIABLE_COST_TYPE;
109
113
  category: VARIABLE_COST_CATEGORY;
114
+ amount: number;
115
+ isAdSpend: boolean;
110
116
  effectiveFrom: string;
111
117
  effectiveTo?: string;
112
- filters?: VariableCostFilters;
113
118
  }
114
119
  export interface FixedCostRecord extends GenericCostRecord {
115
120
  entityType: 'fixed_cost';
116
121
  costType: COST_TYPE.FIXED;
117
- costSource: COST_SOURCE.USER;
118
122
  name: string;
119
- amount: number;
120
123
  frequency: FIXED_COST_FREQUENCY;
121
- channel: COST_CHANNEL;
122
124
  category: FIXED_COST_CATEGORY;
123
- effectiveFrom: string;
124
- effectiveTo?: string;
125
- }
126
- export interface DefaultCogsRecord extends GenericCostRecord {
127
- entityType: 'default_cogs';
128
- costType: COST_TYPE.DEFAULT_COGS;
129
- costSubType: COST_SUB_TYPE.PERCENTAGE;
130
- costSource: COST_SOURCE.USER;
131
125
  amount: number;
126
+ isAdSpend: boolean;
132
127
  effectiveFrom: string;
133
128
  effectiveTo?: string;
134
129
  }
135
- export declare type CostRecord = ProductCostRecord | VariableCostRecord | FixedCostRecord | DefaultCogsRecord;
130
+ export declare type CostRecord = ProductCostRecord | HandlingFeeRecord | DefaultCogsRecord | ShippingConfigRecord | PaymentGatewayRecord | VariableCostRecord | FixedCostRecord;
package/dist/cjs/types/costs/cost-types.js CHANGED
@@ -1,53 +1,61 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.COST_CHANNEL = exports.FIXED_COST_CATEGORY = exports.VARIABLE_COST_CATEGORY = exports.FIXED_COST_FREQUENCY = exports.VARIABLE_COST_TYPE = exports.COST_SOURCE = exports.COST_SUB_TYPE = exports.COST_TYPE = void 0;
3
+ exports.FIXED_COST_CATEGORY = exports.VARIABLE_COST_CATEGORY = exports.FIXED_COST_FREQUENCY = exports.VARIABLE_COST_TYPE = exports.SHIPPING_METHOD = exports.COST_CHANNEL = exports.COST_SOURCE = exports.COST_SUB_TYPE = exports.COST_TYPE = void 0;
4
4
  var COST_TYPE;
5
5
  (function (COST_TYPE) {
6
6
  COST_TYPE["PRODUCT"] = "product";
7
- COST_TYPE["SHIPPING"] = "shipping";
8
7
  COST_TYPE["VARIABLE"] = "variable";
9
8
  COST_TYPE["FIXED"] = "fixed";
10
- COST_TYPE["DEFAULT_COGS"] = "default";
9
+ COST_TYPE["DEFAULT_COGS"] = "default_cogs";
10
+ COST_TYPE["SHIPPING_CONFIG"] = "shipping_config";
11
+ COST_TYPE["HANDLING"] = "handling";
12
+ COST_TYPE["GATEWAY"] = "gateway";
11
13
  })(COST_TYPE = exports.COST_TYPE || (exports.COST_TYPE = {}));
12
14
  var COST_SUB_TYPE;
13
15
  (function (COST_SUB_TYPE) {
14
- COST_SUB_TYPE["FLAT"] = "flat";
15
- COST_SUB_TYPE["PERCENTAGE"] = "percentage";
16
+ COST_SUB_TYPE["PRODUCT_COST"] = "product_cost";
17
+ COST_SUB_TYPE["HANDLING_FEE"] = "handling_fee";
16
18
  })(COST_SUB_TYPE = exports.COST_SUB_TYPE || (exports.COST_SUB_TYPE = {}));
17
19
  var COST_SOURCE;
18
20
  (function (COST_SOURCE) {
19
- COST_SOURCE["SHOPIFY"] = "shopify";
20
21
  COST_SOURCE["MANUAL"] = "manual";
21
- COST_SOURCE["USER"] = "user";
22
+ COST_SOURCE["SHOPIFY"] = "shopify";
22
23
  })(COST_SOURCE = exports.COST_SOURCE || (exports.COST_SOURCE = {}));
24
+ var COST_CHANNEL;
25
+ (function (COST_CHANNEL) {
26
+ COST_CHANNEL["ONLINE"] = "online";
27
+ COST_CHANNEL["POS"] = "pos";
28
+ COST_CHANNEL["BOTH"] = "both";
29
+ })(COST_CHANNEL = exports.COST_CHANNEL || (exports.COST_CHANNEL = {}));
30
+ var SHIPPING_METHOD;
31
+ (function (SHIPPING_METHOD) {
32
+ SHIPPING_METHOD["SHOPIFY_CHARGES"] = "shopify_charges";
33
+ SHIPPING_METHOD["FIXED_RATE"] = "fixed_rate";
34
+ })(SHIPPING_METHOD = exports.SHIPPING_METHOD || (exports.SHIPPING_METHOD = {}));
23
35
  var VARIABLE_COST_TYPE;
24
36
  (function (VARIABLE_COST_TYPE) {
25
37
  VARIABLE_COST_TYPE["PER_ORDER"] = "per_order";
26
38
  VARIABLE_COST_TYPE["PER_LINE_ITEM"] = "per_line_item";
39
+ VARIABLE_COST_TYPE["PCT_TOTAL_SALES"] = "pct_total_sales";
40
+ VARIABLE_COST_TYPE["PCT_GROSS_SALES"] = "pct_gross_sales";
41
+ VARIABLE_COST_TYPE["PCT_NET_SALES"] = "pct_net_sales";
27
42
  VARIABLE_COST_TYPE["PER_REFUND_ORDER"] = "per_refund_order";
28
43
  VARIABLE_COST_TYPE["PER_REFUND_LINE_ITEM"] = "per_refund_line_item";
29
- VARIABLE_COST_TYPE["PCT_SALES"] = "pct_sales";
30
- VARIABLE_COST_TYPE["PCT_COGS"] = "pct_cogs";
31
44
  VARIABLE_COST_TYPE["PCT_AD_SPEND"] = "pct_ad_spend";
32
- VARIABLE_COST_TYPE["PCT_SHIPPING"] = "pct_shipping";
33
- VARIABLE_COST_TYPE["PCT_GROSS_SALES"] = "pct_gross_sales";
34
- VARIABLE_COST_TYPE["BY_WEIGHT"] = "by_weight";
35
- VARIABLE_COST_TYPE["BY_QUANTITY"] = "by_quantity";
36
45
  })(VARIABLE_COST_TYPE = exports.VARIABLE_COST_TYPE || (exports.VARIABLE_COST_TYPE = {}));
37
46
  var FIXED_COST_FREQUENCY;
38
47
  (function (FIXED_COST_FREQUENCY) {
39
48
  FIXED_COST_FREQUENCY["DAILY"] = "daily";
40
49
  FIXED_COST_FREQUENCY["WEEKLY"] = "weekly";
41
50
  FIXED_COST_FREQUENCY["MONTHLY"] = "monthly";
51
+ FIXED_COST_FREQUENCY["QUARTERLY"] = "quarterly";
42
52
  FIXED_COST_FREQUENCY["YEARLY"] = "yearly";
43
53
  })(FIXED_COST_FREQUENCY = exports.FIXED_COST_FREQUENCY || (exports.FIXED_COST_FREQUENCY = {}));
44
54
  var VARIABLE_COST_CATEGORY;
45
55
  (function (VARIABLE_COST_CATEGORY) {
46
- VARIABLE_COST_CATEGORY["SHIPPING"] = "shipping";
47
- VARIABLE_COST_CATEGORY["PAYMENT_FEES"] = "payment_fees";
48
- VARIABLE_COST_CATEGORY["PACKAGING"] = "packaging";
49
- VARIABLE_COST_CATEGORY["RETURNS"] = "returns";
50
56
  VARIABLE_COST_CATEGORY["FULFILLMENT"] = "fulfillment";
57
+ VARIABLE_COST_CATEGORY["TRANSACTION"] = "transaction";
58
+ VARIABLE_COST_CATEGORY["MARKETING"] = "marketing";
51
59
  VARIABLE_COST_CATEGORY["OTHER"] = "other";
52
60
  })(VARIABLE_COST_CATEGORY = exports.VARIABLE_COST_CATEGORY || (exports.VARIABLE_COST_CATEGORY = {}));
53
61
  var FIXED_COST_CATEGORY;
@@ -55,14 +63,7 @@ var FIXED_COST_CATEGORY;
55
63
  FIXED_COST_CATEGORY["RENT"] = "rent";
56
64
  FIXED_COST_CATEGORY["SALARIES"] = "salaries";
57
65
  FIXED_COST_CATEGORY["SOFTWARE"] = "software";
58
- FIXED_COST_CATEGORY["UTILITIES"] = "utilities";
59
66
  FIXED_COST_CATEGORY["INSURANCE"] = "insurance";
60
67
  FIXED_COST_CATEGORY["OTHER"] = "other";
61
68
  })(FIXED_COST_CATEGORY = exports.FIXED_COST_CATEGORY || (exports.FIXED_COST_CATEGORY = {}));
62
- var COST_CHANNEL;
63
- (function (COST_CHANNEL) {
64
- COST_CHANNEL["ONLINE"] = "online";
65
- COST_CHANNEL["POS"] = "pos";
66
- COST_CHANNEL["BOTH"] = "both";
67
- })(COST_CHANNEL = exports.COST_CHANNEL || (exports.COST_CHANNEL = {}));
68
69
  //# sourceMappingURL=cost-types.js.map
package/dist/cjs/types/costs/cost-types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"cost-types.js","sourceRoot":"","sources":["../../../../src/types/costs/cost-types.ts"],"names":[],"mappings":";;;AAAA,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,kCAAqB,CAAA;IACrB,kCAAqB,CAAA;IACrB,4BAAe,CAAA;IACf,qCAAwB,CAAA;AAC1B,CAAC,EANW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAMpB;AAED,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,8BAAa,CAAA;IACb,0CAAyB,CAAA;AAC3B,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AAED,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,gCAAiB,CAAA;IACjB,4BAAa,CAAA;AACf,CAAC,EAJW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAItB;AAED,IAAY,kBAYX;AAZD,WAAY,kBAAkB;IAC5B,6CAAuB,CAAA;IACvB,qDAA+B,CAAA;IAC/B,2DAAqC,CAAA;IACrC,mEAA6C,CAAA;IAC7C,6CAAuB,CAAA;IACvB,2CAAqB,CAAA;IACrB,mDAA6B,CAAA;IAC7B,mDAA6B,CAAA;IAC7B,yDAAmC,CAAA;IACnC,6CAAuB,CAAA;IACvB,iDAA2B,CAAA;AAC7B,CAAC,EAZW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAY7B;AAED,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,uCAAe,CAAA;IACf,yCAAiB,CAAA;IACjB,2CAAmB,CAAA;IACnB,yCAAiB,CAAA;AACnB,CAAC,EALW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAK/B;AAED,IAAY,sBAOX;AAPD,WAAY,sBAAsB;IAChC,+CAAqB,CAAA;IACrB,uDAA6B,CAAA;IAC7B,iDAAuB,CAAA;IACvB,6CAAmB,CAAA;IACnB,qDAA2B,CAAA;IAC3B,yCAAe,CAAA;AACjB,CAAC,EAPW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAOjC;AAED,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,oCAAa,CAAA;IACb,4CAAqB,CAAA;IACrB,4CAAqB,CAAA;IACrB,8CAAuB,CAAA;IACvB,8CAAuB,CAAA;IACvB,sCAAe,CAAA;AACjB,CAAC,EAPW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAO9B;AAED,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,2BAAW,CAAA;IACX,6BAAa,CAAA;AACf,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB"}
1
+ {"version":3,"file":"cost-types.js","sourceRoot":"","sources":["../../../../src/types/costs/cost-types.ts"],"names":[],"mappings":";;;AAEA,IAAY,SAQX;AARD,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,kCAAqB,CAAA;IACrB,4BAAe,CAAA;IACf,0CAA6B,CAAA;IAC7B,gDAAmC,CAAA;IACnC,kCAAqB,CAAA;IACrB,gCAAmB,CAAA;AACrB,CAAC,EARW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAQpB;AAED,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,8CAA6B,CAAA;IAC7B,8CAA6B,CAAA;AAC/B,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AAED,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,gCAAiB,CAAA;IACjB,kCAAmB,CAAA;AACrB,CAAC,EAHW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAGtB;AAED,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,2BAAW,CAAA;IACX,6BAAa,CAAA;AACf,CAAC,EAJW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAIvB;AAED,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,sDAAmC,CAAA;IACnC,4CAAyB,CAAA;AAC3B,CAAC,EAHW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAG1B;AAED,IAAY,kBASX;AATD,WAAY,kBAAkB;IAC5B,6CAAuB,CAAA;IACvB,qDAA+B,CAAA;IAC/B,yDAAmC,CAAA;IACnC,yDAAmC,CAAA;IACnC,qDAA+B,CAAA;IAC/B,2DAAqC,CAAA;IACrC,mEAA6C,CAAA;IAC7C,mDAA6B,CAAA;AAC/B,CAAC,EATW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAS7B;AAED,IAAY,oBAMX;AAND,WAAY,oBAAoB;IAC9B,uCAAe,CAAA;IACf,yCAAiB,CAAA;IACjB,2CAAmB,CAAA;IACnB,+CAAuB,CAAA;IACvB,yCAAiB,CAAA;AACnB,CAAC,EANW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAM/B;AAED,IAAY,sBAKX;AALD,WAAY,sBAAsB;IAChC,qDAA2B,CAAA;IAC3B,qDAA2B,CAAA;IAC3B,iDAAuB,CAAA;IACvB,yCAAe,CAAA;AACjB,CAAC,EALW,sBAAsB,GAAtB,8BAAsB,KAAtB,8BAAsB,QAKjC;AAED,IAAY,mBAMX;AAND,WAAY,mBAAmB;IAC7B,oCAAa,CAAA;IACb,4CAAqB,CAAA;IACrB,4CAAqB,CAAA;IACrB,8CAAuB,CAAA;IACvB,sCAAe,CAAA;AACjB,CAAC,EANW,mBAAmB,GAAnB,2BAAmB,KAAnB,2BAAmB,QAM9B"}
package/dist/esm/types/api/measures/definitions/core-measure-definitions.js CHANGED
@@ -441,8 +441,8 @@ export const CORE_MEASURES_MAP = {
441
441
  applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
442
442
  },
443
443
  [MEASURE.CORE_EFFECTIVE_COGS]: {
444
- title: 'COGS (Effective)',
445
- description: 'Cost of Goods Sold with default COGS applied when product cost is missing.',
444
+ title: 'Effective COGS',
445
+ description: 'Net Cost of Goods Sold (Orders COGS + Handling - Refund COGS)',
446
446
  sumPrefix: '$',
447
447
  sumSuffix: '',
448
448
  avgPrefix: '$',
@@ -455,9 +455,24 @@ export const CORE_MEASURES_MAP = {
455
455
  useCompactNotation: true,
456
456
  applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
457
457
  },
458
+ [MEASURE.CORE_EFFECTIVE_COGS_PERCENT]: {
459
+ title: 'Effective COGS %',
460
+ description: 'Effective COGS as a percentage of Net Sales',
461
+ sumPrefix: '',
462
+ sumSuffix: '%',
463
+ avgPrefix: '',
464
+ avgSuffix: '%',
465
+ icon: 'upstack',
466
+ measure: MEASURE.CORE_EFFECTIVE_COGS_PERCENT,
467
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
468
+ valueType: MeasureValueType.PERCENTAGE,
469
+ decimalPlaces: 2,
470
+ useCompactNotation: false,
471
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
472
+ },
458
473
  [MEASURE.CORE_NEW_CUSTOMER_EFFECTIVE_COGS]: {
459
- title: 'New Customer COGS (Effective)',
460
- description: 'New Customer COGS with default applied.',
474
+ title: 'NC Effective COGS',
475
+ description: 'New Customer Effective COGS',
461
476
  sumPrefix: '$',
462
477
  sumSuffix: '',
463
478
  avgPrefix: '$',
@@ -470,30 +485,45 @@ export const CORE_MEASURES_MAP = {
470
485
  useCompactNotation: true,
471
486
  applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
472
487
  },
473
- [MEASURE.CORE_VARIABLE_COSTS]: {
474
- title: 'Variable Costs',
475
- description: 'Total variable costs calculated from configured cost rules (payment fees, fulfillment, packaging, etc.).',
488
+ [MEASURE.CORE_COGS_ORDERS]: {
489
+ title: 'COGS (Orders)',
490
+ description: 'Cost of Goods Sold from orders',
476
491
  sumPrefix: '$',
477
492
  sumSuffix: '',
478
493
  avgPrefix: '$',
479
494
  avgSuffix: '',
480
495
  icon: 'upstack',
481
- measure: MEASURE.CORE_VARIABLE_COSTS,
496
+ measure: MEASURE.CORE_COGS_ORDERS,
497
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
498
+ valueType: MeasureValueType.CURRENCY,
499
+ decimalPlaces: 2,
500
+ useCompactNotation: true,
501
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
502
+ },
503
+ [MEASURE.CORE_COGS_REFUNDS]: {
504
+ title: 'COGS (Refunds)',
505
+ description: 'Cost of Goods Sold recovered from refunds',
506
+ sumPrefix: '$',
507
+ sumSuffix: '',
508
+ avgPrefix: '$',
509
+ avgSuffix: '',
510
+ icon: 'upstack',
511
+ measure: MEASURE.CORE_COGS_REFUNDS,
482
512
  category: MEASURE_CATEGORY.UPSTACK_DATA,
483
513
  valueType: MeasureValueType.CURRENCY,
484
514
  decimalPlaces: 2,
485
515
  useCompactNotation: true,
486
516
  applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
487
517
  },
488
- [MEASURE.CORE_VARIABLE_COSTS_PER_ORDER]: {
489
- title: 'Variable Costs Per Order',
490
- description: 'Average variable costs per order.',
518
+ [MEASURE.CORE_VARIABLE_COSTS]: {
519
+ title: 'Variable Costs',
520
+ description: 'Total custom variable expenses (per-order fees, % of sales, etc.)',
491
521
  sumPrefix: '$',
492
522
  sumSuffix: '',
493
523
  avgPrefix: '$',
494
524
  avgSuffix: '',
495
525
  icon: 'upstack',
496
- measure: MEASURE.CORE_VARIABLE_COSTS_PER_ORDER,
526
+ measure: MEASURE.CORE_VARIABLE_COSTS,
497
527
  category: MEASURE_CATEGORY.UPSTACK_DATA,
498
528
  valueType: MeasureValueType.CURRENCY,
499
529
  decimalPlaces: 2,
@@ -502,7 +532,7 @@ export const CORE_MEASURES_MAP = {
502
532
  },
503
533
  [MEASURE.CORE_VARIABLE_COSTS_PERCENT]: {
504
534
  title: 'Variable Costs %',
505
- description: 'Variable costs as a percentage of net sales.',
535
+ description: 'Variable costs as a percentage of Net Sales',
506
536
  sumPrefix: '',
507
537
  sumSuffix: '%',
508
538
  avgPrefix: '',
@@ -515,60 +545,90 @@ export const CORE_MEASURES_MAP = {
515
545
  useCompactNotation: false,
516
546
  applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
517
547
  },
518
- [MEASURE.CORE_NEW_CUSTOMER_VARIABLE_COSTS]: {
519
- title: 'New Customer Variable Costs',
520
- description: 'Variable costs for new customer orders only.',
548
+ [MEASURE.CORE_FIXED_COSTS]: {
549
+ title: 'Fixed Costs',
550
+ description: 'Total fixed expenses (rent, salaries, software, etc.)',
521
551
  sumPrefix: '$',
522
552
  sumSuffix: '',
523
553
  avgPrefix: '$',
524
554
  avgSuffix: '',
525
555
  icon: 'upstack',
526
- measure: MEASURE.CORE_NEW_CUSTOMER_VARIABLE_COSTS,
556
+ measure: MEASURE.CORE_FIXED_COSTS,
527
557
  category: MEASURE_CATEGORY.UPSTACK_DATA,
528
558
  valueType: MeasureValueType.CURRENCY,
529
559
  decimalPlaces: 2,
530
560
  useCompactNotation: true,
531
561
  applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
532
562
  },
533
- [MEASURE.CORE_FIXED_COSTS]: {
534
- title: 'Fixed Costs',
535
- description: 'Total fixed costs allocated across the date range (rent, salaries, software, etc.).',
563
+ [MEASURE.CORE_FIXED_COSTS_PERCENT]: {
564
+ title: 'Fixed Costs %',
565
+ description: 'Fixed costs as a percentage of Net Sales',
566
+ sumPrefix: '',
567
+ sumSuffix: '%',
568
+ avgPrefix: '',
569
+ avgSuffix: '%',
570
+ icon: 'upstack',
571
+ measure: MEASURE.CORE_FIXED_COSTS_PERCENT,
572
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
573
+ valueType: MeasureValueType.PERCENTAGE,
574
+ decimalPlaces: 2,
575
+ useCompactNotation: false,
576
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
577
+ },
578
+ [MEASURE.CORE_SHIPPING_COSTS]: {
579
+ title: 'Shipping Costs',
580
+ description: 'Seller-side shipping expenses',
536
581
  sumPrefix: '$',
537
582
  sumSuffix: '',
538
583
  avgPrefix: '$',
539
584
  avgSuffix: '',
540
585
  icon: 'upstack',
541
- measure: MEASURE.CORE_FIXED_COSTS,
586
+ measure: MEASURE.CORE_SHIPPING_COSTS,
587
+ category: MEASURE_CATEGORY.UPSTACK_DATA,
588
+ valueType: MeasureValueType.CURRENCY,
589
+ decimalPlaces: 2,
590
+ useCompactNotation: true,
591
+ applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
592
+ },
593
+ [MEASURE.CORE_PAYMENT_GATEWAY_COSTS]: {
594
+ title: 'Payment Gateway Costs',
595
+ description: 'Payment processing fees (flat + percentage per gateway)',
596
+ sumPrefix: '$',
597
+ sumSuffix: '',
598
+ avgPrefix: '$',
599
+ avgSuffix: '',
600
+ icon: 'upstack',
601
+ measure: MEASURE.CORE_PAYMENT_GATEWAY_COSTS,
542
602
  category: MEASURE_CATEGORY.UPSTACK_DATA,
543
603
  valueType: MeasureValueType.CURRENCY,
544
604
  decimalPlaces: 2,
545
605
  useCompactNotation: true,
546
606
  applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
547
607
  },
548
- [MEASURE.CORE_FIXED_COSTS_PER_DAY]: {
549
- title: 'Fixed Costs Per Day',
550
- description: 'Average fixed costs per day.',
608
+ [MEASURE.CORE_CUSTOM_AD_SPEND]: {
609
+ title: 'Custom Ad Spend',
610
+ description: 'User-entered ad spend from custom variable/fixed expenses marked as ad spend',
551
611
  sumPrefix: '$',
552
612
  sumSuffix: '',
553
613
  avgPrefix: '$',
554
614
  avgSuffix: '',
555
615
  icon: 'upstack',
556
- measure: MEASURE.CORE_FIXED_COSTS_PER_DAY,
616
+ measure: MEASURE.CORE_CUSTOM_AD_SPEND,
557
617
  category: MEASURE_CATEGORY.UPSTACK_DATA,
558
618
  valueType: MeasureValueType.CURRENCY,
559
619
  decimalPlaces: 2,
560
620
  useCompactNotation: true,
561
621
  applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
562
622
  },
563
- [MEASURE.CORE_NEW_CUSTOMER_FIXED_COSTS]: {
564
- title: 'New Customer Fixed Costs',
565
- description: 'Fixed costs allocated proportionally to new customer orders.',
623
+ [MEASURE.CORE_BLENDED_AD_SPEND]: {
624
+ title: 'Blended Ad Spend',
625
+ description: 'Total ad spend combining API channel spend and custom ad spend expenses',
566
626
  sumPrefix: '$',
567
627
  sumSuffix: '',
568
628
  avgPrefix: '$',
569
629
  avgSuffix: '',
570
630
  icon: 'upstack',
571
- measure: MEASURE.CORE_NEW_CUSTOMER_FIXED_COSTS,
631
+ measure: MEASURE.CORE_BLENDED_AD_SPEND,
572
632
  category: MEASURE_CATEGORY.UPSTACK_DATA,
573
633
  valueType: MeasureValueType.CURRENCY,
574
634
  decimalPlaces: 2,
@@ -577,7 +637,7 @@ export const CORE_MEASURES_MAP = {
577
637
  },
578
638
  [MEASURE.CORE_GROSS_PROFIT]: {
579
639
  title: 'Gross Profit (CM1)',
580
- description: 'Contribution Margin 1: Net Sales minus Effective COGS.',
640
+ description: 'Net Sales - Effective COGS',
581
641
  sumPrefix: '$',
582
642
  sumSuffix: '',
583
643
  avgPrefix: '$',
@@ -591,8 +651,8 @@ export const CORE_MEASURES_MAP = {
591
651
  applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
592
652
  },
593
653
  [MEASURE.CORE_GROSS_PROFIT_PERCENT]: {
594
- title: 'Gross Profit % (CM1 %)',
595
- description: 'Gross Profit as a percentage of Net Sales.',
654
+ title: 'Gross Profit Margin %',
655
+ description: 'Gross Profit as a percentage of Net Sales',
596
656
  sumPrefix: '',
597
657
  sumSuffix: '%',
598
658
  avgPrefix: '',
@@ -606,8 +666,8 @@ export const CORE_MEASURES_MAP = {
606
666
  applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
607
667
  },
608
668
  [MEASURE.CORE_CM2]: {
609
- title: 'CM2',
610
- description: 'Contribution Margin 2: CM1 - Variable Costs.',
669
+ title: 'CM2 (Contribution Margin 2)',
670
+ description: 'Gross Profit - Shipping - Gateway Costs - Variable Expenses',
611
671
  sumPrefix: '$',
612
672
  sumSuffix: '',
613
673
  avgPrefix: '$',
@@ -622,7 +682,7 @@ export const CORE_MEASURES_MAP = {
622
682
  },
623
683
  [MEASURE.CORE_CM2_PERCENT]: {
624
684
  title: 'CM2 %',
625
- description: 'CM2 as a percentage of Net Sales.',
685
+ description: 'CM2 as a percentage of Net Sales',
626
686
  sumPrefix: '',
627
687
  sumSuffix: '%',
628
688
  avgPrefix: '',
@@ -636,8 +696,8 @@ export const CORE_MEASURES_MAP = {
636
696
  applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
637
697
  },
638
698
  [MEASURE.CORE_CM3]: {
639
- title: 'CM3',
640
- description: 'Contribution Margin 3: CM2 - Ad Spend.',
699
+ title: 'CM3 (Contribution Margin 3)',
700
+ description: 'CM2 - Blended Ad Spend',
641
701
  sumPrefix: '$',
642
702
  sumSuffix: '',
643
703
  avgPrefix: '$',
@@ -652,7 +712,7 @@ export const CORE_MEASURES_MAP = {
652
712
  },
653
713
  [MEASURE.CORE_CM3_PERCENT]: {
654
714
  title: 'CM3 %',
655
- description: 'CM3 as a percentage of Net Sales.',
715
+ description: 'CM3 as a percentage of Net Sales',
656
716
  sumPrefix: '',
657
717
  sumSuffix: '%',
658
718
  avgPrefix: '',
@@ -667,7 +727,7 @@ export const CORE_MEASURES_MAP = {
667
727
  },
668
728
  [MEASURE.CORE_NET_PROFIT]: {
669
729
  title: 'Net Profit',
670
- description: 'CM3 - Fixed Costs. Final bottom-line profit.',
730
+ description: 'CM3 - Fixed Expenses',
671
731
  sumPrefix: '$',
672
732
  sumSuffix: '',
673
733
  avgPrefix: '$',
@@ -681,8 +741,8 @@ export const CORE_MEASURES_MAP = {
681
741
  applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
682
742
  },
683
743
  [MEASURE.CORE_NET_PROFIT_PERCENT]: {
684
- title: 'Net Profit %',
685
- description: 'Net Profit as a percentage of Net Sales.',
744
+ title: 'Net Profit Margin %',
745
+ description: 'Net Profit as a percentage of Net Sales',
686
746
  sumPrefix: '',
687
747
  sumSuffix: '%',
688
748
  avgPrefix: '',
@@ -695,65 +755,5 @@ export const CORE_MEASURES_MAP = {
695
755
  useCompactNotation: false,
696
756
  applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
697
757
  },
698
- [MEASURE.CORE_NEW_CUSTOMER_GROSS_PROFIT]: {
699
- title: 'New Customer Gross Profit (CM1)',
700
- description: 'New Customer Contribution Margin 1: NC Net Sales minus NC Effective COGS.',
701
- sumPrefix: '$',
702
- sumSuffix: '',
703
- avgPrefix: '$',
704
- avgSuffix: '',
705
- icon: 'upstack',
706
- measure: MEASURE.CORE_NEW_CUSTOMER_GROSS_PROFIT,
707
- category: MEASURE_CATEGORY.UPSTACK_DATA,
708
- valueType: MeasureValueType.CURRENCY,
709
- decimalPlaces: 2,
710
- useCompactNotation: true,
711
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
712
- },
713
- [MEASURE.CORE_NEW_CUSTOMER_CM2]: {
714
- title: 'New Customer CM2',
715
- description: 'New Customer CM2: NC CM1 - NC Variable Costs.',
716
- sumPrefix: '$',
717
- sumSuffix: '',
718
- avgPrefix: '$',
719
- avgSuffix: '',
720
- icon: 'upstack',
721
- measure: MEASURE.CORE_NEW_CUSTOMER_CM2,
722
- category: MEASURE_CATEGORY.UPSTACK_DATA,
723
- valueType: MeasureValueType.CURRENCY,
724
- decimalPlaces: 2,
725
- useCompactNotation: true,
726
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
727
- },
728
- [MEASURE.CORE_NEW_CUSTOMER_CM3]: {
729
- title: 'New Customer CM3',
730
- description: 'New Customer CM3: NC CM2 - Ad Spend.',
731
- sumPrefix: '$',
732
- sumSuffix: '',
733
- avgPrefix: '$',
734
- avgSuffix: '',
735
- icon: 'upstack',
736
- measure: MEASURE.CORE_NEW_CUSTOMER_CM3,
737
- category: MEASURE_CATEGORY.UPSTACK_DATA,
738
- valueType: MeasureValueType.CURRENCY,
739
- decimalPlaces: 2,
740
- useCompactNotation: true,
741
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
742
- },
743
- [MEASURE.CORE_NEW_CUSTOMER_NET_PROFIT]: {
744
- title: 'New Customer Net Profit',
745
- description: 'New Customer Net Profit: NC CM3 - NC Fixed Costs.',
746
- sumPrefix: '$',
747
- sumSuffix: '',
748
- avgPrefix: '$',
749
- avgSuffix: '',
750
- icon: 'upstack',
751
- measure: MEASURE.CORE_NEW_CUSTOMER_NET_PROFIT,
752
- category: MEASURE_CATEGORY.UPSTACK_DATA,
753
- valueType: MeasureValueType.CURRENCY,
754
- decimalPlaces: 2,
755
- useCompactNotation: true,
756
- applicableContexts: CUSTOM_DASHBOARD_APPLICABLE_CONTEXTS,
757
- },
758
758
  };
759
759
  //# sourceMappingURL=core-measure-definitions.js.map