Refactoring Woka management (#1810)

* Wrap websockets with HyperExpress

* Add endpoints on pusher to resolve wokas

* getting textures urls from pusher

* Adding OpenAPI documentation for the pusher.

The pusher now exposes a "/openapi" endpoint and a "/swagger-ui/" endpoint.

* revert FRONT_URL

* playerTextures metadata is being loaded via Phaser.Loader

* fetch textures every time character or customize scene is open

* Heavy changes: refactoring the pusher to always send the textures (and the front to accept them)

* Sending character layer details to admin

* Cleaning commented code

* Fixing regex

* Fix woka endpoints on pusher

* Change error wording on pusher

* Working on integration of the woka-list with the new admin endpoint.

* Switching from "name" to "id" in texture object + using zod for woka/list validation

* Add position on default woka data

* Remove async on pusher option method

* Fix woka list url

* add options for /register

* Fxiing loading the Woka list

* Actually returning something in logout-callback

* Copying messages to back too

* remove customize button if no body parts are available (#1952)

* remove customize button if no body parts are available

* remove unused position field from PlayerTexturesCollection interface

* removed unused label field

* fix LocalUser test

* little PlayerTextures class refactor

* Fixing linting

* Fixing missing Openapi packages in prod

* Fixing back build

Co-authored-by: Hanusiak Piotr <piotr@ltmp.co>
Co-authored-by: David Négrier <d.negrier@thecodingmachine.com>

* Add returns on pusher endpoints

Co-authored-by: Alexis Faizeau <a.faizeau@workadventu.re>
Co-authored-by: Hanusiak Piotr <piotr@ltmp.co>
Co-authored-by: Piotr Hanusiak <wacneg@gmail.com>

pusher/src/Services/AdminApi.ts

@@ -1,26 +1,34 @@
 import { ADMIN_API_TOKEN, ADMIN_API_URL, ADMIN_URL, OPID_PROFILE_SCREEN_PROVIDER } from "../Enum/EnvironmentVariable";
-import Axios from "axios";
-import { GameRoomPolicyTypes } from "_Model/PusherRoom";
-import { CharacterTexture } from "../Messages/JsonMessages/CharacterTexture";
+import Axios, { AxiosResponse } from "axios";
 import { MapDetailsData } from "../Messages/JsonMessages/MapDetailsData";
 import { RoomRedirect } from "../Messages/JsonMessages/RoomRedirect";
 import { AdminApiData, isAdminApiData } from "../Messages/JsonMessages/AdminApiData";
+import * as tg from "generic-type-guard";
+import { isNumber } from "generic-type-guard";
+import { isWokaDetail } from "../Enum/PlayerTextures";
+import qs from "qs";
 
 export interface AdminBannedData {
     is_banned: boolean;
     message: string;
 }
 
-export interface FetchMemberDataByUuidResponse {
-    email: string;
-    userUuid: string;
-    tags: string[];
-    visitCardUrl: string | null;
-    textures: CharacterTexture[];
-    messages: unknown[];
-    anonymous?: boolean;
-    userRoomToken: string | undefined;
-}
+const isFetchMemberDataByUuidResponse = new tg.IsInterface()
+    .withProperties({
+        email: tg.isString,
+        userUuid: tg.isString,
+        tags: tg.isArray(tg.isString),
+        visitCardUrl: tg.isNullable(tg.isString),
+        textures: tg.isArray(isWokaDetail),
+        messages: tg.isArray(tg.isUnknown),
+    })
+    .withOptionalProperties({
+        anonymous: tg.isBoolean,
+        userRoomToken: tg.isString,
+    })
+    .get();
+
+export type FetchMemberDataByUuidResponse = tg.GuardedType<typeof isFetchMemberDataByUuidResponse>;
 
 class AdminApi {
     /**
@@ -48,15 +56,25 @@ class AdminApi {
     async fetchMemberDataByUuid(
         userIdentifier: string | null,
         roomId: string,
-        ipAddress: string
+        ipAddress: string,
+        characterLayers: string[]
     ): Promise<FetchMemberDataByUuidResponse> {
         if (!ADMIN_API_URL) {
             return Promise.reject(new Error("No admin backoffice set!"));
         }
-        const res = await Axios.get(ADMIN_API_URL + "/api/room/access", {
-            params: { userIdentifier, roomId, ipAddress },
+        const res = await Axios.get<unknown, AxiosResponse<unknown>>(ADMIN_API_URL + "/api/room/access", {
+            params: { userIdentifier, roomId, ipAddress, characterLayers },
             headers: { Authorization: `${ADMIN_API_TOKEN}` },
+            paramsSerializer: (p) => {
+                return qs.stringify(p, { arrayFormat: "brackets" });
+            },
         });
+        if (!isFetchMemberDataByUuidResponse(res.data)) {
+            throw new Error(
+                "Invalid answer received from the admin for the /api/room/access endpoint. Received: " +
+                    JSON.stringify(res.data)
+            );
+        }
         return res.data;
     }