refactor: add types for shop config in metadata

Author: Jameskmonger

src/engine/config/shop-config.ts

@@ -97,8 +97,8 @@ export class Shop {
     }
 
     public open(player: Player): void {
-        player.metadata['lastOpenedShop'] = this;
-        player.metadata['shopCloseListener'] = player.interfaceState.closed.subscribe((whatClosed: WidgetClosedEvent) => {
+        player.metadata.lastOpenedShop = this;
+        player.metadata.shopCloseListener = player.interfaceState.closed.subscribe((whatClosed: WidgetClosedEvent) => {
             if(whatClosed && whatClosed.widget && whatClosed.widget.widgetId === widgets.shop.widgetId) {
                 this.removePlayerFromShop(player);
             }
@@ -121,7 +121,7 @@ export class Shop {
 
     private updateCustomers() {
         for (const player of this.customers) {
-            if(player.metadata['lastOpenedShop'] === this) {
+            if(player.metadata.lastOpenedShop === this) {
                 player.outgoingPackets.sendUpdateAllWidgetItems(widgets.shop, this.container);
             } else {
                 this.removePlayerFromShop(player);
@@ -130,9 +130,9 @@ export class Shop {
     }
 
     private removePlayerFromShop(player: Player) {
-        if(player.metadata['lastOpenedShop'] === this) {
-            player.metadata['lastOpenedShop'] = undefined;
-            player.metadata['shopCloseListener'].unsubscribe();
+        if(player.metadata.lastOpenedShop === this) {
+            player.metadata.lastOpenedShop = undefined;
+            player.metadata.shopCloseListener.unsubscribe();
         }
         this.customers = this.customers.filter((c) => c !== player);
     }

src/engine/world/actor/player/metadata.ts

@@ -1,3 +1,4 @@
+import { Subscription } from 'rxjs';
 import { Chunk } from '@engine/world/map';
 import { Position } from '@engine/world/position';
 
@@ -29,4 +30,18 @@ export type PlayerMetadata = {
      * The player's last position before teleporting.
      */
     lastPosition: Position;
+
+    /**
+     * The player's currently open shop.
+     *
+     * TODO (jameskmonger) This is currently an instance of `Shop`. We shouldn't be storing whole instances of classes in the metadata.
+     */
+    lastOpenedShop: any;
+
+    /**
+     * A subscription to the player's "widget closed" events.
+     *
+     * Used to remove a player from a shop when they close the shop's widget.
+     */
+    shopCloseListener: Subscription;
 };

src/plugins/items/shopping/buy-from-shop.plugin.ts

@@ -19,7 +19,7 @@ export const handler: itemInteractionActionHandler = (details) => {
         return;
     }
 
-    const openedShop: Shop = player.metadata['lastOpenedShop'];
+    const openedShop = player.metadata.lastOpenedShop;
     if(!openedShop) {
         return;
     }

src/plugins/items/shopping/item-value.plugin.ts

@@ -8,7 +8,7 @@ export const shopSellValueHandler: itemInteractionActionHandler = ({ player, ite
 };
 
 export const shopPurchaseValueHandler: itemInteractionActionHandler = ({ player, itemDetails }) => {
-    const openedShop: Shop = player.metadata['lastOpenedShop'];
+    const openedShop = player.metadata.lastOpenedShop;
     if(!openedShop) {
         return;
     }

src/plugins/items/shopping/sell-to-shop.plugin.ts

@@ -12,7 +12,7 @@ export const handler: itemInteractionActionHandler = (details) => {
         return;
     }
 
-    const openedShop: Shop = player.metadata['lastOpenedShop'];
+    const openedShop = player.metadata.lastOpenedShop;
     if(!openedShop) {
         return;
     }