@surfside/ads-core 1.0.6

package/lib/types/helpers/responses/ClickthroughHelpers.d.ts

@@ -0,0 +1,2 @@
+import type { ICompiledPublisherConfiguration, IProductInformation } from '../../models';
+export declare function BuildClickThroughUrl(configuration: ICompiledPublisherConfiguration, product: IProductInformation, catalog: IProductInformation, ext?: any): string;

package/lib/types/helpers/responses/VastHelpers.d.ts

@@ -0,0 +1,4 @@
+import type { IBidResponse, IVast } from '../../models';
+import type { ILoggerService } from '../../services';
+export declare function DeserializeVideo(response: IBidResponse, logger?: ILoggerService): IVast | null;
+export declare function DeserializeVast(logger: ILoggerService | undefined, adm: string): IVast;

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

@@ -0,0 +1,4 @@
+export * from './BuildBannerResponse';
+export * from './BuildNativeResponse';
+export * from './ClickthroughHelpers';
+export * from './VastHelpers';

package/lib/types/index.d.ts

@@ -0,0 +1,19 @@
+import { type IBidderService, type IConfigurationService, type IDeviceService, type IEventService, type IGeoService, type IProductFeedService, type IRecommenderService, type IUserIDService } from './services';
+export * from './models';
+export * from './services';
+export * from './errors';
+export * from './constant-values';
+export * from './helpers';
+export * from './utils';
+export * from './middleware';
+export interface ISurfsideCoreAPI {
+    bidder: IBidderService;
+    config: IConfigurationService;
+    geo: IGeoService;
+    productFeed: IProductFeedService;
+    userId: IUserIDService;
+    recommender: IRecommenderService;
+    events: IEventService;
+    device: IDeviceService;
+}
+export declare function initSurfsideCore(): ISurfsideCoreAPI;

package/lib/types/middleware/DeviceMiddleware.d.ts

@@ -0,0 +1,3 @@
+import type { IBidRequest } from '../models';
+import type { IDeviceService, ILoggerService } from '../services';
+export declare function DeviceMiddleware(logger: ILoggerService | undefined, deviceService: IDeviceService | undefined, request: IBidRequest): Promise<IBidRequest>;

package/lib/types/middleware/GeoMiddleware.d.ts

@@ -0,0 +1,3 @@
+import type { IBidRequest } from '../models';
+import type { IGeoService, ILoggerService } from '../services';
+export declare function GeoMiddlewareImmediate(geoService: IGeoService, logger: ILoggerService | undefined, request: IBidRequest, geoTargetingEnabled: boolean, ipTargetingEnabled: boolean): Promise<IBidRequest>;

package/lib/types/middleware/IdentityMiddleware.d.ts

@@ -0,0 +1,4 @@
+import { type IBidRequest } from '../models';
+import type { ILoggerService, IUserIDService } from '../services';
+export declare function IdentityMiddleware(userIDService: IUserIDService, logger: ILoggerService | undefined, request: IBidRequest): Promise<IBidRequest>;
+export declare const buildIdentityMiddleware: (userIdService: IUserIDService, logger: ILoggerService | undefined) => (request: IBidRequest) => Promise<IBidRequest>;

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

@@ -0,0 +1,3 @@
+export * from './GeoMiddleware';
+export * from './DeviceMiddleware';
+export * from './IdentityMiddleware';

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

@@ -0,0 +1,4 @@
+export * from './rtb';
+export * from './retail';
+export * from './vast';
+export * from './tracking';

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

@@ -0,0 +1,37 @@
+export interface IProductInformation {
+    image: string | null;
+    price: string | null;
+    salePrice: string | null;
+    thc: string | null;
+    strain: string | null;
+    cbd: string | null;
+    name: string | null;
+    brand_name: string | null;
+    brandName: string | null;
+    productType: string | null;
+    details: string | null;
+    cta: string | null;
+    clickthroughUrl: string | null;
+    winUrl: string | null;
+    pixelUrl: string | null;
+    ext?: any;
+}
+export declare class DefaultProductInformation implements IProductInformation {
+    image: string | null;
+    price: string | null;
+    salePrice: string | null;
+    thc: string | null;
+    strain: string | null;
+    cbd: string | null;
+    name: string | null;
+    brand_name: string | null;
+    brandName: string | null;
+    productType: string | null;
+    details: string | null;
+    cta: string | null;
+    clickthroughUrl: string | null;
+    winUrl: string | null;
+    pixelUrl: string | null;
+    ext?: any;
+    constructor();
+}

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

@@ -0,0 +1,64 @@
+import type { IProductInformation } from '../../models';
+import type Handlebars from 'handlebars/runtime';
+export type ProductCallback = (e: Event, product: IProductInformation) => void;
+export interface ICallbacks extends Record<string, ProductCallback> {
+}
+export interface INativeTemplateDelegateWindow {
+    origin: string;
+    port: string;
+    path: string;
+    host: string;
+    host_name: string;
+    search: string;
+    hash: string;
+    protocol: string;
+}
+export interface IPublisherConfiguration {
+    geoTargeting?: boolean;
+    ipTargeting?: boolean;
+    clickThroughUrlTemplate?: string;
+    productCardTemplate?: string;
+    productCardStyleSheet?: string;
+    carouselStyleSheet?: string;
+    reAuctionEnabled?: boolean;
+    reAuctionInterval?: number;
+}
+export interface ICompiledPublisherConfigurationTemplatesDTO {
+    productCardTemplate: string;
+    productCardStylesheet: string;
+    clickThroughUrlTemplate: string;
+    carouselStylesheet: string;
+    javascriptCallbacks: string;
+}
+export interface IProductContext {
+    product: Partial<IProductInformation>;
+    window: INativeTemplateDelegateWindow;
+    publisher: ICompiledPublisherConfiguration;
+    catalog: IProductInformation;
+    clickthrough?: string;
+    ext: any;
+}
+export interface ICompiledPublisherConfigurationTemplates {
+    productCardTemplate: Handlebars.TemplateDelegate<IProductContext>;
+    clickThroughUrlTemplate: Handlebars.TemplateDelegate<IProductContext>;
+    productCardStylesheet: string;
+    carouselStylesheet: string;
+    javascriptCallbacks: ICallbacks;
+}
+export interface ICompiledPublisherConfigurationSettingsDTO {
+    commerceMediaEnabled: boolean;
+    ipTargetingEnabled: boolean;
+    geoTargetingEnabled: boolean;
+    reauctionEnabled: boolean;
+    reauctionIntervalMs: number;
+    productFeedEnabled: boolean;
+    sponsoredByEnabled?: boolean;
+}
+export interface ICompiledPublisherConfigurationDTO {
+    templates: ICompiledPublisherConfigurationTemplatesDTO;
+    settings: ICompiledPublisherConfigurationSettingsDTO;
+}
+export interface ICompiledPublisherConfiguration {
+    settings: ICompiledPublisherConfigurationSettingsDTO;
+    templates: ICompiledPublisherConfigurationTemplates;
+}

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

@@ -0,0 +1,10 @@
+export interface IRecommendedProduct {
+    item_id: string;
+    rating?: number;
+}
+export interface IRecommenderResponse {
+    id: string;
+    error?: string;
+    locationId: string;
+    recommendations: IRecommendedProduct[];
+}

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

@@ -0,0 +1,3 @@
+export * from './IPublisherConfiguration';
+export type { IProductInformation } from './IProductInformation';
+export type { IRecommenderResponse, IRecommendedProduct } from './IRecommenderResponse';

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

@@ -0,0 +1,399 @@
+export interface IBrandVersion {
+    brand: string;
+    version?: string[];
+    ext?: any;
+}
+export interface IUserAgent {
+    browsers?: IBrandVersion[];
+    platform?: IBrandVersion;
+    mobile?: number;
+    architecture?: string;
+    bitness?: string;
+    model?: string;
+    source?: number;
+    ext?: any;
+}
+export declare enum AgentTypes {
+    SESSION = 1,
+    DEVICE = 2,
+    USER = 3
+}
+export interface IUid {
+    id: string;
+    atype?: AgentTypes;
+    ext?: any;
+}
+export interface IEid {
+    source: string;
+    uids: IUid[];
+    ext?: any;
+}
+export interface ISupplyChainNode {
+    asi?: string;
+    sid?: string;
+    hp?: number;
+    rid?: string;
+    name?: string;
+    domain?: string;
+    ext?: any;
+}
+export interface ISupplyChain {
+    complete: number;
+    nodes: ISupplyChainNode[];
+    ver: string;
+    ext?: any;
+}
+export interface IChannel {
+    id?: string;
+    name?: string;
+    domain?: string;
+    ext?: any;
+}
+export interface INetwork {
+    id?: string;
+    name?: string;
+    domain?: string;
+    ext?: any;
+}
+export interface ISegment {
+    id?: string;
+    name?: string;
+    value?: string;
+    ext?: any;
+}
+export interface IData {
+    id?: string;
+    name?: string;
+    segment?: ISegment[];
+    ext?: any;
+}
+export interface IUser {
+    id?: string;
+    buyeruid?: string;
+    yob?: number;
+    gender?: string;
+    keywords?: string;
+    kwarray?: string[];
+    customdata?: string;
+    geo?: IGeo;
+    data?: IData[];
+    cconsent?: string;
+    eids?: IEid[];
+    ext?: any;
+}
+export interface IGeo {
+    lat?: number;
+    lon?: number;
+    type?: number;
+    accuracy?: number;
+    lastfix?: number;
+    ipservice?: number;
+    country?: string;
+    region?: string;
+    regionfips104?: string;
+    metro?: string;
+    city?: string;
+    zip?: string;
+    utcoffset?: number;
+    ext?: any;
+}
+export declare enum AdCom10DeviceTypes {
+    MOBILE = 1,
+    PC = 2,
+    CTV = 3,
+    PHONE = 4,
+    TABLET = 5,
+    CONNECTED = 6,
+    SET_TOP = 7,
+    OOH = 8
+}
+export interface IDevice {
+    ua?: string;
+    geo?: IGeo;
+    dnt?: number;
+    lmt?: number;
+    ip?: string;
+    ipv6?: string;
+    devicetype?: number;
+    make?: string;
+    model?: string;
+    os?: string;
+    osv?: string;
+    hwv?: string;
+    h?: number;
+    w?: number;
+    ppi?: number;
+    pxratio?: number;
+    js?: number;
+    geofetch?: number;
+    flashver?: string;
+    language?: string;
+    lanbg?: string;
+    carrier?: string;
+    mccmnc?: string;
+    connectiontype?: number;
+    ifa?: string;
+    didsha1?: string;
+    didmd5?: string;
+    dpidsha1?: string;
+    dpidmd5?: string;
+    macsha1?: string;
+    macmd5?: string;
+    ext?: any;
+    sua?: IUserAgent;
+}
+export interface IProducer {
+    id?: string;
+    name?: string;
+    cattax?: number[];
+    cat?: string[];
+    domain?: string;
+    ext?: any;
+}
+export interface IContent {
+    id?: string;
+    episode?: number;
+    title?: string;
+    series?: string;
+    season?: string;
+    artist?: string;
+    genre?: string;
+    album?: string;
+    isrc?: string;
+    producer?: IProducer;
+    url?: string;
+    cattax?: number[];
+    cat?: string[];
+    prodq?: number;
+    videoquality?: number;
+    context?: number;
+    contentrating?: string;
+    userrating?: string;
+    qagmediarating?: number;
+    keywords?: string;
+    kwarray?: string[];
+    livestream?: number;
+    sourcerelationship?: number;
+    len?: number;
+    language?: string;
+    langb?: string;
+    embeddable?: number;
+    data?: IData[];
+    network?: INetwork;
+    channel?: IChannel;
+    ext?: any;
+}
+export interface IPublisher {
+    id?: string;
+    name?: string;
+    cattax?: number[];
+    cat?: string[];
+    domain?: string;
+    ext?: any;
+}
+export interface IApp {
+    id?: string;
+    name?: string;
+    bundle?: string;
+    domain?: string;
+    storeurl?: string;
+    cat?: string[];
+    sectioncat?: string[];
+    pagecat?: string[];
+    ver?: string;
+    privacypolicy?: number;
+    paid?: number;
+    publisher?: IPublisher;
+    content?: IContent;
+    keywords?: string;
+    kwarray?: string[];
+    ext?: any;
+}
+export interface ISite {
+    id?: string;
+    name?: string;
+    domain?: string;
+    cat?: string[];
+    sectioncat?: string[];
+    pagecat?: string[];
+    page?: string;
+    ref?: string;
+    search?: string;
+    mobile?: number;
+    privacypolicy?: number;
+    publisher?: IPublisher;
+    content?: IContent;
+    keywords?: string;
+    kwarray?: string[];
+    ext?: any;
+}
+export interface IDeal {
+    id: string;
+    bidfloor: number;
+    bidfloorcur?: string;
+    at?: number;
+    wseat?: string[];
+    wadomain?: string[];
+    ext?: any;
+}
+export interface IPmp {
+    private_auction?: number;
+    deals?: IDeal[];
+    ext?: any;
+}
+export interface IFormat {
+    w?: number;
+    h?: number;
+    wratio?: number;
+    hratio?: number;
+    wmin?: number;
+    ext?: any;
+}
+export interface INative {
+    request: string;
+    ver?: string;
+    api?: number[];
+    battr?: number[];
+    ext?: any;
+}
+export interface IAudio {
+    mimes: string[];
+    minduration?: number;
+    maxduration?: number;
+    poddur?: number;
+    protocols?: number[];
+    startdelay?: number;
+    rqddurs?: number[];
+    podid?: string;
+    podseq?: number;
+    sequence?: number;
+    slotinpod?: number;
+    mincpmpersec?: number;
+    battr?: number[];
+    maxextended?: number;
+    minbitrate?: number;
+    maxbitrate?: number;
+    delivery?: number[];
+    companionad?: IBanner[];
+    api?: number[];
+    companiontype?: number[];
+    maxseq?: number;
+    feed?: number;
+    stitched?: number;
+    nvol?: number;
+    ext?: any;
+}
+export interface IVideo {
+    mimes: string[];
+    minduration?: number;
+    maxduration?: number;
+    startdelay?: number;
+    maxseq?: number;
+    poddur?: number;
+    protocols?: number[];
+    w?: number;
+    h?: number;
+    podid?: string;
+    podseq?: number;
+    rqddurs?: number[];
+    placement?: number;
+    linearity?: number;
+    skip?: number;
+    skipmin?: number;
+    skipafter?: number;
+    sequence?: number;
+    slotinpod?: number;
+    mincpmpersec?: number;
+    battr?: number[];
+    maxextended?: number;
+    minbitrate?: number;
+    maxbitrate?: number;
+    boxingallowed?: number;
+    playbackmethod?: number[];
+    playbackend?: number;
+    delivery?: number[];
+    pos?: number;
+    companionad?: IBanner[];
+    api?: number[];
+    companiontype?: number[];
+    ext?: any;
+}
+export interface IBanner {
+    format?: IFormat[];
+    w?: number;
+    h?: number;
+    btype?: number[];
+    battr?: number[];
+    pos?: number;
+    mimes?: string[];
+    topframe?: number;
+    expdir?: number[];
+    api?: number[];
+    id?: string;
+    ext?: any;
+}
+export interface IMetric {
+    type: string;
+    value: number;
+    vendor?: string;
+    ext?: any;
+}
+export interface IImp {
+    id: string;
+    metric?: IMetric[];
+    banner?: IBanner;
+    video?: IVideo;
+    audio?: IAudio;
+    native?: INative;
+    pmp?: IPmp;
+    displaymanager?: string;
+    displaymanagerver?: string;
+    instl?: number;
+    tagid?: string;
+    bidfloor?: number;
+    bidfloorcur?: string;
+    clickbrowser?: number;
+    secure?: number;
+    iframebuster?: string[];
+    rwdd?: number;
+    ssai?: number;
+    exp?: number;
+    ext?: any;
+}
+export interface IRegs {
+    coppa?: number;
+    ext?: any;
+    gdpr?: number;
+    us_privacy?: string;
+}
+export interface ISource {
+    fd?: number;
+    tid?: string;
+    pchain?: string;
+    schain?: ISupplyChain;
+    ext?: any;
+}
+export interface IBidRequest {
+    id: string;
+    imp: IImp[];
+    site?: ISite;
+    app?: IApp;
+    device?: IDevice;
+    user?: IUser;
+    test?: number;
+    at?: number;
+    tmax?: number;
+    wseat?: string[];
+    bseat?: string[];
+    allimps?: number;
+    cur?: string[];
+    wlang?: string[];
+    wlangb?: string[];
+    bcat?: string[];
+    cattax?: number[];
+    badv?: string[];
+    bapp?: string[];
+    source?: ISource;
+    regs?: IRegs;
+    ext?: any;
+}

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

@@ -0,0 +1,47 @@
+export interface IBid {
+    id: string;
+    impid: string;
+    price: number;
+    nurl?: string;
+    burl?: string;
+    lurl?: string;
+    adm?: string;
+    adid?: string;
+    adomain?: string[];
+    bundle?: string;
+    iurl?: string;
+    cid?: string;
+    crid?: string;
+    tactic?: string;
+    cattax?: number;
+    cat?: string[];
+    attr?: number[];
+    api?: number;
+    protocol?: number;
+    qagmediarating?: number;
+    language?: string;
+    dealid?: string;
+    w?: number;
+    h?: number;
+    wratio?: number;
+    hratio?: number;
+    exp?: number;
+    ext?: any;
+    dur?: number;
+    mtype?: number;
+    slotinpid?: number;
+}
+export interface ISeatBid {
+    bid: IBid[];
+    seat?: string;
+    group?: number;
+    ext?: any;
+}
+export interface IBidResponse {
+    id: string;
+    seatbid?: ISeatBid[];
+    bidid?: string;
+    cur?: string;
+    nbr?: number;
+    ext?: any;
+}

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

@@ -0,0 +1,3 @@
+export * from './IBidResponse';
+export * from './IBidRequest';
+export * from './native';

package/lib/types/models/rtb/native/Constants.d.ts

@@ -0,0 +1,60 @@
+export declare enum CreativeType {
+    BANNER = 0,
+    INLINE = 1,
+    PRODUCT_CARD = 2,
+    PRODUCT_CAROUSEL = 3,
+    VIDEO = 4
+}
+export declare enum NativePosition {
+    UNKNOWN = 0,
+    ABOVE_THE_FOLD = 1,
+    BELOW_THE_FOLD = 3,
+    HEADER = 4,
+    FOOTER = 5,
+    SIDEBAR = 6,
+    FULL_SCREN = 7
+}
+export declare enum NativeImageTypes {
+    ICON = 1,
+    MAIN = 3
+}
+export declare enum NativeDataTypes {
+    SPONSORED = 1,
+    DESC = 2,
+    RATING = 3,
+    LIKES = 4,
+    DOWNLOADS = 5,
+    PRICE = 6,
+    SALEPRICE = 7,
+    PHONE = 8,
+    ADDRESS = 9,
+    DESC2 = 10,
+    DISPLAYURL = 11,
+    CTATEXT = 12,
+    SURF_STRAIN = 500,
+    SURF_THC = 501,
+    SURF_CBD = 502,
+    SURF_CATEGORY = 503
+}
+export declare enum NativeAssetId {
+    TITLE = 0,
+    IMAGE = 1,
+    SPONSORED = 2,
+    DESC = 3,
+    RATING = 4,
+    PRICE = 5,
+    SALEPRICE = 6,
+    DISPLAYURL = 7,
+    CTATEXT = 8,
+    SURF_CATEGORY = 9,
+    SURF_THC = 10,
+    SURF_CBD = 11,
+    SURF_STRAIN = 12
+}
+export interface INativeDataAsset {
+    id: number;
+    required: 0 | 1;
+    data: {
+        type: number;
+    };
+}