@retroachievements/api 1.2.0 → 1.3.0

package/dist/user/models/user-claims.model.d.ts

@@ -1,19 +1,19 @@
-interface UserClaim {
-    id: number;
-    user: string;
-    gameId: number;
-    gameTitle: string;
-    gameIcon: string;
-    consoleName: string;
-    claimType: number;
-    setType: number;
-    status: number;
-    extension: number;
-    special: number;
-    created: string;
-    doneTime: string;
-    updated: string;
-    minutesLeft: number;
-}
-export type UserClaims = UserClaim[];
-export {};
+interface UserClaim {
+    id: number;
+    user: string;
+    gameId: number;
+    gameTitle: string;
+    gameIcon: string;
+    consoleName: string;
+    claimType: number;
+    setType: number;
+    status: number;
+    extension: number;
+    special: number;
+    created: string;
+    doneTime: string;
+    updated: string;
+    minutesLeft: number;
+}
+export type UserClaims = UserClaim[];
+export {};

package/dist/user/models/user-completed-games.model.d.ts

@@ -1,12 +1,12 @@
-export interface UserCompletedGame {
-    gameId: number;
-    title: string;
-    imageIcon: string;
-    consoleId: number;
-    consoleName: string;
-    maxPossible: number;
-    numAwarded: number;
-    pctWon: number;
-    hardcoreMode: boolean;
-}
-export type UserCompletedGames = UserCompletedGame[];
+export interface UserCompletedGame {
+    gameId: number;
+    title: string;
+    imageIcon: string;
+    consoleId: number;
+    consoleName: string;
+    maxPossible: number;
+    numAwarded: number;
+    pctWon: number;
+    hardcoreMode: boolean;
+}
+export type UserCompletedGames = UserCompletedGame[];

package/dist/user/models/user-game-rank-and-score.model.d.ts

@@ -1,7 +1,7 @@
-export interface UserGameRankAndScoreEntity {
-    user: string;
-    totalScore: number;
-    lastAward: string;
-    userRank: number;
-}
-export type UserGameRankAndScore = UserGameRankAndScoreEntity[];
+export interface UserGameRankAndScoreEntity {
+    user: string;
+    totalScore: number;
+    lastAward: string;
+    userRank: number;
+}
+export type UserGameRankAndScore = UserGameRankAndScoreEntity[];

package/dist/user/models/user-points.model.d.ts

@@ -1,4 +1,4 @@
-export interface UserPoints {
-    points: number;
-    softcorePoints: number;
-}
+export interface UserPoints {
+    points: number;
+    softcorePoints: number;
+}

package/dist/user/models/user-progress.model.d.ts

@@ -1,9 +1,9 @@
-export interface UserProgressEntity {
-    numPossibleAchievements: number;
-    possibleScore: number;
-    numAchieved: number;
-    scoreAchieved: number;
-    numAchievedHardcore: number;
-    scoreAchievedHardcore: number;
-}
-export type UserProgress = Record<`${number}`, UserProgressEntity>;
+export interface UserProgressEntity {
+    numPossibleAchievements: number;
+    possibleScore: number;
+    numAchieved: number;
+    scoreAchieved: number;
+    numAchievedHardcore: number;
+    scoreAchievedHardcore: number;
+}
+export type UserProgress = Record<`${number}`, UserProgressEntity>;

package/dist/user/models/user-recent-achievement.model.d.ts

@@ -1,16 +1,16 @@
-export interface UserRecentAchievement {
-    date: string;
-    hardcoreMode: boolean;
-    achievementId: number;
-    title: string;
-    description: string;
-    badgeName: string;
-    points: number;
-    author: string;
-    gameTitle: string;
-    gameIcon: string;
-    gameId: number;
-    consoleName: string;
-    badgeUrl: string;
-    gameUrl: string;
-}
+export interface UserRecentAchievement {
+    date: string;
+    hardcoreMode: boolean;
+    achievementId: number;
+    title: string;
+    description: string;
+    badgeName: string;
+    points: number;
+    author: string;
+    gameTitle: string;
+    gameIcon: string;
+    gameId: number;
+    consoleName: string;
+    badgeUrl: string;
+    gameUrl: string;
+}

package/dist/user/models/user-recently-played-games.model.d.ts

@@ -1,16 +1,16 @@
-export interface UserRecentlyPlayedGameEntity {
-    gameId: number;
-    consoleId: number;
-    consoleName: string;
-    title: string;
-    imageIcon: string;
-    lastPlayed: string;
-    myVote: 1 | 2 | 3 | 4 | 5 | null;
-    numPossibleAchievements: number;
-    possibleScore: number;
-    numAchieved: number;
-    scoreAchieved: number;
-    numAchievedHardcore: number;
-    scoreAchievedHardcore: number;
-}
-export type UserRecentlyPlayedGames = UserRecentlyPlayedGameEntity[];
+export interface UserRecentlyPlayedGameEntity {
+    gameId: number;
+    consoleId: number;
+    consoleName: string;
+    title: string;
+    imageIcon: string;
+    lastPlayed: string;
+    myVote: 1 | 2 | 3 | 4 | 5 | null;
+    numPossibleAchievements: number;
+    possibleScore: number;
+    numAchieved: number;
+    scoreAchieved: number;
+    numAchievedHardcore: number;
+    scoreAchievedHardcore: number;
+}
+export type UserRecentlyPlayedGames = UserRecentlyPlayedGameEntity[];

package/dist/user/models/user-summary.model.d.ts

@@ -1,82 +1,82 @@
-export interface RecentlyPlayedGameEntity {
-    gameId: number;
-    consoleId: number;
-    consoleName: string;
-    title: string;
-    imageIcon: string;
-    lastPlayed: string;
-}
-export interface LastActivityEntity {
-    id: number;
-    timestamp: string;
-    lastupdate: string;
-    activitytype: number;
-    user: string;
-    data: string;
-    data2: string;
-}
-export interface LastGameEntity {
-    id: number;
-    title: string;
-    consoleId: number;
-    forumTopicId: number;
-    flags: number;
-    imageIcon: string;
-    imageTitle: string;
-    imageIngame: string;
-    imageBoxArt: string;
-    publisher: string;
-    developer: string;
-    genre: string;
-    released: string;
-    isFinal: boolean;
-    consoleName: string;
-    richPresencePatch: string;
-}
-export interface AwardedGameEntity {
-    numPossibleAchievements: number;
-    possibleScore: number;
-    numAchieved: number;
-    scoreAchieved: number;
-    numAchievedHardcore: number;
-    scoreAchievedHardcore: number;
-}
-export interface ExtendedRecentAchievementEntity {
-    id: number;
-    gameId: number;
-    gameTitle: string;
-    title: string;
-    description: string;
-    points: number;
-    badgeName: string;
-    isAwarded: true;
-    dateAwarded: string;
-    hardcoreAchieved: false;
-}
-export interface UserSummary {
-    recentlyPlayedCount: number;
-    recentlyPlayed: RecentlyPlayedGameEntity[];
-    memberSince: string;
-    lastActivity: LastActivityEntity;
-    richPresenceMsg: string;
-    lastGameId: number;
-    lastGame: LastGameEntity;
-    contribCount: number;
-    contribYield: number;
-    totalPoints: number;
-    totalSoftcorePoints: number;
-    totalTruePoints: number;
-    permissions: number;
-    untracked: boolean;
-    id: number;
-    userWallActive: boolean;
-    motto: string;
-    rank: number;
-    awarded: Record<`${number}`, AwardedGameEntity>;
-    recentAchievements: Record<`${number}`, Record<`${number}`, ExtendedRecentAchievementEntity>>;
-    points: number;
-    softcorePoints: number;
-    userPic: string;
-    totalRanked: number;
-    status: string;
-}
+export interface RecentlyPlayedGameEntity {
+    gameId: number;
+    consoleId: number;
+    consoleName: string;
+    title: string;
+    imageIcon: string;
+    lastPlayed: string;
+}
+export interface LastActivityEntity {
+    id: number;
+    timestamp: string;
+    lastupdate: string;
+    activitytype: number;
+    user: string;
+    data: string;
+    data2: string;
+}
+export interface LastGameEntity {
+    id: number;
+    title: string;
+    consoleId: number;
+    forumTopicId: number;
+    flags: number;
+    imageIcon: string;
+    imageTitle: string;
+    imageIngame: string;
+    imageBoxArt: string;
+    publisher: string;
+    developer: string;
+    genre: string;
+    released: string;
+    isFinal: boolean;
+    consoleName: string;
+    richPresencePatch: string;
+}
+export interface AwardedGameEntity {
+    numPossibleAchievements: number;
+    possibleScore: number;
+    numAchieved: number;
+    scoreAchieved: number;
+    numAchievedHardcore: number;
+    scoreAchievedHardcore: number;
+}
+export interface ExtendedRecentAchievementEntity {
+    id: number;
+    gameId: number;
+    gameTitle: string;
+    title: string;
+    description: string;
+    points: number;
+    badgeName: string;
+    isAwarded: true;
+    dateAwarded: string;
+    hardcoreAchieved: false;
+}
+export interface UserSummary {
+    recentlyPlayedCount: number;
+    recentlyPlayed: RecentlyPlayedGameEntity[];
+    memberSince: string;
+    lastActivity: LastActivityEntity;
+    richPresenceMsg: string;
+    lastGameId: number;
+    lastGame: LastGameEntity;
+    contribCount: number;
+    contribYield: number;
+    totalPoints: number;
+    totalSoftcorePoints: number;
+    totalTruePoints: number;
+    permissions: number;
+    untracked: boolean;
+    id: number;
+    userWallActive: boolean;
+    motto: string;
+    rank: number;
+    awarded: Record<`${number}`, AwardedGameEntity>;
+    recentAchievements: Record<`${number}`, Record<`${number}`, ExtendedRecentAchievementEntity>>;
+    points: number;
+    softcorePoints: number;
+    userPic: string;
+    totalRanked: number;
+    status: string;
+}

package/dist/utils/internal/apiBaseUrl.d.ts

@@ -1 +1 @@
-export declare const apiBaseUrl = "https://retroachievements.org/API";
+export declare const apiBaseUrl = "https://retroachievements.org/API";

package/dist/utils/internal/buildRequestUrl.d.ts

@@ -1,2 +1,2 @@
-import type { AuthObject } from "../public/models";
-export declare const buildRequestUrl: (baseUrl: string, endpointUrl: string, authObject: AuthObject, args?: Record<string, string | number>) => string;
+import type { AuthObject } from "../public/models";
+export declare const buildRequestUrl: (baseUrl: string, endpointUrl: string, authObject: AuthObject, args?: Record<string, string | number>) => string;

package/dist/utils/internal/buildRequestUrl.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/utils/internal/call.d.ts

@@ -1,20 +1,11 @@
-/**
- * Fetch an HTTP resource. This is publicly exposed in the
- * event you would like to access an endpoint that this
- * library does not currently support.
- *
- * UNLESS YOU'RE SURE OF WHAT YOU'RE DOING, YOU PROBABLY
- * SHOULDN'T USE THIS FUNCTION.
- *
- * 2022-10-09: At the time of writing, Node.js LTS (16.x)
- * does not yet support fetch. As a result, we pull in
- * isomorphic-unfetch for Node.js compatibility. Our support
- * matrix includes 14.x and 16.x.
- *
- * @FIXME - When Node.js 20.x is released, remove the
- * isomorphic-unfetch dependency. At that point we will have
- * two major LTS versions that include a native fetch API.
- */
-export declare const call: <T extends readonly any[] | Record<string, any>>(config: {
-    url: string;
-}) => Promise<T>;
+/**
+ * Fetch an HTTP resource. This is publicly exposed in the
+ * event you would like to access an endpoint that this
+ * library does not currently support.
+ *
+ * UNLESS YOU'RE SURE OF WHAT YOU'RE DOING, YOU PROBABLY
+ * SHOULDN'T USE THIS FUNCTION.
+ */
+export declare const call: <T extends readonly any[] | Record<string, any>>(config: {
+    url: string;
+}) => Promise<T>;

package/dist/utils/internal/call.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/utils/internal/id.model.d.ts

@@ -1 +1 @@
-export type ID = string | number;
+export type ID = string | number;

package/dist/utils/internal/index.d.ts

@@ -1,5 +1,5 @@
-export * from "./apiBaseUrl";
-export * from "./buildRequestUrl";
-export * from "./call";
-export * from "./id.model";
-export * from "./serializeProperties";
+export * from "./apiBaseUrl";
+export * from "./buildRequestUrl";
+export * from "./call";
+export * from "./id.model";
+export * from "./serializeProperties";

package/dist/utils/internal/serializeProperties.d.ts

@@ -1,4 +1,4 @@
-export declare const serializeProperties: (originalData: any, options?: Partial<{
-    shouldCastToNumbers: string[];
-    shouldMapToBooleans: string[];
-}>) => any;
+export declare const serializeProperties: (originalData: any, options?: Partial<{
+    shouldCastToNumbers: string[];
+    shouldMapToBooleans: string[];
+}>) => any;

package/dist/utils/internal/serializeProperties.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/utils/public/buildAuthorization.d.ts

@@ -1,22 +1,22 @@
-import type { AuthObject } from "./models";
-/**
- * Accepts your RetroAchievements.org username and web API key. After
- * receiving these inputs, the function returns you a value that can be
- * used for the authentication parameter by any of the async calls in this
- * library.
- *
- * Your account's personal Web API Key can be found on the Settings page
- * of RetroAchievements.org. Do not use a Web API Key that is not associated
- * with your account.
- *
- * @returns An `AuthObject` that you can pass to any of the API call functions.
- *
- * @example
- * ```
- * const authorization = buildAuthorization({
- *   userName: "Scott",
- *   webApiKey: "LtjCwW16nJI7cqOyPIQtXk8v1cfF0tmO"
- * });
- * ```
- */
-export declare const buildAuthorization: (options: AuthObject) => AuthObject;
+import type { AuthObject } from "./models";
+/**
+ * Accepts your RetroAchievements.org username and web API key. After
+ * receiving these inputs, the function returns you a value that can be
+ * used for the authentication parameter by any of the async calls in this
+ * library.
+ *
+ * Your account's personal Web API Key can be found on the Settings page
+ * of RetroAchievements.org. Do not use a Web API Key that is not associated
+ * with your account.
+ *
+ * @returns An `AuthObject` that you can pass to any of the API call functions.
+ *
+ * @example
+ * ```
+ * const authorization = buildAuthorization({
+ *   userName: "Scott",
+ *   webApiKey: "LtjCwW16nJI7cqOyPIQtXk8v1cfF0tmO"
+ * });
+ * ```
+ */
+export declare const buildAuthorization: (options: AuthObject) => AuthObject;

package/dist/utils/public/buildAuthorization.test.d.ts

@@ -1 +1 @@
-export {};
+export {};

package/dist/utils/public/index.d.ts

@@ -1,3 +1,3 @@
-export { call as unsafe_call } from "../internal/call";
-export * from "./buildAuthorization";
-export * from "./models";
+export { call as unsafe_call } from "../internal/call";
+export * from "./buildAuthorization";
+export * from "./models";

package/dist/utils/public/models/auth-object.model.d.ts

@@ -1,19 +1,19 @@
-/**
- * Each RetroAchievements API call is uniquely authenticated
- * using a userName + API key combination. Your account's personal
- * Web API Key can be found on the Settings page.
- */
-export interface AuthObject {
-    /**
-     * You or your app's exact username on the RetroAchievements.org website.
-     * For example, https://retroachievements.org/user/Scott would have a value
-     * of "Scott".
-     */
-    userName: string;
-    /**
-     * This can be found in the "Keys" section of your Settings page on the
-     * RetroAchievements.org website. This is a 32-digit alphanumeric key
-     * that is case-sensitive.
-     */
-    webApiKey: string;
-}
+/**
+ * Each RetroAchievements API call is uniquely authenticated
+ * using a userName + API key combination. Your account's personal
+ * Web API Key can be found on the Settings page.
+ */
+export interface AuthObject {
+    /**
+     * You or your app's exact username on the RetroAchievements.org website.
+     * For example, https://retroachievements.org/user/Scott would have a value
+     * of "Scott".
+     */
+    userName: string;
+    /**
+     * This can be found in the "Keys" section of your Settings page on the
+     * RetroAchievements.org website. This is a 32-digit alphanumeric key
+     * that is case-sensitive.
+     */
+    webApiKey: string;
+}

package/dist/utils/public/models/index.d.ts

@@ -1 +1 @@
-export * from "./auth-object.model";
+export * from "./auth-object.model";

package/package.json

@@ -10,7 +10,7 @@
     "raweb",
     "retro gaming"
   ],
-  "version": "1.2.0",
+  "version": "1.3.0",
   "typings": "dist/index.d.ts",
   "exports": {
     ".": {
@@ -37,17 +37,12 @@
     "format:check": "prettier --check . '**/*.{json,md,js,ts,tsx}'",
     "lint": "eslint --ignore-path .gitignore --ext .js,.ts,.tsx .",
     "lint:fix": "eslint --ignore-path .gitignore --ext .js,.ts,.tsx . --fix",
-    "test": "NODE_OPTIONS='--no-experimental-fetch' jest --selectProjects UNIT",
-    "test:coverage": "jest --selectProjects UNIT --coverage",
-    "verify": "yarn format:check && yarn lint && yarn test:coverage && yarn build && yarn size && yarn docs:build",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "verify": "yarn format:check && yarn lint && yarn test:coverage && yarn build && yarn size",
     "size": "size-limit",
-    "start": "microbundle watch",
-    "docs:dev": "vitepress dev docs",
-    "docs:build": "vitepress build docs",
-    "docs:preview": "vitepress preview docs"
-  },
-  "dependencies": {
-    "isomorphic-unfetch": "^3.1.0"
+    "start": "microbundle watch"
   },
   "peerDependencies": {},
   "devDependencies": {
@@ -55,33 +50,31 @@
     "@commitlint/config-conventional": "^17.4.2",
     "@digitak/esrun": "^3.2.19",
     "@size-limit/preset-small-lib": "^8.1.2",
-    "@swc/core": "^1.3.30",
-    "@swc/jest": "^0.2.24",
     "@tsconfig/recommended": "^1.0.2",
-    "@types/jest": "^29.4.0",
-    "@typescript-eslint/eslint-plugin": "^5.49.0",
-    "@typescript-eslint/parser": "^5.49.0",
+    "@typescript-eslint/eslint-plugin": "^6.9.1",
+    "@typescript-eslint/parser": "^6.9.1",
+    "@vitest/coverage-v8": "^0.34.6",
     "cz-conventional-changelog": "^3.3.0",
     "dotenv-flow-cli": "^1.0.0",
-    "eslint": "^8.33.0",
+    "eslint": "^8.53.0",
     "eslint-config-prettier": "^8.6.0",
-    "eslint-import-resolver-typescript": "^3.5.3",
-    "eslint-plugin-import": "^2.27.5",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import": "^2.29.0",
     "eslint-plugin-simple-import-sort": "^10.0.0",
-    "eslint-plugin-sonarjs": "^0.18.0",
-    "eslint-plugin-unicorn": "^45.0.2",
+    "eslint-plugin-sonarjs": "^0.23.0",
+    "eslint-plugin-unicorn": "^49.0.0",
     "husky": "4.3.8",
-    "jest": "^29.4.1",
     "microbundle": "^0.15.1",
-    "msw": "^1.0.1",
+    "msw": "^2.0.3",
     "prettier": "2.8.3",
     "pretty-quick": "3.1.3",
     "size-limit": "^8.1.2",
-    "tslib": "^2.5.0",
-    "type-fest": "^3.5.3",
-    "typescript": "^4.9.4",
-    "vitepress": "^1.0.0-alpha.43",
-    "vue": "^3.2.45"
+    "tslib": "^2.6.2",
+    "type-fest": "^4.6.0",
+    "typescript": "^5.2.2",
+    "undici": "^5.27.2",
+    "vite": "^4.5.0",
+    "vitest": "^0.34.6"
   },
   "size-limit": [
     {
@@ -117,11 +110,11 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/RetroAchievements/retroachievements-api-js.git"
+    "url": "git+https://github.com/RetroAchievements/api-js.git"
   },
   "bugs": {
-    "url": "https://github.com/RetroAchievements/retroachievements-api-js/issues"
+    "url": "https://github.com/RetroAchievements/api-js/issues"
   },
-  "homepage": "https://github.com/RetroAchievements/retroachievements-api-js#readme",
+  "homepage": "https://github.com/RetroAchievements/api-js#readme",
   "author": "RAWeb Team"
 }