@surfside/surfside-events 0.0.1

package/dist/index.umd.min.d.ts

@@ -0,0 +1,245 @@
+import { BrowserPlugin } from '@surfside/browser-core';
+import { CommonEventProperties } from '@surfside/digital-core';
+declare function SurfsideCommercePlugin(): BrowserPlugin;
+/**
+ * A Commerce Action
+ * Used when tracking an Surfside Commerce Action with all stored Commerce contexts
+ */
+interface commerceAction {
+    /** Actions specify how to interpret product and promotion data */
+    action?: string;
+}
+/**
+ * Track a Commerce Action with all stored Commerce contexts
+ *
+ * @param event
+ * @param trackers
+ */
+declare function setCommerceAction(event?: commerceAction & CommonEventProperties, trackers?: Array<string>): void;
+/**
+ * The Commerce Transaction Context
+ * Represents information about an ecommerce related action that has taken place.
+ */
+interface commerceTransactionContext {
+    /** The transaction id */
+    id?: string;
+    /** The store of affiliation from which this transaction occured */
+    affiliation?: string;
+    /** Specifies the total revenue or grand total associated with the transaction */
+    revenue?: string;
+    /** The total tax associated with the transaction. */
+    tax?: number;
+    /** The shipping cost associated with the transaction. */
+    shipping?: number;
+    /** The transaction coupon redeemed with the transaction. */
+    coupon?: string;
+    /** The list that the associated products belong to. */
+    list?: string;
+    /**	A number representing a step in the checkout process. Optional on `checkout` actions.  */
+    step?: number;
+    /** Additional field for checkout and checkout_option actions that can describe option information on the checkout page, like selected payment method. */
+    option?: string;
+    /** The currency of the transactoin */
+    currency?: string;
+}
+/**
+ * Adds a Commerce Transaction Context to an Action
+ *
+ * @param context - The context to be stored
+ * @param trackers - The tracker identifiers which the context will be stored against
+ */
+declare function addTransaction(context?: commerceTransactionContext, trackers?: Array<string>): void;
+/**
+ * A Commerce Impression Context
+ */
+interface commerceImpressionContext {
+    /** The product ID or SKU */
+    id?: string;
+    /** The name of the product */
+    name?: string;
+    /** The list or collection to which the product belongs */
+    list?: string;
+    /** The brand associated with the product */
+    brand?: string;
+    /** The category to which the product belongs */
+    category?: string;
+    /** The variant of the product */
+    variant?: string;
+    /** The product's position in a list or collection */
+    position?: number;
+    /** The price of a product  */
+    price?: string;
+    /** The currency of a product  */
+    currency?: string;
+}
+/**
+ * Adds a Commerce Impression Context
+ *
+ * @param context - The context to be stored
+ * @param trackers - The tracker identifiers which the context will be stored against
+ */
+declare function addImpression(context?: commerceImpressionContext, trackers?: Array<string>): void;
+/**
+ * A Commerce Product Context
+ */
+interface commerceProductContext {
+    /** The product ID or SKU */
+    id?: string;
+    /** The name of the product */
+    name?: string;
+    /** The list or collection to which the product belongs */
+    list?: string;
+    /** The brand associated with the product */
+    brand?: string;
+    /** The category to which the product belongs  */
+    category?: string;
+    /** The variant of the product */
+    variant?: string;
+    /** The price of a product */
+    price?: number;
+    /** The quantity of a product */
+    quantity?: number;
+    /** The coupon code associated with a product */
+    coupon?: string;
+    /** The product's position in a list or collection */
+    position?: number;
+    /** The currency of the product */
+    currency?: string;
+}
+/**
+ * Adds a Commerce Product Context
+ *
+ * @param context - The context to be stored
+ * @param trackers - The tracker identifiers which the context will be stored against
+ */
+declare function addProduct(context?: commerceProductContext, trackers?: Array<string>): void;
+/**
+ * A Commerce Promotion Context
+ */
+interface commercePromoContext {
+    /** The promotion ID */
+    id?: string;
+    /** The name of the promotion */
+    name?: string;
+    /** The creative associated with the promotion */
+    creative?: string;
+    /** The position of the creative */
+    position?: string;
+    /** The currency of the product */
+    currency?: string;
+}
+/**
+ * Adds a Commerce Promotion Context
+ *
+ * @param context - The context to be stored
+ * @param trackers - The tracker identifiers which the context will be stored against
+ */
+declare function addPromotion(context?: commercePromoContext, trackers?: Array<string>): void;
+/** SURFSIDE CORE CONTEXTS **/
+/**
+ * A Surfside Source Context
+ */
+interface sourceContext {
+    /** The Account ID */
+    accountId?: string;
+    /** The Source ID */
+    sourceId?: string;
+}
+/**
+ * Adds a Surfside Source Context
+ *
+ * @param context - The context to be stored
+ * @param trackers - The tracker identifiers which the context will be stored against
+ */
+declare function source(context?: sourceContext, trackers?: Array<string>): void;
+/**
+ * A Surfside Segment Context
+ */
+interface segmentContext {
+    /** The Segment ID */
+    segmentId?: string;
+    /** The Segment Value */
+    segmentVal?: string;
+}
+/**
+ * Adds a Surfside Segment Context
+ *
+ * @param context - The context to be stored
+ * @param trackers - The tracker identifiers which the context will be stored against
+ */
+declare function segment(context?: segmentContext, trackers?: Array<string>): void;
+/**
+ * A Surfside User Context
+ */
+interface userContext {
+    /** The address of the user */
+    address?: string;
+    /** The age of the user */
+    age?: string;
+    /** The company of the user */
+    company?: string;
+    /** The created timstamp of the user */
+    createdAt?: string;
+    /** The date of birth of the user */
+    dateOfBirth?: string;
+    /** The email of the user */
+    email?: string;
+    /** The first name of the user */
+    firstName?: string;
+    /** The gender of the user */
+    gender?: string;
+    /** The user ID of the user */
+    userId?: string;
+    /** The last name of the user */
+    lastName?: string;
+}
+/**
+ * Adds a Surfside User Context
+ *
+ * @param context - The context to be stored
+ * @param trackers - The tracker identifiers which the context will be stored against
+ */
+declare function setUser(context?: userContext, trackers?: Array<string>): void;
+/**
+ * A Surfside User Context
+ */
+interface identifyUserContext {
+    /** The ID of the user */
+    id?: string;
+    /** The address of the user */
+    address?: string;
+    /** The age of the user */
+    age?: string;
+    /** The company of the user */
+    company?: string;
+    /** The created timstamp of the user */
+    createdAt?: string;
+    /** The date of birth of the user */
+    dateOfBirth?: string;
+    /** The email of the user */
+    email?: string;
+    /** The first name of the user */
+    firstName?: string;
+    /** The gender of the user */
+    gender?: string;
+    /** The user ID of the user */
+    userId?: string;
+    /** The last name of the user */
+    lastName?: string;
+    /** The name of the user */
+    name?: string;
+    /** The phone of the user */
+    phone?: string;
+    /** The title of the user */
+    title?: string;
+    /** The username of the user */
+    username?: string;
+}
+/**
+ * Adds a Surfside  Context
+ *
+ * @param context - The context to be stored
+ * @param trackers - The tracker identifiers which the context will be stored against
+ */
+declare function identifyUser(context?: identifyUserContext, trackers?: Array<string>): void;
+export { SurfsideCommercePlugin, commerceAction, setCommerceAction, commerceTransactionContext, addTransaction, commerceImpressionContext, addImpression, commerceProductContext, addProduct, commercePromoContext, addPromotion, sourceContext, source, segmentContext, segment, userContext, setUser, identifyUserContext, identifyUser };

package/dist/index.umd.min.js

@@ -0,0 +1,7 @@
+/*!
+ * Surfside Digital Analytics v0.0.1 (https://surfside.io)
+ * Copyright 2022 Surfside Solutions Inc, Snowplow Analytics Ltd, 2010 Anthon Pang
+ */
+
+"use strict";!function(e,n){"object"==typeof exports&&"undefined"!=typeof module?n(exports):"function"==typeof define&&define.amd?define(["exports"],n):n((e="undefined"!=typeof globalThis?globalThis:e||self).snowplowEnhancedEcommerce={})}(this,(function(e){function n(e,n,o){if(o||2===arguments.length)for(var t,r=0,i=n.length;r<i;r++)!t&&r in n||(t||(t=Array.prototype.slice.call(n,0,r)),t[r]=n[r]);return e.concat(t||Array.prototype.slice.call(n))}function o(e){return e=parseInt(e),isNaN(e)?void 0:e}function t(e){return e=parseFloat(e),isNaN(e)?void 0:e}function r(e,n,o){try{var t=null!=e?e:Object.keys(n);e=[];for(var r=0;r<t.length;r++){var i=t[r];n.hasOwnProperty(i)?e.push(n[i]):c.warn(i+" not configured")}e.forEach(o)}catch(e){c.error("Function failed",e)}}var i,a;(a=i||(i={}))[a.none=0]="none",a[a.error=1]="error",a[a.warn=2]="warn",a[a.debug=3]="debug",a[a.info=4]="info";var c=function(e){return void 0===e&&(e=i.warn),{setLogLevel:function(n){e=i[n]?n:i.warn},warn:function(o,t){for(var r=[],a=2;a<arguments.length;a++)r[a-2]=arguments[a];e>=i.warn&&"undefined"!=typeof console&&(a="Snowplow: "+o,t?console.warn.apply(console,n([a+"\n",t],r,!1)):console.warn.apply(console,n([a],r,!1)))},error:function(o,t){for(var r=[],a=2;a<arguments.length;a++)r[a-2]=arguments[a];e>=i.error&&"undefined"!=typeof console&&(a="Snowplow: "+o+"\n",t?console.error.apply(console,n([a+"\n",t],r,!1)):console.error.apply(console,n([a],r,!1)))},debug:function(o){for(var t=[],r=1;r<arguments.length;r++)t[r-1]=arguments[r];e>=i.debug&&"undefined"!=typeof console&&console.debug.apply(console,n(["Snowplow: "+o],t,!1))},info:function(o){for(var t=[],r=1;r<arguments.length;r++)t[r-1]=arguments[r];e>=i.info&&"undefined"!=typeof console&&console.info.apply(console,n(["Snowplow: "+o],t,!1))}}}(),s={},d={};e.SurfsideCommercePlugin=function(){return{activateBrowserPlugin:function(e){s[e.id]=e,d[e.id]=[]}}},e.addImpression=function(e,n){void 0===e&&(e={}),void 0===n&&(n=Object.keys(s));var r=e.id,i=e.name,a=e.list,c=e.brand,u=e.category,f=e.variant,l=e.position,p=e.price,m=e.currency;n.forEach((function(e){d[e]&&d[e].push({schema:"iglu:io.surfside.commerce/impression/jsonschema/1-0-0",data:{id:r,name:i,list:a,brand:c,category:u,variant:f,position:o(l),price:t(p),currency:m}})}))},e.addProduct=function(e,n){void 0===e&&(e={}),void 0===n&&(n=Object.keys(s));var r=e.id,i=e.name,a=e.list,c=e.brand,u=e.category,f=e.variant,l=e.price,p=e.quantity,m=e.coupon,h=e.position,y=e.currency;n.forEach((function(e){d[e]&&d[e].push({schema:"iglu:io.surfside.commerce/product/jsonschema/1-0-0",data:{id:r,name:i,list:a,brand:c,category:u,variant:f,price:t(l),quantity:o(p),coupon:m,position:o(h),currency:y}})}))},e.addPromotion=function(e,n){void 0===e&&(e={}),void 0===n&&(n=Object.keys(s));var o=e.id,t=e.name,r=e.creative,i=e.position,a=e.currency;n.forEach((function(e){d[e]&&d[e].push({schema:"iglu:io.surfside.commerce/promotion/jsonschema/1-0-0",data:{id:o,name:t,creative:r,position:i,currency:a}})}))},e.addTransaction=function(e,n){void 0===e&&(e={}),void 0===n&&(n=Object.keys(s));var r=e.id,i=e.affiliation,a=e.revenue,c=e.tax,u=e.shipping,f=e.coupon,l=e.list,p=e.step,m=e.option,h=e.currency;n.forEach((function(e){d[e]&&d[e].push({schema:"iglu:io.surfside.commerce/transaction/jsonschema/1-0-0",data:{id:r,affiliation:i,revenue:t(a),tax:t(c),shipping:t(u),coupon:f,list:l,step:o(p),option:m,currency:h}})}))},e.identifyUser=function(e,n){void 0===e&&(e={}),void 0===n&&(n=Object.keys(s));var o=e.id,t=e.address,r=e.age,i=e.company,a=e.createdAt,c=e.dateOfBirth,u=e.email,f=e.firstName,l=e.gender,p=e.userId,m=e.lastName,h=e.name,y=e.phone,v=e.title,g=e.username;n.forEach((function(e){d[e]&&d[e].push({schema:"iglu:io.surfside.identity/user/jsonschema/1-0-0",data:{id:o,address:t,age:r,company:i,createdAt:a,dateOfBirth:c,email:u,firstName:f,gender:l,userId:p,lastName:m,name:h,phone:y,title:v,username:g}})}))},e.segment=function(e,n){void 0===e&&(e={}),void 0===n&&(n=Object.keys(s));var o=e.segmentId,t=e.segmentVal;r(n,s,(function(e){d[e.id].length=0,e.core.addGlobalContexts([{schema:"iglu:io.surfside/segment/jsonschema/1-0-0",data:{segmentId:o,segmentVal:t}}])}))},e.setCommerceAction=function(e,n){void 0===e&&(e={}),void 0===n&&(n=Object.keys(s)),r(n,s,(function(n){var o=d[n.id].concat(e.context||[]);d[n.id].length=0;var t=(n=n.core).track,r={action:e},i=function(){var e,n={},o=[],t=[],r=function(e,o){null!=o&&""!==o&&(n[e]=o)};return{add:r,addDict:function(e){for(var n in e)Object.prototype.hasOwnProperty.call(e,n)&&r(n,e[n])},addJson:function(e,n,r){var i;if(i=r)e:{if(null!=r&&(r.constructor==={}.constructor||r.constructor===[].constructor))for(var a in r)if(Object.prototype.hasOwnProperty.call(r,a)){i=!0;break e}i=!1}i&&(e={keyIfEncoded:e,keyIfNotEncoded:n,json:r},t.push(e),o.push(e))},getPayload:function(){return n},getJson:function(){return o},withJsonProcessor:function(n){e=n},build:function(){return null==e||e(this,t),n}}}();r={schema:"iglu:com.snowplowanalytics.snowplow/unstruct_event/jsonschema/1-0-0",data:{schema:"iglu:io.surfside.commerce/action/jsonschema/1-0-0",data:r}},i.add("e","ue"),i.addJson("ue_px","ue_pr",r),t.call(n,i,o,e.timestamp)}))},e.setUser=function(e,n){void 0===e&&(e={}),void 0===n&&(n=Object.keys(s));var o=e.address,t=e.age,r=e.company,i=e.createdAt,a=e.dateOfBirth,c=e.email,u=e.firstName,f=e.gender,l=e.userId,p=e.lastName;n.forEach((function(e){d[e]&&d[e].push({schema:"iglu:io.surfside.identity/user/jsonschema/1-0-0",data:{address:o,age:t,company:r,createdAt:i,dateOfBirth:a,email:c,firstName:u,gender:f,userId:l,lastName:p}})}))},e.source=function(e,n){void 0===e&&(e={}),void 0===n&&(n=Object.keys(s));var o=e.accountId,t=e.sourceId;r(n,s,(function(e){d[e.id].length=0,e.core.addGlobalContexts([{schema:"iglu:io.surfside/context/jsonschema/1-0-0",data:{accountId:o,sourceId:t}}])}))},Object.defineProperty(e,"__esModule",{value:!0})}));
+//# sourceMappingURL=index.umd.min.js.map