Add new loadout parameters and settings (#277)

* Add minstat/maxstat to stat constraints

* Add armor perks constraints

* Add new fields to stately model

* Add a new setting

* Add validation

* Fix

* Upgrade

* Oof

Author: bhollis

api/shapes/loadouts.ts

@@ -127,6 +127,25 @@ export interface LoadoutParameters {
    */
   mods?: number[];
 
+  /**
+   * A list of perks that should be activated by this loadout. This expresses a
+   * desire in the Loadout Optimizer to generate sets that have these perks.
+   *
+   * For "armor set perks" this indicates that the perk should be activated by
+   * having enough set pieces to activate it. For regular perks, each occurrence
+   * of the perk in this list represents one instance of the perk that should
+   * appear on an item in the loadout.
+   *
+   * For example, this can be used to:
+   * - Specify what exotic class item perks you want
+   * - Specify set bonuses that you want to activate
+   * - Specify that you want some seasonal armor perks to be used (e.g. 3
+   *   instances of the Iron Banner experience perk)
+   *
+   *  For picking specific perks on weapons, use modsByBucket instead.
+   */
+  perks?: number[];
+
   /**
    * If set, after applying the mods above, all other mods will be removed from armor.
    */
@@ -206,6 +225,7 @@ export const defaultLoadoutParameters: LoadoutParameters = {
     { statHash: 4244567218 }, // Strength
   ],
   mods: [],
+  perks: [],
   assumeArmorMasterwork: AssumeArmorMasterwork.None,
   autoStatMods: true,
   includeRuntimeStatBenefits: true,
@@ -218,8 +238,24 @@ export const defaultLoadoutParameters: LoadoutParameters = {
 export interface StatConstraint {
   /** The stat definition hash of the stat */
   statHash: number;
-  /** The minimum tier value for the stat. 0 if unset. */
+  /**
+   * The minimum tier value for the stat. 0 if unset.
+   * @deprecated in favor of minStat
+   */
   minTier?: number;
-  /** The maximum tier value for the stat. 10 if unset. */
+  /**
+   * The maximum tier value for the stat. 10 if unset.
+   * @deprecated in favor of maxStat
+   */
   maxTier?: number;
+  /**
+   * Minimum absolute value for the stat. 0 if unset. Replaces minTier in Edge
+   * of Fate.
+   */
+  minStat?: number;
+  /**
+   * Maximum absolute value for the stat. Max Possible Stat Value if unset.
+   * Replaces maxTier in Edge of Fate.
+   */
+  maxStat?: number;
 }

api/shapes/settings.ts

@@ -158,6 +158,9 @@ export interface Settings {
   /** How grouped weapons in the vault should be displayed. */
   vaultWeaponGroupingStyle: VaultWeaponGroupingStyle;
 
+  /** How grouped armor in the vault should be displayed. */
+  vaultArmorGroupingStyle: VaultWeaponGroupingStyle;
+
   /** The currently selected item popup tab. */
   itemPopupTab: ItemPopupTab;
 }
@@ -250,5 +253,6 @@ export const defaultSettings: Settings = {
   vendorsHideSilverItems: false,
   vaultWeaponGrouping: '',
   vaultWeaponGroupingStyle: VaultWeaponGroupingStyle.Lines,
+  vaultArmorGroupingStyle: VaultWeaponGroupingStyle.Inline,
   itemPopupTab: ItemPopupTab.Overview,
 };

api/stately/generated/stately_item_types.d.ts

@@ -12,8 +12,8 @@ import type {
   ArtifactUnlocksSchema,
   CollapsedSectionSchema,
   CustomStatDefSchema,
-  CustomStatWeightsEntrySchema,
   CustomStatsEntrySchema,
+  CustomStatWeightsEntrySchema,
   GlobalSettings,
   GlobalSettingsSchema,
   InGameLoadoutIdentifiersSchema,
@@ -52,8 +52,8 @@ export declare const itemTypeToSchema: {
   ArtifactUnlocks: typeof ArtifactUnlocksSchema;
   CollapsedSection: typeof CollapsedSectionSchema;
   CustomStatDef: typeof CustomStatDefSchema;
-  CustomStatWeightsEntry: typeof CustomStatWeightsEntrySchema;
   CustomStatsEntry: typeof CustomStatsEntrySchema;
+  CustomStatWeightsEntry: typeof CustomStatWeightsEntrySchema;
   InGameLoadoutIdentifiers: typeof InGameLoadoutIdentifiersSchema;
   LoadoutItem: typeof LoadoutItemSchema;
   LoadoutParameters: typeof LoadoutParametersSchema;

api/stately/generated/stately_item_types.js

@@ -42,8 +42,8 @@ export const typeToSchema = {
   ArtifactUnlocks: ArtifactUnlocksSchema,
   CollapsedSection: CollapsedSectionSchema,
   CustomStatDef: CustomStatDefSchema,
-  CustomStatWeightsEntry: CustomStatWeightsEntrySchema,
   CustomStatsEntry: CustomStatsEntrySchema,
+  CustomStatWeightsEntry: CustomStatWeightsEntrySchema,
   InGameLoadoutIdentifiers: InGameLoadoutIdentifiersSchema,
   LoadoutItem: LoadoutItemSchema,
   LoadoutParameters: LoadoutParametersSchema,
@@ -54,13 +54,14 @@ export const typeToSchema = {
 };
 
 /** The version of the schema that this client was generated for. */
-const SCHEMA_VERSION_ID = 3;
+const SCHEMA_VERSION_ID = 6;
+const SCHEMA_ID = 8030842688320564;
 
 export function createClient(storeId, opts) {
-  return createGenericClient(storeId, typeToSchema, SCHEMA_VERSION_ID, opts);
+  return createGenericClient(storeId, typeToSchema, SCHEMA_VERSION_ID, SCHEMA_ID, opts);
 }
 
-if (createGenericClient.length < 3) {
+if (createGenericClient.length < 4) {
   throw new Error(
     'Your version of @stately-cloud/client is too old. Please update to the latest version.',
   );