@solomon-tech/webanalytics-sdk 1.0.0

package/README.md

@@ -0,0 +1,20 @@
+# Deploy
+
+Add to page/liquid:
+
+```html
+...
+<script>
+    //
+    window.__SOLOMON__ = {
+        companyId: "SOLOMON"
+    };
+</script>
+<script defer src="https://storage.googleapis.com/solomon-app-scripts/webanalytics-events.js"></script>
+...
+```
+
+HTML5 has 3 options to load scripts: sync, defer and async. Sync adds delay to rendering, so it should be avoided. Defer is preferred since it does not block rendering.
+
+Async could be used but it does not prevent DOMContentLoaded event. Currently, we send PageView on this event. This should be reviewed later on.
+

package/dist/sdk/cookies/fbp.d.ts

@@ -0,0 +1,3 @@
+declare const getFbp: () => Promise<string | null>;
+declare const getFbc: () => Promise<string | null>;
+export { getFbp, getFbc };

package/dist/sdk/cookies/fbp.js

@@ -0,0 +1,21 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { getCookie } from "../utils";
+const FBP_COOKIE_NAME = "_fbp";
+const FBC_COOKIE_NAME = "_fbc";
+const getFbp = () => __awaiter(void 0, void 0, void 0, function* () {
+    const cookie = (yield getCookie(FBP_COOKIE_NAME));
+    return cookie;
+});
+const getFbc = () => __awaiter(void 0, void 0, void 0, function* () {
+    const cookie = (yield getCookie(FBC_COOKIE_NAME));
+    return cookie;
+});
+export { getFbp, getFbc };

package/dist/sdk/cookies/legacy.d.ts

@@ -0,0 +1,2 @@
+declare const getLegacyId: () => Promise<string | null>;
+export { getLegacyId };

package/dist/sdk/cookies/legacy.js

@@ -0,0 +1,16 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { getAllStorage } from "../utils";
+const LEGACY_ID_KEY = "uniqueId";
+const getLegacyId = () => __awaiter(void 0, void 0, void 0, function* () {
+    const legacyId = (yield getAllStorage(LEGACY_ID_KEY));
+    return legacyId || null;
+});
+export { getLegacyId };

package/dist/sdk/cookies/session.d.ts

@@ -0,0 +1,2 @@
+declare const getSessionId: () => Promise<string>;
+export { getSessionId };

package/dist/sdk/cookies/session.js

@@ -0,0 +1,25 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { getCookie, setCookie } from "../utils";
+const SESSION_ID_COOKIE_NAME = "solomon-session-id";
+const SESSION_ID_COOKIE_TIME = 30 * 60 * 1000;
+function generateUUIDv4() {
+    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, c => {
+        const r = (crypto.getRandomValues(new Uint8Array(1))[0] & 15) >> 0;
+        const v = c === 'x' ? r : (r & 0x3) | 0x8;
+        return v.toString(16);
+    });
+}
+const getSessionId = () => __awaiter(void 0, void 0, void 0, function* () {
+    const cookie = (yield getCookie(SESSION_ID_COOKIE_NAME)) || generateUUIDv4();
+    yield setCookie(SESSION_ID_COOKIE_NAME, cookie, SESSION_ID_COOKIE_TIME);
+    return cookie;
+});
+export { getSessionId };

package/dist/sdk/cookies/user.d.ts

@@ -0,0 +1,2 @@
+declare const getUserId: () => Promise<string>;
+export { getUserId };

package/dist/sdk/cookies/user.js

@@ -0,0 +1,25 @@
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { getAllStorage, setAllStorage } from "../utils";
+const USER_ID_KEY = "solomon-user-id";
+const USER_ID_COOKIE_TIME = 365 * 24 * 60 * 60 * 1000;
+function generateUUIDv4() {
+    return 'xxxxxxxx-xxxx-4xxx-yxxx-xxxxxxxxxxxx'.replace(/[xy]/g, c => {
+        const r = (crypto.getRandomValues(new Uint8Array(1))[0] & 15) >> 0;
+        const v = c === 'x' ? r : (r & 0x3) | 0x8;
+        return v.toString(16);
+    });
+}
+const getUserId = () => __awaiter(void 0, void 0, void 0, function* () {
+    const cookie = (yield getAllStorage(USER_ID_KEY)) || generateUUIDv4();
+    yield setAllStorage(USER_ID_KEY, cookie, USER_ID_COOKIE_TIME);
+    return cookie;
+});
+export { getUserId };

package/dist/sdk/cookies/uuid.js

@@ -0,0 +1 @@
+"use strict";

package/dist/sdk/events.d.ts

@@ -0,0 +1,292 @@
+import { Product, CustomAliases } from "./types";
+declare enum Type {
+    VIEW_PAGE = "VIEW_PAGE",
+    CONTENT_VIEW = "CONTENT_VIEW",
+    ADD_TO_CART = "ADD_TO_CART",
+    INITIATE_CHECKOUT = "INITIATE_CHECKOUT",
+    ADD_SHIPPING_INFO = "ADD_SHIPPING_INFO",
+    ADD_CUSTOMER_INFO = "ADD_CUSTOMER_INFO",
+    ADD_PAYMENT_INFO = "ADD_PAYMENT_INFO",
+    CHECKOUT_COMPLETED = "CHECKOUT_COMPLETED"
+}
+declare const SolomonEvent: (companyId: string, type: Type, payload: any, custom_aliases?: Promise<CustomAliases>) => Promise<{
+    company_id: string;
+    event_id: string;
+    event_time: string;
+    session_id: string;
+    user_id: string;
+    fbp: string | null;
+    fbc: string | null;
+    legacy_id: string | null;
+    custom_aliases: CustomAliases | undefined;
+    event_type: string;
+    page_referrer: string;
+    page_path: string;
+    utm_source: string;
+    utm_medium: string;
+    utm_campaign: string;
+    utm_term: string;
+    utm_content: string;
+    sol_source: string;
+    sol_medium: string;
+    sol_campaign: string;
+    sol_content: string;
+    event_payload: any;
+    voxus_url: string;
+}>;
+declare const ViewPageEvent: (payload: {
+    url: string;
+    path?: string;
+}, aliases?: Promise<CustomAliases>, companyId?: string) => Promise<{
+    company_id: string;
+    event_id: string;
+    event_time: string;
+    session_id: string;
+    user_id: string;
+    fbp: string | null;
+    fbc: string | null;
+    legacy_id: string | null;
+    custom_aliases: CustomAliases | undefined;
+    event_type: string;
+    page_referrer: string;
+    page_path: string;
+    utm_source: string;
+    utm_medium: string;
+    utm_campaign: string;
+    utm_term: string;
+    utm_content: string;
+    sol_source: string;
+    sol_medium: string;
+    sol_campaign: string;
+    sol_content: string;
+    event_payload: any;
+    voxus_url: string;
+}>;
+declare const EventTouchpoint: (aliases?: Promise<CustomAliases>, platform?: string, account_id?: string) => Promise<any>;
+declare const ContentViewEvent: (payload: Product & {
+    path?: string;
+}, aliases?: Promise<CustomAliases>, companyId?: string) => Promise<{
+    company_id: string;
+    event_id: string;
+    event_time: string;
+    session_id: string;
+    user_id: string;
+    fbp: string | null;
+    fbc: string | null;
+    legacy_id: string | null;
+    custom_aliases: CustomAliases | undefined;
+    event_type: string;
+    page_referrer: string;
+    page_path: string;
+    utm_source: string;
+    utm_medium: string;
+    utm_campaign: string;
+    utm_term: string;
+    utm_content: string;
+    sol_source: string;
+    sol_medium: string;
+    sol_campaign: string;
+    sol_content: string;
+    event_payload: any;
+    voxus_url: string;
+}>;
+declare const AddToCartEvent: (payload: {
+    item_id: string;
+    item_quantity: number;
+    url?: string;
+    path?: string;
+}, aliases?: Promise<CustomAliases>, companyId?: string) => Promise<{
+    company_id: string;
+    event_id: string;
+    event_time: string;
+    session_id: string;
+    user_id: string;
+    fbp: string | null;
+    fbc: string | null;
+    legacy_id: string | null;
+    custom_aliases: CustomAliases | undefined;
+    event_type: string;
+    page_referrer: string;
+    page_path: string;
+    utm_source: string;
+    utm_medium: string;
+    utm_campaign: string;
+    utm_term: string;
+    utm_content: string;
+    sol_source: string;
+    sol_medium: string;
+    sol_campaign: string;
+    sol_content: string;
+    event_payload: any;
+    voxus_url: string;
+}>;
+export type InitiateCheckoutPayload = {
+    'item_count': number;
+    'items': any;
+    'total_price': number;
+    'currency': string;
+    'total_discount'?: number;
+    'url'?: string;
+    'path'?: string;
+};
+declare const InitiateCheckoutEvent: (payload: InitiateCheckoutPayload, aliases?: Promise<CustomAliases>, companyId?: string) => Promise<{
+    company_id: string;
+    event_id: string;
+    event_time: string;
+    session_id: string;
+    user_id: string;
+    fbp: string | null;
+    fbc: string | null;
+    legacy_id: string | null;
+    custom_aliases: CustomAliases | undefined;
+    event_type: string;
+    page_referrer: string;
+    page_path: string;
+    utm_source: string;
+    utm_medium: string;
+    utm_campaign: string;
+    utm_term: string;
+    utm_content: string;
+    sol_source: string;
+    sol_medium: string;
+    sol_campaign: string;
+    sol_content: string;
+    event_payload: any;
+    voxus_url: string;
+}>;
+export type AddCustomerInfoPayload = {
+    'item_count': number;
+    'items': any;
+    'total_price': number;
+    'currency': string;
+    'total_discount'?: number;
+    'path'?: string;
+    'url'?: string;
+};
+declare const AddCustomerInfoEvent: (payload: AddCustomerInfoPayload, aliases?: Promise<CustomAliases>, companyId?: string) => Promise<{
+    company_id: string;
+    event_id: string;
+    event_time: string;
+    session_id: string;
+    user_id: string;
+    fbp: string | null;
+    fbc: string | null;
+    legacy_id: string | null;
+    custom_aliases: CustomAliases | undefined;
+    event_type: string;
+    page_referrer: string;
+    page_path: string;
+    utm_source: string;
+    utm_medium: string;
+    utm_campaign: string;
+    utm_term: string;
+    utm_content: string;
+    sol_source: string;
+    sol_medium: string;
+    sol_campaign: string;
+    sol_content: string;
+    event_payload: any;
+    voxus_url: string;
+}>;
+export type AddShippingInfoPayload = {
+    'item_count': number;
+    'items': any;
+    'total_price': number;
+    'currency': string;
+    'total_discount'?: number;
+    'path'?: string;
+    'url'?: string;
+};
+declare const AddShippingInfoEvent: (payload: AddShippingInfoPayload, aliases?: Promise<CustomAliases>, companyId?: string) => Promise<{
+    company_id: string;
+    event_id: string;
+    event_time: string;
+    session_id: string;
+    user_id: string;
+    fbp: string | null;
+    fbc: string | null;
+    legacy_id: string | null;
+    custom_aliases: CustomAliases | undefined;
+    event_type: string;
+    page_referrer: string;
+    page_path: string;
+    utm_source: string;
+    utm_medium: string;
+    utm_campaign: string;
+    utm_term: string;
+    utm_content: string;
+    sol_source: string;
+    sol_medium: string;
+    sol_campaign: string;
+    sol_content: string;
+    event_payload: any;
+    voxus_url: string;
+}>;
+export type AddPaymentInfoPayload = {
+    'item_count': number;
+    'items': any;
+    'total_price': number;
+    'currency'?: string;
+    'path'?: string;
+    'url'?: string;
+};
+declare const AddPaymentInfoEvent: (payload: AddPaymentInfoPayload, aliases?: Promise<CustomAliases>, companyId?: string) => Promise<{
+    company_id: string;
+    event_id: string;
+    event_time: string;
+    session_id: string;
+    user_id: string;
+    fbp: string | null;
+    fbc: string | null;
+    legacy_id: string | null;
+    custom_aliases: CustomAliases | undefined;
+    event_type: string;
+    page_referrer: string;
+    page_path: string;
+    utm_source: string;
+    utm_medium: string;
+    utm_campaign: string;
+    utm_term: string;
+    utm_content: string;
+    sol_source: string;
+    sol_medium: string;
+    sol_campaign: string;
+    sol_content: string;
+    event_payload: any;
+    voxus_url: string;
+}>;
+export type CheckoutCompletedPayload = {
+    'item_count': number;
+    'items': any;
+    'total_price': number;
+    'currency': string;
+    'total_discount'?: number;
+    'url'?: string;
+    'path'?: string;
+};
+declare const CheckoutCompletedEvent: (payload: CheckoutCompletedPayload, aliases?: Promise<CustomAliases>, companyId?: string) => Promise<{
+    company_id: string;
+    event_id: string;
+    event_time: string;
+    session_id: string;
+    user_id: string;
+    fbp: string | null;
+    fbc: string | null;
+    legacy_id: string | null;
+    custom_aliases: CustomAliases | undefined;
+    event_type: string;
+    page_referrer: string;
+    page_path: string;
+    utm_source: string;
+    utm_medium: string;
+    utm_campaign: string;
+    utm_term: string;
+    utm_content: string;
+    sol_source: string;
+    sol_medium: string;
+    sol_campaign: string;
+    sol_content: string;
+    event_payload: any;
+    voxus_url: string;
+}>;
+export { SolomonEvent, Type, ViewPageEvent as createViewPage, ContentViewEvent, AddToCartEvent, InitiateCheckoutEvent, AddPaymentInfoEvent, AddCustomerInfoEvent, AddShippingInfoEvent, CheckoutCompletedEvent, EventTouchpoint as eventTouchpoint };