@rian8337/osu-droid-utilities 2.0.0-alpha.3 → 2.0.0-alpha.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +4 -5
  2. package/typings/index.d.ts +205 -205
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rian8337/osu-droid-utilities",
3
- "version": "2.0.0-alpha.3",
3
+ "version": "2.0.0-alpha.4",
4
4
  "description": "A module containing utilities for osu!droid.",
5
5
  "keywords": [
6
6
  "osu",
@@ -23,15 +23,14 @@
23
23
  "scripts": {
24
24
  "build": "rollup -c ../../rollup.config.js",
25
25
  "lint": "eslint --ext ts",
26
- "prepare": "npm run build",
27
26
  "test": "jest -i"
28
27
  },
29
28
  "bugs": {
30
29
  "url": "https://github.com/Rian8337/osu-droid-module/issues"
31
30
  },
32
31
  "dependencies": {
33
- "@rian8337/osu-base": "^2.0.0-alpha.0",
34
- "@rian8337/osu-droid-replay-analyzer": "^2.0.0-alpha.3",
32
+ "@rian8337/osu-base": "^2.0.0-alpha.4",
33
+ "@rian8337/osu-droid-replay-analyzer": "^2.0.0-alpha.4",
35
34
  "crypto-js": "^4.1.1"
36
35
  },
37
36
  "publishConfig": {
@@ -40,5 +39,5 @@
40
39
  "devDependencies": {
41
40
  "@types/crypto-js": "^4.1.0"
42
41
  },
43
- "gitHead": "2dcada0b1b3986ea9637472b2b34e6b51c0ea40d"
42
+ "gitHead": "d7ebd2e4178199a8ccede5e409bbeaaafae62b35"
44
43
  }
@@ -1,211 +1,211 @@
1
- import { Accuracy, Mod } from '@rian8337/osu-base';
2
- import { ReplayAnalyzer } from '@rian8337/osu-droid-replay-analyzer';
1
+ import { Accuracy, Mod } from "@rian8337/osu-base";
2
+ import { ReplayAnalyzer } from "@rian8337/osu-droid-replay-analyzer";
3
3
 
4
- interface ScoreInformation {
5
- /**
6
- * The uid of the player.
7
- */
8
- uid?: number;
9
- /**
10
- * The ID of the score.
11
- */
12
- scoreID?: number;
13
- /**
14
- * The player's name.
15
- */
16
- username: string;
17
- /**
18
- * The title of the beatmap.
19
- */
20
- title: string;
21
- /**
22
- * The maximum combo achieved in the play.
23
- */
24
- combo: number;
25
- /**
26
- * The score achieved in the play.
27
- */
28
- score: number;
29
- /**
30
- * The rank achieved in the play.
31
- */
32
- rank: string;
33
- /**
34
- * The date of which the play was set.
35
- */
36
- date: Date | number;
37
- /**
38
- * The accuracy achieved in the play.
39
- */
40
- accuracy: Accuracy;
41
- /**
42
- * Enabled modifications in the score, including force AR and custom speed multiplier.
43
- */
44
- mods: string;
45
- /**
46
- * MD5 hash of the play.
47
- */
48
- hash: string;
49
- }
50
- /**
51
- * Represents an osu!droid score.
52
- */
53
- declare class Score {
54
- /**
55
- * The uid of the player.
56
- */
57
- uid: number;
58
- /**
59
- * The ID of the score.
60
- */
61
- scoreID: number;
62
- /**
63
- * The player's name.
64
- */
65
- username: string;
66
- /**
67
- * The title of the beatmap.
68
- */
69
- title: string;
70
- /**
71
- * The maximum combo achieved in the play.
72
- */
73
- combo: number;
74
- /**
75
- * The score achieved in the play.
76
- */
77
- score: number;
78
- /**
79
- * The rank achieved in the play.
80
- */
81
- rank: string;
82
- /**
83
- * The date of which the play was set.
84
- */
85
- date: Date;
86
- /**
87
- * The accuracy achieved in the play.
88
- */
89
- accuracy: Accuracy;
90
- /**
91
- * Enabled modifications in the score.
92
- */
93
- mods: Mod[];
94
- /**
95
- * MD5 hash of the play.
96
- */
97
- hash: string;
98
- /**
99
- * The speed multiplier of the play.
100
- */
101
- speedMultiplier: number;
102
- /**
103
- * The forced AR of the play.
104
- */
105
- forcedAR?: number;
106
- /**
107
- * The replay of the score.
108
- */
109
- replay?: ReplayAnalyzer;
110
- constructor(values?: ScoreInformation);
111
- /**
112
- * Retrieves play information.
113
- *
114
- * @param params Function parameters.
115
- */
116
- static getFromHash(params: {
117
- /**
118
- * The uid of the player.
119
- */
120
- uid: number;
121
- /**
122
- * The MD5 hash to retrieve.
123
- */
124
- hash: string;
125
- }): Promise<Score>;
126
- /**
127
- * Fills this instance with score information.
128
- *
129
- * @param info The score information from API response to fill with.
130
- */
131
- fillInformation(info: string): Score;
132
- /**
133
- * Returns the complete mod string of this score (mods, speed multiplier, and force AR combined).
134
- */
135
- getCompleteModString(): string;
136
- /**
137
- * Downloads the replay of this score.
138
- */
139
- downloadReplay(): Promise<void>;
140
- /**
141
- * Returns a string representative of the class.
142
- */
143
- toString(): string;
4
+ interface ScoreInformation {
5
+ /**
6
+ * The uid of the player.
7
+ */
8
+ uid?: number;
9
+ /**
10
+ * The ID of the score.
11
+ */
12
+ scoreID?: number;
13
+ /**
14
+ * The player's name.
15
+ */
16
+ username: string;
17
+ /**
18
+ * The title of the beatmap.
19
+ */
20
+ title: string;
21
+ /**
22
+ * The maximum combo achieved in the play.
23
+ */
24
+ combo: number;
25
+ /**
26
+ * The score achieved in the play.
27
+ */
28
+ score: number;
29
+ /**
30
+ * The rank achieved in the play.
31
+ */
32
+ rank: string;
33
+ /**
34
+ * The date of which the play was set.
35
+ */
36
+ date: Date | number;
37
+ /**
38
+ * The accuracy achieved in the play.
39
+ */
40
+ accuracy: Accuracy;
41
+ /**
42
+ * Enabled modifications in the score, including force AR and custom speed multiplier.
43
+ */
44
+ mods: string;
45
+ /**
46
+ * MD5 hash of the play.
47
+ */
48
+ hash: string;
49
+ }
50
+ /**
51
+ * Represents an osu!droid score.
52
+ */
53
+ declare class Score {
54
+ /**
55
+ * The uid of the player.
56
+ */
57
+ uid: number;
58
+ /**
59
+ * The ID of the score.
60
+ */
61
+ scoreID: number;
62
+ /**
63
+ * The player's name.
64
+ */
65
+ username: string;
66
+ /**
67
+ * The title of the beatmap.
68
+ */
69
+ title: string;
70
+ /**
71
+ * The maximum combo achieved in the play.
72
+ */
73
+ combo: number;
74
+ /**
75
+ * The score achieved in the play.
76
+ */
77
+ score: number;
78
+ /**
79
+ * The rank achieved in the play.
80
+ */
81
+ rank: string;
82
+ /**
83
+ * The date of which the play was set.
84
+ */
85
+ date: Date;
86
+ /**
87
+ * The accuracy achieved in the play.
88
+ */
89
+ accuracy: Accuracy;
90
+ /**
91
+ * Enabled modifications in the score.
92
+ */
93
+ mods: Mod[];
94
+ /**
95
+ * MD5 hash of the play.
96
+ */
97
+ hash: string;
98
+ /**
99
+ * The speed multiplier of the play.
100
+ */
101
+ speedMultiplier: number;
102
+ /**
103
+ * The forced AR of the play.
104
+ */
105
+ forcedAR?: number;
106
+ /**
107
+ * The replay of the score.
108
+ */
109
+ replay?: ReplayAnalyzer;
110
+ constructor(values?: ScoreInformation);
111
+ /**
112
+ * Retrieves play information.
113
+ *
114
+ * @param params Function parameters.
115
+ */
116
+ static getFromHash(params: {
117
+ /**
118
+ * The uid of the player.
119
+ */
120
+ uid: number;
121
+ /**
122
+ * The MD5 hash to retrieve.
123
+ */
124
+ hash: string;
125
+ }): Promise<Score>;
126
+ /**
127
+ * Fills this instance with score information.
128
+ *
129
+ * @param info The score information from API response to fill with.
130
+ */
131
+ fillInformation(info: string): Score;
132
+ /**
133
+ * Returns the complete mod string of this score (mods, speed multiplier, and force AR combined).
134
+ */
135
+ getCompleteModString(): string;
136
+ /**
137
+ * Downloads the replay of this score.
138
+ */
139
+ downloadReplay(): Promise<void>;
140
+ /**
141
+ * Returns a string representative of the class.
142
+ */
143
+ toString(): string;
144
144
  }
145
145
 
146
- /**
147
- * Represents an osu!droid player.
148
- */
149
- declare class Player {
150
- /**
151
- * The uid of the player.
152
- */
153
- uid: number;
154
- /**
155
- * The username of the player.
156
- */
157
- username: string;
158
- /**
159
- * The avatar URL of the player.
160
- */
161
- avatarURL: string;
162
- /**
163
- * The location of the player based on ISO 3166-1 country codes. See {@link https://en.wikipedia.org/wiki/ISO_3166-1 this} Wikipedia page for more information.
164
- */
165
- location: string;
166
- /**
167
- * The email that is attached to the player's account.
168
- */
169
- email: string;
170
- /**
171
- * The overall rank of the player.
172
- */
173
- rank: number;
174
- /**
175
- * The total score of the player.
176
- */
177
- score: number;
178
- /**
179
- * The overall accuracy of the player.
180
- */
181
- accuracy: number;
182
- /**
183
- * The amount of times the player has played.
184
- */
185
- playCount: number;
186
- /**
187
- * Recent plays of the player.
188
- */
189
- readonly recentPlays: Score[];
190
- /**
191
- * Retrieves a player's info based on uid or username.
192
- *
193
- * Either uid or username must be specified.
194
- */
195
- static getInformation(params: {
196
- uid?: number;
197
- username?: string;
198
- }): Promise<Player>;
199
- /**
200
- * Fills this instance with player information.
201
- *
202
- * @param info The player information from API response to fill with.
203
- */
204
- fillInformation(info: string): Player;
205
- /**
206
- * Returns a string representative of the class.
207
- */
208
- toString(): string;
146
+ /**
147
+ * Represents an osu!droid player.
148
+ */
149
+ declare class Player {
150
+ /**
151
+ * The uid of the player.
152
+ */
153
+ uid: number;
154
+ /**
155
+ * The username of the player.
156
+ */
157
+ username: string;
158
+ /**
159
+ * The avatar URL of the player.
160
+ */
161
+ avatarURL: string;
162
+ /**
163
+ * The location of the player based on ISO 3166-1 country codes. See {@link https://en.wikipedia.org/wiki/ISO_3166-1 this} Wikipedia page for more information.
164
+ */
165
+ location: string;
166
+ /**
167
+ * The email that is attached to the player's account.
168
+ */
169
+ email: string;
170
+ /**
171
+ * The overall rank of the player.
172
+ */
173
+ rank: number;
174
+ /**
175
+ * The total score of the player.
176
+ */
177
+ score: number;
178
+ /**
179
+ * The overall accuracy of the player.
180
+ */
181
+ accuracy: number;
182
+ /**
183
+ * The amount of times the player has played.
184
+ */
185
+ playCount: number;
186
+ /**
187
+ * Recent plays of the player.
188
+ */
189
+ readonly recentPlays: Score[];
190
+ /**
191
+ * Retrieves a player's info based on uid or username.
192
+ *
193
+ * Either uid or username must be specified.
194
+ */
195
+ static getInformation(params: {
196
+ uid?: number;
197
+ username?: string;
198
+ }): Promise<Player>;
199
+ /**
200
+ * Fills this instance with player information.
201
+ *
202
+ * @param info The player information from API response to fill with.
203
+ */
204
+ fillInformation(info: string): Player;
205
+ /**
206
+ * Returns a string representative of the class.
207
+ */
208
+ toString(): string;
209
209
  }
210
210
 
211
211
  export { Player, Score };