Add new settings (#286)

* Add new settings

* Upgrade client signature

* OK

Author: bhollis

api/shapes/settings.ts

@@ -22,6 +22,13 @@ export const enum VaultWeaponGroupingStyle {
   Inline,
 }
 
+export const enum OrnamentDisplay {
+  /** Always display the ornament's image. */
+  All,
+  /** Always display the base image. */
+  None,
+}
+
 export interface Settings {
   /** Show item quality percentages */
   readonly itemQuality: boolean;
@@ -166,6 +173,15 @@ export interface Settings {
 
   /** The currently selected item popup tab. */
   itemPopupTab: ItemPopupTab;
+
+  /** Whether to show vaulted items underneath equipped items in Desktop view. */
+  vaultBelow: boolean;
+
+  /** Different modes for how armor stats can be compared. */
+  armorCompare: 'current' | 'base' | 'baseMasterwork';
+
+  /** Whether to show the ornamented state of items. */
+  ornamentDisplay: OrnamentDisplay;
 }
 
 export const defaultSettings: Settings = {
@@ -259,4 +275,7 @@ export const defaultSettings: Settings = {
   vaultWeaponGroupingStyle: VaultWeaponGroupingStyle.Lines,
   vaultArmorGroupingStyle: VaultWeaponGroupingStyle.Inline,
   itemPopupTab: ItemPopupTab.Overview,
+  vaultBelow: false,
+  armorCompare: 'baseMasterwork',
+  ornamentDisplay: OrnamentDisplay.All,
 };

api/stately/client.ts

@@ -1,8 +1,11 @@
+import { nodeTransport } from '@stately-cloud/client/node';
 import { createClient } from './generated/index.js';
 
 /**
  * Our StatelyDB client, bound to our types and store.
  */
-export const client = createClient(BigInt(process.env.STATELY_STORE_ID!), {
+export const client = createClient({
+  storeId: BigInt(process.env.STATELY_STORE_ID!),
   region: process.env.STATELY_REGION || 'us-west-2',
+  transport: nodeTransport,
 });

api/stately/generated/README.md

@@ -3,8 +3,8 @@
 This is an auto-generated README file to help you understand your schema!
 
 * SchemaID => `8030842688320564`
-* Schema Version => `8`
-* See schema on the [Stately Console](https://console.stately.cloud/1org/schemas/8030842688320564).
+* Schema Version => `9`
+* See schema on the [Stately Console](https://console.stately.cloud/6529794557127699/schemas/?schemaVersion=9).
 
 ### Key Path Layout
 

api/stately/generated/index.d.ts

@@ -1,5 +1,5 @@
 // @generated by Stately. DO NOT EDIT.
-/* eslint-disable */
+ 
 
 export * from './stately_item_types.js';
 export * from './stately_pb.js';

api/stately/generated/stately_item_types.d.ts

@@ -1,10 +1,11 @@
 // @generated by Stately. DO NOT EDIT.
-/* eslint-disable */
+ 
 
 import type {
   ClientOptions,
   DatabaseClient as GenericDatabaseClient,
-  StoreID,
+  Item,
+  ItemInit,
 } from '@stately-cloud/client';
 import type {
   ApiApp,
@@ -89,8 +90,32 @@ export type AnyItem =
   | Settings
   | Triumph;
 
+type TypeMap = typeof itemTypeToSchema;
+
 // DatabaseClient is a database client that has been customized with your schema.
-export type DatabaseClient = GenericDatabaseClient<typeof itemTypeToSchema, AllItemTypes>;
+export type DatabaseClient = GenericDatabaseClient<TypeMap, AllItemTypes>;
+
+/**
+ * Create a new DatabaseClient bound to your schema that allows operations against
+ * stores that use that schema.
+ * @example
+ * import { createClient } from "./my_schema";
+ *  import { nodeTransport } from "@stately-cloud/client/node";
+ * const client = createClient({ storeId: 1221515n, transport: nodeTransport });
+ * const item = await client.get("Equipment", "/jedi-luke/equipment-lightsaber");
+ * @private this is used by the generated code and should not be called directly.
+ */
+export declare function createClient(options: ClientOptions): DatabaseClient;
 
-// createClient creates a new database client with your schema.
-export declare function createClient(storeId: StoreID, opts?: ClientOptions): DatabaseClient;
+/**
+ * create builds a new item of the specified type. You *must* use this
+ * function to create items so that they have the proper metadata for the
+ * client to use them.
+ * @param typeName - One of the itemType or objectType names from your schema.
+ * @param init - The initial data for the item. Any values that aren't set
+ * here will be set to their zero value.
+ */
+export declare function create<T extends keyof TypeMap>(
+  typeName: T,
+  init?: ItemInit<TypeMap, T>,
+): Item<TypeMap, T>;

api/stately/generated/stately_item_types.js

@@ -1,7 +1,7 @@
 // @generated by Stately. DO NOT EDIT.
 /* eslint-disable */
 
-import { createClient as createGenericClient } from '@stately-cloud/client';
+import { createClient as createGenericClient, makeCreateFunction } from '@stately-cloud/client';
 import {
   ApiAppSchema,
   ArtifactUnlocksSchema,
@@ -56,14 +56,22 @@ export const typeToSchema = {
 };
 
 /** The version of the schema that this client was generated for. */
-const SCHEMA_VERSION_ID = 8;
-const SCHEMA_ID = 8030842688320564;
+export const SCHEMA_VERSION_ID = 9;
+export const SCHEMA_ID = 8030842688320564;
 
-export function createClient(storeId, opts) {
-  return createGenericClient(storeId, typeToSchema, SCHEMA_VERSION_ID, SCHEMA_ID, opts);
+export function createClient({ storeId, transport, ...transportOptions }) {
+  return createGenericClient({
+    storeId,
+    itemTypeMap: typeToSchema,
+    schemaVersionID: SCHEMA_VERSION_ID,
+    schemaID: SCHEMA_ID,
+    clientFactory: transport(transportOptions),
+  });
 }
 
-if (createGenericClient.length < 4) {
+export const create = makeCreateFunction(typeToSchema);
+
+if (createGenericClient.length !== 1) {
   throw new Error(
     'Your version of @stately-cloud/client is too old. Please update to the latest version.',
   );