@surfside/ads-core 2.0.17 → 2.0.19

package/lib/esm/services/Tracker.js

@@ -0,0 +1,67 @@
+import { Ctx } from './Logger';
+export const InitTrackerService = (logger, accountId, siteId, locationId, channelId, windowInfo, userAgent, geo, device, userId, host) => {
+    const initTracker = (path, eventName) => (product) => async (context) => {
+        const log = Ctx(logger)?.with('recommended tracker').with(eventName);
+        try {
+            log?.info('Calling event tracker');
+            const url = new URL(`${windowInfo.protocol}//${host}/${path}`);
+            url.searchParams.set('location_id', locationId);
+            url.searchParams.set('item_id', product.id ?? 'undefined');
+            url.searchParams.set('next_type', context?.nextType ?? 'page');
+            url.searchParams.set('recommendation_model', context?.recommend ?? 'top-products');
+            url.searchParams.set('recommendation_page', String(context?.page ?? 1));
+            url.searchParams.set('recommendation_position_absolute', String(context?.positionAbsolute ?? 1));
+            url.searchParams.set('recommendation_position_relative', String(context?.positionRelative ?? 1));
+            url.searchParams.set('recommendation_value', String(context?.recommendationValue ?? 1));
+            url.searchParams.set('strategy', context?.strategy ?? 'hybrid');
+            url.searchParams.set('zone_id', context?.zoneId ?? 'undefined');
+            url.searchParams.set('account_id', accountId);
+            url.searchParams.set('event_name', eventName);
+            if (geo !== undefined) {
+                url.searchParams.set('geo_city', geo.city);
+                url.searchParams.set('geo_country', geo.country);
+                url.searchParams.set('geo_metro', geo.city);
+                url.searchParams.set('geo_region', geo.region);
+                url.searchParams.set('geo_utcoffset', String(geo.utcoffset));
+                url.searchParams.set('geo_zip', geo.zip);
+                url.searchParams.set('ip', geo.ip);
+                url.searchParams.set('lat', String(geo.coords.latitude));
+                url.searchParams.set('lon', String(geo.coords.longitude));
+            }
+            url.searchParams.set('isp', 'undefined');
+            if (device !== undefined) {
+                url.searchParams.set('device_type', String(device.devicetype));
+                url.searchParams.set('make', device.make ?? 'undefined');
+                url.searchParams.set('model', device.model ?? 'undefined');
+                url.searchParams.set('os', device.os ?? 'undefined');
+                url.searchParams.set('osv', device.osv ?? 'undefined');
+            }
+            url.searchParams.set('pub_bundle', windowInfo.host);
+            url.searchParams.set('pub_channel_id', channelId);
+            url.searchParams.set('pub_domain', windowInfo.host);
+            url.searchParams.set('pub_id', siteId);
+            url.searchParams.set('pub_name', windowInfo.host);
+            url.searchParams.set('pub_site_id', siteId);
+            url.searchParams.set('pub_store_id', locationId);
+            url.searchParams.set('pub_zone', context?.zoneId ?? 'undefined');
+            url.searchParams.set('ua', userAgent);
+            if (userId !== undefined) {
+                url.searchParams.set('user_id', userId ?? 'undefined');
+            }
+            const finalUrl = url.toString();
+            log?.debug(finalUrl);
+            await fetch(url);
+        }
+        catch (e) {
+            log?.error('Failed to call tracker. Got', e);
+        }
+    };
+    return {
+        recommended: {
+            getClickTracker: initTracker('rec/clk', 'click'),
+            getImpressionTracker: initTracker('rec/imp', 'imp'),
+            getAddToCartTracker: initTracker('rec/atc', 'atc')
+        }
+    };
+};
+//# sourceMappingURL=Tracker.js.map

package/lib/esm/services/Tracker.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Tracker.js","sourceRoot":"src/","sources":["services/Tracker.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,GAAG,EAAgB,MAAM,UAAU,CAAC;AAwC7C,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAC9B,MAA2B,EAC3B,SAAiB,EACjB,MAAc,EACd,UAAkB,EAClB,SAAiB,EACjB,UAAyC,EACzC,SAAiB,EACjB,GAA4B,EAC5B,MAA2B,EAC3B,MAA0B,EAC1B,IAAY,EACU,EAAE;IACxB,MAAM,WAAW,GAAG,CAAC,IAAY,EAAE,SAAiB,EAAE,EAAE,CACpD,CAAC,OAA4B,EAAE,EAAE,CAC7B,KAAK,EAAE,OAA0B,EAAE,EAAE;QACjC,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QAErE,IAAI,CAAC;YACD,GAAG,EAAE,IAAI,CAAC,uBAAuB,CAAC,CAAC;YACnC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,UAAU,CAAC,QAAQ,KAAK,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC;YAE/D,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;YAChD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,IAAI,WAAW,CAAC,CAAC;YAC3D,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,OAAO,EAAE,QAAQ,IAAI,MAAM,CAAC,CAAC;YAC/D,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,sBAAsB,EAAE,OAAO,EAAE,SAAS,IAAI,cAAc,CAAC,CAAC;YACnF,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,qBAAqB,EAAE,MAAM,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;YACxE,GAAG,CAAC,YAAY,CAAC,GAAG,CAChB,kCAAkC,EAClC,MAAM,CAAC,OAAO,EAAE,gBAAgB,IAAI,CAAC,CAAC,CACzC,CAAC;YACF,GAAG,CAAC,YAAY,CAAC,GAAG,CAChB,kCAAkC,EAClC,MAAM,CAAC,OAAO,EAAE,gBAAgB,IAAI,CAAC,CAAC,CACzC,CAAC;YACF,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,sBAAsB,EAAE,MAAM,CAAC,OAAO,EAAE,mBAAmB,IAAI,CAAC,CAAC,CAAC,CAAC;YACxF,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,EAAE,QAAQ,IAAI,QAAQ,CAAC,CAAC;YAChE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,IAAI,WAAW,CAAC,CAAC;YAChE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;YAC9C,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;YAC9C,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;gBACpB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC3C,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,EAAE,GAAG,CAAC,OAAO,CAAC,CAAC;gBACjD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;gBAC5C,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;gBAC/C,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,eAAe,EAAE,MAAM,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;gBAC7D,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;gBACzC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC;gBACnC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACzD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC;YAC9D,CAAC;YACD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;YACzC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACvB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,CAAC;gBAC/D,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,IAAI,WAAW,CAAC,CAAC;gBACzD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,MAAM,CAAC,KAAK,IAAI,WAAW,CAAC,CAAC;gBAC3D,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,IAAI,WAAW,CAAC,CAAC;gBACrD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,GAAG,IAAI,WAAW,CAAC,CAAC;YAC3D,CAAC;YACD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YACpD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,gBAAgB,EAAE,SAAS,CAAC,CAAC;YAClD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YACpD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YACvC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,UAAU,CAAC,IAAI,CAAC,CAAC;YAClD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;YAC5C,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,cAAc,EAAE,UAAU,CAAC,CAAC;YACjD,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,EAAE,MAAM,IAAI,WAAW,CAAC,CAAC;YACjE,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YACtC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;gBACvB,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,SAAS,EAAE,MAAM,IAAI,WAAW,CAAC,CAAC;YAC3D,CAAC;YACD,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,EAAE,CAAC;YAChC,GAAG,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;YAErB,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,GAAG,EAAE,KAAK,CAAC,6BAA6B,EAAE,CAAC,CAAC,CAAC;QACjD,CAAC;IACL,CAAC,CAAC;IACV,OAAO;QACH,WAAW,EAAE;YACT,eAAe,EAAE,WAAW,CAAC,SAAS,EAAE,OAAO,CAAC;YAChD,oBAAoB,EAAE,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC;YACnD,mBAAmB,EAAE,WAAW,CAAC,SAAS,EAAE,KAAK,CAAC;SACrD;KACJ,CAAC;AACN,CAAC,CAAC"}

package/lib/esm/services/index.js

@@ -9,4 +9,5 @@ export * from './Recommender';
 export * from './Memo';
 export * from './Template';
 export * from './Dynamic';
+export * from './Tracker';
 //# sourceMappingURL=index.js.map

package/lib/esm/services/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"src/","sources":["services/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"src/","sources":["services/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC"}

package/lib/types/Api.d.ts

@@ -6,6 +6,7 @@ import { type BuildHybridCarouselFn, type BuildHybridCarouselFromInitialBidFn, t
 import { type EvaluateClickthroughTemplateFn, type EvaluateProductCardTemplateFn } from './services/Template';
 import { type BuildDynamicZoneRequestFn, type GetDynamicZoneFn } from './services/Dynamic';
 import { type GenerateCategoriesFn } from './services/Category';
+import { type InitTrackerServiceFn, type IProductTrackerService } from './services/Tracker';
 export declare const PROD_BIDDER = "//bid.surfside.io/rtb/bids/surfside";
 export declare const PROD_CONFIGURATION_SERVICE = "//r.surfside.io";
 export declare const PROD_SPONSORED_PRODUCT_FEED = "//creative.surfside.io";
@@ -48,6 +49,11 @@ export interface ISurfsideApi {
      * Generates categories for the site
      */
     generateCategories: GenerateCategoriesFn;
+    /**
+     * Creates a set of trackers from a product input. Builds a URL with all relevant info from the trackers
+     * and returns functions to call when the relevant events fire
+     */
+    trackers: IProductTrackerService;
     /**
      * A handlebars runtime instance, for evaluating templates
      */
@@ -145,6 +151,7 @@ export declare function InitSurfAdsCoreInternal(internalApiDto: {
     generateSponsoredProductCardResponse: GenerateSponsoredProductCardResponseFn;
     evaluateProductCardTemplate: EvaluateProductCardTemplateFn;
     evaluateClickthroughTemplate: EvaluateClickthroughTemplateFn;
+    initTrackerService: InitTrackerServiceFn;
     handlebars: typeof Handlebars;
     windowInfo: INativeTemplateDelegateWindow;
     screenInfo: IScreen;
@@ -158,7 +165,7 @@ export declare function InitSurfAdsCoreInternal(internalApiDto: {
     locationId: string;
     userId: string | undefined;
 }): AsyncResult<ISurfsideApi>;
-export declare const InitSurfAdsCoreServices: (logger: ILogger | undefined, bidderServiceUrl: string, configurationServiceUrl: string, productFeedUrl: string, recommendedProductFeedUrl: string, recommenderServiceUrl: string, dynamicZoneServiceUrl: string, windowInfo: INativeTemplateDelegateWindow, screenInfo: IScreen, navigator: INavigator, mobile: boolean, ip: string | undefined, geoProviderToken: string | undefined, accountId: string, siteId: string, channelId: string, locationId: string, userId: string | undefined) => AsyncResult<ISurfsideApi>;
+export declare const InitSurfAdsCoreServices: (logger: ILogger | undefined, bidderServiceUrl: string, configurationServiceUrl: string, productFeedUrl: string, recommendedProductFeedUrl: string, recommenderServiceUrl: string, dynamicZoneServiceUrl: string, windowInfo: INativeTemplateDelegateWindow, screenInfo: IScreen, navigator: INavigator, mobile: boolean, ip: string | undefined, geoProviderToken: string | undefined, accountId: string, siteId: string, channelId: string, locationId: string, userId: string | undefined, initTrackerService?: InitTrackerServiceFn) => AsyncResult<ISurfsideApi>;
 export declare const InitSurfAdsCoreSSR: (windowInfo: INativeTemplateDelegateWindow, screen: IScreen, navigator: INavigator, mobile: boolean, ip: string, geoProviderToken: string, accountId: string, siteId: string, channelId: string, locationId: string, userId: string | undefined, logger?: ILogger) => AsyncResult<ISurfsideApi>;
 export declare const InitSurfAdsCore: (channelId: string, accountId: string, siteId: string, locationId: string, userId: string | undefined, logger?: ILogger) => AsyncResult<ISurfsideApi>;
 export declare class MissingConfigurationError extends Error {

package/lib/types/helpers/Functions.d.ts

@@ -0,0 +1,2 @@
+export declare const Nothing: () => undefined;
+export declare const AsyncNothing: () => Promise<undefined>;

package/lib/types/helpers/index.d.ts

@@ -5,3 +5,4 @@ export * from './Handlebars';
 export * from './TryGet';
 export * from './Window';
 export * from './Generator';
+export * from './Functions';

package/lib/types/helpers/response/Carousel.d.ts

@@ -1,6 +1,7 @@
-import type { IBid, IBidRequest } from '../../models';
+import { type IBid, type IBidRequest } from '../../models';
 import { type ILogger, type NonPersonalRecommenderFn, type PersonalRecommenderFn, type RequestBidsFn, type Result } from '../../services';
 import { type EvaluateClickthroughTemplateFn } from '../../services/Template';
+import { type IProductTrackerService } from '../../services/Tracker';
 import type { GenerateSponsoredProductCardResponseFn, IBuiltProductCardResponse } from './ProductCard';
 export type BuildSponsoredCarouselFn = (request: IBidRequest) => Result<IBuiltCarousel>;
 export type BuildSponsoredCarouselFromInitialBidFn = (request: IBidRequest, initialBid: IBid) => Result<IBuiltCarousel>;
@@ -42,9 +43,9 @@ export interface IPastPurchasesProductRecommender {
 export type ProductRecommender = ITopProductRecommender | IForYouProductRecommender | IPastPurchasesProductRecommender;
 export declare const BuildSponsoredCarousel: (logger: ILogger | undefined, requestBids: RequestBidsFn, generateProductCardResponse: GenerateSponsoredProductCardResponseFn, request: IBidRequest) => Result<IBuiltCarousel>;
 export declare const BuildSponsoredCarouselFromInitialBid: (logger: ILogger | undefined, requestBids: RequestBidsFn, generateProductCardResponse: GenerateSponsoredProductCardResponseFn, request: IBidRequest, initialBid: IBid) => Result<IBuiltCarousel>;
-export declare const BuildRecommendedCarousel: (logger: ILogger | undefined, evaluateClickthroughTemplate: EvaluateClickthroughTemplateFn, topProductGenerator: NonPersonalRecommenderFn, forYouProductGenerator: PersonalRecommenderFn, pastPurchasesProductGenerator: PersonalRecommenderFn, userId: string | undefined, recommenderType: PublicRecommenderType) => Result<IBuiltCarousel>;
-export declare const BuildHybridCarousel: (logger: ILogger | undefined, evaluateClickthroughTemplate: EvaluateClickthroughTemplateFn, requestBids: RequestBidsFn, generateProductCardResponse: GenerateSponsoredProductCardResponseFn, topProductGenerator: NonPersonalRecommenderFn, forYouProductGenerator: PersonalRecommenderFn, pastPurchasesProductGenerator: PersonalRecommenderFn, userId: string | undefined, recommenderType: PublicRecommenderType, request: IBidRequest) => Result<IBuiltCarousel>;
-export declare const BuildHybridCarouselFromInitialBid: (logger: ILogger | undefined, evaluateClickthroughTemplate: EvaluateClickthroughTemplateFn, requestBids: RequestBidsFn, generateProductCardResponse: GenerateSponsoredProductCardResponseFn, topProductGenerator: NonPersonalRecommenderFn, forYouProductGenerator: PersonalRecommenderFn, pastPurchasesProductGenerator: PersonalRecommenderFn, userId: string | undefined, recommenderType: PublicRecommenderType, request: IBidRequest, initialBid: IBid) => Result<IBuiltCarousel>;
+export declare const BuildRecommendedCarousel: (logger: ILogger | undefined, evaluateClickthroughTemplate: EvaluateClickthroughTemplateFn, topProductGenerator: NonPersonalRecommenderFn, forYouProductGenerator: PersonalRecommenderFn, pastPurchasesProductGenerator: PersonalRecommenderFn, userId: string | undefined, trackers: IProductTrackerService, recommenderType: PublicRecommenderType) => Result<IBuiltCarousel>;
+export declare const BuildHybridCarousel: (logger: ILogger | undefined, evaluateClickthroughTemplate: EvaluateClickthroughTemplateFn, requestBids: RequestBidsFn, generateProductCardResponse: GenerateSponsoredProductCardResponseFn, topProductGenerator: NonPersonalRecommenderFn, forYouProductGenerator: PersonalRecommenderFn, pastPurchasesProductGenerator: PersonalRecommenderFn, userId: string | undefined, trackers: IProductTrackerService, recommenderType: PublicRecommenderType, request: IBidRequest) => Result<IBuiltCarousel>;
+export declare const BuildHybridCarouselFromInitialBid: (logger: ILogger | undefined, evaluateClickthroughTemplate: EvaluateClickthroughTemplateFn, requestBids: RequestBidsFn, generateProductCardResponse: GenerateSponsoredProductCardResponseFn, topProductGenerator: NonPersonalRecommenderFn, forYouProductGenerator: PersonalRecommenderFn, pastPurchasesProductGenerator: PersonalRecommenderFn, userId: string | undefined, trackers: IProductTrackerService, recommenderType: PublicRecommenderType, request: IBidRequest, initialBid: IBid) => Result<IBuiltCarousel>;
 export declare class InvalidRecommenderTypeError extends Error {
     type: string;
     constructor(type: string);

package/lib/types/helpers/response/ProductCard.d.ts

@@ -1,22 +1,34 @@
-import { type IBid, type ICompiledPublisherConfiguration, type INativeResponse, type INativeTemplateDelegateWindow, type IProductInformation } from '../../models';
+import { type IBid, type ICompiledPublisherConfiguration, type INativeResponse, type INativeTemplateDelegateWindow, type IProductInformation, type ProductCallbackExtras } from '../../models';
 import { type AsyncResult, type GetAllSponsoredProductFromNativeIdFn, type ILogger } from '../../services';
+import { type ProductTrackerCallback } from '../../services/Tracker';
 import { type IBuiltResponse } from './BuiltResponse';
 export type BuildAllSponsoredProductCardResponsesFn = (bids: IBid[]) => AsyncResult<IBuiltProductCardBidResponse[]>;
 export type GenerateSponsoredProductCardResponseFn = (bids: IBid[]) => AsyncGenerator<IBuiltProductCardBidResponse>;
-export interface ITracker {
-    type: number;
+export interface IPixelTracker {
+    type: 'pixel';
     url: string;
 }
-export interface IPixelTracker extends ITracker {
-    type: 1;
+export interface IScriptTracker {
+    type: 'script';
+    src: string;
+}
+export interface ICallbackTracker {
+    type: 'callback';
+    callback: ProductTrackerCallback;
 }
-export interface IScriptTracker extends ITracker {
-    type: 2;
+export type TrackerObject = IPixelTracker | IScriptTracker | ICallbackTracker;
+export interface ITracker {
+    type: number;
+    url: string;
 }
 export interface ITrackerObject {
+    /** @deprecated */
     win: string;
+    /** @deprecated */
     imp: string[];
+    /** @deprecated */
     others: ITracker[];
+    namedTrackers: Record<string, TrackerObject[]>;
 }
 export type IBuiltProductCardBidResponse = IBuiltResponse & IBuiltProductCardResponse & {
     native: INativeResponse;
@@ -47,3 +59,4 @@ export declare class MissingProductIdError extends Error {
     readonly native: INativeResponse;
     constructor(bid: IBid, native: INativeResponse);
 }
+export declare const NamedTrackersToCallbacks: (namedTrackers: Record<string, TrackerObject[]> | undefined) => ProductCallbackExtras;

package/lib/types/models/retail/Configuration.d.ts

@@ -1,6 +1,15 @@
 import type { IDynamicZone, IProductInformation } from '../../models';
 import type { ICompiledCategoryPublisherConfiguration, ICompiledCategoryPublisherConfigurationDTO } from './Category';
-export type ProductCallback = (e: Event, product: IProductInformation) => void;
+export type TrackerCallback = () => Promise<void>;
+export type ProductCallbackExtras = {
+    trackers: {
+        addToCart: TrackerCallback;
+        imp: TrackerCallback;
+        click: TrackerCallback;
+        [key: string]: TrackerCallback;
+    };
+};
+export type ProductCallback = (e: Event, product: IProductInformation, extras: ProductCallbackExtras) => void;
 export type Callbacks = Record<string, ProductCallback>;
 export type TemplateDelegate = (context: IProductContext) => string;
 export interface INativeTemplateDelegateWindow {
@@ -55,6 +64,7 @@ export interface ICompiledPublisherConfigurationSettingsDTO {
     productFeedEnabled: boolean;
     sponsoredByEnabled?: boolean;
     defaultImage?: string;
+    strictCategoryMatching?: boolean;
 }
 export interface ICompiledPublisherConfigurationDTO {
     templates: ICompiledPublisherConfigurationTemplatesDTO;
@@ -68,3 +78,4 @@ export interface ICompiledPublisherConfiguration {
     category: ICompiledCategoryPublisherConfiguration;
     dynamicZones?: Record<string, IDynamicZone>;
 }
+export declare const DefaultProductCallbackExtras: () => ProductCallbackExtras;

package/lib/types/models/rtb/BidResponse.d.ts

@@ -1,5 +1,6 @@
 export interface IBidExtensions extends Record<string, any> {
     primaryCategory?: string;
+    originalCategories?: string[];
 }
 export interface IBid {
     id: string;

package/lib/types/models/rtb/NativeRequest.d.ts

@@ -67,6 +67,8 @@ export declare const EventTypes: {
     readonly ViewableMRC50: 2;
     readonly ViewableMRC100: 3;
     readonly ViewableVIDEO50: 4;
+    readonly Click: 500;
+    readonly AddToCart: 501;
 };
 /**
  * The context of the page for the native ad unit, i.e what type of content is being displayed

package/lib/types/services/Tracker.d.ts

@@ -0,0 +1,25 @@
+import type { RecommenderType } from '../helpers';
+import type { IDevice, IGeoContext, INativeTemplateDelegateWindow, IProductInformation } from '../models';
+import { type ILogger } from './Logger';
+export interface ICarouselContext {
+    nextType: 'page' | 'product';
+    recommend: RecommenderType;
+    strategy: 'sponsored' | 'hybrid' | 'recommended';
+    page?: number;
+    positionAbsolute?: number;
+    positionRelative?: number;
+    recommendationValue: number;
+    zoneId: string;
+}
+export type ProductTrackerCallback = (context?: ICarouselContext) => Promise<void>;
+export type ProductTrackerInitializer = (product: IProductInformation) => ProductTrackerCallback;
+export interface IRecommendedTrackerService {
+    getClickTracker: ProductTrackerInitializer;
+    getAddToCartTracker: ProductTrackerInitializer;
+    getImpressionTracker: ProductTrackerInitializer;
+}
+export interface IProductTrackerService {
+    recommended: IRecommendedTrackerService;
+}
+export type InitTrackerServiceFn = (logger: ILogger | undefined, accountId: string, siteId: string, locationId: string, channelId: string, windowInfo: INativeTemplateDelegateWindow, userAgent: string, geo: IGeoContext | undefined, device: IDevice | undefined, userId: string | undefined, host: string) => IProductTrackerService;
+export declare const InitTrackerService: (logger: ILogger | undefined, accountId: string, siteId: string, locationId: string, channelId: string, windowInfo: INativeTemplateDelegateWindow, userAgent: string, geo: IGeoContext | undefined, device: IDevice | undefined, userId: string | undefined, host: string) => IProductTrackerService;

package/lib/types/services/index.d.ts

@@ -9,3 +9,4 @@ export * from './Recommender';
 export * from './Memo';
 export * from './Template';
 export * from './Dynamic';
+export * from './Tracker';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@surfside/ads-core",
-  "version": "2.0.17",
+  "version": "2.0.19",
   "module": "./lib/esm/index.js",
   "main": "./lib/cjs/index.js",
   "types": "./lib/types/index.d.ts",