Merge Places module into the Metaverse module

To consolidate metaverse API methods.
vircadia · Sep 5, 2023 · a943334 · a943334
1 parent e7f313a
commit a943334
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 63 deletions.
diff --git a/src/components/overlays/explore/Explore.vue b/src/components/overlays/explore/Explore.vue
@@ -479,7 +479,8 @@ import { Vector3, Vector4 } from "@babylonjs/core";
 import { applicationStore, userStore } from "@Stores/index";
 import { Utility } from "@Modules/utility";
 import { Location } from "@Modules/domain/location";
-import { Places, PlaceEntry } from "@Modules/places";
+import { API } from "@Modules/metaverse/API";
+import type { PlaceEntry } from "@Modules/metaverse/APIPlaces";
 import { Renderer } from "@Modules/scene";
 import Log from "@Modules/debugging/log";
 import OverlayShell from "../OverlayShell.vue";
@@ -515,7 +516,7 @@ export default defineComponent({
 
     data() {
         return {
-            placesList: [] as PlaceEntry[],
+            placesList: new Array<PlaceEntry>(),
             loading: false,
             filterText: "",
             locationInput: "",
@@ -598,7 +599,7 @@ export default defineComponent({
     methods: {
         async loadPlacesList(): Promise<void> {
             this.loading = true;
-            this.placesList = await Places.getActiveList();
+            this.placesList = await API.getActivePlaceList();
             this.loading = false;
         },
 

diff --git a/src/modules/metaverse/API.ts b/src/modules/metaverse/API.ts
@@ -13,8 +13,9 @@ import { MetaverseManager } from "@Modules/metaverse";
 import { Account } from "../account";
 import { GetAccountAPI, PostUsersAPI } from "@Modules/metaverse/APIAccount";
 import { MetaverseInfoAPI } from "@Modules/metaverse/APIInfo";
-import { GetPlacesAPI } from "@Modules/metaverse/APIPlaces";
+import { GetPlacesAPI, type GetPlacesResponse, type PlaceEntry } from "@Modules/metaverse/APIPlaces";
 import { OAuthTokenAPI } from "@Modules/metaverse/APIToken";
+import Log, { findErrorMessage } from "@Modules/debugging/log";
 
 /**
  * Standard response from Metaverse server API requests.
@@ -124,4 +125,34 @@ export class API {
         }
         throw new Error(`Vircadia API POST request to ${path} failed: ${response.status}: ${response.statusText}`);
     }
+
+    /**
+     * @returns A list of the places (worlds) available in the connected Metaverse.
+     */
+    public static async getActivePlaceList(): Promise<PlaceEntry[]> {
+        const places: PlaceEntry[] = [];
+
+        if (!MetaverseManager.activeMetaverse?.isConnected) {
+            Log.error(Log.types.PLACES, "Attempted to get places when not connected to a Metaverse server.");
+        }
+
+        try {
+            const placesResponse = await this.get(this.endpoints.places + "?status=online") as GetPlacesResponse;
+
+            for (const place of placesResponse.places) {
+                places.push({
+                    name: place.name,
+                    placeId: place.placeId,
+                    address: place.address,
+                    description: place.description,
+                    thumbnail: place.thumbnail ?? "",
+                    currentAttendance: place.current_attendance ?? 0
+                });
+            }
+        } catch (error) {
+            Log.error(Log.types.PLACES, `Exception while attempting to get places: ${findErrorMessage(error)}`);
+        }
+
+        return places;
+    }
 }
diff --git a/src/modules/metaverse/APIPlaces.ts b/src/modules/metaverse/APIPlaces.ts
@@ -18,3 +18,11 @@ export interface GetPlacesResponse {
     "places": PlaceInfo[],
     "maturity-categories": string[]
 }
+export interface PlaceEntry {
+    name: string;
+    placeId: string;
+    address: string;
+    description: string;
+    thumbnail: string;
+    currentAttendance: number;
+}
diff --git a/src/modules/places/index.ts b/src/modules/places/index.ts
diff --git a/src/pages/FirstTimeSetup.vue b/src/pages/FirstTimeSetup.vue
@@ -498,7 +498,8 @@ import { defineComponent } from "vue";
 import { uniqueNamesGenerator, adjectives, colors, animals } from "unique-names-generator";
 import { AvatarStoreInterface } from "@Modules/avatar/StoreInterface";
 import { Utility } from "@Modules/utility";
-import { Places, PlaceEntry } from "@Modules/places";
+import { API } from "@Modules/metaverse/API";
+import type { PlaceEntry } from "@Modules/metaverse/APIPlaces";
 
 export default defineComponent({
     name: "FirstTimeSetup",
@@ -509,7 +510,7 @@ export default defineComponent({
             transition: false,
             step: 1,
             AvatarStoreInterface,
-            placesList: [] as PlaceEntry[],
+            placesList: new Array<PlaceEntry>(),
             selectedPlace: {} as PlaceEntry
         };
     },
@@ -629,7 +630,7 @@ export default defineComponent({
          */
         async loadPlaces(): Promise<void> {
             await Utility.metaverseConnectionSetup(applicationStore.defaultConnectionConfig.DEFAULT_METAVERSE_URL ?? "");
-            this.placesList = await Places.getActiveList();
+            this.placesList = await API.getActivePlaceList();
         },
         /**
          * Register the first-time-setup process as complete, and redirect to any pending location.