fpl-api-node - npm Package Compare versions

Comparing version 2.0.0-alpha.5 to 2.0.0-alpha.6

dist/data-service.d.ts

 import * as types from './types';
-export declare function getEntryHistory(entryId: number): Promise<types.EntryHistory>;
-export declare function getEntryEvent(entryId: number, eventNumber: number): Promise<types.EntryEvent>;
+export declare function getEntryHistory(entryId: number): Promise<types.EntryRoot>;
+export declare function getEntryEvent(entryId: number, eventNumber: number): Promise<types.EntryEventRoot>;
 export declare function getEntryTransfers(entryId: number): Promise<types.EntryTransfers>;
 export declare function getTotalEntries(): Promise<number>;
+export declare function getElements(): Promise<types.Player[]>;
 export declare function getElementTypes(): Promise<types.ElementType[]>;
+export declare function getEvents(): Promise<types.Gameweek[]>;
 export declare function getTeams(): Promise<types.Team[]>;
@@ -8,0 +10,0 @@ export declare function getEventLive(eventNumber: number): Promise<types.LiveEvent>;

dist/data-service.js

@@ -26,2 +26,6 @@ "use strict";
 exports.getTotalEntries = getTotalEntries;
+function getElements() {
+    return getData('/elements');
+}
+exports.getElements = getElements;
 function getElementTypes() {
@@ -31,2 +35,6 @@ return getData('/element-types');
 exports.getElementTypes = getElementTypes;
+function getEvents() {
+    return getData('/events');
+}
+exports.getEvents = getEvents;
 function getTeams() {
@@ -33,0 +41,0 @@ return getData('/teams');

dist/index.d.ts

 import * as types from './types';
-export declare function getEntry(entryId: number): Promise<types.Entry>;
-export declare function getEntryEventHistory(entryId: number, eventNumber: number): Promise<types.EntryEventHistory>;
-export declare function getEntryEventPicks(entryId: number, eventNumber: number): Promise<types.EntryPick[]>;
-export declare function getEntryTransferHistory(entryId: number): Promise<types.EntryTransferHistory[]>;
+export declare function findEntry(entryId: number): Promise<types.Entry>;
+export declare function findEntryGameweek(entryId: number, gameweek: number): Promise<types.EntryGameweek>;
+export declare function findEntryPicksByGameweek(entryId: number, gameweek: number): Promise<types.EntryPick[]>;
+export declare function findEntryTransferHistory(entryId: number): Promise<types.EntryTransferHistory[]>;
+export declare function findPlayers(): Promise<types.Player[]>;
+export declare function findPlayer(playerId: number): Promise<types.Player>;
+export declare function findPlayerStatsByGameweek(playerId: number, gameweek: number): Promise<types.PlayerStats>;
+export declare function findGameweeks(): Promise<types.Gameweek[]>;
+export declare function findGameweek(gameweek: number): Promise<types.Gameweek>;
+export declare function findTeams(): Promise<types.Team[]>;
+export declare function findTeam(teamId: number): Promise<types.Team>;
 export declare function getTotalNumberOfEntries(): Promise<number>;
-export declare function getElements(): Promise<types.Element[]>;
-export declare function getElement(id: number): Promise<types.Element>;

dist/index.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var dataService = require("./data-service");
-function getEntry(entryId) {
+function findEntry(entryId) {
     return new Promise(function (resolve, reject) {
@@ -11,6 +11,6 @@ dataService.getEntryHistory(entryId).then(function (data) {
 }
-exports.getEntry = getEntry;
-function getEntryEventHistory(entryId, eventNumber) {
+exports.findEntry = findEntry;
+function findEntryGameweek(entryId, gameweek) {
     return new Promise(function (resolve, reject) {
-        dataService.getEntryEvent(entryId, eventNumber).then(function (data) {
+        dataService.getEntryEvent(entryId, gameweek).then(function (data) {
             resolve(data.entry_history);
@@ -20,6 +20,6 @@ });
 }
-exports.getEntryEventHistory = getEntryEventHistory;
-function getEntryEventPicks(entryId, eventNumber) {
+exports.findEntryGameweek = findEntryGameweek;
+function findEntryPicksByGameweek(entryId, gameweek) {
     return new Promise(function (resolve, reject) {
-        dataService.getEntryEvent(entryId, eventNumber).then(function (data) {
+        dataService.getEntryEvent(entryId, gameweek).then(function (data) {
             resolve(data.picks);
@@ -29,4 +29,4 @@ });
 }
-exports.getEntryEventPicks = getEntryEventPicks;
-function getEntryTransferHistory(entryId) {
+exports.findEntryPicksByGameweek = findEntryPicksByGameweek;
+function findEntryTransferHistory(entryId) {
     return new Promise(function (resolve, reject) {
@@ -38,29 +38,75 @@ dataService.getEntryTransfers(entryId).then(function (data) {
 }
-exports.getEntryTransferHistory = getEntryTransferHistory;
-function getTotalNumberOfEntries() {
+exports.findEntryTransferHistory = findEntryTransferHistory;
+function findPlayers() {
     return new Promise(function (resolve, reject) {
-        dataService.getBootstrapData().then(function (data) {
-            resolve(data['total-players']);
+        dataService.getElements().then(function (data) {
+            resolve(data);
         });
     });
 }
-exports.getTotalNumberOfEntries = getTotalNumberOfEntries;
-function getElements() {
+exports.findPlayers = findPlayers;
+function findPlayer(playerId) {
     return new Promise(function (resolve, reject) {
-        dataService.getBootstrapData().then(function (data) {
-            resolve(data.elements);
+        dataService.getElements().then(function (elements) {
+            var match = elements.find(function (element) {
+                return element.id === playerId;
+            });
+            resolve(match);
         });
     });
 }
-exports.getElements = getElements;
-function getElement(id) {
+exports.findPlayer = findPlayer;
+function findPlayerStatsByGameweek(playerId, gameweek) {
     return new Promise(function (resolve, reject) {
-        getElements().then(function (elements) {
-            var matchedElement = elements.find(function (element) {
-                return element.id === id;
+        dataService.getEventLive(gameweek).then(function (data) {
+            resolve(data.elements[playerId].stats);
+        });
+    });
+}
+exports.findPlayerStatsByGameweek = findPlayerStatsByGameweek;
+function findGameweeks() {
+    return new Promise(function (resolve, reject) {
+        dataService.getEvents().then(function (data) {
+            resolve(data);
+        });
+    });
+}
+exports.findGameweeks = findGameweeks;
+function findGameweek(gameweek) {
+    return new Promise(function (resolve, reject) {
+        dataService.getEvents().then(function (events) {
+            var match = events.find(function (event) {
+                return event.id === gameweek;
             });
-            resolve(matchedElement);
+            resolve(match);
         });
     });
 }
-exports.getElement = getElement;
+exports.findGameweek = findGameweek;
+function findTeams() {
+    return new Promise(function (resolve, reject) {
+        dataService.getTeams().then(function (data) {
+            resolve(data);
+        });
+    });
+}
+exports.findTeams = findTeams;
+function findTeam(teamId) {
+    return new Promise(function (resolve, reject) {
+        dataService.getTeams().then(function (teams) {
+            var match = teams.find(function (team) {
+                return team.id === teamId;
+            });
+            resolve(match);
+        });
+    });
+}
+exports.findTeam = findTeam;
+function getTotalNumberOfEntries() {
+    return new Promise(function (resolve, reject) {
+        dataService.getBootstrapData().then(function (data) {
+            resolve(data['total-players']);
+        });
+    });
+}
+exports.getTotalNumberOfEntries = getTotalNumberOfEntries;

dist/types.d.ts

 export interface BootstrappedData {
     phases: Phase[];
-    elements: Element[];
+    elements: Player[];
     'total-players': number;
     teams: Team[];
     element_types: ElementType[];
-    events: Event[];
+    events: Gameweek[];
 }
-export interface Event {
+export interface Gameweek {
     id: number;
@@ -42,3 +42,3 @@ name: string;
 }
-export interface Element {
+export interface Player {
     id: number;
@@ -218,3 +218,3 @@ photo: string;
 }
-export interface EntryHistory {
+export interface EntryRoot {
     chips: EntryChip[];
@@ -224,7 +224,7 @@ entry: Entry;
     season: EntrySeason[];
-    history: EntryEventHistory[];
+    history: EntryGameweek[];
 }
-export interface EntryEvent {
+export interface EntryEventRoot {
     leagues: EntryLeagues;
-    entry_history: EntryEventHistory;
+    entry_history: EntryGameweek;
     ce: number;
@@ -261,3 +261,3 @@ automatic_subs: EntryAutomaticSub[];
     element_type: number;
-    stats: ElementStats;
+    stats: PlayerStats;
     multiplier: number;
@@ -319,3 +319,3 @@ }
 }
-export interface EntryEventHistory {
+export interface EntryGameweek {
     id: number;
@@ -363,3 +363,3 @@ movement: string;
 }
-export interface ElementStats {
+export interface PlayerStats {
     yellow_cards: number;
@@ -436,5 +436,5 @@ own_goals: number;
             }>;
-            stats: ElementStats;
+            stats: PlayerStats;
         };
     };
 }

package.json

 {
   "name": "fpl-api-node",
-  "version": "2.0.0-alpha.5",
+  "version": "2.0.0-alpha.6",
   "description": "A node wrapper for the Fantasy Premier League (fantasy.premierleague.com) restful web api",
@@ -11,3 +11,3 @@ "main": "dist/index.js",
   "scripts": {
-    "generate-api": "ts-node tasks/api-generator/index.ts",
+    "generateWiki": "ts-node tasks/wiki/src/index.ts",
     "lint": "tslint --project tsconfig.json",
@@ -40,2 +40,3 @@ "test": "mocha -r ts-node/register test/specs.ts --timeout 15000 --slow 0",
     "@types/handlebars": "^4.0.35",
+    "@types/lodash": "^4.14.73",
     "@types/mocha": "^2.2.41",
@@ -45,2 +46,3 @@ "@types/node-cache": "^4.1.0",
     "handlebars": "^4.0.10",
+    "lodash": "^4.17.4",
     "mocha": "^3.4.2",
@@ -47,0 +49,0 @@ "ts-node": "^3.3.0",

README.md

@@ -5,6 +5,4 @@ # fpl-api-node (Season 2017-18)
 
-**Please note this library is currently being re-written in anticipation for the 2017-2018 season.**
+A simple node API wrapper for the Fantasy Premier League (fantasy.premierleague.com) web apis. 
 
-A node API wrapper for the Fantasy Premier League (fantasy.premierleague.com) web apis. 
-
 ## Installation
@@ -21,9 +19,8 @@
 
-fplapi.getEntry(entryId).then( data => doSomething(data) );
+fplapi.findEntry(entryId).then((data) => console.log(data));
 ```
 
-## Methods
+## Documentation
 
-API to follow shortly
+Please refer to the [Wiki for API docs](https://github.com/tgreyuk/fpl-api-node/wiki/API).
 
-<!--Please read [API documentation](API.md) for available methods.-->

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

21435

increased by10.7%

Lines of code

650

increased by10.36%

Number of medium supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

13

increased by18.18%

Number of lines in readme file

25

decreased by-7.41%

No dependency changes