Merge pull request #15 from martinsileno/season-state

Add typing for seasonState attribute added in PUBG API v6.0.0

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pubg-typescript-api",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "TypeScript wrapper on the official PUBG API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

src/entities/match.spec.ts

@@ -1,7 +1,7 @@
 import { expect } from 'chai';
 import 'mocha';
 
-import { DeathType, GameMode, IMatch, MapName, PlatformRegion } from '..';
+import { DeathType, GameMode, IMatch, MapName, PlatformRegion, SeasonState } from '..';
 
 import { Asset } from './asset';
 import { Match } from './match';
@@ -20,7 +20,7 @@ const API_RESPONSE: IMatch = {
       "gameMode": "duo-fpp",
       "isCustomMatch": false,
       "mapName": "Desert_Main",
-      "seasonState": "",
+      "seasonState": "progress",
       "shardId": "pc-eu",
       "stats": null,
       "tags": null,
@@ -685,7 +685,7 @@ describe('Match entity', () => {
     expect(match.isCustomMatch).to.be.false;
     expect(match.map).to.equal(MapName.DESERT_MAIN);
     expect(match.patchVersion).to.be.an('undefined');
-    expect(match.seasonState).to.equal('');
+    expect(match.seasonState).to.equal(SeasonState.PROGRESS);
     expect(match.shardId).to.equal(PlatformRegion.PC_EU);
   });
 

src/entities/match.ts

@@ -11,6 +11,7 @@ import {
   PlatformRegion,
   PubgAPI,
   Roster,
+  SeasonState,
   Telemetry,
   TelemetryPubgAPI,
 } from '..';
@@ -30,7 +31,7 @@ export class Match {
   private _isCustomMatch: boolean;
   private _map: MapName;
   private _patchVersion: string | undefined;
-  private _seasonState: any;
+  private _seasonState: SeasonState;
   private _shardId: PlatformRegion;
 
   private _participants: Participant[];
@@ -45,7 +46,7 @@ export class Match {
     this._isCustomMatch = matchDetail.data.attributes.isCustomMatch;
     this._map = matchDetail.data.attributes.mapName as MapName;
     this._patchVersion = matchDetail.data.attributes.patchVersion;
-    this._seasonState = matchDetail.data.attributes.seasonState;
+    this._seasonState = matchDetail.data.attributes.seasonState as SeasonState;
     this._shardId = matchDetail.data.attributes.shardId as PlatformRegion;
 
     const participantsMap = new Map<string, Participant>();  // maps participant id to Participant

src/entities/telemetry/events/matchDefinition.ts

@@ -1,18 +1,18 @@
-import { ILogMatchDefinition } from '../../..';
+import { ILogMatchDefinition, SeasonState } from '../../..';
 
 import { TelemetryEvent } from './telemetryEvent';
 
 
 export class MatchDefinition extends TelemetryEvent {
   private _matchId: string;
   private _pingQuality: string;
-  private _seasonState: any;
+  private _seasonState: SeasonState;
 
   constructor(event: ILogMatchDefinition) {
     super(event);
     this._matchId = event.MatchId;
     this._pingQuality = event.PingQuality;
-    this._seasonState = event.SeasonState;
+    this._seasonState = event.SeasonState as SeasonState;
   }
 
   get matchId(): string {
@@ -23,7 +23,7 @@ export class MatchDefinition extends TelemetryEvent {
     return this._pingQuality;
   }
 
-  get seasonState(): any {
+  get seasonState(): SeasonState {
     return this._seasonState;
   }
 }

src/entities/telemetry/telemetry.spec.ts

@@ -1,7 +1,7 @@
 import { expect } from 'chai';
 import 'mocha';
 
-import { ITelemetry, Telemetry } from '../..';
+import { ITelemetry, SeasonState, Telemetry } from '../..';
 
 
 //#region setup
@@ -10,7 +10,7 @@ const API_RESPONSE: ITelemetry = [
   {
     "MatchId": "match.bro.official.2018-04.eu.duo-fpp.2018.04.27.8c1c8a56-4104-46ef-8aec-5e012b041574",
     "PingQuality": "low",
-    "SeasonState": "",
+    "SeasonState": "progress",
     "_D": "2018-04-27T09:14:41.7057369+00:00",
     "_T": "LogMatchDefinition"
   },
@@ -1163,7 +1163,7 @@ describe('Telemetry entity', () => {
     /* tslint:disable-next-line:max-line-length */
     expect(event.matchId).to.equal('match.bro.official.2018-04.eu.duo-fpp.2018.04.27.8c1c8a56-4104-46ef-8aec-5e012b041574');
     expect(event.pingQuality).to.equal('low');
-    expect(event.seasonState).to.equal('');
+    expect(event.seasonState).to.equal(SeasonState.PROGRESS);
     expect(event.dateTime).to.deep.equal(new Date('2018-04-27T09:14:41.7057369+00:00'));
   });
 

src/interfaces/match.ts

@@ -100,7 +100,7 @@ export interface IMatch {
       isCustomMatch: boolean;
       mapName: string;  // XXX: sometimes not returned?
       patchVersion?: '';  // XXX: sometimes not returned?
-      seasonState: any;
+      seasonState: string;
       shardId: string;
       stats: null;
       tags: null;

src/interfaces/telemetry.ts

@@ -125,7 +125,7 @@ export interface ILogMatchDefinition extends IBaseTelemetryEvent {
   _T: 'LogMatchDefinition';
   MatchId: string;
   PingQuality: string;  // PC only
-  SeasonState: any;
+  SeasonState: string;
 }
 
 export interface ILogMatchStart extends ITelemetryEvent {

src/shared/constants.ts

@@ -37,6 +37,12 @@ export enum PlatformRegion {
   KAKAO = 'kakao'
 }
 
+export enum SeasonState {
+  CLOSED = 'closed',
+  PREPARE = 'prepare',
+  PROGRESS = 'progress'
+}
+
 export enum TelemetryEventType {
   LOGPLAYERLOGIN = 'LogPlayerLogin',
   LOGPLAYERCREATE = 'LogPlayerCreate',

src/shared/index.ts

@@ -3,5 +3,6 @@ export {
   GameMode,
   MapName,
   PlatformRegion,
+  SeasonState,
   TelemetryEventType,
 } from './constants';