glitch-javascript-sdk 2.1.2 → 2.1.3

package/dist/index.d.ts

@@ -3512,6 +3512,74 @@ declare class SocialPosts {
     * @returns promise
     */
     static shortLinkReports<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * List comments for a social media post.
+     *
+     * @param post_id The ID of the social media post.
+     * @param params Optional query parameters for filtering and sorting.
+     * @returns A promise
+     */
+    static listComments<T>(post_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Sync comments from the social media platform for a specific post.
+     *
+     * @param post_id The ID of the social media post.
+     * @param params Optional query parameters (e.g., limit).
+     * @returns A promise
+     */
+    static syncComments<T>(post_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get a list of all comments that are pending a response.
+     *
+     * @param params Optional query parameters for filtering.
+     * @returns A promise
+     */
+    static listPendingResponses<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Retrieve a single comment by its ID.
+     *
+     * @param comment_id The ID of the comment.
+     * @param params Optional query parameters (e.g., include_thread).
+     * @returns A promise
+     */
+    static viewComment<T>(comment_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Post a reply to a comment.
+     *
+     * @param comment_id The ID of the comment to reply to.
+     * @param data The content of the reply.
+     * @returns A promise
+     */
+    static replyToComment<T>(comment_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Moderate a comment (approve, reject, spam, hide, show).
+     *
+     * @param comment_id The ID of the comment to moderate.
+     * @param data The moderation action and optional reason.
+     * @returns A promise
+     */
+    static moderateComment<T>(comment_id: string, data: object): AxiosPromise<Response<T>>;
+    /**
+     * Mark a comment as needing a response.
+     *
+     * @param comment_id The ID of the comment.
+     * @returns A promise
+     */
+    static markCommentForResponse<T>(comment_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Get the full thread for a given comment.
+     *
+     * @param comment_id The ID of a comment within the thread.
+     * @returns A promise
+     */
+    static getCommentThread<T>(comment_id: string): AxiosPromise<Response<T>>;
+    /**
+     * Trigger a manual update of a comment's metrics from its platform.
+     *
+     * @param comment_id The ID of the comment to update.
+     * @returns A promise
+     */
+    static updateCommentMetrics<T>(comment_id: string): AxiosPromise<Response<T>>;
 }
 
 declare class Titles {
@@ -5101,6 +5169,52 @@ declare class PlayTests {
     static mine<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
+interface SteamCapsuleCropRequest {
+    media_id: string;
+    capsule_type: 'header' | 'small' | 'main' | 'vertical' | 'library' | 'library_header' | 'library_hero' | 'page_background';
+    crop_x?: number;
+    crop_y?: number;
+    crop_width?: number;
+    crop_height?: number;
+}
+interface SteamCapsuleAnalysisRequest {
+    media_id: string;
+    capsule_type: 'header' | 'small' | 'main' | 'vertical' | 'library' | 'library_header' | 'library_hero' | 'page_background';
+    game_name?: string;
+    game_genre?: string;
+}
+interface SteamCapsuleDimensions {
+    width: number;
+    height: number;
+}
+interface SteamCapsuleCropResponse {
+    media: any;
+    download_url: string;
+    dimensions: SteamCapsuleDimensions;
+    capsule_type: string;
+}
+interface CategoryScores {
+    visual_hierarchy: number;
+    title_readability: number;
+    genre_communication: number;
+    brand_identity: number;
+    composition_balance: number;
+    art_style: number;
+    emotional_impact: number;
+    steam_compliance: number;
+}
+interface SteamCapsuleAnalysisResponse {
+    media_id: string;
+    capsule_type: string;
+    dimensions: SteamCapsuleDimensions;
+    overall_score: number;
+    category_scores: CategoryScores;
+    strengths: string[];
+    improvements: string[];
+    recommendations: string[];
+    ai_description: string;
+    guidelines: any;
+}
 declare class Media {
     /**
      * Upload media content using a File object.
@@ -5134,6 +5248,40 @@ declare class Media {
      * @returns promise
      */
     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
+    */
+    static cropSteamCapsule(request: SteamCapsuleCropRequest, params?: Record<string, any>): AxiosPromise<Response<SteamCapsuleCropResponse>>;
+    /**
+     * Analyze a Steam capsule image using AI.
+     *
+     * @param request The analysis request parameters.
+     * @param params Additional query parameters.
+     *
+     * @returns promise
+     */
+    static analyzeSteamCapsule(request: SteamCapsuleAnalysisRequest, params?: Record<string, any>): AxiosPromise<Response<SteamCapsuleAnalysisResponse>>;
+    /**
+     * Get Steam capsule dimensions for a specific type.
+     *
+     * @param capsuleType The type of Steam capsule.
+     *
+     * @returns The dimensions object or null if invalid type.
+     */
+    static getSteamCapsuleDimensions(capsuleType: string): SteamCapsuleDimensions | null;
+    /**
+     * Get Steam capsule type information and requirements.
+     *
+     * @param capsuleType The type of Steam capsule.
+     *
+     * @returns Information about the capsule type.
+     */
+    static getSteamCapsuleInfo(capsuleType: string): any;
 }
 
 declare class Scheduler {

package/package.json

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

package/src/api/Media.ts

@@ -3,6 +3,59 @@ import Requests from "../util/Requests";
 import Response from "../util/Response";
 import { AxiosProgressEvent, AxiosPromise } from "axios";
 
+export interface SteamCapsuleCropRequest {
+    media_id: string;
+    capsule_type: 'header' | 'small' | 'main' | 'vertical' | 'library' | 'library_header' | 'library_hero' | 'page_background';
+    crop_x?: number;
+    crop_y?: number;
+    crop_width?: number;
+    crop_height?: number;
+}
+
+export interface SteamCapsuleAnalysisRequest {
+    media_id: string;
+    capsule_type: 'header' | 'small' | 'main' | 'vertical' | 'library' | 'library_header' | 'library_hero' | 'page_background';
+    game_name?: string;
+    game_genre?: string;
+}
+
+export interface SteamCapsuleDimensions {
+    width: number;
+    height: number;
+}
+
+export interface SteamCapsuleCropResponse {
+    media: any;
+    download_url: string;
+    dimensions: SteamCapsuleDimensions;
+    capsule_type: string;
+}
+
+export interface CategoryScores {
+    visual_hierarchy: number;
+    title_readability: number;
+    genre_communication: number;
+    brand_identity: number;
+    composition_balance: number;
+    art_style: number;
+    emotional_impact: number;
+    steam_compliance: number;
+}
+
+export interface SteamCapsuleAnalysisResponse {
+    media_id: string;
+    capsule_type: string;
+    dimensions: SteamCapsuleDimensions;
+    overall_score: number;
+    category_scores: CategoryScores;
+    strengths: string[];
+    improvements: string[];
+    recommendations: string[];
+    ai_description: string;
+    guidelines: any;
+}
+
+
 class Media {
     /**
      * Upload media content using a File object.
@@ -44,6 +97,114 @@ class Media {
     public static get<T>(media_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
         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.
+     * @param params Additional query parameters.
+     * 
+     * @returns promise
+     */
+    public static cropSteamCapsule(request: SteamCapsuleCropRequest, params?: Record<string, any>): AxiosPromise<Response<SteamCapsuleCropResponse>> {
+        return Requests.processRoute(MediaRoute.routes.cropSteamCapsule, request, {}, params);
+    }
+
+    /**
+     * Analyze a Steam capsule image using AI.
+     * 
+     * @param request The analysis request parameters.
+     * @param params Additional query parameters.
+     * 
+     * @returns promise
+     */
+    public static analyzeSteamCapsule(request: SteamCapsuleAnalysisRequest, params?: Record<string, any>): AxiosPromise<Response<SteamCapsuleAnalysisResponse>> {
+        return Requests.processRoute(MediaRoute.routes.analyzeSteamCapsule, request, {}, params);
+    }
+
+    /**
+     * Get Steam capsule dimensions for a specific type.
+     * 
+     * @param capsuleType The type of Steam capsule.
+     * 
+     * @returns The dimensions object or null if invalid type.
+     */
+    public static getSteamCapsuleDimensions(capsuleType: string): SteamCapsuleDimensions | null {
+        const dimensions: Record<string, SteamCapsuleDimensions> = {
+            'header': { width: 920, height: 430 },
+            'small': { width: 462, height: 174 },
+            'main': { width: 1232, height: 706 },
+            'vertical': { width: 748, height: 896 },
+            'library': { width: 600, height: 900 },
+            'library_header': { width: 920, height: 430 },
+            'library_hero': { width: 3840, height: 1240 },
+            'page_background': { width: 1438, height: 810 }
+        };
+
+        return dimensions[capsuleType] || null;
+    }
+
+    /**
+     * Get Steam capsule type information and requirements.
+     * 
+     * @param capsuleType The type of Steam capsule.
+     * 
+     * @returns Information about the capsule type.
+     */
+    public static getSteamCapsuleInfo(capsuleType: string) {
+        const info: Record<string, any> = {
+            'header': {
+                name: 'Header Capsule',
+                purpose: 'Appears at the top of store page, in recommended sections, grid view in libraries',
+                textRequirement: 'Logo must be clearly legible',
+                designFocus: 'Focus on branding of your product'
+            },
+            'small': {
+                name: 'Small Capsule',
+                purpose: 'Used for all lists throughout Steam: search results, top-sellers, new releases',
+                textRequirement: 'Logo should nearly fill the small capsule for readability',
+                designFocus: 'Focus on making logo clearly legible at smallest size'
+            },
+            'main': {
+                name: 'Main Capsule',
+                purpose: 'Appears at top of front page in featured and recommended carousel',
+                textRequirement: 'Logo should be prominent and readable',
+                designFocus: 'Designed to market the product with key art and logo'
+            },
+            'vertical': {
+                name: 'Vertical Capsule',
+                purpose: 'Can appear at top of front page during seasonal sales',
+                textRequirement: 'Logo should be clearly visible',
+                designFocus: 'Vertical asset designed to market your game'
+            },
+            'library': {
+                name: 'Library Capsule',
+                purpose: 'Used in library overview and collection views',
+                textRequirement: 'Game name/logo should be easily legible against background',
+                designFocus: 'Graphically-centric to give user sense of experience'
+            },
+            'library_header': {
+                name: 'Library Header',
+                purpose: 'Appears in various places in Steam Client Library',
+                textRequirement: 'Logo must be clearly legible',
+                designFocus: 'Focus on branding, similar to Library Capsule'
+            },
+            'library_hero': {
+                name: 'Library Hero',
+                purpose: 'Appears at top of user\'s library details page',
+                textRequirement: 'Should NOT contain any text or logos',
+                designFocus: 'Visually rich, easily recognizable key art'
+            },
+            'page_background': {
+                name: 'Page Background',
+                purpose: 'Background image for store page',
+                textRequirement: 'Minimal or no text',
+                designFocus: 'Should be ambient, not compete with page content'
+            }
+        };
+
+        return info[capsuleType] || null;
+    }
 }
 
 export default Media;

package/src/api/SocialPosts.ts

@@ -190,6 +190,102 @@ class SocialPosts {
         return Requests.processRoute(SocialPostsRoute.routes.shortLinkReports, undefined, undefined, params);
     }
 
+
+    /**
+     * List comments for a social media post.
+     * 
+     * @param post_id The ID of the social media post.
+     * @param params Optional query parameters for filtering and sorting.
+     * @returns A promise
+     */
+    public static listComments<T>(post_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(SocialPostsRoute.routes.listComments, undefined, { post_id }, params);
+    }
+
+    /**
+     * Sync comments from the social media platform for a specific post.
+     * 
+     * @param post_id The ID of the social media post.
+     * @param params Optional query parameters (e.g., limit).
+     * @returns A promise
+     */
+    public static syncComments<T>(post_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(SocialPostsRoute.routes.syncComments, undefined, { post_id }, params);
+    }
+
+    /**
+     * Get a list of all comments that are pending a response.
+     * 
+     * @param params Optional query parameters for filtering.
+     * @returns A promise
+     */
+    public static listPendingResponses<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(SocialPostsRoute.routes.listPendingResponses, undefined, undefined, params);
+    }
+
+    /**
+     * Retrieve a single comment by its ID.
+     * 
+     * @param comment_id The ID of the comment.
+     * @param params Optional query parameters (e.g., include_thread).
+     * @returns A promise
+     */
+    public static viewComment<T>(comment_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(SocialPostsRoute.routes.viewComment, undefined, { comment_id }, params);
+    }
+
+    /**
+     * Post a reply to a comment.
+     * 
+     * @param comment_id The ID of the comment to reply to.
+     * @param data The content of the reply.
+     * @returns A promise
+     */
+    public static replyToComment<T>(comment_id: string, data: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(SocialPostsRoute.routes.replyToComment, data, { comment_id });
+    }
+
+    /**
+     * Moderate a comment (approve, reject, spam, hide, show).
+     * 
+     * @param comment_id The ID of the comment to moderate.
+     * @param data The moderation action and optional reason.
+     * @returns A promise
+     */
+    public static moderateComment<T>(comment_id: string, data: object): AxiosPromise<Response<T>> {
+        return Requests.processRoute(SocialPostsRoute.routes.moderateComment, data, { comment_id });
+    }
+
+    /**
+     * Mark a comment as needing a response.
+     * 
+     * @param comment_id The ID of the comment.
+     * @returns A promise
+     */
+    public static markCommentForResponse<T>(comment_id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(SocialPostsRoute.routes.markCommentForResponse, undefined, { comment_id });
+    }
+
+    /**
+     * Get the full thread for a given comment.
+     * 
+     * @param comment_id The ID of a comment within the thread.
+     * @returns A promise
+     */
+    public static getCommentThread<T>(comment_id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(SocialPostsRoute.routes.getCommentThread, undefined, { comment_id });
+    }
+
+    /**
+     * Trigger a manual update of a comment's metrics from its platform.
+     * 
+     * @param comment_id The ID of the comment to update.
+     * @returns A promise
+     */
+    public static updateCommentMetrics<T>(comment_id: string): AxiosPromise<Response<T>> {
+        return Requests.processRoute(SocialPostsRoute.routes.updateCommentMetrics, undefined, { comment_id });
+    }
+
 }
 
 export default SocialPosts;

package/src/routes/MediaRoute.ts

@@ -5,6 +5,8 @@ class MediaRoute {
     public static routes: { [key: string]: Route } = {
         upload: { url: '/media', method: HTTP_METHODS.POST },
         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 },
     };
 }
 

package/src/routes/SocialPostsRoute.ts

@@ -19,6 +19,17 @@ class SocialPostsRoute {
         updatePostImpressions : { url: '/socialposts/{post_id}/impressions', method: HTTP_METHODS.PUT },
         shortLinkReports: { url: '/socialposts/shortlinks/reports', method: HTTP_METHODS.GET },
 
+        // New Comment Routes
+        listComments: { url: '/socialposts/{post_id}/comments', method: HTTP_METHODS.GET },
+        syncComments: { url: '/socialposts/{post_id}/sync-comments', method: HTTP_METHODS.POST },
+        listPendingResponses: { url: '/socialposts/comments/pending-responses', method: HTTP_METHODS.GET },
+        viewComment: { url: '/socialposts/comments/{comment_id}', method: HTTP_METHODS.GET },
+        replyToComment: { url: '/socialposts/comments/{comment_id}/reply', method: HTTP_METHODS.POST },
+        moderateComment: { url: '/socialposts/comments/{comment_id}/moderate', method: HTTP_METHODS.PUT },
+        markCommentForResponse: { url: '/socialposts/comments/{comment_id}/mark-for-response', method: HTTP_METHODS.PUT },
+        getCommentThread: { url: '/socialposts/comments/{comment_id}/thread', method: HTTP_METHODS.GET },
+        updateCommentMetrics: { url: '/socialposts/comments/{comment_id}/update-metrics', method: HTTP_METHODS.PUT },
+
     };
 
   }