@surfside/ads-core 2.0.1

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/NativeRequest.d.ts

@@ -0,0 +1,170 @@
+export declare const NativePosition: {
+    readonly Unknown: 0;
+    readonly AboveTheFold: 1;
+    readonly BelowTheFold: 3;
+    readonly Header: 4;
+    readonly Footer: 5;
+    readonly Sidebar: 6;
+    readonly FullScreen: 7;
+};
+/**
+ * The type of the image within native ad (icon vs main image)
+ */
+export declare const NativeImageTypes: {
+    readonly Icon: 1;
+    readonly Main: 3;
+};
+/**
+ * The type ID for each native asset type. IDs above 500 are surfside-specific fields, all
+ * others are OpenRTB Native Ad Spec 1.2 fields.
+ */
+export declare const NativeDataTypes: {
+    readonly Sponsored: 1;
+    readonly Desc: 2;
+    readonly Rating: 3;
+    readonly Likes: 4;
+    readonly Downloads: 5;
+    readonly Price: 6;
+    readonly SalePrice: 7;
+    readonly Phone: 8;
+    readonly Address: 9;
+    readonly Desc2: 10;
+    readonly DisplayURL: 11;
+    readonly CTAText: 12;
+    readonly SurfStrain: 500;
+    readonly SurfTHC: 501;
+    readonly SurfCBD: 502;
+    readonly SurfCategory: 503;
+    readonly SurfMetaProduct: 599;
+};
+/**
+ * The ID for each field within a surfside native ad request. The Asset ID matches the asset type, for simplicity.
+ */
+export declare const NativeAssetId: {
+    readonly Title: 0;
+    readonly Image: 1;
+    readonly Sponsored: 2;
+    readonly Desc: 3;
+    readonly Rating: 4;
+    readonly Price: 5;
+    readonly SalePrice: 6;
+    readonly DisplayURL: 7;
+    readonly CTAText: 8;
+    readonly Video: 9;
+    readonly SurfStrain: 500;
+    readonly SurfTHC: 501;
+    readonly SurfCBD: 502;
+    readonly SurfCategory: 503;
+    readonly SurfMetaBrand: 598;
+    readonly SurfMetaProduct: 599;
+};
+/**
+ * Event types which can be tracked by the native ad unit
+ */
+export declare const EventTypes: {
+    readonly Imp: 1;
+    readonly ViewableMRC50: 2;
+    readonly ViewableMRC100: 3;
+    readonly ViewableVIDEO50: 4;
+};
+/**
+ * The context of the page for the native ad unit, i.e what type of content is being displayed
+ */
+export declare const ContextTypes: {
+    readonly Content: 1;
+    readonly Social: 2;
+    readonly Product: 3;
+};
+/**
+ * The sub-type of the context
+ */
+export declare const ContextSubTypes: {
+    readonly General: 10;
+    readonly Article: 11;
+    readonly Video: 12;
+    readonly Audio: 13;
+    readonly Image: 14;
+    readonly UserGenerated: 15;
+    readonly GeneralSocial: 20;
+    readonly Email: 21;
+    readonly Chat: 22;
+    readonly Product: 30;
+    readonly Application: 31;
+    readonly ProductReviews: 32;
+};
+/**
+ * The format of the ad unit, i.e: what type of ad is being displayed and where
+ */
+export declare const PlacementTypes: {
+    readonly InFeed: 1;
+    readonly Atomic: 2;
+    readonly OutsideCore: 3;
+    readonly Recommendation: 4;
+};
+/**
+ * Presets for default video MIME types
+ */
+export declare const VideoMimes: {
+    readonly MP4: "video/mp4";
+    readonly WEBM: "video/webm";
+};
+/**
+ * The method used to track events, 1x1 pixel of Javascript tag
+ */
+export declare const EventTrackingMethods: {
+    readonly Img: 1;
+    readonly JS: 2;
+};
+export interface INativeRequest {
+    ver?: string;
+    context?: number;
+    contextsubtype?: number;
+    plcmttype?: number;
+    plcmtcnt?: number;
+    seq?: number;
+    assets: IAssetObject[];
+    aurlsupport?: number;
+    durlsupport?: number;
+    eventtrackers?: IEventTrackerRequestObject[];
+    privacy?: number;
+    ext?: any;
+}
+export interface IAssetObject {
+    id: number;
+    required?: number;
+    title?: ITitleRequestObject;
+    img?: IImageRequestObject;
+    video?: IVideoRequestObject;
+    data?: IDataRequestObject;
+    ext?: any;
+}
+export interface ITitleRequestObject {
+    len: number;
+    ext?: any;
+}
+export interface IImageRequestObject {
+    type?: number;
+    w?: number;
+    wmin?: number;
+    h?: number;
+    hmin?: number;
+    mimes?: string[];
+    ext?: any;
+}
+export interface IVideoRequestObject {
+    mimes: number[] | string[];
+    minduration: number;
+    maxduration: number;
+    protocols: number[];
+    ext?: any;
+}
+export interface IDataRequestObject {
+    type: number;
+    len?: number;
+    ext?: any;
+}
+export interface IEventTrackerRequestObject {
+    event: number;
+    methods: number[];
+    ext?: any;
+}

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

@@ -0,0 +1,60 @@
+import { type IProductInformation } from '../../models';
+export interface INativeResponse {
+    native: INativeResponseDetails;
+}
+export interface INativeResponseDetails {
+    ver?: string;
+    assets?: IAssetResponseObject[];
+    assetsurl?: string;
+    dcourl?: string;
+    link: ILinkResponseObject;
+    imptrackers?: string[];
+    jstracker?: string;
+    eventtrackers?: IEventTrackerResponseObject[];
+    privacy?: string;
+    ext?: any;
+}
+export interface IAssetResponseObject {
+    id?: number;
+    required?: number;
+    title?: ITitleResponseObject;
+    img?: IImageResponseObject;
+    data?: IDataResponseObject;
+    video?: IVideoResponseObject;
+    link?: ILinkResponseObject;
+    ext?: any;
+}
+export interface ITitleResponseObject {
+    text: string;
+    len?: number;
+    ext?: any;
+}
+export interface IImageResponseObject {
+    type: number;
+    url: string;
+    w?: number;
+    h?: number;
+    ext?: any;
+}
+export interface IDataResponseObject {
+    type?: number;
+    value: string;
+    ext?: any;
+}
+export interface IVideoResponseObject {
+    vasttag: string;
+}
+export interface ILinkResponseObject {
+    url: string;
+    clicktrackers?: string[];
+    fallback?: string;
+    ext?: any;
+}
+export interface IEventTrackerResponseObject {
+    event: number;
+    method: number;
+    url?: string;
+    customdata?: any;
+    ext?: any;
+}
+export declare function NativeResponseToProductInformation(native: INativeResponse): IProductInformation;

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

@@ -0,0 +1,4 @@
+export * from './BidRequest';
+export * from './BidResponse';
+export * from './NativeRequest';
+export * from './NativeResponse';