@ughuuu/game_server 1.0.0

package/README.md

@@ -0,0 +1,188 @@
+# game_server
+
+GameServer - JavaScript client for game_server
+API for Game Server application
+
+## Authentication
+
+This API uses JWT (JSON Web Tokens) with access and refresh tokens:
+
+### Getting Tokens
+- **Email/Password**: POST to `/api/v1/login` with email and password
+- **Discord OAuth**: Use `/api/v1/auth/discord` flow
+- **Google OAuth**: Use `/api/v1/auth/google` flow
+- **Facebook OAuth**: Use `/api/v1/auth/facebook` flow
+- **Apple Sign In**: Use `/auth/apple` browser flow (API flow not yet implemented)
+
+Both methods return:
+- `access_token` - Short-lived (15 min), use for API requests
+- `refresh_token` - Long-lived (30 days), use to get new access tokens
+
+### Using Tokens
+Include the access token in the Authorization header:
+```
+Authorization: Bearer <access_token>
+```
+
+### Refreshing Tokens
+When your access token expires, use POST `/api/v1/refresh` with your refresh token to get a new access token.
+
+## Endpoints
+All API endpoints are under `/api/v1`
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 1.0.0
+- Package version: 1.0.0
+- Generator version: 7.17.0
+- Build package: org.openapitools.codegen.languages.JavascriptClientCodegen
+
+## Installation
+
+### For [Node.js](https://nodejs.org/)
+
+#### npm
+
+To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
+
+Then install it via:
+
+```shell
+npm install game_server --save
+```
+
+Finally, you need to build the module:
+
+```shell
+npm run build
+```
+
+##### Local development
+
+To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run:
+
+```shell
+npm install
+```
+
+Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`:
+
+```shell
+npm link
+```
+
+To use the link you just defined in your project, switch to the directory you want to use your game_server from, and run:
+
+```shell
+npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
+```
+
+Finally, you need to build the module:
+
+```shell
+npm run build
+```
+
+#### git
+
+If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID
+then install it via:
+
+```shell
+    npm install GIT_USER_ID/GIT_REPO_ID --save
+```
+
+### For browser
+
+The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following
+the above steps with Node.js and installing browserify with `npm install -g browserify`,
+perform the following (assuming *main.js* is your entry file):
+
+```shell
+browserify main.js > bundle.js
+```
+
+Then include *bundle.js* in the HTML pages.
+
+### Webpack Configuration
+
+Using Webpack you may encounter the following error: "Module not found: Error:
+Cannot resolve module", most certainly you should disable AMD loader. Add/merge
+the following section to your webpack config:
+
+```javascript
+module: {
+  rules: [
+    {
+      parser: {
+        amd: false
+      }
+    }
+  ]
+}
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) instruction and execute the following JS code:
+
+```javascript
+var GameServer = require('game_server');
+
+
+var api = new GameServer.AuthenticationApi()
+var opts = {
+  'loginRequest': new GameServer.LoginRequest() // {LoginRequest} Login credentials
+};
+api.login(opts).then(function(data) {
+  console.log('API called successfully. Returned data: ' + data);
+}, function(error) {
+  console.error(error);
+});
+
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *http://localhost:4000*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*GameServer.AuthenticationApi* | [**login**](docs/AuthenticationApi.md#login) | **POST** /api/v1/login | Login
+*GameServer.AuthenticationApi* | [**logout**](docs/AuthenticationApi.md#logout) | **DELETE** /api/v1/logout | Logout
+*GameServer.AuthenticationApi* | [**oauthConflictDelete**](docs/AuthenticationApi.md#oauthConflictDelete) | **POST** /api/v1/auth/{provider}/conflict-delete | Delete conflicting provider account
+*GameServer.AuthenticationApi* | [**oauthRequest**](docs/AuthenticationApi.md#oauthRequest) | **GET** /api/v1/auth/{provider} | Initiate API OAuth
+*GameServer.AuthenticationApi* | [**oauthSessionStatus**](docs/AuthenticationApi.md#oauthSessionStatus) | **GET** /api/v1/auth/session/{session_id} | Get OAuth session status
+*GameServer.AuthenticationApi* | [**refreshToken**](docs/AuthenticationApi.md#refreshToken) | **POST** /api/v1/refresh | Refresh access token
+*GameServer.AuthenticationApi* | [**unlinkProvider**](docs/AuthenticationApi.md#unlinkProvider) | **DELETE** /api/v1/me/providers/{provider} | Unlink OAuth provider
+*GameServer.HealthApi* | [**index**](docs/HealthApi.md#index) | **GET** /api/v1/health | Health check
+*GameServer.UsersApi* | [**getCurrentUser**](docs/UsersApi.md#getCurrentUser) | **GET** /api/v1/me | Return current user info
+*GameServer.UsersApi* | [**getUserMetadata**](docs/UsersApi.md#getUserMetadata) | **GET** /api/v1/me/metadata | Return current user&#39;s metadata
+
+
+## Documentation for Models
+
+ - [GameServer.GetCurrentUser200Response](docs/GetCurrentUser200Response.md)
+ - [GameServer.GetCurrentUser200ResponseData](docs/GetCurrentUser200ResponseData.md)
+ - [GameServer.HealthResponse](docs/HealthResponse.md)
+ - [GameServer.Login200Response](docs/Login200Response.md)
+ - [GameServer.Login200ResponseData](docs/Login200ResponseData.md)
+ - [GameServer.Login200ResponseDataUser](docs/Login200ResponseDataUser.md)
+ - [GameServer.LoginRequest](docs/LoginRequest.md)
+ - [GameServer.Logout200Response](docs/Logout200Response.md)
+ - [GameServer.OauthRequest200Response](docs/OauthRequest200Response.md)
+ - [GameServer.OauthSessionStatus200Response](docs/OauthSessionStatus200Response.md)
+ - [GameServer.RefreshToken200Response](docs/RefreshToken200Response.md)
+ - [GameServer.RefreshToken200ResponseData](docs/RefreshToken200ResponseData.md)
+ - [GameServer.RefreshTokenRequest](docs/RefreshTokenRequest.md)
+
+
+## Documentation for Authorization
+
+
+Authentication schemes defined for the API:
+### authorization
+
+- **Type**: Bearer authentication (JWT)
+