fansunited-sdk-esm 1.20.1 → 1.22.0

package/Core/Configurator/Enums/ErrorHandlingModeEnum.d.ts

@@ -0,0 +1,4 @@
+export declare enum ErrorHandlingModeEnum {
+    DEFAULT = "default",
+    STANDARD = "standard"
+}

package/Core/Configurator/Enums/ValidationMessageEnum.d.ts

@@ -7,6 +7,8 @@ export declare enum ValidationMessageEnum {
     ID_SCHEMA_INVALID = "This idSchema value is not supported, the default one will be set which is: native",
     ENVIRONMENT_MISSING = "If no environment is passed the default one will be set which is: prod",
     ENVIRONMENT_INVALID = "This environment value is not supported, the default one will be set which is: prod",
+    ERROR_HANDLING_MODE_MISSING = "If no errorHandlingMode is passed the default one will be set which is: default",
+    ERROR_HANDLING_MODE_INVALID = "This errorHandlingMode value is not supported, the default one will be set which is: default",
     AUTH_PROVIDER_CONFIG_PROP_MISSING = "The following property is missing from the authProvider object:",
     AUTH_PROVIDER_CONFIG_INVALID_PROP = "You have passed a property which is not supported for the authentication provider:",
     AUTH_PROVIDER_CONFIG_MISSING = "The field authProvider must be provided to use this SDK",

package/Core/Configurator/Models/ConfigValidationModel.d.ts

@@ -5,6 +5,7 @@ export default class ConfigValidationModel {
     idSchema: ValidationItemModel;
     clientId: ValidationItemModel;
     lang: ValidationItemModel;
+    errorHandlingMode: ValidationItemModel;
     authProvider: any;
     isValid: boolean;
 }

package/Core/Configurator/Models/SDKConfiguraitonModel.d.ts

@@ -1,4 +1,4 @@
-import { EnvironmentType, IdSchemaType, LangType } from "../Types/ConfiguratorTypes";
+import { EnvironmentType, ErrorHandlingModeType, IdSchemaType, LangType } from "../Types/ConfiguratorTypes";
 import FansUnitedAuthInterface from "./FansUnitedAuthInterface";
 export default class SDKConfigurationModel {
     apiKey: string;
@@ -6,5 +6,6 @@ export default class SDKConfigurationModel {
     environment?: EnvironmentType;
     idSchema?: IdSchemaType;
     lang?: LangType;
+    errorHandlingMode?: ErrorHandlingModeType;
     authProvider: FansUnitedAuthInterface;
 }

package/Core/Configurator/Types/ConfiguratorTypes.d.ts

@@ -1,3 +1,4 @@
 export declare type LangType = 'bg' | 'en' | 'ro';
 export declare type IdSchemaType = 'native' | 'enetpulse' | 'sportal365' | 'sportradar';
 export declare type EnvironmentType = 'dev' | 'prod' | 'staging';
+export declare type ErrorHandlingModeType = 'default' | 'standard';

package/Core/Configurator/Validators/ErrorHandlingModeValidator.d.ts

@@ -0,0 +1,8 @@
+import SDKConfigurationModel from "../Models/SDKConfiguraitonModel";
+import ValidationItemModel from "../Models/ValidationItemModel";
+import IValidator from "./IValidator";
+export default class ErrorHandlingModeValidator implements IValidator {
+    validate: (config: SDKConfigurationModel) => ValidationItemModel;
+    private validateField;
+    private generateMessage;
+}

package/Core/Exception/ErrorCodes.d.ts

@@ -1,3 +1,4 @@
 export declare enum ErrorCodes {
-    BAD_METHOD_CALL = 400
+    BAD_METHOD_CALL = 400,
+    UNAUTHORIZED = 401
 }

package/Core/Exception/ErrorStatuses.d.ts

@@ -4,5 +4,7 @@ export declare enum ErrorStatuses {
     INVALID_MARKET = "INVALID_MARKET",
     INVALID_FIELD = "INVALID_FIELD",
     INVALID_TYPE = "INVALID_TYPE",
-    EXCEEDED_LENGTH = "EXCEEDED_LENGTH"
+    EXCEEDED_LENGTH = "EXCEEDED_LENGTH",
+    INVALID_TOKEN = "invalid_token",
+    UNAUTHORIZED = "unauthorized"
 }

package/Core/Exception/StandardFansUnitedException.d.ts

@@ -0,0 +1,12 @@
+interface FansUnitedException {
+    error: {
+        code: number;
+        status: string;
+        message: string;
+    };
+}
+export default class StandardFansUnitedException {
+    response: FansUnitedException;
+    constructor(code: number, status: string, message: string);
+}
+export {};

package/Core/Global/Constants/Tests/SDKConfigurationsTesting.d.ts

@@ -4,6 +4,7 @@ export declare const SDK_CONFIG_NATIVE: {
     idSchema: string;
     clientId: string;
     lang: string;
+    errorHandlingMode: string;
     authProvider: {
         getIdToken: () => void;
     };
@@ -14,6 +15,7 @@ export declare const SDK_CONFIG_ENETPULSE: {
     idSchema: string;
     clientId: string;
     lang: string;
+    errorHandlingMode: string;
     authProvider: {
         getIdToken: () => void;
     };
@@ -24,6 +26,7 @@ export declare const SDK_CONFIG_SPORTAL365: {
     idSchema: string;
     clientId: string;
     lang: string;
+    errorHandlingMode: string;
     authProvider: {
         getIdToken: () => void;
     };
@@ -34,6 +37,7 @@ export declare const SDK_CONFIG_SPORTRADAR: {
     idSchema: string;
     clientId: string;
     lang: string;
+    errorHandlingMode: string;
     authProvider: {
         getIdToken: () => void;
     };

package/Core/Global/LocalStorage.d.ts

@@ -5,11 +5,12 @@ import ProfileCountryModel from "../Namespaces/Profile/Models/ProfileCountryMode
 import CompetitionBasicModel from "../Namespaces/Football/Models/Competition/CompetitionBasicModel";
 import CompetitionFilters from "../Namespaces/Football/Models/Competition/CompetitionFilters";
 import ProfileStatsModel from "../Namespaces/Profile/Models/Stats/ProfileStatsModel";
-export declare type ExparationType = "profile" | "statistics" | "badges";
+export declare type ExparationType = "profile" | "statistics" | "badges" | "features";
 export default class LocalStorage {
     private idSchema;
-    readonly expirationTimeout: number;
+    readonly expirationProfileTimeout: number;
     readonly expirationBadgesTimeout: number;
+    readonly expirationClientFeaturesTimeout: number;
     constructor(configuration: SDKConfigurationModel);
     clearData: () => void;
     getEntityById: (type?: string, id?: string) => any;
@@ -37,7 +38,11 @@ export default class LocalStorage {
     getCompetitions: (filters?: CompetitionFilters) => any;
     setCompetitions: (competitions: CompetitionBasicModel[]) => void;
     getCompetitionsLength: () => number;
-    getExpiration: (type: ExparationType) => number;
+    getClientFeatures: () => any;
+    setClientFeatures: (features: {
+        [key: string]: any;
+    }) => void;
+    getExpiration: (namespace: string, type: ExparationType) => number;
     /**
      * The purpose of this method is to avoid the posibility of having same competitions store in Local Storage.
      * @param competitions Cached competitions.
@@ -46,5 +51,8 @@ export default class LocalStorage {
     private makeCompetitionsUnique;
     private getData;
     private setData;
+    /**
+     * Guarantee that the new local storage schema is set
+     */
     private initialNewSchema;
 }

package/Core/Global/Messages/Messages.d.ts

@@ -5,7 +5,9 @@ export declare enum ErrorMessages {
     INVALID_PLAYER_ID = "Player id is invalid!",
     QUERY_PARAM_MATCH_IDS_EXCEEDED = "Maximum matchIds in PredictionFilters should be 10 or less.",
     QUERY_PARAM_FILTERS_LIMIT_EXCEEDED = "Maximum limit for filtering games is 50 or less.",
-    INVALID_PREDICTION_FIELD = "Prediction field is invalid. For more information please visit our documentation"
+    INVALID_PREDICTION_FIELD = "Prediction field is invalid. For more information please visit our documentation",
+    INVALID_TOKEN = "Invalid JWT token is provided",
+    EXPIRED_TOKEN = "The provided JWT token is expired"
 }
 export declare const WarningMessages: {
     UNEXPECTED_STATUS_PROP: string;

package/Core/Https/ActivityHttps.d.ts

@@ -7,7 +7,6 @@ import ProfileStatsModel from "../Namespaces/Profile/Models/Stats/ProfileStatsMo
 import Https from "./Https";
 export default class ActivityHttps extends Https {
     private activityRemapper;
-    private apiSignInUrl;
     constructor(config: SDKConfiguraitonModel);
     createActivity: (requestBody: CreateActivityRequestBody) => Promise<ActivityResponseBody>;
     deleteActivity: (activityId: string) => Promise<boolean>;

package/Core/Https/ClientHttps.d.ts

@@ -8,8 +8,10 @@ export declare enum FeatureConfigType {
     LOYALTY = "loyalty"
 }
 export default class ClientHttps extends Https {
-    private apiSignInUrl;
     private featureConfigRemapper;
+    private localStorage;
     constructor(config: SDKConfigurationModel);
     getConfig: (feature: FeatureConfigType) => Promise<FeaturesConfigModels>;
+    private getCachedFeatures;
+    private getLocalStorageData;
 }

package/Core/Https/FootballHttps.d.ts

@@ -16,8 +16,6 @@ import SearchModel from "../Namespaces/Football/Models/Search/SearchModel";
 import FootballPaginationModel from "../Namespaces/Football/Models/Pagination/FootballPaginationModel";
 import Https from "./Https";
 export default class FootballHttps extends Https {
-    private apiSignInUrl;
-    private clientId;
     private limitIds;
     private countryRemapper;
     private competitionBasicRemapper;

package/Core/Https/Https.d.ts

@@ -1,7 +1,17 @@
-import { AxiosInstance } from "axios";
+import { AxiosError, AxiosInstance } from "axios";
 import SDKConfigurationModel from "../Configurator/Models/SDKConfiguraitonModel";
+import StandardFansUnitedException from "../Exception/StandardFansUnitedException";
 export default class Https {
+    protected apiSignInUrl: string;
     protected instanceAuth: AxiosInstance;
     protected instance: AxiosInstance;
+    private errorHandlingMode;
     constructor(configuration: SDKConfigurationModel, baseUrl: string);
+    /**
+     * Returns the axios error param when handling mode is set to default
+     * Otherwise returns a new StandardFansUnitedException from API's returned exception body.
+     * @param e Axios error. Catched from throwed CRUD operations.
+     * @returns Axios error or StandardFansUnitedException
+     */
+    protected transformAxiosErrorToFansUnitedException: (e: AxiosError) => AxiosError | StandardFansUnitedException;
 }

package/Core/Https/IdMappingHttps.d.ts

@@ -2,7 +2,6 @@ import { AxiosResponse } from "axios";
 import SDKConfiguraitonModel from "../Configurator/Models/SDKConfiguraitonModel";
 import Https from "./Https";
 export default class IdMappingHttps extends Https {
-    private apiSignInUrl;
     constructor(config: SDKConfiguraitonModel);
     getEntityById: (type: string, id: string) => AxiosResponse<any>;
     getEntityByIdAndSchema: (type: string, id: string, schemaId: string) => AxiosResponse<any>;

package/Core/Https/LoyaltyHttps.d.ts

@@ -7,13 +7,13 @@ import TemplateModel from "../Namespaces/Loyalty/Models/Template/TemplateModel";
 import HighestSuccessRateModel from "../Namespaces/Loyalty/Models/HighestSuccessRate/HighestSuccessRateModel";
 import Https from "./Https";
 export default class LoyaltyHttps extends Https {
-    private apiSignInUrl;
     private templateRemapper;
     private leaderboardRemapper;
     private rankingsRemapper;
     private highestSuccessRateRemapper;
     constructor(config: SDKConfiguraitonModel);
     getTemplates: (disableCache: boolean, isPaginated: boolean) => Promise<PaginationModel | TemplateModel[]>;
+    getTemplateById: (templateId: string, disableCache: boolean) => Promise<TemplateModel>;
     getLeaderboard: (templateId: string, disableCache: boolean, filters: LoyaltyFilters) => Promise<PaginationModel>;
     getLeaderboardForGame: (gameId: string, disableCache: boolean, filters: LoyaltyFilters) => Promise<PaginationModel>;
     getUserRankings: (userId: string, filters: RankingsFilters, disableCache: boolean) => Promise<FootballPaginationModel>;

package/Core/Https/PredictorHttps.d.ts

@@ -12,7 +12,6 @@ import MainFiltersBQ from "../Global/Models/Filters/MainFiltersBQ";
 import Https from "./Https";
 import ContestWinners from "../Namespaces/TopX/Models/Games/Winners/ContestWinners";
 export default class PredictorHttps extends Https {
-    private apiSignInUrl;
     private predictionRemapper;
     private matchSummaryRemapper;
     private gamesRemapper;

package/Core/Https/ProfileHttps.d.ts

@@ -6,7 +6,6 @@ import FollowFilters from "../Namespaces/Profile/Models/FollowFilters";
 import PaginationModel from "../Global/Models/Pagination/PaginationModel";
 import Https from "./Https";
 export default class ProfileHttps extends Https {
-    private apiSignInUrl;
     private profileRemapper;
     private followingRemapper;
     private followersRemapper;

package/Core/Namespaces/Loyalty/Facade/LoyaltyFacade.d.ts

@@ -23,6 +23,7 @@ export default class LoyaltyFacade {
     private topXFacade;
     private matchQuizFacade;
     private predictorHttps;
+    private errorHandlingMode;
     constructor(config: SDKConfigurationModel, clientHttps: ClientHttps, loyaltyHttps: LoyaltyHttps, profileHttps: ProfileHttps, localStorage: LocalStorage);
     getConfig: () => Promise<FeaturesConfigModels>;
     getClientBadges: () => Promise<ClientBadges>;

package/Core/Namespaces/Loyalty/Validator/LoyaltyValidator.d.ts

@@ -1,3 +1,4 @@
+import { ErrorHandlingModeType } from "../../../Configurator/Types/ConfiguratorTypes";
 export default class LoyaltyValidator {
-    validateMarket: (market: string) => void;
+    validateMarket: (errorHandlingMode: ErrorHandlingModeType, market: string) => void;
 }

package/Core/Namespaces/MatchQuiz/Facade/MatchQuizFacade.d.ts

@@ -16,6 +16,7 @@ export default class MatchQuizFacade {
     private idMapping;
     private clientHttps;
     private predictorValidator;
+    private errorHandlingMode;
     constructor(config: SDKConfigurationModel);
     getConfig: () => Promise<FeaturesConfigModels>;
     play: (matchQuizPrediction: PredictionRequestModel) => Promise<PredictionResponseModel>;

package/Core/Namespaces/Predictor/Facade/PredictorFacade.d.ts

@@ -14,6 +14,7 @@ export default class PredictorFacade {
     readonly idMapping: IdMappingService;
     readonly predictorService: PredictorService;
     private predictorValidator;
+    private errorHandlingMode;
     constructor(config: SDKConfigurationModel, predictorHttps: PredictorHttps, clientHttps: ClientHttps, idMapping: IdMappingService);
     /**
     * Exposing PredictorService for two operations:

package/Core/Namespaces/Predictor/Validator/PredictorValidator.d.ts

@@ -13,7 +13,10 @@ import RedCardFixtureModel from "../Models/Fixtures/Markets/RedCardFixtureModel"
 import PredictionRequestModel from "../Models/Predictions/PredictionRequestModel";
 import { TypeGames } from "../../TopX/types/types";
 import TopXPredictionRequestModel from "../../TopX/Models/Prediction/TopXPredictionRequestModel";
+import { ErrorHandlingModeType } from "../../../Configurator/Types/ConfiguratorTypes";
 export default class PredictorValidator {
+    private errorHandlingMode;
+    constructor(errorHandlingMode: ErrorHandlingModeType);
     /**
      * Validate all field for game prediction (Top X and Match Quiz). The following cases are covered:
      * 1. Unsupported field is provided (Top X and Match Quiz)

package/Core/Namespaces/TopX/Facade/TopXFacade.d.ts

@@ -19,6 +19,7 @@ export default class TopXFacade {
     readonly predictorService: PredictorService;
     readonly predictorValidator: PredictorValidator;
     private clientHttps;
+    private errorHandlingMode;
     constructor(config: SDKConfigurationModel, idMapping: IdMappingService);
     getConfig: () => Promise<FeaturesConfigModels>;
     getGames: (filters?: GamesFilters, disableCache?: boolean) => Promise<PaginationModel>;

package/README.md

@@ -46,6 +46,7 @@ const fansUnitedSdk = FansUnitedSDK({
     "clientId": "your-client-id-here",
     "lang": "BG|EN|RO", // default: EN
     "idSchema": "native|enetpulse|sportradar|sportal365", // default: native
+    "errorHandlingMode": "default|standard", // default: default
     "authProvider": new myTokenProvider()
 });
 ```