@retroachievements/api 0.0.0-development

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 RetroAchievements.org
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,103 @@
+# DTS User Guide
+
+Congrats! You just saved yourself hours of work by bootstrapping this project with DTS. Let’s get you oriented with what’s here and how to use it.
+
+> This DTS setup is meant for developing libraries (not apps!) that can be published to NPM. If you’re looking to build a Node app, you could use `ts-node-dev`, plain `ts-node`, or simple `tsc`.
+
+> If you’re new to TypeScript, checkout [this handy cheatsheet](https://devhints.io/typescript)
+
+## Commands
+
+DTS scaffolds your new library inside `/src`.
+
+To run DTS, use:
+
+```bash
+npm start # or yarn start
+```
+
+This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
+
+To do a one-off build, use `npm run build` or `yarn build`.
+
+To run tests, use `npm test` or `yarn test`.
+
+## Configuration
+
+Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
+
+### Jest
+
+Jest tests are set up to run with `npm test` or `yarn test`.
+
+### Bundle Analysis
+
+[`size-limit`](https://github.com/ai/size-limit) is set up to calculate the real cost of your library with `npm run size` and visualize the bundle with `npm run analyze`.
+
+#### Setup Files
+
+This is the folder structure we set up for you:
+
+```txt
+/src
+  index.ts        # EDIT THIS
+/test
+  index.test.ts   # EDIT THIS
+.gitignore
+package.json
+README.md         # EDIT THIS
+tsconfig.json
+```
+
+### Rollup
+
+DTS uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
+
+### TypeScript
+
+`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
+
+## Continuous Integration
+
+### GitHub Actions
+
+Two actions are added by default:
+
+- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
+- `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit)
+
+## Optimizations
+
+Please see the main `dts` [optimizations docs](https://github.com/weiran-zsd/dts-cli#optimizations). In particular, know that you can take advantage of development-only optimizations:
+
+```js
+// ./types/index.d.ts
+declare var __DEV__: boolean;
+
+// inside your code...
+if (__DEV__) {
+  console.log("foo");
+}
+```
+
+You can also choose to install and use [invariant](https://github.com/weiran-zsd/dts-cli#invariant) and [warning](https://github.com/weiran-zsd/dts-cli#warning) functions.
+
+## Module Formats
+
+CJS, ESModules, and UMD module formats are supported.
+
+The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.
+
+## Named Exports
+
+Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.
+
+## Including Styles
+
+There are many ways to ship styles, including with CSS-in-JS. DTS has no opinion on this, configure how you like.
+
+For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.
+
+## Publishing to NPM
+
+We recommend using [np](https://github.com/sindresorhus/np).

package/dist/__playground.d.ts

@@ -0,0 +1,7 @@
+/**
+ * PLEASE ONLY COMMIT CHANGES TO THIS FILE IF YOU WANT THEM
+ * TO DIRECTLY IMPACT EVERY DEV WORKING ON THE PROJECT.
+ *
+ * Use this file to test and experiment with changes to the project.
+ */
+export {};

package/dist/achievement/getAchievementUnlocks.d.ts

@@ -0,0 +1,45 @@
+import type { AuthObject } from "../utils/public";
+import type { AchievementUnlockEntity } from "./models";
+/**
+ * A call to this function will retrieve a list of users who
+ * have earned the given achievementId.
+ *
+ * @param authorization An object containing your userName and webApiKey.
+ * This can be constructed with `buildAuthorization()`.
+ *
+ * @param payload.achievementId The target achievement we want to
+ * retrieve the unlocks list for. If unknown, this can be found
+ * by navigating to the achievement's page on the RetroAchievements.org
+ * website. eg: https://retroachievements.org/achievement/13876 has an
+ * ID of 13876.
+ *
+ * @param payload.offset Defaults to 0. The number of entries to skip.
+ *
+ * @param payload.count Defaults to 50, has a max of 500.
+ *
+ * @example
+ * ```
+ * const achievementUnlocks = await getAchievementUnlocks(
+ *   authorization,
+ *   { achievementId: 13876 }
+ * );
+ * ```
+ *
+ * @returns An array containing metadata about unlocks for
+ * the target achievement.
+ * ```
+ * [
+ *   {
+ *     user: 'Podgicus0305',
+ *     raPoints: 15544,
+ *     dateAwarded: '2022-07-12 19:06:34',
+ *     hardcoreMode: true
+ *   }
+ * ]
+ * ```
+ */
+export declare const getAchievementUnlocks: (authorization: AuthObject, payload: {
+    achievementId: number;
+    offset?: number;
+    count?: number;
+}) => Promise<AchievementUnlockEntity[]>;

package/dist/achievement/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./getAchievementUnlocks";
+export * from "./models";

package/dist/achievement/models/achievement-unlock-entity.model.d.ts

@@ -0,0 +1,6 @@
+export interface AchievementUnlockEntity {
+    user: string;
+    raPoints: number;
+    dateAwarded: string;
+    hardcoreMode: boolean;
+}

package/dist/achievement/models/get-achievement-unlocks-response.model.d.ts

@@ -0,0 +1,8 @@
+interface AchievementUnlocksResponseEntity {
+    User: string;
+    RAPoints: string;
+    DateAwarded: string;
+    HardcoreMode: string;
+}
+export declare type GetAchievementUnlocksResponse = AchievementUnlocksResponseEntity[];
+export {};

package/dist/achievement/models/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./achievement-unlock-entity.model";
+export * from "./get-achievement-unlocks-response.model";