@surfside/ads-core 2.0.1 → 2.0.3

package/lib/types/constant-values/index.d.ts

@@ -1,46 +0,0 @@
-export declare enum HttpStatus {
-    OK = 200,
-    NO_CONTENT = 204,
-    BAD_REQUEST = 400,
-    NOT_FOUND = 404,
-    UNAUTHORIZED = 401,
-    FORBIDDEN = 403
-}
-export declare enum HttpStatusClass {
-    SUCCESS = 2,
-    CLIENT_ERROR = 4,
-    SERVER_ERROR = 5
-}
-export declare enum SurfColors {
-    INDIGO = "#331c7a",
-    ULTRAMARINE = "#1f69ff",
-    AQUAMARINE = "#4ceaaa",
-    ELECTRIC_LIME = "#c5f700",
-    CRAYOLA = "#f7a800",
-    ORANGE = "#f66d18",
-    RED = "#e72024",
-    LAVENDER = "#c0abff",
-    ULTRA_RED = "#f97585",
-    SOFT_GOLD = "#f4bd5d",
-    MAGIC_MINT = "#baf7db",
-    SKY_BLUE = "#7eceeb",
-    CARIBBEAN_GREN = "#0dcc91",
-    LAVENDER_GRAY = "#d3d3e0"
-}
-export declare enum IPServices {
-    IP2LOCATION = 1,
-    NEUSTAR = 2,
-    MAXMIND = 3,
-    NETACUITY = 4
-}
-export declare enum LocationType {
-    GPS = 1,
-    IP = 2,
-    USER = 3
-}
-export declare enum Environment {
-    PROD = "PROD",
-    STAGING = "STAGING",
-    LOCAL = "LOCAL",
-    MOCK = "MOCK"
-}

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

@@ -1,3 +0,0 @@
-export declare class NoBidResponseError extends Error {
-    constructor(message: string);
-}

package/lib/types/helpers/generators/CollectN.d.ts

@@ -1,2 +0,0 @@
-export declare function CollectN<T>(generator: Generator<T>, n: number): T[];
-export declare function CollectNAsync<T>(generator: AsyncGenerator<T>, n: number): Promise<T[]>;

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

@@ -1 +0,0 @@
-export * from './CollectN';

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

@@ -1,119 +0,0 @@
-/**
- * Converts the passed string to a slug with the specified options. By default, the slug is hyphenated and only
- * contains alphanumeric characters. You can pass a different hyphenation regex and a different drop regex to
- * customize the slug. For example, {{slug "My Product Name"}} will return "my-product-name".
- *
- * To change which characters are converted to hyphens, you can pass a regular expression to the hyphenate option.
- * For example, {{slug "My Product's Name" hyphenate="[\s']"}} will return "my-product-s-name".
- * The default hyphenate regex is /[\s_\-,]/ig.
- *
- * To remove characters instead of hyphenate them, you can pass a regular expression to the drop option.
- * For example, {{slug "My Product's Name" drop="[^A-Za-z0-9\s']"}} will return "my-product's-name".
- * The default drop regex is /[^A-Za-z0-9\-]/ig.
- *
- * To limit the max number of hyphenated slug components returned, you can pass a length option.
- * For example, {{slug "My Product's Name" length=2}} will return "my-product".
- * The default length is 5.
- *
- * @param name The string to be slugified
- * @param options The options object. Can take "hypenate", "drop", and "length" options.
- * @returns The slugified string
- */
-export declare function slug(name: string, options: {
-    hash: {
-        hyphenate: string | undefined;
-        drop: string | undefined;
-        length: number | undefined;
-    };
-}): string;
-/**
- * Converts the passed string to lowercase. For example, {{lower "My Product Name"}} will return "my product name".
- *
- * @param name The string to be converted to lowercase
- * @returns A lowercase version of the passed string
- */
-export declare function lower(name: string): string;
-/**
- * Returns the path component of the URL at the specified position, 1-indexed
- * For example, if the URL is "https://example.com/foo/bar", {{path 1}} will return "foo".
- *
- * @param position The position of the path component to return, 1-indexed
- * @returns The path component at the specified position
- */
-export declare function path(position: number): string;
-export declare function global(): any;
-export declare function sed(input: string, searchRegex: string, replacement: string): string;
-/**
- * Returns the value of the specified query parameter from the URL, specified by key.
- * For example, if the URL is "https://example.com?foo=bar", {{search "foo"}} will return "bar".
- *
- * @param name The name of the query parameter to return
- * @returns The value of the query parameter, or an empty string if the parameter is not found
- */
-export declare function search(name: string): string;
-/**
- * Returns the first truthy argument, or an empty string if all arguments are falsy. Returns false for empty strings
- * For example, {{coalesce false (eq "b" "d") c}} will return "c", because false is falsy, "b" is not equal to "d",
- * and c is truthy.
- *
- * @returns The first truthy argument, or an empty string if all arguments are falsy
- */
-export declare function coalesce(): string;
-/**
- * Joins the passed arguments with the specified separator.
- * For example, {{join "foo" "bar" "baz"}} will return "foo/bar/baz"..
- *
- * There is an optional "separator" argument that can be passed to change the separator. For example,
- * {{join "foo" "bar" "baz" separator=","}} will return "foo,bar,baz".
- *
- * @returns The joined string
- */
-export declare function join(): string;
-/**
- * Encodes the passed string for use in a URI component.
- *
- * @param component The string to encode
- * @returns The encoded string, or an empty string if the component is falsy
- */
-export declare function uri(component: string): string;
-/**
- * Returns true if the two passed arguments are equal (using javascript ===), false otherwise.
- *
- * @param a The first argument
- * @param b The second argument
- * @returns True if the two arguments are equal, false otherwise
- */
-export declare function eq(a: any, b: any): boolean;
-/**
- * Returns true if either of the passed arguments are truthy, false otherwise.
- *
- * @param a The first argument
- * @param b The second argument
- * @returns True if either of the arguments are truthy, false otherwise
- */
-export declare function or(a: any, b: any): boolean;
-/**
- * Returns true if both of the passed arguments are truthy, false otherwise.
- *
- * @param a The first argument
- * @param b The second argument
- * @returns True if both of the arguments are truthy, false otherwise
- */
-export declare function and(a: any, b: any): boolean;
-/**
- * Returns true if the first argument is in the second argument (an array). Otherwise, returns false.
- * If the second argument is not an array, or the array is empty, this will return false.
- *
- * The name of the helper is "in" but the name of the function is "isIn" because "in" is a reserved word in javascript.
- *
- * @param a The value to check
- * @param b The array to check against
- * @returns True if the value is in the array, false otherwise
- */
-export declare function isIn(a: any, b: any[]): boolean;
-/**
- * Returns an array of the passed arguments. Useful with the "in" helper
- *
- * @returns An array of the passed arguments
- */
-export declare function array(): any[];

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

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

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