@athoscommerce/beacon 1.0.0

package/src/client/models/index.ts

@@ -0,0 +1,56 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './AddtocartSchema';
+export * from './AddtocartSchemaData';
+export * from './AttributionInner';
+export * from './BannersInner';
+export * from './CartSchema';
+export * from './CartSchemaData';
+export * from './ClickthroughBannersInner';
+export * from './ClickthroughBannersSchema';
+export * from './ClickthroughBannersSchema1';
+export * from './ClickthroughResultsInner';
+export * from './ClickthroughResultsSchema';
+export * from './ClickthroughResultsSchema1';
+export * from './ClickthroughSchema';
+export * from './ClickthroughSchemaData';
+export * from './Context';
+export * from './Currency';
+export * from './ErrorResponseBody';
+export * from './ImpressionSchema';
+export * from './ImpressionSchemaData';
+export * from './InlineObject';
+export * from './InlineObject1';
+export * from './LogSchema';
+export * from './LogSchemaData';
+export * from './MessagingSchema';
+export * from './MessagingSchemaContext';
+export * from './MessagingSchemaData';
+export * from './OrderTransactionSchema';
+export * from './OrderTransactionSchemaData';
+export * from './PersonalizationLogContext';
+export * from './PersonalizationLogSchema';
+export * from './PersonalizationLogSchemaData';
+export * from './Product';
+export * from './ProductPageviewSchema';
+export * from './ProductPageviewSchemaData';
+export * from './ProductPageviewSchemaDataResult';
+export * from './RecommendationsAddtocartSchema';
+export * from './RecommendationsAddtocartSchemaData';
+export * from './RecommendationsClickthroughSchema';
+export * from './RecommendationsClickthroughSchemaData';
+export * from './RecommendationsImpressionSchema';
+export * from './RecommendationsImpressionSchemaData';
+export * from './RecommendationsRenderSchema';
+export * from './RecommendationsRenderSchemaData';
+export * from './RedirectSchema';
+export * from './RedirectSchemaData';
+export * from './RenderSchema';
+export * from './RenderSchemaData';
+export * from './ResultProduct';
+export * from './ResultProductType';
+export * from './ResultResultBanner';
+export * from './ResultsInner';
+export * from './ShopperContext';
+export * from './ShopperLoginSchema';
+export * from './ValidationErrorWithDataField';

package/src/client/runtime.ts

@@ -0,0 +1,432 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * analytics.athoscommerce.net
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 2.2.48
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+export const BASE_PATH = "https://analytics.athoscommerce.net/beacon/v2".replace(/\/+$/, "");
+
+export interface ConfigurationParameters {
+    basePath?: string; // override base path
+    fetchApi?: FetchAPI; // override for fetch implementation
+    middleware?: Middleware[]; // middleware to apply before/after fetch requests
+    queryParamsStringify?: (params: HTTPQuery) => string; // stringify function for query strings
+    username?: string; // parameter for basic security
+    password?: string; // parameter for basic security
+    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>); // parameter for apiKey security
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>); // parameter for oauth2 security
+    headers?: HTTPHeaders; //header params we want to use on every request
+    credentials?: RequestCredentials; //value for the credentials param we want to use on each request
+}
+
+export class Configuration {
+    constructor(private configuration: ConfigurationParameters = {}) {}
+
+    set config(configuration: Configuration) {
+        this.configuration = configuration;
+    }
+
+    get basePath(): string {
+        return this.configuration.basePath != null ? this.configuration.basePath : BASE_PATH;
+    }
+
+    get fetchApi(): FetchAPI | undefined {
+        return this.configuration.fetchApi;
+    }
+
+    get middleware(): Middleware[] {
+        return this.configuration.middleware || [];
+    }
+
+    get queryParamsStringify(): (params: HTTPQuery) => string {
+        return this.configuration.queryParamsStringify || querystring;
+    }
+
+    get username(): string | undefined {
+        return this.configuration.username;
+    }
+
+    get password(): string | undefined {
+        return this.configuration.password;
+    }
+
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined {
+        const apiKey = this.configuration.apiKey;
+        if (apiKey) {
+            return typeof apiKey === 'function' ? apiKey : () => apiKey;
+        }
+        return undefined;
+    }
+
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined {
+        const accessToken = this.configuration.accessToken;
+        if (accessToken) {
+            return typeof accessToken === 'function' ? accessToken : async () => accessToken;
+        }
+        return undefined;
+    }
+
+    get headers(): HTTPHeaders | undefined {
+        return this.configuration.headers;
+    }
+
+    get credentials(): RequestCredentials | undefined {
+        return this.configuration.credentials;
+    }
+}
+
+export const DefaultConfig = new Configuration();
+
+/**
+ * This is the base class for all generated API classes.
+ */
+export class BaseAPI {
+
+    private static readonly jsonRegex = new RegExp('^(:?application\/json|[^;/ \t]+\/[^;/ \t]+[+]json)[ \t]*(:?;.*)?$', 'i');
+    private middleware: Middleware[];
+
+    constructor(protected configuration = DefaultConfig) {
+        this.middleware = configuration.middleware;
+    }
+
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]) {
+        const next = this.clone<T>();
+        next.middleware = next.middleware.concat(...middlewares);
+        return next;
+    }
+
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>) {
+        const middlewares = preMiddlewares.map((pre) => ({ pre }));
+        return this.withMiddleware<T>(...middlewares);
+    }
+
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>) {
+        const middlewares = postMiddlewares.map((post) => ({ post }));
+        return this.withMiddleware<T>(...middlewares);
+    }
+
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean {
+        if (!mime) {
+            return false;
+        }
+        return BaseAPI.jsonRegex.test(mime);
+    }
+
+    protected async request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response> {
+        const { url, init } = await this.createFetchParams(context, initOverrides);
+        const response = await this.fetchApi(url, init);
+        if (response && (response.status >= 200 && response.status < 300)) {
+            return response;
+        }
+        throw new ResponseError(response, 'Response returned an error code');
+    }
+
+    private async createFetchParams(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction) {
+        let url = this.configuration.basePath + context.path;
+        if (context.query !== undefined && Object.keys(context.query).length !== 0) {
+            // only add the querystring to the URL if there are query parameters.
+            // this is done to avoid urls ending with a "?" character which buggy webservers
+            // do not handle correctly sometimes.
+            url += '?' + this.configuration.queryParamsStringify(context.query);
+        }
+
+        const headers = Object.assign({}, this.configuration.headers, context.headers);
+        Object.keys(headers).forEach(key => headers[key] === undefined ? delete headers[key] : {});
+
+        const initOverrideFn =
+            typeof initOverrides === "function"
+                ? initOverrides
+                : async () => initOverrides;
+
+        const initParams = {
+            method: context.method,
+            headers,
+            body: context.body,
+            credentials: this.configuration.credentials,
+        };
+
+        const overriddenInit: RequestInit = {
+            ...initParams,
+            ...(await initOverrideFn({
+                init: initParams,
+                context,
+            }))
+        };
+
+        let body: any;
+        if (isFormData(overriddenInit.body)
+            || (overriddenInit.body instanceof URLSearchParams)
+            || isBlob(overriddenInit.body)) {
+          body = overriddenInit.body;
+        } else if (this.isJsonMime(headers['Content-Type'])) {
+          body = JSON.stringify(overriddenInit.body);
+        } else {
+          body = overriddenInit.body;
+        }
+
+        const init: RequestInit = {
+            ...overriddenInit,
+            body
+        };
+
+        return { url, init };
+    }
+
+    private fetchApi = async (url: string, init: RequestInit) => {
+        let fetchParams = { url, init };
+        for (const middleware of this.middleware) {
+            if (middleware.pre) {
+                fetchParams = await middleware.pre({
+                    fetch: this.fetchApi,
+                    ...fetchParams,
+                }) || fetchParams;
+            }
+        }
+        let response: Response | undefined = undefined;
+        try {
+            response = await (this.configuration.fetchApi || fetch)(fetchParams.url, fetchParams.init);
+        } catch (e) {
+            for (const middleware of this.middleware) {
+                if (middleware.onError) {
+                    response = await middleware.onError({
+                        fetch: this.fetchApi,
+                        url: fetchParams.url,
+                        init: fetchParams.init,
+                        error: e,
+                        response: response ? response.clone() : undefined,
+                    }) || response;
+                }
+            }
+            if (response === undefined) {
+              if (e instanceof Error) {
+                throw new FetchError(e, 'The request failed and the interceptors did not return an alternative response');
+              } else {
+                throw e;
+              }
+            }
+        }
+        for (const middleware of this.middleware) {
+            if (middleware.post) {
+                response = await middleware.post({
+                    fetch: this.fetchApi,
+                    url: fetchParams.url,
+                    init: fetchParams.init,
+                    response: response.clone(),
+                }) || response;
+            }
+        }
+        return response;
+    }
+
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone<T extends BaseAPI>(this: T): T {
+        const constructor = this.constructor as any;
+        const next = new constructor(this.configuration);
+        next.middleware = this.middleware.slice();
+        return next;
+    }
+};
+
+function isBlob(value: any): value is Blob {
+    return typeof Blob !== 'undefined' && value instanceof Blob;
+}
+
+function isFormData(value: any): value is FormData {
+    return typeof FormData !== "undefined" && value instanceof FormData;
+}
+
+export class ResponseError extends Error {
+    override name: "ResponseError" = "ResponseError";
+    constructor(public response: Response, msg?: string) {
+        super(msg);
+    }
+}
+
+export class FetchError extends Error {
+    override name: "FetchError" = "FetchError";
+    constructor(public cause: Error, msg?: string) {
+        super(msg);
+    }
+}
+
+export class RequiredError extends Error {
+    override name: "RequiredError" = "RequiredError";
+    constructor(public field: string, msg?: string) {
+        super(msg);
+    }
+}
+
+export const COLLECTION_FORMATS = {
+    csv: ",",
+    ssv: " ",
+    tsv: "\t",
+    pipes: "|",
+};
+
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = { [key: string]: string };
+export type HTTPQuery = { [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery };
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = { headers?: HTTPHeaders; method: HTTPMethod; credentials?: RequestCredentials; body?: HTTPBody };
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+
+export type InitOverrideFunction = (requestContext: { init: HTTPRequestInit, context: RequestOpts }) => Promise<RequestInit>
+
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+
+export function querystring(params: HTTPQuery, prefix: string = ''): string {
+    return Object.keys(params)
+        .map(key => querystringSingleKey(key, params[key], prefix))
+        .filter(part => part.length > 0)
+        .join('&');
+}
+
+function querystringSingleKey(key: string, value: string | number | null | undefined | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery, keyPrefix: string = ''): string {
+    const fullKey = keyPrefix + (keyPrefix.length ? `[${key}]` : key);
+    if (value instanceof Array) {
+        const multiValue = value.map(singleValue => encodeURIComponent(String(singleValue)))
+            .join(`&${encodeURIComponent(fullKey)}=`);
+        return `${encodeURIComponent(fullKey)}=${multiValue}`;
+    }
+    if (value instanceof Set) {
+        const valueAsArray = Array.from(value);
+        return querystringSingleKey(key, valueAsArray, keyPrefix);
+    }
+    if (value instanceof Date) {
+        return `${encodeURIComponent(fullKey)}=${encodeURIComponent(value.toISOString())}`;
+    }
+    if (value instanceof Object) {
+        return querystring(value as HTTPQuery, fullKey);
+    }
+    return `${encodeURIComponent(fullKey)}=${encodeURIComponent(String(value))}`;
+}
+
+export function exists(json: any, key: string) {
+    const value = json[key];
+    return value !== null && value !== undefined;
+}
+
+export function mapValues(data: any, fn: (item: any) => any) {
+    const result: { [key: string]: any } = {};
+    for (const key of Object.keys(data)) {
+        result[key] = fn(data[key]);
+    }
+    return result;
+}
+
+export function canConsumeForm(consumes: Consume[]): boolean {
+    for (const consume of consumes) {
+        if ('multipart/form-data' === consume.contentType) {
+            return true;
+        }
+    }
+    return false;
+}
+
+export interface Consume {
+    contentType: string;
+}
+
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+
+export class JSONApiResponse<T> {
+    constructor(public raw: Response, private transformer: ResponseTransformer<T> = (jsonValue: any) => jsonValue) {}
+
+    async value(): Promise<T> {
+        return this.transformer(await this.raw.json());
+    }
+}
+
+export class VoidApiResponse {
+    constructor(public raw: Response) {}
+
+    async value(): Promise<void> {
+        return undefined;
+    }
+}
+
+export class BlobApiResponse {
+    constructor(public raw: Response) {}
+
+    async value(): Promise<Blob> {
+        return await this.raw.blob();
+    };
+}
+
+export class TextApiResponse {
+    constructor(public raw: Response) {}
+
+    async value(): Promise<string> {
+        return await this.raw.text();
+    };
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './client/models/index';
+export * from './client/apis/index';
+export { Beacon, type BeaconConfig, type PreflightRequestModel, type BeaconGlobals } from './Beacon';

package/src/indexCDN.ts

@@ -0,0 +1,34 @@
+import packageJSON from '../package.json';
+export const { version } = packageJSON;
+import { Beacon } from './Beacon';
+import { getContext } from '@searchspring/snap-toolbox';
+
+const scriptEl = document.currentScript as HTMLScriptElement;
+if (scriptEl) {
+    try {
+        const context = getContext(['siteId', 'siteid'], scriptEl);
+        const siteId = `${context.siteId || context.siteid}`.trim().toLowerCase();
+        let initializeBeacon = true;
+
+        if (typeof window !== 'undefined') {
+            if (window.searchspring?.tracker?.track || window.athos?.tracker?.track) {
+                console.warn('Beacon: This script should be removed. An exisiting Snap instance is already on the page.');
+                initializeBeacon = false;
+            }
+            if (window.athos?.tracker && !window.athos?.tracker?.track) {
+                console.warn('Beacon: Beacon script included multiple times. Second initialization ignored.');
+                initializeBeacon = false;
+            }
+            if (!siteId) {
+                throw new Error('Beacon: No siteId found in script context. Beacon will not initialize.');
+            }
+            if (initializeBeacon) {
+                const domain = siteId.startsWith('at') ? 'athos' : 'searchspring';
+                window.athos = window.athos || {};
+                window.athos.tracker = new Beacon({ siteId }, { initiator: `${domain}/cdn/beaconjs/${version}` });
+            }
+        }
+    } catch (e) {
+        console.error(e);
+    }
+}

package/src/utils/featureFlags.ts

@@ -0,0 +1,35 @@
+export function getFlags(userAgent = ''): FeatureFlags {
+	userAgent = (userAgent || (typeof window == 'undefined' ? {} : window?.navigator).userAgent || '').toLowerCase();
+
+	return {
+		cookies: function () {
+			return typeof window == 'undefined' ? false : window?.navigator?.cookieEnabled;
+		},
+		storage: function () {
+			const test = 'ss-test';
+			if (typeof window == 'undefined'){
+				return false;
+			}
+
+			try {
+				window?.localStorage.setItem(test, test);
+				window?.localStorage.removeItem(test);
+
+				return true;
+			} catch (e) {
+				return false;
+			}
+		},
+	};
+}
+
+interface FeatureFlags {
+	cookies: () => boolean;
+	storage: () => boolean;
+}
+
+const flags = getFlags();
+export const featureFlags = {
+	cookies: flags.cookies(),
+	storage: flags.storage(),
+};

package/tsconfig.cjs.json

@@ -0,0 +1,31 @@
+{
+	"compilerOptions": {
+		"declaration": true,
+		"declarationMap": true,
+		"moduleResolution": "node",
+		"esModuleInterop": true,
+		"lib": [
+			"es2020",
+			"dom"
+		],
+		"resolveJsonModule": true,
+		"strict": true,
+		"target": "es5",
+		"module": "CommonJS",
+		"outDir": "./dist/cjs"
+	},
+	"exclude": [
+		"**/node_modules/*",
+		"**/coverage/*",
+		"**/dist/**",
+		"**/*.spec.ts",
+		"**/*.spec.tsx",
+		"**/*.test.ts",
+		"**/*.test.tsx",
+		"**/*.stories.tsx",
+		"**/__tests__/*",
+		"**/__mocks__/*",
+		"**/test/*",
+		"**/*.cy.tsx",
+	]
+}

package/tsconfig.json

@@ -0,0 +1,34 @@
+{
+	"compilerOptions": {
+		"target": "es2020",
+		"module": "es2020",
+		"declaration": true,
+		"declarationMap": true,
+		"moduleResolution": "node",
+		"esModuleInterop": true,
+		"lib": [
+			"es2020",
+			"dom"
+		],
+		"resolveJsonModule": true,
+		"strict": true,
+		"outDir": "./dist/esm",
+	},
+	"exclude": [
+		"**/node_modules/*",
+		"**/coverage/*",
+		"**/dist/**",
+		"**/*.spec.ts",
+		"**/*.spec.tsx",
+		"**/*.test.ts",
+		"**/*.test.tsx",
+		"**/*.stories.tsx",
+		"**/__tests__/*",
+		"**/__mocks__/*",
+		"**/test/*",
+		"**/*.cy.tsx",
+	],
+	"include": [
+		"src"
+	],
+}

package/webpack.prod.js

@@ -0,0 +1,47 @@
+const path = require("path");
+
+module.exports = {
+	mode: "production",
+	entry: "./src/indexCDN.ts",
+	output: {
+		filename: "beacon.js",
+		path: path.resolve(__dirname, "dist/cdn"),
+	},
+	resolve: {
+		extensions: [".ts", ".js"],
+	},
+	target: "browserslist:universal",
+	module: {
+		rules: [
+			{
+				test: /\.(ts|js)?$/,
+				use: [
+					{
+						loader: "babel-loader",
+						options: {
+							presets: [
+								[
+									"@babel/preset-env",
+									{
+										browserslistEnv: "universal",
+									},
+								],
+							],
+						},
+					},
+					{
+						loader: 'ts-loader',
+						options: {
+							transpileOnly: true,
+						},
+					},
+				],
+				include: [
+					/node_modules\/@searchspring/,
+					/node_modules\/@athoscommerce/,
+					path.resolve(__dirname, "src"),
+				],
+			},
+		],
+	},
+}