@adtrackify/at-tracking-event-types 4.18.1 → 4.18.2

package/dist/esm/types/common/currency.js

@@ -1,61 +1,61 @@
-export const Currencies = [
-    'AED',
-    'ARS',
-    'AUD',
-    'BDT',
-    'BIF',
-    'BOB',
-    'BRL',
-    'CAD',
-    'CHF',
-    'CLP',
-    'CNY',
-    'COP',
-    'CRC',
-    'CZK',
-    'DKK',
-    'DZD',
-    'EGP',
-    'EUR',
-    'GBP',
-    'GTQ',
-    'HKD',
-    'HNL',
-    'HUF',
-    'IDR',
-    'ILS',
-    'INR',
-    'ISK',
-    'JPY',
-    'KES',
-    'KRW',
-    'KWD',
-    'KZT',
-    'MAD',
-    'MOP',
-    'MXN',
-    'MYR',
-    'NGN',
-    'NIO',
-    'NOK',
-    'NZD',
-    'PEN',
-    'PHP',
-    'PKR',
-    'PLN',
-    'PYG',
-    'QAR',
-    'RON',
-    'RUB',
-    'SAR',
-    'SEK',
-    'SGD',
-    'THB',
-    'TRY',
-    'TWD',
-    'USD',
-    'VES',
-    'VND',
-    'ZAR',
-];
+export const Currencies = [
+    'AED',
+    'ARS',
+    'AUD',
+    'BDT',
+    'BIF',
+    'BOB',
+    'BRL',
+    'CAD',
+    'CHF',
+    'CLP',
+    'CNY',
+    'COP',
+    'CRC',
+    'CZK',
+    'DKK',
+    'DZD',
+    'EGP',
+    'EUR',
+    'GBP',
+    'GTQ',
+    'HKD',
+    'HNL',
+    'HUF',
+    'IDR',
+    'ILS',
+    'INR',
+    'ISK',
+    'JPY',
+    'KES',
+    'KRW',
+    'KWD',
+    'KZT',
+    'MAD',
+    'MOP',
+    'MXN',
+    'MYR',
+    'NGN',
+    'NIO',
+    'NOK',
+    'NZD',
+    'PEN',
+    'PHP',
+    'PKR',
+    'PLN',
+    'PYG',
+    'QAR',
+    'RON',
+    'RUB',
+    'SAR',
+    'SEK',
+    'SGD',
+    'THB',
+    'TRY',
+    'TWD',
+    'USD',
+    'VES',
+    'VND',
+    'ZAR',
+];
 //# sourceMappingURL=currency.js.map

package/dist/esm/types/common/index.d.ts

@@ -1,2 +1,2 @@
-export * from './address.js';
-export * from './currency.js';
+export * from './address.js';
+export * from './currency.js';

package/dist/esm/types/common/index.js

@@ -1,3 +1,3 @@
-export * from './address.js';
-export * from './currency.js';
+export * from './address.js';
+export * from './currency.js';
 //# sourceMappingURL=index.js.map

package/dist/esm/types/costs/cost-types.d.ts

@@ -0,0 +1,265 @@
+export declare enum COST_TYPE {
+    PRODUCT = "product",
+    SHIPPING = "shipping",
+    HANDLING = "handling",
+    GATEWAY = "gateway",
+    VARIABLE = "variable",
+    FIXED = "fixed",
+    DEFAULT_COGS = "default_cogs"
+}
+export declare enum COST_SOURCE {
+    MANUAL = "manual",
+    SHOPIFY = "shopify"
+}
+export declare enum VARIABLE_COST_TYPE {
+    PER_ORDER = "per_order",
+    PER_LINE_ITEM = "per_line_item",
+    PER_REFUND_ORDER = "per_refund_order",
+    PER_REFUND_LINE_ITEM = "per_refund_line_item",
+    PCT_GROSS_SALES = "pct_gross_sales",
+    PCT_TOTAL_SALES = "pct_total_sales",
+    PCT_NET_SALES = "pct_net_sales",
+    PCT_COGS = "pct_cogs",
+    PCT_SHIPPING = "pct_shipping",
+    BY_WEIGHT = "by_weight",
+    BY_QUANTITY = "by_quantity"
+}
+export declare enum FIXED_COST_FREQUENCY {
+    DAILY = "daily",
+    WEEKLY = "weekly",
+    MONTHLY = "monthly",
+    QUARTERLY = "quarterly",
+    YEARLY = "yearly"
+}
+export declare enum COST_CHANNEL {
+    ONLINE = "online",
+    POS = "pos",
+    BOTH = "both"
+}
+export declare enum SHIPPING_METHOD {
+    SHOPIFY_CHARGES = "shopify_charges",
+    FIXED_RATE = "fixed_rate"
+}
+export declare enum VARIABLE_COST_CATEGORY {
+    SHIPPING = "shipping",
+    PAYMENT_FEES = "payment_fees",
+    PACKAGING = "packaging",
+    FULFILLMENT = "fulfillment",
+    TRANSACTION = "transaction",
+    MARKETING = "marketing",
+    OTHER = "other"
+}
+export declare enum FIXED_COST_CATEGORY {
+    RENT = "rent",
+    SALARIES = "salaries",
+    SOFTWARE = "software",
+    UTILITIES = "utilities",
+    INSURANCE = "insurance",
+    OTHER = "other"
+}
+export declare enum COST_SYNC_ACTION {
+    UPSERT = "UPSERT",
+    DELETE = "DELETE"
+}
+export interface CostSyncMessageMetadata {
+    firstSeen: string;
+    lastSeen: string;
+    numSeen: number;
+}
+export interface CostSyncMessage {
+    action: COST_SYNC_ACTION;
+    pixelId: string;
+    env: string;
+    pk: string;
+    record?: CostRecord;
+    messageMetadata?: CostSyncMessageMetadata;
+}
+export interface CostHistoryPeriod {
+    effectiveStartDate: string;
+    effectiveEndDate: string | null;
+    cost: number;
+}
+export interface OrdersCostRecalcMessage {
+    pixelId: string;
+    env: string;
+    variantId: string;
+    productId: string;
+    costHistory: CostHistoryPeriod[];
+    messageMetadata?: CostSyncMessageMetadata;
+}
+export interface GenericCostRecord {
+    pk: string;
+    sk?: string;
+    entityId: string;
+    pixelId: string;
+    env: string;
+    costType: COST_TYPE;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ProductCostHistoryRecord {
+    id: string;
+    isCurrent: boolean;
+    costType: COST_TYPE.PRODUCT;
+    costSource: COST_SOURCE;
+    price: number;
+    cost: number;
+    effectiveStartDate: string;
+    effectiveEndDate: string | null;
+    description: string;
+}
+export interface ProductCostRecord extends GenericCostRecord {
+    costType: COST_TYPE.PRODUCT;
+    productId: string;
+    variantId: string;
+    sku: string;
+    productTitle: string;
+    variantTitle: string;
+    imageUrls: string[];
+    currentPrice?: number;
+    currentCost?: number;
+    handlingFee?: number;
+    currency: string;
+    costSource: COST_SOURCE;
+    costHistory: ProductCostHistoryRecord[];
+}
+export interface HandlingFeeRecord extends GenericCostRecord {
+    costType: COST_TYPE.HANDLING;
+    enabled: boolean;
+    amount: number;
+    effectiveFrom: string;
+    effectiveTo?: string;
+}
+export interface DefaultCogsRecord extends GenericCostRecord {
+    costType: COST_TYPE.DEFAULT_COGS;
+    amount: number;
+    effectiveFrom: string;
+    effectiveTo?: string;
+}
+export interface ShippingConfigRecord extends GenericCostRecord {
+    costType: COST_TYPE.SHIPPING;
+    enabled: boolean;
+    method: SHIPPING_METHOD;
+    amount?: number;
+    effectiveFrom: string;
+    effectiveTo?: string;
+}
+export interface PaymentGatewayRecord extends GenericCostRecord {
+    costType: COST_TYPE.GATEWAY;
+    name: string;
+    gatewayName: string;
+    flatFee: number;
+    percentFee: number;
+    effectiveFrom: string;
+    effectiveTo?: string;
+}
+export interface VariableCostRecord extends GenericCostRecord {
+    costType: COST_TYPE.VARIABLE;
+    name: string;
+    variableType: VARIABLE_COST_TYPE;
+    amount: number;
+    channel: COST_CHANNEL;
+    category: VARIABLE_COST_CATEGORY;
+    isAdSpend: boolean;
+    effectiveFrom: string;
+    effectiveTo?: string;
+    filters?: {
+        shippingTitleContains?: string;
+        skipShopifyPayments?: boolean;
+        paymentGateway?: string;
+        countries?: string[];
+    };
+}
+export interface FixedCostRecord extends GenericCostRecord {
+    costType: COST_TYPE.FIXED;
+    name: string;
+    amount: number;
+    frequency: FIXED_COST_FREQUENCY;
+    channel: COST_CHANNEL;
+    category: FIXED_COST_CATEGORY;
+    isAdSpend: boolean;
+    effectiveFrom: string;
+    effectiveTo?: string;
+}
+export declare type CostRecord = ProductCostRecord | HandlingFeeRecord | DefaultCogsRecord | ShippingConfigRecord | PaymentGatewayRecord | VariableCostRecord | FixedCostRecord;
+export interface CostApiRecord {
+    id: string;
+    pixelId: string;
+    costType: COST_TYPE;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ProductCostApiRecord extends CostApiRecord {
+    costType: COST_TYPE.PRODUCT;
+    productId: string;
+    variantId: string;
+    sku: string;
+    productTitle: string;
+    variantTitle: string;
+    imageUrls: string[];
+    currentPrice?: number;
+    currentCost?: number;
+    handlingFee?: number;
+    currency: string;
+    costSource: COST_SOURCE;
+    costHistory: ProductCostHistoryRecord[];
+}
+export interface HandlingFeeApiRecord extends CostApiRecord {
+    costType: COST_TYPE.HANDLING;
+    enabled: boolean;
+    amount: number;
+    effectiveFrom: string;
+    effectiveTo?: string;
+}
+export interface DefaultCogsApiRecord extends CostApiRecord {
+    costType: COST_TYPE.DEFAULT_COGS;
+    amount: number;
+    effectiveFrom: string;
+    effectiveTo?: string;
+}
+export interface ShippingConfigApiRecord extends CostApiRecord {
+    costType: COST_TYPE.SHIPPING;
+    enabled: boolean;
+    method: SHIPPING_METHOD;
+    amount?: number;
+    effectiveFrom: string;
+    effectiveTo?: string;
+}
+export interface PaymentGatewayApiRecord extends CostApiRecord {
+    costType: COST_TYPE.GATEWAY;
+    name: string;
+    gatewayName: string;
+    flatFee: number;
+    percentFee: number;
+    effectiveFrom: string;
+    effectiveTo?: string;
+}
+export interface VariableCostApiRecord extends CostApiRecord {
+    costType: COST_TYPE.VARIABLE;
+    name: string;
+    variableType: VARIABLE_COST_TYPE;
+    amount: number;
+    channel: COST_CHANNEL;
+    category: VARIABLE_COST_CATEGORY;
+    isAdSpend: boolean;
+    effectiveFrom: string;
+    effectiveTo?: string;
+    filters?: {
+        shippingTitleContains?: string;
+        skipShopifyPayments?: boolean;
+        paymentGateway?: string;
+        countries?: string[];
+    };
+}
+export interface FixedCostApiRecord extends CostApiRecord {
+    costType: COST_TYPE.FIXED;
+    name: string;
+    amount: number;
+    frequency: FIXED_COST_FREQUENCY;
+    channel: COST_CHANNEL;
+    category: FIXED_COST_CATEGORY;
+    isAdSpend: boolean;
+    effectiveFrom: string;
+    effectiveTo?: string;
+}
+export declare type CostApiRecordUnion = ProductCostApiRecord | HandlingFeeApiRecord | DefaultCogsApiRecord | ShippingConfigApiRecord | PaymentGatewayApiRecord | VariableCostApiRecord | FixedCostApiRecord;

package/dist/esm/types/costs/cost-types.js

@@ -0,0 +1,73 @@
+export var COST_TYPE;
+(function (COST_TYPE) {
+    COST_TYPE["PRODUCT"] = "product";
+    COST_TYPE["SHIPPING"] = "shipping";
+    COST_TYPE["HANDLING"] = "handling";
+    COST_TYPE["GATEWAY"] = "gateway";
+    COST_TYPE["VARIABLE"] = "variable";
+    COST_TYPE["FIXED"] = "fixed";
+    COST_TYPE["DEFAULT_COGS"] = "default_cogs";
+})(COST_TYPE || (COST_TYPE = {}));
+export var COST_SOURCE;
+(function (COST_SOURCE) {
+    COST_SOURCE["MANUAL"] = "manual";
+    COST_SOURCE["SHOPIFY"] = "shopify";
+})(COST_SOURCE || (COST_SOURCE = {}));
+export var VARIABLE_COST_TYPE;
+(function (VARIABLE_COST_TYPE) {
+    VARIABLE_COST_TYPE["PER_ORDER"] = "per_order";
+    VARIABLE_COST_TYPE["PER_LINE_ITEM"] = "per_line_item";
+    VARIABLE_COST_TYPE["PER_REFUND_ORDER"] = "per_refund_order";
+    VARIABLE_COST_TYPE["PER_REFUND_LINE_ITEM"] = "per_refund_line_item";
+    VARIABLE_COST_TYPE["PCT_GROSS_SALES"] = "pct_gross_sales";
+    VARIABLE_COST_TYPE["PCT_TOTAL_SALES"] = "pct_total_sales";
+    VARIABLE_COST_TYPE["PCT_NET_SALES"] = "pct_net_sales";
+    VARIABLE_COST_TYPE["PCT_COGS"] = "pct_cogs";
+    VARIABLE_COST_TYPE["PCT_SHIPPING"] = "pct_shipping";
+    VARIABLE_COST_TYPE["BY_WEIGHT"] = "by_weight";
+    VARIABLE_COST_TYPE["BY_QUANTITY"] = "by_quantity";
+})(VARIABLE_COST_TYPE || (VARIABLE_COST_TYPE = {}));
+export var FIXED_COST_FREQUENCY;
+(function (FIXED_COST_FREQUENCY) {
+    FIXED_COST_FREQUENCY["DAILY"] = "daily";
+    FIXED_COST_FREQUENCY["WEEKLY"] = "weekly";
+    FIXED_COST_FREQUENCY["MONTHLY"] = "monthly";
+    FIXED_COST_FREQUENCY["QUARTERLY"] = "quarterly";
+    FIXED_COST_FREQUENCY["YEARLY"] = "yearly";
+})(FIXED_COST_FREQUENCY || (FIXED_COST_FREQUENCY = {}));
+export var COST_CHANNEL;
+(function (COST_CHANNEL) {
+    COST_CHANNEL["ONLINE"] = "online";
+    COST_CHANNEL["POS"] = "pos";
+    COST_CHANNEL["BOTH"] = "both";
+})(COST_CHANNEL || (COST_CHANNEL = {}));
+export var SHIPPING_METHOD;
+(function (SHIPPING_METHOD) {
+    SHIPPING_METHOD["SHOPIFY_CHARGES"] = "shopify_charges";
+    SHIPPING_METHOD["FIXED_RATE"] = "fixed_rate";
+})(SHIPPING_METHOD || (SHIPPING_METHOD = {}));
+export var VARIABLE_COST_CATEGORY;
+(function (VARIABLE_COST_CATEGORY) {
+    VARIABLE_COST_CATEGORY["SHIPPING"] = "shipping";
+    VARIABLE_COST_CATEGORY["PAYMENT_FEES"] = "payment_fees";
+    VARIABLE_COST_CATEGORY["PACKAGING"] = "packaging";
+    VARIABLE_COST_CATEGORY["FULFILLMENT"] = "fulfillment";
+    VARIABLE_COST_CATEGORY["TRANSACTION"] = "transaction";
+    VARIABLE_COST_CATEGORY["MARKETING"] = "marketing";
+    VARIABLE_COST_CATEGORY["OTHER"] = "other";
+})(VARIABLE_COST_CATEGORY || (VARIABLE_COST_CATEGORY = {}));
+export var FIXED_COST_CATEGORY;
+(function (FIXED_COST_CATEGORY) {
+    FIXED_COST_CATEGORY["RENT"] = "rent";
+    FIXED_COST_CATEGORY["SALARIES"] = "salaries";
+    FIXED_COST_CATEGORY["SOFTWARE"] = "software";
+    FIXED_COST_CATEGORY["UTILITIES"] = "utilities";
+    FIXED_COST_CATEGORY["INSURANCE"] = "insurance";
+    FIXED_COST_CATEGORY["OTHER"] = "other";
+})(FIXED_COST_CATEGORY || (FIXED_COST_CATEGORY = {}));
+export var COST_SYNC_ACTION;
+(function (COST_SYNC_ACTION) {
+    COST_SYNC_ACTION["UPSERT"] = "UPSERT";
+    COST_SYNC_ACTION["DELETE"] = "DELETE";
+})(COST_SYNC_ACTION || (COST_SYNC_ACTION = {}));
+//# sourceMappingURL=cost-types.js.map

package/dist/esm/types/costs/cost-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cost-types.js","sourceRoot":"","sources":["../../../../src/types/costs/cost-types.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,SAQX;AARD,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,kCAAqB,CAAA;IACrB,kCAAqB,CAAA;IACrB,gCAAmB,CAAA;IACnB,kCAAqB,CAAA;IACrB,4BAAe,CAAA;IACf,0CAA6B,CAAA;AAC/B,CAAC,EARW,SAAS,KAAT,SAAS,QAQpB;AAED,MAAM,CAAN,IAAY,WAGX;AAHD,WAAY,WAAW;IACrB,gCAAiB,CAAA;IACjB,kCAAmB,CAAA;AACrB,CAAC,EAHW,WAAW,KAAX,WAAW,QAGtB;AAED,MAAM,CAAN,IAAY,kBAYX;AAZD,WAAY,kBAAkB;IAC5B,6CAAuB,CAAA;IACvB,qDAA+B,CAAA;IAC/B,2DAAqC,CAAA;IACrC,mEAA6C,CAAA;IAC7C,yDAAmC,CAAA;IACnC,yDAAmC,CAAA;IACnC,qDAA+B,CAAA;IAC/B,2CAAqB,CAAA;IACrB,mDAA6B,CAAA;IAC7B,6CAAuB,CAAA;IACvB,iDAA2B,CAAA;AAC7B,CAAC,EAZW,kBAAkB,KAAlB,kBAAkB,QAY7B;AAED,MAAM,CAAN,IAAY,oBAMX;AAND,WAAY,oBAAoB;IAC9B,uCAAe,CAAA;IACf,yCAAiB,CAAA;IACjB,2CAAmB,CAAA;IACnB,+CAAuB,CAAA;IACvB,yCAAiB,CAAA;AACnB,CAAC,EANW,oBAAoB,KAApB,oBAAoB,QAM/B;AAED,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,2BAAW,CAAA;IACX,6BAAa,CAAA;AACf,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB;AAED,MAAM,CAAN,IAAY,eAGX;AAHD,WAAY,eAAe;IACzB,sDAAmC,CAAA;IACnC,4CAAyB,CAAA;AAC3B,CAAC,EAHW,eAAe,KAAf,eAAe,QAG1B;AAED,MAAM,CAAN,IAAY,sBAQX;AARD,WAAY,sBAAsB;IAChC,+CAAqB,CAAA;IACrB,uDAA6B,CAAA;IAC7B,iDAAuB,CAAA;IACvB,qDAA2B,CAAA;IAC3B,qDAA2B,CAAA;IAC3B,iDAAuB,CAAA;IACvB,yCAAe,CAAA;AACjB,CAAC,EARW,sBAAsB,KAAtB,sBAAsB,QAQjC;AAED,MAAM,CAAN,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,KAAnB,mBAAmB,QAO9B;AAID,MAAM,CAAN,IAAY,gBAGX;AAHD,WAAY,gBAAgB;IAC1B,qCAAiB,CAAA;IACjB,qCAAiB,CAAA;AACnB,CAAC,EAHW,gBAAgB,KAAhB,gBAAgB,QAG3B"}

package/dist/esm/types/costs/index.d.ts

@@ -0,0 +1 @@
+export * from './cost-types.js';

package/dist/esm/types/costs/index.js

@@ -0,0 +1,2 @@
+export * from './cost-types.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/types/costs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/types/costs/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAC"}