@crawlora-org/flashscore 0.1.0

package/src/index.d.ts

@@ -0,0 +1,175 @@
+import type {
+  CrawloraGeneratedGroups,
+  OperationId,
+  OperationParamsMap,
+  OperationRequestArgs,
+  OperationResponseMap
+} from "./types.js";
+
+export type CrawloraParams = Record<string, unknown>;
+export type CrawloraLogEvent = { event: string; [key: string]: unknown };
+export interface CrawloraRequestContext { operationId: string; method: string; url: string; headers: Record<string, string> }
+export type CrawloraBeforeRequest = (ctx: CrawloraRequestContext) => void | Promise<void>;
+export type CrawloraAfterResponse = (operationId: string, status: number, headers: Record<string, string>, body: unknown) => unknown;
+
+export interface CrawloraClientOptions {
+  apiKey?: string;
+  jwtToken?: string;
+  baseUrl?: string;
+  timeout?: number;
+  retries?: number;
+  retryDelay?: number;
+  maxRetryDelay?: number;
+  retryStatuses?: Iterable<number>;
+  isRetryable?: (status: number, error: CrawloraError) => boolean;
+  onRetry?: (attempt: number, error: CrawloraError, delay: number) => void;
+  requestId?: boolean;
+  idempotencyKeys?: boolean;
+  rateLimit?: number;
+  maxConcurrency?: number;
+  logger?: (event: CrawloraLogEvent) => void;
+  beforeRequest?: CrawloraBeforeRequest | Iterable<CrawloraBeforeRequest>;
+  afterResponse?: CrawloraAfterResponse | Iterable<CrawloraAfterResponse>;
+  headers?: Record<string, string>;
+  userAgent?: string | false;
+  fetch?: typeof globalThis.fetch;
+}
+
+export interface CrawloraRequestOptions {
+  headers?: Record<string, string>;
+  responseType?: "auto" | "json" | "text" | "stream";
+  timeout?: number;
+  signal?: AbortSignal;
+  retries?: number;
+  isRetryable?: (status: number, error: CrawloraError) => boolean;
+}
+
+export interface OperationDefinition {
+  id: string; method: string; path: string; pathParams: string[];
+  queryParams: Array<{ name: string; in?: "query"; collectionFormat?: string; type?: string; required?: boolean; enum?: string[] }>;
+  formParams: Array<{ name: string; in?: "formData"; type?: string; required?: boolean; enum?: string[] }>;
+  bodyParam?: string; bodyRequired?: boolean; consumes: string[]; produces: string[]; security: string[];
+  paginatable?: boolean; cursorParams?: string[];
+}
+
+export class CrawloraError extends Error {
+  status: number; code?: number; body: unknown; headers: Record<string, string>;
+  response?: Response; cause?: unknown; retryable?: boolean; requestId?: string;
+}
+export class CrawloraClientError extends CrawloraError {}
+export class CrawloraServerError extends CrawloraError {}
+export class CrawloraNetworkError extends CrawloraError {}
+
+export interface CrawloraPaginateOptions extends CrawloraRequestOptions {
+  pageParam?: string; cursorParam?: string; nextCursor?: (page: unknown) => unknown;
+  start?: unknown; step?: number; maxPages?: number;
+}
+export interface CrawloraPaginateItemsOptions extends CrawloraPaginateOptions {
+  items?: (page: unknown) => Iterable<unknown>;
+}
+
+export class CrawloraClient {
+  constructor(options?: CrawloraClientOptions);
+  request<I extends OperationId>(operationId: I, params: OperationParamsMap[I], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  request<I extends OperationId>(operationId: I, params: OperationParamsMap[I], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  request<I extends OperationId>(operationId: I, ...args: OperationRequestArgs<I>): Promise<OperationResponseMap[I]>;
+  operation<I extends OperationId>(operationId: I, params: OperationParamsMap[I], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  operation<I extends OperationId>(operationId: I, params: OperationParamsMap[I], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  operation<I extends OperationId>(operationId: I, ...args: OperationRequestArgs<I>): Promise<OperationResponseMap[I]>;
+  paginate<I extends OperationId>(operationId: I, params?: OperationParamsMap[I], options?: CrawloraPaginateOptions): AsyncGenerator<OperationResponseMap[I], void, unknown>;
+  paginateItems<I extends OperationId>(operationId: I, params?: OperationParamsMap[I], options?: CrawloraPaginateItemsOptions): AsyncGenerator<unknown, void, unknown>;
+  [group: string]: unknown;
+}
+export interface CrawloraClient extends CrawloraGeneratedGroups {}
+
+export class FlashscoreClient extends CrawloraClient {
+  request<I extends OperationId>(operationId: I, params: OperationParamsMap[I], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  operation<I extends OperationId>(operationId: I, params: OperationParamsMap[I], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  calendar(params: OperationParamsMap["flashscore-calendar"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  calendarCategories(params?: OperationParamsMap["flashscore-calendar-categories"], options?: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  competitions(params: OperationParamsMap["flashscore-competitions"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  matchH2h(params: OperationParamsMap["flashscore-match-h2h"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  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>;
+  matchNews(params: OperationParamsMap["flashscore-match-news"], 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>;
+  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>;
+  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>;
+  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>;
+  tournamentStandings(params: OperationParamsMap["flashscore-tournament-standings"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  tournamentStandingsViews(params: OperationParamsMap["flashscore-tournament-standings-views"], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  request<I extends OperationId>(operationId: I, params: OperationParamsMap[I], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  operation<I extends OperationId>(operationId: I, params: OperationParamsMap[I], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  calendar(params: OperationParamsMap["flashscore-calendar"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  calendarCategories(params?: OperationParamsMap["flashscore-calendar-categories"], options?: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  competitions(params: OperationParamsMap["flashscore-competitions"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  matchH2h(params: OperationParamsMap["flashscore-match-h2h"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  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>;
+  matchNews(params: OperationParamsMap["flashscore-match-news"], 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>;
+  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>;
+  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>;
+  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>;
+  tournamentStandings(params: OperationParamsMap["flashscore-tournament-standings"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+  tournamentStandingsViews(params: OperationParamsMap["flashscore-tournament-standings-views"], options: CrawloraRequestOptions & { responseType: "text" }): Promise<string>;
+
+  request<I extends OperationId>(operationId: I, params: OperationParamsMap[I], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  request<I extends OperationId>(operationId: I, ...args: OperationRequestArgs<I>): Promise<OperationResponseMap[I]>;
+  operation<I extends OperationId>(operationId: I, params: OperationParamsMap[I], options: CrawloraRequestOptions & { responseType: "stream" }): Promise<Response>;
+  operation<I extends OperationId>(operationId: I, ...args: OperationRequestArgs<I>): Promise<OperationResponseMap[I]>;
+  calendar(...args: OperationRequestArgs<"flashscore-calendar">): Promise<OperationResponseMap["flashscore-calendar"]>;
+  calendarCategories(...args: OperationRequestArgs<"flashscore-calendar-categories">): Promise<OperationResponseMap["flashscore-calendar-categories"]>;
+  competitions(...args: OperationRequestArgs<"flashscore-competitions">): Promise<OperationResponseMap["flashscore-competitions"]>;
+  matchH2h(...args: OperationRequestArgs<"flashscore-match-h2h">): Promise<OperationResponseMap["flashscore-match-h2h"]>;
+  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"]>;
+  matchNews(...args: OperationRequestArgs<"flashscore-match-news">): Promise<OperationResponseMap["flashscore-match-news"]>;
+  matchStandings(...args: OperationRequestArgs<"flashscore-match-standings">): Promise<OperationResponseMap["flashscore-match-standings"]>;
+  matchStats(...args: OperationRequestArgs<"flashscore-match-stats">): Promise<OperationResponseMap["flashscore-match-stats"]>;
+  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"]>;
+  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"]>;
+  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"]>;
+  tournamentStandings(...args: OperationRequestArgs<"flashscore-tournament-standings">): Promise<OperationResponseMap["flashscore-tournament-standings"]>;
+  tournamentStandingsViews(...args: OperationRequestArgs<"flashscore-tournament-standings-views">): Promise<OperationResponseMap["flashscore-tournament-standings-views"]>;
+}
+export { FlashscoreClient as Client };
+export const operations: Record<string, OperationDefinition>;
+export const groups: Record<string, Record<string, string>>;
+export const operationCount: number;
+export const OperationIds: Readonly<Record<string, OperationId>>;
+export const VERSION: string;
+export * from "./types.js";
+export default FlashscoreClient;

package/src/index.js

@@ -0,0 +1,50 @@
+import { groups } from "./operations.js";
+import {
+  CrawloraClient,
+  CrawloraClientError,
+  CrawloraError,
+  CrawloraNetworkError,
+  CrawloraServerError
+} from "./client.js";
+
+export class FlashscoreClient extends CrawloraClient {
+  constructor(options = {}) {
+    super({ ...options, userAgent: options.userAgent ?? "crawlora-flashscore-js/0.1.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);
+    this["matchH2h"] = (...args) => this.request("flashscore-match-h2h", ...args);
+    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["matchNews"] = (...args) => this.request("flashscore-match-news", ...args);
+    this["matchStandings"] = (...args) => this.request("flashscore-match-standings", ...args);
+    this["matchStats"] = (...args) => this.request("flashscore-match-stats", ...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["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["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);
+    this["tournamentStandings"] = (...args) => this.request("flashscore-tournament-standings", ...args);
+    this["tournamentStandingsViews"] = (...args) => this.request("flashscore-tournament-standings-views", ...args);
+  }
+}
+
+export { FlashscoreClient as Client };
+export {
+  CrawloraClient,
+  CrawloraClientError,
+  CrawloraError,
+  CrawloraNetworkError,
+  CrawloraServerError
+};
+export { groups, operations, operationCount, OperationIds } from "./operations.js";
+export const VERSION = "0.1.0";
+export default FlashscoreClient;