@surfside/ads 3.6.2 → 3.6.4-4c0a326f.0

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

@@ -0,0 +1,18 @@
+import { type ILogger } from '@surfside/ads-core';
+import { SimpleCreativeComponent, type CompletedSimpleCreativeAttributes } from './SimpleCreative';
+import { type InitApi } from './Creative';
+import { type GetUserIdFn } from '@surfside/ads-core-web';
+export declare class SurfsideBanner extends SimpleCreativeComponent {
+    private _cancellationToken;
+    private _nextRender;
+    private _bounce;
+    static get observedAttributes(): string[];
+    constructor(initApi: InitApi, getUserId: GetUserIdFn, logger?: ILogger);
+    protected getComponentName(): string;
+    attributeChangedCallback(this: this, name: string, oldValue: string | null, newValue: string | null): Promise<void>;
+    connectedCallback(): Promise<void>;
+    adoptedCallback(): void;
+    disconnectedCallback(): void;
+    connectedMoveCallback(): void;
+    render(this: this & CompletedSimpleCreativeAttributes): Promise<void>;
+}

package/lib/types/components/Card.d.ts

@@ -0,0 +1,17 @@
+import { type RecommenderType } from '@surfside/ads-core';
+import { type CompletedBaseAttributes, CreativeComponent } from './Creative';
+export type CompletedCardAttributes = CompletedBaseAttributes & {
+    strategy: string;
+    recommend: string;
+};
+export declare class SurfsideProductCard extends CreativeComponent {
+    private _cancellationToken;
+    protected recommend: RecommenderType;
+    protected strategy: string;
+    private _bounce;
+    static get observedAttributes(): string[];
+    protected getComponentName(): string;
+    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): Promise<void>;
+    connectedCallback(): Promise<void>;
+    render(this: this & CompletedCardAttributes): Promise<void>;
+}

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

@@ -0,0 +1,31 @@
+import { type ILogger, type RecommenderType } from '@surfside/ads-core';
+import { type CompletedBaseAttributes, CreativeComponent, type InitApi } from './Creative';
+import { type GetUserIdFn } from '@surfside/ads-core-web';
+export declare const NextType: {
+    readonly Product: "product";
+    readonly Page: "page";
+};
+export type CompletedCarouselAttributes = CompletedBaseAttributes & {
+    maxItems: number | undefined;
+    cardMinWidth: number;
+    cardMaxWidth: number | undefined;
+    strategy: string;
+    recommend: string;
+    nextType: string;
+};
+export declare class SurfsideCarousel extends CreativeComponent {
+    private _cancellationToken;
+    private _renderDebounce?;
+    protected maxItems?: number | null;
+    protected cardMinWidth: number;
+    protected cardMaxWidth?: number | null;
+    protected strategy: string;
+    protected recommend: RecommenderType;
+    protected nextType: 'page' | 'product';
+    static get observedAttributes(): string[];
+    constructor(initApi: InitApi, getUserId: GetUserIdFn, logger?: ILogger);
+    protected getComponentName(): string;
+    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): Promise<void>;
+    connectedCallback(): Promise<void>;
+    render(this: this & CompletedCarouselAttributes): Promise<void>;
+}

package/lib/types/components/Creative.d.ts

@@ -0,0 +1,65 @@
+import { type AsyncResult, type ILogger, type IContextLogger } from '@surfside/ads-core';
+import { type GetUserIdFn, type ISurfsideWebApi } from '@surfside/ads-core-web';
+export type CompletedBaseAttributes = {
+    accountId: string;
+    siteId: string;
+    locationId: string;
+    channelId: string;
+    zoneId: string;
+    keywords: string[];
+    api: ISurfsideWebApi;
+};
+export type BaseAttributeNames = 'account-id' | 'site-id' | 'location-id' | 'channel-id' | 'zone-id' | 'keywords' | 'category';
+export type InitApi = (accountId: string, siteId: string, channelId: string, locationId: string, userId: string | undefined, url: string) => AsyncResult<ISurfsideWebApi>;
+export declare const ProductFeedStrategy: {
+    readonly Sponsored: "sponsored";
+    readonly Hybrid: "hybrid";
+    readonly Recommended: "recommended";
+};
+export declare const RecommenderTypeInputs: {
+    TopProducts: string;
+    ForYou: string;
+    BuyAgain: string;
+    PastPurchases: string;
+};
+export declare const AttributeValOrThrow: (element: Element, attribute: string, value: string | null) => string;
+export declare const DEBOUNCE_THRESHOLD = 10;
+export declare abstract class CreativeComponent extends HTMLElement {
+    private _initApi;
+    private _getUserId;
+    protected accountId: string | undefined;
+    protected siteId: string | undefined;
+    protected locationId: string | undefined;
+    protected channelId: string | undefined;
+    protected zoneId: string | undefined;
+    protected category: string[];
+    protected keywords: string[];
+    protected shadow: ShadowRoot;
+    protected api?: ISurfsideWebApi;
+    protected log?: IContextLogger;
+    protected totem: string | undefined;
+    private _stopTimer?;
+    protected restartEndToEndTimer: () => void;
+    private _instanceId;
+    protected get instanceId(): string;
+    private readonly _monkeyHistoryReplaceCallback;
+    constructor(_initApi: InitApi, _getUserId: GetUserIdFn, logger?: ILogger);
+    connectedCallback(): void;
+    protected abstract getComponentName(): string;
+    protected static get observedBaseAttributes(): string[];
+    protected getBaseAttributeValues(): {
+        accountId: string | undefined;
+        siteId: string | undefined;
+        channelId: string | undefined;
+        locationId: string | undefined;
+        zoneId: string | undefined;
+        category: string[];
+        keywords: string[];
+    };
+    protected attributesLoaded(): boolean;
+    protected lazyLoadApi(): Promise<void>;
+    protected baseAttributeChangedCallback(key: BaseAttributeNames, oldValue: string | null, newValue: string | null, logger?: IContextLogger): Promise<void>;
+    disconnectedCallback(): void;
+    protected initApi(): Promise<void>;
+    protected readBaseAttributes(): asserts this is this & CompletedBaseAttributes;
+}

package/lib/types/components/Dynamic.d.ts

@@ -0,0 +1,23 @@
+import { type IDynamicZoneRequest, type RecommenderType } from '@surfside/ads-core';
+import { type CompletedBaseAttributes, CreativeComponent } from './Creative';
+export type CompletedDynamicAttributes = CompletedBaseAttributes & {
+    maxItems: number | undefined;
+    cardMinWidth?: number;
+    strategy?: string;
+    recommend?: string;
+    nextType?: string;
+};
+export declare class SurfsideDynamicZone extends CreativeComponent {
+    private _cancellationToken;
+    protected maxItems?: number;
+    protected cardMinWidth?: number;
+    protected strategy?: string;
+    protected recommend?: RecommenderType;
+    protected nextType?: 'page' | 'product';
+    private _bounce;
+    protected getComponentName(): string;
+    static get observedAttributes(): string[];
+    attributeChangedCallback(name: string, oldValue: string | null, newValue: string | null): Promise<void>;
+    render(this: this & CompletedDynamicAttributes): Promise<void>;
+    requestAndRender(this: this & CompletedDynamicAttributes, dynamicZoneRequest: IDynamicZoneRequest): Promise<void>;
+}

package/lib/types/components/SimpleCreative.d.ts

@@ -0,0 +1,19 @@
+import { type BaseAttributeNames, CreativeComponent, type InitApi, type CompletedBaseAttributes } from './Creative';
+import type { GetUserIdFn } from '@surfside/ads-core-web';
+import { type IContextLogger, type ILogger } from '@surfside/ads-core';
+export type CompletedSimpleCreativeAttributes = CompletedBaseAttributes & {
+    width: number;
+    height: number;
+};
+export type SimpleCreativeAttributeNames = BaseAttributeNames | 'width' | 'height';
+export declare const IntValOrThrow: (element: Element, attribute: string, value: string | null) => number;
+export declare const IntValOr: <T>(element: Element, attribute: string, value: string | null, or: T) => number | T;
+export declare abstract class SimpleCreativeComponent extends CreativeComponent {
+    protected width?: number | null;
+    protected height?: number | null;
+    constructor(initApi: InitApi, getUserId: GetUserIdFn, logger?: ILogger);
+    protected attributesLoaded(): boolean;
+    protected static get observedSimpleAttributes(): string[];
+    simpleAttributeChangedCallback(name: string, oldValue: string | null, newValue: string | null, logger?: IContextLogger): Promise<void>;
+    readSimpleAttributes(): asserts this is this & CompletedSimpleCreativeAttributes;
+}

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

@@ -0,0 +1,22 @@
+import { type ILogger } from '@surfside/ads-core';
+import { SimpleCreativeComponent, type CompletedSimpleCreativeAttributes } from './SimpleCreative';
+import { type InitApi } from './Creative';
+import { type GetUserIdFn } from '@surfside/ads-core-web';
+export type CompletedVideoAttributes = CompletedSimpleCreativeAttributes & {
+    minDuration: number;
+    maxDuration: number;
+};
+export declare class SurfsideVideo extends SimpleCreativeComponent {
+    private _cancellationToken;
+    protected minDuration?: number | null;
+    protected maxDuration?: number | null;
+    private _bounce;
+    static get observedAttributes(): string[];
+    constructor(initApi: InitApi, getUserId: GetUserIdFn, logger?: ILogger);
+    protected getComponentName(): string;
+    protected attributesLoaded(): boolean;
+    attributeChangedCallback(this: this, name: string, oldValue: string | null, newValue: string | null): Promise<void>;
+    protected readVideoAttributes(): asserts this is this & CompletedVideoAttributes;
+    connectedCallback(): Promise<void>;
+    render(this: this & CompletedVideoAttributes): Promise<void>;
+}

package/lib/types/demo/test.d.ts

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

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

@@ -0,0 +1,12 @@
+import { type AsyncResult, type ILogger } from '@surfside/ads-core';
+import { type ISurfsideClientApi } from '@surfside/ads-core-client';
+export * from './Init';
+export type Initializer = (accountId: string, siteId: string, channelId: string, locationId: string, userId: string | undefined, logger?: ILogger) => AsyncResult<ISurfsideClientApi>;
+export declare const InitSurfAdsWebComponents: (initializer?: Initializer) => void;
+export declare const SurfsideAdsVersionTable: {
+    [x: string]: {
+        buildBranch: string;
+        buildHash: string;
+        buildVer: string;
+    };
+};

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

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

package/lib/types/index.script.mock.d.ts

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

package/lib/types/service/Init.d.ts

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

package/lib/types/util/Attributes.d.ts

@@ -0,0 +1,24 @@
+import { type Result } from '@surfside/ads-core';
+export declare const ReadAttribute: (element: Element, attr: string) => Result<string>;
+export declare const ReadNumberAttribute: (element: Element, attr: string) => Result<number>;
+export declare const ReadIntAttribute: (element: Element, attr: string) => Result<number>;
+export declare const ReadBoolAttribute: (element: Element, attr: string) => Result<boolean>;
+export declare class AttributeNotFoundError extends Error {
+    element: Element;
+    attribute: string;
+    constructor(element: Element, attribute: string);
+}
+export declare abstract class AttributeWrongTypeError extends Error {
+    element: Element;
+    attribute: string;
+    constructor(element: Element, attribute: string, message: string);
+}
+export declare class AttributeNotANumberError extends AttributeWrongTypeError {
+    constructor(element: Element, attribute: string);
+}
+export declare class AttributeNotBoolError extends AttributeWrongTypeError {
+    constructor(element: Element, attribute: string);
+}
+export declare class AttributeNotIntError extends AttributeWrongTypeError {
+    constructor(element: Element, attribute: string);
+}

package/lib/types/util/Types.d.ts

@@ -0,0 +1,3 @@
+export type NoneNullable<T> = {
+    [K in keyof T]: NonNullable<T[K]>;
+};

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@surfside/ads",
-  "version": "3.6.2",
-  "module": "./lib/esm/index.js",
-  "main": "./lib/cjs/index.js",
-  "types": "./lib/types/index.d.ts",
+  "version": "3.6.4-4c0a326f.0",
+  "module": "./lib/esm/index.module.js",
+  "main": "./lib/cjs/index.module.js",
+  "types": "./lib/types/index.module.d.ts",
   "exports": {
     ".": {
-      "import": "./lib/esm/index.js",
-      "require": "./lib/cjs/index.js",
-      "types": "./lib/types/index.d.ts"
+      "import": "./lib/esm/index.module.js",
+      "require": "./lib/cjs/index.module.js",
+      "types": "./lib/types/index.module.d.ts"
     }
   },
   "license": "UNLICENSED",
@@ -35,8 +35,8 @@
     "typescript": "^5"
   },
   "dependencies": {
-    "@surfside/ads-core": "2.4.2",
-    "@surfside/ads-core-mock": "0.4.2",
-    "@surfside/ads-core-web": "0.4.2"
+    "@surfside/ads-core": "2.4.4-4c0a326f.0",
+    "@surfside/ads-core-mock": "0.4.4-4c0a326f.0",
+    "@surfside/ads-core-web": "0.4.4-4c0a326f.0"
   }
 }