order3000 1.4.0 → 1.6.0

package/dist/tracking.cjs

@@ -0,0 +1,37 @@
+'use strict';
+
+const AD_CLICK_ID_KEYS = [
+  "gclid",
+  "gbraid",
+  "wbraid",
+  "fbclid"
+];
+const AD_CLICK_COOKIE_MAX_AGE = 90 * 24 * 60 * 60;
+function writeCookie(name, value) {
+  document.cookie = `${name}=${encodeURIComponent(value)}; path=/; max-age=${AD_CLICK_COOKIE_MAX_AGE}; SameSite=Lax`;
+}
+function readCookie(name) {
+  const match = document.cookie.split("; ").find((row) => row.startsWith(`${name}=`));
+  return match ? decodeURIComponent(match.slice(name.length + 1)) : void 0;
+}
+function persistAdClickIdsFromUrl() {
+  if (typeof window === "undefined") return;
+  const params = new URLSearchParams(window.location.search);
+  for (const key of AD_CLICK_ID_KEYS) {
+    const value = params.get(key);
+    if (value) writeCookie(key, value);
+  }
+}
+function getAdClickIds() {
+  if (typeof window === "undefined") return {};
+  const ids = {};
+  for (const key of AD_CLICK_ID_KEYS) {
+    const value = readCookie(key);
+    if (value) ids[key] = value;
+  }
+  return ids;
+}
+
+exports.AD_CLICK_ID_KEYS = AD_CLICK_ID_KEYS;
+exports.getAdClickIds = getAdClickIds;
+exports.persistAdClickIdsFromUrl = persistAdClickIdsFromUrl;

package/dist/tracking.d.cts

@@ -0,0 +1,34 @@
+/**
+ * order3000 ad-click attribution — first-party capture of the click identifiers
+ * that appear on an ad's landing URL (Google Ads auto-tagging `gclid`/`gbraid`/
+ * `wbraid`; Meta `fbclid`). A reservation made later in the session is then
+ * attributed to the originating ad click and reported to the ad platform
+ * server-side — Google Ads offline conversions and the Meta Conversions API.
+ *
+ * **Provided by order3000 so every consumer captures attribution identically,
+ * without re-implementing this logic.** Wire it in two lines on the restaurant
+ * frontend:
+ *
+ *   - call `persistAdClickIdsFromUrl()` once on landing (every page), and
+ *   - spread `getAdClickIds()` into the `reservations.make(...)` payload on
+ *     submit.
+ *
+ * No Google/Meta script is ever loaded — these are plain query params we read
+ * ourselves and store in first-party cookies (browser-only; every function is a
+ * no-op when `window` is undefined, so it is safe to import in SSR code).
+ */
+/** The ad-click identifiers order3000 captures from a landing URL. */
+declare const AD_CLICK_ID_KEYS: readonly ["gclid", "gbraid", "wbraid", "fbclid"];
+type AdClickIdKey = (typeof AD_CLICK_ID_KEYS)[number];
+type AdClickIds = Partial<Record<AdClickIdKey, string>>;
+/**
+ * Read any ad-click ids from the current URL and persist them to first-party
+ * cookies. Call once on landing (every page). Only a present id is written, so a
+ * later non-ad navigation never clears an earlier attribution.
+ */
+declare function persistAdClickIdsFromUrl(): void;
+/** The persisted ad-click ids, for attaching to a reservation on submit. */
+declare function getAdClickIds(): AdClickIds;
+
+export { AD_CLICK_ID_KEYS, getAdClickIds, persistAdClickIdsFromUrl };
+export type { AdClickIdKey, AdClickIds };

package/dist/tracking.d.mts

@@ -0,0 +1,34 @@
+/**
+ * order3000 ad-click attribution — first-party capture of the click identifiers
+ * that appear on an ad's landing URL (Google Ads auto-tagging `gclid`/`gbraid`/
+ * `wbraid`; Meta `fbclid`). A reservation made later in the session is then
+ * attributed to the originating ad click and reported to the ad platform
+ * server-side — Google Ads offline conversions and the Meta Conversions API.
+ *
+ * **Provided by order3000 so every consumer captures attribution identically,
+ * without re-implementing this logic.** Wire it in two lines on the restaurant
+ * frontend:
+ *
+ *   - call `persistAdClickIdsFromUrl()` once on landing (every page), and
+ *   - spread `getAdClickIds()` into the `reservations.make(...)` payload on
+ *     submit.
+ *
+ * No Google/Meta script is ever loaded — these are plain query params we read
+ * ourselves and store in first-party cookies (browser-only; every function is a
+ * no-op when `window` is undefined, so it is safe to import in SSR code).
+ */
+/** The ad-click identifiers order3000 captures from a landing URL. */
+declare const AD_CLICK_ID_KEYS: readonly ["gclid", "gbraid", "wbraid", "fbclid"];
+type AdClickIdKey = (typeof AD_CLICK_ID_KEYS)[number];
+type AdClickIds = Partial<Record<AdClickIdKey, string>>;
+/**
+ * Read any ad-click ids from the current URL and persist them to first-party
+ * cookies. Call once on landing (every page). Only a present id is written, so a
+ * later non-ad navigation never clears an earlier attribution.
+ */
+declare function persistAdClickIdsFromUrl(): void;
+/** The persisted ad-click ids, for attaching to a reservation on submit. */
+declare function getAdClickIds(): AdClickIds;
+
+export { AD_CLICK_ID_KEYS, getAdClickIds, persistAdClickIdsFromUrl };
+export type { AdClickIdKey, AdClickIds };

package/dist/tracking.mjs

@@ -0,0 +1,33 @@
+const AD_CLICK_ID_KEYS = [
+  "gclid",
+  "gbraid",
+  "wbraid",
+  "fbclid"
+];
+const AD_CLICK_COOKIE_MAX_AGE = 90 * 24 * 60 * 60;
+function writeCookie(name, value) {
+  document.cookie = `${name}=${encodeURIComponent(value)}; path=/; max-age=${AD_CLICK_COOKIE_MAX_AGE}; SameSite=Lax`;
+}
+function readCookie(name) {
+  const match = document.cookie.split("; ").find((row) => row.startsWith(`${name}=`));
+  return match ? decodeURIComponent(match.slice(name.length + 1)) : void 0;
+}
+function persistAdClickIdsFromUrl() {
+  if (typeof window === "undefined") return;
+  const params = new URLSearchParams(window.location.search);
+  for (const key of AD_CLICK_ID_KEYS) {
+    const value = params.get(key);
+    if (value) writeCookie(key, value);
+  }
+}
+function getAdClickIds() {
+  if (typeof window === "undefined") return {};
+  const ids = {};
+  for (const key of AD_CLICK_ID_KEYS) {
+    const value = readCookie(key);
+    if (value) ids[key] = value;
+  }
+  return ids;
+}
+
+export { AD_CLICK_ID_KEYS, getAdClickIds, persistAdClickIdsFromUrl };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "order3000",
-  "version": "1.4.0",
+  "version": "1.6.0",
   "description": "order3000 node.js sdk",
   "main": "./dist/client.cjs",
   "module": "./dist/client.mjs",
@@ -25,6 +25,16 @@
         "types": "./dist/schemas.d.mts",
         "default": "./dist/schemas.mjs"
       }
+    },
+    "./tracking": {
+      "require": {
+        "types": "./dist/tracking.d.cts",
+        "default": "./dist/tracking.cjs"
+      },
+      "import": {
+        "types": "./dist/tracking.d.mts",
+        "default": "./dist/tracking.mjs"
+      }
     }
   },
   "dependencies": {