@flitt/api 1.0.0 → 1.1.0

package/src/types.ts

@@ -1,6 +1,6 @@
 /**
- * Response types of the Flitt Public API v1 (`/v1/public-api`) and of the
- * Vote API (`/v1/vote-api`). Dates are ISO 8601 strings, as sent by the API.
+ * Response types of the Flitt Public API v1 (`/v1/public-api`), votes and
+ * reviews included. Dates are ISO 8601 strings, as sent by the API.
  */
 
 export type Game = "GMOD" | "FIVEM" | "MC";
@@ -275,7 +275,7 @@ export type WebhookEvent<T = Record<string, unknown> | null> = {
 };
 
 // ---------------------------------------------------------------------------
-// Vote API
+// Votes and reviews (part of the Public API)
 // ---------------------------------------------------------------------------
 
 type IdentityFields = {
@@ -355,7 +355,8 @@ export type VoteStats = {
   monthly: Array<{ month: string; votes: number; views: number; joinClicks: number; rank: number | null }>;
 };
 
-export type VoteServer = {
+/** Vote counters, ranking, status and rating of a server (`flitt.votes.summary`). */
+export type VoteSummary = {
   id: string;
   name: string | null;
   game: Game;
@@ -370,6 +371,9 @@ export type VoteServer = {
   stats?: VoteStats;
 };
 
+/** @deprecated since 1.1: renamed VoteSummary. */
+export type VoteServer = VoteSummary;
+
 export type Review = {
   id: string;
   rating: number;

package/src/version.ts

@@ -1,2 +1,2 @@
 /** Package version, kept in sync with package.json by scripts/sync-version.mjs. */
-export const VERSION = "1.0.0";
+export const VERSION = "1.1.0";