@surfside/ads-core-client 0.1.0

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

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

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

@@ -0,0 +1,7 @@
+import { type IBid, type IBuiltBannerResponse, type ICompiledPublisherConfiguration, type ILogger, type INativeTemplateDelegateWindow, type IProductInformation, type Result } from '@surfside/ads-core';
+export type BuildBannerResponseFn = (bid: IBid) => Result<IBuiltBannerResponse>;
+export declare const BuildBannerResponse: (logger: ILogger | undefined, windowInfo: INativeTemplateDelegateWindow, config: ICompiledPublisherConfiguration, bid: IBid) => Result<IBuiltBannerResponse>;
+export declare const getProductInfoFromDivTag: (logger: ILogger | undefined, div: HTMLElement | null, bid: IBid) => Result<IProductInformation>;
+export declare class MissingProductInfoError extends Error {
+    constructor();
+}

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

@@ -0,0 +1,17 @@
+import { type AsyncResult, type BuildAllSponsoredProductCardResponsesFn, type IBidRequest, type IBidResponse, type IBuiltBannerResponse, type IBuiltProductCardBidResponse, type IBuiltProductCardResponse, type IBuiltVideo, type ILogger } from '@surfside/ads-core';
+import { type BuildBannerResponseFn } from './Banner';
+import { type BuildVideoResponseFn } from './Video';
+export type BuildAllResponsesFn = (request: IBidRequest, response: IBidResponse) => AsyncResult<IBuiltResponseCollection>;
+export type GenerateAllResponsesFn = (request: IBidRequest, response: IBidResponse, pageSize: number) => AsyncResult<IBuiltResponseGeneratorCollection>;
+export interface IBuiltResponseCollection {
+    banners: IBuiltBannerResponse[];
+    videos: IBuiltVideo[];
+    productCards: IBuiltProductCardBidResponse[];
+}
+export interface IBuiltResponseGeneratorCollection {
+    banners: IBuiltBannerResponse[];
+    videos: IBuiltVideo[];
+    productCards?: IBuiltProductCardResponse[];
+}
+export declare const BuildAllResponses: (logger: ILogger | undefined, buildBannerResponse: BuildBannerResponseFn, buildVideoResponse: BuildVideoResponseFn, buildAllProductCardResponses: BuildAllSponsoredProductCardResponsesFn, request: IBidRequest, response: IBidResponse) => AsyncResult<IBuiltResponseCollection>;
+export declare const GenerateAllResponses: (logger: ILogger | undefined, buildBannerResponse: BuildBannerResponseFn, buildVideoResponse: BuildVideoResponseFn, buildProductCard: BuildAllSponsoredProductCardResponsesFn, request: IBidRequest, response: IBidResponse) => AsyncResult<IBuiltResponseGeneratorCollection>;

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

@@ -0,0 +1,24 @@
+import { type AsyncResult, type ILogger, type RequestBidsFn, type BuildHybridCarouselFromInitialBidFn, type BuildSponsoredCarouselFromInitialBidFn, type BuildRecommendedCarouselFn, type IBuiltProductCardResponse, type IBuiltCarousel, type BuildAllSponsoredProductCardResponsesFn, type IBuiltBannerResponse, type IBuiltVideo, type IDynamicBanner, type IDynamicVideo, type IDynamicProductCard } from '@surfside/ads-core';
+import { type IDynamicZoneRequest } from '@surfside/ads-core';
+import { type BuildBannerResponseFn } from './Banner';
+import { type BuildVideoResponseFn } from './Video';
+import { type IDynamicCarousel } from '@surfside/ads-core';
+export type BuildDynamicResponseFn = (dynamicRequest: IDynamicZoneRequest) => AsyncResult<IBuiltDynamicResponse>;
+export interface IBuiltDynamicCarousel extends IBuiltCarousel {
+    dynamicCarouselRequest: IDynamicCarousel;
+}
+export interface IBuiltDynamicBanner extends IBuiltBannerResponse {
+    dynamicBannerRequest: IDynamicBanner;
+}
+export interface IBuiltDynamicVideo extends IBuiltVideo {
+    dynamicVideoRequest: IDynamicVideo;
+}
+export interface IBuiltDynamicProductCard extends IBuiltProductCardResponse {
+    dynamicProductCardRequest: IDynamicProductCard;
+}
+export type IBuiltDynamicResponse = IBuiltDynamicBanner | IBuiltDynamicVideo | IBuiltDynamicProductCard | IBuiltDynamicCarousel;
+export declare const BuildDynamicResponse: (logger: ILogger | undefined, requestBids: RequestBidsFn, buildBannerResponse: BuildBannerResponseFn, buildVideoResponse: BuildVideoResponseFn, buildHybridCarousel: BuildHybridCarouselFromInitialBidFn, buildSponsoredCarousel: BuildSponsoredCarouselFromInitialBidFn, buildRecommendedCarousel: BuildRecommendedCarouselFn, buildAllSponsoredProductCardResponses: BuildAllSponsoredProductCardResponsesFn, dynamicRequest: IDynamicZoneRequest) => AsyncResult<IBuiltDynamicResponse>;
+export declare class NoDynamicAdsAvailableError extends Error {
+    readonly dynamicRequest: IDynamicZoneRequest;
+    constructor(dynamicRequest: IDynamicZoneRequest);
+}

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

@@ -0,0 +1,33 @@
+import { type IBid, type IVast, type ILogger, type Result, type IBuiltVideo, type INativeTemplateDelegateWindow, type ICompiledPublisherConfiguration } from '@surfside/ads-core';
+export type BuildVideoResponseFn = (bid: IBid) => Result<IBuiltVideo>;
+export declare const BuildVideoResponse: (logger: ILogger | undefined, windowInfo: INativeTemplateDelegateWindow, configuration: ICompiledPublisherConfiguration, bid: IBid) => Result<IBuiltVideo>;
+export declare const DeserializeVideo: (logger: ILogger | undefined, bid: IBid) => Result<IVast>;
+export declare function DeserializeVast(logger: ILogger | undefined, adm: string): Result<IVast>;
+export declare class MissingChildTagError extends Error {
+    element: Element | undefined;
+    tagName: string;
+    constructor(element: Element | undefined, tagName: string);
+}
+export declare class MissingAttributeError extends Error {
+    element: Element;
+    attributeName: string;
+    constructor(element: Element, attributeName: string);
+}
+export declare class NotANumberError extends Error {
+    element: Element;
+    attributeName: string;
+    constructor(element: Element, attributeName: string);
+}
+export declare class MissingTextContentError extends Error {
+    element: Element;
+    attributeName: string;
+    constructor(element: Element, attributeName: string);
+}
+export declare class MissingCreativeError extends Error {
+    vast: IVast;
+    constructor(vast: IVast);
+}
+export declare class MissingClickthroughUrlError extends Error {
+    vast: IVast;
+    constructor(vast: IVast);
+}

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

@@ -0,0 +1,4 @@
+export * from './Banner';
+export * from './Video';
+export * from './BuildAll';
+export * from './Dynamic';

package/lib/types/index.d.ts

@@ -0,0 +1,52 @@
+import { type AsyncResult, type BuildAllSponsoredProductCardResponsesFn, type GenerateSponsoredProductCardResponseFn, type GetAllSponsoredProductFromNativeIdFn, type GetConfigurationFn, type GetDeviceFn, type GetGeoFn, type GetRecommendedProductFromProductIdFn, type GetSponsoredProductFromNativeIdFn, type ILogger, type INativeTemplateDelegateWindow, type INavigator, type IScreen, type ISurfsideApi, type NonPersonalRecommenderFn, type PersonalRecommenderFn, type RequestBidsFn, type EvaluateClickthroughTemplateFn, type EvaluateProductCardTemplateFn } from '@surfside/ads-core';
+import { type BuildAllResponsesFn, type BuildBannerResponseFn, type BuildVideoResponseFn, type GenerateAllResponsesFn } from './helpers';
+import { type GetDynamicZoneFn } from '@surfside/ads-core';
+import { type BuildDynamicResponseFn } from './helpers/response/Dynamic';
+export * from '@surfside/ads-core';
+export * from './helpers';
+export interface ISurfsideClientApi extends ISurfsideApi {
+    buildBannerResponse: BuildBannerResponseFn;
+    buildVideoResponse: BuildVideoResponseFn;
+    buildAllResponses: BuildAllResponsesFn;
+    generateAllResponses: GenerateAllResponsesFn;
+    buildDynamicResponse: BuildDynamicResponseFn;
+    screenInfo: IScreen;
+    windowInfo: INativeTemplateDelegateWindow;
+    navigator: INavigator;
+}
+export declare const InitSurfAdsCoreClientInternal: (internalClientApiDto: {
+    logger: ILogger | undefined;
+    requestBids: RequestBidsFn;
+    getConfiguration: GetConfigurationFn;
+    getGeo: GetGeoFn;
+    getDevice: GetDeviceFn;
+    getSponsoredProduct: GetSponsoredProductFromNativeIdFn;
+    getAllSponsoredProducts: GetAllSponsoredProductFromNativeIdFn;
+    getRecommendedProduct: GetRecommendedProductFromProductIdFn;
+    generateTopProducts: NonPersonalRecommenderFn;
+    generateForYou: PersonalRecommenderFn;
+    generatePreviousPurchases: PersonalRecommenderFn;
+    buildAllProductCardResponses: BuildAllSponsoredProductCardResponsesFn;
+    generateProductCardResponse: GenerateSponsoredProductCardResponseFn;
+    buildBannerResponse: BuildBannerResponseFn;
+    buildVideoResponse: BuildVideoResponseFn;
+    buildAllResponses: BuildAllResponsesFn;
+    getDynamicZone: GetDynamicZoneFn;
+    generateAllResponses: GenerateAllResponsesFn;
+    evaluateProductCardTemplate: EvaluateProductCardTemplateFn;
+    evaluateClickthroughTemplate: EvaluateClickthroughTemplateFn;
+    handlebars: typeof Handlebars;
+    screenInfo: IScreen;
+    windowInfo: INativeTemplateDelegateWindow;
+    navigator: INavigator;
+    mobile: boolean;
+    ip: string | undefined;
+    geoProviderToken: string | undefined;
+    accountId: string;
+    siteId: string;
+    channelId: string;
+    locationId: string;
+    userId: string | undefined;
+}) => AsyncResult<ISurfsideClientApi>;
+export declare const InitSurfAdsCoreClientServices: (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<ISurfsideClientApi>;
+export declare const InitSurfAdsCoreClient: (accountId: string, siteId: string, channelId: string, locationId: string, userId: string | undefined, logger?: ILogger) => AsyncResult<ISurfsideClientApi>;

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@surfside/ads-core-client",
+  "module": "./lib/esm/index.js",
+  "main": "./lib/cjs/index.js",
+  "types": "./lib/types/index.d.ts",
+  "version": "0.1.0",
+  "license": "UNLICENSED",
+  "files": [
+    "lib/",
+    "README.md"
+  ],
+  "type": "module",
+  "scripts": {
+    "build": "bun run bun.build.ts",
+    "lint": "npx eslint"
+  },
+  "dependencies": {
+    "@surfside/ads-core": "^2.0.0"
+  },
+  "devDependencies": {
+    "@types/bun": "latest"
+  },
+  "peerDependencies": {
+    "typescript": "^5"
+  }
+}