fansunited-sdk-esm 1.41.0 → 1.42.0

package/Core/Global/Factories/LocalInstanceFactory.d.ts

@@ -0,0 +1,4 @@
+import { LocalCacheInterface } from "../Interfaces/GlobalInterfaces";
+export default class LocalCacheInstanceFactory {
+    createLocalCacheInstance: (idSchema: string) => LocalCacheInterface;
+}

package/Core/Global/Interfaces/GlobalInterfaces.d.ts

@@ -1,3 +1,42 @@
+import IdMappingModel from "../../IdMapping/Models/IdMappingModel";
+import CompetitionBasicModel from "../../Namespaces/Football/Models/Competition/CompetitionBasicModel";
+import CompetitionFilters from "../../Namespaces/Football/Models/Competition/CompetitionFilters";
+import FootballCountryModel from "../../Namespaces/Football/Models/Country/FootballCountryModel";
+import ProfileCountryModel from "../../Namespaces/Profile/Models/ProfileCountryModel";
+import ProfileModel from "../../Namespaces/Profile/Models/ProfileModel";
+import ProfileStatsModel from "../../Namespaces/Profile/Models/Stats/ProfileStatsModel";
+import { ExpirationType } from "../LocalStorage";
 export interface FiltersInterface {
     constructFiltersUrl?: () => string;
 }
+export interface LocalCacheInterface {
+    clearData: () => void;
+    getEntityById: (ids: string | string[], type: string, schema: string) => IdMappingModel;
+    getEntity: (ids: string | string[], type: string, schema: string) => IdMappingModel | IdMappingModel[];
+    getIdsByType: (typeIdsObj: any, configSchema: string, toSchema: string) => any;
+    checkForExistingIdObjs: (idsObj: any, toSchema: string) => any;
+    addIdMapping: (idMapping: IdMappingModel) => void;
+    addIdMappings: (idMappings: IdMappingModel[]) => void;
+    addTopIdMappings: (topIdMappings: IdMappingModel[]) => void;
+    setOwnProfile: (profile: ProfileModel) => void;
+    getOwnProfile: () => ProfileModel;
+    getProfileCountries: () => ProfileCountryModel[];
+    setProfileCountries: (countries: ProfileCountryModel[]) => void;
+    getProfileStats: () => ProfileStatsModel;
+    setProfileStats: (stats: ProfileStatsModel) => void;
+    getProfileBadges: () => string[];
+    setProfileBadges: (badges: string[]) => void;
+    getFootballCountries: () => FootballCountryModel[];
+    setFootballCountries: (countries: FootballCountryModel[]) => void;
+    getCompetitions: (filters?: CompetitionFilters) => CompetitionBasicModel[];
+    setCompetitions: (competitions: CompetitionBasicModel[]) => void;
+    getCompetitionsLength: () => number;
+    getClientFeatures: () => {
+        [key: string]: any;
+    };
+    setClientFeatures: (features: {
+        [key: string]: any;
+    }) => void;
+    deleteClientFeatures: () => void;
+    getExpiration: (namespace: string, type: ExpirationType) => number;
+}

package/Core/Global/LocalStorage.d.ts

@@ -1,4 +1,3 @@
-import SDKConfigurationModel from "../Configurator/Models/SDKConfiguraitonModel";
 import ProfileModel from "../Namespaces/Profile/Models/ProfileModel";
 import FootballCountryModel from "../Namespaces/Football/Models/Country/FootballCountryModel";
 import ProfileCountryModel from "../Namespaces/Profile/Models/ProfileCountryModel";
@@ -6,18 +5,19 @@ import CompetitionBasicModel from "../Namespaces/Football/Models/Competition/Com
 import CompetitionFilters from "../Namespaces/Football/Models/Competition/CompetitionFilters";
 import ProfileStatsModel from "../Namespaces/Profile/Models/Stats/ProfileStatsModel";
 import IdMappingModel from "../IdMapping/Models/IdMappingModel";
-export type ExparationType = "profile" | "statistics" | "badges" | "features" | "ids";
-export default class LocalStorage {
+import { LocalCacheInterface } from "./Interfaces/GlobalInterfaces";
+export type ExpirationType = "profile" | "statistics" | "badges" | "features" | "ids";
+export default class LocalStorage implements LocalCacheInterface {
     private idSchema;
     readonly expirationProfileTimeout: number;
     readonly expirationBadgesTimeout: number;
     readonly expirationClientFeaturesTimeout: number;
     readonly expirationFootballIdsTimeout: number;
-    constructor(configuration: SDKConfigurationModel);
+    constructor(idSchema: string);
     clearData: () => void;
     getEntityById: (type?: string, id?: string) => any;
     getEntity: (ids: string | string[], type: string, schema: string) => any;
-    getEntityByNativeId: (type?: string, id?: string) => any;
+    private getEntityByNativeId;
     /**
      * Returns the ids as object {id: <entity id>, exists: true/false};
      * @param idsObj
@@ -50,7 +50,7 @@ export default class LocalStorage {
         [key: string]: any;
     }) => void;
     deleteClientFeatures: () => void;
-    getExpiration: (namespace: string, type: ExparationType) => number;
+    getExpiration: (namespace: string, type: ExpirationType) => number;
     /**
      * The purpose of this method is to avoid the posibility of having same competitions store in Local Storage.
      * @param competitions Cached competitions.

package/Core/Global/ServerSideCache.d.ts

@@ -0,0 +1,51 @@
+import { LocalCacheInterface } from "./Interfaces/GlobalInterfaces";
+import ProfileModel from "../Namespaces/Profile/Models/ProfileModel";
+import IdMappingModel from "../IdMapping/Models/IdMappingModel";
+import CompetitionBasicModel from "../Namespaces/Football/Models/Competition/CompetitionBasicModel";
+import FootballCountryModel from "../Namespaces/Football/Models/Country/FootballCountryModel";
+import ProfileStatsModel from "../Namespaces/Profile/Models/Stats/ProfileStatsModel";
+import ProfileCountryModel from "../Namespaces/Profile/Models/ProfileCountryModel";
+import { ExpirationType } from "./LocalStorage";
+import CompetitionFilters from "../Namespaces/Football/Models/Competition/CompetitionFilters";
+/**
+ * TODO: As for now all data that is fetched from the memory cache has to be cast to concrete type.
+ * There is an open PR with a solution to set the value type of the NodeCache class.
+ * https://github.com/node-cache/node-cache/issues/273
+ */
+export default class ServerSideCache implements LocalCacheInterface {
+    private static instance;
+    private static nodeCache;
+    private readonly profileTTL;
+    private readonly clientTTL;
+    private readonly profileBadgesTTL;
+    private idMappingsExpiration;
+    private idSchema;
+    private constructor();
+    static getInstance(idSchema: string): ServerSideCache;
+    clearData: () => void;
+    getEntityById: (type: string, id: string) => IdMappingModel;
+    getEntity: (ids: string | string[], type: string, schema: string) => IdMappingModel | IdMappingModel[];
+    checkForExistingIdObjs: (idsObj: any, toSchema: string) => {};
+    getIdsByType: (typeIdsObj: any, configSchema: string, toSchema: string) => {};
+    addIdMapping: (idMapping: IdMappingModel) => void;
+    addIdMappings: (idMappings: IdMappingModel[]) => void;
+    addTopIdMappings: (topIdMappings: IdMappingModel[]) => void;
+    setOwnProfile: (profile: ProfileModel) => boolean;
+    getOwnProfile: () => ProfileModel;
+    getProfileCountries: () => ProfileCountryModel[];
+    setProfileCountries: (profileCountries: ProfileCountryModel[]) => boolean;
+    getProfileStats: () => ProfileStatsModel;
+    setProfileStats: (profileStats: ProfileStatsModel) => boolean;
+    getProfileBadges: () => string[];
+    setProfileBadges: (badges: string[]) => void;
+    getFootballCountries: () => FootballCountryModel[];
+    setFootballCountries: (footballCountries: FootballCountryModel[]) => boolean;
+    getCompetitions: (filters?: CompetitionFilters) => any[];
+    setCompetitions: (competitions: CompetitionBasicModel[]) => boolean;
+    getCompetitionsLength: () => number;
+    getClientFeatures: () => unknown;
+    setClientFeatures: (features: Object) => boolean;
+    deleteClientFeatures: () => number;
+    getExpiration: (namespace: string, type: ExpirationType) => number;
+    private getKeyFromExpirationType;
+}

package/Core/IdMapping/IdMappingFacade.d.ts

@@ -1,11 +1,10 @@
 import SDKConfigurationModel from "../Configurator/Models/SDKConfiguraitonModel";
 export default class IdMappingFacade {
-    private isBrowser;
-    private localStorage;
+    private localCache;
     private https;
     constructor(configuration: SDKConfigurationModel);
     getEntitiesByIds: (idsObj: any, configSchema?: string, toSchema?: string) => Promise<any>;
-    getEntityById: (ids: string | string[], type: string, schemaId: string) => Promise<any>;
+    getEntityById: (ids: string | string[], type: string, schemaId: string) => Promise<any[] | import("./Models/IdMappingModel").default>;
     /**
      * Checks ids if they exist in the local storage, this function requires the already checked ids object
      * @param checkedIdsObj

package/Core/IdMapping/IdMappingService.d.ts

@@ -4,7 +4,7 @@ export default class IdMappingService {
     readonly idSchema: string;
     readonly idMappingFacade: IdMappingFacade;
     constructor(configuration: SDKConfigurationModel);
-    getEntityIdBySchemaId: (type: string, id: string) => Promise<any>;
+    getEntityIdBySchemaId: (type: string, id: string) => Promise<any[] | import("./Models/IdMappingModel").default>;
     remapEntities: (entities: any, type: string) => Promise<any>;
     getEntityIdsBySchemaId: (ids: string[], type: string, toSchema?: string) => Promise<any>;
 }

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

@@ -1,15 +1,14 @@
-import LocalStorage from "../../../Global/LocalStorage";
 import FootballHttps from "../../../Https/FootballHttps";
 import IdMappingService from "../../../IdMapping/IdMappingService";
 import CompetitionBasicModel from "../Models/Competition/CompetitionBasicModel";
 import CompetitionFullModel from "../Models/Competition/CompetitionFullModel";
 import CompetitionFilters from "../Models/Competition/CompetitionFilters";
+import { LocalCacheInterface } from "../../../Global/Interfaces/GlobalInterfaces";
 export default class CompetitionsFacade {
-    private isBrowser;
     private localStorage;
     private https;
     private idMapping;
-    constructor(localStorage: LocalStorage, https: FootballHttps, idMapping: IdMappingService);
+    constructor(localStorage: LocalCacheInterface, https: FootballHttps, idMapping: IdMappingService);
     getCompetitionsIdMapping: (filters?: CompetitionFilters, disableCache?: boolean) => Promise<CompetitionBasicModel[]>;
     getCompetitionsMapWithNativeIds: (competitionIds: string[]) => Promise<Map<string, CompetitionBasicModel>>;
     private getCompetitions;

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

@@ -1,13 +1,12 @@
-import LocalStorage from "../../../Global/LocalStorage";
+import { LocalCacheInterface } from "../../../Global/Interfaces/GlobalInterfaces";
 import FootballHttps from "../../../Https/FootballHttps";
 import IdMappingService from "../../../IdMapping/IdMappingService";
 import FootballCountryModel from "../Models/Country/FootballCountryModel";
 export default class CountriesFacade {
-    private isBrowser;
-    private localStorage;
+    private localCache;
     private https;
     private idMapping;
-    constructor(localStorage: LocalStorage, https: FootballHttps, idMapping: IdMappingService);
+    constructor(localCache: LocalCacheInterface, https: FootballHttps, idMapping: IdMappingService);
     getCountriesWithIdMapping: (disableCache?: boolean) => Promise<FootballCountryModel[]>;
     private getCountries;
 }

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

@@ -1,4 +1,3 @@
-import LocalStorage from "../../../Global/LocalStorage";
 import FootballHttps from "../../../Https/FootballHttps";
 import IdMappingService from "../../../IdMapping/IdMappingService";
 import CompetitionsFacade from "./CompetitionsFacade";
@@ -21,6 +20,7 @@ import SearchFilters from "../Models/Search/SearchFilters";
 import FootballPaginationModel from "../Models/Pagination/FootballPaginationModel";
 import SDKConfigurationModel from "../../../Configurator/Models/SDKConfiguraitonModel";
 import PlayerBasicModel from "../Models/Player/PlayerBasicModel";
+import { LocalCacheInterface } from "../../../Global/Interfaces/GlobalInterfaces";
 export default class FootballFacade {
     private countriesFacade;
     competitionsFacade: CompetitionsFacade;
@@ -28,7 +28,7 @@ export default class FootballFacade {
     playerFacade: PlayerFacade;
     private matchFacade;
     private searchFacade;
-    constructor(config: SDKConfigurationModel, localStorage: LocalStorage, https: FootballHttps, idMapping: IdMappingService);
+    constructor(config: SDKConfigurationModel, localCache: LocalCacheInterface, https: FootballHttps, idMapping: IdMappingService);
     getCountries: (disableCache?: boolean) => Promise<FootballCountryModel[]>;
     getCompetitions: (filters?: CompetitionFilters, disableCache?: boolean) => Promise<CompetitionBasicModel[]>;
     getCompetitionById: (id: string, disableCache?: boolean) => Promise<CompetitionFullModel>;

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

@@ -18,7 +18,7 @@ import FootballPaginationModel from "./Models/Pagination/FootballPaginationModel
 export default class Football {
     private https;
     private idMapping;
-    private localStorage;
+    private localCache;
     footballFacade: FootballFacade;
     constructor(config: SDKConfigurationModel);
     getCountries: (disableCache?: boolean) => Promise<FootballCountryModel[]>;

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

@@ -8,13 +8,13 @@ import { FeaturesConfigModels } from "../../../Global/Types/GlobalTypes";
 import RankingsFilters from "../Models/Filters/RankingsFilters";
 import FootballPaginationModel from "../../Football/Models/Pagination/FootballPaginationModel";
 import ProfileHttps from "../../../Https/ProfileHttps";
-import LocalStorage from "../../../Global/LocalStorage";
 import HighestSuccessRateModel from "../Models/HighestSuccessRate/HighestSuccessRateModel";
 import ContestWinners from "../../TopX/Models/Games/Winners/ContestWinners";
 import EntitiesFollowsFilters from "../Models/Filters/EntitiesFollowsFilters";
 import EntitiesFollows from "../Models/EntitiesFollows/EntitiesFollows";
 import TemplateByIdModel from "../Models/Template/TemplateByIdModel";
 import HighestSuccessRateFilters from "../Models/Filters/HighestSuccessRateFilters";
+import { LocalCacheInterface } from "../../../Global/Interfaces/GlobalInterfaces";
 export default class LoyaltyFacade {
     private config;
     private clientHttps;
@@ -27,7 +27,7 @@ export default class LoyaltyFacade {
     private matchQuizFacade;
     private predictorHttps;
     private errorHandlingMode;
-    constructor(config: SDKConfigurationModel, clientHttps: ClientHttps, loyaltyHttps: LoyaltyHttps, profileHttps: ProfileHttps, localStorage: LocalStorage);
+    constructor(config: SDKConfigurationModel, clientHttps: ClientHttps, loyaltyHttps: LoyaltyHttps, profileHttps: ProfileHttps, localCache: LocalCacheInterface);
     getConfig: () => Promise<FeaturesConfigModels>;
     getClientBadges: () => Promise<ClientBadges>;
     getTemplates: (disableCache?: boolean) => Promise<PaginationModel>;

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

@@ -15,7 +15,7 @@ export default class Loyalty {
     private profileHttps;
     private loyaltyHttps;
     private loyaltyFacade;
-    private localStorage;
+    private localCache;
     constructor(config: SDKConfigurationModel);
     getConfig: () => Promise<FeaturesConfigModels>;
     getClientBadges: () => Promise<ClientBadges>;

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

@@ -1,4 +1,3 @@
-import LocalStorage from "../../../Global/LocalStorage";
 import ProfileHttps from "../../../Https/ProfileHttps";
 import FollowingModel from "../Models/Following/FollowingModel";
 import InterestModel from "../Models/InterestModel";
@@ -10,11 +9,12 @@ import ProfileStatsModel from "../Models/Stats/ProfileStatsModel";
 import ActivityHttps from "../../../Https/ActivityHttps";
 import SDKIdsRemapper from "../../../Remapper/SDKIdsRemapper";
 import { ErrorHandlingModeType } from "../../../Configurator/Types/ConfiguratorTypes";
+import { LocalCacheInterface } from "../../../Global/Interfaces/GlobalInterfaces";
 export default class OwnProfileBuilder {
     private idsRemapper;
     private profileHttps;
     private profileService;
-    private localStorage;
+    private localCache;
     private profileFacade;
     private ownProfile;
     private modified;
@@ -22,7 +22,7 @@ export default class OwnProfileBuilder {
     private promises;
     private isFetching;
     private errorHandlingMode;
-    constructor(idsRemapper: SDKIdsRemapper, localStorage: LocalStorage, profileHttps: ProfileHttps, activityHttps: ActivityHttps, errorHandlingMode: ErrorHandlingModeType);
+    constructor(idsRemapper: SDKIdsRemapper, localCache: LocalCacheInterface, profileHttps: ProfileHttps, activityHttps: ActivityHttps, errorHandlingMode: ErrorHandlingModeType);
     private getOwnProfile;
     private delay;
     private setOwnProfile;

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

@@ -1,4 +1,3 @@
-import LocalStorage from "../../../Global/LocalStorage";
 import PaginationModel from "../../../Global/Models/Pagination/PaginationModel";
 import SDKIdsRemapper from "../../../Remapper/SDKIdsRemapper";
 import ActivityHttps from "../../../Https/ActivityHttps";
@@ -8,13 +7,14 @@ import FullnessProfile from "../Models/FullnessProfile/FullnessProfile";
 import InterestModel from "../Models/InterestModel";
 import ProfileModel from "../Models/ProfileModel";
 import ProfileStatsModel from "../Models/Stats/ProfileStatsModel";
+import { LocalCacheInterface } from "../../../Global/Interfaces/GlobalInterfaces";
 export default class ProfileBuilder {
     private idsRemapper;
     private profileHttps;
     private activityHttps;
     private profileFacade;
     private profileId;
-    constructor(idsRemapper: SDKIdsRemapper, localStorage: LocalStorage, profileHttps: ProfileHttps, activityHttps: ActivityHttps);
+    constructor(idsRemapper: SDKIdsRemapper, localCache: LocalCacheInterface, profileHttps: ProfileHttps, activityHttps: ActivityHttps);
     setId: (id: string) => this;
     private getProfile;
     getInfo: () => Promise<ProfileModel>;

package/Core/Namespaces/Profile/Facade/ProfileFacade.d.ts

@@ -1,4 +1,3 @@
-import LocalStorage from "../../../Global/LocalStorage";
 import ProfileHttps from "../../../Https/ProfileHttps";
 import ProfileModel from "../Models/ProfileModel";
 import ProfileCountryModel from "../Models/ProfileCountryModel";
@@ -8,12 +7,12 @@ import PaginationModel from "../../../Global/Models/Pagination/PaginationModel";
 import ProfileStatsModel from "../Models/Stats/ProfileStatsModel";
 import ActivityHttps from "../../../Https/ActivityHttps";
 import FollowingModel from "../Models/Following/FollowingModel";
+import { LocalCacheInterface } from "../../../Global/Interfaces/GlobalInterfaces";
 export default class ProfileFacade {
-    private isBrowser;
-    private localStorage;
+    private localCache;
     private profileHttps;
     private activityHttps;
-    constructor(localStorage: LocalStorage, profileHttps: ProfileHttps, activityHttps?: ActivityHttps);
+    constructor(localCache: LocalCacheInterface, profileHttps: ProfileHttps, activityHttps?: ActivityHttps);
     getOwn: () => Promise<ProfileModel>;
     updateOwnProfile: () => Promise<ProfileModel>;
     getByIds: (ids: string[], disableCache?: boolean) => Promise<ProfileModel[]>;

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

@@ -8,7 +8,7 @@ export default class Profile {
     private footballHttps;
     private footballFacade;
     private idMapping;
-    private localStorage;
+    private localCache;
     private profileFacade;
     private ownProfileBuilder;
     private profileBuilder;