@fuul/sdk 1.1.5 → 2.0.0

package/README.md

@@ -1,8 +1,8 @@
 # Getting started with Fuul SDK
 
-## Installation
+## Installation & minimum set up
 
-### 1. Install the Fuul SDK
+### 1. Installation
 
 Run one of the following commands to add Fuul SDK to your project:
 
@@ -18,67 +18,44 @@ Yarn:
 yarn add @fuul/sdk
 ```
 
-### 2. Set up the Fuul SDK
+### 2. Set up
 
-In order to authenticate to Fuul with your project, you must execute the following in the root file of your app.
+Before using the SDK you must initialize it by supplying your Fuul issued API key.
+
+NOTE: Be sure to do this at the root of your app so you have the SDK ready for use just by importing it at the usage point.
 
 ```tsx
-const settings = {
-  apiKey: "your-fuul-api-key" 
-};
+import { Fuul } from ('@fuul/sdk');
 
-const fuul = new Fuul(settings);
+Fuul.init({ apiKey: "your-fuul-api-key" });
 ```
 
-Now you’ll be able to use Fuul as a global object in any of your files, so you don’t have to create a new instance every time.
-
-### 3. Test your integration
+Now you can start sending events.
 
-Test your integration with the following method:
+### 3. Sending events
 
-```tsx
-function main() {
-  fuul.verifyConnection();
-}
-main();
-```
+For Fuul to attribute conversion events you'll need to report the "pageview" and "connect wallet" events.
 
-### 4. Sending events
-
-For Fuul to attribute conversion events to your visitors, you'll need to report the connect_wallet event. 
-
-#### Connect wallet event
 
-Projects must send this event every time users connect a wallet to their website (both when connecting a wallet for the first time and when changing wallets during the session).
+#### Page view event
 
-For this type of event, projects must send the user address that is being connected to the website as an argument.
+Projects must send this event every time a user visits a page on their website.
 
 ```tsx
-await fuul.sendEvent("connect_wallet", {}, { userAddress: '0x01' });
-```
-
-### Sending Custom Events
+import { Fuul } from ('@fuul/sdk');
 
-Apart from the necessary `connect wallet` event, we allow projects to send any custom event to track as pleased.
-
-```tsx
-await fuul.sendEvent("my-custom-event", {
-	arg1: 'arg1',
-	arg2: 'arg2',
-});
+await fuul.sendPageview();
 ```
 
-### 5. Generating Tracking Links
 
-You can also generate the tracking link for a given wallet `address` and `project id`
+#### Connect wallet event
 
-```tsx
-// Let's assume you are testing in localhost:3000
+Projects must send this event every time users connect a wallet to their website. 
 
-const myWonderfulReferrerAddress: string = "0xE8BF39dCd16CF20d39006ba3C722A02e701bf0eE"
-const projectId: string = "79e72760-c730-4422-9e7b-3b730e8800dc"
+NOTE: Make sure to send the event when connecting a wallet for the first time as well as when changing wallets during the session.
 
-const myTrackingId: string = Fuul.generateTrackingLink(myWonderfulReferrerAddress, projectId);
+```tsx
+import { Fuul } from ('@fuul/sdk');
 
-console.log(myTrackingId) // http://localhost:3000?p=79e72760-c730-4422-9e7b-3b730e8800dc&origin=fuul&r=0xE8BF39dCd16CF20d39006ba3C722A02e701bf0eE 
+await Fuul.sendConnectWallet({ userAddress: '0x01' });
 ```

package/dist/ConversionService.d.ts

@@ -0,0 +1,12 @@
+import { HttpClient } from './HttpClient';
+import { Conversion } from './types/api';
+export type ConversionServiceSettings = {
+    httpClient: HttpClient;
+    debug?: boolean;
+};
+export declare class ConversionService {
+    private httpClient;
+    constructor(settings: ConversionServiceSettings);
+    getAll(): Promise<Conversion[]>;
+}
+//# sourceMappingURL=ConversionService.d.ts.map

package/dist/ConversionService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConversionService.d.ts","sourceRoot":"","sources":["../../src/ConversionService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAEzC,MAAM,MAAM,yBAAyB,GAAG;IACtC,UAAU,EAAE,UAAU,CAAC;IACvB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,UAAU,CAAa;gBAEnB,QAAQ,EAAE,yBAAyB;IAIzC,MAAM,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;CAKtC"}

package/dist/EventService.d.ts

@@ -0,0 +1,18 @@
+import { HttpClient } from './HttpClient';
+import { FuulEvent } from './types/api';
+export declare const SENT_EVENT_ID_KEY = "fuul.sent";
+export declare const SENT_EVENT_VALIDITY_PERIOD_SECONDS = 60;
+export type EventServiceSettings = {
+    httpClient: HttpClient;
+    debug?: boolean;
+};
+export declare class EventService {
+    private readonly debug;
+    private readonly httpClient;
+    constructor(settings: EventServiceSettings);
+    sendEvent(event: FuulEvent): Promise<void>;
+    isDuplicate(thisEvent: FuulEvent): boolean;
+    private getCurrentTimestamp;
+    private saveSentEvent;
+}
+//# sourceMappingURL=EventService.d.ts.map

package/dist/EventService.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"EventService.d.ts","sourceRoot":"","sources":["../../src/EventService.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,eAAO,MAAM,iBAAiB,cAAc,CAAC;AAC7C,eAAO,MAAM,kCAAkC,KAAK,CAAC;AAErD,MAAM,MAAM,oBAAoB,GAAG;IACjC,UAAU,EAAE,UAAU,CAAC;IACvB,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAU;IAChC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;gBAE5B,QAAQ,EAAE,oBAAoB;IAK7B,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,OAAO,CAAC,IAAI,CAAC;IAYhD,WAAW,CAAC,SAAS,EAAE,SAAS,GAAG,OAAO;IAyCjD,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,aAAa;CAQtB"}

package/dist/{infrastructure/http/HttpClient.d.ts → HttpClient.d.ts}

@@ -1,4 +1,4 @@
-import { AxiosResponse, RawAxiosRequestHeaders } from 'axios';
+import { AxiosResponse } from 'axios';
 interface HttpClientOptions {
     baseURL: string;
     timeout: number;
@@ -13,6 +13,7 @@ export declare class HttpClient {
     private readonly client;
     private readonly queryParams;
     constructor(options: HttpClientOptions);
+    private buildQueryParams;
     get<T>(path: string, params?: any): Promise<AxiosResponse<T>>;
     post<T>(path: string, data: {
         [key: string]: any;
@@ -21,7 +22,6 @@ export declare class HttpClient {
         [key: string]: any;
     }): Promise<AxiosResponse<T>>;
     delete<T>(path: string): Promise<AxiosResponse<T>>;
-    _getHeaders(apiKey: string): RawAxiosRequestHeaders;
 }
 export {};
 //# sourceMappingURL=HttpClient.d.ts.map

package/dist/HttpClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"HttpClient.d.ts","sourceRoot":"","sources":["../../src/HttpClient.ts"],"names":[],"mappings":"AAAA,OAAc,EAAiB,aAAa,EAA0B,MAAM,OAAO,CAAC;AAEpF,UAAU,iBAAiB;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAgB;IACvC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;gBAEzB,OAAO,EAAE,iBAAiB;IAUtC,OAAO,CAAC,gBAAgB;IAWlB,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,GAAG,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAI7D,IAAI,CAAC,CAAC,EACV,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE;QACJ,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,GACA,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAItB,GAAG,CAAC,CAAC,EACT,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE;QACJ,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;KACpB,GACA,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;IAItB,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;CAGzD"}

package/dist/core.d.ts

@@ -0,0 +1,58 @@
+import { Conversion } from './types/api';
+import { EventArgs, FuulSettings, UserMetadata } from './types/sdk';
+export declare function init(settings: FuulSettings): void;
+/**
+ * @param {string} name Event name
+ * @param {EventArgs} args Event arguments
+ * @param {UserMetadata} userMetadata User metadata
+ * @returns {Promise<void>}
+ * @example
+ * ```js
+ * sendEvent('my_event', { value: 10 }, { userAddress: '0x01' })
+ * ```
+ */
+export declare function sendEvent(name: string, args?: EventArgs, userMetadata?: UserMetadata): Promise<void>;
+/**
+ * @param {string} pageName Optional page name, default is document.location.pathname
+ * @see https://docs.fuul.xyz/technical-guide-for-projects/sending-events-through-the-fuul-sdk#pageview-event
+ * @returns {Promise<void>}
+ * @example
+ * ```typescript
+ * sendPageview({ page: '/home' })
+ * sendPageview({ page: '/product/123' })
+ * ```
+ */
+export declare function sendPageview(pageName?: string): Promise<void>;
+/**
+ * @param {UserMetadata} userMetadata Metadata from the user that connected the wallet
+ * @see https://docs.fuul.xyz/technical-guide-for-projects/sending-events-through-the-fuul-sdk#connect-wallet-event
+ * @returns {Promise<void>}
+ * @example
+ * ```typescript
+ * sendConnectWallet({
+ *   userAddress: '0x12345',
+ *   signature: '0xaad9a0b62f87c15a248cb99ca926785b828b5',
+ *   signatureMessage: 'Accept referral from Fuul'
+ * })
+ * ```
+ */
+export declare function sendConnectWallet(userMetadata: UserMetadata): Promise<void>;
+/**
+ * Generates a tracking link for an affiliate
+ * @param {string} landingUrl - Landing URL of your project
+ * @param {string} affiliateAddress - Affiliate wallet address
+ * @param {string} projectId - Project ID
+ * @returns {string} Tracking link
+ **/
+export declare function generateTrackingLink(landingUrl: string, affiliateAddress: string, projectId: string): string;
+export declare function getConversions(): Promise<Conversion[]>;
+declare const _default: {
+    init: typeof init;
+    sendEvent: typeof sendEvent;
+    sendPageview: typeof sendPageview;
+    sendConnectWallet: typeof sendConnectWallet;
+    generateTrackingLink: typeof generateTrackingLink;
+    getConversions: typeof getConversions;
+};
+export default _default;
+//# sourceMappingURL=core.d.ts.map

package/dist/core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../src/core.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,UAAU,EAAa,MAAM,aAAa,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAWpE,wBAAgB,IAAI,CAAC,QAAQ,EAAE,YAAY,QAoB1C;AAQD;;;;;;;;;GASG;AACH,wBAAsB,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,SAAS,EAAE,YAAY,CAAC,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAuD1G;AAED;;;;;;;;;GASG;AACH,wBAAsB,YAAY,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAKnE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,iBAAiB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC,CAEjF;AAED;;;;;;IAMI;AACJ,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAE5G;AAED,wBAAsB,cAAc,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC,CAG5D;;;;;;;;;AAuBD,wBAOE"}

package/dist/index.d.ts

@@ -1,50 +1,5 @@
-import { ConversionDTO } from './infrastructure/conversions/dtos';
-import { EventArgs, EventMetadata, FuulSettings, IGenerateTrackingLink, UserMetadata } from './types';
-declare class Fuul {
-    private readonly apiKey;
-    private readonly BASE_API_URL;
-    private readonly httpClient;
-    private readonly settings;
-    private conversionService;
-    constructor(apiKey: string, settings?: FuulSettings);
-    init(): Promise<void>;
-    checkApiKey(): void;
-    /**
-     * @param {EventType} name Event name.
-     * @param {EventArgs} args Event arguments
-     * @param {EventMetadata} metadata Event metadata like userAddress, signature, signatureMessage
-     * @returns {Promise<void>}
-     * @example
-     * ```js
-     * fuul.sendEvent('my_event', { value: 10 }, { userAddress: '0x01' })
-     * ```
-     */
-    sendEvent(name: string, args?: EventArgs, metadata?: EventMetadata): Promise<void>;
-    /**
-     * @param {UserMetadata} userMetadata Metadata from the user that is connecting the wallet
-     * @see https://docs.fuul.xyz/technical-guide-for-projects/sending-events-through-the-fuul-sdk#connect-wallet-event
-     * @returns {Promise<void>}
-     * @example
-     * ```typescript
-     * fuul.sendConnectWalletEvent({
-     *     userAddress: '0x12345',
-     *     signature: '0xaad9a0b62f87c15a248cb99ca926785b828b5',
-     *     signatureMessage: 'Accept referral from Fuul'
-     * })
-     * ```
-     */
-    sendConnectWalletEvent(userMetadata: UserMetadata): Promise<void>;
-    verifyConnection(): void;
-    /**
-     * Generates a tracking link for a referrer
-     * @param {Object} trackingLinkParams - Tracking link parameters
-     * @param {string} trackingLinkParams.address - Referrer wallet address.
-     * @param {string} trackingLinkParams.projectId - Project ID.
-     * @param {string} trackingLinkParams.baseUrl - Base URL of your app. Defaults to window.location.href.
-     * @returns {string} tracking link
-     **/
-    generateTrackingLink({ address, projectId, baseUrl }: IGenerateTrackingLink): string;
-    getAllConversions(): Promise<ConversionDTO[]>;
-}
-export default Fuul;
+import Fuul from './core';
+export type { Conversion } from './types/api';
+export type { EventArgs, FuulSettings, UserMetadata } from './types/sdk';
+export { Fuul };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,mCAAmC,CAAA;AAEjE,OAAO,EACL,SAAS,EACT,aAAa,EACb,YAAY,EACZ,qBAAqB,EAErB,YAAY,EACb,MAAM,SAAS,CAAA;AAoBhB,cAAM,IAAI;IACR,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAQ;IAC/B,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAyC;IACtE,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IACvC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAc;IAEvC,OAAO,CAAC,iBAAiB,CAAmB;gBAEhC,MAAM,EAAE,MAAM,EAAE,QAAQ,GAAE,YAAiB;IAqBjD,IAAI;IAQV,WAAW,IAAI,IAAI;IAMnB;;;;;;;;;OASG;IACG,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAE,SAAc,EAAE,QAAQ,GAAE,aAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA2ChG;;;;;;;;;;;;OAYG;IACG,sBAAsB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvE,gBAAgB,IAAI,IAAI;IAWxB;;;;;;;QAOI;IACJ,oBAAoB,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE,qBAAqB,GAAG,MAAM;IAI9E,iBAAiB,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;CAGpD;AAED,eAAe,IAAI,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,QAAQ,CAAC;AAE1B,YAAY,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC9C,YAAY,EAAE,SAAS,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAEzE,OAAO,EAAE,IAAI,EAAE,CAAC"}