Move Hotbar types to seperate file (#3532)

src/common/hotbar-store.ts

@@ -22,38 +22,17 @@
 import { action, comparer, observable, makeObservable } from "mobx";
 import { BaseStore } from "./base-store";
 import migrations from "../migrations/hotbar-store";
-import * as uuid from "uuid";
 import isNull from "lodash/isNull";
 import { toJS } from "./utils";
 import { CatalogEntity } from "./catalog";
 import { catalogEntity } from "../main/catalog-sources/general";
-
-export interface HotbarItem {
-  entity: {
-    uid: string;
-    name?: string;
-    source?: string;
-  };
-  params?: {
-    [key: string]: string;
-  }
-}
-
-export type Hotbar = Required<HotbarCreateOptions>;
-
-export interface HotbarCreateOptions {
-  id?: string;
-  name: string;
-  items?: (HotbarItem | null)[];
-}
+import { Hotbar, HotbarCreateOptions, HotbarItem, getEmptyHotbar } from "./hotbar-types";
 
 export interface HotbarStoreModel {
   hotbars: Hotbar[];
   activeHotbarId: string;
 }
 
-export const defaultHotbarCells = 12; // Number is chosen to easy hit any item with keyboard
-
 export class HotbarStore extends BaseStore<HotbarStoreModel> {
   @observable hotbars: Hotbar[] = [];
   @observable private _activeHotbarId: string;
@@ -89,18 +68,16 @@ export class HotbarStore extends BaseStore<HotbarStoreModel> {
     return this.hotbarIndex(this.activeHotbarId);
   }
 
-  static getInitialItems() {
-    return [...Array.from(Array(defaultHotbarCells).fill(null))];
-  }
-
   @action
   protected fromStore(data: Partial<HotbarStoreModel> = {}) {
     if (!data.hotbars || !data.hotbars.length) {
-      this.hotbars = [{
-        id: uuid.v4(),
-        name: "Default",
-        items: this.defaultHotbarInitialItems,
-      }];
+      const hotbar = getEmptyHotbar("Default");
+      const { metadata: { uid, name, source } } = catalogEntity;
+      const initialItem = { entity: { uid, name, source } };
+
+      hotbar.items[0] = initialItem;
+
+      this.hotbars = [hotbar];
     } else {
       this.hotbars = data.hotbars;
     }
@@ -116,16 +93,6 @@ export class HotbarStore extends BaseStore<HotbarStoreModel> {
     }
   }
 
-  get defaultHotbarInitialItems() {
-    const { metadata: { uid, name, source } } = catalogEntity;
-    const initialItem = { entity: { uid, name, source }};
-
-    return [
-      initialItem,
-      ...Array.from(Array(defaultHotbarCells - 1).fill(null))
-    ];
-  }
-
   getActive() {
     return this.getById(this.activeHotbarId);
   }
@@ -140,16 +107,12 @@ export class HotbarStore extends BaseStore<HotbarStoreModel> {
 
   @action
   add(data: HotbarCreateOptions, { setActive = false } = {}) {
-    const {
-      id = uuid.v4(),
-      items = HotbarStore.getInitialItems(),
-      name,
-    } = data;
+    const hotbar = getEmptyHotbar(data.name, data.id);
 
-    this.hotbars.push({ id, name, items });
+    this.hotbars.push(hotbar);
 
     if (setActive) {
-      this._activeHotbarId = id;
+      this._activeHotbarId = hotbar.id;
     }
   }
 

src/common/hotbar-types.ts

@@ -0,0 +1,52 @@
+/**
+ * Copyright (c) 2021 OpenLens Authors
+ *
+ * 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.
+ */
+
+import * as uuid from "uuid";
+import type { Tuple } from "./utils";
+
+export interface HotbarItem {
+  entity: {
+    uid: string;
+    name?: string;
+    source?: string;
+  };
+  params?: {
+    [key: string]: string;
+  }
+}
+
+export type Hotbar = Required<HotbarCreateOptions>;
+
+export interface HotbarCreateOptions {
+  id?: string;
+  name: string;
+  items?: Tuple<HotbarItem | null, typeof defaultHotbarCells>;
+}
+
+export const defaultHotbarCells = 12; // Number is chosen to easy hit any item with keyboard
+
+export function getEmptyHotbar(name: string, id: string = uuid.v4()): Hotbar {
+  return {
+    id,
+    items: Array(defaultHotbarCells).fill(null) as Tuple<HotbarItem | null, typeof defaultHotbarCells>,
+    name,
+  };
+}