@fuul/sdk 0.5.0

package/README.md

@@ -0,0 +1,99 @@
+# Getting started with Fuul SDK
+
+**Setting up the Fuul SDK**
+
+## **1. Install the Fuul SDK**
+
+Run one of the following commands to add Fuul SDK to your project:
+
+### npm
+
+```bash
+npm install fuul-sdk
+```
+
+### yarn
+
+```bash
+yarn add fuul-sdk
+```
+
+## 2**. Set up the Fuul SDK**
+
+In order to authenticate to full with your project, you must execute the following in the root file of your app.
+
+```tsx
+// App.tsx
+
+// Settings config object
+const settings = {
+  projectId: "myprojectid", // Replace with your Fuul Project Id.
+};
+
+const fuul = new Fuul(settings);
+```
+
+By this way, you’ll be available to use Fuul as a global object in any of your files, so you don’t have to create a new instance every time.
+
+- Please note that `projectId` is not required when you initialize Fuul sdk, but it is mandatory in order to send a `“connect_wallet”` event. But don’t worry, you can send it later as an argument using the `Fuul.sendEvent()` method if needed (please refer to section 3 of this guide)
+
+## 3**. Verifying the connection to Fuul SDK**
+
+You can verify that everything was set up successfully with the following method
+
+```tsx
+Fuul.verifyConnection()
+```
+
+If everything is ok, you will see a prompt as below:
+
+![Untitled](Getting%20started%20with%20Fuul%20SDK%205855c088f6d14fcf9dca9d3a13e9bd86/Untitled.png)
+
+## 4**. Sending events**
+
+In order to send events such as `pageview` or `connect_wallet` you must do the following
+
+```tsx
+// Sending a pageview event does not need any parameters, just the event name
+const handlePageView = async () => {
+	await Fuul.sendEvent("pageview");
+}
+
+// You can also send additional event arguments as follows:
+const handlePageView = async () => {
+	await Fuul.sendEvent("pageview", {
+		foo,
+		bar,
+		...myWonderfulArguments
+	});
+}
+
+// For connect_wallet events, you must send the address that is being connected as an argument
+const handlePageView = async () => {
+	await Fuul.sendEvent("connect_wallet", {
+		address: "0x3Ec0590BC79c74B0145f94C0bE1C5d63E491569f"
+		});
+}
+
+// Sending projectId as an event argument (please note that you must send it as project_id)
+const handlePageView = async () => {
+	await Fuul.sendEvent("pageview", {
+		project_id: "my-wonderful-project-id"
+	});
+}
+```
+
+## 5**. Generating tracking links**
+
+You can also generate the tracking link for a given wallet `address` and `campaign id`
+
+```tsx
+// Let's assume you are testing in localhost:3000
+
+const myWonderfulReferrerAddress: string = "0xE8BF39dCd16CF20d39006ba3C722A02e701bf0eE"
+const campaignId: string = "79e72760-c730-4422-9e7b-3b730e8800dc"
+
+const myTrackingId: string = Fuul.generateTrackingLink(myWonderfulReferrerAddress, campaignId);
+
+console.log(myTrackingId) // http://localhost:3000?c=79e72760-c730-4422-9e7b-3b730e8800dc&origin=fuul&r=0xE8BF39dCd16CF20d39006ba3C722A02e701bf0eE 
+```

package/lib/cjs/constants.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SENT_EVENT_ID_KEY = exports.REFERRER_ID_KEY = exports.CAMPAIGN_ID_KEY = exports.TRACKING_ID_KEY = exports.SESSION_ID_KEY = void 0;
+exports.SESSION_ID_KEY = "fuul.session_id";
+exports.TRACKING_ID_KEY = "fuul.tracking_id";
+exports.CAMPAIGN_ID_KEY = "fuul.campaign_id";
+exports.REFERRER_ID_KEY = "fuul.referrer_id";
+exports.SENT_EVENT_ID_KEY = "fuul.sent";

package/lib/cjs/index.js

@@ -0,0 +1,185 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Fuul = void 0;
+const axios_1 = __importDefault(require("axios"));
+const date_1 = require("./utils/date");
+const localStorage_1 = require("./utils/localStorage");
+const constants_1 = require("./constants");
+const saveSentEvent = (eventName, params) => {
+    const timestamp = Date.now();
+    const SENT_EVENT_KEY = `${constants_1.SENT_EVENT_ID_KEY}_${eventName}`;
+    const eventParams = Object.assign(Object.assign({}, params), { timestamp });
+    localStorage.setItem(SENT_EVENT_KEY, JSON.stringify(eventParams));
+};
+const isEventAlreadySentAndInValidTimestamp = (eventName, params) => {
+    const SENT_EVENT_KEY = `${constants_1.SENT_EVENT_ID_KEY}_${eventName}`;
+    const storedEvent = localStorage.getItem(SENT_EVENT_KEY);
+    if (!storedEvent)
+        return false;
+    const parsedEvent = JSON.parse(storedEvent);
+    const isSameDay = (0, date_1.datesAreOnSameDay)(new Date(Date.now()), new Date(parsedEvent.timestamp));
+    if (eventName === "connect_wallet") {
+        return parsedEvent["tracking_id"] === params.tracking_id && isSameDay;
+    }
+    else {
+        return (parsedEvent["tracking_id"] === params.tracking_id &&
+            parsedEvent["campaign_id"] === params.campaign_id &&
+            parsedEvent["referrer_id"] === params.referrer_id &&
+            isSameDay);
+    }
+};
+const generateRandomId = () => __awaiter(void 0, void 0, void 0, function* () {
+    const nanoid = yield Promise.resolve().then(() => __importStar(require("nanoid"))).then((m) => m.nanoid);
+    return nanoid();
+});
+const saveSessionId = () => __awaiter(void 0, void 0, void 0, function* () {
+    if (typeof window === "undefined")
+        return;
+    localStorage.setItem(constants_1.SESSION_ID_KEY, yield generateRandomId());
+});
+const saveTrackingId = () => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    if (typeof window === "undefined" || typeof document === "undefined")
+        return;
+    const queryParams = new URLSearchParams(window.location.search);
+    if (!queryParams.has("c") ||
+        !queryParams.has("origin") ||
+        !queryParams.has("r"))
+        return;
+    const isFuulOrigin = queryParams.get("origin") === "fuul";
+    if (!isFuulOrigin)
+        return;
+    if (!(0, localStorage_1.getTrackingId)()) {
+        localStorage.setItem(constants_1.TRACKING_ID_KEY, yield generateRandomId());
+    }
+    localStorage.setItem(constants_1.CAMPAIGN_ID_KEY, (_a = queryParams.get("c")) !== null && _a !== void 0 ? _a : "");
+    localStorage.setItem(constants_1.REFERRER_ID_KEY, (_b = queryParams.get("r")) !== null && _b !== void 0 ? _b : "");
+});
+const buildTrackingLinkQueryParams = (r, c) => {
+    return `c=${c}&origin=fuul&r=${r}`;
+};
+class Fuul {
+    constructor(projectId) {
+        this.BASE_API_URL = "https://api.fuul.xyz/api/v1";
+        this.projectId = projectId;
+        saveSessionId();
+        saveTrackingId();
+        globalThis.Fuul = this;
+    }
+    /**
+     * @param {EventType} name Event name.
+     * @param {EventArgsType} args Event additional arguments.
+     * ```js
+     * import { Fuul } from 'fuul-sdk'
+     *
+     * // Initialize Fuul in your app root file
+     * new Fuul('your-project-id')
+     *
+     * // Then you can send an event as follows:
+     * fuul.sendEvent('connect_wallet', {
+     *    address,
+     *    ...args
+     * })
+     * ```
+     */
+    sendEvent(name, args) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const session_id = (0, localStorage_1.getSessionId)();
+            const tracking_id = (0, localStorage_1.getTrackingId)();
+            const campaign_id = (0, localStorage_1.getCampaignId)();
+            const referrer_id = (0, localStorage_1.getReferrerId)();
+            if (!tracking_id)
+                return;
+            let params = {
+                tracking_id,
+            };
+            let reqBody = {};
+            if (name === "connect_wallet") {
+                reqBody = {
+                    name,
+                    session_id,
+                    event_args: Object.assign(Object.assign({}, args), { tracking_id }),
+                };
+            }
+            else {
+                if (!campaign_id || !referrer_id)
+                    return;
+                params = Object.assign(Object.assign({}, params), { referrer_id,
+                    campaign_id });
+                reqBody = {
+                    name,
+                    session_id,
+                    project_id: (_a = this.projectId) !== null && _a !== void 0 ? _a : args === null || args === void 0 ? void 0 : args.project_id,
+                    event_args: Object.assign(Object.assign({}, args), { referrer: referrer_id, campaign_id,
+                        tracking_id }),
+                };
+            }
+            if (isEventAlreadySentAndInValidTimestamp(name, params))
+                return;
+            const url = `${this.BASE_API_URL}/events`;
+            try {
+                const response = yield axios_1.default.post(url, reqBody);
+                saveSentEvent(name, params);
+                return response.data;
+            }
+            catch (error) {
+                return error;
+            }
+        });
+    }
+    verifyConnection() {
+        if (window !== undefined && globalThis.Fuul) {
+            window.alert("You are successfully connected to Fuul SDK! ✅");
+        }
+    }
+    /**
+     * Generates a tracking link for a referrer
+     * @param  {string} address referrer address
+     * @param  {string} cid campaign id you want to refer the user
+     * @param  {string} baseUrl base url of your app
+     * @returns {string} tracking link
+     */
+    generateTrackingLink({ address, cid, baseUrl, }) {
+        return `${baseUrl !== null && baseUrl !== void 0 ? baseUrl : window.location.href}?${buildTrackingLinkQueryParams(address, cid)}`;
+    }
+}
+exports.Fuul = Fuul;
+exports.default = {
+    Fuul,
+};

package/lib/cjs/types/constants.d.ts

@@ -0,0 +1,6 @@
+export declare const SESSION_ID_KEY = "fuul.session_id";
+export declare const TRACKING_ID_KEY = "fuul.tracking_id";
+export declare const CAMPAIGN_ID_KEY = "fuul.campaign_id";
+export declare const REFERRER_ID_KEY = "fuul.referrer_id";
+export declare const SENT_EVENT_ID_KEY = "fuul.sent";
+//# sourceMappingURL=constants.d.ts.map

package/lib/cjs/types/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc,oBAAoB,CAAC;AAChD,eAAO,MAAM,eAAe,qBAAqB,CAAC;AAClD,eAAO,MAAM,eAAe,qBAAqB,CAAC;AAClD,eAAO,MAAM,eAAe,qBAAqB,CAAC;AAClD,eAAO,MAAM,iBAAiB,cAAc,CAAC"}

package/lib/cjs/types/index.d.ts

@@ -0,0 +1,37 @@
+import { EventArgsType, EventType, IGenerateTrackingLink } from "./types/types";
+export declare class Fuul {
+    private projectId?;
+    private BASE_API_URL;
+    constructor(projectId?: string);
+    /**
+     * @param {EventType} name Event name.
+     * @param {EventArgsType} args Event additional arguments.
+     * ```js
+     * import { Fuul } from 'fuul-sdk'
+     *
+     * // Initialize Fuul in your app root file
+     * new Fuul('your-project-id')
+     *
+     * // Then you can send an event as follows:
+     * fuul.sendEvent('connect_wallet', {
+     *    address,
+     *    ...args
+     * })
+     * ```
+     */
+    sendEvent(name: EventType, args?: EventArgsType): Promise<any>;
+    verifyConnection(): void;
+    /**
+     * Generates a tracking link for a referrer
+     * @param  {string} address referrer address
+     * @param  {string} cid campaign id you want to refer the user
+     * @param  {string} baseUrl base url of your app
+     * @returns {string} tracking link
+     */
+    generateTrackingLink({ address, cid, baseUrl, }: IGenerateTrackingLink): string;
+}
+declare const _default: {
+    Fuul: typeof Fuul;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/cjs/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAkBA,OAAO,EACL,aAAa,EACb,SAAS,EACT,qBAAqB,EAEtB,MAAM,eAAe,CAAC;AA+EvB,qBAAa,IAAI;IACf,OAAO,CAAC,SAAS,CAAC,CAAS;IAC3B,OAAO,CAAC,YAAY,CAAyC;gBAEjD,SAAS,CAAC,EAAE,MAAM;IAS9B;;;;;;;;;;;;;;;OAeG;IACG,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC;IA4DpE,gBAAgB,IAAI,IAAI;IAMxB;;;;;;OAMG;IACH,oBAAoB,CAAC,EACnB,OAAO,EACP,GAAG,EACH,OAAO,GACR,EAAE,qBAAqB,GAAG,MAAM;CAMlC;;;;AAMD,wBAEE"}

package/lib/cjs/types/types/types.d.ts

@@ -0,0 +1,20 @@
+export interface SendEventParams {
+    name: EventType;
+    args?: EventArgsType;
+    projectId?: string;
+}
+export type EventArgsType = {
+    [key: string]: string;
+};
+export type EventType = "connect_wallet" | "pageview";
+export interface SentEventParams {
+    tracking_id: string;
+    campaign_id?: string;
+    referrer_id?: string;
+}
+export interface IGenerateTrackingLink {
+    address: string;
+    cid: string;
+    baseUrl?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/cjs/types/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/types/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,gBAAgB,GAAG,UAAU,CAAC;AAEtD,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/lib/cjs/types/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/types/utils/date.d.ts

@@ -0,0 +1,2 @@
+export declare const datesAreOnSameDay: (first: Date, second: Date) => boolean;
+//# sourceMappingURL=date.d.ts.map

package/lib/cjs/types/utils/date.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../../../../src/utils/date.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iBAAiB,UAAW,IAAI,UAAU,IAAI,YAGrB,CAAC"}

package/lib/cjs/types/utils/localStorage.d.ts

@@ -0,0 +1,5 @@
+export declare const getSessionId: () => string | null;
+export declare const getTrackingId: () => string | null;
+export declare const getCampaignId: () => string | null;
+export declare const getReferrerId: () => string | null;
+//# sourceMappingURL=localStorage.d.ts.map

package/lib/cjs/types/utils/localStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"localStorage.d.ts","sourceRoot":"","sources":["../../../../src/utils/localStorage.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,YAAY,qBAA6C,CAAC;AACvE,eAAO,MAAM,aAAa,qBAA8C,CAAC;AACzE,eAAO,MAAM,aAAa,qBAA8C,CAAC;AACzE,eAAO,MAAM,aAAa,qBAA8C,CAAC"}

package/lib/cjs/utils/date.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.datesAreOnSameDay = void 0;
+const datesAreOnSameDay = (first, second) => first.getFullYear() === second.getFullYear() &&
+    first.getMonth() === second.getMonth() &&
+    first.getDate() === second.getDate();
+exports.datesAreOnSameDay = datesAreOnSameDay;

package/lib/cjs/utils/localStorage.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getReferrerId = exports.getCampaignId = exports.getTrackingId = exports.getSessionId = void 0;
+const constants_1 = require("../constants");
+const getSessionId = () => localStorage.getItem(constants_1.SESSION_ID_KEY);
+exports.getSessionId = getSessionId;
+const getTrackingId = () => localStorage.getItem(constants_1.TRACKING_ID_KEY);
+exports.getTrackingId = getTrackingId;
+const getCampaignId = () => localStorage.getItem(constants_1.CAMPAIGN_ID_KEY);
+exports.getCampaignId = getCampaignId;
+const getReferrerId = () => localStorage.getItem(constants_1.REFERRER_ID_KEY);
+exports.getReferrerId = getReferrerId;

package/lib/esm/constants.js

@@ -0,0 +1,5 @@
+export const SESSION_ID_KEY = "fuul.session_id";
+export const TRACKING_ID_KEY = "fuul.tracking_id";
+export const CAMPAIGN_ID_KEY = "fuul.campaign_id";
+export const REFERRER_ID_KEY = "fuul.referrer_id";
+export const SENT_EVENT_ID_KEY = "fuul.sent";

package/lib/esm/index.mjs

@@ -0,0 +1,155 @@
+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 axios from "axios";
+import { datesAreOnSameDay } from "./utils/date";
+import { getCampaignId, getReferrerId, getSessionId, getTrackingId, } from "./utils/localStorage";
+import { CAMPAIGN_ID_KEY, REFERRER_ID_KEY, SENT_EVENT_ID_KEY, SESSION_ID_KEY, TRACKING_ID_KEY, } from "./constants";
+const saveSentEvent = (eventName, params) => {
+    const timestamp = Date.now();
+    const SENT_EVENT_KEY = `${SENT_EVENT_ID_KEY}_${eventName}`;
+    const eventParams = Object.assign(Object.assign({}, params), { timestamp });
+    localStorage.setItem(SENT_EVENT_KEY, JSON.stringify(eventParams));
+};
+const isEventAlreadySentAndInValidTimestamp = (eventName, params) => {
+    const SENT_EVENT_KEY = `${SENT_EVENT_ID_KEY}_${eventName}`;
+    const storedEvent = localStorage.getItem(SENT_EVENT_KEY);
+    if (!storedEvent)
+        return false;
+    const parsedEvent = JSON.parse(storedEvent);
+    const isSameDay = datesAreOnSameDay(new Date(Date.now()), new Date(parsedEvent.timestamp));
+    if (eventName === "connect_wallet") {
+        return parsedEvent["tracking_id"] === params.tracking_id && isSameDay;
+    }
+    else {
+        return (parsedEvent["tracking_id"] === params.tracking_id &&
+            parsedEvent["campaign_id"] === params.campaign_id &&
+            parsedEvent["referrer_id"] === params.referrer_id &&
+            isSameDay);
+    }
+};
+const generateRandomId = () => __awaiter(void 0, void 0, void 0, function* () {
+    const nanoid = yield import("nanoid").then((m) => m.nanoid);
+    return nanoid();
+});
+const saveSessionId = () => __awaiter(void 0, void 0, void 0, function* () {
+    if (typeof window === "undefined")
+        return;
+    localStorage.setItem(SESSION_ID_KEY, yield generateRandomId());
+});
+const saveTrackingId = () => __awaiter(void 0, void 0, void 0, function* () {
+    var _a, _b;
+    if (typeof window === "undefined" || typeof document === "undefined")
+        return;
+    const queryParams = new URLSearchParams(window.location.search);
+    if (!queryParams.has("c") ||
+        !queryParams.has("origin") ||
+        !queryParams.has("r"))
+        return;
+    const isFuulOrigin = queryParams.get("origin") === "fuul";
+    if (!isFuulOrigin)
+        return;
+    if (!getTrackingId()) {
+        localStorage.setItem(TRACKING_ID_KEY, yield generateRandomId());
+    }
+    localStorage.setItem(CAMPAIGN_ID_KEY, (_a = queryParams.get("c")) !== null && _a !== void 0 ? _a : "");
+    localStorage.setItem(REFERRER_ID_KEY, (_b = queryParams.get("r")) !== null && _b !== void 0 ? _b : "");
+});
+const buildTrackingLinkQueryParams = (r, c) => {
+    return `c=${c}&origin=fuul&r=${r}`;
+};
+export class Fuul {
+    constructor(projectId) {
+        this.BASE_API_URL = "https://api.fuul.xyz/api/v1";
+        this.projectId = projectId;
+        saveSessionId();
+        saveTrackingId();
+        globalThis.Fuul = this;
+    }
+    /**
+     * @param {EventType} name Event name.
+     * @param {EventArgsType} args Event additional arguments.
+     * ```js
+     * import { Fuul } from 'fuul-sdk'
+     *
+     * // Initialize Fuul in your app root file
+     * new Fuul('your-project-id')
+     *
+     * // Then you can send an event as follows:
+     * fuul.sendEvent('connect_wallet', {
+     *    address,
+     *    ...args
+     * })
+     * ```
+     */
+    sendEvent(name, args) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const session_id = getSessionId();
+            const tracking_id = getTrackingId();
+            const campaign_id = getCampaignId();
+            const referrer_id = getReferrerId();
+            if (!tracking_id)
+                return;
+            let params = {
+                tracking_id,
+            };
+            let reqBody = {};
+            if (name === "connect_wallet") {
+                reqBody = {
+                    name,
+                    session_id,
+                    event_args: Object.assign(Object.assign({}, args), { tracking_id }),
+                };
+            }
+            else {
+                if (!campaign_id || !referrer_id)
+                    return;
+                params = Object.assign(Object.assign({}, params), { referrer_id,
+                    campaign_id });
+                reqBody = {
+                    name,
+                    session_id,
+                    project_id: (_a = this.projectId) !== null && _a !== void 0 ? _a : args === null || args === void 0 ? void 0 : args.project_id,
+                    event_args: Object.assign(Object.assign({}, args), { referrer: referrer_id, campaign_id,
+                        tracking_id }),
+                };
+            }
+            if (isEventAlreadySentAndInValidTimestamp(name, params))
+                return;
+            const url = `${this.BASE_API_URL}/events`;
+            try {
+                const response = yield axios.post(url, reqBody);
+                saveSentEvent(name, params);
+                return response.data;
+            }
+            catch (error) {
+                return error;
+            }
+        });
+    }
+    verifyConnection() {
+        if (window !== undefined && globalThis.Fuul) {
+            window.alert("You are successfully connected to Fuul SDK! ✅");
+        }
+    }
+    /**
+     * Generates a tracking link for a referrer
+     * @param  {string} address referrer address
+     * @param  {string} cid campaign id you want to refer the user
+     * @param  {string} baseUrl base url of your app
+     * @returns {string} tracking link
+     */
+    generateTrackingLink({ address, cid, baseUrl, }) {
+        return `${baseUrl !== null && baseUrl !== void 0 ? baseUrl : window.location.href}?${buildTrackingLinkQueryParams(address, cid)}`;
+    }
+}
+export default {
+    Fuul,
+};

package/lib/esm/types/constants.d.ts

@@ -0,0 +1,6 @@
+export declare const SESSION_ID_KEY = "fuul.session_id";
+export declare const TRACKING_ID_KEY = "fuul.tracking_id";
+export declare const CAMPAIGN_ID_KEY = "fuul.campaign_id";
+export declare const REFERRER_ID_KEY = "fuul.referrer_id";
+export declare const SENT_EVENT_ID_KEY = "fuul.sent";
+//# sourceMappingURL=constants.d.ts.map

package/lib/esm/types/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,cAAc,oBAAoB,CAAC;AAChD,eAAO,MAAM,eAAe,qBAAqB,CAAC;AAClD,eAAO,MAAM,eAAe,qBAAqB,CAAC;AAClD,eAAO,MAAM,eAAe,qBAAqB,CAAC;AAClD,eAAO,MAAM,iBAAiB,cAAc,CAAC"}

package/lib/esm/types/index.d.ts

@@ -0,0 +1,37 @@
+import { EventArgsType, EventType, IGenerateTrackingLink } from "./types/types";
+export declare class Fuul {
+    private projectId?;
+    private BASE_API_URL;
+    constructor(projectId?: string);
+    /**
+     * @param {EventType} name Event name.
+     * @param {EventArgsType} args Event additional arguments.
+     * ```js
+     * import { Fuul } from 'fuul-sdk'
+     *
+     * // Initialize Fuul in your app root file
+     * new Fuul('your-project-id')
+     *
+     * // Then you can send an event as follows:
+     * fuul.sendEvent('connect_wallet', {
+     *    address,
+     *    ...args
+     * })
+     * ```
+     */
+    sendEvent(name: EventType, args?: EventArgsType): Promise<any>;
+    verifyConnection(): void;
+    /**
+     * Generates a tracking link for a referrer
+     * @param  {string} address referrer address
+     * @param  {string} cid campaign id you want to refer the user
+     * @param  {string} baseUrl base url of your app
+     * @returns {string} tracking link
+     */
+    generateTrackingLink({ address, cid, baseUrl, }: IGenerateTrackingLink): string;
+}
+declare const _default: {
+    Fuul: typeof Fuul;
+};
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/lib/esm/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AAkBA,OAAO,EACL,aAAa,EACb,SAAS,EACT,qBAAqB,EAEtB,MAAM,eAAe,CAAC;AA+EvB,qBAAa,IAAI;IACf,OAAO,CAAC,SAAS,CAAC,CAAS;IAC3B,OAAO,CAAC,YAAY,CAAyC;gBAEjD,SAAS,CAAC,EAAE,MAAM;IAS9B;;;;;;;;;;;;;;;OAeG;IACG,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,EAAE,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC;IA4DpE,gBAAgB,IAAI,IAAI;IAMxB;;;;;;OAMG;IACH,oBAAoB,CAAC,EACnB,OAAO,EACP,GAAG,EACH,OAAO,GACR,EAAE,qBAAqB,GAAG,MAAM;CAMlC;;;;AAMD,wBAEE"}

package/lib/esm/types/types/types.d.ts

@@ -0,0 +1,20 @@
+export interface SendEventParams {
+    name: EventType;
+    args?: EventArgsType;
+    projectId?: string;
+}
+export type EventArgsType = {
+    [key: string]: string;
+};
+export type EventType = "connect_wallet" | "pageview";
+export interface SentEventParams {
+    tracking_id: string;
+    campaign_id?: string;
+    referrer_id?: string;
+}
+export interface IGenerateTrackingLink {
+    address: string;
+    cid: string;
+    baseUrl?: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/lib/esm/types/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../../src/types/types.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,SAAS,CAAC;IAChB,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,aAAa,GAAG;IAC1B,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG,gBAAgB,GAAG,UAAU,CAAC;AAEtD,MAAM,WAAW,eAAe;IAC9B,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB"}

package/lib/esm/types/types.js

@@ -0,0 +1 @@
+export {};

package/lib/esm/types/utils/date.d.ts

@@ -0,0 +1,2 @@
+export declare const datesAreOnSameDay: (first: Date, second: Date) => boolean;
+//# sourceMappingURL=date.d.ts.map

package/lib/esm/types/utils/date.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../../../../src/utils/date.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iBAAiB,UAAW,IAAI,UAAU,IAAI,YAGrB,CAAC"}

package/lib/esm/types/utils/localStorage.d.ts

@@ -0,0 +1,5 @@
+export declare const getSessionId: () => string | null;
+export declare const getTrackingId: () => string | null;
+export declare const getCampaignId: () => string | null;
+export declare const getReferrerId: () => string | null;
+//# sourceMappingURL=localStorage.d.ts.map

package/lib/esm/types/utils/localStorage.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"localStorage.d.ts","sourceRoot":"","sources":["../../../../src/utils/localStorage.ts"],"names":[],"mappings":"AAOA,eAAO,MAAM,YAAY,qBAA6C,CAAC;AACvE,eAAO,MAAM,aAAa,qBAA8C,CAAC;AACzE,eAAO,MAAM,aAAa,qBAA8C,CAAC;AACzE,eAAO,MAAM,aAAa,qBAA8C,CAAC"}

package/lib/esm/utils/date.js

@@ -0,0 +1,3 @@
+export const datesAreOnSameDay = (first, second) => first.getFullYear() === second.getFullYear() &&
+    first.getMonth() === second.getMonth() &&
+    first.getDate() === second.getDate();

package/lib/esm/utils/localStorage.js

@@ -0,0 +1,5 @@
+import { CAMPAIGN_ID_KEY, REFERRER_ID_KEY, SESSION_ID_KEY, TRACKING_ID_KEY, } from "../constants";
+export const getSessionId = () => localStorage.getItem(SESSION_ID_KEY);
+export const getTrackingId = () => localStorage.getItem(TRACKING_ID_KEY);
+export const getCampaignId = () => localStorage.getItem(CAMPAIGN_ID_KEY);
+export const getReferrerId = () => localStorage.getItem(REFERRER_ID_KEY);

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@fuul/sdk",
+  "version": "0.5.0",
+  "description": "Fuul SDK",
+  "types": "./lib/esm/types/index.d.ts",
+  "main": "./lib/esm/index.mjs",
+  "files": [
+    "lib/**/*"
+  ],
+  "scripts": {
+    "compile": "node compile.js",
+    "clean": "rm -rf ./lib",
+    "dev": "ts-node ./src/index.ts",
+    "build": "npm run clean && npm run build:esm && npm run build:cjs",
+    "build:esm": "tsc -p ./configs/tsconfig.esm.json && mv lib/esm/index.js lib/esm/index.mjs",
+    "build:cjs": "tsc -p ./configs/tsconfig.cjs.json",
+    "semantic-release": "semantic-release"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "axios": "^1.2.2",
+    "nanoid": "^4.0.0"
+  },
+  "devDependencies": {
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/npm": "^9.0.2",
+    "@types/node": "^18.11.18",
+    "semantic-release": "^20.1.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.7.4"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/fuul-app/fuul-sdk.git"
+  },
+  "publishConfig": {
+    "tag": "latest",
+    "access": "public"
+  }
+}