fansunited-sdk-esm 1.5.1 → 1.6.0

package/Core/Exception/ErrorCodes.d.ts

@@ -0,0 +1,3 @@
+export declare enum ErrorCodes {
+    BAD_METHOD_CALL = 400
+}

package/Core/Exception/ErrorStatuses.d.ts

@@ -0,0 +1,8 @@
+export declare enum ErrorStatuses {
+    INVALID_TEMPLATE = "INVALID_TEMPLATE",
+    INVALID_PREDICTION = "INVALID_PREDICTION",
+    INVALID_MARKET = "INVALID_MARKET",
+    INVALID_FIELD = "INVALID_FIELD",
+    INVALID_TYPE = "INVALID_TYPE",
+    EXCEEDED_LENGTH = "EXCEEDED_LENGTH"
+}

package/Core/Exception/FansUnitedSdkException.d.ts

@@ -1,5 +1,8 @@
-import { ErrorMessages } from "../Global/Messages/Messages";
+import { ErrorStatuses } from "./ErrorStatuses";
 export default class FansUnitedSdkException extends Error {
-    constructor(message: ErrorMessages);
+    code: number;
+    status: ErrorStatuses;
+    message: string;
+    constructor(code: number, status: ErrorStatuses, message: string);
     errorMessage: () => string;
 }

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

@@ -7,3 +7,4 @@ export declare const ID_TYPES: {
 export declare const documentationLinks: {
     PREDICTOR_USER_RELATED_OPERATION: string;
 };
+export declare const validFixtureFields: string[];

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

@@ -1,11 +1,18 @@
+import { MarketEnum } from "../../Namespaces/Predictor/Enums/MarketEnum";
 export declare enum ErrorMessages {
     LOYALTY_INVALID_TEMPLATE_ID = "Provided template ID does NOT exist! Try again with existing template ID.",
     INVALID_MATCH_ID = "Match id is invalid!",
     INVALID_PLAYER_ID = "Player id is invalid!",
     QUERY_PARAM_MATCH_IDS_EXCEEDED = "Maximum matchIds in PredictionFilters should be 10 or less.",
-    INVALID_PREDICTION_MODEL = "The prediction is invalid. Please check again have you passed appropriate prediction model. For more information please visit our offical documentation: \n https://docs.fansunitedmedia.com/sdks/js/match.quiz#gamerelatedoperations"
+    INVALID_PREDICTION_FIELD = "Prediction field is invalid. For more information please visit our documentation"
 }
 export declare const WarningMessages: {
     UNEXPECTED_STATUS_PROP: string;
     UNEXPECTED_TYPE_PROP: string;
 };
+export declare const invalidPredictionMessage: (prediction: string, market: MarketEnum) => string;
+export declare const invalidMarketMessage: (market: string) => string;
+export declare const invalidMarketTopXMessage: (market: string) => string;
+export declare const invalidFieldMessage: (fields: string[]) => string;
+export declare const missingFieldsMessage: (field: string, missingFields: string[]) => string;
+export declare const invalidTypeMessage: (field: string, correctType: string) => string;

package/Core/Namespaces/Football/Facades/FootballFacade.d.ts

@@ -17,6 +17,7 @@ import PlayerFilters from "../Models/Player/PlayerFilters";
 import SearchFilters from "../Models/Search/SearchFilters";
 import FootballPaginationModel from "../Models/Pagination/FootballPaginationModel";
 import SDKConfigurationModel from "../../../Configurator/Models/SDKConfiguraitonModel";
+import PlayerBasicModel from "../Models/Player/PlayerBasicModel";
 export default class FootballFacade {
     private countriesFacade;
     private competitionsFacade;
@@ -41,6 +42,7 @@ export default class FootballFacade {
     getTopPlayers: (disableCache?: boolean) => Promise<TopPlayerModel[]>;
     getNextMatchForPlayer: (id: string, disableCache?: boolean) => Promise<MatchFullModel>;
     getPrevMatchForPlayer: (id: string, disableCache?: boolean) => Promise<MatchFullModel>;
+    getPlayersMapWithNativeIds: (playerIds: string[]) => Promise<Map<string, PlayerBasicModel>>;
     getMatches: (filters?: MatchFilters, disableCache?: boolean) => Promise<FootballPaginationModel>;
     getMatchById: (id: string, disableCache?: boolean) => Promise<MatchFullModel>;
     search: (filters: SearchFilters, disableCache?: boolean) => Promise<SearchModel>;

package/Core/Namespaces/Loyalty/Models/Points/PointsModel.d.ts

@@ -1,9 +1,10 @@
-import ActionValueModel from "../Actions/ActionValueModel";
 import Points from "./Points";
+import PointsValueModel from "./PointsValueModel";
 export default class PointsModel {
     general: Points[];
     comments: any[];
-    predictor: ActionValueModel[];
-    activity: ActionValueModel[];
-    topX: ActionValueModel[];
+    predictor: PointsValueModel[];
+    activity: PointsValueModel[];
+    topX: PointsValueModel[];
+    matchQuiz: PointsValueModel[];
 }

package/Core/Namespaces/Loyalty/Models/Points/PointsValueModel.d.ts

@@ -0,0 +1,5 @@
+import ActionValueModel from "../Actions/ActionValueModel";
+export default class PointsValueModel extends ActionValueModel {
+    points: number;
+    constructor();
+}

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

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

package/Core/Namespaces/MatchQuiz/Models/Games/GamesMatchQuizListModel.d.ts

@@ -8,6 +8,7 @@ export default class GamesMatchQuizListModel {
     outcome: string;
     predictionsCutoff: string;
     fixtures: FixturesMatchQuizModel[];
+    predictionId: string;
     rules: string;
     flags: string[];
     points: number;

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

@@ -13,7 +13,7 @@ export default class PredictorFacade {
     readonly clientHttps: ClientHttps;
     readonly idMapping: IdMappingService;
     readonly predictorService: PredictorService;
-    readonly invalidPredictionMessage = "The prediction is invalid. Please check again have you passed appropriate prediction argument. For more information visit our official documentation: \n https://docs.fansunitedmedia.com/sdks/js/predictor#matchrelatedoperations";
+    private predictorValidator;
     constructor(config: SDKConfigurationModel, predictorHttps: PredictorHttps, clientHttps: ClientHttps, idMapping: IdMappingService);
     /**
     * Exposing PredictorService for two operations:

package/Core/Namespaces/Predictor/Models/Fixtures/Markets/CorrectScoreFixtureModel.d.ts

@@ -4,6 +4,7 @@ import FixturesModel from "../FixturesModel";
 export default class CorrectScoreFixtureModel implements FixturesModel {
     matchId: string;
     market: MarketEnum;
+    matchType: string;
     prediction: ValueCorrectScore;
     constructor(matchId: string, value: string);
 }

package/Core/Namespaces/Predictor/Models/Fixtures/Markets/{FullTimeOneXTwoFixtureModel.d.ts → OneXTwoFixtureModel.d.ts}

@@ -2,9 +2,9 @@ import FixturesModel from "../FixturesModel";
 import ValueOneXTwo from "../../Value/ValueOneXTwo";
 import { MarketEnum } from "../../../Enums/MarketEnum";
 import { OneXTwoEnum } from "../../../Enums/ValueEnums";
-export default class FullTimeOneXTwoFixtureModel implements FixturesModel {
+export default class OneXTwoFixtureModel implements FixturesModel {
     matchId: string;
     market: MarketEnum;
     prediction: ValueOneXTwo;
-    constructor(matchId: string, value: OneXTwoEnum);
+    constructor(matchId: string, market: MarketEnum, value: OneXTwoEnum);
 }

package/Core/Namespaces/Predictor/Service/PredictorService.d.ts

@@ -1,19 +1,6 @@
 import { MarketEnum } from "../Enums/MarketEnum";
 import IdMappingService from "../../../IdMapping/IdMappingService";
 import PredictionsModel from "../Models/Predictions/PredictionsModel";
-import HalfTimeFullTimeFixtureModel from "../Models/Fixtures/Markets/HalfTimeFullTimeFixtureModel";
-import DoubleChanceFixtureModel from "../Models/Fixtures/Markets/DoubleChanceFixtureModel";
-import FullTimeOneXTwoFixtureModel from "../Models/Fixtures/Markets/FullTimeOneXTwoFixtureModel";
-import CorrectScoreFixtureModel from "../Models/Fixtures/Markets/CorrectScoreFixtureModel";
-import HalfTimeOneXTwoFixtureModel from "../Models/Fixtures/Markets/HalfTimeOneXTwoFixtureModel";
-import CornersFixtureModel from "../Models/Fixtures/Markets/CornersFixtureModel";
-import PlayerFixtureModel from "../Models/Fixtures/Markets/PlayerFixtureModel";
-import BothTeamsFixtureModel from "../Models/Fixtures/Markets/BothTeamsFixtureModel";
-import RedCardFixtureModel from "../Models/Fixtures/Markets/RedCardFixtureModel";
-import PenaltyMatchFixtureModel from "../Models/Fixtures/Markets/PenaltyMatchFixtureModel";
-import OverGoalsFixtureModel from "../Models/Fixtures/Markets/OverGoalsFixtureModel";
-import OverCornersFixtureModel from "../Models/Fixtures/Markets/OverCornersFixtureModel";
-import MatchSummaryModel from "../Models/Summary/MatchSummaryModel";
 import SDKConfigurationModel from "../../../Configurator/Models/SDKConfiguraitonModel";
 import PredictionsFilters from "../Models/Predictions/PredictionsFilters";
 import { TypeGames } from "../../TopX/Types/TypeGames";
@@ -21,6 +8,7 @@ import GamesFilters from "../../TopX/Models/Games/GamesFilters";
 import PaginationModel from "../../../Global/Models/Pagination/PaginationModel";
 import { FeaturesConfigModels, FilterCase } from "../../../Global/Types/GlobalTypes";
 import GameMarketsResults from "../../MatchQuiz/Models/GameMarketsResults/GameMarketsResults";
+import MatchSummaryModel from "../Models/Summary/MatchSummaryModel";
 export default class PredictorService {
     private footballHttps;
     private idMapping;
@@ -48,12 +36,6 @@ export default class PredictorService {
      * @returns Market that fits response model
      */
     convertMarketForResponseModel: (market: any, target: number) => string;
-    /**
-     * Checks market of the fixture and returns new object type.
-     * @param fixture
-     * @returns Fixture model.
-     */
-    validateFixture: (matchId: string, market: MarketEnum, value: any, playerId?: string) => PlayerFixtureModel | CorrectScoreFixtureModel | OverCornersFixtureModel | OverGoalsFixtureModel | HalfTimeFullTimeFixtureModel | DoubleChanceFixtureModel | FullTimeOneXTwoFixtureModel | HalfTimeOneXTwoFixtureModel | CornersFixtureModel | BothTeamsFixtureModel | RedCardFixtureModel | PenaltyMatchFixtureModel;
     getMarketSummary: (matchSummary: MatchSummaryModel, market: MarketEnum, playerId?: string) => any;
     remapCompetitionsFromConfig: (config: FeaturesConfigModels) => Promise<FeaturesConfigModels>;
     /**

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

@@ -0,0 +1,111 @@
+import { MarketEnum } from "../Enums/MarketEnum";
+import BothTeamsFixtureModel from "../Models/Fixtures/Markets/BothTeamsFixtureModel";
+import CornersFixtureModel from "../Models/Fixtures/Markets/CornersFixtureModel";
+import CorrectScoreFixtureModel from "../Models/Fixtures/Markets/CorrectScoreFixtureModel";
+import DoubleChanceFixtureModel from "../Models/Fixtures/Markets/DoubleChanceFixtureModel";
+import OneXTwoFixtureModel from "../Models/Fixtures/Markets/OneXTwoFixtureModel";
+import HalfTimeFullTimeFixtureModel from "../Models/Fixtures/Markets/HalfTimeFullTimeFixtureModel";
+import OverCornersFixtureModel from "../Models/Fixtures/Markets/OverCornersFixtureModel";
+import OverGoalsFixtureModel from "../Models/Fixtures/Markets/OverGoalsFixtureModel";
+import PenaltyMatchFixtureModel from "../Models/Fixtures/Markets/PenaltyMatchFixtureModel";
+import PlayerFixtureModel from "../Models/Fixtures/Markets/PlayerFixtureModel";
+import RedCardFixtureModel from "../Models/Fixtures/Markets/RedCardFixtureModel";
+import PredictionRequestModel from "../Models/Predictions/PredictionRequestModel";
+import { TypeGames } from "../../TopX/Types/TypeGames";
+import TopXPredictionRequestModel from "../../TopX/Models/Prediction/TopXPredictionRequestModel";
+export default class PredictorValidator {
+    /**
+     * 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)
+     * 2. Validates tiebreak if is provided (Top X)
+     * 3. Validates missing required fields for game request body
+     * 4. Validates fixtures
+     * @param gameType MATCH_QUIZ, TOP_X and SINGLE. In our case we will use only MATCH_QUIZ and TOP_X.
+     * @param param Game request body.
+     * @returns Game request body if is valid. If not throws specific message.
+     */
+    validateBodyFields: (gameType: TypeGames, param: PredictionRequestModel | TopXPredictionRequestModel) => PredictionRequestModel | TopXPredictionRequestModel;
+    /**
+     * Constructs object types for specific markets. This is done for easier reconstructing when sending the request
+     * body to API. Validates the following cases:
+     * 1. Market is valid.
+     * 2. Prediction is a valid one for the specific market
+     * 3. Regex test for CORRECT_SCORE market prediction (String(int:int))
+     * 4. Validates playerId except for nobody market (PLAYER_SCORE_FIRST_GOAL)
+     * @param matchId Match ID to predict.
+     * @param market Market to predict
+     * @param prediction The value of prediction.
+     * @param playerId Optional. Used only for player markets.
+     * @returns Specific type of fixture.
+     */
+    validateFixture: (matchId: string, market: MarketEnum, prediction: any, playerId?: string) => PlayerFixtureModel | CorrectScoreFixtureModel | OverCornersFixtureModel | OverGoalsFixtureModel | BothTeamsFixtureModel | CornersFixtureModel | DoubleChanceFixtureModel | OneXTwoFixtureModel | HalfTimeFullTimeFixtureModel | PenaltyMatchFixtureModel | RedCardFixtureModel;
+    /**
+     * Validate fixture fields. Throws exception for the following cases:
+     * 1. When invalid field is provided
+     * 2. When required field is missing
+     * @param fixture Fixture fields to validate.
+     */
+    private validateFixtureFields;
+    /**
+     * Validates tiebreaker if provided (Top X). Throws exception for the following cases:
+     * 1. If tiebreaker is not an object
+     * 2. If the keys in tiebreaker object are incorrect
+     * 3. If the required key is missing
+     * 4. If the required key is invalid type
+     * @param tiebreaker Tiebreaker for Top X prediciton.
+     */
+    private validateTiebreaker;
+    /**
+     * Validates prediction in every fixture. Throws for the following cases:
+     * 1. When prediction is rather than object type
+     * 2. When field 'value' is missing
+     * 3. When field rather than 'value' is provided
+     * 4. When invalid fields are provided
+     * @param market Market of fixture
+     * @param prediction Prediction of fixture
+     */
+    private validatePredictionKey;
+    /**
+     * Validates player ID for all related player markets EXCEPT PLAYER_SCORE_FIRST_GOAL. The following cases are covered:
+     * 1. playerId is falsy value
+     * 2. playerId is invalid type
+     * @param market Player market.
+     * @param playerId Player ID.
+     */
+    private validatePlayerId;
+    /**
+     * Validates the market of every fixture. The market should contain in the enumerated list.
+     * @param market Market of fixture.
+     */
+    private validateMarket;
+    /**
+     * Validates the market for Top X Game.
+     */
+    private validateMarketTopX;
+    /**
+     * Used for type check for prediction field in fixture.
+     * @param prediction Fixture's prediction
+     * @returns True or false.
+     */
+    private isPredictionBoolean;
+    /**
+     * Throws exception for invalid prediction for specific market.
+     */
+    private throwInvalidPredictionException;
+    /**
+     * Throws exception when provided market is not supported from Fans United.
+     */
+    private throwInvalidMarketException;
+    /**
+     * Throws exception for invalid fields.
+     */
+    private throwInvalidParamException;
+    /**
+     * Throws exception for missing fields.
+     */
+    private throwMissingFieldsException;
+    /**
+     * Throws exception for field invalid type.
+     */
+    private throwInvalidType;
+}

package/Core/Namespaces/Profile/Builders/OwnProfileBuilder.d.ts

@@ -17,7 +17,6 @@ export default class OwnProfileBuilder {
     private profileService;
     private localStorage;
     private profileFacade;
-    private interestsService;
     private ownProfile;
     private modified;
     private expireAt;
@@ -29,7 +28,7 @@ export default class OwnProfileBuilder {
     private setOwnProfile;
     getInfo: () => Promise<ProfileModel>;
     showInterests: () => Promise<InterestModel[]>;
-    showFullInterests: () => Promise<any[]>;
+    showFullInterests: () => Promise<InterestModel[]>;
     getFollowers: (filters?: FollowFilters) => Promise<PaginationModel>;
     getFollowing: (filters?: FollowFilters) => Promise<PaginationModel>;
     follow: (profiles: string[]) => Promise<FollowingModel[]>;

package/Core/Namespaces/Profile/Builders/ProfileBuilder.d.ts

@@ -3,8 +3,6 @@ import PaginationModel from "../../../Global/Models/Pagination/PaginationModel";
 import SDKIdsRemapper from "../../../Remapper/SDKIdsRemapper";
 import ActivityHttps from "../../../Https/ActivityHttps";
 import ProfileHttps from "../../../Https/ProfileHttps";
-import IdMappingService from "../../../IdMapping/IdMappingService";
-import FootballFacade from "../../Football/Facades/FootballFacade";
 import FollowFilters from "../Models/FollowFilters";
 import FullnessProfile from "../Models/FullnessProfile/FullnessProfile";
 import InterestModel from "../Models/InterestModel";
@@ -15,14 +13,13 @@ export default class ProfileBuilder {
     private profileHttps;
     private activityHttps;
     private profileFacade;
-    private interestsService;
     private profileId;
-    constructor(idsRemapper: SDKIdsRemapper, localStorage: LocalStorage, profileHttps: ProfileHttps, activityHttps: ActivityHttps, idMapping: IdMappingService, footballFacade: FootballFacade);
+    constructor(idsRemapper: SDKIdsRemapper, localStorage: LocalStorage, profileHttps: ProfileHttps, activityHttps: ActivityHttps);
     setId: (id: string) => this;
     private getProfile;
     getInfo: () => Promise<ProfileModel>;
     showInterests: () => Promise<InterestModel[]>;
-    showFullInterests: () => Promise<any[]>;
+    showFullInterests: () => Promise<InterestModel[]>;
     getFollowers: (filters?: FollowFilters) => Promise<PaginationModel>;
     getFollowing: (filters?: FollowFilters) => Promise<PaginationModel>;
     showFullnessProfile: () => Promise<FullnessProfile>;

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

@@ -10,10 +10,12 @@ import TopXPredictionRequestModel from "../Models/Prediction/TopXPredictionReque
 import PredictionsFilters from "../../Predictor/Models/Predictions/PredictionsFilters";
 import { FeaturesConfigModels } from "../../../Global/Types/GlobalTypes";
 import GameMarketsResults from "../../MatchQuiz/Models/GameMarketsResults/GameMarketsResults";
+import PredictorValidator from "../../Predictor/Validator/PredictorValidator";
 export default class TopXFacade {
     readonly idMapping: IdMappingService;
     readonly predictorHttps: PredictorHttps;
     readonly predictorService: PredictorService;
+    readonly predictorValidator: PredictorValidator;
     private clientHttps;
     constructor(config: SDKConfigurationModel, idMapping: IdMappingService);
     getConfig: () => Promise<FeaturesConfigModels>;

package/Core/Namespaces/TopX/Models/Games/GamesTopXListModel.d.ts

@@ -8,6 +8,7 @@ export default class GamesTopXListModel {
     outcome: string;
     predictionsCutoff: string;
     fixtures: FixturesTopXModel[];
+    predictionId: string;
     rules: string;
     flags: string[];
     points: number;

package/Core/Remapper/Profile/ProfileOperations.d.ts

@@ -42,11 +42,30 @@ export default class ProfileOperations {
     remapInterestToNative: (interest: InterestModel) => Promise<InterestModel>;
     /**
      * Extracting custom interests from list of interests in profile.
+     * @param interests
+     * @returns Custom interests.
+     */
+    private inquiryCustomInterests;
+    /**
      * We are using this function when we want to show interests from profile.
      * @param interests
      * @returns Utilizing @function remapInterestsToIdSchema for remapping to idSchema.
      */
-    inquiryCustomInterests: (interests: InterestModel[]) => Promise<InterestModel[]>;
+    remapInterests: (interests: InterestModel[]) => Promise<InterestModel[]>;
+    /**
+     * In case we have custom interest we don't remap the id. When the id for the entity is not remaped successfully or
+     * is not found in Football API, the model is set to null.
+     * @param interests
+     * @returns Details for each interest in profile
+     */
+    showFullInterests: (interests: InterestModel[]) => Promise<any[]>;
+    /**
+     * Using FootballFacade to get information for teams, players or competitions with remapped ids.
+     * Fetch entities models from Football Facade and return them as type: { entityId: model }.
+     * @param interests Profile interests containing entitie native ids.
+     * @returns A Map value of key entity native ID and value entity model.
+     */
+    private getInterestsEntitiesMap;
     /**
      * Calls id mapping facade to fetch id entities from storage or Id Mapping API.
      * @param idsObj Object which key is entity and value is string array of ids.

package/Core/Remapper/SDKIdsRemapper.d.ts

@@ -8,5 +8,6 @@ export default class SDKIdsRemapper {
     constructor(config: SDKConfigurationModel, footballFacade: FootballFacade);
     remapSuccessRatesEntities: (profileStats: ProfileStatsModel) => Promise<ProfileStatsModel>;
     remapInterestToNative: (interest: InterestModel) => Promise<InterestModel>;
-    inquiryCustomInterests: (interests: InterestModel[]) => Promise<InterestModel[]>;
+    remapInterests: (interests: InterestModel[]) => Promise<InterestModel[]>;
+    showFullInterests: (interests: InterestModel[]) => Promise<InterestModel[]>;
 }