glitch-javascript-sdk 2.1.6 → 2.1.8

package/dist/index.d.ts

@@ -5179,7 +5179,7 @@ declare class PlayTests {
 
 interface SteamCapsuleCropRequest {
     media_id: string;
-    capsule_type: 'header' | 'small' | 'main' | 'vertical' | 'library' | 'library_header' | 'library_hero' | 'page_background';
+    capsule_type: 'header' | 'small' | 'main' | 'vertical' | 'library' | 'library_header' | 'library_hero' | 'page_background' | 'screenshot' | 'app_icon' | 'shortcut_icon';
     crop_x?: number;
     crop_y?: number;
     crop_width?: number;
@@ -5191,6 +5191,22 @@ interface SteamCapsuleAnalysisRequest {
     game_name?: string;
     game_genre?: string;
 }
+interface RemoveBackgroundRequest {
+    media_id: string;
+    output_format?: 'png' | 'webp';
+}
+interface RemoveBackgroundAIRequest {
+    media_id: string;
+    use_ai_analysis?: boolean;
+}
+interface CreateLibraryLogoRequest {
+    media_id: string;
+    target_width?: number;
+    target_height?: number;
+}
+interface ValidateScreenshotRequest {
+    media_id: string;
+}
 interface SteamCapsuleDimensions {
     width: number;
     height: number;
@@ -5223,6 +5239,30 @@ interface SteamCapsuleAnalysisResponse {
     ai_description: string;
     guidelines: any;
 }
+interface RemoveBackgroundResponse {
+    success: boolean;
+    message: string;
+    data: any;
+}
+interface RemoveBackgroundAIResponse {
+    success: boolean;
+    message: string;
+    data: any;
+    ai_used: boolean;
+}
+interface CreateLibraryLogoResponse {
+    success: boolean;
+    message: string;
+    data: any;
+}
+interface ScreenshotValidationResponse {
+    success: boolean;
+    valid: boolean;
+    dimensions: SteamCapsuleDimensions;
+    aspect_ratio: number;
+    issues: string[];
+    recommendations: string[];
+}
 declare class Media {
     /**
      * Upload media content using a File object.
@@ -5257,13 +5297,13 @@ declare class Media {
      */
     static get<T>(media_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
-    * Crop and resize an image to Steam capsule dimensions.
-    *
-    * @param request The crop request parameters.
-    * @param params Additional query parameters.
-    *
-    * @returns promise
-    */
+     * Crop and resize an image to Steam capsule dimensions.
+     *
+     * @param request The crop request parameters.
+     * @param params Additional query parameters.
+     *
+     * @returns promise
+     */
     static cropSteamCapsule(request: SteamCapsuleCropRequest, params?: Record<string, any>): AxiosPromise<Response<SteamCapsuleCropResponse>>;
     /**
      * Analyze a Steam capsule image using AI.
@@ -5274,6 +5314,42 @@ declare class Media {
      * @returns promise
      */
     static analyzeSteamCapsule(request: SteamCapsuleAnalysisRequest, params?: Record<string, any>): AxiosPromise<Response<SteamCapsuleAnalysisResponse>>;
+    /**
+     * Remove background from an image to create transparent PNG.
+     *
+     * @param request The background removal request parameters.
+     * @param params Additional query parameters.
+     *
+     * @returns promise
+     */
+    static removeBackground(request: RemoveBackgroundRequest, params?: Record<string, any>): AxiosPromise<Response<RemoveBackgroundResponse>>;
+    /**
+     * Remove background from an image using AI analysis for better results.
+     *
+     * @param request The AI-enhanced background removal request parameters.
+     * @param params Additional query parameters.
+     *
+     * @returns promise
+     */
+    static removeBackgroundAI(request: RemoveBackgroundAIRequest, params?: Record<string, any>): AxiosPromise<Response<RemoveBackgroundAIResponse>>;
+    /**
+     * Create a Steam Library Logo meeting Steam's requirements.
+     *
+     * @param request The library logo creation request parameters.
+     * @param params Additional query parameters.
+     *
+     * @returns promise
+     */
+    static createLibraryLogo(request: CreateLibraryLogoRequest, params?: Record<string, any>): AxiosPromise<Response<CreateLibraryLogoResponse>>;
+    /**
+     * Validate a screenshot against Steam's requirements.
+     *
+     * @param request The screenshot validation request parameters.
+     * @param params Additional query parameters.
+     *
+     * @returns promise
+     */
+    static validateScreenshot(request: ValidateScreenshotRequest, params?: Record<string, any>): AxiosPromise<Response<ScreenshotValidationResponse>>;
     /**
      * Get Steam capsule dimensions for a specific type.
      *
@@ -5290,6 +5366,31 @@ declare class Media {
      * @returns Information about the capsule type.
      */
     static getSteamCapsuleInfo(capsuleType: string): any;
+    /**
+     * Get Steam screenshot requirements.
+     *
+     * @returns Screenshot requirements object.
+     */
+    static getSteamScreenshotRequirements(): {
+        minWidth: number;
+        minHeight: number;
+        aspectRatio: number;
+        minCount: number;
+        format: string;
+        content: string;
+    };
+    /**
+     * Get Steam library logo requirements.
+     *
+     * @returns Library logo requirements object.
+     */
+    static getSteamLibraryLogoRequirements(): {
+        maxWidth: number;
+        maxHeight: number;
+        format: string;
+        requirement: string;
+        content: string;
+    };
 }
 
 declare class Scheduler {

package/package.json

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

package/src/api/Media.ts

@@ -5,7 +5,7 @@ import { AxiosProgressEvent, AxiosPromise } from "axios";
 
 export interface SteamCapsuleCropRequest {
     media_id: string;
-    capsule_type: 'header' | 'small' | 'main' | 'vertical' | 'library' | 'library_header' | 'library_hero' | 'page_background';
+    capsule_type: 'header' | 'small' | 'main' | 'vertical' | 'library' | 'library_header' | 'library_hero' | 'page_background' | 'screenshot' | 'app_icon' | 'shortcut_icon';
     crop_x?: number;
     crop_y?: number;
     crop_width?: number;
@@ -19,6 +19,26 @@ export interface SteamCapsuleAnalysisRequest {
     game_genre?: string;
 }
 
+export interface RemoveBackgroundRequest {
+    media_id: string;
+    output_format?: 'png' | 'webp';
+}
+
+export interface RemoveBackgroundAIRequest {
+    media_id: string;
+    use_ai_analysis?: boolean;
+}
+
+export interface CreateLibraryLogoRequest {
+    media_id: string;
+    target_width?: number;
+    target_height?: number;
+}
+
+export interface ValidateScreenshotRequest {
+    media_id: string;
+}
+
 export interface SteamCapsuleDimensions {
     width: number;
     height: number;
@@ -55,6 +75,33 @@ export interface SteamCapsuleAnalysisResponse {
     guidelines: any;
 }
 
+export interface RemoveBackgroundResponse {
+    success: boolean;
+    message: string;
+    data: any;
+}
+
+export interface RemoveBackgroundAIResponse {
+    success: boolean;
+    message: string;
+    data: any;
+    ai_used: boolean;
+}
+
+export interface CreateLibraryLogoResponse {
+    success: boolean;
+    message: string;
+    data: any;
+}
+
+export interface ScreenshotValidationResponse {
+    success: boolean;
+    valid: boolean;
+    dimensions: SteamCapsuleDimensions;
+    aspect_ratio: number;
+    issues: string[];
+    recommendations: string[];
+}
 
 class Media {
     /**
@@ -98,7 +145,7 @@ class Media {
         return Requests.processRoute(MediaRoute.routes.getMedia, {}, { media_id: media_id }, params);
     }
 
-     /**
+    /**
      * Crop and resize an image to Steam capsule dimensions.
      * 
      * @param request The crop request parameters.
@@ -122,6 +169,54 @@ class Media {
         return Requests.processRoute(MediaRoute.routes.analyzeSteamCapsule, request, {}, params);
     }
 
+    /**
+     * Remove background from an image to create transparent PNG.
+     * 
+     * @param request The background removal request parameters.
+     * @param params Additional query parameters.
+     * 
+     * @returns promise
+     */
+    public static removeBackground(request: RemoveBackgroundRequest, params?: Record<string, any>): AxiosPromise<Response<RemoveBackgroundResponse>> {
+        return Requests.processRoute(MediaRoute.routes.removeBackground, request, {}, params);
+    }
+
+    /**
+     * Remove background from an image using AI analysis for better results.
+     * 
+     * @param request The AI-enhanced background removal request parameters.
+     * @param params Additional query parameters.
+     * 
+     * @returns promise
+     */
+    public static removeBackgroundAI(request: RemoveBackgroundAIRequest, params?: Record<string, any>): AxiosPromise<Response<RemoveBackgroundAIResponse>> {
+        return Requests.processRoute(MediaRoute.routes.removeBackgroundAI, request, {}, params);
+    }
+
+    /**
+     * Create a Steam Library Logo meeting Steam's requirements.
+     * 
+     * @param request The library logo creation request parameters.
+     * @param params Additional query parameters.
+     * 
+     * @returns promise
+     */
+    public static createLibraryLogo(request: CreateLibraryLogoRequest, params?: Record<string, any>): AxiosPromise<Response<CreateLibraryLogoResponse>> {
+        return Requests.processRoute(MediaRoute.routes.createLibraryLogo, request, {}, params);
+    }
+
+    /**
+     * Validate a screenshot against Steam's requirements.
+     * 
+     * @param request The screenshot validation request parameters.
+     * @param params Additional query parameters.
+     * 
+     * @returns promise
+     */
+    public static validateScreenshot(request: ValidateScreenshotRequest, params?: Record<string, any>): AxiosPromise<Response<ScreenshotValidationResponse>> {
+        return Requests.processRoute(MediaRoute.routes.validateScreenshot, request, {}, params);
+    }
+
     /**
      * Get Steam capsule dimensions for a specific type.
      * 
@@ -205,6 +300,37 @@ class Media {
 
         return info[capsuleType] || null;
     }
+
+    /**
+     * Get Steam screenshot requirements.
+     * 
+     * @returns Screenshot requirements object.
+     */
+    public static getSteamScreenshotRequirements() {
+        return {
+            minWidth: 1920,
+            minHeight: 1080,
+            aspectRatio: 16 / 9,
+            minCount: 5,
+            format: 'Should be high-res, widescreen format',
+            content: 'Should show gameplay, not menus or concept art'
+        };
+    }
+
+    /**
+     * Get Steam library logo requirements.
+     * 
+     * @returns Library logo requirements object.
+     */
+    public static getSteamLibraryLogoRequirements() {
+        return {
+            maxWidth: 1280,
+            maxHeight: 720,
+            format: 'PNG with transparent background',
+            requirement: 'Either 1280px wide and/or 720px tall',
+            content: 'Logo only, should be legible against any background'
+        };
+    }
 }
 
-export default Media;
+export default Media;

package/src/routes/MediaRoute.ts

@@ -7,6 +7,10 @@ class MediaRoute {
         getMedia: { url: '/media/{media_id}', method: HTTP_METHODS.GET },
         cropSteamCapsule: { url: '/media/crop-steam-capsule', method: HTTP_METHODS.POST },
         analyzeSteamCapsule: { url: '/media/analyze-steam-capsule', method: HTTP_METHODS.POST },
+        removeBackground: { url: '/media/remove-background', method: HTTP_METHODS.POST },
+        removeBackgroundAI: { url: '/media/remove-background-ai', method: HTTP_METHODS.POST },
+        createLibraryLogo: { url: '/media/create-library-logo', method: HTTP_METHODS.POST },
+        validateScreenshot: { url: '/media/validate-screenshot', method: HTTP_METHODS.POST },
     };
 }