@pack/packlytics 0.1.0-ab-beta.0 → 1.0.0

package/dist/packlytics.d.ts

@@ -1,5 +1,4 @@
-import { Pack } from "./packlytics.types";
-export declare function usePacklytics(request: Request, pack: Pack, params: {
+export declare function packlytics(request: Request, session: any, params: {
     storeFrontId: string;
     sessionSecret: string;
 }): Promise<Response | undefined>;

package/dist/packlytics.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packlytics.d.ts","sourceRoot":"","sources":["../src/packlytics.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,IAAI,EAAQ,MAAM,oBAAoB,CAAC;AAEhD,wBAAsB,aAAa,CACjC,OAAO,EAAE,OAAO,EAChB,IAAI,EAAE,IAAI,EACV,MAAM,EAAE;IACN,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACvB,iCAoCF"}
+{"version":3,"file":"packlytics.d.ts","sourceRoot":"","sources":["../src/packlytics.ts"],"names":[],"mappings":"AAOA,wBAAsB,UAAU,CAC9B,OAAO,EAAE,OAAO,EAChB,OAAO,EAAE,GAAG,EACZ,MAAM,EAAE;IACN,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;CACvB,iCAiDF"}

package/dist/packlytics.js

@@ -1,16 +1,26 @@
-import { getClientIPAddress } from "./utils/get-client-ip-address";
 import { getPacklyticsId } from "./utils/get-packlytics-id";
 import { getClientLocales } from "./utils/get-client-locales";
 import { trackPageHit } from "./utils/page-hit";
 import { getDevice } from "./utils/get-client-device";
-export async function usePacklytics(request, pack, params) {
+import { getStorefrontHeaders } from "@shopify/remix-oxygen";
+import { getClientLocation } from "./utils/get-client-location";
+export async function packlytics(request, session, params) {
+    if (process.env.NODE_ENV === "development") {
+        return;
+    }
+    // Preview enabled
+    if (!!session.get("previewEnabled")) {
+        return;
+    }
     const url = new URL(request.url);
-    const ipaddress = getClientIPAddress(request) || "";
+    const ipaddress = getStorefrontHeaders(request)["buyerIp"] || "";
     const dataToHash = `${request.headers.get("user-agent")}${ipaddress}${url.hostname}`;
     const packlyticsId = getPacklyticsId(dataToHash, params.sessionSecret);
-    const testSession = pack.session.get("test");
+    const testSession = session.get("test");
+    const locale = getClientLocales(request) || ["en-US"];
+    const location = getClientLocation(locale[0]);
     return trackPageHit(params.storeFrontId, packlyticsId)({
-        "pack-session-id": pack.session.id, // This session ID is saved on the __pack cookie
+        "pack-session-id": session.id, // This session ID is saved on the __pack cookie
         "user-agent": request.headers.get("user-agent") || "",
         pathname: url.pathname,
         query: url.search,
@@ -18,15 +28,16 @@ export async function usePacklytics(request, pack, params) {
         referrer: request.referrer,
         ipaddress: ipaddress,
         language: getClientLocales(request) || "",
-        locale: request.headers.get("accept-language") || "",
+        locale: locale[0],
+        location: location,
         connection: request.headers.get("connection") || "",
         href: request.url,
         ...getDevice(request.headers.get("user-agent") || ""),
         test: {
             "test-id": testSession?.data?.id || "",
             "test-handle": testSession?.data?.handle || "",
-            "test-variant-id": testSession?.data?.TestVariant?.id || "",
-            "test-variant-handle": testSession?.data?.TestVariant?.handle || "",
+            "test-variant-id": testSession?.data?.testVariant?.id || "",
+            "test-variant-handle": testSession?.data?.testVariant?.handle || "",
         },
     });
 }

package/dist/packlytics.types.d.ts

@@ -10,34 +10,9 @@ interface JSONArray extends Array<JSONValue> {
 interface JSONObject {
     [x: string]: JSONValue;
 }
-export interface Pack {
-    session: any;
-}
-export interface Test {
-    id: string;
-    handle: string;
-    TestVariant: {
-        id: string;
-        handle: string;
-    };
-}
 export type PackData = {
     version: string;
 };
-export type BrowserData = {
-    "user-agent": string;
-    pathname: string;
-    query: string;
-    screen: string;
-    referrer: string;
-    hostname: string;
-    language: string;
-    locale: string;
-    location: string;
-    connection: string;
-    deviceCategory: string;
-    href: string;
-};
 export type EventDataPayload = JSONObject;
 export type EventData = PackData & {
     timestamp: string;

package/dist/packlytics.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packlytics.types.d.ts","sourceRoot":"","sources":["../src/packlytics.types.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,WAAW,EAAE,GAAG,CAAC;QACjB,OAAO,EAAE,GAAG,CAAC;KACd;CACF;AAED,KAAK,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,SAAS,CAAC;AAEpE,UAAU,SAAU,SAAQ,KAAK,CAAC,SAAS,CAAC;CAAG;AAE/C,UAAU,UAAU;IAClB,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACxB;AAED,MAAM,WAAW,IAAI;IACnB,OAAO,EAAE,GAAG,CAAC;CACd;AAED,MAAM,WAAW,IAAI;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE;QACX,EAAE,EAAE,MAAM,CAAC;QACX,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;CACH;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC;AAE1C,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,gBAAgB,CAAC"}
+{"version":3,"file":"packlytics.types.d.ts","sourceRoot":"","sources":["../src/packlytics.types.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,WAAW,EAAE,GAAG,CAAC;QACjB,OAAO,EAAE,GAAG,CAAC;KACd;CACF;AAED,KAAK,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,UAAU,GAAG,SAAS,CAAC;AAEpE,UAAU,SAAU,SAAQ,KAAK,CAAC,SAAS,CAAC;CAAG;AAE/C,UAAU,UAAU;IAClB,CAAC,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;CACxB;AAED,MAAM,MAAM,QAAQ,GAAG;IACrB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG,UAAU,CAAC;AAE1C,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG,gBAAgB,CAAC"}

package/dist/utils/get-client-location.d.ts

@@ -0,0 +1,2 @@
+export declare function getClientLocation(locale: string): string;
+//# sourceMappingURL=get-client-location.d.ts.map

package/dist/utils/get-client-location.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-client-location.d.ts","sourceRoot":"","sources":["../../src/utils/get-client-location.ts"],"names":[],"mappings":"AAAA,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,MAAM,UAI/C"}

package/dist/utils/get-client-location.js

@@ -0,0 +1,4 @@
+export function getClientLocation(locale) {
+    const localeSplit = locale.split("-");
+    return localeSplit.length > 1 ? localeSplit[1].toLowerCase() : "";
+}

package/dist/utils/get-packlytics-id.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"get-packlytics-id.d.ts","sourceRoot":"","sources":["../../src/utils/get-packlytics-id.ts"],"names":[],"mappings":"AA4BA;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,UAO3D"}
+{"version":3,"file":"get-packlytics-id.d.ts","sourceRoot":"","sources":["../../src/utils/get-packlytics-id.ts"],"names":[],"mappings":"AAuHA;;;;;;;;;GASG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,UAO3D"}

package/dist/utils/get-packlytics-id.js

@@ -1,23 +1,105 @@
-import crypto from "crypto";
-function generateUUIDFromHash(hash) {
-    const crypto = require("crypto");
-    const bytes = crypto.createHash("sha1").update(hash).digest();
-    bytes[6] = (bytes[6] & 0x0f) | 0x50; // Set version to 5 (version 5 UUID)
-    bytes[8] = (bytes[8] & 0x3f) | 0x80; // Set variant to RFC 4122
-    const uuid = bytes.toString("hex", 0, 16);
+function sha256(ascii) {
+    function rightRotate(value, amount) {
+        return (value >>> amount) | (value << (32 - amount));
+    }
+    const mathPow = Math.pow;
+    const maxWord = mathPow(2, 32);
+    const lengthProperty = "length";
+    let i, j; // Used as a counter across the whole file
+    let result = "";
+    const words = [];
+    const asciiBitLength = ascii[lengthProperty] * 8;
+    //* caching results is optional - remove/add slash from front of this line to toggle
+    // Initial hash value: first 32 bits of the fractional parts of the square roots of the first 8 primes
+    // (we actually calculate the first 64, but extra values are just ignored)
+    // @ts-ignore
+    let hash = (sha256.h = sha256.h || []);
+    // Round constants: first 32 bits of the fractional parts of the cube roots of the first 64 primes
+    // @ts-ignore
+    const k = (sha256.k = sha256.k || []);
+    let primeCounter = k[lengthProperty];
+    /*/
+    var hash = [], k = [];
+    var primeCounter = 0;
+    //*/
+    const isComposite = {};
+    for (let candidate = 2; primeCounter < 64; candidate++) {
+        // @ts-ignore
+        if (!isComposite[candidate]) {
+            for (i = 0; i < 313; i += candidate) {
+                // @ts-ignore
+                isComposite[i] = candidate;
+            }
+            hash[primeCounter] = (mathPow(candidate, 0.5) * maxWord) | 0;
+            k[primeCounter++] = (mathPow(candidate, 1 / 3) * maxWord) | 0;
+        }
+    }
+    ascii += "\x80"; // Append Ƈ' bit (plus zero padding)
+    while ((ascii[lengthProperty] % 64) - 56)
+        ascii += "\x00"; // More zero padding
+    for (i = 0; i < ascii[lengthProperty]; i++) {
+        j = ascii.charCodeAt(i);
+        if (j >> 8)
+            return; // ASCII check: only accept characters in range 0-255
+        words[i >> 2] |= j << (((3 - i) % 4) * 8);
+    }
+    words[words[lengthProperty]] = (asciiBitLength / maxWord) | 0;
+    words[words[lengthProperty]] = asciiBitLength;
+    // process each chunk
+    for (j = 0; j < words[lengthProperty];) {
+        const w = words.slice(j, (j += 16)); // The message is expanded into 64 words as part of the iteration
+        const oldHash = hash;
+        // This is now the undefinedworking hash", often labelled as variables a...g
+        // (we have to truncate as well, otherwise extra entries at the end accumulate
+        hash = hash.slice(0, 8);
+        for (i = 0; i < 64; i++) {
+            const i2 = i + j;
+            // Expand the message into 64 words
+            // Used below if
+            const w15 = w[i - 15], w2 = w[i - 2];
+            // Iterate
+            const a = hash[0], e = hash[4];
+            const temp1 = hash[7] +
+                (rightRotate(e, 6) ^ rightRotate(e, 11) ^ rightRotate(e, 25)) + // S1
+                ((e & hash[5]) ^ (~e & hash[6])) + // ch
+                k[i] +
+                // Expand the message schedule if needed
+                (w[i] =
+                    i < 16
+                        ? w[i]
+                        : (w[i - 16] +
+                            (rightRotate(w15, 7) ^ rightRotate(w15, 18) ^ (w15 >>> 3)) + // s0
+                            w[i - 7] +
+                            (rightRotate(w2, 17) ^ rightRotate(w2, 19) ^ (w2 >>> 10))) | // s1
+                            0);
+            // This is only used once, so *could* be moved below, but it only saves 4 bytes and makes things unreadble
+            const temp2 = (rightRotate(a, 2) ^ rightRotate(a, 13) ^ rightRotate(a, 22)) + // S0
+                ((a & hash[1]) ^ (a & hash[2]) ^ (hash[1] & hash[2])); // maj
+            hash = [(temp1 + temp2) | 0].concat(hash); // We don't bother trimming off the extra ones, they're harmless as long as we're truncating when we do the slice()
+            hash[4] = (hash[4] + temp1) | 0;
+        }
+        for (i = 0; i < 8; i++) {
+            hash[i] = (hash[i] + oldHash[i]) | 0;
+        }
+    }
+    for (i = 0; i < 8; i++) {
+        for (j = 3; j + 1; j--) {
+            const b = (hash[i] >> (j * 8)) & 255;
+            result += (b < 16 ? 0 : "") + b.toString(16);
+        }
+    }
+    return result;
+}
+function createHash(data) {
+    const hash = sha256(data);
     return [
-        uuid.substring(0, 8),
-        uuid.substring(8, 12),
-        uuid.substring(12, 16),
-        uuid.substring(16, 20),
-        uuid.substring(20),
+        hash?.substring(0, 8),
+        hash?.substring(8, 12),
+        hash?.substring(12, 16),
+        hash?.substring(16, 20),
+        hash?.substring(20, 32),
     ].join("-");
 }
-function createHash(data, algorithm = "sha256") {
-    const hash = crypto.createHash(algorithm);
-    hash.update(data);
-    return generateUUIDFromHash(hash.digest("hex"));
-}
 /**
  * Generates a UUID from the user data, such as user-agent and IP Address + Salt
  * The salt is generated on the currante date + a Secret from the StoreFront,
@@ -31,6 +113,6 @@ function createHash(data, algorithm = "sha256") {
 export function getPacklyticsId(data, secret) {
     const currentDate = new Date();
     const formattedDate = currentDate.toLocaleDateString("en-US");
-    const salt = createHash(formattedDate + secret);
+    const salt = sha256(formattedDate + secret);
     return createHash(data + salt);
 }

package/dist/utils/send-event.js

@@ -15,12 +15,12 @@ const getPacklyticsMetadata = async () => {
             metadata = await response.json();
         }
         else {
-            console.error("Error to get packlytics metadata:", response.statusText);
+            console.error("Error getting Packlytics metadata:", response.statusText);
         }
     }
     catch (error) {
         // @ts-ignore
-        console.error("Error to get packlytics metadata:", error.message);
+        console.error("Error getting Packlytics metadata:", error.message);
     }
 };
 export const sendEvent = (storefrontId, sessionId) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pack/packlytics",
   "description": "Packlytics",
-  "version": "0.1.0-ab-beta.0",
+  "version": "1.0.0",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "engines": {