@surfside/ads-core 2.0.1 → 2.0.2

package/lib/types/services/tracking/device/DeviceOverrideService.d.ts

@@ -1,8 +0,0 @@
-import { OverrideService } from '../../../services/OverrideService';
-import type { IDevice } from '../../../models';
-import { type IDeviceService, type ILoggerService } from '../../../services';
-export declare class DeviceOverrideService extends OverrideService<IDevice> implements IDeviceService {
-    constructor(logger?: ILoggerService);
-    getDeviceInfo(): Promise<IDevice | null>;
-    mapDataSetToData(dataset: DOMStringMap): IDevice | null;
-}

package/lib/types/services/tracking/device/IDeviceService.d.ts

@@ -1,4 +0,0 @@
-import type { IDevice } from '../../../models';
-export interface IDeviceService {
-    getDeviceInfo: () => Promise<IDevice | null>;
-}

package/lib/types/services/tracking/device/SurfsideDeviceService.d.ts

@@ -1,16 +0,0 @@
-import type { ILoggerService } from '../../logger';
-import { DeviceOverrideService } from './DeviceOverrideService';
-import { type IBrandVersion, type IDevice } from '../../../models';
-interface IDeviceContext {
-    make?: string;
-    model?: string;
-    os?: string;
-    osv?: string;
-    browser?: IBrandVersion;
-}
-export declare class SurfsideDeviceService extends DeviceOverrideService {
-    constructor(logger?: ILoggerService);
-    getDeviceInfo(): Promise<IDevice | null>;
-}
-export declare function TryGetDeviceInfo(): IDeviceContext | null;
-export {};

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

@@ -1,3 +0,0 @@
-export * from './IDeviceService';
-export * from './DeviceOverrideService';
-export * from './SurfsideDeviceService';

package/lib/types/services/tracking/events/IEventService.d.ts

@@ -1,5 +0,0 @@
-import type { IBidRequest, IBidResponse } from '../../../models';
-export interface IEventService {
-    raiseBidRequested: (request: IBidRequest) => Promise<void>;
-    raiseBidResponded: (response: IBidResponse, request: IBidRequest) => Promise<void>;
-}

package/lib/types/services/tracking/events/SurfsideEventService.d.ts

@@ -1,42 +0,0 @@
-import type { IBidRequest, IBidResponse } from '../../../models';
-import type { IEventService, ILoggerService } from '../../../services';
-interface ISurfTrackerOptions {
-    appId: string;
-    cookieName: string;
-    collectorUrl: string;
-    discoverRootDomain: boolean;
-    cookieSameSite: string;
-}
-type SurfTrack = (action: string, ...args: any[]) => void;
-interface ISurfTracker extends SurfTrack {
-    q?: any[];
-}
-declare global {
-    interface Window {
-        surf: ISurfTracker;
-        surfContext: any[];
-    }
-}
-export interface ISurfsideEventServiceLazyLoadConfig extends Partial<ISurfTrackerOptions> {
-    lazyLoad: true;
-    src: string;
-}
-export interface ISurfsideEventServiceDefaultConfig extends Partial<ISurfTrackerOptions> {
-    lazyLoad: false;
-}
-/**
- * The surfside event service. This service is responsible for tracking events. It converts
- * bid requests and responses to legacy snowplow/prebidJS style events and sends them to the
- * surfside tracker.
- */
-export declare class SurfsideEventService implements IEventService {
-    private readonly _logger?;
-    private _surf;
-    private readonly _appId;
-    private readonly _collectorUrl;
-    private readonly _src?;
-    constructor(config?: ISurfsideEventServiceLazyLoadConfig | ISurfsideEventServiceDefaultConfig, _logger?: ILoggerService | undefined);
-    raiseBidRequested(request: IBidRequest): Promise<void>;
-    raiseBidResponded(response: IBidResponse, request: IBidRequest): Promise<void>;
-}
-export {};

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

@@ -1,2 +0,0 @@
-export * from './IEventService';
-export * from './SurfsideEventService';

package/lib/types/services/tracking/geo/GeoOverrideService.d.ts

@@ -1,8 +0,0 @@
-import { OverrideService } from '../../../services/OverrideService';
-import type { IGeoContext } from '../../../models';
-import { type IGeoService, type ILoggerService } from '../../../services';
-export declare class GeoOverrideService extends OverrideService<IGeoContext> implements IGeoService {
-    constructor(logger?: ILoggerService);
-    mapDataSetToData(dataset: DOMStringMap): IGeoContext | null;
-    getGeo(): Promise<IGeoContext | null>;
-}

package/lib/types/services/tracking/geo/IGeoService.d.ts

@@ -1,12 +0,0 @@
-import type { IGeoContext } from '../../../models';
-/**
- * The geo service interface. Returns the geo context for the user, as well as the IP address of the user.
- * This is useful for targeting ads based on the user's location, and is added to the "device" object in the bid request
- */
-export interface IGeoService {
-    /**
-     * Gets the geo context for the user, including the user's location and IP address
-     * @returns The geo context, or null if the geo context could not be retrieved
-     */
-    getGeo: () => Promise<IGeoContext | null>;
-}

package/lib/types/services/tracking/geo/SurfsideGeoService.d.ts

@@ -1,7 +0,0 @@
-import type { IGeoContext } from '../../../models';
-import type { ILoggerService } from '../../../services';
-import { GeoOverrideService } from './GeoOverrideService';
-export declare class SurfsideGeoService extends GeoOverrideService {
-    constructor(logger?: ILoggerService);
-    getGeo(): Promise<IGeoContext | null>;
-}

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

@@ -1,3 +0,0 @@
-export * from './IGeoService';
-export * from './SurfsideGeoService';
-export * from './GeoOverrideService';

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

@@ -1,4 +0,0 @@
-export * from './geo';
-export * from './user';
-export * from './events';
-export * from './device';

package/lib/types/services/tracking/user/IUserIDService.d.ts

@@ -1,4 +0,0 @@
-import type { IUserID } from '../../../models';
-export interface IUserIDService {
-    getUserId: () => Promise<IUserID | null>;
-}

package/lib/types/services/tracking/user/SurfsideUserIDService.d.ts

@@ -1,7 +0,0 @@
-import type { IUserID } from '../../../models';
-import type { ILoggerService } from '../../../services';
-import { UserOverrideService } from './UserOverrideService';
-export declare class SurfsideUserIDService extends UserOverrideService {
-    constructor(logger?: ILoggerService);
-    getUserId(): Promise<IUserID | null>;
-}

package/lib/types/services/tracking/user/UserOverrideService.d.ts

@@ -1,8 +0,0 @@
-import { OverrideService } from '../../../services/OverrideService';
-import type { IUserID } from '../../../models';
-import { type ILoggerService, type IUserIDService } from '../../../services';
-export declare class UserOverrideService extends OverrideService<IUserID> implements IUserIDService {
-    constructor(logger?: ILoggerService);
-    getUserId(): Promise<IUserID | null>;
-    mapDataSetToData(dataset: DOMStringMap): string | null;
-}

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

@@ -1,3 +0,0 @@
-export * from './IUserIDService';
-export * from './SurfsideUserIDService';
-export * from './UserOverrideService';

package/lib/types/utils/Protocol.d.ts

@@ -1 +0,0 @@
-export declare function GetSafeUrl(relativeUrl: string): string;

package/lib/types/utils/Rendering.d.ts

@@ -1,44 +0,0 @@
-import type { ICompiledPublisherConfiguration, INativeTemplateDelegateWindow, IProductContext, IProductInformation, IPublisherConfiguration } from '../models';
-import type Handlebars from 'handlebars/runtime';
-import type { ILoggerService } from '../services';
-export interface INativeTemplateDelegateData {
-    product: Partial<IProductInformation>;
-    window: INativeTemplateDelegateWindow;
-    publisher: IPublisherConfiguration;
-    catalog: IProductInformation;
-    ext: any;
-}
-export type NativeTemplateDelegate = Handlebars.TemplateDelegate<INativeTemplateDelegateData>;
-export type EventHandler = (e: Event) => (void | Promise<void>);
-export interface IEventHandleCallbackList {
-    click: EventHandler;
-    mousedown: EventHandler;
-    loadeddata: EventHandler;
-    error: EventHandler;
-    touchend: EventHandler;
-    touchstart: EventHandler;
-    touchmove: EventHandler;
-}
-/**
- * Initializes Handlebars with all custom helpers
- *
- * @param logger The logger service for debug messages
- */
-export declare function initHandlebars(handlebars: typeof Handlebars, logger?: ILoggerService): void;
-/**
- * Returns a NativeTemplateDelegateWindow object with the current window location properties
- *
- * @returns A NativeTemplateDelegateWindow object with the current window location properties
- */
-export declare function getNativeTemplateDelegateWindow(): INativeTemplateDelegateWindow;
-/**
- * Renders a URL template using the provided delegate, native slot, and publisher configuration.
- * Gets the window location properties from the current window.
- *
- * @param delegate The Handlebars delegate function to render the template
- * @param productInformation The native slot object to render
- * @param publisherConfiguration The publisher configuration object to render
- * @returns The rendered URL template
- */
-export declare function RenderTemplate(delegate: HandlebarsTemplateDelegate<IProductContext>, productInformation: IProductInformation | undefined, publisherConfiguration: ICompiledPublisherConfiguration, clickthrough?: string, catalogProduct?: IProductInformation): Element;
-export declare function RenderAndBind<T>(template: HandlebarsTemplateDelegate<T>, t: T & Partial<IEventHandleCallbackList>): Element;

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

@@ -1,2 +0,0 @@
-export * from './Protocol';
-export * from './Rendering';