[econ] room storefront purchaseables

apps/econ/src/room-purchasables-db.ts

@@ -0,0 +1,119 @@
+/**
+ * Everything a room sells, in one list — what `GET /api/ugcPurchasables/v1/items/room/:roomId`
+ * answers. There is no table of its own: the list is assembled on read from the three tables
+ * that hold a room's listings — `room_key` (room-key-db), `room_consumable`
+ * (room-consumable-db) and the purchase offers inside `room_currency` (room-currency-db) —
+ * each projected into the client's 10-key `UgcPurchasableItem` with `ItemType` saying which
+ * it is. One shape for three kinds of thing, which is the point of the route: the client
+ * draws the room's shop from it without knowing which table a line came from.
+ */
+import { getRoomConsumables } from './room-consumable-db'
+import { getPurchaseOffers, getRoomCurrencies } from './room-currency-db'
+import { getRoomKeys } from './room-key-db'
+
+/**
+ * The client's `ItemType` enum for a UGC purchasable, numeric on the wire. Recovered from the
+ * client: RoomKey 0, RoomConsumable 1, RoomCurrencyItem 3, StoreUGCAvatarItem 4, UNDEFINED 5
+ * — 2 is unassigned. Note this is NOT the `itemType` inside the `{ itemType, itemId }`
+ * reference `…/items/bulk` and `/api/items/purchaseInfos` take, where a custom avatar item
+ * is 3 (`UGC_ITEM_TYPE_CUSTOM_AVATAR_ITEM`); the two enums share a name and little else.
+ */
+export const ROOM_PURCHASABLE_TYPE = {
+	roomKey: 0,
+	roomConsumable: 1,
+	roomCurrencyItem: 3,
+	storeUgcAvatarItem: 4,
+	undefined: 5,
+} as const
+
+/**
+ * One line of a room's shop — the client's `UgcPurchasableItem`, 10 keys. `ItemId` is a bare
+ * GUID string, with the kind beside it as `ItemType`, not the `{ itemType, itemId }` struct
+ * the bulk lookups use. `Price` is a `long` in the client's model. `ImageName` is null for a
+ * listing with no art, as the key and consumable routes already serve it.
+ */
+export interface RoomPurchasable {
+	ItemType: number
+	ItemId: string
+	Name: string
+	Description: string
+	ImageName: string | null
+	RoomId: number
+	Price: number
+	/** A `room_currency` id the line is charged in, or null for tokens. */
+	PurchaseCurrencyId: string | null
+	/** ISO-8601 UTC. */
+	CreatedAt: string
+	/** ISO-8601 UTC. */
+	ModifiedAt: string
+}
+
+/**
+ * A room's shop: its keys, then its consumables, then the purchase offers of each of its
+ * currencies. Each kind keeps its own module's order. A room that sells nothing is `[]` —
+ * never `{}` or an empty body, which the client's decoder throws on.
+ *
+ * What stands in for what each table lacks:
+ *  - A key is named by its `ReplicationId`, the GUID minted beside its numeric `RoomKeyId`
+ *    (`ItemId` is a Guid in the client's model). Nothing records when a key was last edited,
+ *    so `ModifiedAt` is its `CreatedAt`.
+ *  - A consumable records only `ModifiedAt`, which stands as its `CreatedAt` too.
+ *  - A purchase offer is a pack of the room's currency sold for TOKENS, so its
+ *    `PurchaseCurrencyId` is null; it has no description or art of its own, and the one
+ *    timestamp it keeps serves as both.
+ */
+export async function getRoomPurchasables(
+	db: D1Database,
+	roomId: number
+): Promise<RoomPurchasable[]> {
+	const [keys, consumables, currencies] = await Promise.all([
+		getRoomKeys(db, roomId),
+		getRoomConsumables(db, roomId),
+		getRoomCurrencies(db, roomId),
+	])
+	const offers = await getPurchaseOffers(
+		db,
+		currencies.map((currency) => currency.CurrencyId)
+	)
+
+	return [
+		...keys.map((key): RoomPurchasable => ({
+			ItemType: ROOM_PURCHASABLE_TYPE.roomKey,
+			ItemId: key.ReplicationId,
+			Name: key.Name,
+			Description: key.Description,
+			ImageName: key.ImageName,
+			RoomId: key.RoomId,
+			Price: key.Price,
+			PurchaseCurrencyId: key.PurchaseCurrencyId,
+			CreatedAt: key.CreatedAt,
+			ModifiedAt: key.CreatedAt,
+		})),
+		...consumables.map((consumable): RoomPurchasable => ({
+			ItemType: ROOM_PURCHASABLE_TYPE.roomConsumable,
+			ItemId: consumable.RoomConsumableId,
+			Name: consumable.Name,
+			Description: consumable.Description,
+			ImageName: consumable.ImageName,
+			RoomId: consumable.RoomId,
+			Price: consumable.Price,
+			PurchaseCurrencyId: consumable.PurchaseCurrencyId,
+			CreatedAt: consumable.ModifiedAt,
+			ModifiedAt: consumable.ModifiedAt,
+		})),
+		...offers.flatMap((shop) =>
+			shop.PurchaseOffers.map((offer): RoomPurchasable => ({
+				ItemType: ROOM_PURCHASABLE_TYPE.roomCurrencyItem,
+				ItemId: offer.CurrencyPurchaseOfferId,
+				Name: offer.Name,
+				Description: '',
+				ImageName: null,
+				RoomId: roomId,
+				Price: offer.Price,
+				PurchaseCurrencyId: null,
+				CreatedAt: offer.ModifiedAt,
+				ModifiedAt: offer.ModifiedAt,
+			}))
+		),
+	]
+}