glitch-javascript-sdk 2.7.7 → 2.7.8

package/dist/index.d.ts

@@ -5303,6 +5303,33 @@ declare class Influencers {
     static workbook<T>(data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
+/**
+ * Interface for the Release Stats response to help developers
+ * understand the data structure returned by the optimizer.
+ */
+interface ReleaseStatEntry {
+    date: string;
+    count: number;
+    intensity: 'low' | 'medium' | 'high' | 'extreme';
+    is_danger_zone: boolean;
+    recommendation: string;
+    events: Array<{
+        name: string;
+        type: 'nextfest' | 'sale';
+        start: string;
+        end: string;
+    }>;
+}
+interface ReleaseStatsResponse {
+    data: ReleaseStatEntry[];
+    meta: {
+        user_status: 'authenticated' | 'guest';
+        lookahead_days: number;
+        start_date: string;
+        end_date: string;
+        global_events: any[];
+    };
+}
 declare class Games {
     /**
      * Get a list of Games available on he platform.
@@ -5350,6 +5377,29 @@ declare class Games {
      * @returns promise
      */
     static createGameScheduler<T>(game_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+    * Get release competition statistics and Steam danger zones.
+    *
+    * This tool analyzes the 'ExternalGames' database to show how many other games
+    * are releasing around a specific date. It also overlays hard-coded Steam events
+    * like NextFest and Seasonal Sales.
+    *
+    * @see https://api.glitch.fun/api/documentation#/ExternalGames/getReleaseStats
+    *
+    * @param params Filtering options:
+    *   - precision: 'day' | 'month' | 'year' (Default: 'day'). Use 'month' for long-term planning.
+    *   - start_date: 'YYYY-MM-DD'. The date to begin the analysis from.
+    *
+    * @returns AxiosPromise<Response<ReleaseStatsResponse>>
+    *
+    * @example
+    * Games.getReleaseStats({ precision: 'day', start_date: '2025-06-01' })
+    *   .then(res => console.log(res.data.data));
+    */
+    static getReleaseStats<T = ReleaseStatsResponse>(params?: {
+        precision?: 'day' | 'month' | 'year';
+        start_date?: string;
+    }): AxiosPromise<Response<T>>;
 }
 
 declare class Publications {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glitch-javascript-sdk",
-  "version": "2.7.7",
+  "version": "2.7.8",
   "description": "Javascript SDK for Glitch",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/api/Games.ts

@@ -3,6 +3,35 @@ import Requests from "../util/Requests";
 import Response from "../util/Response";
 import { AxiosPromise } from "axios";
 
+/**
+ * Interface for the Release Stats response to help developers 
+ * understand the data structure returned by the optimizer.
+ */
+export interface ReleaseStatEntry {
+    date: string;
+    count: number;
+    intensity: 'low' | 'medium' | 'high' | 'extreme';
+    is_danger_zone: boolean;
+    recommendation: string;
+    events: Array<{
+        name: string;
+        type: 'nextfest' | 'sale';
+        start: string;
+        end: string;
+    }>;
+}
+
+export interface ReleaseStatsResponse {
+    data: ReleaseStatEntry[];
+    meta: {
+        user_status: 'authenticated' | 'guest';
+        lookahead_days: number;
+        start_date: string;
+        end_date: string;
+        global_events: any[];
+    };
+}
+
 class Games {
 
     /**
@@ -12,7 +41,7 @@ class Games {
      * 
      * @returns promise
      */
-    public static listGames<T>(params?: Record<string, any>) :  AxiosPromise<Response<T>> {
+    public static listGames<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
         return Requests.processRoute(GamesRoutes.routes.listGames, undefined, undefined, params);
     }
 
@@ -23,8 +52,8 @@ class Games {
      * 
      * @returns promise
      */
-    public static viewGame<T>(game_id : string, params?: Record<string, any>) :  AxiosPromise<Response<T>> {
-        return Requests.processRoute(GamesRoutes.routes.viewGame, undefined, {game_id : game_id}, params);
+    public static viewGame<T>(game_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(GamesRoutes.routes.viewGame, undefined, { game_id: game_id }, params);
     }
 
     /**
@@ -34,8 +63,8 @@ class Games {
      * 
      * @returns promise
      */
-    public static createCampaignData<T>(game_id : string, data?: object, params?: Record<string, any>) :  AxiosPromise<Response<T>> {
-        return Requests.processRoute(GamesRoutes.routes.createCampaignData, data, {game_id : game_id}, params);
+    public static createCampaignData<T>(game_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(GamesRoutes.routes.createCampaignData, data, { game_id: game_id }, params);
     }
 
     /**
@@ -43,8 +72,8 @@ class Games {
      * 
      * @returns promise
      */
-    public static createCampaignWithTitle<T>(game_id : string, data?: object, params?: Record<string, any>) :  AxiosPromise<Response<T>> {
-        return Requests.processRoute(GamesRoutes.routes.createCampaignWithTitle, data, {game_id : game_id}, params);
+    public static createCampaignWithTitle<T>(game_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(GamesRoutes.routes.createCampaignWithTitle, data, { game_id: game_id }, params);
     }
 
     /**
@@ -54,8 +83,8 @@ class Games {
      * 
      * @returns promise
      */
-    public static createGameTitle<T>(game_id : string, data?: object, params?: Record<string, any>) :  AxiosPromise<Response<T>> {
-        return Requests.processRoute(GamesRoutes.routes.createGameTitle, data, {game_id : game_id}, params);
+    public static createGameTitle<T>(game_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(GamesRoutes.routes.createGameTitle, data, { game_id: game_id }, params);
     }
 
     /**
@@ -65,8 +94,45 @@ class Games {
      * 
      * @returns promise
      */
-    public static createGameScheduler<T>(game_id : string, data?: object, params?: Record<string, any>) :  AxiosPromise<Response<T>> {
-        return Requests.processRoute(GamesRoutes.routes.createGameScheduler, data, {game_id : game_id}, params);
+    public static createGameScheduler<T>(game_id: string, data?: object, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(GamesRoutes.routes.createGameScheduler, data, { game_id: game_id }, params);
+    }
+
+    /**
+    * Get release competition statistics and Steam danger zones.
+    * 
+    * This tool analyzes the 'ExternalGames' database to show how many other games 
+    * are releasing around a specific date. It also overlays hard-coded Steam events 
+    * like NextFest and Seasonal Sales.
+    * 
+    * @see https://api.glitch.fun/api/documentation#/ExternalGames/getReleaseStats
+    * 
+    * @param params Filtering options:
+    *   - precision: 'day' | 'month' | 'year' (Default: 'day'). Use 'month' for long-term planning.
+    *   - start_date: 'YYYY-MM-DD'. The date to begin the analysis from.
+    * 
+    * @returns AxiosPromise<Response<ReleaseStatsResponse>>
+    * 
+    * @example
+    * Games.getReleaseStats({ precision: 'day', start_date: '2025-06-01' })
+    *   .then(res => console.log(res.data.data));
+    */
+    public static getReleaseStats<T = ReleaseStatsResponse>(params?: {
+        precision?: 'day' | 'month' | 'year',
+        start_date?: string
+    }): AxiosPromise<Response<T>> {
+
+        // Defensive check: ensure precision is valid if provided
+        if (params?.precision && !['day', 'month', 'year'].includes(params.precision)) {
+            console.warn(`Invalid precision '${params.precision}' passed to getReleaseStats. Defaulting to 'day'.`);
+        }
+
+        return Requests.processRoute(
+            GamesRoutes.routes.releaseStats,
+            undefined,
+            undefined,
+            params
+        );
     }
 
 }

package/src/routes/GamesRoutes.ts

@@ -10,7 +10,7 @@ class GamesRoutes {
     createCampaignWithTitle: { url: '/games/{game_id}/generateCampaignWithTitle', method: HTTP_METHODS.POST },
     createGameTitle: { url: '/games/{game_id}/generateTitle', method: HTTP_METHODS.POST },
     createGameScheduler: { url: '/games/{game_id}/generateScheduler', method: HTTP_METHODS.POST },
-
+    releaseStats: { url: '/games/release-stats', method: HTTP_METHODS.GET },
   };
 
 }