@kionell/osu-api - npm Package Compare versions

Comparing version 1.2.0 to 1.3.0

lib/index.d.ts

@@ -586,3 +586,3 @@ import { DifficultyAttributes, IScoreInfo, IBeatmapInfo, IUserInfo, IRuleset, ScoreRank, BeatmapInfo, ScoreInfo, UserInfo } from 'osu-classes';
   avatar_url: string;
-  country_code: string;
+  country_code: Uppercase<string>;
   default_group: string;
@@ -797,27 +797,15 @@ id: number;
 declare class APIFactory {
-  /**
-     * Creates a new API client based on a server name.
-     * @param server Server name.
-     * @returns API client.
-     */
-  getAPIClient(server?: keyof typeof Server | null): APIClient;
-  /**
-     * Adds credentials to the specific server API.
-     * @param server Server name.
-     * @param clientId API client ID.
-     * @param clientSecret API client secret.
-     */
-  addCredentials(server?: keyof typeof Server | null, clientId?: string, clientSecret?: string): void;
-  /**
-     * Creates a new instance of URL scanner based on a server name.
-     * @param server Server name.
-     * @returns URL scanner.
-     */
-  createURLScanner(server?: keyof typeof Server | null): URLScanner;
-  /**
-     * Creates a new instance of URL generator based on a server name.
-     * @param server Server name.
-     * @returns URL generator.
-     */
-  createURLGenerator(server?: keyof typeof Server | null): URLGenerator;
+  getAPIClient(server?: 'Bancho' | null): BanchoAPIClient;
+  getAPIClient(server: 'Gatari'): APIClient;
+  getAPIClient(server: 'Akatsuki'): APIClient;
+  getAPIClient(server: 'Ripple'): APIClient;
+  addCredentials(server: 'Bancho', clientId: string, clientSecret: string): void;
+  createURLScanner(server?: 'Bancho' | null): BanchoURLScanner;
+  createURLScanner(server: 'Gatari'): URLScanner;
+  createURLScanner(server: 'Akatsuki'): URLScanner;
+  createURLScanner(server: 'Ripple'): URLScanner;
+  createURLGenerator(server?: 'Bancho' | null): BanchoURLGenerator;
+  createURLGenerator(server: 'Gatari'): URLGenerator;
+  createURLGenerator(server: 'Akatsuki'): URLGenerator;
+  createURLGenerator(server: 'Ripple'): URLGenerator;
 }
@@ -824,0 +812,0 @@ declare const _default: APIFactory;

package.json

 {
   "name": "@kionell/osu-api",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "API clients for different osu! servers",
@@ -5,0 +5,0 @@ "exports": {

No alert changes

Worsened metrics

Total package byte prevSize

92368

decreased by-0.1%

Lines of code

2866

decreased by-0.28%

No dependency changes