@notidotbot/noti-api-client 1.4.16 → 1.4.17

package/prisma/schema/models/gameConfig.prisma

@@ -0,0 +1,128 @@
+// Game-deal subscriptions (Noti Games API integration).
+//
+// One GuildGameConfig per guild holds the routing + filter configuration. It mirrors the
+// `noti-vision-server` localStorage shape from the gameApi `/viewer` dashboard mockup, but
+// persisted in Postgres so the web dashboard + Discord commands share one source of truth.
+//
+// Premium gating is enforced in Noti (see INTEGRATION.md "Premium tiers"): the API serves
+// everything unconditionally. Free guilds get free/upcoming/weekend game alerts, genre/tag
+// filters, min-discount + max-price filters, and up to 2 tracked games. Premium unlocks
+// per-category channel/role routing (webhook identity), all-time-low alerts, unlimited
+// tracked games, and digest window customization.
+
+model GuildGameConfig {
+  dbId String @id @default(uuid())
+
+  guildId String @unique
+
+  enabled Boolean @default(false)
+
+  // Default routing — the free-tier "one channel + one mention role" target. Every
+  // notification falls back here unless a premium category route overrides it.
+  notificationChannelId String?
+  pingRoleId            String?
+
+  // Delivery tier. Window/day customization (digestHourUTC / digestWeekday) is premium;
+  // free guilds get the fixed evening window on any day.
+  deliveryMode  GameDeliveryEnum @default(instant)
+  digestHourUTC Int? // Premium. 0-23 UTC. Null = default evening window.
+  digestWeekday Int? // Premium. 0-6 (Sun-Sat) for weekly digests. Null = any/default.
+
+  // Free-to-keep games (free.new). The headline growth-loop feature — never gated.
+  freeGamesEnabled   Boolean         @default(true)
+  freeDlcEnabled     Boolean         @default(false)
+  freeGameStores     GameStoreEnum[]
+  upcomingFreeEnabled Boolean        @default(false)
+  freeWeekendEnabled Boolean         @default(false) // Steam play-for-free windows (NOT free to keep)
+
+  // Discount alerts (deal.new). Min-discount + max-price filters are free.
+  discountsEnabled   Boolean         @default(false)
+  discountStores     GameStoreEnum[]
+  minDiscountPercent Int? // 0-100. price.discountPercent >= n
+  maxPriceCents      Int? // price.finalCents <= n
+
+  // Category / studio filters (free, multi-select). Empty = no filter (match all).
+  // Matched case-insensitively against item.genres / item.tags / developers+publishers.
+  genres   String[]
+  tags     String[]
+  studios  String[]
+
+  // All-Time-Low alerts (PREMIUM) — deal.lowest events / flags.allTimeLow.
+  allTimeLowEnabled       Boolean @default(false)
+  allTimeLowMaxPriceCents Int?
+
+  // Game changelogs (PatchBot-style) — independent of price tracking.
+  changelogChannelId  String?
+  changelogPingRoleId String?
+
+  categoryRoutes GuildGameCategoryRoute[]
+  trackedGames   GuildTrackedGame[]
+  changelogGames GuildGameChangelog[]
+}
+
+// PREMIUM: per-category channel/role routing. The first route (lowest `priority`) whose
+// match criteria the event satisfies wins; webhook identity is also premium-only.
+model GuildGameCategoryRoute {
+  dbId String @id @default(uuid())
+
+  // Match criteria (empty array / null = "any").
+  kinds              GameKindEnum[]
+  stores             GameStoreEnum[]
+  flags              GameFlagEnum[]
+  genres             String[]
+  tags               String[]
+  minDiscountPercent Int?
+
+  // Routing target for matching events.
+  channelId  String?
+  pingRoleId String?
+
+  // Custom webhook identity (premium). When set, the notification is posted via a webhook
+  // with this name/avatar instead of the bot user.
+  webhookEnabled   Boolean? @default(false)
+  webhookUsername  String?
+  webhookAvatarUrl String?
+
+  priority Int @default(0)
+
+  gameConfigId String
+  gameConfig   GuildGameConfig? @relation(fields: [gameConfigId], references: [dbId], onUpdate: Cascade, onDelete: Cascade)
+
+  @@unique([gameConfigId, priority])
+}
+
+// A specific followed game. Tracked games are registered on the API watchlist so even a 5%
+// discount is tracked. Free guilds: 2 per guild; premium: unlimited (API cap 500 global).
+model GuildTrackedGame {
+  dbId String @id @default(uuid())
+
+  steamAppId Int? // resolved to a CheapShark id by the API; null for Epic-only titles
+  title      String? // normalized-title match for games without a Steam appid
+  itemId     String? // canonical deal id once observed (steam:730 / epic:...)
+
+  // Optional per-game routing override (else uses the guild default channel/role).
+  channelId  String?
+  pingRoleId String?
+
+  minDiscountPercent Int?
+  atlOnly            Boolean @default(false)
+
+  gameConfigId String
+  gameConfig   GuildGameConfig? @relation(fields: [gameConfigId], references: [dbId], onUpdate: Cascade, onDelete: Cascade)
+
+  @@unique([gameConfigId, steamAppId])
+  @@unique([gameConfigId, title])
+}
+
+// A game whose Steam patch notes / announcements this guild follows (changelog.new).
+model GuildGameChangelog {
+  dbId String @id @default(uuid())
+
+  steamAppId Int
+  title      String?
+
+  gameConfigId String
+  gameConfig   GuildGameConfig? @relation(fields: [gameConfigId], references: [dbId], onUpdate: Cascade, onDelete: Cascade)
+
+  @@unique([gameConfigId, steamAppId])
+}

package/prisma/schema/models/youtubeStreamer.prisma

@@ -17,8 +17,8 @@ model YoutubeStreamer {
   videoNotificationChannelId String?
   showNotifyButton           Boolean?
 
-  pingRoleId                   String? // Pinged on live notifications (and videos when videoRoleId is unset).
-  videoRoleId                  String? // Pinged on video notifications; falls back to pingRoleId when null.
+  pingRoleId                   String? // Pinged on live notifications only.
+  videoRoleId                  String? // Pinged on video notifications only; mentions no one when null (independent of pingRoleId).
   customCoolDownBeforeNextLive Int? // Premium. In minutes.
 
   liveRoleId           String?

package/prisma/schema/schema.prisma

@@ -1,182 +1,216 @@
 generator client {
-    provider = "prisma-client-js"
+  provider = "prisma-client-js"
 }
 
 datasource db {
-    provider = "postgresql"
-    url      = env("DATABASE_URL")
+  provider = "postgresql"
+  url      = env("DATABASE_URL")
 }
 
 generator tsPrisma {
-    provider = "ts-prisma-generator"
+  provider = "ts-prisma-generator"
 }
 
 enum LeaderBoardTypesEnum {
-    weekly
-    monthly
-    overall
+  weekly
+  monthly
+  overall
 }
 
 enum SingleMessageTypeEnum {
-    autoLiveRoleAdded
-    autoLiveRoleRemoved
-    statusRoleAdded
-    statusRoleRemoved
-    statChannelLive
-    statChannelOffline
-    statFollowers
+  autoLiveRoleAdded
+  autoLiveRoleRemoved
+  statusRoleAdded
+  statusRoleRemoved
+  statChannelLive
+  statChannelOffline
+  statFollowers
 }
 
 enum StreamerMessageTypeEnum {
-    clip
-    kickBuiltInClip
-    vod
-    kickLive
-    kickOffline
-    twitchLive
-    twitchOffline
-    rumbleLive
-    rumbleOffline
-    tiktokLive
-    tiktokOffline
-    tiktokVideo
-    youtubeLive
-    youtubeVideo
+  clip
+  kickBuiltInClip
+  vod
+  kickLive
+  kickOffline
+  twitchLive
+  twitchOffline
+  rumbleLive
+  rumbleOffline
+  tiktokLive
+  tiktokOffline
+  tiktokVideo
+  youtubeLive
+  youtubeVideo
 }
 
 enum GuildMessageTypeEnum {
-    giveawayRerolled
-    giveawayWinner
-    giveawayEnded
-    giveawayDM
-    linkedRole
-    giveaway
-    birthday
-    welcome
-    leave
-
-    // StreamerMessageTypeEnum
-    clip
-    kickBuiltInClip
-    vod
-    kickLive
-    kickOffline
-    twitchLive
-    twitchOffline
-    rumbleLive
-    rumbleOffline
-    tiktokLive
-    tiktokOffline
-    tiktokVideo
-    youtubeLive
-    youtubeVideo
+  giveawayRerolled
+  giveawayWinner
+  giveawayEnded
+  giveawayDM
+  linkedRole
+  giveaway
+  birthday
+  welcome
+  leave
+
+  // StreamerMessageTypeEnum
+  clip
+  kickBuiltInClip
+  vod
+  kickLive
+  kickOffline
+  twitchLive
+  twitchOffline
+  rumbleLive
+  rumbleOffline
+  tiktokLive
+  tiktokOffline
+  tiktokVideo
+  youtubeLive
+  youtubeVideo
 }
 
 enum GuildSingleMessageTypeEnum {
-    autoLiveRoleAdded
-    autoLiveRoleRemoved
-    statusRoleAdded
-    statusRoleRemoved
-    statChannelLive
-    statChannelOffline
-    statFollowers
+  autoLiveRoleAdded
+  autoLiveRoleRemoved
+  statusRoleAdded
+  statusRoleRemoved
+  statChannelLive
+  statChannelOffline
+  statFollowers
 }
 
 enum OverridesEnum {
-    autoPublish
-    cancel
-    dontPublish
+  autoPublish
+  cancel
+  dontPublish
 }
 
 enum PlatformEnum {
-    kick
-    twitch
-    rumble
-    tiktok
-    youtube
+  kick
+  twitch
+  rumble
+  tiktok
+  youtube
 }
 
 enum ClipperCategoryEnum {
-    vip
-    sub
-    mod
-    broadcaster
+  vip
+  sub
+  mod
+  broadcaster
 }
 
 enum UserMediaSharePermissionsEnum {
-    vip
-    sub
-    mod
-    broadcaster
-    everyone
+  vip
+  sub
+  mod
+  broadcaster
+  everyone
 }
 
 enum PlatformsWithVideosEnum {
-    tiktok
-    youtube
+  tiktok
+  youtube
 }
 
 enum RumbleTypeEnum {
-    channel
-    user
+  channel
+  user
 }
 
 enum QueryInEnum {
-    title
-    category
-    description
+  title
+  category
+  description
 }
 
 enum FilterEnum {
-    whitelist
-    blacklist
+  whitelist
+  blacklist
 }
 
 enum MediaShareTypesEnum {
-    tiktok
-    youtube
-    shorts
+  tiktok
+  youtube
+  shorts
 }
 
 enum MediaShareCommandsEnum {
-    request
-    skip
-    pause
-    clear
-    rban
-    play
-    mode
-    runban
+  request
+  skip
+  pause
+  clear
+  rban
+  play
+  mode
+  runban
 }
 
 enum RoleBonusEnum {
-    stackable
-    highest
+  stackable
+  highest
 }
 
 enum UserNotificationSeverityEnum {
-    info
-    warning
-    emergency
+  info
+  warning
+  emergency
+}
+
+// Game-deal integration (Noti Games API). `GameStoreEnum` mirrors the API's `store`,
+// `GameKindEnum` mirrors `DealKind`, `GameFlagEnum` the notify-worthy `DealItem.flags`.
+enum GameStoreEnum {
+  steam
+  epic
+  gog
+  prime
+}
+
+enum GameKindEnum {
+  free_game
+  free_dlc_or_loot
+  discount
+  upcoming_free
+}
+
+enum GameFlagEnum {
+  freeWeekend
+  allTimeLow
+  featured
+  aaa
+  earlyAccess
+}
+
+enum GameDeliveryEnum {
+  instant
+  daily
+  weekly
 }
 
 model AllEnumsModel {
-    dbId String @id @default(uuid())
-
-    leaderBoardTypes     LeaderBoardTypesEnum
-    singleMessageTypes   SingleMessageTypeEnum
-    streamerMessageTypes StreamerMessageTypeEnum
-    guildMessageTypes    GuildMessageTypeEnum
-    overrides            OverridesEnum
-    platform             PlatformEnum
-    clipperCategories    ClipperCategoryEnum
-    userMediaSharePerms  UserMediaSharePermissionsEnum
-    platformsWithVideos  PlatformsWithVideosEnum
-    rumbleTypes          RumbleTypeEnum
-    queryIns             QueryInEnum
-    roleFilters          FilterEnum
-    mediaShareTypes      MediaShareTypesEnum
-    mediaShareCommands   MediaShareCommandsEnum
-    roleBonusTypes       RoleBonusEnum
-    userNotificationSev  UserNotificationSeverityEnum
+  dbId String @id @default(uuid())
+
+  leaderBoardTypes     LeaderBoardTypesEnum
+  singleMessageTypes   SingleMessageTypeEnum
+  streamerMessageTypes StreamerMessageTypeEnum
+  guildMessageTypes    GuildMessageTypeEnum
+  overrides            OverridesEnum
+  platform             PlatformEnum
+  clipperCategories    ClipperCategoryEnum
+  userMediaSharePerms  UserMediaSharePermissionsEnum
+  platformsWithVideos  PlatformsWithVideosEnum
+  rumbleTypes          RumbleTypeEnum
+  queryIns             QueryInEnum
+  roleFilters          FilterEnum
+  mediaShareTypes      MediaShareTypesEnum
+  mediaShareCommands   MediaShareCommandsEnum
+  roleBonusTypes       RoleBonusEnum
+  userNotificationSev  UserNotificationSeverityEnum
+  gameStores           GameStoreEnum
+  gameKinds            GameKindEnum
+  gameFlags            GameFlagEnum
+  gameDelivery         GameDeliveryEnum
 }