@crawlora-org/flashscore 0.1.2 → 0.2.0

package/README.md

@@ -1,7 +1,7 @@
 # @crawlora-org/flashscore
 
 JavaScript and TypeScript client for Crawlora's hosted Flashscore API.
-It calls Crawlora's service; it does not run a browser or scrape Flashscore locally. A Crawlora account and `CRAWLORA_API_KEY` are required, and API use is billed under your Crawlora account. Crawlora is independent from and not endorsed by Flashscore or its owners.
+It calls [Crawlora](https://crawlora.net); it does not run a browser or scrape Flashscore locally. A Crawlora account and `CRAWLORA_API_KEY` are required, and API use is billed under your Crawlora account. Crawlora is independent from and not endorsed by Flashscore or its owners.
 
 ## Install
 
@@ -9,14 +9,29 @@ It calls Crawlora's service; it does not run a browser or scrape Flashscore loca
 npm install @crawlora-org/flashscore
 ```
 
+## Get an API key
+
+Create an account at [crawlora.net](https://crawlora.net/signup), then open the [Crawlora console](https://crawlora.net/app) for API-key setup. Set your key in the shell before running the client:
+
+```sh
+export CRAWLORA_API_KEY="your-crawlora-api-key"
+```
+
 ## Use
 
+Save this example as `example.mjs`, then run `node example.mjs` after installing the package and setting your API key.
+
 ```js
+import process from "node:process";
 import { FlashscoreClient } from "@crawlora-org/flashscore";
 
-const client = new FlashscoreClient({ apiKey: process.env.CRAWLORA_API_KEY });
-const result = await client.sports({  });
-console.log(result);
+const apiKey = process.env.CRAWLORA_API_KEY;
+if (!apiKey) throw new Error("Set CRAWLORA_API_KEY before running this example.");
+const client = new FlashscoreClient({ apiKey });
+const result1 = await client.sports({});
+console.log(result1);
+const result2 = await client.scores({ sport: "football", day_offset: 0 });
+console.log(result2);
 ```
 
 The client also exports `Client` as an alias for `FlashscoreClient`. Operation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crawlora-org/flashscore",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "description": "Typed JavaScript client for the Crawlora Flashscore API",
   "homepage": "https://github.com/Crawlora-org/crawlora-flashscore#readme",
   "bugs": { "url": "https://github.com/Crawlora-org/crawlora-flashscore/issues" },

package/src/index.d.ts

@@ -92,18 +92,32 @@ export class FlashscoreClient extends CrawloraClient {
   matchHighlights(params: OperationParamsMap["flashscore-match-highlights"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
   matchInfo(params: OperationParamsMap["flashscore-match-info"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
   matchLineups(params: OperationParamsMap["flashscore-match-lineups"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  matchMissingPlayers(params: OperationParamsMap["flashscore-match-missing-players"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
   matchNews(params: OperationParamsMap["flashscore-match-news"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  matchOdds(params: OperationParamsMap["flashscore-match-odds"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  matchPredictedLineups(params: OperationParamsMap["flashscore-match-predicted-lineups"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
   matchStandings(params: OperationParamsMap["flashscore-match-standings"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
   matchStats(params: OperationParamsMap["flashscore-match-stats"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  matchTv(params: OperationParamsMap["flashscore-match-tv"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
   navigation(params?: OperationParamsMap["flashscore-navigation"], options?: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
   news(params?: OperationParamsMap["flashscore-news"], options?: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
   newsArticle(params: OperationParamsMap["flashscore-news-article"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
   newsCategories(params?: OperationParamsMap["flashscore-news-categories"], options?: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  oddsGeos(params?: OperationParamsMap["flashscore-odds-geos"], options?: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  player(params: OperationParamsMap["flashscore-player"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  playerInjuries(params: OperationParamsMap["flashscore-player-injuries"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  playerTransfers(params: OperationParamsMap["flashscore-player-transfers"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
   rankingCategories(params?: OperationParamsMap["flashscore-ranking-categories"], options?: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
   rankings(params: OperationParamsMap["flashscore-rankings"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
   scores(params: OperationParamsMap["flashscore-scores"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
   search(params: OperationParamsMap["flashscore-search"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
   sports(params?: OperationParamsMap["flashscore-sports"], options?: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  team(params: OperationParamsMap["flashscore-team"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  teamFixtures(params: OperationParamsMap["flashscore-team-fixtures"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  teamNews(params: OperationParamsMap["flashscore-team-news"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  teamResults(params: OperationParamsMap["flashscore-team-results"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  teamSquad(params: OperationParamsMap["flashscore-team-squad"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  teamTransfers(params: OperationParamsMap["flashscore-team-transfers"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
   topSearch(params?: OperationParamsMap["flashscore-top-search"], options?: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
   tournamentEvents(params: OperationParamsMap["flashscore-tournament-events"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
   tournamentSeasons(params: OperationParamsMap["flashscore-tournament-seasons"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
@@ -118,18 +132,32 @@ export class FlashscoreClient extends CrawloraClient {
   matchHighlights(params: OperationParamsMap["flashscore-match-highlights"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
   matchInfo(params: OperationParamsMap["flashscore-match-info"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
   matchLineups(params: OperationParamsMap["flashscore-match-lineups"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  matchMissingPlayers(params: OperationParamsMap["flashscore-match-missing-players"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
   matchNews(params: OperationParamsMap["flashscore-match-news"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  matchOdds(params: OperationParamsMap["flashscore-match-odds"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  matchPredictedLineups(params: OperationParamsMap["flashscore-match-predicted-lineups"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
   matchStandings(params: OperationParamsMap["flashscore-match-standings"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
   matchStats(params: OperationParamsMap["flashscore-match-stats"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  matchTv(params: OperationParamsMap["flashscore-match-tv"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
   navigation(params?: OperationParamsMap["flashscore-navigation"], options?: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
   news(params?: OperationParamsMap["flashscore-news"], options?: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
   newsArticle(params: OperationParamsMap["flashscore-news-article"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
   newsCategories(params?: OperationParamsMap["flashscore-news-categories"], options?: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  oddsGeos(params?: OperationParamsMap["flashscore-odds-geos"], options?: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  player(params: OperationParamsMap["flashscore-player"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  playerInjuries(params: OperationParamsMap["flashscore-player-injuries"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  playerTransfers(params: OperationParamsMap["flashscore-player-transfers"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
   rankingCategories(params?: OperationParamsMap["flashscore-ranking-categories"], options?: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
   rankings(params: OperationParamsMap["flashscore-rankings"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
   scores(params: OperationParamsMap["flashscore-scores"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
   search(params: OperationParamsMap["flashscore-search"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
   sports(params?: OperationParamsMap["flashscore-sports"], options?: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  team(params: OperationParamsMap["flashscore-team"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  teamFixtures(params: OperationParamsMap["flashscore-team-fixtures"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  teamNews(params: OperationParamsMap["flashscore-team-news"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  teamResults(params: OperationParamsMap["flashscore-team-results"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  teamSquad(params: OperationParamsMap["flashscore-team-squad"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  teamTransfers(params: OperationParamsMap["flashscore-team-transfers"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
   topSearch(params?: OperationParamsMap["flashscore-top-search"], options?: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
   tournamentEvents(params: OperationParamsMap["flashscore-tournament-events"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
   tournamentSeasons(params: OperationParamsMap["flashscore-tournament-seasons"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
@@ -147,18 +175,32 @@ export class FlashscoreClient extends CrawloraClient {
   matchHighlights(...args: OperationRequestArgs<"flashscore-match-highlights">): Promise<OperationResponseMap["flashscore-match-highlights"]>;
   matchInfo(...args: OperationRequestArgs<"flashscore-match-info">): Promise<OperationResponseMap["flashscore-match-info"]>;
   matchLineups(...args: OperationRequestArgs<"flashscore-match-lineups">): Promise<OperationResponseMap["flashscore-match-lineups"]>;
+  matchMissingPlayers(...args: OperationRequestArgs<"flashscore-match-missing-players">): Promise<OperationResponseMap["flashscore-match-missing-players"]>;
   matchNews(...args: OperationRequestArgs<"flashscore-match-news">): Promise<OperationResponseMap["flashscore-match-news"]>;
+  matchOdds(...args: OperationRequestArgs<"flashscore-match-odds">): Promise<OperationResponseMap["flashscore-match-odds"]>;
+  matchPredictedLineups(...args: OperationRequestArgs<"flashscore-match-predicted-lineups">): Promise<OperationResponseMap["flashscore-match-predicted-lineups"]>;
   matchStandings(...args: OperationRequestArgs<"flashscore-match-standings">): Promise<OperationResponseMap["flashscore-match-standings"]>;
   matchStats(...args: OperationRequestArgs<"flashscore-match-stats">): Promise<OperationResponseMap["flashscore-match-stats"]>;
+  matchTv(...args: OperationRequestArgs<"flashscore-match-tv">): Promise<OperationResponseMap["flashscore-match-tv"]>;
   navigation(...args: OperationRequestArgs<"flashscore-navigation">): Promise<OperationResponseMap["flashscore-navigation"]>;
   news(...args: OperationRequestArgs<"flashscore-news">): Promise<OperationResponseMap["flashscore-news"]>;
   newsArticle(...args: OperationRequestArgs<"flashscore-news-article">): Promise<OperationResponseMap["flashscore-news-article"]>;
   newsCategories(...args: OperationRequestArgs<"flashscore-news-categories">): Promise<OperationResponseMap["flashscore-news-categories"]>;
+  oddsGeos(...args: OperationRequestArgs<"flashscore-odds-geos">): Promise<OperationResponseMap["flashscore-odds-geos"]>;
+  player(...args: OperationRequestArgs<"flashscore-player">): Promise<OperationResponseMap["flashscore-player"]>;
+  playerInjuries(...args: OperationRequestArgs<"flashscore-player-injuries">): Promise<OperationResponseMap["flashscore-player-injuries"]>;
+  playerTransfers(...args: OperationRequestArgs<"flashscore-player-transfers">): Promise<OperationResponseMap["flashscore-player-transfers"]>;
   rankingCategories(...args: OperationRequestArgs<"flashscore-ranking-categories">): Promise<OperationResponseMap["flashscore-ranking-categories"]>;
   rankings(...args: OperationRequestArgs<"flashscore-rankings">): Promise<OperationResponseMap["flashscore-rankings"]>;
   scores(...args: OperationRequestArgs<"flashscore-scores">): Promise<OperationResponseMap["flashscore-scores"]>;
   search(...args: OperationRequestArgs<"flashscore-search">): Promise<OperationResponseMap["flashscore-search"]>;
   sports(...args: OperationRequestArgs<"flashscore-sports">): Promise<OperationResponseMap["flashscore-sports"]>;
+  team(...args: OperationRequestArgs<"flashscore-team">): Promise<OperationResponseMap["flashscore-team"]>;
+  teamFixtures(...args: OperationRequestArgs<"flashscore-team-fixtures">): Promise<OperationResponseMap["flashscore-team-fixtures"]>;
+  teamNews(...args: OperationRequestArgs<"flashscore-team-news">): Promise<OperationResponseMap["flashscore-team-news"]>;
+  teamResults(...args: OperationRequestArgs<"flashscore-team-results">): Promise<OperationResponseMap["flashscore-team-results"]>;
+  teamSquad(...args: OperationRequestArgs<"flashscore-team-squad">): Promise<OperationResponseMap["flashscore-team-squad"]>;
+  teamTransfers(...args: OperationRequestArgs<"flashscore-team-transfers">): Promise<OperationResponseMap["flashscore-team-transfers"]>;
   topSearch(...args: OperationRequestArgs<"flashscore-top-search">): Promise<OperationResponseMap["flashscore-top-search"]>;
   tournamentEvents(...args: OperationRequestArgs<"flashscore-tournament-events">): Promise<OperationResponseMap["flashscore-tournament-events"]>;
   tournamentSeasons(...args: OperationRequestArgs<"flashscore-tournament-seasons">): Promise<OperationResponseMap["flashscore-tournament-seasons"]>;

package/src/index.js

@@ -9,7 +9,7 @@ import {
 
 export class FlashscoreClient extends CrawloraClient {
   constructor(options = {}) {
-    super({ ...options, userAgent: options.userAgent ?? "crawlora-flashscore-js/0.1.2" });
+    super({ ...options, userAgent: options.userAgent ?? "crawlora-flashscore-js/0.2.0" });
     this["calendar"] = (...args) => this.request("flashscore-calendar", ...args);
     this["calendarCategories"] = (...args) => this.request("flashscore-calendar-categories", ...args);
     this["competitions"] = (...args) => this.request("flashscore-competitions", ...args);
@@ -17,18 +17,32 @@ export class FlashscoreClient extends CrawloraClient {
     this["matchHighlights"] = (...args) => this.request("flashscore-match-highlights", ...args);
     this["matchInfo"] = (...args) => this.request("flashscore-match-info", ...args);
     this["matchLineups"] = (...args) => this.request("flashscore-match-lineups", ...args);
+    this["matchMissingPlayers"] = (...args) => this.request("flashscore-match-missing-players", ...args);
     this["matchNews"] = (...args) => this.request("flashscore-match-news", ...args);
+    this["matchOdds"] = (...args) => this.request("flashscore-match-odds", ...args);
+    this["matchPredictedLineups"] = (...args) => this.request("flashscore-match-predicted-lineups", ...args);
     this["matchStandings"] = (...args) => this.request("flashscore-match-standings", ...args);
     this["matchStats"] = (...args) => this.request("flashscore-match-stats", ...args);
+    this["matchTv"] = (...args) => this.request("flashscore-match-tv", ...args);
     this["navigation"] = (...args) => this.request("flashscore-navigation", ...args);
     this["news"] = (...args) => this.request("flashscore-news", ...args);
     this["newsArticle"] = (...args) => this.request("flashscore-news-article", ...args);
     this["newsCategories"] = (...args) => this.request("flashscore-news-categories", ...args);
+    this["oddsGeos"] = (...args) => this.request("flashscore-odds-geos", ...args);
+    this["player"] = (...args) => this.request("flashscore-player", ...args);
+    this["playerInjuries"] = (...args) => this.request("flashscore-player-injuries", ...args);
+    this["playerTransfers"] = (...args) => this.request("flashscore-player-transfers", ...args);
     this["rankingCategories"] = (...args) => this.request("flashscore-ranking-categories", ...args);
     this["rankings"] = (...args) => this.request("flashscore-rankings", ...args);
     this["scores"] = (...args) => this.request("flashscore-scores", ...args);
     this["search"] = (...args) => this.request("flashscore-search", ...args);
     this["sports"] = (...args) => this.request("flashscore-sports", ...args);
+    this["team"] = (...args) => this.request("flashscore-team", ...args);
+    this["teamFixtures"] = (...args) => this.request("flashscore-team-fixtures", ...args);
+    this["teamNews"] = (...args) => this.request("flashscore-team-news", ...args);
+    this["teamResults"] = (...args) => this.request("flashscore-team-results", ...args);
+    this["teamSquad"] = (...args) => this.request("flashscore-team-squad", ...args);
+    this["teamTransfers"] = (...args) => this.request("flashscore-team-transfers", ...args);
     this["topSearch"] = (...args) => this.request("flashscore-top-search", ...args);
     this["tournamentEvents"] = (...args) => this.request("flashscore-tournament-events", ...args);
     this["tournamentSeasons"] = (...args) => this.request("flashscore-tournament-seasons", ...args);
@@ -46,5 +60,5 @@ export {
   CrawloraServerError
 };
 export { groups, operations, operationCount, OperationIds } from "./operations.js";
-export const VERSION = "0.1.2";
+export const VERSION = "0.2.0";
 export default FlashscoreClient;