@surfside/ads-core 1.0.6 → 2.0.2

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

@@ -1,124 +0,0 @@
-import type { IApp, IBanner, IBidRequest, IDevice, IImp, INative, IRegs, ISite, IUser, IVideo } from '../../models';
-declare enum BuilderCreativeType {
-    BANNER = 0,
-    VIDEO = 1,
-    NATIVE = 2
-}
-interface IBuilderState<T, U> {
-    currentCreative: T;
-    type: U;
-    imp: IImp;
-}
-export interface IBannerBuilderState extends IBuilderState<IBanner, BuilderCreativeType.BANNER> {
-}
-export interface IVideoBuilderState extends IBuilderState<IVideo, BuilderCreativeType.VIDEO> {
-}
-export interface INativeBuilderState extends IBuilderState<INative, BuilderCreativeType.NATIVE> {
-}
-/** Builds an OpenRTB 2.6 bid request */
-export declare class RequestBuilder {
-    private readonly _request;
-    private _builderState;
-    /**
-     *
-     * @param id The ID of the request. If not provided, a random ID will be generated.
-     */
-    constructor(id?: string);
-    /**
-     *
-     * @returns The built bid request
-     */
-    build(): IBidRequest;
-    /**
-     * Adds surfside-specific information to the top level bid request and all subsequent impression objects
-     * @param accountId The account ID of the current store
-     * @param siteId The site ID of the current store
-     * @param locationId The location ID of the current store (i.e: the ID of the specific brick and mortar store)
-     * @param zoneId The ID for the zone on the advertisement
-     * @param channelId The channel ID being advertised on
-     * @param keywords A set of keywords describing the content of the page.
-     * @returns The builder instance
-     */
-    withSurfContext(accountId: string, siteId: string, locationId: string, zoneId: string, channelId?: string, keywords?: string[]): this;
-    /**
-     * Adds a banner impression to the request. If a creative is already being built,
-     * it will be appended to the request.
-     * @param w The width of the banner being requested
-     * @param h The height of the banner being requested
-     * @param options Other OpenRTB fields to include in the banner object.
-     * @returns The builder instance
-     */
-    withBanner(w: number, h: number, options?: Partial<IBanner>): this;
-    /**
-     * Adds a video impression to the request. If a create is already being built,
-     * it will be appended to the request
-     * @param w The width of the video being requested
-     * @param h The height of the video being requested
-     * @param minduration The minimum duration of the video, in seconds
-     * @param maxduration The maximum duration of the video, in seconds
-     * @param mimes A list of MIME types supported by the video. Defaults to ['video/mp4', 'video/webm']
-     * @param options Other OpenRTB fields to include in the video object
-     * @returns The builder instance
-     */
-    withVideo(w: number, h: number, minduration: number, maxduration: number, mimes?: string[], options?: Partial<IVideo>): this;
-    /**
-     * Adds a native impression to the request. If a creative is already being built,
-     * it will be appended to the request. Native requests are stringified JSON objects
-     * in the OpenRTB Native 1.2 format. Use the NativeRequestBuilder to build these objects.
-     * @param request The native request object, as a stringified JSON object
-     * @param options Other OpenRTB fields to include in the native object
-     * @returns The builder instance
-     */
-    withNative(request: string, options?: Partial<INative>): this;
-    /**
-     * Sets the bid floor on the current impression. This operates on each impression,
-     * so it needs to be called again for each impression if multiple are present.
-     * @param bidfloor The bid floor to set
-     * @param bidfloorcur The currency of the bid floor. Defaults to 'USD'
-     * @returns The builder instance
-     */
-    withBidFloor(bidfloor: number, bidfloorcur?: string): this;
-    /**
-     * Adds an extension to the current impression. Extensions are dynamically typed dictionaries
-     * with options that are specific to the bidder. This operates on each impression, so it needs
-     * to be called again for each impression if multiple are present.
-     * @param ext The extension to add
-     * @returns The builder instance
-     */
-    withImpExt(ext: any): this;
-    /**
-     * The site that the ad appears on.
-     * @param site The site object. If not provided, a default site object will be created using the current hostname.
-     * @returns The builder instance
-     */
-    withSite(site?: ISite): this;
-    /**
-     * The app that the ad appears in.
-     * @param app The app object. If not provided, a default app object will be created using the current hostname.
-     * @returns The builder instance
-     */
-    withApp(app?: IApp): this;
-    /**
-     * Information about the current user's device, including useragent, IP, make and model as well as geo information.
-     * @param device The device object
-     * @returns The builder instance
-     */
-    withDevice(device: IDevice): this;
-    /**
-     * Information about the current user. Geo information can be included here, but is different
-     * from the device's geo information; this is the user's home location.
-     * @param user The user object
-     * @returns The builder instance
-     */
-    withUser(user: IUser): this;
-    /**
-     * Used if any data privacy regulations are relevant to the request (i.e: COPPA, GDPR, etc.)
-     * @param regs The regs object
-     * @returns The builder instance
-     */
-    withRegulations(regs: IRegs): this;
-    private _appendBuilderState;
-    private _appendImpression;
-    private _generateId;
-}
-export {};

package/lib/types/helpers/requests/SimpleBannerRequest.d.ts

@@ -1,26 +0,0 @@
-import type { IApp, IBidRequest, IDevice, IImp, IRegs, ISite, ISource, IUser } from '../../models';
-export declare class SimpleBannerRequest implements IBidRequest {
-    id: string;
-    imp: IImp[];
-    site?: ISite | undefined;
-    app?: IApp | undefined;
-    device?: IDevice | undefined;
-    user?: IUser | undefined;
-    test?: number | undefined;
-    at?: number | undefined;
-    tmax?: number | undefined;
-    wseat?: string[] | undefined;
-    bseat?: string[] | undefined;
-    allimps?: number | undefined;
-    cur?: string[] | undefined;
-    wlang?: string[] | undefined;
-    wlangb?: string[] | undefined;
-    bcat?: string[] | undefined;
-    cattax?: number[] | undefined;
-    badv?: string[] | undefined;
-    bapp?: string[] | undefined;
-    source?: ISource | undefined;
-    regs?: IRegs | undefined;
-    ext?: any;
-    constructor(id: string, w: number, h: number);
-}

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

@@ -1,2 +0,0 @@
-export * from './SimpleBannerRequest';
-export * from './RequestBuilder';

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

@@ -1,10 +0,0 @@
-import type { IBid, IBidResponse, ICompiledPublisherConfiguration, IProductInformation } from '../../models';
-interface IBuiltBanner {
-    element: HTMLDivElement | null;
-    product: IProductInformation | null;
-    clickThrough: string | null;
-}
-export declare function BuildBanner(response: IBidResponse | null, config?: ICompiledPublisherConfiguration): IBuiltBanner;
-export declare function BuildBannerFromBid(bid: IBid): HTMLDivElement | null;
-export declare function BuildProductInfoFromElement(element: HTMLDivElement): IProductInformation | null;
-export {};

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

@@ -1,21 +0,0 @@
-import { type IBidResponse, type ICompiledPublisherConfiguration, type INativeResponse } from '../../models';
-import { ILoggerService, type IProductFeedService } from '../../services';
-export interface ITrackers {
-    pixels: string[];
-    js: string[];
-}
-export interface IBuiltNative {
-    data: INativeResponse;
-    clickThrough: string;
-    winUrl: string;
-    trackers: ITrackers;
-    element?: Element;
-}
-export interface IPublisherContext {
-    config: ICompiledPublisherConfiguration;
-    productService: IProductFeedService;
-    accountId: string;
-    siteId: string;
-    locationId: string;
-}
-export declare function BuildNativeResponse(response: IBidResponse | null, context?: IPublisherContext, logger?: ILoggerService): Promise<IBuiltNative[]>;

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

@@ -1,2 +0,0 @@
-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

@@ -1,4 +0,0 @@
-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

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

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

@@ -1,3 +0,0 @@
-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

@@ -1,3 +0,0 @@
-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

@@ -1,4 +0,0 @@
-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

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

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

@@ -1,37 +0,0 @@
-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/rtb/native/Constants.d.ts

@@ -1,60 +0,0 @@
-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;
-    };
-}

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

@@ -1,54 +0,0 @@
-import type { ContextSubTypes, ContextTypes, EventTrackingMethods, EventTypes, NativeDataTypes, PlacementTypes, VideoMimes } from './NativeConstants';
-export interface INativeRequest {
-    ver?: string;
-    context?: ContextTypes;
-    contextsubtype?: ContextSubTypes;
-    plcmttype?: PlacementTypes;
-    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: VideoMimes[] | string[];
-    minduration: number;
-    maxduration: number;
-    protocols: number[];
-    ext?: any;
-}
-export interface IDataRequestObject {
-    type: NativeDataTypes;
-    len?: number;
-    ext?: any;
-}
-export interface IEventTrackerRequestObject {
-    event: EventTypes;
-    methods: EventTrackingMethods[];
-    ext?: any;
-}

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

@@ -1,120 +0,0 @@
-/**
- * The position of the native ad, on the screen
- */
-export declare enum NativePosition {
-    UNKNOWN = 0,
-    ABOVE_THE_FOLD = 1,
-    BELOW_THE_FOLD = 3,
-    HEADER = 4,
-    FOOTER = 5,
-    SIDEBAR = 6,
-    FULL_SCREN = 7
-}
-/**
- * The type of the image within native ad (icon vs main image)
- */
-export declare enum NativeImageTypes {
-    ICON = 1,
-    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 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,
-    SURF_META_PRODUCT = 599
-}
-/**
- * The ID for each field within a surfside native ad request. The Asset ID matches the asset type, for simplicity.
- */
-export declare enum NativeAssetId {
-    TITLE = 0,
-    IMAGE = 1,
-    SPONSORED = 2,
-    DESC = 3,
-    RATING = 4,
-    PRICE = 5,
-    SALEPRICE = 6,
-    DISPLAYURL = 7,
-    CTATEXT = 8,
-    SURF_STRAIN = 500,
-    SURF_THC = 501,
-    SURF_CBD = 502,
-    SURF_CATEGORY = 503,
-    SURF_META_PRODUCT = 599
-}
-/**
- * Event types which can be tracked by the native ad unit
- */
-export declare enum EventTypes {
-    IMP = 1,
-    VIEWABLE_MRC50 = 2,
-    VIEWABLE_MRC100 = 3,
-    VIEWABLE_VIDEO50 = 4,
-    SURF_WIN = 500,
-    SURF_CLICK = 501
-}
-/**
- * The context of the page for the native ad unit, i.e what type of content is being displayed
- */
-export declare enum ContextTypes {
-    CONTENT = 1,
-    SOCIAL = 2,
-    PRODUCT = 3
-}
-/**
- * The sub-type of the context
- */
-export declare enum ContextSubTypes {
-    GENERAL = 10,
-    ARTICLE = 11,
-    VIDEO = 12,
-    AUDIO = 13,
-    IMAGE = 14,
-    USER_GENERATED = 15,
-    GENERAL_SOCIAL = 20,
-    EMAIL = 21,
-    CHAT = 22,
-    PRODUCT = 30,
-    APPLICATION = 31,
-    PRODUCT_REVIEWS = 32
-}
-/**
- * The format of the ad unit, i.e: what type of ad is being displayed and where
- */
-export declare enum PlacementTypes {
-    IN_FEED = 1,
-    ATOMIC = 2,
-    OUTSIDE_CORE = 3,
-    RECOMMENDATION = 4
-}
-/**
- * Presets for default video MIME types
- */
-export declare enum VideoMimes {
-    MP4 = "video/mp4",
-    WEBM = "video/webm"
-}
-/**
- * The method used to track events, 1x1 pixel of Javascript tag
- */
-export declare enum EventTrackingMethods {
-    IMG = 1,
-    JS = 2
-}

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

@@ -1,158 +0,0 @@
-import { EventTrackingMethods, EventTypes, NativeAssetId, NativeDataTypes, type VideoMimes } from '../../../models';
-import type { INativeRequest } from './INativeRequest';
-/**
- * Builder for creating an OpenRTB Native 1.2 request object.
- */
-export declare class NativeRequestBuilder {
-    private readonly _request;
-    /**
-     * Creates a new NativeRequestBuilder instance, using version 1.2 and product type context.
-     */
-    constructor();
-    /**
-     * Overrides the 1.2 version with the provided version.
-     * @param ver The version to use
-     * @returns The builder instance
-     */
-    withVer(ver: string): this;
-    /**
-     * Overrides the native request context type with the provided context.
-     * @param context The context to use
-     * @returns The builder instance
-     */
-    withContext(context: number): this;
-    /**
-     * Adds a title asset to the request.
-     * @param length The lenght of the title, default is 80
-     * @param required Whether the title is required, default is true
-     * @returns The builder instance
-     */
-    withTitle(length?: number, required?: boolean): this;
-    /**
-     * Adds an image asset to the request.
-     * @param width The full width of the image. If minWidth is not provided, this is the exact width.
-     *              Otherwise, it is the max width
-     * @param height The full height of the image. If minHeight is not provided, this is the exact height.
-     *              Otherwise, it is the max height
-     * @param minWidth The minimum width of the image. undefined by default
-     * @param minHeight The minimum height of the image. undefined by default
-     * @param required Whether the image is required, default is true
-     * @returns
-     */
-    withImage(width: number, height: number, minWidth?: number, minHeight?: number, required?: boolean): this;
-    /**
-     * Adds a video asset to the request.
-     * @param mimes The supported MIME types for the video
-     * @param minDuration The minimum duration of the video
-     * @param maxDuration The maximum duration of the video
-     * @param required Whether the video is required, default is true
-     * @returns The builder instance
-     */
-    withVideo(mimes: VideoMimes[] | string[], minDuration: number, maxDuration: number, required?: boolean): this;
-    /**
-     * Adds a data asset to the request.
-     * @param type The type ID of the data asset
-     * @param id The ID of the asset field; This number is used to address the asset
-    *            in the response so it must be unique
-     * @param length The max length of the data asset's value, in characters
-     * @param required Whether the data asset is required, default is true
-     * @returns The builder instance
-     */
-    withData(type: NativeDataTypes, id: NativeAssetId, length?: number, required?: boolean): this;
-    /**
-     * Adds a sponsored field to the request.
-     * @param length The max length of the sponsored field, in characters. Default is 80
-     * @param required Whether the sponsored field is required. Default is true
-     * @returns The builder instance
-     */
-    withSponsored(length?: number, required?: boolean): this;
-    /**
-     * Adds a description field to the request.
-     * @param length The max length of the description field, in characters. Default is 80
-     * @param required Whether the description field is required. Default is true
-     * @returns The builder instance
-     */
-    withDescription(length?: number, required?: boolean): this;
-    /**
-     * Adds a rating field to the request.
-     * @param length The max length of the rating field, in characters. Default is 80
-     * @param required Whether the rating field is required. Default is true
-     * @returns The builder instance
-     */
-    withRating(length?: number, required?: boolean): this;
-    /**
-     * Adds a price field to the request.
-     * @param length The max length of the price field, in characters. Default is 80
-     * @param required Whether the price field is required. Default is true
-     * @returns The builder instance
-     */
-    withPrice(length?: number, required?: boolean): this;
-    /**
-     * Adds a sale price field to the request.
-     * @param length The max length of the sale price field, in characters. Default is 80
-     * @param required Whether the sale price field is required. Default is true
-     * @returns The builder instance
-     */
-    withSalePrice(length?: number, required?: boolean): this;
-    /**
-     * Adds a display URL field to the request.
-     * @param length The max length of the display URL field, in characters. Default is 80
-     * @param required Whether the display URL field is required. Default is true
-     * @returns The builder instance
-     */
-    withDisplayUrl(length?: number, required?: boolean): this;
-    /**
-     * Adds a CTA (call to action) text field to the request.
-     * @param length The max length of the call to action text field, in characters. Default is 80
-     * @param required Whether the call to action text field is required. Default is true
-     * @returns The builder instance
-     */
-    withCtaText(length?: number, required?: boolean): this;
-    /**
-     * Adds a category field to the request.
-     * @param length The max length of the category field, in characters. Default is 80
-     * @param required Whether the category field is required. Default is true
-     * @returns The builder instance
-     */
-    withCategory(length?: number, required?: boolean): this;
-    /**
-     * Adds a THC field to the request.
-     * @param length The max length of the THC field, in characters. Default is 80
-     * @param required Whether the THC field is required. Default is true
-     * @returns The builder instance
-     */
-    withTHC(length?: number, required?: boolean): this;
-    /**
-     * Adds a CBD field to the request.
-     * @param length The max length of the CBD field, in characters. Default is 80
-     * @param required Whether the CBD field is required. Default is true
-     * @returns The builder instance
-     */
-    withCBD(length?: number, required?: boolean): this;
-    /**
-     * Adds a strain field to the request.
-     * @param length The max length of the strain field, in characters. Default is 80
-     * @param required Whether the strain field is required. Default is true
-     * @returns The builder instance
-     */
-    withStrain(length?: number, required?: boolean): this;
-    /**
-     * Adds a meta product field to the request.
-     * @param length The max length of the meta product field, in characters. Default is 80
-     * @param required Whether the meta product field is required. Default is true
-     * @returns The builder instance
-     */
-    withMetaProduct(length?: number, required?: boolean): this;
-    /**
-     * Adds an event tracker to the request.
-     * @param event The type of event to be tracked
-     * @param methods Which methods are acceptable: either 1x1 image pixels or javascript tags, or both
-     * @returns The builder instance
-     */
-    withEventTracker(event: EventTypes, methods: EventTrackingMethods[]): this;
-    /**
-     * Generate the native bid request object.
-     * @returns The native request object
-     */
-    build(): INativeRequest;
-}

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

@@ -1,4 +0,0 @@
-export * from './INativeRequest';
-export * from './INativeResponse';
-export * from './NativeRequestBuilder';
-export * from './NativeConstants';