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

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

@@ -0,0 +1,135 @@
+export declare enum COST_TYPE {
+    PRODUCT = "product",
+    SHIPPING = "shipping",
+    VARIABLE = "variable",
+    FIXED = "fixed",
+    DEFAULT_COGS = "default"
+}
+export declare enum COST_SUB_TYPE {
+    FLAT = "flat",
+    PERCENTAGE = "percentage"
+}
+export declare enum COST_SOURCE {
+    SHOPIFY = "shopify",
+    MANUAL = "manual",
+    USER = "user"
+}
+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_SALES = "pct_sales",
+    PCT_COGS = "pct_cogs",
+    PCT_AD_SPEND = "pct_ad_spend",
+    PCT_SHIPPING = "pct_shipping",
+    PCT_GROSS_SALES = "pct_gross_sales",
+    BY_WEIGHT = "by_weight",
+    BY_QUANTITY = "by_quantity"
+}
+export declare enum FIXED_COST_FREQUENCY {
+    DAILY = "daily",
+    WEEKLY = "weekly",
+    MONTHLY = "monthly",
+    YEARLY = "yearly"
+}
+export declare enum VARIABLE_COST_CATEGORY {
+    SHIPPING = "shipping",
+    PAYMENT_FEES = "payment_fees",
+    PACKAGING = "packaging",
+    RETURNS = "returns",
+    FULFILLMENT = "fulfillment",
+    OTHER = "other"
+}
+export declare enum FIXED_COST_CATEGORY {
+    RENT = "rent",
+    SALARIES = "salaries",
+    SOFTWARE = "software",
+    UTILITIES = "utilities",
+    INSURANCE = "insurance",
+    OTHER = "other"
+}
+export declare enum COST_CHANNEL {
+    ONLINE = "online",
+    POS = "pos",
+    BOTH = "both"
+}
+export interface VariableCostFilters {
+    shippingTitleContains?: string;
+    skipShopifyPayments?: boolean;
+    paymentGateway?: string;
+    countries?: string[];
+}
+export interface ProductCostHistoryRecord {
+    id: string;
+    isCurrent: boolean;
+    costType: COST_TYPE;
+    costSource: COST_SOURCE;
+    price?: number;
+    cost?: number;
+    effectiveStartDate: string;
+    effectiveEndDate: string | null;
+    description: string;
+}
+export interface GenericCostRecord {
+    pk: string;
+    sk?: string;
+    entityType: string;
+    entityId: string;
+    pixelId: string;
+    shopifyAppInstallId: string;
+    costType: COST_TYPE;
+    costSubType: COST_SUB_TYPE;
+    costSource: COST_SOURCE;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface ProductCostRecord extends GenericCostRecord {
+    entityType: 'product_cost';
+    costType: COST_TYPE.PRODUCT;
+    productId: string;
+    variantId: string;
+    sku: string;
+    productTitle: string;
+    variantTitle: string;
+    imageUrls: string[];
+    currentPrice?: number;
+    currentCost?: number;
+    currency: string;
+    costHistory: ProductCostHistoryRecord[];
+}
+export interface VariableCostRecord extends GenericCostRecord {
+    entityType: 'variable_cost';
+    costType: COST_TYPE.VARIABLE;
+    costSource: COST_SOURCE.USER;
+    name: string;
+    variableType: VARIABLE_COST_TYPE;
+    amount: number;
+    channel: COST_CHANNEL;
+    category: VARIABLE_COST_CATEGORY;
+    effectiveFrom: string;
+    effectiveTo?: string;
+    filters?: VariableCostFilters;
+}
+export interface FixedCostRecord extends GenericCostRecord {
+    entityType: 'fixed_cost';
+    costType: COST_TYPE.FIXED;
+    costSource: COST_SOURCE.USER;
+    name: string;
+    amount: number;
+    frequency: FIXED_COST_FREQUENCY;
+    channel: COST_CHANNEL;
+    category: FIXED_COST_CATEGORY;
+    effectiveFrom: string;
+    effectiveTo?: string;
+}
+export interface DefaultCogsRecord extends GenericCostRecord {
+    entityType: 'default_cogs';
+    costType: COST_TYPE.DEFAULT_COGS;
+    costSubType: COST_SUB_TYPE.PERCENTAGE;
+    costSource: COST_SOURCE.USER;
+    amount: number;
+    effectiveFrom: string;
+    effectiveTo?: string;
+}
+export declare type CostRecord = ProductCostRecord | VariableCostRecord | FixedCostRecord | DefaultCogsRecord;

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

@@ -0,0 +1,65 @@
+export var COST_TYPE;
+(function (COST_TYPE) {
+    COST_TYPE["PRODUCT"] = "product";
+    COST_TYPE["SHIPPING"] = "shipping";
+    COST_TYPE["VARIABLE"] = "variable";
+    COST_TYPE["FIXED"] = "fixed";
+    COST_TYPE["DEFAULT_COGS"] = "default";
+})(COST_TYPE || (COST_TYPE = {}));
+export var COST_SUB_TYPE;
+(function (COST_SUB_TYPE) {
+    COST_SUB_TYPE["FLAT"] = "flat";
+    COST_SUB_TYPE["PERCENTAGE"] = "percentage";
+})(COST_SUB_TYPE || (COST_SUB_TYPE = {}));
+export var COST_SOURCE;
+(function (COST_SOURCE) {
+    COST_SOURCE["SHOPIFY"] = "shopify";
+    COST_SOURCE["MANUAL"] = "manual";
+    COST_SOURCE["USER"] = "user";
+})(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_SALES"] = "pct_sales";
+    VARIABLE_COST_TYPE["PCT_COGS"] = "pct_cogs";
+    VARIABLE_COST_TYPE["PCT_AD_SPEND"] = "pct_ad_spend";
+    VARIABLE_COST_TYPE["PCT_SHIPPING"] = "pct_shipping";
+    VARIABLE_COST_TYPE["PCT_GROSS_SALES"] = "pct_gross_sales";
+    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["YEARLY"] = "yearly";
+})(FIXED_COST_FREQUENCY || (FIXED_COST_FREQUENCY = {}));
+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["RETURNS"] = "returns";
+    VARIABLE_COST_CATEGORY["FULFILLMENT"] = "fulfillment";
+    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_CHANNEL;
+(function (COST_CHANNEL) {
+    COST_CHANNEL["ONLINE"] = "online";
+    COST_CHANNEL["POS"] = "pos";
+    COST_CHANNEL["BOTH"] = "both";
+})(COST_CHANNEL || (COST_CHANNEL = {}));
+//# 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":"AAAA,MAAM,CAAN,IAAY,SAMX;AAND,WAAY,SAAS;IACnB,gCAAmB,CAAA;IACnB,kCAAqB,CAAA;IACrB,kCAAqB,CAAA;IACrB,4BAAe,CAAA;IACf,qCAAwB,CAAA;AAC1B,CAAC,EANW,SAAS,KAAT,SAAS,QAMpB;AAED,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,8BAAa,CAAA;IACb,0CAAyB,CAAA;AAC3B,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAED,MAAM,CAAN,IAAY,WAIX;AAJD,WAAY,WAAW;IACrB,kCAAmB,CAAA;IACnB,gCAAiB,CAAA;IACjB,4BAAa,CAAA;AACf,CAAC,EAJW,WAAW,KAAX,WAAW,QAItB;AAED,MAAM,CAAN,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,KAAlB,kBAAkB,QAY7B;AAED,MAAM,CAAN,IAAY,oBAKX;AALD,WAAY,oBAAoB;IAC9B,uCAAe,CAAA;IACf,yCAAiB,CAAA;IACjB,2CAAmB,CAAA;IACnB,yCAAiB,CAAA;AACnB,CAAC,EALW,oBAAoB,KAApB,oBAAoB,QAK/B;AAED,MAAM,CAAN,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,KAAtB,sBAAsB,QAOjC;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;AAED,MAAM,CAAN,IAAY,YAIX;AAJD,WAAY,YAAY;IACtB,iCAAiB,CAAA;IACjB,2BAAW,CAAA;IACX,6BAAa,CAAA;AACf,CAAC,EAJW,YAAY,KAAZ,YAAY,QAIvB"}

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"}

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

@@ -1,5 +1,6 @@
 export * from './api/index.js';
 export * from './common/index.js';
+export * from './costs/index.js';
 export * from './event/index.js';
 export * from './event-bus-event.js';
 export * from './third-party-event-configuration-types.js';

package/dist/esm/types/index.js

@@ -1,5 +1,6 @@
 export * from './api/index.js';
 export * from './common/index.js';
+export * from './costs/index.js';
 export * from './event/index.js';
 export * from './event-bus-event.js';
 export * from './third-party-event-configuration-types.js';

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,4CAA4C,CAAC;AAC3D,cAAc,wBAAwB,CAAC;AACvC,cAAc,oCAAoC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/types/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,4CAA4C,CAAC;AAC3D,cAAc,wBAAwB,CAAC;AACvC,cAAc,oCAAoC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adtrackify/at-tracking-event-types",
-  "version": "4.17.1",
+  "version": "4.17.3",
   "description": "",
   "files": [
     "dist/*"