@surfside/ads-core 2.0.14 → 2.0.16

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

@@ -1,3 +1,5 @@
+import { type HelperDelegate } from 'handlebars';
+import { type INativeTemplateDelegateWindow } from '../models';
 /**
  * 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
@@ -43,7 +45,16 @@ export declare function upper(name: string): string;
  * @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 const path: (pathname: string) => (position: number, options: {
+    hash: {
+        url?: string;
+    };
+}) => string | undefined;
+export declare function money(value: number | string, options: {
+    hash: {
+        cents?: boolean;
+    };
+}): string;
 /**
  * A general-purpose string replacement tool - meant to behave like the Unix sed tool. Accepts a regex for
  * search, and a replacement string. for example, if the input string is "hello world" and the search is
@@ -96,7 +107,11 @@ export declare function replace(input: string, search: string, replacement: stri
  * @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;
+export declare const search: (search: string) => (name: string, options: {
+    hash: {
+        url?: 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",
@@ -157,11 +172,17 @@ export declare function and(a: any, b: any): boolean;
  * @returns True if the value is in the array, false otherwise
  */
 export declare function isIn(a: any, b: any[]): boolean;
+/**
+ * Grabs a variable off of the global window object. {{global "foo" "bar"}} will return `window.foo.bar`.
+ * If any part of the path is undefined, this returns undefined with no exceptions
+ * @returns The global variable
+ */
+export declare function global(...args: any[]): any;
 /**
  * Returns an array of the passed arguments. Useful with the "in" helper
  * @group TemplateHelpers
  * @returns An array of the passed arguments
  */
 export declare function array(...args: any[]): any[];
-export type HandlebarsHelpers = Record<string, Function>;
-export declare const GetHelpers: () => HandlebarsHelpers;
+export type HandlebarsHelpers = Record<string, HelperDelegate>;
+export declare const GetHelpers: (windowInfo: INativeTemplateDelegateWindow) => HandlebarsHelpers;

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

@@ -1,5 +1,7 @@
 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 { type ILogger } from '../services';
+import { type NativeRequestBuilder } from './NativeRequestBuilder';
+import { type GenerateCategoriesFn } from '../services/Category';
 export type RequestBuilderFn = (zoneId: string, id?: string) => RequestBuilder;
 export type RequestWith<T> = (t: T) => RequestBuilder;
 export type RequestBuilder = {
@@ -8,9 +10,13 @@ export type RequestBuilder = {
     withApp: RequestWith<IApp>;
     withSite: RequestWith<ISite>;
     withKeywords: RequestWith<string[]>;
+    withSurfCategory: RequestWith<string[]>;
     withBanner: (w: number, h: number, options?: Partial<IBanner>, impOptions?: Partial<IImp>) => RequestBuilder;
     withVideo: (w: number, h: number, minduration: number | undefined, maxduration: number, mimes?: string[], options?: Partial<IVideo>, impOptions?: Partial<IImp>) => RequestBuilder;
     withNative: (request: string | INativeRequest, options?: Partial<INative>, impOptions?: Partial<IImp>) => RequestBuilder;
+    withNatives: (requests: (string | INativeRequest)[], options?: Partial<INative>, impOptions?: Partial<IImp>) => RequestBuilder;
+    withNativeCopies: (request: string | INativeRequest, n: number, options?: Partial<INative>, impOptions?: Partial<IImp>) => RequestBuilder;
+    withProductCards: (nativeBuilder: NativeRequestBuilder, 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;
+export declare function StartRequest(logger: ILogger | undefined, accountId: string, siteId: string, channelId: string, locationId: string, device: IDevice | undefined, geo: IGeoContext | undefined, userId: string | undefined, generateCategories: GenerateCategoriesFn, zoneId: string, id?: string): RequestBuilder;

package/lib/types/index.d.ts

@@ -2,3 +2,4 @@ export * from './helpers';
 export * from './models';
 export * from './services';
 export * from './Api';
+export * from './BuildInfo';

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

@@ -0,0 +1,15 @@
+export type CategoryStrategy = 'url';
+export interface ICompiledCategoryGlobalConfigDTO {
+    globalCanonicalMap: Record<string, string>;
+    globalPatterns: string[];
+}
+export interface ICompiledCategoryPublisherConfigurationDTO {
+    'strategy': CategoryStrategy;
+    customCanonicalMap: Record<string, string>;
+    customPatterns: string[];
+}
+export interface ICompiledCategoryPublisherConfiguration {
+    strategy: CategoryStrategy;
+    canonicalMap: Record<string, string>;
+    patterns: string[];
+}

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

@@ -1,4 +1,5 @@
 import type { IDynamicZone, IProductInformation } from '../../models';
+import type { ICompiledCategoryPublisherConfiguration, ICompiledCategoryPublisherConfigurationDTO } from './Category';
 export type ProductCallback = (e: Event, product: IProductInformation) => void;
 export type Callbacks = Record<string, ProductCallback>;
 export type TemplateDelegate = (context: IProductContext) => string;
@@ -53,14 +54,17 @@ export interface ICompiledPublisherConfigurationSettingsDTO {
     reauctionIntervalMs: number;
     productFeedEnabled: boolean;
     sponsoredByEnabled?: boolean;
+    defaultImage?: string;
 }
 export interface ICompiledPublisherConfigurationDTO {
     templates: ICompiledPublisherConfigurationTemplatesDTO;
     settings: ICompiledPublisherConfigurationSettingsDTO;
+    category: ICompiledCategoryPublisherConfigurationDTO;
     dynamicZones?: Record<string, IDynamicZone>;
 }
 export interface ICompiledPublisherConfiguration {
     settings: ICompiledPublisherConfigurationSettingsDTO;
     templates: ICompiledPublisherConfigurationTemplates;
+    category: ICompiledCategoryPublisherConfiguration;
     dynamicZones?: Record<string, IDynamicZone>;
 }

package/lib/types/models/rtb/BidRequest.d.ts

@@ -406,5 +406,6 @@ export interface ISurfExtension {
     locationId: string;
     storeId: string;
     accountLocationId: string;
+    surfCategory: string[];
     keywords?: string[];
 }

package/lib/types/services/BotFiltering.d.ts

@@ -0,0 +1,3 @@
+import { ILogger } from './Logger';
+export declare const FilterBots: <TArgs extends readonly unknown[], TReturn>(logger: ILogger | undefined, userAgent: string, fn: (...args: TArgs) => TReturn, fallback: (...args: TArgs) => TReturn) => (...args: TArgs) => TReturn;
+export declare const FilterBotsAsyncGenerator: <TArgs extends readonly unknown[], TReturn>(logger: ILogger | undefined, userAgent: string, fn: (...args: TArgs) => AsyncGenerator<TReturn>) => (...args: TArgs) => AsyncGenerator<Awaited<TReturn>, void, any>;

package/lib/types/services/Category.d.ts

@@ -0,0 +1,4 @@
+import { type ICompiledCategoryPublisherConfiguration } from '../models/retail/Category';
+import { type ILogger } from './Logger';
+export type GenerateCategoriesFn = (providedCategories: string[]) => string[];
+export declare const GenerateCategories: (logger: ILogger | undefined, providedCategories: string[], page: string, categoryConfig: ICompiledCategoryPublisherConfiguration) => string[];

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

@@ -8,17 +8,17 @@ export interface IDynamicZoneRequest {
     request: IBidRequest;
     requestIds: Record<string, DynamicCreative>;
 }
-export type BuildDynamicZoneRequestFn = (zoneId: string, dynamicZone: IDynamicZone) => Result<IDynamicZoneRequest>;
+export type BuildDynamicZoneRequestFn = (zoneId: string, dynamicZone: IDynamicZone, category?: string[]) => Result<IDynamicZoneRequest>;
 export type GetDynamicZoneFn = (zoneId: string) => AsyncResult<IDynamicZone>;
 export declare const GetDynamicZone: (logger: ILogger | undefined, config: ICompiledPublisherConfiguration, zoneId: string) => Promise<import("./Result").ErrResult<MissingDynamicZoneError> | import("./Result").OkResult<IDynamicZone>>;
-export declare const BuildDynamicZoneRequest: (logger: ILogger | undefined, startRequest: RequestBuilderFn, nativeRequest: NativeRequestBuilderFn, screenInfo: IScreen, zoneId: string, dynamicZone: IDynamicZone) => Result<IDynamicZoneRequest>;
+export declare const BuildDynamicZoneRequest: (logger: ILogger | undefined, startRequest: RequestBuilderFn, nativeRequest: NativeRequestBuilderFn, screenInfo: IScreen, zoneId: string, dynamicZone: IDynamicZone, category?: string[]) => Result<IDynamicZoneRequest>;
 export declare class NoDynamicScreenSizeMatchError extends Error {
     readonly dynamicZone: IDynamicZone;
     readonly screenInfo: IScreen;
     readonly selectedStringSize: string;
     constructor(dynamicZone: IDynamicZone, screenInfo: IScreen, selectedStringSize: string);
 }
-export declare const buildDynamicBidRequestFromSelectedScreenSize: (logger: ILogger | undefined, startRequest: RequestBuilderFn, nativeRequest: NativeRequestBuilderFn, zoneId: string, screenSize: IScreenSize) => Result<IDynamicZoneRequest>;
+export declare const buildDynamicBidRequestFromSelectedScreenSize: (logger: ILogger | undefined, startRequest: RequestBuilderFn, nativeRequest: NativeRequestBuilderFn, zoneId: string, screenSize: IScreenSize, category?: string[]) => Result<IDynamicZoneRequest>;
 export declare const buildDynamicBidRequestRecursive: (logger: ILogger | undefined, nativeRequest: NativeRequestBuilderFn, builder: RequestBuilder, requestIds: Record<string, DynamicCreative>, [head, ...tail]: DynamicCreative[]) => Result<[builder: RequestBuilder, requestIds: Record<string, DynamicCreative>]>;
 export declare class MissingDynamicZoneError extends Error {
     readonly zoneId: string;

package/lib/types/services/Product.d.ts

@@ -1,12 +1,12 @@
-import type { IProductInformation } from '../models';
+import type { ICompiledPublisherConfiguration, IProductInformation } from '../models';
 import { type ILogger } from './Logger';
 import { type Result, type AsyncResult } from './Result';
 export type GetSponsoredProductFromNativeIdFn = (nativeId: string) => AsyncGenerator<IProductInformation>;
 export type GetAllSponsoredProductFromNativeIdFn = (nativeId: string) => Promise<Result<IProductInformation[]>>;
 export type GetRecommendedProductFromProductIdFn = (productId: string) => AsyncResult<IProductInformation>;
-export declare const GetAllSponsoredProducts: (logger: ILogger | undefined, url: string, accountId: string, locationId: string, nativeId: string) => Promise<Result<IProductInformation[]>>;
-export declare const GetAllSponsoredBrandProducts: (logger: ILogger | undefined, url: string, accountId: string, locationId: string, nativeId: string) => Promise<Result<IProductInformation[]>>;
-export declare const GetRecommendedProduct: (logger: ILogger | undefined, url: string, accountId: string, locationId: string, productId: string) => AsyncResult<IProductInformation>;
+export declare const GetAllSponsoredProducts: (logger: ILogger | undefined, url: string, config: ICompiledPublisherConfiguration, accountId: string, locationId: string, nativeId: string) => Promise<Result<IProductInformation[]>>;
+export declare const GetAllSponsoredBrandProducts: (logger: ILogger | undefined, url: string, config: ICompiledPublisherConfiguration, accountId: string, locationId: string, nativeId: string) => Promise<Result<IProductInformation[]>>;
+export declare const GetRecommendedProduct: (logger: ILogger | undefined, url: string, config: ICompiledPublisherConfiguration, accountId: string, locationId: string, productId: string) => AsyncResult<IProductInformation>;
 export declare class NoNativeError extends Error {
     nativeId: string;
     constructor(nativeId: string);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@surfside/ads-core",
-  "version": "2.0.14",
+  "version": "2.0.16",
   "module": "./lib/esm/index.js",
   "main": "./lib/cjs/index.js",
   "types": "./lib/types/index.d.ts",
@@ -24,6 +24,7 @@
     "@types/jest": "^29.5.14",
     "eslint": "^9.25.1",
     "jest": "^29.7.0",
+    "npm-run-all": "^4.1.5",
     "ts-jest": "^29.3.2",
     "typedoc": "^0.28.5",
     "typescript-eslint": "^8.41.0"
@@ -36,7 +37,11 @@
   },
   "scripts": {
     "clean": "rm -rf ./lib",
-    "build": "tsc -p ./tsconfig.types.json && tsc -p ./tsconfig.esm.json && tsc -p tsconfig.cjs.json",
+    "prebuild": "echo \"export const SurfsideAdsCoreVersionInfo = { buildBranch: '$(git rev-parse --abbrev-ref HEAD)', buildHash: '$(git rev-parse --short HEAD)', buildVer: '$(bun -e 'console.log(require(\"./package.json\").version)')'};\" > src/BuildInfo.ts",
+    "build": "bunx npm-run-all --parallel \"types\" \"esm\" \"cjs\"",
+    "types": "tsc -p ./tsconfig.types.json",
+    "esm": "tsc -p ./tsconfig.esm.json",
+    "cjs": "tsc -p tsconfig.cjs.json",
     "lint": "npx eslint"
   }
 }