@surfside/ads-core 2.0.1

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

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

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

package/lib/types/helpers/response/Banner.d.ts

@@ -0,0 +1,22 @@
+import { IBuiltResponse } from './BuiltResponse';
+/**
+ * A built banner response - includes the `adm` field for the banner as well as the rendered commerce media
+ * clickthrough URL template, if applicable.
+ *
+ * @expandType IBuiltResponse
+ */
+export interface IBuiltBannerResponse extends IBuiltResponse {
+    /**
+     * Indicates the type of the {@link IBuiltResponse}. 0 means Banner
+     */
+    type: 'banner';
+    /**
+     * The HTML of the banner creative
+     */
+    adm: string;
+    /**
+     * The clickthrough URL of the creative, if it the banner is a commerce media creative (i.e, the URL is built from
+     * the clickthrough URL template). For regular static banners that click out to 3rd party sites, this is `undefined`
+     */
+    clickthrough?: string;
+}

package/lib/types/helpers/response/BuiltResponse.d.ts

@@ -0,0 +1,31 @@
+import { IBid } from '../../models';
+export declare const CreativeType: {
+    readonly Banner: 0;
+    readonly Video: 1;
+    readonly ProductCard: 2;
+    readonly Carousel: 3;
+};
+/**
+ * A built creative response. Includes the bid response which fed the creative as well as a `type` field indicating what
+ * kind of creative it is (i.e, {@link IBuiltBannerResponse }, {@link IBuiltVideo}, {@link IBuiltProductCardResponse},
+ * {@link IBuiltCarousel}).
+ *
+ * @see IBuiltBannerResponse
+ * @see IBuiltVideo
+ * @see IBuiltProductCardResponse
+ * @see IBuiltCarousel
+ */
+export interface IBuiltResponse {
+    /**
+     * The OpenRTB Bid object which created this creative
+     */
+    bid: IBid;
+}
+export declare class MissingAdmError extends Error {
+    readonly bid: IBid | null;
+    constructor(bid: IBid | null);
+}
+export declare class MissingProductError extends Error {
+    readonly bid?: IBid | undefined;
+    constructor(bid?: IBid | undefined);
+}

package/lib/types/helpers/response/Carousel.d.ts

@@ -0,0 +1,51 @@
+import type { IBid, IBidRequest } from '../../models';
+import { type ILogger, type NonPersonalRecommenderFn, type PersonalRecommenderFn, type RequestBidsFn, type Result } from '../../services';
+import { EvaluateClickthroughTemplateFn } from '../../services/Template';
+import type { GenerateSponsoredProductCardResponseFn, IBuiltProductCardResponse } from './ProductCard';
+export type BuildSponsoredCarouselFn = (request: IBidRequest) => Result<IBuiltCarousel>;
+export type BuildSponsoredCarouselFromInitialBidFn = (request: IBidRequest, initialBid: IBid) => Result<IBuiltCarousel>;
+export type BuildRecommendedCarouselFn = (RecommenderType: PublicRecommenderType) => Result<IBuiltCarousel>;
+export type BuildHybridCarouselFn = (recommenderType: PublicRecommenderType, request: IBidRequest) => Result<IBuiltCarousel>;
+export type BuildHybridCarouselFromInitialBidFn = (RecommenderType: PublicRecommenderType, request: IBidRequest, initialBid: IBid) => Result<IBuiltCarousel>;
+export type CarouselNextProductFn = () => AsyncGenerator<IBuiltProductCardResponse>;
+export interface IBuiltCarousel {
+    type: 'carousel';
+    getProduct: CarouselNextProductFn;
+}
+export type RecommenderType = 'top-products' | 'for-you' | 'past-purchases';
+export interface IPublicTopProductsRecommenderType {
+    type: 'top-products';
+}
+export interface IPublicForYouRecommenderType {
+    type: 'for-you';
+}
+export interface IPublicPastPurchasesRecommenderType {
+    type: 'past-purchases';
+}
+export type PublicRecommenderType = IPublicTopProductsRecommenderType | IPublicForYouRecommenderType | IPublicPastPurchasesRecommenderType;
+export interface ITopProductRecommender {
+    recommenderType: 'top-products';
+    topProductGenerator: NonPersonalRecommenderFn;
+}
+export interface IForYouProductRecommender {
+    recommenderType: 'for-you';
+    forYouProductGenerator: PersonalRecommenderFn;
+    topProductGenerator: NonPersonalRecommenderFn;
+    userId?: string;
+}
+export interface IPastPurchasesProductRecommender {
+    recommenderType: 'past-purchases';
+    pastPurchasesProductGenerator: PersonalRecommenderFn;
+    topProductGenerator: NonPersonalRecommenderFn;
+    userId?: string;
+}
+export type ProductRecommender = ITopProductRecommender | IForYouProductRecommender | IPastPurchasesProductRecommender;
+export declare const BuildSponsoredCarousel: (logger: ILogger | undefined, requestBids: RequestBidsFn, generateProductCardResponse: GenerateSponsoredProductCardResponseFn, request: IBidRequest) => Result<IBuiltCarousel>;
+export declare const BuildSponsoredCarouselFromInitialBid: (logger: ILogger | undefined, requestBids: RequestBidsFn, generateProductCardResponse: GenerateSponsoredProductCardResponseFn, request: IBidRequest, initialBid: IBid) => Result<IBuiltCarousel>;
+export declare const BuildRecommendedCarousel: (logger: ILogger | undefined, evaluateClickthroughTemplate: EvaluateClickthroughTemplateFn, topProductGenerator: NonPersonalRecommenderFn, forYouProductGenerator: PersonalRecommenderFn, pastPurchasesProductGenerator: PersonalRecommenderFn, userId: string | undefined, recommenderType: PublicRecommenderType) => Result<IBuiltCarousel>;
+export declare const BuildHybridCarousel: (logger: ILogger | undefined, evaluateClickthroughTemplate: EvaluateClickthroughTemplateFn, requestBids: RequestBidsFn, generateProductCardResponse: GenerateSponsoredProductCardResponseFn, topProductGenerator: NonPersonalRecommenderFn, forYouProductGenerator: PersonalRecommenderFn, pastPurchasesProductGenerator: PersonalRecommenderFn, userId: string | undefined, recommenderType: PublicRecommenderType, request: IBidRequest) => Result<IBuiltCarousel>;
+export declare const BuildHybridCarouselFromInitialBid: (logger: ILogger | undefined, evaluateClickthroughTemplate: EvaluateClickthroughTemplateFn, requestBids: RequestBidsFn, generateProductCardResponse: GenerateSponsoredProductCardResponseFn, topProductGenerator: NonPersonalRecommenderFn, forYouProductGenerator: PersonalRecommenderFn, pastPurchasesProductGenerator: PersonalRecommenderFn, userId: string | undefined, recommenderType: PublicRecommenderType, request: IBidRequest, initialBid: IBid) => Result<IBuiltCarousel>;
+export declare class InvalidRecommenderTypeError extends Error {
+    type: string;
+    constructor(type: string);
+}

package/lib/types/helpers/response/Clickthrough.d.ts

@@ -0,0 +1,3 @@
+import type { ICompiledPublisherConfiguration, INativeTemplateDelegateWindow, IProductInformation } from '../../models';
+import { ILogger, Result } from '../../services';
+export declare const BuildClickthroughUrl: (logger: ILogger | undefined, windowInfo: INativeTemplateDelegateWindow, configuration: ICompiledPublisherConfiguration, product: IProductInformation) => Result<string>;

package/lib/types/helpers/response/ProductCard.d.ts

@@ -0,0 +1,49 @@
+import { IBid, ICompiledPublisherConfiguration, INativeResponse, INativeTemplateDelegateWindow, IProductInformation } from '../../models';
+import { AsyncResult, GetAllSponsoredProductFromNativeIdFn, ILogger } from '../../services';
+import { IBuiltResponse } from './BuiltResponse';
+export type BuildAllSponsoredProductCardResponsesFn = (bids: IBid[]) => AsyncResult<IBuiltProductCardBidResponse[]>;
+export type GenerateSponsoredProductCardResponseFn = (bids: IBid[]) => AsyncGenerator<IBuiltProductCardBidResponse>;
+export interface ITracker {
+    type: number;
+    url: string;
+}
+export interface IPixelTracker extends ITracker {
+    type: 1;
+}
+export interface IScriptTracker extends ITracker {
+    type: 2;
+}
+export interface ITrackerObject {
+    win: string;
+    imp: string[];
+    others: ITracker[];
+}
+export type IBuiltProductCardBidResponse = IBuiltResponse & IBuiltProductCardResponse & {
+    native: INativeResponse;
+    sponsored: true;
+};
+export interface IBuiltProductCardResponse {
+    type: 'product-card';
+    product: IProductInformation;
+    trackers?: ITrackerObject;
+    clickthrough: string;
+    sponsored: boolean;
+}
+export declare const BuildAllSponsoredProductCardResponses: (logger: ILogger | undefined, getAllSponsoredProducts: GetAllSponsoredProductFromNativeIdFn, windowInfo: INativeTemplateDelegateWindow, configuration: ICompiledPublisherConfiguration, bids: IBid[]) => AsyncResult<IBuiltProductCardBidResponse[]>;
+export declare function GenerateSponsoredProductCardResponse(logger: ILogger | undefined, getAllSponsoredProducts: GetAllSponsoredProductFromNativeIdFn, windowInfo: INativeTemplateDelegateWindow, configuration: ICompiledPublisherConfiguration, bids: IBid[]): AsyncGenerator<IBuiltProductCardBidResponse>;
+export declare class MissingBidsError extends Error {
+    constructor();
+}
+export declare class MalformedNativeResponseError extends Error {
+    readonly bid: IBid;
+    constructor(bid: IBid);
+}
+export declare class MissingWinUrlError extends Error {
+    readonly bid: IBid;
+    constructor(bid: IBid);
+}
+export declare class MissingProductIdError extends Error {
+    readonly bid: IBid;
+    readonly native: INativeResponse;
+    constructor(bid: IBid, native: INativeResponse);
+}

package/lib/types/helpers/response/Video.d.ts

@@ -0,0 +1,17 @@
+import { IVast } from '../../models';
+import { IBuiltResponse } from './BuiltResponse';
+/**
+ * A built video response. The raw Vast XML response from the bidder has been parsed out into a structure object here.
+ * @expandType IBuiltResponse
+ */
+export interface IBuiltVideo extends IBuiltResponse {
+    type: 'video';
+    /**
+     * The parsed out Vast Video object
+     */
+    video: IVast;
+    /**
+     * The clickthrough URL for the video
+     */
+    clickthrough: string;
+}

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

@@ -0,0 +1,6 @@
+export * from './BuiltResponse';
+export * from './Banner';
+export * from './Clickthrough';
+export * from './ProductCard';
+export * from './Video';
+export * from './Carousel';

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

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

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

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

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

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

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

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

package/lib/types/index.d.ts

@@ -0,0 +1,4 @@
+export * from './helpers';
+export * from './models';
+export * from './services';
+export * from './Api';

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

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

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

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

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

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

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

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

package/lib/types/models/dynamic/DynamicZone.d.ts

@@ -0,0 +1,37 @@
+export interface IDynamicZone {
+    value: IScreenSize[];
+}
+export interface IScreenSize {
+    size: 'default' | 'mobile' | 'tablet' | 'desktop';
+    values: DynamicCreative[];
+}
+export interface IDynamicCreative {
+    zoneId: string;
+    keywords?: string[];
+}
+export interface IDynamicSimpleCreative extends IDynamicCreative {
+    width: number;
+    height: number;
+}
+export interface IDynamicCatalogCreative extends IDynamicCreative {
+    strategy?: 'sponsored' | 'hybrid' | 'recommended';
+    recommendation?: 'top-products' | 'for-you' | 'past-purchases';
+}
+export interface IDynamicVideo extends IDynamicSimpleCreative {
+    type: 'Video';
+    minDuration?: number;
+    maxDuration: number;
+}
+export interface IDynamicBanner extends IDynamicSimpleCreative {
+    type: 'Banner';
+}
+export interface IDynamicProductCard extends IDynamicCatalogCreative {
+    type: 'ProductCard';
+}
+export interface IDynamicCarousel extends IDynamicCatalogCreative {
+    type: 'Carousel';
+    maxItems?: number;
+    cardMinWidth: number;
+    nextType: 'page' | 'product';
+}
+export type DynamicCreative = IDynamicBanner | IDynamicCarousel | IDynamicProductCard | IDynamicVideo;

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

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

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

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

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

@@ -0,0 +1,66 @@
+import type { IDynamicZone, IProductInformation } from '../../models';
+export type ProductCallback = (e: Event, product: IProductInformation) => void;
+export type Callbacks = Record<string, ProductCallback>;
+export type TemplateDelegate = (context: IProductContext) => string;
+export interface INativeTemplateDelegateWindow {
+    href: string;
+    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 extends IProductInformation {
+    product: Partial<IProductInformation>;
+    window: INativeTemplateDelegateWindow;
+    publisher: ICompiledPublisherConfiguration;
+    catalog: IProductInformation;
+    clickthrough?: string;
+    ext?: any;
+}
+export interface ICompiledPublisherConfigurationTemplates {
+    productCardTemplate: TemplateDelegate;
+    clickThroughUrlTemplate: TemplateDelegate;
+    productCardStylesheet: string;
+    carouselStylesheet: string;
+    javascriptCallbacks: Callbacks;
+}
+export interface ICompiledPublisherConfigurationSettingsDTO {
+    commerceMediaEnabled: boolean;
+    ipTargetingEnabled: boolean;
+    geoTargetingEnabled: boolean;
+    reauctionEnabled: boolean;
+    reauctionIntervalMs: number;
+    productFeedEnabled: boolean;
+    sponsoredByEnabled?: boolean;
+}
+export interface ICompiledPublisherConfigurationDTO {
+    templates: ICompiledPublisherConfigurationTemplatesDTO;
+    settings: ICompiledPublisherConfigurationSettingsDTO;
+    dynamicZones?: Record<string, IDynamicZone>;
+}
+export interface ICompiledPublisherConfiguration {
+    settings: ICompiledPublisherConfigurationSettingsDTO;
+    templates: ICompiledPublisherConfigurationTemplates;
+    dynamicZones?: Record<string, IDynamicZone>;
+}

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

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

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

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

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

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

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

@@ -0,0 +1,19 @@
+export interface IProductInformation {
+    id?: string;
+    image?: string;
+    price?: string;
+    salePrice?: string;
+    thc?: string;
+    strain?: string;
+    cbd?: string;
+    name?: string;
+    brand_name?: string;
+    brandName?: string;
+    productType?: string;
+    details?: string;
+    cta?: string;
+    clickthroughUrl?: string;
+    winUrl?: string;
+    pixelUrl?: string;
+    ext?: any;
+}

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

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

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

@@ -0,0 +1,3 @@
+export * from './Configuration';
+export * from './Product';
+export * from './Recommended';