fnapi-js 1.1.2 → 2.0.0-beta.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Ajaxfnc
-
-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.
+MIT License
+
+Copyright (c) 2025 Ajaxfnc
+
+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

@@ -1,78 +1,102 @@
 # fnapi-js
 
-An unofficial JavaScript/Typescript wrapper for the [Fortnite-API](https://fortnite-api.com/) REST API.
+Zero-dependency TypeScript wrapper for the public Fortnite APIs, with a complete Epic Games account-service auth, realtime (XMPP/EOS), party, MCP and item-shop/gifting layer.
 
-## Installation
+[![license](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+[![node](https://img.shields.io/badge/node-%3E%3D18-brightgreen.svg)](https://nodejs.org)
+[![types](https://img.shields.io/badge/types-included-blue.svg)](#)
+
+## Install
 
 ```bash
 npm install fnapi-js
 ```
 
-## Usage
+Node 18+. Ships dual ESM/CJS builds and full `.d.ts` types; works identically from TypeScript and plain JavaScript. No runtime dependencies.
+
+## Two halves
+
+Everything is imported from the package root:
+
+```ts
+import { FortniteAPI, EpicGamesClient } from 'fnapi-js';
+```
+
+- **`FortniteAPI`** — the [fortnite-api.com](https://fortnite-api.com) wrapper: `shop`, `cosmetics`, `aes`, `banners`, `creatorCode` (`sac`), `map`, `news`, `playlists`, `stats`.
+- **`EpicGamesClient`** — the Epic Games account service: every OAuth grant, device-code login, device auths, account lookups, sessions with auto-refresh — and on top of a signed-in session: MCP profile operations, the item shop + gifting, friends, party create/join/lifecycle, XMPP + EOS realtime, and an event-driven `LiveClient` bot.
+
+## Quick start
+
+### Fortnite API
+
+```ts
+import { FortniteAPI, Language, MatchMethod } from 'fnapi-js';
+
+const client = new FortniteAPI({ language: Language.English });
+
+const shop = await client.shop.get();
+console.log(`Shop for ${shop.date} has ${shop.entries.length} entries`);
+
+const renegade = await client.cosmetics.search({
+  name: 'Renegade Raider',
+  matchMethod: MatchMethod.Full,
+});
+console.log(`${renegade.name} — ${renegade.rarity.displayValue}`);
+```
+
+### Epic Games auth
 
-```javascript
-// ESM
-import { ApiClient, Enums } from 'fnapi-js';
+```ts
+import { EpicGamesClient } from 'fnapi-js';
 
-// CommonJS
-const { ApiClient, Enums } = require('fnapi-js');
+const epic = new EpicGamesClient();
 
-// Initialize the client
-const fnApi = new ApiClient({ apiKey: 'your-api-key' });
+const session = await epic.loginClientCredentials();
+const verified = await session.verify();
+console.log(`verified client ${verified.client_id}`);
+await session.logout();
+```
+
+To sign in as a user, use the device-code flow — see the docs.
 
-// Get player stats
-const stats = await fnApi.stats.get(
-    'username',
-    Enums.accountType.epic(),
-    Enums.timeWindow.lifetime(),
-    Enums.statsImage.all()
-);
+### Live bot, shop & party
 
-// Search cosmetics
-const searchOptions = new SearchOptions()
-    .setType('outfit')
-    .setRarity('epic')
-    .setMatchMethod(Enums.matchMethod.contains());
+```ts
+const session = await epic.loginWithDeviceAuth(creds);
 
-const cosmetics = await fnApi.cosmetics.searchCosmetics(searchOptions);
+const bot = await session.live();
+bot.on('friend:request', (request) => request.accept());
+bot.on('party:invite', (invite) => invite.accept());
 
-// Get creator code
-const creatorCode = await fnApi.sac.get('code');
+const shop = await session.shop();
+await shop.find('Renegade Raider')?.gift('SomeFriend');
+
+const party = await bot.createParty();
+await party.setPrivacy('private');
+```
 
-// Get AES keys
-const aesKeys = await fnApi.aes.getKeys();
+## Configuration
+
+Runtime configuration lives in `config.json` (no `.env`). Copy the template and fill in your own values:
+
+```bash
+cp config.example.json config.json
 ```
 
-## Check out the docs
-- [Documentation](https://github.com/AjaxFNC-YT/fnapi-js/blob/main/src/docs/DOCUMENTATION.md)
-
-## Available Endpoints
-
-- Stats
-  - Get player stats
-  - Get stats by account ID
-- Cosmetics
-  - Search cosmetics
-  - Get new cosmetics
-  - Get by ID
-  - Get tracks, instruments, cars, LEGO items, etc.
-- Creator Codes
-  - Get creator code info
-- AES
-  - Get encryption keys
-- Map
-  - Get current map info
-- News
-  - Get game news
-- Playlists
-  - Get available playlists
-  - Get playlist by ID
-- Shop
-  - Get current shop items
-- Banners
-  - Get all available banners
-  - Get all avaible banner colors
+`config.json` is git-ignored — it holds account/device-auth secrets and must never be committed.
+
+## Documentation
+
+The full API reference is consolidated in [`docs.md`](./docs.md), and the source pages live under [`docs/`](./docs) (built with VitePress).
+
+## CLI
+
+An interactive CLI covers most of the surface — auth, shop, gifting, party, live events, Fortnite endpoints:
+
+```bash
+npm run cli
+```
 
 ## License
 
-MIT
+[MIT](./LICENSE)

package/config.example.json

@@ -0,0 +1,24 @@
+{
+  "apiKey": "",
+  "language": "en",
+  "timeout": 30000,
+  "retries": 3,
+  "cache": {
+    "enabled": false,
+    "ttl": 60000
+  },
+  "live": {
+    "playerName": "Ninja",
+    "cosmeticId": "CID_028_Athena_Commando_F",
+    "playlistId": "playlist_defaultsolo",
+    "creatorCode": "ninja"
+  },
+  "epic": {
+    "client": "fortniteAndroid",
+    "deviceAuth": {
+      "accountId": "",
+      "deviceId": "",
+      "secret": ""
+    }
+  }
+}