JavaScript SDK

Welcome to the Fans United JavaScript SDK. This SDK works for client-side, server-side and React Native implementations.
The SDK has complete coverage of the Fans United APIs and is split into different namespaces depending on what you want
to achieve.

Operations supported by the SDK:

Profile Operations
Football Operations
Predictor Operations
Top X Operations
Match Quiz Operations
Loyalty Operations
Activity Operations
Mini-Games Operations
Progress Operations
Private Leagues Operations
Discussions Operations
Fantasy Operations
Voting Operations

Install the SDK

The JavaScript SDK is distributed as 2 NPM packages - ESM and UMD.

ESM

Install JavaScript SDK as ESM dependency by running the following command:

npm i fansunited-sdk-esm
yarn add fansunited-sdk-esm

UMD

For UMD package run the following command:

npm i fansunited-sdk-umd
yarn add fansunited-sdk-umd

For CDN add the following script command in your html file:

<script src="https://cdn.jsdelivr.net/npm/[email protected]/index.js"></script>

Where "@1.23.0" is the version of JS SDK that you want to use in your application.

Use the SDK in your app

The SDK works with JWTs provided from OAuth2 provider. The default provider is Firebase Authentication, but if the
client has their own provider, it can be integrated into the platform.

The SDK comes with a configuration and an interface. The client needs to implement this interface and pass the implementation
in the config.

Initiate the SDK

This is what the SDK config requires:

N.B: The following example is when JavaScript SDK is installed as an ESM dependency

import {FansUnitedSDK} from "fansunited-sdk-esm";

let fansUnitedSdk = FansUnitedSDK({
    apiKey: "your-api-key-here",
    environment: "dev|prod|staging|watg|yolo", // default: prod
    clientId: "your-client-id-here",
    lang: "bg|en|ro|el|sk", // default: en
    idSchema: "native|enetpulse|sportradar|sportal365", // default: native
    errorHandlingMode: "default|standard", // default: default
    authProvider: new myTokenProvider()
});

You need to create a class that has the following 2 methods:

getIdToken() - This function should return a valid JWT as a string. This token is used for all requests that require authentication. If any API returns 401 Unauthorized response, the SDK will repeat the request by calling the getIdToken() function again, expecting that the token has been changed. If the token has not changed and the API still returns 401, the exception will be relayed to the client.
logout() - you can implement custom logout logic here

A client supplied class would look like this:

class myTokenProvider {
  getIdToken = () => {
    // custom logic ....
    return "tokenString"; // no need prefixing this with Bearer. Just the plain token string is needed
  }
  logout = () => {
    // custom logic ....
  };
}

TypeScript

Providing configuration to JS SDK in TypeScript projects follow this model:

class SDKConfigurationModel {
    apiKey: string;
    clientId: string;
    environment?: EnvironmentType;
    idSchema?: IdSchemaType;
    lang?: LangType;
  	errorHandlingMode?: ErrorHandlingModeType;
    authProvider: FansUnitedAuthInterface;
}

type EnvironmentType = 'dev' | 'prod' | 'staging' | 'watg' | 'yolo';
type IdSchemaType = 'native' | 'enetpulse' | 'sportal365' | 'sportradar';
type LangType = 'bg' | 'en' | 'ro' | 'el' | 'sk';
type ErrorHandlingModeType = 'default' | 'standard';

Here is an example how you can construct this configuration:

class TokenProvider {
	public getIdToken = (): string => {
    // custom logic ....
    return "tokenString";
	};
	public logout = () => {
  	// custom logic ....
  };
}

const idSchema: IdSchemaType = 'sportal365';
const lang: LangType = 'bg';
const environment: EnvironmentType = 'staging';
const errorHandlingMode: ErrorHandlingModeType = 'standard';

const config = {
  apiKey: "AIzaSyBDsY25nJ4VZz0iiLLQpPRnjMRnIHkyqg4",
  clientId: "productiontesting1",
  authProvider: new TokenProvider(),
  idSchema,
  lang,
  environment,
  errorHandlingMode
};

N.B
As you can see from SDKConfigurationModel, fields idSchema, lang, environment and errorHandlingMode are optional. If they are not provided, they will be set to default values (idSchema: "native", lang: "en", environment: "prod", errorHandlingMode: "default").

Configuration validator

When you provide a configuration, it gets validate before Fans United JS SDK initialization. If some of the fields are missing or invalid, warning messages are logged or error messages are throwed.

Warning messages

All warning messages are logged to the developer. The following cases contains warning messages:

When idSchema is NOT provided. Logs the following message:
If no idSchema is passed the default one will be set which is: native.
When idSchema is provided, but the value is NOT supported:
This idSchema value is not supported, the default one will be set which is: native.
When environment is NOT provided. Logs the following message:
If no environment is passed the default one will be set which is: prod.
When environment is provided, but the value is NOT supported:
This environment value is not supported, the default one will be set which is: prod.
When lang is NOT provided. Logs the following message:
If no lang is passed the default one will be set which is: en.
When lang is provided, but the value is NOT supported:
This lang value is not supported, the default one will be set which is: en.
When errorHandlingMode is NOT provided. Logs the following message:
If no errorHandlingMode is passed the default one will be set which is: default.
When errorHandlingMode is provided, but the value is NOT supported:
This errorHandlingMode value is not supported, the default one will be set which is: default.
When for authProvider field has been provided more properties than the expected ones (getIdToken and logout):
You have passed a property which is not supported for the authentication provider:

Error messages

All error messages are throwed to the developer. The following cases contains error messages:

When apiKey is NOT provided. Throws the following message:
The field apiKey with valid value must be provided to use Fans United JS SDK.
When clientId is NOT provided. Throws the following message:
The field clientId must be provided to use Fans United JS SDK.
When authProvider is NOT provided. Throws the following message:
The field authProvider must be provided to use this SDK.
When authProvider is missing some of FansUnitedAuthInterface methods. Throws the following message:
The following property is missing from the authProvider object:

SDK instance versioning

getVersion method

To be able to see the current version of SDK that you are using, you can call the getVersion method. It returns the following method:

📘
Method call:

const version = sdk.getVersion();
console.log(version) // See below for logged model

The version as it follows:

{
   version: "1.78.0",
   major: 1,
   minor: 78,
   patch: 0,
   releaseCandidate: null, // When version is 1.78.0-RC1, then the releaseCandidate will be 1
}