Set user

.eslintrc.js

@@ -149,7 +149,6 @@ module.exports = {
         'no-useless-call': 'error',
         'no-useless-concat': 'error',
         'no-void': 'error',
-        'no-warning-comments': 'error',
         'no-with': 'error',
         'radix': 'error',
         'vars-on-top': 'off',
@@ -420,7 +419,7 @@ module.exports = {
         'import/exports-last': 'off',
         'import/group-exports': 'off',
         'import/no-cycle': 'error',
-        'import/no-default-export': 'error',
+        'import/no-default-export': 'off',
         'import/no-self-import': 'error',
         'import/no-useless-path-segments': 'error',
 

.flowconfig

@@ -3,6 +3,7 @@
 .*/node_modules/npm
 .*/node_modules/jsonlint
 .*/dist/module
+.*/test/tracker/set-user.test.js
 [untyped]
 .*/src/lib/jetlore
 [include]

src/declarations.js

@@ -1,5 +1,5 @@
 /* @flow */
 
-import type { MuseGlobalType } from './types';
+import type { MuseGlobalType } from './lib/types';
 
 declare var __muse__ : MuseGlobalType;

src/lib/compose-cart.js

@@ -1,4 +1,11 @@
 /* @flow */
+import { getCookie } from './cookie-utils';
+import constants from './constants';
+
+const {
+    storage,
+    sevenDays
+} = constants;
 // $FlowFixMe
 export const removeFromCart = (items, currentItems = []) => {
     return items.reduce((accumulator, item) => {
@@ -26,3 +33,39 @@ export const removeFromCart = (items, currentItems = []) => {
 export const addToCart = (items, currentItems = []) => {
     return [ ...currentItems, ...items ];
 };
+// $FlowFixMe
+export const composeCart = (type, data) => {
+    // Copy the data so we don't modify it outside the scope of this method.
+    let _data = { ...data };
+
+    // Devnote: Checking for cookie for backwards compatibility (the cookie check can be removed
+    // a couple weeks after deploy because any cart cookie storage will be moved to localStorage
+    // in this function).
+    const storedCart = window.localStorage.getItem(storage.paypalCrCart) || getCookie(storage.paypalCrCart) || '{}';
+    const expiry = window.localStorage.getItem(storage.paypalCrCartExpiry);
+    const cart = JSON.parse(storedCart);
+    const currentItems = cart ? cart.items : [];
+
+    if (!expiry) {
+        window.localStorage.setItem(storage.paypalCrCartExpiry, Date.now() + sevenDays);
+    }
+
+    switch (type) {
+    case 'add':
+        _data.items = addToCart(data.items, currentItems);
+        break;
+    case 'set':
+        _data.items = data.items;
+        break;
+    case 'remove':
+        _data = { ...cart, ...data };
+        _data.items = removeFromCart(data.items, currentItems);
+        break;
+    default:
+        throw new Error('invalid cart action');
+    }
+
+    window.localStorage.setItem(storage.paypalCrCart, JSON.stringify(_data));
+
+    return _data;
+};

src/lib/constants.js

@@ -0,0 +1,16 @@
+/* @flow */
+export default {
+    'sevenDays': 6.048e+8,
+    'accessTokenUrl': 'https://www.paypal.com/muse/api/partner-token',
+    'storage': {
+        'paypalCrCart': 'paypal-cr-cart',
+        'paypalCrCartExpiry': 'paypal-cr-cart-expiry'
+    },
+    'defaultTrackerConfig': {
+        'user': {
+            'id': null,
+            'email': null,
+            'name': null
+        }
+    }
+};

src/lib/cookie-utils.js

@@ -1,4 +1,5 @@
 /* @flow */
+import generate from './generate-id';
 
 export const getCookie = (cookieName : string) : string => {
     const name = `${ cookieName }=`;
@@ -21,3 +22,12 @@ export const setCookie = (cookieName : string, cookieValue : string, expirationM
     const expires = `expires=${ d.toUTCString() }`;
     document.cookie = `${ cookieName }=${ cookieValue }; Path=/; ${ expires }`;
 };
+
+export const getUserIdCookie = () : ?string => {
+    return getCookie('paypal-user-id') || null;
+};
+
+export const setRandomUserIdCookie = () : void => {
+    const ONE_MONTH_IN_MILLISECONDS = 30 * 24 * 60 * 60 * 1000;
+    setCookie('paypal-user-id', generate.generateId(), ONE_MONTH_IN_MILLISECONDS);
+};

src/generate-id.js → src/lib/generate-id.js

@@ -7,7 +7,6 @@ import { uniqueID } from 'belter/src';
 ** - flow and eslint have to be disabled on whatever line this is used.
 */
 
-// eslint-disable-next-line import/no-default-export
 export default {
     generateId: uniqueID
 };

src/lib/get-property-id.js

@@ -0,0 +1,40 @@
+/* @flow */
+import { getClientID, getMerchantID } from '@paypal/sdk-client/src';
+
+import type {
+    Config
+} from './types';
+
+export const getPropertyId = ({ paramsToPropertyIdUrl } : Config) => {
+    // $FlowFixMe
+    return new Promise(resolve => {
+        const clientId = getClientID();
+        const merchantId = getMerchantID()[0];
+        const propertyIdKey = `property-id-${ clientId }-${ merchantId }`;
+        const savedPropertyId = window.localStorage.getItem(propertyIdKey);
+        const currentUrl = `${ window.location.protocol }//${ window.location.host }`;
+        if (savedPropertyId) {
+            return resolve(savedPropertyId);
+        }
+        let url;
+        // $FlowFixMe
+        if (paramsToPropertyIdUrl) {
+            url = paramsToPropertyIdUrl();
+        } else {
+            url = 'https://paypal.com/tagmanager/containers/xo';
+        }
+        return window.fetch(`${ url }?mrid=${ merchantId }&url=${ encodeURIComponent(currentUrl) }`)
+            .then(res => {
+                if (res.status === 200) {
+                    return res;
+                }
+            })
+            .then(r => r.json()).then(container => {
+                window.localStorage.setItem(propertyIdKey, container.id);
+                resolve(container.id);
+            })
+            .catch(() => {
+                // doing nothing for now since there's no logging
+            });
+    });
+};

src/lib/track.js

@@ -0,0 +1,49 @@
+/* @flow */
+import { getClientID, getMerchantID } from '@paypal/sdk-client/src';
+
+import { getUserIdCookie, setRandomUserIdCookie } from './cookie-utils';
+import { getDeviceInfo } from './get-device-info';
+import type {
+    Config,
+    TrackingType
+} from './types';
+
+export const track = <T>(config : Config, trackingType : TrackingType, trackingData : T) => {
+    const encodeData = data => encodeURIComponent(btoa(JSON.stringify(data)));
+
+    const img = document.createElement('img');
+    img.style.display = 'none';
+    if (!getUserIdCookie()) {
+        setRandomUserIdCookie();
+    }
+    const user = {
+        ...config.user,
+        id: getUserIdCookie()
+    };
+
+    const deviceInfo = getDeviceInfo();
+    const data = {
+        ...trackingData,
+        user,
+        propertyId: config.propertyId,
+        trackingType,
+        clientId: getClientID(),
+        merchantId: getMerchantID().join(','),
+        deviceInfo
+    };
+
+    // paramsToBeaconUrl is a function that gives you the ability to override the beacon url
+    // to whatever you want it to be based on the trackingType string and data object.
+    // This can be useful for testing purposes, this feature won't be used by merchants.
+    if (config.paramsToBeaconUrl) {
+        img.src = config.paramsToBeaconUrl({ trackingType, data });
+    } else {
+        img.src = `https://www.paypal.com/targeting/track/${ trackingType }?data=${ encodeData(data) }`;
+    }
+
+    // TODO: this will add a new image EVERY time the 'track' method is called. There's no reason
+    // to clutter the DOM like this. We should replace the old image.
+    if (document.body) {
+        document.body.appendChild(img);
+    }
+};

src/lib/types.js

@@ -0,0 +1,99 @@
+/* @flow */
+
+export const TYPES = true;
+
+export type MuseServerConfigType = {|
+    assetsUrl : string
+|};
+
+export type MuseGlobalType = {|
+    serverConfig : MuseServerConfigType
+|};
+
+export type TrackingType = 'view' | 'cartEvent' | 'purchase' | 'setUser' | 'cancelCart';
+
+export type CartEventType = 'addToCart' | 'setCart' | 'removeFromCart';
+
+export type Product = {|
+    id : string,
+    title? : string,
+    url? : string,
+    description? : string,
+    imgUrl? : string,
+    otherImages? : $ReadOnlyArray<string>,
+    keywords? : $ReadOnlyArray<string>,
+    price? : string,
+    quantity? : string
+|};
+
+export type ViewData = {| page : string, title? : string |};
+
+export type CartData = {|
+    cartId? : string,
+    items : $ReadOnlyArray<Product>,
+    emailCampaignId? : string,
+    total? : string,
+    currencyCode? : string
+|};
+
+export type CancelCartData = {|
+    cartId? : string
+|};
+
+export type RemoveCartData = {|
+    cartId? : string,
+    items : $ReadOnlyArray<{ id : string }>
+|};
+
+export type PurchaseData = {| cartId : string |};
+
+export type UserData = {|
+    user : {|
+        id? : string,
+        email? : string,
+        name? : string
+    |}
+|};
+
+export type IdentityData = {|
+    mrid : string,
+    onIdentification : Function,
+    onError? : Function
+|};
+
+export type ParamsToBeaconUrl = ({
+    trackingType : TrackingType,
+    data : ViewData | CartData | RemoveCartData | PurchaseData | CancelCartData
+}) => string;
+
+export type ParamsToTokenUrl = () => string;
+
+export type ParamsToPropertyIdUrl = () => string;
+
+export type JetloreConfig = {|
+    user_id : string,
+    cid : string,
+    feed_id : string,
+    div? : string,
+    lang? : string
+|};
+
+export type Config = {|
+    user? : {|
+        id? : string,
+        email? : string, // mandatory if unbranded cart recovery
+        name? : string
+    |},
+    propertyId? : string,
+    paramsToBeaconUrl? : ParamsToBeaconUrl,
+    paramsToTokenUrl? : ParamsToTokenUrl,
+    jetlore? : {|
+        user_id : string,
+        access_token : string,
+        feed_id : string,
+        div? : string,
+        lang? : string
+    |},
+    paramsToPropertyIdUrl? : ParamsToPropertyIdUrl
+|};
+