@surfside/ads-core 2.5.0-3757d11d.0 → 2.5.0-4fcf80fb.0

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

@@ -26,4 +26,4 @@ export type ImpressionRequestBuilder = RequestBuilder & {
     andNative: (request: string | INativeRequest, options?: Partial<INative>) => ImpressionRequestBuilder;
     andProductCards: (nativeBuilder: NativeRequestBuilder, options?: Partial<INative>) => ImpressionRequestBuilder;
 };
-export declare function StartRequest(logger: ILogger | undefined, accountId: string, siteId: string, channelId: string, locationId: string, device: IDevice | undefined, geo: IGeoContext | undefined, userId: string | undefined, generateCategories: MapCategoriesFn, strictCategoryFiltering: boolean | undefined, zoneId: string, id?: string): RequestBuilder;
+export declare function StartRequest(logger: ILogger | undefined, accountId: string, siteId: string, channelId: string, locationId: string, device: IDevice | undefined, geo: IGeoContext | undefined, userId: string | undefined, generateCategories: MapCategoriesFn, strictCategoryFiltering: boolean | undefined, brandTakeoversEnabled: boolean, zoneId: string, id?: string): RequestBuilder;

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

@@ -2,7 +2,7 @@ import { type IBid, type IBidRequest, type ICompiledPublisherConfiguration, type
 import { type AsyncResult, type GetAllSponsoredProductFromNativeIdFn, 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';
+import type { GenerateSponsoredProductCardResponseFn, IBuiltProductCardResponse, NamedTrackers } from './ProductCard';
 export type BuildSponsoredCarouselFn = (request: IBidRequest) => Result<IBuiltCarousel>;
 export type BuildSponsoredCarouselFromInitialBidFn = (request: IBidRequest, initialBid: IBid) => Result<IBuiltCarousel>;
 export type BuildRecommendedCarouselFn = (RecommenderType: PublicRecommenderType, category?: string) => Result<IBuiltCarousel>;
@@ -16,6 +16,7 @@ export interface IBuiltCarousel {
 export interface ISimpleBuiltCarousel {
     type: 'simpleCarousel';
     products: IBuiltProductCardResponse[];
+    trackers: NamedTrackers;
 }
 export type RecommenderType = 'top-products' | 'for-you' | 'past-purchases';
 export interface IPublicTopProductsRecommenderType {

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

@@ -1,5 +1,5 @@
 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 AsyncResult, type GetAllSponsoredProductFromNativeIdFn, type ILogger, type Result } from '../../services';
 import { type ProductTrackerCallback } from '../../services/Tracker';
 import { type IBuiltResponse } from './BuiltResponse';
 export type BuildAllSponsoredProductCardResponsesFn = (bids: IBid[]) => AsyncResult<IBuiltProductCardBidResponse[]>;
@@ -21,6 +21,12 @@ export interface ITracker {
     type: number;
     url: string;
 }
+export type NamedTrackers = {
+    impression: TrackerObject[];
+    viewable?: TrackerObject[];
+    win: TrackerObject[];
+    [_: string]: TrackerObject[] | undefined;
+};
 export interface ITrackerObject {
     /** @deprecated */
     win: string;
@@ -28,7 +34,7 @@ export interface ITrackerObject {
     imp: string[];
     /** @deprecated */
     others: ITracker[];
-    namedTrackers: Record<string, TrackerObject[]>;
+    namedTrackers: NamedTrackers;
 }
 export type IBuiltProductCardBidResponse = IBuiltResponse & IBuiltProductCardResponse & {
     native: INativeResponse;
@@ -40,6 +46,7 @@ export interface IBuiltProductCardResponse {
     trackers?: ITrackerObject;
     clickthrough: string;
     sponsored: boolean;
+    wrapClick: (url: string) => Result<string>;
 }
 export declare const BuildAllSponsoredProductCardResponses: (logger: ILogger | undefined, getAllSponsoredProducts: GetAllSponsoredProductFromNativeIdFn, getAllSponsoredBrandProducts: GetAllSponsoredProductFromNativeIdFn, windowInfo: INativeTemplateDelegateWindow, configuration: ICompiledPublisherConfiguration, bids: IBid[]) => AsyncResult<IBuiltProductCardBidResponse[]>;
 export declare function GenerateSponsoredProductCardResponse(logger: ILogger | undefined, getAllSponsoredProducts: GetAllSponsoredProductFromNativeIdFn, getAllSponsoredBrandProducts: GetAllSponsoredProductFromNativeIdFn, windowInfo: INativeTemplateDelegateWindow, configuration: ICompiledPublisherConfiguration, bids: IBid[]): AsyncGenerator<IBuiltProductCardBidResponse>;
@@ -59,4 +66,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;
+export declare const NamedTrackersToCallbacks: (namedTrackers: NamedTrackers | undefined) => ProductCallbackExtras;

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

@@ -71,11 +71,17 @@ export interface ICompiledPublisherConfigurationSettingsDTO {
     excludedZones?: string[];
     brandTakeover?: Record<string, string[]>;
 }
+/** Sparse per-location branch of config.json: only the compiled keys that location overrides. */
+export interface ILocationConfigurationOverridesDTO {
+    templates?: Partial<ICompiledPublisherConfigurationTemplatesDTO>;
+    settings?: Partial<ICompiledPublisherConfigurationSettingsDTO>;
+}
 export interface ICompiledPublisherConfigurationDTO {
     templates: ICompiledPublisherConfigurationTemplatesDTO;
     settings: ICompiledPublisherConfigurationSettingsDTO;
     category: ICompiledCategoryPublisherConfigurationDTO;
     dynamicZones?: Record<string, IDynamicZone>;
+    locations?: Record<string, ILocationConfigurationOverridesDTO>;
 }
 export interface ILoadedTemplateModules {
     productCardTemplateRaw?: TemplateSpecification;

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

@@ -411,4 +411,9 @@ export interface ISurfExtension {
     publisherConfig?: string;
     bcreatives?: number[];
     bplacements?: number[];
+    sdk?: ISdkInfo;
+}
+export interface ISdkInfo {
+    ver: string;
+    hash: string;
 }

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

@@ -1,4 +1,4 @@
-import type { IBidRequest, IBidResponse, ICompiledPublisherConfiguration, INativeTemplateDelegateWindow } from '../models';
+import type { IBid, IBidRequest, IBidResponse, ICompiledPublisherConfiguration, INativeTemplateDelegateWindow } from '../models';
 import { type ILogger } from './Logger';
 import { type AsyncResult, type ErrResult, type Result } from './Result';
 export type RequestBidsFn = (request: IBidRequest) => AsyncResult<IBidResponse>;
@@ -14,7 +14,10 @@ export declare class StatefulRequestBidsSubscriber {
     kill(err: ErrResult): void;
     debounce(bidRequest: IBidRequest, res: (value: Result<IBidResponse>) => void): void;
 }
+export declare const WrapNativeClick: (bid: IBid, clickthrough: string) => Result<string>;
+export declare const ClickWrapper: (handler: string) => (clickthrough: string) => Result<string>;
 export declare const DebounceBidRequests: (state: StatefulRequestBidsSubscriber) => (bidRequest: IBidRequest) => AsyncResult<IBidResponse>;
+export declare const PageIsBrandTakeover: (logger: ILogger | undefined, config: ICompiledPublisherConfiguration, window: INativeTemplateDelegateWindow) => [false, undefined] | [true, string[]];
 export declare const WrapBidRequestDebouncerIfEnabled: (logger: ILogger | undefined, config: ICompiledPublisherConfiguration, window: INativeTemplateDelegateWindow, requestBids: RequestBidsFn) => RequestBidsFn;
 export declare class NoBidsError extends Error {
     readonly request: IBidRequest;
@@ -45,3 +48,7 @@ export declare class MalformedBidResponseError extends Error {
 export declare class MissingBidRequestInDebouncerError extends Error {
     constructor();
 }
+export declare class MalformedNativeAdmError extends Error {
+    bid: IBid;
+    constructor(bid: IBid);
+}

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

@@ -0,0 +1,6 @@
+import type { ICompiledPublisherConfigurationDTO } from '../models/retail/Configuration';
+/**
+ * Each key present in the location branch replaces the site value whole; the
+ * contract is shared with platform-services and platform-frontend.
+ */
+export declare const ResolveLocationConfiguration: (configuration: ICompiledPublisherConfigurationDTO, locationId: string | undefined) => ICompiledPublisherConfigurationDTO;

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@surfside/ads-core",
-  "version": "2.5.0-3757d11d.0",
+  "version": "2.5.0-4fcf80fb.0",
   "module": "./lib/esm/index.js",
   "main": "./lib/cjs/index.js",
   "types": "./lib/types/index.d.ts",
@@ -43,6 +43,6 @@
     "esm": "tsc -p ./tsconfig.esm.json",
     "cjs": "tsc -p tsconfig.cjs.json",
     "lint": "npx eslint",
-    "test": "jest --config jest.config.cjs"
+    "test": "bun test"
   }
 }