@athoscommerce/beacon 1.0.0

package/dist/cjs/src/utils/featureFlags.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.featureFlags = void 0;
+exports.getFlags = getFlags;
+function getFlags(userAgent) {
+    if (userAgent === void 0) { userAgent = ''; }
+    userAgent = (userAgent || (typeof window == 'undefined' ? {} : window === null || window === void 0 ? void 0 : window.navigator).userAgent || '').toLowerCase();
+    return {
+        cookies: function () {
+            var _a;
+            return typeof window == 'undefined' ? false : (_a = window === null || window === void 0 ? void 0 : window.navigator) === null || _a === void 0 ? void 0 : _a.cookieEnabled;
+        },
+        storage: function () {
+            var test = 'ss-test';
+            if (typeof window == 'undefined') {
+                return false;
+            }
+            try {
+                window === null || window === void 0 ? void 0 : window.localStorage.setItem(test, test);
+                window === null || window === void 0 ? void 0 : window.localStorage.removeItem(test);
+                return true;
+            }
+            catch (e) {
+                return false;
+            }
+        },
+    };
+}
+var flags = getFlags();
+exports.featureFlags = {
+    cookies: flags.cookies(),
+    storage: flags.storage(),
+};

package/dist/esm/package.json

@@ -0,0 +1,78 @@
+{
+    "name": "@athoscommerce/beacon",
+    "version": "1.0.0",
+    "author": "athoscommerce",
+    "license": "MIT",
+    "description": "Javascript library for utilizing Athos Commerce beacon tracking.",
+    "main": "dist/cjs/src/index.js",
+    "module": "dist/esm/src/index.js",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/athoscommerce/beacon.js.git"
+    },
+    "prettier": "@searchspring/prettier",
+    "scripts": {
+        "analyze": "webpack --config webpack.prod.js --analyze",
+        "build": "rm -rf ./dist && npm run generate && tsc && tsc -p tsconfig.cjs.json && npm run build:cdn",
+        "build:cdn": "webpack --config webpack.prod.js",
+        "dev:server": "http-server ./public",
+        "dev": "tsc --watch",
+        "commit": "cz",
+        "test": "jest",
+        "test:watch": "jest --watch",
+        "generate": "rm -fr ./src/client && openapi-generator-cli generate -i ./beacon.v2.snap.types.oas.yaml -g typescript-fetch -o ./src/client",
+        "format": "prettier --write 'src/**/*.{js,jsx,ts,tsx}' '!src/client/**'",
+        "lint": "eslint 'src/**/*.{js,jsx,ts,tsx}'",
+        "prepare": "husky",
+        "version": "standard-version -a",
+        "postpublish": "git push && git push --tags"
+    },
+    "dependencies": {
+        "@searchspring/snap-toolbox": "0.73.7",
+        "uuid": "9.0.1"
+    },
+    "devDependencies": {
+        "@babel/core": "^7.21.4",
+        "@babel/preset-env": "^7.21.4",
+        "@babel/runtime": "^7.21.0",
+        "@openapitools/openapi-generator-cli": "^2.25.2",
+        "@searchspring/browserslist-config-snap": "^1.0.7",
+        "@searchspring/prettier": "1.0.2",
+        "@types/jest": "^29.5.14",
+        "@types/uuid": "^10.0.0",
+        "babel-loader": "^9.1.2",
+        "cz-conventional-changelog": "3.3.0",
+        "eslint": "9.23.0",
+        "eslint-config-prettier": "10.1.1",
+        "http-server": "^14.1.1",
+        "husky": "9.1.7",
+        "jest": "29.7.0",
+        "jest-environment-jsdom": "^29.7.0",
+        "jsdom": "26.0.0",
+        "lint-staged": "15.5.0",
+        "prettier": "3.5.3",
+        "standard-version": "9.5.0",
+        "ts-jest": "^29.3.0",
+        "ts-loader": "9.4.2",
+        "typedoc": "0.28.1",
+        "typescript": "5.8.2",
+        "webpack": "^5.77.0",
+        "webpack-bundle-analyzer": "^4.8.0",
+        "webpack-cli": "^5.0.1",
+        "whatwg-fetch": "^3.6.20"
+    },
+    "lint-staged": {
+        "*.{js,ts,tsx}": [
+            "prettier --write",
+            "eslint"
+        ]
+    },
+    "config": {
+        "commitizen": {
+            "path": "./node_modules/cz-conventional-changelog"
+        }
+    },
+    "browserslist": {
+        "universal": "extends @searchspring/browserslist-config-snap/universal"
+    }
+}

package/dist/esm/src/Beacon.d.ts

@@ -0,0 +1,181 @@
+export declare const version: string;
+import { Context, AutocompleteApi, CartApi, CartSchemaData, CategoryApi, ErrorLogsApi, OrderApi, OrderTransactionSchemaData, Product, ProductApi, RecommendationsApi, SearchApi, ShopperApi, FetchAPI, RecommendationsImpressionSchema, RedirectSchemaData, ClickthroughSchemaData, AddtocartSchemaData, ImpressionSchemaData, RecommendationsRenderSchemaData, RecommendationsImpressionSchemaData, RecommendationsAddtocartSchemaData, RecommendationsClickthroughSchemaData, RenderSchemaData, ProductPageviewSchemaData, ProductPageviewSchemaDataResult, ImpressionSchema, Currency, LogSchemaData, HTTPHeaders, RecommendationsAddtocartSchema, AddtocartSchema } from './client';
+declare global {
+    interface Window {
+        Beacon?: typeof Beacon;
+        searchspring?: any;
+        athos?: any;
+    }
+}
+export type PreflightRequestModel = {
+    userId: string;
+    siteId: string;
+    shopper?: string;
+    cart?: string[];
+    lastViewed?: string[];
+};
+export type BeaconConfig = {
+    mode?: 'production' | 'development';
+    initiator?: string;
+    requesters?: {
+        personalization?: {
+            origin?: string;
+            headers?: HTTPHeaders;
+        };
+        beacon?: {
+            origin?: string;
+            headers?: HTTPHeaders;
+        };
+    };
+    apis?: {
+        fetch?: FetchAPI;
+    };
+    href?: string;
+    userAgent?: string;
+};
+export type BeaconGlobals = {
+    siteId: string;
+};
+interface ApiMethodMap {
+    shopper: ShopperApi;
+    autocomplete: AutocompleteApi;
+    search: SearchApi;
+    category: CategoryApi;
+    recommendations: RecommendationsApi;
+    product: ProductApi;
+    cart: CartApi;
+    order: OrderApi;
+    error: ErrorLogsApi;
+}
+export interface PayloadRequest {
+    apiType: keyof ApiMethodMap;
+    endpoint: string;
+    payload: any;
+}
+export type Payload<T> = {
+    siteId?: string;
+    data: T;
+};
+export declare const REQUEST_GROUPING_TIMEOUT = 300;
+export declare const PREFLIGHT_DEBOUNCE_TIMEOUT = 300;
+export declare const PAGE_LOAD_ID_KEY = "ssPageLoadId";
+export declare const CART_KEY = "ssCartProducts";
+export declare const COOKIE_SAMESITE = "Lax";
+export declare const PAGE_LOAD_ID_EXPIRATION = 10000;
+export declare const COOKIE_DOMAIN: string | undefined;
+export declare class Beacon {
+    protected config: BeaconConfig;
+    protected globals: BeaconGlobals;
+    protected mode: 'production' | 'development';
+    private pageLoadId;
+    private userId;
+    private sessionId;
+    private shopperId;
+    private attribution;
+    private currency;
+    private initiator;
+    private batchIntervalTimeout;
+    private preflightTimeout;
+    private apis;
+    private requests;
+    constructor(globals: BeaconGlobals, config?: BeaconConfig);
+    private getCookie;
+    private setCookie;
+    private getLocalStorageItem;
+    private setLocalStorageItem;
+    storage: {
+        cart: {
+            get: () => Product[];
+            set: (products: Product[]) => void;
+            add: (products: Product[]) => void;
+            remove: (products: Product[]) => void;
+            clear: () => void;
+        };
+        viewed: {
+            get: () => ProductPageviewSchemaDataResult[];
+            set: (products: ProductPageviewSchemaDataResult[]) => void;
+            add: (products: ProductPageviewSchemaDataResult[]) => void;
+        };
+    };
+    events: {
+        shopper: {
+            login: (event: Payload<{
+                id: string;
+            }>) => void;
+        };
+        autocomplete: {
+            render: (event: Payload<RenderSchemaData>) => void;
+            impression: (event: Payload<ImpressionSchemaData>) => void;
+            addToCart: (event: Payload<AddtocartSchemaData>) => void;
+            clickThrough: (event: Payload<ClickthroughSchemaData>) => void;
+            redirect: (event: Payload<RedirectSchemaData>) => void;
+        };
+        search: {
+            render: (event: Payload<RenderSchemaData>) => void;
+            impression: (event: Payload<ImpressionSchemaData>) => void;
+            addToCart: (event: Payload<AddtocartSchemaData>) => void;
+            clickThrough: (event: Payload<ClickthroughSchemaData>) => void;
+            redirect: (event: Payload<RedirectSchemaData>) => void;
+        };
+        category: {
+            render: (event: Payload<RenderSchemaData>) => void;
+            impression: (event: Payload<ImpressionSchemaData>) => void;
+            addToCart: (event: Payload<AddtocartSchemaData>) => void;
+            clickThrough: (event: Payload<ClickthroughSchemaData>) => void;
+        };
+        recommendations: {
+            render: (event: Payload<RecommendationsRenderSchemaData>) => void;
+            impression: (event: Payload<RecommendationsImpressionSchemaData>) => void;
+            addToCart: (event: Payload<RecommendationsAddtocartSchemaData>) => void;
+            clickThrough: (event: Payload<RecommendationsClickthroughSchemaData>) => void;
+        };
+        product: {
+            pageView: (event: Payload<ProductPageviewSchemaData>) => void;
+        };
+        cart: {
+            add: (event: Payload<CartSchemaData>) => void;
+            remove: (event: Payload<CartSchemaData>) => void;
+        };
+        order: {
+            transaction: (event: Payload<OrderTransactionSchemaData>) => void;
+        };
+        error: {
+            shopifypixel: (event: Payload<LogSchemaData>) => void;
+            snap: (event: Payload<LogSchemaData>) => void;
+        };
+    };
+    queueRequest(request: PayloadRequest): void;
+    updateContext(key: keyof Context, value: any): void;
+    getContext(): Context;
+    private getStoredId;
+    getPageLoadId(): string;
+    getUserId(): string;
+    getSessionId(): string;
+    getShopperId(): string;
+    setShopperId(shopperId: string): void;
+    private getAttribution;
+    generateId(): string;
+    getTimestamp(): string;
+    setCurrency(currency: Currency): void;
+    pageLoad(): string;
+    private createRequest;
+    private getApiClient;
+    private sendRequests;
+    private processRequests;
+    private _sendPreflight;
+    sendPreflight(overrides?: {
+        userId: string;
+        siteId: string;
+        shopper: string;
+        cart: Product[];
+        lastViewed: ProductPageviewSchemaDataResult[];
+    }): void;
+    protected getProductId(product: Product | ProductPageviewSchemaDataResult): string;
+}
+export declare function appendResults(acc: {
+    nonBatched: PayloadRequest[];
+    batches: Record<string, PayloadRequest>;
+}, key: string, schemaName: string, request: PayloadRequest): void;
+export declare function additionalRequestKeys(key: string, type: 'search' | 'autocomplete' | 'category' | 'recommendation', schema: ImpressionSchema | RecommendationsImpressionSchema | RecommendationsAddtocartSchema | AddtocartSchema): string;
+export {};
+//# sourceMappingURL=Beacon.d.ts.map

package/dist/esm/src/Beacon.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Beacon.d.ts","sourceRoot":"","sources":["../../../src/Beacon.ts"],"names":[],"mappings":"AACA,eAAO,MAAQ,OAAO,QAAgB,CAAC;AAIvC,OAAO,EACN,OAAO,EACP,eAAe,EAGf,OAAO,EACP,cAAc,EACd,WAAW,EAGX,YAAY,EACZ,QAAQ,EACR,0BAA0B,EAC1B,OAAO,EACP,UAAU,EACV,kBAAkB,EAGlB,SAAS,EAGT,UAAU,EAGV,QAAQ,EACR,+BAA+B,EAC/B,kBAAkB,EAClB,sBAAsB,EACtB,mBAAmB,EACnB,oBAAoB,EACpB,+BAA+B,EAC/B,mCAAmC,EACnC,kCAAkC,EAClC,qCAAqC,EACrC,gBAAgB,EAChB,yBAAyB,EACzB,+BAA+B,EAC/B,gBAAgB,EAEhB,QAAQ,EAER,aAAa,EAEb,WAAW,EACX,8BAA8B,EAC9B,eAAe,EACf,MAAM,UAAU,CAAC;AAqBlB,OAAO,CAAC,MAAM,CAAC;IACd,UAAU,MAAM;QACf,MAAM,CAAC,EAAE,OAAO,MAAM,CAAC;QACvB,YAAY,CAAC,EAAE,GAAG,CAAC;QACnB,KAAK,CAAC,EAAE,GAAG,CAAC;KACZ;CACD;AAGD,MAAM,MAAM,qBAAqB,GAAG;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IAC1B,IAAI,CAAC,EAAE,YAAY,GAAG,aAAa,CAAC;IACpC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE;QACZ,eAAe,CAAC,EAAE;YACjB,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,OAAO,CAAC,EAAE,WAAW,CAAC;SACtB,CAAC;QACF,MAAM,CAAC,EAAE;YACR,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,OAAO,CAAC,EAAE,WAAW,CAAC;SACtB,CAAC;KACF,CAAC;IACF,IAAI,CAAC,EAAE;QACN,KAAK,CAAC,EAAE,QAAQ,CAAC;KACjB,CAAC;IACF,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;CACnB,CAAC;AACF,MAAM,MAAM,aAAa,GAAG;IAC3B,MAAM,EAAE,MAAM,CAAC;CACf,CAAC;AAEF,UAAU,YAAY;IACrB,OAAO,EAAE,UAAU,CAAC;IACpB,YAAY,EAAE,eAAe,CAAC;IAC9B,MAAM,EAAE,SAAS,CAAC;IAClB,QAAQ,EAAE,WAAW,CAAC;IACtB,eAAe,EAAE,kBAAkB,CAAC;IACpC,OAAO,EAAE,UAAU,CAAC;IACpB,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,EAAE,QAAQ,CAAC;IAChB,KAAK,EAAE,YAAY,CAAC;CACpB;AACD,MAAM,WAAW,cAAc;IAC9B,OAAO,EAAE,MAAM,YAAY,CAAC;IAC5B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,GAAG,CAAC;CACb;AAED,MAAM,MAAM,OAAO,CAAC,CAAC,IAAI;IACxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,CAAC,CAAC;CACR,CAAC;AAEF,eAAO,MAAM,wBAAwB,MAAM,CAAC;AAC5C,eAAO,MAAM,0BAA0B,MAAM,CAAC;AAE9C,eAAO,MAAM,gBAAgB,iBAAiB,CAAC;AAG/C,eAAO,MAAM,QAAQ,mBAAmB,CAAC;AAEzC,eAAO,MAAM,eAAe,QAAQ,CAAC;AAKrC,eAAO,MAAM,uBAAuB,QAAQ,CAAC;AAG7C,eAAO,MAAM,aAAa,oBACuG,CAAC;AAElI,qBAAa,MAAM;IAClB,SAAS,CAAC,MAAM,EAAE,YAAY,CAAC;IAC/B,SAAS,CAAC,OAAO,EAAE,aAAa,CAAC;IACjC,SAAS,CAAC,IAAI,EAAE,YAAY,GAAG,aAAa,CAAgB;IAC5D,OAAO,CAAC,UAAU,CAAc;IAChC,OAAO,CAAC,MAAM,CAAc;IAC5B,OAAO,CAAC,SAAS,CAAc;IAC/B,OAAO,CAAC,SAAS,CAAc;IAC/B,OAAO,CAAC,WAAW,CAAiC;IACpD,OAAO,CAAC,QAAQ,CAEd;IACF,OAAO,CAAC,SAAS,CAAc;IAC/B,OAAO,CAAC,oBAAoB,CAA8B;IAC1D,OAAO,CAAC,gBAAgB,CAA8B;IACtD,OAAO,CAAC,IAAI,CAAe;IAE3B,OAAO,CAAC,QAAQ,CAAwB;gBAE5B,OAAO,EAAE,aAAa,EAAE,MAAM,CAAC,EAAE,YAAY;IAwCzD,OAAO,CAAC,SAAS;IAqBjB,OAAO,CAAC,SAAS;IAqCjB,OAAO,CAAC,mBAAmB;IAiB3B,OAAO,CAAC,mBAAmB;IAW3B,OAAO;;uBAEI,OAAO,EAAE;4BAyBF,OAAO,EAAE,KAAG,IAAI;4BAoBhB,OAAO,EAAE,KAAG,IAAI;+BA2Bb,OAAO,EAAE,KAAG,IAAI;yBA4BxB,IAAI;;;uBAKN,+BAA+B,EAAE;4BAuB1B,+BAA+B,EAAE,KAAG,IAAI;4BAwBxC,+BAA+B,EAAE,KAAG,IAAI;;MAuBxD;IAEF,MAAM;;2BAEW,OAAO,CAAC;gBAAE,EAAE,EAAE,MAAM,CAAA;aAAE,CAAC;;;4BAgBtB,OAAO,CAAC,gBAAgB,CAAC;gCAYrB,OAAO,CAAC,oBAAoB,CAAC;+BAY9B,OAAO,CAAC,mBAAmB,CAAC;kCAgBzB,OAAO,CAAC,sBAAsB,CAAC;8BAYnC,OAAO,CAAC,kBAAkB,CAAC;;;4BAc7B,OAAO,CAAC,gBAAgB,CAAC;gCAYrB,OAAO,CAAC,oBAAoB,CAAC;+BAY9B,OAAO,CAAC,mBAAmB,CAAC;kCAgBzB,OAAO,CAAC,sBAAsB,CAAC;8BAYnC,OAAO,CAAC,kBAAkB,CAAC;;;4BAc7B,OAAO,CAAC,gBAAgB,CAAC;gCAYrB,OAAO,CAAC,oBAAoB,CAAC;+BAY9B,OAAO,CAAC,mBAAmB,CAAC;kCAgBzB,OAAO,CAAC,sBAAsB,CAAC;;;4BAcrC,OAAO,CAAC,+BAA+B,CAAC;gCAYpC,OAAO,CAAC,mCAAmC,CAAC;+BAY7C,OAAO,CAAC,kCAAkC,CAAC;kCAgBxC,OAAO,CAAC,qCAAqC,CAAC;;;8BAclD,OAAO,CAAC,yBAAyB,CAAC;;;yBAiBvC,OAAO,CAAC,cAAc,CAAC;4BAwBpB,OAAO,CAAC,cAAc,CAAC;;;iCA0BlB,OAAO,CAAC,0BAA0B,CAAC;;;kCAelC,OAAO,CAAC,aAAa,CAAC;0BAY9B,OAAO,CAAC,aAAa,CAAC;;MAapC;IAEF,YAAY,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI;IAS3C,aAAa,CAAC,GAAG,EAAE,MAAM,OAAO,EAAE,KAAK,EAAE,GAAG,GAAG,IAAI;IA0BnD,UAAU,IAAI,OAAO;IAmBrB,OAAO,CAAC,WAAW;IAkDZ,aAAa,IAAI,MAAM;IA2BvB,SAAS,IAAI,MAAM;IAInB,YAAY,IAAI,MAAM;IAItB,YAAY,IAAI,MAAM;IAkBtB,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAkB5C,OAAO,CAAC,cAAc;IAiDtB,UAAU,IAAI,MAAM;IAIpB,YAAY,IAAI,MAAM;IAItB,WAAW,CAAC,QAAQ,EAAE,QAAQ,GAAG,IAAI;IAMrC,QAAQ,IAAI,MAAM;IAOlB,OAAO,CAAC,aAAa;IASrB,OAAO,CAAC,YAAY;IAIpB,OAAO,CAAC,YAAY;IAyBpB,OAAO,CAAC,eAAe;IA0EvB,OAAO,CAAC,cAAc;IAOf,aAAa,CAAC,SAAS,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,EAAE,CAAC;QAAC,UAAU,EAAE,+BAA+B,EAAE,CAAA;KAAE,GAAG,IAAI;IAyC3J,SAAS,CAAC,YAAY,CAAC,OAAO,EAAE,OAAO,GAAG,+BAA+B,GAAG,MAAM;CAGlF;AAED,wBAAgB,aAAa,CAC5B,GAAG,EAAE;IACJ,UAAU,EAAE,cAAc,EAAE,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;CACxC,EACD,GAAG,EAAE,MAAM,EACX,UAAU,EAAE,MAAM,EAClB,OAAO,EAAE,cAAc,QA0BvB;AAED,wBAAgB,qBAAqB,CACpC,GAAG,EAAE,MAAM,EACX,IAAI,EAAE,QAAQ,GAAG,cAAc,GAAG,UAAU,GAAG,gBAAgB,EAC/D,MAAM,EAAE,gBAAgB,GAAG,+BAA+B,GAAG,8BAA8B,GAAG,eAAe,GAC3G,MAAM,CAcR"}