@time2win/t2w 1.4.8 → 1.4.10

package/CHANGELOG.md

@@ -1,72 +1,80 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## 1.4.8 - 2024-03-29
-### Modified
-```reg_type``` field of ```T2WEventRace``` to type ```'individual' | 'team'
-
-## 1.4.7 - 2024-03-25
-### Modified
-Gender type of ```T2WIndividualResult``` to ```M | F | U```
-
-## 1.4.6 - 2024-02-28
-### Modified
-Error handling for methods, if api is not allowed, the error message will be more specific
-
-## 1.4.5 - 2024-02-15
-### Modified
-Calculation of ```racenumNumeric``` to support more cases
-
-## 1.4.4 - 2024-02-15
-### Modified
-Calculation of ```racenumNumeric``` to support more cases
-
-## 1.4.3 - 2024-02-14
-### Modified
-Calculation of ```racenumNumeric``` to use always the first part before a dash (if available)
-
-## 1.4.2 - 2024-02-14
-### Modified
-```getTeamsWithMembers()``` and ```getParticipantInfos()``` now have raceId as optional parameter (if not set, all races will be requested)
-
-## 1.4.1 - 2024-02-14
-### Modified
-property ```racenumNumeric``` and ```racenum``` to be nullable for all occurrences  
-
-## 1.4.0 - 2024-02-09
-### Added
-property ```racenumNumeric``` now available in ```T2WIndividualResult```, ```T2WTeamResult```, ```T2WParticipantInfo```, ```T2WTeam```, ```T2WTeamMember``` interface 
-
-## 1.3.0 - 2024-02-07
-### Modified
-parameter order of all methods to have page at the end (enhances usability)
-
-## 1.2.1 - 2024-02-07
-### Added
-```T2WIndividualResultSplit``` interface for Split details of individual results
-
-## 1.2.0 - 2024-02-06
-### Modified
-```T2WParticipantInfo``` interface has now status properties
-
-## 1.1.0 - 2024-02-06
-### Added
-```getUpcomingEvents()``` method
-
-### Removed
-```T2WEventData``` interface (was duplicate of ```T2WEvent```)
-
-## 1.0.1 - 2023-10-25
-### Added
-Keywords in package.json
-
-### Modified
-Requirements for NodeJS and TS
-
-## 1.0.0 - 2023-10-25
-### Added
-Latest of T2W API and running production ready version
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 1.4.10 - 2024-08-04
+### Modified
+added readonly pageSize field to t2w package and set it to 250 for all requests
+
+## 1.4.9 - 2024-06-14
+### Modified
+```dataExtra``` parameters to support types, therefore selection is improved and prevents typos
+
+## 1.4.8 - 2024-03-29
+### Modified
+```reg_type``` field of ```T2WEventRace``` to type ```'individual' | 'team'
+
+## 1.4.7 - 2024-03-25
+### Modified
+Gender type of ```T2WIndividualResult``` to ```M | F | U```
+
+## 1.4.6 - 2024-02-28
+### Modified
+Error handling for methods, if api is not allowed, the error message will be more specific
+
+## 1.4.5 - 2024-02-15
+### Modified
+Calculation of ```racenumNumeric``` to support more cases
+
+## 1.4.4 - 2024-02-15
+### Modified
+Calculation of ```racenumNumeric``` to support more cases
+
+## 1.4.3 - 2024-02-14
+### Modified
+Calculation of ```racenumNumeric``` to use always the first part before a dash (if available)
+
+## 1.4.2 - 2024-02-14
+### Modified
+```getTeamsWithMembers()``` and ```getParticipantInfos()``` now have raceId as optional parameter (if not set, all races will be requested)
+
+## 1.4.1 - 2024-02-14
+### Modified
+property ```racenumNumeric``` and ```racenum``` to be nullable for all occurrences  
+
+## 1.4.0 - 2024-02-09
+### Added
+property ```racenumNumeric``` now available in ```T2WIndividualResult```, ```T2WTeamResult```, ```T2WParticipantInfo```, ```T2WTeam```, ```T2WTeamMember``` interface 
+
+## 1.3.0 - 2024-02-07
+### Modified
+parameter order of all methods to have page at the end (enhances usability)
+
+## 1.2.1 - 2024-02-07
+### Added
+```T2WIndividualResultSplit``` interface for Split details of individual results
+
+## 1.2.0 - 2024-02-06
+### Modified
+```T2WParticipantInfo``` interface has now status properties
+
+## 1.1.0 - 2024-02-06
+### Added
+```getUpcomingEvents()``` method
+
+### Removed
+```T2WEventData``` interface (was duplicate of ```T2WEvent```)
+
+## 1.0.1 - 2023-10-25
+### Added
+Keywords in package.json
+
+### Modified
+Requirements for NodeJS and TS
+
+## 1.0.0 - 2023-10-25
+### Added
+Latest of T2W API and running production ready version

package/README.md

@@ -1,23 +1,23 @@
-# @time2win/t2w
-providing latest-state models and advanced methods to interact with the T2W API.
-Models are included per default and can be imported directly from the package.
-
-## Requirements
-NodeJS >= 18.x \
-Typescript >= 4.x
-
-## Usage
-
-### Install Package
-```bash
-npm install @time2win/t2w
-```
-
-### Import Package
-```js
-import Time2WinAPI from '@time2win/t2w';
-import { T2WEvent } from '@time2win/t2w/models';
-
-const api = new Time2WinAPI('YOUR-API-KEY');
-```
-
+# @time2win/t2w
+providing latest-state models and advanced methods to interact with the T2W API.
+Models are included per default and can be imported directly from the package.
+
+## Requirements
+NodeJS >= 18.x \
+Typescript >= 4.x
+
+## Usage
+
+### Install Package
+```bash
+npm install @time2win/t2w
+```
+
+### Import Package
+```js
+import Time2WinAPI from '@time2win/t2w';
+import { T2WEvent } from '@time2win/t2w/models';
+
+const api = new Time2WinAPI('YOUR-API-KEY');
+```
+

package/index.d.ts

@@ -1,16 +1,17 @@
-import { T2WEvent, T2WEventResponse, T2WIndividualResultResponse, T2WParticipantResponse, T2WTeamResponse, T2WTeamResultsResponse } from './models';
-export default class Time2WinAPI {
-    private readonly apiUrl;
-    private readonly apiKey;
-    constructor(apiKey: string);
-    getEventData(eventId: number, dataExtra?: string[]): Promise<T2WEvent>;
-    getTeamResult(eventId: number, raceId: number, dataExtra?: string[], teamType?: 'M' | 'F' | 'U', page?: number): Promise<T2WTeamResultsResponse>;
-    getTeamsWithMembers(eventId: number, raceId?: number, dataExtra?: string[], page?: number): Promise<T2WTeamResponse>;
-    getIndividualResults(eventId: number, raceId: number, dataExtra?: string[], gender?: 'M' | 'F' | 'U', page?: number): Promise<T2WIndividualResultResponse>;
-    getParticipantInfos(eventId: number, raceId?: number, dataExtra?: string[], gender?: 'M' | 'F' | 'U', page?: number): Promise<T2WParticipantResponse>;
-    getUpcomingEvents(from?: Date, to?: Date, page?: number): Promise<T2WEventResponse>;
-    private getUrl;
-    private calculateAge;
-    private formatDate;
-    private getNumericBib;
-}
+import { T2WEvent, T2WEventResponse, T2WIndividualResultResponse, T2WParticipantResponse, T2WTeamResponse, T2WTeamResultsResponse } from './models';
+export default class Time2WinAPI {
+    private readonly apiUrl;
+    private readonly apiKey;
+    private readonly pageSize;
+    constructor(apiKey: string);
+    getEventData(eventId: number, dataExtra?: ('prices' | 'splits')[]): Promise<T2WEvent>;
+    getTeamResult(eventId: number, raceId: number, dataExtra?: ('splits' | 'attributes' | 'laps')[], teamType?: 'M' | 'F' | 'U', page?: number): Promise<T2WTeamResultsResponse>;
+    getTeamsWithMembers(eventId: number, raceId?: number, dataExtra?: ('teammembers' | 'attributes')[], page?: number): Promise<T2WTeamResponse>;
+    getIndividualResults(eventId: number, raceId: number, dataExtra?: ('splits' | 'laps' | 'positions' | 'attributes')[], gender?: 'M' | 'F' | 'U', page?: number): Promise<T2WIndividualResultResponse>;
+    getParticipantInfos(eventId: number, raceId?: number, dataExtra?: ('order' | 'attributes' | 'categories' | 'uci_id' | 'chip_code' | 'externalticket' | 'contactinfo')[], gender?: 'M' | 'F' | 'U', page?: number): Promise<T2WParticipantResponse>;
+    getUpcomingEvents(from?: Date, to?: Date, page?: number): Promise<T2WEventResponse>;
+    private getUrl;
+    private calculateAge;
+    private formatDate;
+    private getNumericBib;
+}