@surfside/ads-core-web 0.1.0

package/lib/types/debug/carousel.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/types/debug/dist/index-7was9ptg.d.ts

@@ -0,0 +1,2 @@
+declare const _exports: any;
+export = _exports;

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

@@ -0,0 +1,16 @@
+import { type Result } from '@surfside/ads-core-client';
+export declare const GetAttribute: (element: Element, attributeName: string) => Result<string>;
+export declare const GetAttributeOr: (element: Element, attributeName: string, or: string) => string;
+export declare const GetNumberAttribute: (element: Element, attributeName: string) => Result<number>;
+export declare const GetNumberAttributeOr: (element: Element, attributeName: string, or: number) => number;
+export declare class MissingAttributeError extends Error {
+    readonly element: Element;
+    readonly attributeName: string;
+    constructor(element: Element, attributeName: string);
+}
+export declare class NotANumberError extends Error {
+    readonly element: Element;
+    readonly attributeName: string;
+    readonly value: string;
+    constructor(element: Element, attributeName: string, value: string);
+}

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

@@ -0,0 +1,2 @@
+export declare const PixelTracker: (url: string) => HTMLImageElement;
+export declare const ScriptTracker: (url: string) => HTMLScriptElement;

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

@@ -0,0 +1,2 @@
+export * from './Dom';
+export * from './Trackers';

package/lib/types/index.d.ts

@@ -0,0 +1,15 @@
+import { type AsyncResult, type ILogger, type ISurfsideClientApi } from '@surfside/ads-core-client';
+import { type RenderCarouselFn } from './rendering/Carousel';
+import { type RenderBannerFn } from './rendering';
+import { type RenderProductCardFn } from './rendering/ProductCard';
+import { type RenderVideoFn } from './rendering/Video';
+export * from './rendering';
+export * from './helpers';
+export interface ISurfsideWebApi extends ISurfsideClientApi {
+    renderBanner: RenderBannerFn;
+    renderVideo: RenderVideoFn;
+    renderProductCard: RenderProductCardFn;
+    renderCarousel: RenderCarouselFn;
+}
+export declare const InitSurfAdsWebInternal: (apiResAsync: AsyncResult<ISurfsideClientApi>) => AsyncResult<ISurfsideWebApi>;
+export declare const InitSurfAdsWeb: (accountId: string, siteId: string, channelId: string, locationId: string, userId: string | undefined, logger?: ILogger) => AsyncResult<ISurfsideWebApi>;

package/lib/types/rendering/Banner.d.ts

@@ -0,0 +1,7 @@
+import { type IBuiltBannerResponse, type ILogger, type Result } from '@surfside/ads-core';
+export type RenderBannerFn = (builtBanner: IBuiltBannerResponse) => Result<HTMLElement>;
+export declare const RenderBanner: (logger: ILogger | undefined, builtBanner: IBuiltBannerResponse) => Result<HTMLElement>;
+export declare class MissingNurlError extends Error {
+    readonly bannerResponse: IBuiltBannerResponse;
+    constructor(bannerResponse: IBuiltBannerResponse);
+}

package/lib/types/rendering/Carousel.d.ts

@@ -0,0 +1,25 @@
+import { type AsyncResult, type Callbacks, type ILogger } from '@surfside/ads-core-client';
+import type { IBuiltCarousel } from '@surfside/ads-core';
+import type { EvaluateProductCardTemplateFn } from '@surfside/ads-core';
+export interface ILimitedCarousel {
+    type: 'limited';
+    limit: number;
+}
+export interface IInfiniteCarousel {
+    type: 'infinite';
+}
+export type CarouselLimits = ILimitedCarousel | IInfiniteCarousel;
+export interface IRenderedCarousel {
+    element: HTMLElement;
+    init: () => AsyncResult<boolean>;
+}
+export type RenderCarouselFn = (carousel: IBuiltCarousel, cardMinWidth: number, carouselLimits: CarouselLimits, nextType: 'page' | 'product') => AsyncResult<IRenderedCarousel>;
+export declare const RenderCarousel: (logger: ILogger | undefined, evaluateProductCardTemplate: EvaluateProductCardTemplateFn, sponsoredByEnabled: boolean, productCardStylesheet: string, carouselStylesheet: string, callbacks: Callbacks, carousel: IBuiltCarousel, cardMinWidth: number, carouselLimits: CarouselLimits, nextType: "page" | "product") => AsyncResult<IRenderedCarousel>;
+export declare class MalformedCarouselError extends Error {
+    readonly parent: HTMLElement;
+    constructor(parent: HTMLElement);
+}
+export declare class EmptyFirstPageError extends Error {
+    readonly parent: HTMLElement;
+    constructor(parent: HTMLElement);
+}

package/lib/types/rendering/Framework.d.ts

@@ -0,0 +1,13 @@
+import { type Callbacks, type ILogger, type IProductInformation, type Result } from '@surfside/ads-core';
+export interface IProductCallbackWrapper {
+    callbacks: Callbacks;
+    product: IProductInformation;
+}
+export declare const Template: (logger: ILogger | undefined, className: string, template: string, style?: string, callbacks?: IProductCallbackWrapper) => Result<HTMLElement>;
+export declare const QuerySelectorResult: (element: Element, selector: string) => Result<Element>;
+export declare const ReplaceWith: (parent: Element, originalSelector: string, element: Element) => Result<Element>;
+export declare class MissingTemplateElementError extends Error {
+    readonly parent: Element;
+    readonly selector: string;
+    constructor(parent: Element, selector: string);
+}

package/lib/types/rendering/ProductCard.d.ts

@@ -0,0 +1,8 @@
+import { type Callbacks, type IBuiltProductCardResponse, type ILogger, type Result } from '@surfside/ads-core-client';
+import type { EvaluateProductCardTemplateFn } from '@surfside/ads-core';
+export type RenderProductCardFn = (productCard: IBuiltProductCardResponse) => Result<HTMLElement>;
+export declare const RenderProductCard: (logger: ILogger | undefined, stylesheet: string, javascriptCallbacks: Callbacks, evaluateProductCardTemplate: EvaluateProductCardTemplateFn, productCard: IBuiltProductCardResponse) => Result<HTMLElement>;
+export declare class MissingTrackersError extends Error {
+    readonly productCardResponse: IBuiltProductCardResponse;
+    constructor(productCardResponse: IBuiltProductCardResponse);
+}

package/lib/types/rendering/Video.d.ts

@@ -0,0 +1,16 @@
+import { type IBuiltVideo, type IDevice, type IGeoContext, type ILogger, type Result } from '@surfside/ads-core-client';
+export type RenderVideoFn = (builtVideo: IBuiltVideo) => Result<HTMLElement>;
+export interface ITrackerState {
+    fired: boolean;
+    url?: string;
+}
+export interface IVideoTrackers {
+    start: ITrackerState;
+    firstQuartile: ITrackerState;
+    midpoint: ITrackerState;
+    thirdQuartile: ITrackerState;
+    complete: ITrackerState;
+    stop: ITrackerState;
+    impression: ITrackerState;
+}
+export declare const RenderVideo: (logger: ILogger | undefined, deviceInfo: IDevice | undefined, geo: IGeoContext | undefined, userAgent: string | undefined, builtVideo: IBuiltVideo) => Result<HTMLElement>;

package/lib/types/rendering/Watermark.d.ts

@@ -0,0 +1,2 @@
+import { type ILogger, type Result } from '@surfside/ads-core';
+export declare const RenderWatermark: (logger: ILogger | undefined) => Result<HTMLElement>;

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

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

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@surfside/ads-core-web",
+  "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 bun.build.ts",
+    "lint": "npx eslint"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.25.1",
+    "@types/bun": "latest",
+    "eslint": "^9.25.1",
+    "handlebars": "^4.7.8",
+    "typescript-eslint": "^8.31.0",
+    "@surfside/ads-core-client": "^0.1.0",
+    "@surfside/ads-core-mock": "^0.1.0",
+    "typescript": "^5.8.3"
+  }
+}