glitch-javascript-sdk 1.8.0 → 1.8.2

package/dist/esm/routes/WebsiteAnalyticsRoute.d.ts

@@ -0,0 +1,7 @@
+import Route from "./interface";
+declare class WebsiteAnalyticsRoute {
+    static routes: {
+        [key: string]: Route;
+    };
+}
+export default WebsiteAnalyticsRoute;

package/dist/esm/util/Session.d.ts

@@ -22,5 +22,13 @@ declare class Session {
         email: string;
         username: string;
     }): void;
+    /**
+     * Generate a tracking token for analytics collection
+     * @param titleId The title ID to generate token for
+     * @param secret The secret key (should match server config)
+     * @returns HMAC-SHA256 token
+     * @throws Error if crypto operations fail
+     */
+    static generateTrackingToken(titleId: string, secret: string): string;
 }
 export default Session;

package/dist/index.d.ts

@@ -862,6 +862,37 @@ declare class Ads {
      * @returns           A response object with data (funding instruments)
      */
     static listCampaignFundingInstruments<T>(campaign_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+   * GET /ads/reddit/targeting/carriers
+   *
+   * Example usage:
+   *   Ads.listRedditCarriers({ scheduler_id: 'uuid-of-scheduler', 'page.size': 50 })
+   */
+    static listRedditCarriers<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * GET /ads/reddit/targeting/communities?names=sub1,sub2
+     */
+    static listRedditCommunities<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * GET /ads/reddit/targeting/communities/search?query=xyz
+     */
+    static searchRedditCommunities<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * GET /ads/reddit/targeting/devices
+     */
+    static listRedditDevices<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * GET /ads/reddit/targeting/geolocations
+     */
+    static listRedditGeolocations<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * GET /ads/reddit/targeting/interests
+     */
+    static listRedditInterests<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * GET /ads/reddit/targeting/third_party_audiences
+     */
+    static listRedditThirdPartyAudiences<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
 declare class Communities {
@@ -4492,6 +4523,16 @@ declare class Scheduler {
      * @returns promise
      */
     static listUpdates<T>(scheduler_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Search the updates related to a promotion schedule.
+     *
+     * @see https://api.glitch.fun/api/documentation#/Scheduler/searchTitleUpdates
+     *
+     * @param scheduler_id The ID of the promotion schedule.
+     *
+     * @returns promise
+     */
+    static searchUpdates<T>(scheduler_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
      * Create a new title update for a promotion schedule.
      *
@@ -4605,6 +4646,13 @@ declare class Scheduler {
      * @returns promise
      */
     static clearRedditAuth<T>(scheduler_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Clear Reddit Ads OAuth credentials from a promotion schedule.
+     *
+     * @param scheduler_id The ID of the promotion schedule.
+     * @returns promise
+     */
+    static clearRedditAdsAuth<T>(scheduler_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
     /**
      * Clear YouTube OAuth credentials from a promotion schedule.
      *
@@ -4926,6 +4974,191 @@ declare class Hashtags {
     static top<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
 }
 
+declare class WebsiteAnalytics {
+    /**
+     * List website analytics sessions with comprehensive filtering
+     *
+     * @param params Filtering options:
+     *   - title_id?: string - Filter by title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - device_type?: 'desktop'|'mobile'|'tablet'|'bot'|'other'
+     *   - country_code?: string - 2-letter country code
+     *   - is_bot?: boolean - Filter by bot status
+     *   - sort?: 'started_at'|'total_duration'|'pageview_count' - Sort field
+     *   - order?: 'asc'|'desc' - Sort order
+     *   - per_page?: number - Items per page (max 100)
+     * @returns Promise with paginated sessions data
+     */
+    static listSessions<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get a paginated list of pageviews with filtering options
+     *
+     * @param params Filtering options:
+     *   - title_id?: string - Filter by title ID
+     *   - analytics_session_id?: string - Filter by session ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - is_exit?: boolean - Filter by exit pageviews
+     *   - sort?: 'occurred_at'|'load_time_ms'|'dom_complete_ms' - Sort field
+     *   - order?: 'asc'|'desc' - Sort order
+     *   - per_page?: number - Items per page (max 100)
+     * @returns Promise with paginated pageviews data
+     */
+    static listPageviews<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get a paginated list of events with filtering options
+     *
+     * @param params Filtering options:
+     *   - title_id?: string - Filter by title ID
+     *   - analytics_session_id?: string - Filter by session ID
+     *   - event_name?: string - Filter by event name
+     *   - event_category?: string - Filter by event category
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - sort?: 'occurred_at'|'event_name' - Sort field
+     *   - order?: 'asc'|'desc' - Sort order
+     *   - per_page?: number - Items per page (max 100)
+     * @returns Promise with paginated events data
+     */
+    static listEvents<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get an analytics overview with summarized metrics
+     *
+     * @param params Overview options:
+     *   - title_id: string - Required title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - group_by?: 'day'|'week'|'month'|'year' - Grouping period
+     *   - include_breakdowns?: boolean - Include detailed breakdowns
+     * @returns Promise with overview data
+     */
+    static overview<T>(params: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Single ingestion endpoint for sessions, pageviews and events
+     *
+     * @param data Analytics data payload with type property:
+     *   - type: 'session'|'pageview'|'event' - Type of analytics data
+     *   - title_id: string - Title ID
+     *   - tracking_token: string - HMAC token for verification
+     *   - plus type-specific fields
+     * @returns Promise with acceptance response
+     */
+    static collect<T>(data: object): AxiosPromise<Response<T>>;
+    /**
+     * Get average session length data with optional grouping
+     *
+     * @param params Filtering options:
+     *   - title_id?: string - Filter by title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - group_by?: 'day'|'week'|'month' - Grouping period
+     *   - device_type?: string - Filter by device type
+     *   - country_code?: string - Filter by country
+     * @returns Promise with average session data
+     */
+    static sessionsAverage<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get session duration histogram data
+     *
+     * @param params Filtering options:
+     *   - title_id?: string - Filter by title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - bucket_size?: number - Duration bucket size in seconds
+     * @returns Promise with histogram data
+     */
+    static sessionsHistogram<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get pageviews over time with optional grouping
+     *
+     * @param params Filtering options:
+     *   - title_id?: string - Filter by title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - group_by?: 'hour'|'day'|'week'|'month' - Grouping period
+     *   - path?: string - Filter by specific path
+     * @returns Promise with pageviews over time data
+     */
+    static pageviewsOverTime<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get top pages by views
+     *
+     * @param params Filtering options:
+     *   - title_id?: string - Filter by title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - limit?: number - Number of top pages to return
+     * @returns Promise with top pages data
+     */
+    static topPages<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get summary of events
+     *
+     * @param params Filtering options:
+     *   - title_id?: string - Filter by title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - event_category?: string - Filter by event category
+     * @returns Promise with events summary data
+     */
+    static eventsSummary<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get most popular events
+     *
+     * @param params Filtering options:
+     *   - title_id?: string - Filter by title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - limit?: number - Number of events to return
+     * @returns Promise with popular events data
+     */
+    static popularEvents<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get geographic distribution of visitors
+     *
+     * @param params Filtering options:
+     *   - title_id?: string - Filter by title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - limit?: number - Number of countries to return
+     * @returns Promise with geo distribution data
+     */
+    static geoDistribution<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get device type breakdown
+     *
+     * @param params Filtering options:
+     *   - title_id?: string - Filter by title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     * @returns Promise with device breakdown data
+     */
+    static deviceBreakdown<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get top referrers
+     *
+     * @param params Filtering options:
+     *   - title_id?: string - Filter by title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - limit?: number - Number of referrers to return
+     * @returns Promise with referrers data
+     */
+    static referrers<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+    /**
+     * Get UTM campaign performance
+     *
+     * @param params Filtering options:
+     *   - title_id?: string - Filter by title ID
+     *   - start_date?: string - Start date (YYYY-MM-DD)
+     *   - end_date?: string - End date (YYYY-MM-DD)
+     *   - group_by?: 'source'|'medium'|'campaign' - Grouping field
+     * @returns Promise with UTM performance data
+     */
+    static utmPerformance<T>(params?: Record<string, any>): AxiosPromise<Response<T>>;
+}
+
 interface Route {
     url: string;
     method: string;
@@ -4988,6 +5221,14 @@ declare class Session {
         email: string;
         username: string;
     }): void;
+    /**
+     * Generate a tracking token for analytics collection
+     * @param titleId The title ID to generate token for
+     * @param secret The secret key (should match server config)
+     * @returns HMAC-SHA256 token
+     * @throws Error if crypto operations fail
+     */
+    static generateTrackingToken(titleId: string, secret: string): string;
 }
 
 declare class Storage {
@@ -5258,6 +5499,7 @@ declare class Glitch {
         Scheduler: typeof Scheduler;
         Funnel: typeof Funnel;
         SocialStats: typeof SocialStats;
+        WebsiteAnalytics: typeof WebsiteAnalytics;
     };
     static util: {
         Requests: typeof Requests;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glitch-javascript-sdk",
-  "version": "1.8.0",
+  "version": "1.8.2",
   "description": "Javascript SDK for Glitch",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
@@ -35,6 +35,7 @@
     "vite-plugin-node-polyfills": "^0.17.0"
   },
   "dependencies": {
+    "@types/crypto-js": "^4.2.2",
     "axios": "^1.6.2",
     "buffer": "^6.0.3",
     "crypto-js": "^4.2.0",

package/src/api/Ads.ts

@@ -474,6 +474,93 @@ class Ads {
         );
     }
 
+    /**
+   * GET /ads/reddit/targeting/carriers
+   * 
+   * Example usage:
+   *   Ads.listRedditCarriers({ scheduler_id: 'uuid-of-scheduler', 'page.size': 50 })
+   */
+  public static listRedditCarriers<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.getRedditCarriers,
+      undefined,
+      undefined,
+      params
+    );
+  }
+
+  /**
+   * GET /ads/reddit/targeting/communities?names=sub1,sub2
+   */
+  public static listRedditCommunities<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.getRedditCommunities,
+      undefined,
+      undefined,
+      params
+    );
+  }
+
+  /**
+   * GET /ads/reddit/targeting/communities/search?query=xyz
+   */
+  public static searchRedditCommunities<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.searchRedditCommunities,
+      undefined,
+      undefined,
+      params
+    );
+  }
+
+  /**
+   * GET /ads/reddit/targeting/devices
+   */
+  public static listRedditDevices<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.getRedditDevices,
+      undefined,
+      undefined,
+      params
+    );
+  }
+
+  /**
+   * GET /ads/reddit/targeting/geolocations
+   */
+  public static listRedditGeolocations<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.getRedditGeolocations,
+      undefined,
+      undefined,
+      params
+    );
+  }
+
+  /**
+   * GET /ads/reddit/targeting/interests
+   */
+  public static listRedditInterests<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.getRedditInterests,
+      undefined,
+      undefined,
+      params
+    );
+  }
+
+  /**
+   * GET /ads/reddit/targeting/third_party_audiences
+   */
+  public static listRedditThirdPartyAudiences<T>(params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(
+      AdsRoute.routes.getRedditThirdPartyAudiences,
+      undefined,
+      undefined,
+      params
+    );
+  }
+
 }
 
 export default Ads;

package/src/api/Scheduler.ts

@@ -108,6 +108,19 @@ class Scheduler {
         return Requests.processRoute(SchedulerRoute.routes.listUpdates, {}, { scheduler_id }, params);
     }
 
+    /**
+     * Search the updates related to a promotion schedule.
+     * 
+     * @see https://api.glitch.fun/api/documentation#/Scheduler/searchTitleUpdates
+     * 
+     * @param scheduler_id The ID of the promotion schedule.
+     * 
+     * @returns promise
+     */
+    public static searchUpdates<T>(scheduler_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(SchedulerRoute.routes.listUpdates, {}, { scheduler_id }, params);
+    }
+
     /**
      * Create a new title update for a promotion schedule.
      * 
@@ -260,6 +273,16 @@ class Scheduler {
         return Requests.processRoute(SchedulerRoute.routes.clearRedditAuth, {}, { scheduler_id }, params);
     }
 
+    /**
+     * Clear Reddit Ads OAuth credentials from a promotion schedule.
+     *
+     * @param scheduler_id The ID of the promotion schedule.
+     * @returns promise
+     */
+    public static clearRedditAdsAuth<T>(scheduler_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+        return Requests.processRoute(SchedulerRoute.routes.clearRedditAdsAuth, {}, { scheduler_id }, params);
+    }
+
     /**
      * Clear YouTube OAuth credentials from a promotion schedule.
      *