@surfside/ads-core 2.0.1

package/lib/types/Api.d.ts

@@ -0,0 +1,169 @@
+import type { INativeTemplateDelegateWindow, ICompiledPublisherConfiguration, IDevice, IGeoContext } from './models';
+import { AsyncResult, INavigator, type IScreen, RequestBidsFn, ILogger, GetSponsoredProductFromNativeIdFn, PersonalRecommenderFn, NonPersonalRecommenderFn, GetConfigurationFn, GetGeoFn, GetDeviceFn, GetRecommendedProductFromProductIdFn, GetAllSponsoredProductFromNativeIdFn } from './services';
+import { BuildAllSponsoredProductCardResponsesFn, GenerateSponsoredProductCardResponseFn, NativeRequestBuilderFn, RequestBuilderFn } from './helpers';
+import Handlebars from 'handlebars/runtime';
+import { BuildHybridCarouselFn, BuildHybridCarouselFromInitialBidFn, BuildRecommendedCarouselFn, BuildSponsoredCarouselFn, BuildSponsoredCarouselFromInitialBidFn } from './helpers/response/Carousel';
+import { type EvaluateClickthroughTemplateFn, type EvaluateProductCardTemplateFn } from './services/Template';
+import { BuildDynamicZoneRequestFn, GetDynamicZoneFn } from './services/Dynamic';
+export declare const PROD_BIDDER = "//rtb.surfside.io/rtb/bids/surfside";
+export declare const PROD_CONFIGURATION_SERVICE = "//r.surfside.io";
+export declare const PROD_SPONSORED_PRODUCT_FEED = "//creative.surfside.io";
+export declare const PROD_RECOMMENDED_PRODUCT_FEED = "//creative.surfside.io";
+export declare const PROD_RECOMMENDER_SERVICE = "//t.surfside.io";
+export declare const PROD_DYNAMIC_ZONE_SERVICE = "//r.surfside.io/";
+/**
+ * A collection of services for querying the surfside API and building responses
+ */
+export interface ISurfsideApi {
+    /**
+     * An optional logger
+     */
+    logger?: ILogger;
+    /**
+     * Gets information about the User's device in OpenRTB's device format
+     */
+    getDevice: GetDeviceFn;
+    /**
+     * The user's device info
+     */
+    device: IDevice | undefined;
+    /**
+     * Gets the user's current current geo and IP information.
+     */
+    getGeo: GetGeoFn;
+    /**
+     * The user's current geo and IP information
+     */
+    geo: IGeoContext | undefined;
+    /**
+     * The site's publisher configuration. Product card templates, clickthrough URL templates, settings, etc.
+     */
+    configuration: ICompiledPublisherConfiguration;
+    /**
+     * Gets the site's publisher configuration
+     */
+    getConfiguration: GetConfigurationFn;
+    /**
+     * A handlebars runtime instance, for evaluating templates
+     */
+    handlebars: typeof Handlebars;
+    /**
+     * Sends a bid request to the bidder and returns its response, if available
+     */
+    requestBids: RequestBidsFn;
+    /**
+     * Builds an OpenRTB 2.6 request
+     */
+    startRequest: RequestBuilderFn;
+    /**
+     * Builds an OpenRTB Native 1.2 request
+     */
+    startNative: NativeRequestBuilderFn;
+    /**
+     * Builds an OpenRTB Native 1.2 request with initial fields, such as site, app, and trackers
+     */
+    defaultNative: NativeRequestBuilderFn;
+    /**
+     * Creates a sponsored product generator from the given Native Creative ID. One native creative ID can generate
+     * multiple products
+     */
+    getSponsoredProduct: GetSponsoredProductFromNativeIdFn;
+    /**
+     * Gets all sponsored products from the native creative ID. One native creative ID can generate multiple products
+     */
+    getAllSponsoredProducts: GetAllSponsoredProductFromNativeIdFn;
+    /**
+     * Gets the associated product info for the site from a product ID
+     */
+    getRecommendedProduct: GetRecommendedProductFromProductIdFn;
+    /**
+     * Creates a recommended product generator for the top (most popular) products on the site.
+     */
+    generateTopProducts: NonPersonalRecommenderFn;
+    /**
+     * Creates a recommended product generator for products recommended for the user. If there are no recommended
+     * products for the user, or if the API was initialized without a user ID, this will return a generator for top
+     * products instead
+     */
+    generateForYou: PersonalRecommenderFn;
+    /**
+     * Creates a recommended product generator based on the user's previously purchased products. If there are no
+     * recommended products for the user, or if the API was initialized without a user ID, this will return a generator
+     * for top products instead
+     */
+    generatePreviousPurchases: PersonalRecommenderFn;
+    /**
+     * Creates a carousel state object using the bid request. The state object is a callback function which sends the
+     * bid request to the bidder and generates product cards from it. When the bid is out of product cards, the
+     * generator will request more bids with the same bid request. If no bids are returned, the generator completes.
+     */
+    buildSponsoredCarousel: BuildSponsoredCarouselFn;
+    /**
+     * Creates a carousel state object using the bid request and initializes it with a pre-existing bid. This is used
+     * for dynamic zones and probably doesn't need to be used in any client applications. The state object is a callback
+     * function which sends the bid request to the bidder and generates product cards from it. When the bid is out of
+     * product cards, the generator will request more bids with the same bid request. If no bids are returned, the
+     * generator completes.
+     */
+    buildSponsoredCarouselFromInitialBid: BuildSponsoredCarouselFromInitialBidFn;
+    /**
+     * Creates a carousel state object with recommendations from the given recommender type (top product, for you,
+     * previous purchases). The state object is a callback function which sends the bid request to the bidder and
+     * generates product cards from it. When the bid is out of product cards, the generator will request more bids with
+     * the same bid request. If no bids are returned, the generator completes.
+     */
+    buildRecommendedCarousel: BuildRecommendedCarouselFn;
+    buildHybridCarousel: BuildHybridCarouselFn;
+    buildHybridCarouselFromInitialBid: BuildHybridCarouselFromInitialBidFn;
+    buildAllSponsoredProductCardResponses: BuildAllSponsoredProductCardResponsesFn;
+    generateSponsoredProductCardResponse: GenerateSponsoredProductCardResponseFn;
+    evaluateProductCardTemplate: EvaluateProductCardTemplateFn;
+    evaluateClickthroughTemplate: EvaluateClickthroughTemplateFn;
+    getDynamicZone: GetDynamicZoneFn;
+    buildDynamicZoneRequest: BuildDynamicZoneRequestFn;
+}
+/**
+ * Initializes the API with the services explicitly passed to it. This function is used by the framework for overloading
+ * mock services. It should not be used in an application
+ * @param internalApiDto The list of services and helpers to inject
+ * @returns An initialized Surfside API
+ */
+export declare function InitSurfAdsCoreInternal(internalApiDto: {
+    logger: ILogger | undefined;
+    requestBids: RequestBidsFn;
+    getConfiguration: GetConfigurationFn;
+    getGeo: GetGeoFn;
+    getDevice: GetDeviceFn;
+    getSponsoredProduct: GetSponsoredProductFromNativeIdFn;
+    getAllSponsoredProducts: GetAllSponsoredProductFromNativeIdFn;
+    getRecommendedProduct: GetRecommendedProductFromProductIdFn;
+    generateTopProducts: NonPersonalRecommenderFn;
+    generateForYou: PersonalRecommenderFn;
+    generatePreviousPurchases: PersonalRecommenderFn;
+    getDynamicZone: GetDynamicZoneFn;
+    buildAllSponsoredProductCardResponses: BuildAllSponsoredProductCardResponsesFn;
+    generateSponsoredProductCardResponse: GenerateSponsoredProductCardResponseFn;
+    evaluateProductCardTemplate: EvaluateProductCardTemplateFn;
+    evaluateClickthroughTemplate: EvaluateClickthroughTemplateFn;
+    handlebars: typeof Handlebars;
+    windowInfo: INativeTemplateDelegateWindow;
+    screenInfo: IScreen;
+    navigator: INavigator;
+    mobile: boolean;
+    ip: string | undefined;
+    geoProviderToken: string | undefined;
+    accountId: string;
+    siteId: string;
+    channelId: string;
+    locationId: string;
+    userId: string | undefined;
+}): AsyncResult<ISurfsideApi>;
+export declare const InitSurfAdsCoreServices: (logger: ILogger | undefined, bidderServiceUrl: string, configurationServiceUrl: string, productFeedUrl: string, recommendedProductFeedUrl: string, recommenderServiceUrl: string, dynamicZoneServiceUrl: string, windowInfo: INativeTemplateDelegateWindow, screenInfo: IScreen, navigator: INavigator, mobile: boolean, ip: string | undefined, geoProviderToken: string | undefined, accountId: string, siteId: string, channelId: string, locationId: string, userId: string | undefined) => AsyncResult<ISurfsideApi>;
+export declare const InitSurfAdsCoreSSR: (windowInfo: INativeTemplateDelegateWindow, screen: IScreen, navigator: INavigator, mobile: boolean, ip: string, geoProviderToken: string, accountId: string, siteId: string, channelId: string, locationId: string, userId: string | undefined, logger?: ILogger) => AsyncResult<ISurfsideApi>;
+export declare const InitSurfAdsCore: (channelId: string, accountId: string, siteId: string, locationId: string, userId: string | undefined, logger?: ILogger) => AsyncResult<ISurfsideApi>;
+export declare class MissingConfigurationError extends Error {
+    constructor(accountId: string, siteId: string);
+}
+export declare class NotABrowserError extends Error {
+    constructor();
+}

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

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

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

package/lib/types/helpers/Generator.d.ts

@@ -0,0 +1,5 @@
+export declare const ConsumeN: <T>(generator: Generator<T>, n: number) => T[];
+export declare const ConsumeAll: <T>(generator: Generator<T>) => T[];
+export declare const ConsumeNAsync: <T>(generator: AsyncGenerator<T>, n: number) => Promise<[data: T[], finished: boolean]>;
+export declare const ConsumeAllAsync: <T>(generator: AsyncGenerator<T>) => Promise<T[]>;
+export declare function GenerateArray<T>(data: T[]): Generator<T>;

package/lib/types/helpers/Handlebars.d.ts

@@ -0,0 +1,124 @@
+/**
+ * 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;
+        dropBefore: string | undefined;
+        length: number | undefined;
+        separator: string | 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;
+export declare function upper(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 | undefined;
+export declare function sed(input: string, searchRegex: string, replacement: string): string;
+export declare function replace(input: string, search: string, replacement: string, all?: boolean): 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[];
+export type HandlebarsHelpers = Record<string, Function>;
+export declare const GetHelpers: () => HandlebarsHelpers;

package/lib/types/helpers/NativeRequestBuilder.d.ts

@@ -0,0 +1,29 @@
+import { type INativeRequest } from '../models';
+import { ILogger } from '../services';
+export type NativeRequestBuilderFn = () => NativeRequestBuilder;
+export type NativeRequestBuilder = {
+    withVer: (ver: string) => NativeRequestBuilder;
+    withContext: (context: number) => NativeRequestBuilder;
+    withContextSubType: (contextSubType: number) => NativeRequestBuilder;
+    withPlacementType: (placementType: number) => NativeRequestBuilder;
+    withTitle: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withImage: (width: number, height: number, minWidth?: number, minHeight?: number, required?: boolean) => NativeRequestBuilder;
+    withVideo: (mimes: number[] | string[], minDuration: number, maxDuration: number, required?: boolean) => NativeRequestBuilder;
+    withData: (type: number, id: number, length?: number, required?: boolean) => NativeRequestBuilder;
+    withSponsored: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withDescription: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withRating: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withPrice: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withSalePrice: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withDisplayURL: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withCTAText: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withCategory: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withTHC: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withCBD: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withStrain: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withMetaProduct: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withEventTracker: (event: number, methods: number[]) => NativeRequestBuilder;
+    build: () => INativeRequest;
+};
+export declare const StartNative: (logger: ILogger | undefined) => NativeRequestBuilder;
+export declare const DefaultNative: (logger: ILogger | undefined) => NativeRequestBuilder;

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

@@ -0,0 +1,16 @@
+import { type IApp, type IBanner, type IBidRequest, type IDevice, type IGeoContext, type IImp, type INative, type INativeRequest, type IRegs, type ISite, type IUser, type IVideo } from '../models';
+import { ILogger } from '../services';
+export type RequestBuilderFn = (zoneId: string, id?: string) => RequestBuilder;
+export type RequestWith<T> = (t: T) => RequestBuilder;
+export type RequestBuilder = {
+    withUser: RequestWith<IUser>;
+    withRegulations: RequestWith<IRegs>;
+    withApp: RequestWith<IApp>;
+    withSite: RequestWith<ISite>;
+    withKeywords: RequestWith<string[]>;
+    withBanner: (w: number, h: number, options?: Partial<IBanner>, impOptions?: Partial<IImp>) => RequestBuilder;
+    withVideo: (w: number, h: number, minduration: number, maxduration: number, mimes?: string[], options?: Partial<IVideo>, impOptions?: Partial<IImp>) => RequestBuilder;
+    withNative: (request: string | INativeRequest, options?: Partial<INative>, impOptions?: Partial<IImp>) => RequestBuilder;
+    build: () => IBidRequest;
+};
+export declare function StartRequest(logger: ILogger | undefined, accountId: string, siteId: string, channelId: string, locationId: string, device: IDevice | undefined, geo: IGeoContext | undefined, userId: string | undefined, zoneId: string, id?: string): RequestBuilder;

package/lib/types/helpers/TryGet.d.ts

@@ -0,0 +1,2 @@
+import { Result } from '../services';
+export declare const TryGet: <T>(get: () => T) => Result<T>;

package/lib/types/helpers/Window.d.ts

@@ -0,0 +1,3 @@
+import { INativeTemplateDelegateWindow } from '../models';
+import { Result } from '../services';
+export declare const GetWindowInfo: () => Result<INativeTemplateDelegateWindow>;

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

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

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

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

@@ -0,0 +1,119 @@
+/**
+ * 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/index.d.ts

@@ -0,0 +1,7 @@
+export * from './NativeRequestBuilder';
+export * from './RequestBuilder';
+export * from './response';
+export * from './Handlebars';
+export * from './TryGet';
+export * from './Window';
+export * from './Generator';

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

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