wynn-api-types 3.7.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ILikePlayingGames
+
+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,28 @@
+# wynn-api-types
+TypeScript types for the Wynncraft API.
+<br>
+These types were generated using [OpenAPI TypeScript](https://openapi-ts.dev) from the
+[Wynncraft API OpenAPI Schema](https://docs.wynncraft.com/openapi.json).
+
+# Building
+Note: Steps 1 and 2 are needed only during initial setup and when the Wynncraft API changes.
+
+1. Run `npm download-spec` to download the OpenAPI spec from the Wynncraft API. It will be saved to `./schemas/original.json`.
+2. Run `npm merge` to merge the overrides in `./schema/overrides.json` into the original spec.
+3. Run `npm build` to generate the TypeScript type definitions.
+
+# Usage Example
+
+```ts
+import type { paths } from 'wynn-api-types';
+
+// Run a global search for "Imperial"
+const response = await fetch('https://api.wynncraft.com/v3/search/Imperial');
+
+if (response.ok) {
+    // Cast to the correct response type for the request path to enable type-aware autocomplete
+    const searchResults = await response.json() as paths['/search/{query}']['get']['responses']['200']['content']['application/json'];
+    // List the matching guilds
+    console.log(JSON.stringify(searchResults.guilds, null, 2));
+}
+```