item pinning (#8918)

* toggle pinned state of items server + client

* pin quests / add pin src

* add officially pinned items and api to get in app rewards

* update schema and get items deatils

* update pin actions to the new logic

* show countBadge only with a number

* extract getPinKey - pin seasonal items

* togglePinned in buy-dialogs

* add pinKey to shop items

* wip

* wip

* fix path

* togglePinnedItem as common.op / use in client

* fix linting

* pinning: getItemInfo and save in db path and type

* make api more consistent, fix bugs

* updates

* fix bugs

* update actions to current api

* marketGear

* change to pinType

* add mystery_set to getItemInfo

* fix isPinned

* ignore animals

* list shopItems (initial)

* shopItem now has default popoverconent, itemclass and price / currency - list pinned items as rewards - attributes to gear

* show buyModal for the rewards

* show mystery_set icon

* add info whether item is suggested

* write migration, fix style issues

* pin potion and armoire

* make potion, armoire not unpinnable

* show notes for armoire and potion, add default items for new users

* show unpin notification

* add/remove pinned gear on class-change

* remove pinned & add new gear on purchase - refactoring pinning methods - fixes

* always allow to purchase armoire

* highlight item if suggested

website/common/script/ops/buyGear.js

@@ -11,6 +11,8 @@ import {
 import handleTwoHanded from '../fns/handleTwoHanded';
 import ultimateGear from '../fns/ultimateGear';
 
+import { removePinnedGearAddPossibleNewOnes } from './pinnedGearUtils';
+
 module.exports = function buyGear (user, req = {}, analytics) {
   let key = get(req, 'params.key');
   if (!key) throw new BadRequest(i18n.t('missingKeyParam', req.language));
@@ -38,6 +40,7 @@ module.exports = function buyGear (user, req = {}, analytics) {
     message = handleTwoHanded(user, item, undefined, req);
   }
 
+  removePinnedGearAddPossibleNewOnes(user, `gear.flat.${item.key}`);
   user.items.gear.owned[item.key] = true;
 
   if (item.last) ultimateGear(user);

website/common/script/ops/changeClass.js

@@ -7,8 +7,11 @@ import {
   NotAuthorized,
   BadRequest,
 } from '../libs/errors';
+import { removePinnedGearByClass, addPinnedGearByClass } from './pinnedGearUtils';
 
 function resetClass (user, req = {}) {
+  removePinnedGearByClass(user);
+
   if (user.preferences.disableClasses) {
     user.preferences.disableClasses = false;
     user.preferences.autoAllocate = false;
@@ -41,6 +44,8 @@ module.exports = function changeClass (user, req = {}, analytics) {
     user.stats.class = klass;
     user.flags.classSelected = true;
 
+    addPinnedGearByClass(user);
+
     user.items.gear.owned[`weapon_${klass}_0`] = true;
     if (klass === 'rogue')  user.items.gear.owned[`shield_${klass}_0`] = true;
 

website/common/script/ops/index.js

@@ -40,6 +40,7 @@ import readCard from './readCard';
 import openMysteryItem from './openMysteryItem';
 import scoreTask from './scoreTask';
 import markPmsRead from './markPMSRead';
+import * as pinnedGearUtils from './pinnedGearUtils';
 
 module.exports = {
   sleep,
@@ -84,4 +85,5 @@ module.exports = {
   openMysteryItem,
   scoreTask,
   markPmsRead,
+  pinnedGearUtils,
 };

website/common/script/ops/pinnedGearUtils.js

@@ -0,0 +1,119 @@
+import content from '../content/index';
+import getItemInfo from '../libs/getItemInfo';
+import get from 'lodash/get';
+import { BadRequest } from '../libs/errors';
+import i18n from '../i18n';
+
+const officialPinnedItems = content.officialPinnedItems;
+
+import updateStore from '../libs/updateStore';
+
+function addPinnedGearByClass (user) {
+  if (user.flags.classSelected) {
+    let newPinnedItems = updateStore(user);
+
+    for (let item of newPinnedItems) {
+      let itemInfo = getItemInfo(user, 'marketGear', item);
+
+      user.pinnedItems.push({
+        type: 'marketGear',
+        path: itemInfo.path,
+      });
+    }
+  }
+}
+
+function removeItemByPath (user, path) {
+  const foundIndex = user.pinnedItems.findIndex(pinnedItem => {
+    return pinnedItem.path === path;
+  });
+
+  if (foundIndex >= 0) {
+    user.pinnedItems.splice(foundIndex, 1);
+    return true;
+  }
+
+  return false;
+}
+
+function removePinnedGearByClass (user) {
+  if (user.flags.classSelected) {
+    let currentPinnedItems = updateStore(user);
+
+    for (let item of currentPinnedItems) {
+      let itemInfo = getItemInfo(user, 'marketGear', item);
+
+      removeItemByPath(user, itemInfo.path);
+    }
+  }
+}
+
+function removePinnedGearAddPossibleNewOnes (user, itemPath) {
+  let currentPinnedItems = updateStore(user);
+  let removeAndAddAllItems = false;
+
+  for (let item of currentPinnedItems) {
+    let itemInfo = getItemInfo(user, 'marketGear', item);
+
+    if (itemInfo.path === itemPath) {
+      removeAndAddAllItems = true;
+      break;
+    }
+  }
+
+  removeItemByPath(user, itemPath);
+
+  if (removeAndAddAllItems) {
+    // an item of the users current "new" gear was bought
+    // remove the old pinned gear items and add the new gear back
+    removePinnedGearByClass(user);
+    addPinnedGearByClass(user);
+  }
+}
+
+/**
+ * @returns {boolean} TRUE added the item / FALSE removed it
+ */
+function togglePinnedItem (user, {item, type, path}, req = {}) {
+  let arrayToChange;
+
+  if (!path) { // If path isn't passed it means an item was passed
+    path = getItemInfo(user, type, item, req.language).path;
+  }
+
+  if (!item) item = get(content, path);
+
+  if (path === 'armoire' || path === 'potion') {
+    throw new BadRequest(i18n.t('cannotUpinArmoirPotion', req.language));
+  }
+
+  let isOfficialPinned = officialPinnedItems.find(officialPinnedItem => {
+    return officialPinnedItem.path === path;
+  }) !== undefined;
+
+  if (isOfficialPinned) {
+    arrayToChange = user.unpinnedItems;
+  } else {
+    arrayToChange = user.pinnedItems;
+  }
+
+  const foundIndex = arrayToChange.findIndex(pinnedItem => {
+    return pinnedItem.path === path;
+  });
+
+  if (foundIndex >= 0) {
+    arrayToChange.splice(foundIndex, 1);
+    return isOfficialPinned;
+  } else {
+    arrayToChange.push({path, type});
+    return !isOfficialPinned;
+  }
+}
+
+module.exports = {
+  addPinnedGearByClass,
+  removePinnedGearByClass,
+  removePinnedGearAddPossibleNewOnes,
+  togglePinnedItem,
+  removeItemByPath,
+};