@surfside/ads-core 1.0.6 → 2.0.2

package/lib/esm/services/Recommender.js

@@ -0,0 +1,78 @@
+import { Ctx } from './Logger';
+import { Err, Ok } from './Result';
+export async function* GenerateTopProducts(logger, productFeed, url, accountId, siteId, locationId) {
+    const log = Ctx(logger)?.with('GenerateTopProducts').with(accountId).with(siteId).with(locationId);
+    log?.info('Generating top products');
+    yield* generateProductRecommendation(logger, productFeed, url, accountId, siteId, locationId, undefined, 'top-products');
+}
+export async function* GenerateForYou(logger, productFeed, url, accountId, siteId, locationId, userId) {
+    const log = Ctx(logger)?.with('GenerateForYou').with(accountId).with(siteId).with(locationId).with(userId);
+    log?.info('Generating for you');
+    yield* generateProductRecommendation(logger, productFeed, url, accountId, siteId, locationId, userId, 'for-you');
+}
+export async function* GeneratePreviousPurchases(logger, productFeed, url, accountId, siteId, locationId, userId) {
+    const log = Ctx(logger)
+        ?.with('GeneratePreviousPurchases')
+        .with(accountId)
+        .with(siteId)
+        .with(locationId)
+        .with(userId);
+    log?.info('Generating previous purchases');
+    yield* generateProductRecommendation(log, productFeed, url, accountId, siteId, locationId, userId, 'buy-again');
+}
+async function* generateProductRecommendation(logger, productFeed, url, accountId, siteId, locationId, userId, type) {
+    const log = Ctx(logger)?.with('generatreProductRecommendation');
+    log?.debug('Generating product recommendation');
+    const recommendations = await fetchRecommendations(log, url, accountId, siteId, locationId, userId, type);
+    if (!recommendations.ok) {
+        log?.error(recommendations.error);
+        return;
+    }
+    yield* generateProduct(log, productFeed, accountId, locationId, recommendations.value);
+    log?.debug('out of recommendations');
+}
+const fetchRecommendations = async (logger, url, accountId, siteId, locationId, userId, type) => {
+    const log = Ctx(logger)?.with('fetchRecommendations');
+    log?.debug('Fetching recommendations');
+    const key = `accountId=${accountId}&siteId=${siteId}&locationId=${locationId}&userId=${userId ?? 'null'}`;
+    try {
+        const results = await fetch(`${url}/r/${type}?${key}&limit=100`);
+        if (!results.ok) {
+            return Err(new Error('Failed to load recommendations. Service returned ' + results.status));
+        }
+        /* On error, the result will be IRecommenderResponse.
+         * On success, it will just be a set of recommended products */
+        const recommendations = await results.json();
+        const error = recommendations.error;
+        if (error !== undefined) {
+            return Err(new Error(error));
+        }
+        return Ok(recommendations);
+    }
+    catch (err) {
+        return Err(err);
+    }
+};
+async function* generateProduct(logger, productFeed, accountId, locationId, results) {
+    const log = Ctx(logger)?.with('generateProduct');
+    log?.debug('generating product info');
+    for (const item of results) {
+        const itemId = item.item_id;
+        try {
+            log?.debug('itemId', itemId);
+            const product = await productFeed(itemId);
+            log?.debug('product', itemId, product);
+            if (product.ok) {
+                yield product.value;
+            }
+            else {
+                log?.warn('item was missing from product feed', itemId);
+            }
+        }
+        catch (err) {
+            log?.warn('couldn\'t get product', err);
+        }
+    }
+    log?.info('no more products. Exiting');
+}
+//# sourceMappingURL=Recommender.js.map

package/lib/esm/services/Recommender.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Recommender.js","sourceRoot":"src/","sources":["services/Recommender.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,GAAG,EAAgB,MAAM,UAAU,CAAC;AAE7C,OAAO,EAAE,GAAG,EAAE,EAAE,EAAoB,MAAM,UAAU,CAAC;AAKrD,MAAM,CAAC,KAAK,SAAU,CAAC,CAAA,mBAAmB,CACtC,MAA2B,EAC3B,WAAiD,EACjD,GAAW,EACX,SAAiB,EACjB,MAAc,EACd,UAAkB;IAElB,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;IACnG,GAAG,EAAE,IAAI,CAAC,yBAAyB,CAAC,CAAC;IAErC,KAAK,CAAC,CAAC,6BAA6B,CAChC,MAAM,EACN,WAAW,EACX,GAAG,EACH,SAAS,EACT,MAAM,EACN,UAAU,EACV,SAAS,EACT,cAAc,CACjB,CAAC;AACN,CAAC;AAED,MAAM,CAAC,KAAK,SAAU,CAAC,CAAA,cAAc,CACjC,MAA2B,EAC3B,WAAiD,EACjD,GAAW,EACX,SAAiB,EACjB,MAAc,EACd,UAAkB,EAClB,MAAc;IAEd,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3G,GAAG,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAEhC,KAAK,CAAC,CAAC,6BAA6B,CAChC,MAAM,EACN,WAAW,EACX,GAAG,EACH,SAAS,EACT,MAAM,EACN,UAAU,EACV,MAAM,EACN,SAAS,CACZ,CAAC;AACN,CAAC;AAED,MAAM,CAAC,KAAK,SAAU,CAAC,CAAA,yBAAyB,CAC5C,MAA2B,EAC3B,WAAiD,EACjD,GAAW,EACX,SAAiB,EACjB,MAAc,EACd,UAAkB,EAClB,MAAc;IAEd,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC;QACnB,EAAE,IAAI,CAAC,2BAA2B,CAAC;SAClC,IAAI,CAAC,SAAS,CAAC;SACf,IAAI,CAAC,MAAM,CAAC;SACZ,IAAI,CAAC,UAAU,CAAC;SAChB,IAAI,CAAC,MAAM,CAAC,CAAC;IAClB,GAAG,EAAE,IAAI,CAAC,+BAA+B,CAAC,CAAC;IAE3C,KAAK,CAAC,CAAC,6BAA6B,CAChC,GAAG,EACH,WAAW,EACX,GAAG,EAAE,SAAS,EACd,MAAM,EACN,UAAU,EACV,MAAM,EACN,WAAW,CACd,CAAC;AACN,CAAC;AAED,KAAK,SAAU,CAAC,CAAA,6BAA6B,CACzC,MAA2B,EAC3B,WAAiD,EACjD,GAAW,EACX,SAAiB,EACjB,MAAc,EACd,UAAkB,EAClB,MAA0B,EAC1B,IAAY;IAEZ,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,gCAAgC,CAAC,CAAC;IAChE,GAAG,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;IAChD,MAAM,eAAe,GAAG,MAAM,oBAAoB,CAC9C,GAAG,EACH,GAAG,EACH,SAAS,EACT,MAAM,EACN,UAAU,EACV,MAAM,EACN,IAAI,CACP,CAAC;IACF,IAAI,CAAC,eAAe,CAAC,EAAE,EAAE,CAAC;QACtB,GAAG,EAAE,KAAK,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAClC,OAAO;IACX,CAAC;IAED,KAAK,CAAC,CAAC,eAAe,CAAC,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC;IACvF,GAAG,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;AACzC,CAAC;AAED,MAAM,oBAAoB,GAAG,KAAK,EAC9B,MAA2B,EAC3B,GAAW,EACX,SAAiB,EACjB,MAAc,EACd,UAAkB,EAClB,MAA0B,EAC1B,IAAY,EACsB,EAAE;IACpC,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,sBAAsB,CAAC,CAAC;IACtD,GAAG,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAEvC,MAAM,GAAG,GAAG,aAAa,SAAS,WAAW,MAAM,eAAe,UAAU,WAAW,MAAM,IAAI,MAAM,EAAE,CAAC;IAC1G,IAAI,CAAC;QACD,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,GAAG,GAAG,MAAM,IAAI,IAAI,GAAG,YAAY,CAAC,CAAC;QACjE,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;YACd,OAAO,GAAG,CAAC,IAAI,KAAK,CAAC,mDAAmD,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QAChG,CAAC;QACD;uEAC+D;QAC/D,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,IAAI,EAAoD,CAAC;QAC/F,MAAM,KAAK,GAAI,eAAwC,CAAC,KAAK,CAAC;QAC9D,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACtB,OAAO,GAAG,CAAC,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;QACjC,CAAC;QAED,OAAO,EAAE,CAAC,eAAwC,CAAC,CAAC;IACxD,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,OAAO,GAAG,CAAC,GAAY,CAAC,CAAC;IAC7B,CAAC;AACL,CAAC,CAAC;AAEF,KAAK,SAAS,CAAC,CAAC,eAAe,CAC3B,MAA2B,EAC3B,WAAiD,EACjD,SAAiB,EACjB,UAAkB,EAClB,OAA8B;IAE9B,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,iBAAiB,CAAC,CAAC;IACjD,GAAG,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAEtC,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QACzB,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC;QAC5B,IAAI,CAAC;YACD,GAAG,EAAE,KAAK,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;YAC7B,MAAM,OAAO,GAAG,MAAM,WAAW,CAAC,MAAM,CAAC,CAAC;YAC1C,GAAG,EAAE,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;YACvC,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC;gBACb,MAAM,OAAO,CAAC,KAAK,CAAC;YACxB,CAAC;iBAAM,CAAC;gBACJ,GAAG,EAAE,IAAI,CAAC,oCAAoC,EAAE,MAAM,CAAC,CAAC;YAC5D,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,GAAG,EAAE,IAAI,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;QAC5C,CAAC;IACL,CAAC;IAED,GAAG,EAAE,IAAI,CAAC,2BAA2B,CAAC,CAAC;AAC3C,CAAC"}

package/lib/esm/services/Result.js

@@ -0,0 +1,199 @@
+export const Ok = (t) => ({
+    ok: true,
+    value: t
+});
+export const Err = (e) => ({
+    ok: false,
+    error: e
+});
+export const TryDo = (fn) => {
+    try {
+        return Ok(fn());
+    }
+    catch (err) {
+        return Err(err);
+    }
+};
+export const TryDoFlat = (fn) => {
+    try {
+        return fn();
+    }
+    catch (err) {
+        return Err(err);
+    }
+};
+export const TryDoAsync = async (fn) => {
+    try {
+        return Ok(await fn());
+    }
+    catch (err) {
+        return Err(err);
+    }
+};
+export const GetValue = (result) => result?.ok === true ? result.value : undefined;
+export const ValueOr = (result, or) => result?.ok === true ? result.value : or;
+export const GetValueOrThrow = (result) => {
+    if (result.ok) {
+        return result.value;
+    }
+    throw result.error;
+};
+export const WrapValue = (value) => {
+    if (value === undefined || value === null) {
+        return Err(new NoValueError(value));
+    }
+    return Ok(value);
+};
+export const AssertValue = GetValueOrThrow;
+export const AllOrNone = (results) => {
+    const failed = results.filter(res => !res.ok).map(res => res.error);
+    if (failed.length > 0) {
+        return Err(new MultipleErrorsError(failed));
+    }
+    const success = results.filter(res => res.ok).map(res => res.value);
+    return Ok(success);
+};
+export const Some = (results) => {
+    const success = results.filter(res => res.ok).map(res => res.value);
+    return Ok(success);
+};
+export const Filter = (...results) => {
+    const success = Some(results).value.map(val => Ok(val));
+    const failed = results.filter(res => !res.ok);
+    return [success, failed];
+};
+export const AnyFailed = (...results) => {
+    const errors = results.filter(res => !res.ok).map(res => res.error);
+    if (errors.length > 0) {
+        return [true, errors];
+    }
+    return [false];
+};
+export class MultipleErrorsError extends Error {
+    errors;
+    constructor(errors) {
+        super('Got multiple errors:\n' +
+            errors.map(err => '\t' + err.message.substring(0, 32).padEnd(35, '.')).join('\n'));
+        this.errors = errors;
+    }
+}
+export const Pipe = (result) => ({
+    then: pipeThen(result),
+    result: pipeResult(result),
+    value: pipeValue(result),
+    valueOr: pipeValueOr(result),
+    valueOrThrow: pipeValueOrThrow(result)
+});
+const pipeThen = (result) => (fn) => {
+    if (!result.ok) {
+        return Pipe(result);
+    }
+    return Pipe(Ok(fn(result.value)));
+};
+const pipeResult = (result) => () => result;
+const pipeValue = (result) => () => GetValue(result);
+const pipeValueOr = (result) => (or) => GetValue(result) ?? or;
+const pipeValueOrThrow = (result) => () => {
+    if (result.ok) {
+        return result.value;
+    }
+    throw result.error;
+};
+export const AsyncPipe = (result) => ({
+    then: asyncPipeThen(result),
+    result: asyncPipeResult(result),
+    value: asyncPipeValue(result),
+    valueOr: asyncPipeValueOr(result),
+    valueOrThrow: asyncPipeValueOrThrow(result)
+});
+const asyncPipeThen = (result) => (fn) => {
+    const asyncResult = result;
+    const wrappedPromiseResult = asyncResult.then(unwrappedResult => {
+        if (unwrappedResult.ok) {
+            try {
+                const fnRes = fn(unwrappedResult.value);
+                return Promise.resolve(fnRes)
+                    .catch(Err);
+            }
+            catch (err) {
+                return Err(err);
+            }
+        }
+        else {
+            return unwrappedResult;
+        }
+    });
+    return AsyncPipe(wrappedPromiseResult);
+};
+const asyncPipeResult = (result) => () => result;
+const asyncPipeValue = (result) => async () => {
+    try {
+        const res = await result;
+        if (res.ok) {
+            return res.value;
+        }
+        return undefined;
+    }
+    catch {
+        return undefined;
+    }
+};
+const asyncPipeValueOr = (result) => async (or) => {
+    try {
+        const res = await result;
+        if (res.ok) {
+            return res.value;
+        }
+        return or;
+    }
+    catch {
+        return or;
+    }
+};
+const asyncPipeValueOrThrow = (result) => async () => {
+    const res = await result;
+    if (res.ok) {
+        return res.value;
+    }
+    throw res.error;
+};
+export const ResultStream = (results) => ({
+    map: streamMap(results),
+    filter: streamFilter(results),
+    results: streamResults(results),
+    value: streamValue(results),
+    valueOr: streamValueOr(results),
+    valueOrThrow: streamValueOrThrow(results)
+});
+const streamMap = (results) => (fn) => {
+    if (!results.ok) {
+        return ResultStream(results);
+    }
+    return ResultStream(Ok(results.value.map(fn)));
+};
+const streamFilter = (results) => (fn) => {
+    if (!results.ok) {
+        return ResultStream(results);
+    }
+    return ResultStream(Ok(results.value.filter(fn)));
+};
+const streamResults = (results) => () => results;
+const streamValue = (results) => () => results.ok ? results.value : undefined;
+const streamValueOr = (results) => (or) => results.ok ? results.value : or;
+const streamValueOrThrow = (results) => () => {
+    if (results.ok) {
+        return results.value;
+    }
+    else {
+        throw results.error;
+    }
+};
+export class NoValueError extends Error {
+    value;
+    constructor(value) {
+        super('Value was undefined or null');
+        this.value = value;
+    }
+}
+;
+//# sourceMappingURL=Result.js.map

package/lib/esm/services/Result.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Result.js","sourceRoot":"src/","sources":["services/Result.ts"],"names":[],"mappings":"AASA,MAAM,CAAC,MAAM,EAAE,GAAG,CAAI,CAAI,EAAe,EAAE,CAAC,CAAC;IACzC,EAAE,EAAE,IAAI;IACR,KAAK,EAAE,CAAC;CACX,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,GAAG,GAAG,CAAY,CAAI,EAAgB,EAAE,CAAC,CAAC;IACnD,EAAE,EAAE,KAAK;IACT,KAAK,EAAE,CAAC;CACX,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,KAAK,GAAG,CAAe,EAAW,EAAgB,EAAE;IAC7D,IAAI,CAAC;QACD,OAAO,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;IACpB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,OAAO,GAAG,CAAC,GAAQ,CAAC,CAAC;IACzB,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAe,EAAsB,EAAgB,EAAE;IAC5E,IAAI,CAAC;QACD,OAAO,EAAE,EAAE,CAAC;IAChB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,OAAO,GAAG,CAAC,GAAQ,CAAC,CAAC;IACzB,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,EAAgB,EAAoB,EAAqB,EAAE;IACtF,IAAI,CAAC;QACD,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IAC1B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACX,OAAO,GAAG,CAAC,GAAQ,CAAC,CAAC;IACzB,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAe,MAAgC,EAAiB,EAAE,CACtF,MAAM,EAAE,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AAEnD,MAAM,CAAC,MAAM,OAAO,GAAG,CAAsB,MAAgC,EAAE,EAAK,EAAS,EAAE,CAC3F,MAAM,EAAE,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AAE5C,MAAM,CAAC,MAAM,eAAe,GAAG,CAAI,MAAwB,EAAK,EAAE;IAC9D,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;QACZ,OAAO,MAAM,CAAC,KAAK,CAAC;IACxB,CAAC;IACD,MAAM,MAAM,CAAC,KAAK,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAI,KAA2B,EAAa,EAAE;IACnE,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;QACxC,OAAO,GAAG,CAAC,IAAI,YAAY,CAAC,KAA2B,CAAC,CAAC,CAAC;IAC9D,CAAC;IACD,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;AACrB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,WAAW,GAAG,eAAe,CAAC;AAE3C,MAAM,CAAC,MAAM,SAAS,GAAG,CAAI,OAA2B,EAAe,EAAE;IACrE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpE,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,OAAO,GAAG,CAAC,IAAI,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC;IAChD,CAAC;IACD,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpE,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,IAAI,GAAG,CAAI,OAA2B,EAAiB,EAAE;IAClE,MAAM,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpE,OAAO,EAAE,CAAC,OAAO,CAAC,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG,CAAI,GAAG,OAA2B,EAAgC,EAAE;IACtF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACxD,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAC9C,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AAC7B,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,GAAG,OAA6B,EAA6B,EAAE;IACrF,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IACpE,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACpB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC1B,CAAC;IACD,OAAO,CAAC,KAAK,CAAC,CAAC;AACnB,CAAC,CAAC;AAEF,MAAM,OAAO,mBAAoB,SAAQ,KAAK;IACd;IAA5B,YAA4B,MAAe;QACvC,KAAK,CAAC,wBAAwB;YAC1B,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CACpF,CAAC;QAHsB,WAAM,GAAN,MAAM,CAAS;IAI3C,CAAC;CACJ;AAUD,MAAM,CAAC,MAAM,IAAI,GAAG,CAAe,MAAoB,EAAqB,EAAE,CAAC,CAAC;IAC5E,IAAI,EAAE,QAAQ,CAAC,MAAM,CAAC;IACtB,MAAM,EAAE,UAAU,CAAC,MAAM,CAAC;IAC1B,KAAK,EAAE,SAAS,CAAC,MAAM,CAAC;IACxB,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC;IAC5B,YAAY,EAAE,gBAAgB,CAAC,MAAM,CAAC;CACzC,CAAC,CAAC;AAEH,MAAM,QAAQ,GAAG,CAAO,MAAoB,EAAE,EAAE,CAAC,CAAI,EAAe,EAAqB,EAAE;IACvF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACb,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IACD,OAAO,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACtC,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAO,MAAoB,EAAE,EAAE,CAAC,GAAiB,EAAE,CAAC,MAAM,CAAC;AAC9E,MAAM,SAAS,GAAG,CAAO,MAAoB,EAAE,EAAE,CAAC,GAAkB,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;AACxF,MAAM,WAAW,GAAG,CAAO,MAAoB,EAAE,EAAE,CAAC,CAAI,EAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;AACzF,MAAM,gBAAgB,GAAG,CAAO,MAAoB,EAAE,EAAE,CAAC,GAAG,EAAE;IAC1D,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;QACZ,OAAO,MAAM,CAAC,KAAK,CAAC;IACxB,CAAC;IACD,MAAM,MAAM,CAAC,KAAK,CAAC;AACvB,CAAC,CAAC;AAUF,MAAM,CAAC,MAAM,SAAS,GAAG,CAAO,MAAyB,EAA0B,EAAE,CAAC,CAAC;IACnF,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC;IAC3B,MAAM,EAAE,eAAe,CAAC,MAAM,CAAC;IAC/B,KAAK,EAAE,cAAc,CAAC,MAAM,CAAC;IAC7B,OAAO,EAAE,gBAAgB,CAAC,MAAM,CAAC;IACjC,YAAY,EAAE,qBAAqB,CAAC,MAAM,CAAC;CAC9C,CAAC,CAAC;AAEH,MAAM,aAAa,GAAG,CAAO,MAAyB,EAAE,EAAE,CACtD,CAAI,EAAwC,EAA0B,EAAE;IACpE,MAAM,WAAW,GAAG,MAA2B,CAAC;IAChD,MAAM,oBAAoB,GAAG,WAAW,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE;QAC5D,IAAI,eAAe,CAAC,EAAE,EAAE,CAAC;YACrB,IAAI,CAAC;gBACD,MAAM,KAAK,GAAG,EAAE,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;gBACxC,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC;qBACxB,KAAK,CAAC,GAAG,CAAC,CAAC;YACpB,CAAC;YAAC,OAAO,GAAG,EAAE,CAAC;gBACX,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;YACpB,CAAC;QACL,CAAC;aAAM,CAAC;YACJ,OAAO,eAAe,CAAC;QAC3B,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,SAAS,CAAC,oBAAoB,CAAC,CAAC;AAC3C,CAAC,CAAC;AAEN,MAAM,eAAe,GAAG,CAAe,MAAyB,EAAE,EAAE,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC;AAClF,MAAM,cAAc,GAAG,CAAO,MAAyB,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE;IACnE,IAAI,CAAC;QACD,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC;QACzB,IAAI,GAAG,CAAC,EAAE,EAAE,CAAC;YACT,OAAO,GAAG,CAAC,KAAK,CAAC;QACrB,CAAC;QACD,OAAO,SAAS,CAAC;IACrB,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,SAAS,CAAC;IACrB,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,gBAAgB,GAAG,CAAO,MAAyB,EAAE,EAAE,CAAC,KAAK,EAAK,EAAK,EAAE,EAAE;IAC7E,IAAI,CAAC;QACD,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC;QACzB,IAAI,GAAG,CAAC,EAAE,EAAE,CAAC;YACT,OAAO,GAAG,CAAC,KAAK,CAAC;QACrB,CAAC;QACD,OAAO,EAAE,CAAC;IACd,CAAC;IAAC,MAAM,CAAC;QACL,OAAO,EAAE,CAAC;IACd,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,qBAAqB,GAAG,CAAO,MAAyB,EAAE,EAAE,CAAC,KAAK,IAAI,EAAE;IAC1E,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC;IACzB,IAAI,GAAG,CAAC,EAAE,EAAE,CAAC;QACT,OAAO,GAAG,CAAC,KAAK,CAAC;IACrB,CAAC;IACD,MAAM,GAAG,CAAC,KAAK,CAAC;AACpB,CAAC,CAAC;AAWF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAe,OAAuB,EAAuB,EAAE,CAAC,CAAC;IACzF,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC;IACvB,MAAM,EAAE,YAAY,CAAC,OAAO,CAAC;IAC7B,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;IAC/B,KAAK,EAAE,WAAW,CAAC,OAAO,CAAC;IAC3B,OAAO,EAAE,aAAa,CAAC,OAAO,CAAC;IAC/B,YAAY,EAAE,kBAAkB,CAAC,OAAO,CAAC;CAC5C,CAAC,CAAC;AAEH,MAAM,SAAS,GAAG,CAAO,OAAuB,EAAE,EAAE,CAAC,CAAI,EAAe,EAAuB,EAAE;IAC7F,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QACd,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,YAAY,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACnD,CAAC,CAAC;AAEF,MAAM,YAAY,GAAG,CAAO,OAAuB,EAAE,EAAE,CAAC,CAAC,EAAqB,EAAuB,EAAE;IACnG,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,CAAC;QACd,OAAO,YAAY,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IACD,OAAO,YAAY,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACtD,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAO,OAAuB,EAAE,EAAE,CAAC,GAAmB,EAAE,CAAC,OAAO,CAAC;AAEvF,MAAM,WAAW,GAAG,CAAO,OAAuB,EAAE,EAAE,CAAC,GAAoB,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;AAErH,MAAM,aAAa,GAAG,CAAO,OAAuB,EAAG,EAAE,CAAC,CAAI,EAAK,EAAW,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;AAEjH,MAAM,kBAAkB,GAAG,CAAO,OAAuB,EAAE,EAAE,CAAC,GAAQ,EAAE;IACpE,IAAI,OAAO,CAAC,EAAE,EAAE,CAAC;QACb,OAAO,OAAO,CAAC,KAAK,CAAC;IACzB,CAAC;SAAM,CAAC;QACJ,MAAM,OAAO,CAAC,KAAK,CAAC;IACxB,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,OAAO,YAAa,SAAQ,KAAK;IACP;IAA5B,YAA4B,KAAuB;QAC/C,KAAK,CAAC,6BAA6B,CAAC,CAAC;QADb,UAAK,GAAL,KAAK,CAAkB;IAEnD,CAAC;CACJ;AAAA,CAAC"}

package/lib/esm/services/Template.js

@@ -0,0 +1,38 @@
+import { Ctx } from './Logger';
+import { Err, GetValueOrThrow, Ok } from './Result';
+export const EvaluateHandlebarsProductCardTemplate = (logger, windowInfo, publisher, product, clickthrough) => {
+    const log = Ctx(logger)?.with('EvaluateHandlebarsProductCardTemplate');
+    log?.info('Evaluating handlebars product card template', product);
+    try {
+        const renderedClickthrough = clickthrough ?? GetValueOrThrow(EvaluateHandlebarsClickthroughTemplate(log, windowInfo, publisher, product));
+        log?.debug('Got clickthrough URL', renderedClickthrough);
+        return Ok(publisher.templates.productCardTemplate({
+            ...product,
+            product,
+            window: windowInfo,
+            publisher,
+            catalog: product,
+            clickthrough: renderedClickthrough
+        }));
+    }
+    catch (error) {
+        return Err(error);
+    }
+};
+export const EvaluateHandlebarsClickthroughTemplate = (logger, windowInfo, publisher, product) => {
+    const log = Ctx(logger)?.with('EvaluateHandlebarsClickthroughTemplate');
+    log?.info('Evaluating handlebars clickthrough URL template', product);
+    try {
+        return Ok(publisher.templates.clickThroughUrlTemplate({
+            product,
+            catalog: product,
+            window: windowInfo,
+            publisher,
+            ...product
+        }));
+    }
+    catch (error) {
+        return Err(error);
+    }
+};
+//# sourceMappingURL=Template.js.map

package/lib/esm/services/Template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Template.js","sourceRoot":"src/","sources":["services/Template.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,GAAG,EAAgB,MAAM,UAAU,CAAC;AAC7C,OAAO,EAAE,GAAG,EAAE,eAAe,EAAE,EAAE,EAAe,MAAM,UAAU,CAAC;AAWjE,MAAM,CAAC,MAAM,qCAAqC,GAAG,CAAC,MAA2B,EAC7E,UAAyC,EACzC,SAA0C,EAC1C,OAA4B,EAC5B,YAAqB,EACP,EAAE;IAChB,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,uCAAuC,CAAC,CAAC;IACvE,GAAG,EAAE,IAAI,CAAC,6CAA6C,EAAE,OAAO,CAAC,CAAC;IAElE,IAAI,CAAC;QACD,MAAM,oBAAoB,GAAG,YAAY,IAAI,eAAe,CACxD,sCAAsC,CAAC,GAAG,EACtC,UAAU,EACV,SAAS,EACT,OAAO,CACV,CACJ,CAAC;QACF,GAAG,EAAE,KAAK,CAAC,sBAAsB,EAAE,oBAAoB,CAAC,CAAC;QAEzD,OAAO,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,mBAAmB,CAAC;YAC9C,GAAG,OAAO;YACV,OAAO;YACP,MAAM,EAAE,UAAU;YAClB,SAAS;YACT,OAAO,EAAE,OAAO;YAChB,YAAY,EAAE,oBAAoB;SACrC,CAAC,CAAC,CAAC;IACR,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,GAAG,CAAC,KAAc,CAAC,CAAC;IAC/B,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,sCAAsC,GAAG,CAAC,MAA2B,EAC9E,UAAyC,EACzC,SAA0C,EAC1C,OAA4B,EACd,EAAE;IAChB,MAAM,GAAG,GAAG,GAAG,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,wCAAwC,CAAC,CAAC;IACxE,GAAG,EAAE,IAAI,CAAC,iDAAiD,EAAE,OAAO,CAAC,CAAC;IACtE,IAAI,CAAC;QACD,OAAO,EAAE,CAAC,SAAS,CAAC,SAAS,CAAC,uBAAuB,CAAC;YAClD,OAAO;YACP,OAAO,EAAE,OAAO;YAChB,MAAM,EAAE,UAAU;YAClB,SAAS;YACT,GAAG,OAAO;SACb,CAAC,CAAC,CAAC;IACR,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACb,OAAO,GAAG,CAAC,KAAc,CAAC,CAAC;IAC/B,CAAC;AACL,CAAC,CAAC"}

package/lib/esm/services/index.js

@@ -0,0 +1,12 @@
+export * from './Geo';
+export * from './Logger';
+export * from './Result';
+export * from './Device';
+export * from './Configuration';
+export * from './Bidder';
+export * from './Product';
+export * from './Recommender';
+export * from './mock';
+export * from './Template';
+export * from './Dynamic';
+//# sourceMappingURL=index.js.map

package/lib/esm/services/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"src/","sources":["services/index.ts"],"names":[],"mappings":"AAAA,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,iBAAiB,CAAC;AAChC,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}

package/lib/esm/services/mock/Bidder.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Bidder.js.map

package/lib/esm/services/mock/Bidder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Bidder.js","sourceRoot":"src/","sources":["services/mock/Bidder.ts"],"names":[],"mappings":""}

package/lib/esm/services/mock/index.js

@@ -0,0 +1,2 @@
+export * from './Bidder';
+//# sourceMappingURL=index.js.map

package/lib/esm/services/mock/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"src/","sources":["services/mock/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC"}

package/lib/types/Api.d.ts

@@ -0,0 +1,169 @@
+import type { INativeTemplateDelegateWindow, ICompiledPublisherConfiguration, IDevice, IGeoContext } from './models';
+import { type AsyncResult, type INavigator, type IScreen, type RequestBidsFn, type ILogger, type GetSponsoredProductFromNativeIdFn, type PersonalRecommenderFn, type NonPersonalRecommenderFn, type GetConfigurationFn, type GetGeoFn, type GetDeviceFn, type GetRecommendedProductFromProductIdFn, type GetAllSponsoredProductFromNativeIdFn } from './services';
+import { type BuildAllSponsoredProductCardResponsesFn, type GenerateSponsoredProductCardResponseFn, type NativeRequestBuilderFn, type RequestBuilderFn } from './helpers';
+import Handlebars from 'handlebars/runtime';
+import { type BuildHybridCarouselFn, type BuildHybridCarouselFromInitialBidFn, type BuildRecommendedCarouselFn, type BuildSponsoredCarouselFn, type BuildSponsoredCarouselFromInitialBidFn } from './helpers/response/Carousel';
+import { type EvaluateClickthroughTemplateFn, type EvaluateProductCardTemplateFn } from './services/Template';
+import { type BuildDynamicZoneRequestFn, type GetDynamicZoneFn } from './services/Dynamic';
+export declare const PROD_BIDDER = "//bid.surfside.io/rtb/bids/surfside";
+export declare const PROD_CONFIGURATION_SERVICE = "//r.surfside.io";
+export declare const PROD_SPONSORED_PRODUCT_FEED = "//creative.surfside.io";
+export declare const PROD_RECOMMENDED_PRODUCT_FEED = "//creative.surfside.io";
+export declare const PROD_RECOMMENDER_SERVICE = "//t.surfside.io";
+export declare const PROD_DYNAMIC_ZONE_SERVICE = "//r.surfside.io/";
+/**
+ * A collection of services for querying the surfside API and building responses
+ */
+export interface ISurfsideApi {
+    /**
+     * An optional logger
+     */
+    logger?: ILogger;
+    /**
+     * Gets information about the User's device in OpenRTB's device format
+     */
+    getDevice: GetDeviceFn;
+    /**
+     * The user's device info
+     */
+    device: IDevice | undefined;
+    /**
+     * Gets the user's current current geo and IP information.
+     */
+    getGeo: GetGeoFn;
+    /**
+     * The user's current geo and IP information
+     */
+    geo: IGeoContext | undefined;
+    /**
+     * The site's publisher configuration. Product card templates, clickthrough URL templates, settings, etc.
+     */
+    configuration: ICompiledPublisherConfiguration;
+    /**
+     * Gets the site's publisher configuration
+     */
+    getConfiguration: GetConfigurationFn;
+    /**
+     * A handlebars runtime instance, for evaluating templates
+     */
+    handlebars: typeof Handlebars;
+    /**
+     * Sends a bid request to the bidder and returns its response, if available
+     */
+    requestBids: RequestBidsFn;
+    /**
+     * Builds an OpenRTB 2.6 request
+     */
+    startRequest: RequestBuilderFn;
+    /**
+     * Builds an OpenRTB Native 1.2 request
+     */
+    startNative: NativeRequestBuilderFn;
+    /**
+     * Builds an OpenRTB Native 1.2 request with initial fields, such as site, app, and trackers
+     */
+    defaultNative: NativeRequestBuilderFn;
+    /**
+     * Creates a sponsored product generator from the given Native Creative ID. One native creative ID can generate
+     * multiple products
+     */
+    getSponsoredProduct: GetSponsoredProductFromNativeIdFn;
+    /**
+     * Gets all sponsored products from the native creative ID. One native creative ID can generate multiple products
+     */
+    getAllSponsoredProducts: GetAllSponsoredProductFromNativeIdFn;
+    /**
+     * Gets the associated product info for the site from a product ID
+     */
+    getRecommendedProduct: GetRecommendedProductFromProductIdFn;
+    /**
+     * Creates a recommended product generator for the top (most popular) products on the site.
+     */
+    generateTopProducts: NonPersonalRecommenderFn;
+    /**
+     * Creates a recommended product generator for products recommended for the user. If there are no recommended
+     * products for the user, or if the API was initialized without a user ID, this will return a generator for top
+     * products instead
+     */
+    generateForYou: PersonalRecommenderFn;
+    /**
+     * Creates a recommended product generator based on the user's previously purchased products. If there are no
+     * recommended products for the user, or if the API was initialized without a user ID, this will return a generator
+     * for top products instead
+     */
+    generatePreviousPurchases: PersonalRecommenderFn;
+    /**
+     * Creates a carousel state object using the bid request. The state object is a callback function which sends the
+     * bid request to the bidder and generates product cards from it. When the bid is out of product cards, the
+     * generator will request more bids with the same bid request. If no bids are returned, the generator completes.
+     */
+    buildSponsoredCarousel: BuildSponsoredCarouselFn;
+    /**
+     * Creates a carousel state object using the bid request and initializes it with a pre-existing bid. This is used
+     * for dynamic zones and probably doesn't need to be used in any client applications. The state object is a callback
+     * function which sends the bid request to the bidder and generates product cards from it. When the bid is out of
+     * product cards, the generator will request more bids with the same bid request. If no bids are returned, the
+     * generator completes.
+     */
+    buildSponsoredCarouselFromInitialBid: BuildSponsoredCarouselFromInitialBidFn;
+    /**
+     * Creates a carousel state object with recommendations from the given recommender type (top product, for you,
+     * previous purchases). The state object is a callback function which sends the bid request to the bidder and
+     * generates product cards from it. When the bid is out of product cards, the generator will request more bids with
+     * the same bid request. If no bids are returned, the generator completes.
+     */
+    buildRecommendedCarousel: BuildRecommendedCarouselFn;
+    buildHybridCarousel: BuildHybridCarouselFn;
+    buildHybridCarouselFromInitialBid: BuildHybridCarouselFromInitialBidFn;
+    buildAllSponsoredProductCardResponses: BuildAllSponsoredProductCardResponsesFn;
+    generateSponsoredProductCardResponse: GenerateSponsoredProductCardResponseFn;
+    evaluateProductCardTemplate: EvaluateProductCardTemplateFn;
+    evaluateClickthroughTemplate: EvaluateClickthroughTemplateFn;
+    getDynamicZone: GetDynamicZoneFn;
+    buildDynamicZoneRequest: BuildDynamicZoneRequestFn;
+}
+/**
+ * Initializes the API with the services explicitly passed to it. This function is used by the framework for overloading
+ * mock services. It should not be used in an application
+ * @param internalApiDto The list of services and helpers to inject
+ * @returns An initialized Surfside API
+ */
+export declare function InitSurfAdsCoreInternal(internalApiDto: {
+    logger: ILogger | undefined;
+    requestBids: RequestBidsFn;
+    getConfiguration: GetConfigurationFn;
+    getGeo: GetGeoFn;
+    getDevice: GetDeviceFn;
+    getSponsoredProduct: GetSponsoredProductFromNativeIdFn;
+    getAllSponsoredProducts: GetAllSponsoredProductFromNativeIdFn;
+    getRecommendedProduct: GetRecommendedProductFromProductIdFn;
+    generateTopProducts: NonPersonalRecommenderFn;
+    generateForYou: PersonalRecommenderFn;
+    generatePreviousPurchases: PersonalRecommenderFn;
+    getDynamicZone: GetDynamicZoneFn;
+    buildAllSponsoredProductCardResponses: BuildAllSponsoredProductCardResponsesFn;
+    generateSponsoredProductCardResponse: GenerateSponsoredProductCardResponseFn;
+    evaluateProductCardTemplate: EvaluateProductCardTemplateFn;
+    evaluateClickthroughTemplate: EvaluateClickthroughTemplateFn;
+    handlebars: typeof Handlebars;
+    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<ISurfsideApi>;
+export declare const InitSurfAdsCoreServices: (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<ISurfsideApi>;
+export declare const InitSurfAdsCoreSSR: (windowInfo: INativeTemplateDelegateWindow, screen: IScreen, navigator: INavigator, mobile: boolean, ip: string, geoProviderToken: string, accountId: string, siteId: string, channelId: string, locationId: string, userId: string | undefined, logger?: ILogger) => AsyncResult<ISurfsideApi>;
+export declare const InitSurfAdsCore: (channelId: string, accountId: string, siteId: string, locationId: string, userId: string | undefined, logger?: ILogger) => AsyncResult<ISurfsideApi>;
+export declare class MissingConfigurationError extends Error {
+    constructor(accountId: string, siteId: string);
+}
+export declare class NotABrowserError extends Error {
+    constructor();
+}

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

@@ -0,0 +1,5 @@
+export declare const ConsumeN: <T>(generator: Generator<T>, n: number) => T[];
+export declare const ConsumeAll: <T>(generator: Generator<T>) => T[];
+export declare const ConsumeNAsync: <T>(generator: AsyncGenerator<T>, n: number) => Promise<[data: T[], finished: boolean]>;
+export declare const ConsumeAllAsync: <T>(generator: AsyncGenerator<T>) => Promise<T[]>;
+export declare function GenerateArray<T>(data: T[]): Generator<T>;

package/lib/types/helpers/{handlebars/index.d.ts → Handlebars.d.ts}

@@ -23,7 +23,9 @@ export declare function slug(name: string, options: {
     hash: {
         hyphenate: string | undefined;
         drop: string | undefined;
+        dropBefore: string | undefined;
         length: number | undefined;
+        separator: string | undefined;
     };
 }): string;
 /**
@@ -33,6 +35,7 @@ export declare function slug(name: string, options: {
  * @returns A lowercase version of the passed string
  */
 export declare function lower(name: string): string;
+export declare function upper(name: string): string;
 /**
  * Returns the path component of the URL at the specified position, 1-indexed
  * For example, if the URL is "https://example.com/foo/bar", {{path 1}} will return "foo".
@@ -40,9 +43,9 @@ export declare function lower(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;
-export declare function global(): any;
+export declare function path(position: number): string | undefined;
 export declare function sed(input: string, searchRegex: string, replacement: string): string;
+export declare function replace(input: string, search: string, replacement: string, all?: boolean): string;
 /**
  * Returns the value of the specified query parameter from the URL, specified by key.
  * For example, if the URL is "https://example.com?foo=bar", {{search "foo"}} will return "bar".
@@ -58,7 +61,7 @@ export declare function search(name: string): string;
  *
  * @returns The first truthy argument, or an empty string if all arguments are falsy
  */
-export declare function coalesce(): string;
+export declare function coalesce(...args: any[]): string;
 /**
  * Joins the passed arguments with the specified separator.
  * For example, {{join "foo" "bar" "baz"}} will return "foo/bar/baz"..
@@ -68,7 +71,7 @@ export declare function coalesce(): string;
  *
  * @returns The joined string
  */
-export declare function join(): string;
+export declare function join(...args: any[]): string;
 /**
  * Encodes the passed string for use in a URI component.
  *
@@ -116,4 +119,6 @@ export declare function isIn(a: any, b: any[]): boolean;
  *
  * @returns An array of the passed arguments
  */
-export declare function array(): any[];
+export declare function array(...args: any[]): any[];
+export type HandlebarsHelpers = Record<string, Function>;
+export declare const GetHelpers: () => HandlebarsHelpers;

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

@@ -0,0 +1,29 @@
+import { type INativeRequest } from '../models';
+import { type ILogger } from '../services';
+export type NativeRequestBuilderFn = () => NativeRequestBuilder;
+export type NativeRequestBuilder = {
+    withVer: (ver: string) => NativeRequestBuilder;
+    withContext: (context: number) => NativeRequestBuilder;
+    withContextSubType: (contextSubType: number) => NativeRequestBuilder;
+    withPlacementType: (placementType: number) => NativeRequestBuilder;
+    withTitle: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withImage: (width: number, height: number, minWidth?: number, minHeight?: number, required?: boolean) => NativeRequestBuilder;
+    withVideo: (mimes: number[] | string[], minDuration: number, maxDuration: number, required?: boolean) => NativeRequestBuilder;
+    withData: (type: number, id: number, length?: number, required?: boolean) => NativeRequestBuilder;
+    withSponsored: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withDescription: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withRating: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withPrice: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withSalePrice: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withDisplayURL: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withCTAText: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withCategory: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withTHC: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withCBD: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withStrain: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withMetaProduct: (length?: number, required?: boolean) => NativeRequestBuilder;
+    withEventTracker: (event: number, methods: number[]) => NativeRequestBuilder;
+    build: () => INativeRequest;
+};
+export declare const StartNative: (logger: ILogger | undefined) => NativeRequestBuilder;
+export declare const DefaultNative: (logger: ILogger | undefined) => NativeRequestBuilder;

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

@@ -0,0 +1,16 @@
+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';
+export type RequestBuilderFn = (zoneId: string, id?: string) => RequestBuilder;
+export type RequestWith<T> = (t: T) => RequestBuilder;
+export type RequestBuilder = {
+    withUser: RequestWith<IUser>;
+    withRegulations: RequestWith<IRegs>;
+    withApp: RequestWith<IApp>;
+    withSite: RequestWith<ISite>;
+    withKeywords: RequestWith<string[]>;
+    withBanner: (w: number, h: number, options?: Partial<IBanner>, impOptions?: Partial<IImp>) => RequestBuilder;
+    withVideo: (w: number, h: number, minduration: number, maxduration: number, mimes?: string[], options?: Partial<IVideo>, impOptions?: Partial<IImp>) => RequestBuilder;
+    withNative: (request: string | INativeRequest, 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;