glitch-javascript-sdk 3.8.13 → 3.9.0

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

@@ -0,0 +1,8 @@
+import Route from './interface';
+/** Route catalog for Azure-backed game website hosting. */
+declare class HostingRoute {
+    static routes: {
+        [key: string]: Route;
+    };
+}
+export default HostingRoute;

package/dist/index.d.ts

@@ -11525,6 +11525,62 @@ declare class GameAdvertising {
     static adminUpsertProviderApp<T>(data: GameAdProviderApp): AxiosPromise<Response<T>>;
 }
 
+type HostingMode = 'static' | 'server';
+type HostingDatabaseEngine = 'postgresql' | 'mysql' | 'azure_sql' | 'cosmos_nosql';
+type HostingDatabasePlan = 'sandbox' | 'launch' | 'growth' | 'scale' | 'dedicated';
+interface CreateHostingSiteRequest {
+    name: string;
+    slug: string;
+    mode: HostingMode;
+    azure_region?: string;
+}
+interface CreateHostingReleaseRequest {
+    version: string;
+    source_type: 'upload' | 'cli' | 'game_build';
+    blob_path?: string;
+    game_build_id?: string;
+    entry_point?: string;
+}
+interface CreateHostingDatabaseRequest {
+    name: string;
+    engine: HostingDatabaseEngine;
+    plan: HostingDatabasePlan;
+    azure_region: string;
+    auto_grow_enabled?: boolean;
+    high_availability_enabled?: boolean;
+}
+/**
+ * Typed SDK for game website hosting, Azure database add-ons, domains, usage,
+ * deployment instructions, and hosted-play attribution.
+ */
+declare class Hosting {
+    static catalog<T>(): AxiosPromise<Response<T>>;
+    static dashboard<T>(title_id: string): AxiosPromise<Response<T>>;
+    static channelAnalytics<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static createSite<T>(title_id: string, data: CreateHostingSiteRequest): AxiosPromise<Response<T>>;
+    static updateSite<T>(title_id: string, site_id: string, data: Partial<CreateHostingSiteRequest> & Record<string, any>): AxiosPromise<Response<T>>;
+    static createUploadUrl<T>(title_id: string, site_id: string): AxiosPromise<Response<T>>;
+    /** Upload directly to the short-lived Azure URL returned by createUploadUrl. */
+    static uploadBuild(uploadUrl: string, file: Blob, requiredHeaders?: Record<string, string>, onUploadProgress?: (event: AxiosProgressEvent) => void): AxiosPromise<void>;
+    static releases<T>(title_id: string, site_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static createRelease<T>(title_id: string, site_id: string, data: CreateHostingReleaseRequest): AxiosPromise<Response<T>>;
+    static promoteRelease<T>(title_id: string, site_id: string, release_id: string): AxiosPromise<Response<T>>;
+    static connectDomain<T>(title_id: string, site_id: string, hostname: string): AxiosPromise<Response<T>>;
+    static verifyDomain<T>(title_id: string, site_id: string, domain_id: string): AxiosPromise<Response<T>>;
+    static checkDomain<T>(hostname: string): AxiosPromise<Response<T>>;
+    static purchaseDomain<T>(title_id: string, site_id: string, data: Record<string, any>): AxiosPromise<Response<T>>;
+    static aiInstructions<T>(title_id: string, site_id: string, data?: Record<string, any>): AxiosPromise<Response<T>>;
+    static resolve<T>(hostname: string): AxiosPromise<Response<T>>;
+    static startPlaySession<T>(data: Record<string, any>): AxiosPromise<Response<T>>;
+    static heartbeatPlaySession<T>(session_id: string, sessionToken: string): AxiosPromise<Response<T>>;
+    static databases<T>(title_id: string, site_id: string, params?: Record<string, any>): AxiosPromise<Response<T>>;
+    static createDatabase<T>(title_id: string, site_id: string, data: CreateHostingDatabaseRequest): AxiosPromise<Response<T>>;
+    static database<T>(title_id: string, site_id: string, database_id: string): AxiosPromise<Response<T>>;
+    static updateDatabase<T>(title_id: string, site_id: string, database_id: string, data: Record<string, any>): AxiosPromise<Response<T>>;
+    static retryDatabase<T>(title_id: string, site_id: string, database_id: string): AxiosPromise<Response<T>>;
+    static deleteDatabase<T>(title_id: string, site_id: string, database_id: string, confirmation: string): AxiosPromise<Response<T>>;
+}
+
 interface Route {
     url: string;
     method: string;
@@ -11896,6 +11952,7 @@ declare class Glitch {
         AdminUsers: typeof AdminUsers;
         MarketResearch: typeof MarketResearch;
         GameAdvertising: typeof GameAdvertising;
+        Hosting: typeof Hosting;
     };
     static util: {
         Requests: typeof Requests;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glitch-javascript-sdk",
-  "version": "3.8.13",
+  "version": "3.9.0",
   "description": "Javascript SDK for Glitch",
   "publishConfig": {
     "access": "public"
@@ -13,7 +13,7 @@
   ],
   "types": "dist/index.d.ts",
   "scripts": {
-    "test": "node scripts/test-game-advertising-routes.cjs && node scripts/test-discord-media-routes.cjs && node scripts/test-user-email-delivery-routes.cjs && node scripts/test-game-show-ticket-routes.cjs",
+    "test": "node scripts/test-hosting-routes.cjs && node scripts/test-game-advertising-routes.cjs && node scripts/test-discord-media-routes.cjs && node scripts/test-user-email-delivery-routes.cjs && node scripts/test-game-show-ticket-routes.cjs",
     "build": "rm -Rf dist && rollup -c --bundleConfigAsCjs",
     "build-docs": "rm  -rf docs && typedoc  --tsconfig tsconfig.json src/"
   },

package/src/api/Hosting.ts

@@ -0,0 +1,223 @@
+import axios, { AxiosPromise, AxiosProgressEvent } from 'axios';
+import HostingRoute from '../routes/HostingRoute';
+import Config from '../config/Config';
+import Requests from '../util/Requests';
+import Response from '../util/Response';
+
+export type HostingPlanKey = 'free' | 'launch' | 'growth' | 'scale' | 'studio';
+export type HostingMode = 'static' | 'server';
+export type HostingDatabaseEngine = 'postgresql' | 'mysql' | 'azure_sql' | 'cosmos_nosql';
+export type HostingDatabasePlan = 'sandbox' | 'launch' | 'growth' | 'scale' | 'dedicated';
+export type HostingDeliveryChannel = 'glitch_store' | 'glitch_hosted_subdomain' | 'glitch_hosted_custom_domain' | 'external';
+
+export interface HostingAccount {
+  id: string;
+  community_id: string;
+  plan: HostingPlanKey;
+  status: string;
+  included_bandwidth_bytes: number;
+  used_bandwidth_bytes: number;
+  remaining_bandwidth_bytes: number;
+  bandwidth_overage_enabled: boolean;
+  bandwidth_spend_limit_cents?: number | null;
+}
+
+export interface HostingRelease {
+  id: string;
+  hosting_site_id: string;
+  game_build_id?: string | null;
+  version: string;
+  status: 'uploading' | 'processing' | 'ready' | 'failed' | 'active' | 'inactive';
+  source_type: 'upload' | 'cli' | 'game_build';
+  entry_point: string;
+  size_bytes: number;
+  checksum?: string | null;
+  error_message?: string | null;
+  promoted_at?: string | null;
+}
+
+export interface HostingDomain {
+  id: string;
+  hostname: string;
+  type: 'generated' | 'custom' | 'managed';
+  status: 'pending_verification' | 'provisioning' | 'active' | 'failed' | 'expired';
+  verification_record_type?: string | null;
+  verification_record_name?: string | null;
+  verification_record_value?: string | null;
+  certificate_status?: string | null;
+  annual_price_cents?: number | null;
+  auto_renew: boolean;
+}
+
+export interface HostingDatabase {
+  id: string;
+  hosting_site_id: string;
+  name: string;
+  engine: HostingDatabaseEngine;
+  plan: HostingDatabasePlan;
+  status: 'awaiting_payment' | 'requested' | 'provisioning' | 'ready' | 'resizing' | 'restoring' | 'failed' | 'deleting' | 'deleted';
+  deployment_model: 'shared' | 'dedicated' | 'serverless';
+  azure_region: string;
+  included_storage_bytes: number;
+  current_storage_bytes: number;
+  auto_grow_enabled: boolean;
+  backup_retention_days: number;
+  high_availability_enabled: boolean;
+  endpoint?: string | null;
+  port?: number | null;
+  binding_name: 'DATABASE_URL' | 'COSMOS_DATABASE';
+  last_error?: string | null;
+}
+
+export interface HostingSite {
+  id: string;
+  hosting_account_id: string;
+  community_id: string;
+  title_id: string;
+  name: string;
+  slug: string;
+  community_slug: string;
+  generated_hostname: string;
+  url: string;
+  mode: HostingMode;
+  status: 'draft' | 'provisioning' | 'live' | 'limited' | 'failed' | 'disabled';
+  server_mode_enabled: boolean;
+  azure_region?: string | null;
+  active_release?: HostingRelease | null;
+  domains?: HostingDomain[];
+  databases?: HostingDatabase[];
+}
+
+export interface CreateHostingSiteRequest {
+  name: string;
+  slug: string;
+  mode: HostingMode;
+  azure_region?: string;
+}
+
+export interface CreateHostingReleaseRequest {
+  version: string;
+  source_type: 'upload' | 'cli' | 'game_build';
+  blob_path?: string;
+  game_build_id?: string;
+  entry_point?: string;
+}
+
+export interface CreateHostingDatabaseRequest {
+  name: string;
+  engine: HostingDatabaseEngine;
+  plan: HostingDatabasePlan;
+  azure_region: string;
+  auto_grow_enabled?: boolean;
+  high_availability_enabled?: boolean;
+}
+
+/**
+ * Typed SDK for game website hosting, Azure database add-ons, domains, usage,
+ * deployment instructions, and hosted-play attribution.
+ */
+class Hosting {
+  public static catalog<T>(): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.catalog);
+  }
+
+  public static dashboard<T>(title_id: string): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.dashboard, undefined, { title_id });
+  }
+
+  public static channelAnalytics<T>(title_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.channelAnalytics, undefined, { title_id }, params);
+  }
+
+  public static createSite<T>(title_id: string, data: CreateHostingSiteRequest): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.createSite, data, { title_id });
+  }
+
+  public static updateSite<T>(title_id: string, site_id: string, data: Partial<CreateHostingSiteRequest> & Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.updateSite, data, { title_id, site_id });
+  }
+
+  public static createUploadUrl<T>(title_id: string, site_id: string): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.uploadUrl, {}, { title_id, site_id });
+  }
+
+  /** Upload directly to the short-lived Azure URL returned by createUploadUrl. */
+  public static uploadBuild(uploadUrl: string, file: Blob, requiredHeaders: Record<string, string> = {}, onUploadProgress?: (event: AxiosProgressEvent) => void): AxiosPromise<void> {
+    return axios.put(uploadUrl, file, {
+      headers: { 'x-ms-blob-type': 'BlockBlob', 'Content-Type': 'application/zip', ...requiredHeaders },
+      onUploadProgress,
+    });
+  }
+
+  public static releases<T>(title_id: string, site_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.releases, undefined, { title_id, site_id }, params);
+  }
+
+  public static createRelease<T>(title_id: string, site_id: string, data: CreateHostingReleaseRequest): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.createRelease, data, { title_id, site_id });
+  }
+
+  public static promoteRelease<T>(title_id: string, site_id: string, release_id: string): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.promoteRelease, {}, { title_id, site_id, release_id });
+  }
+
+  public static connectDomain<T>(title_id: string, site_id: string, hostname: string): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.connectDomain, { hostname }, { title_id, site_id });
+  }
+
+  public static verifyDomain<T>(title_id: string, site_id: string, domain_id: string): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.verifyDomain, {}, { title_id, site_id, domain_id });
+  }
+
+  public static checkDomain<T>(hostname: string): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.checkDomain, { hostname });
+  }
+
+  public static purchaseDomain<T>(title_id: string, site_id: string, data: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.purchaseDomain, data, { title_id, site_id });
+  }
+
+  public static aiInstructions<T>(title_id: string, site_id: string, data: Record<string, any> = {}): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.aiInstructions, data, { title_id, site_id });
+  }
+
+  public static resolve<T>(hostname: string): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.resolve, undefined, undefined, { hostname });
+  }
+
+  public static startPlaySession<T>(data: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.startPlaySession, data);
+  }
+
+  public static heartbeatPlaySession<T>(session_id: string, sessionToken: string): AxiosPromise<Response<T>> {
+    const path = HostingRoute.routes.heartbeatPlaySession.url.replace('{session_id}', session_id);
+    const base = (Config.getBaseUrl() || '').replace(/\/+$/, '');
+    return axios.post(`${base}/${path.replace(/^\/+/, '')}`, {}, { headers: { Authorization: `Bearer ${sessionToken}` } });
+  }
+
+  public static databases<T>(title_id: string, site_id: string, params?: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.databases, undefined, { title_id, site_id }, params);
+  }
+
+  public static createDatabase<T>(title_id: string, site_id: string, data: CreateHostingDatabaseRequest): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.createDatabase, data, { title_id, site_id });
+  }
+
+  public static database<T>(title_id: string, site_id: string, database_id: string): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.database, undefined, { title_id, site_id, database_id });
+  }
+
+  public static updateDatabase<T>(title_id: string, site_id: string, database_id: string, data: Record<string, any>): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.updateDatabase, data, { title_id, site_id, database_id });
+  }
+
+  public static retryDatabase<T>(title_id: string, site_id: string, database_id: string): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.retryDatabase, {}, { title_id, site_id, database_id });
+  }
+
+  public static deleteDatabase<T>(title_id: string, site_id: string, database_id: string, confirmation: string): AxiosPromise<Response<T>> {
+    return Requests.processRoute(HostingRoute.routes.deleteDatabase, undefined, { title_id, site_id, database_id }, { confirmation });
+  }
+}
+
+export default Hosting;

package/src/api/index.ts

@@ -52,6 +52,7 @@ import AdminReports from "./AdminReports";
 import AdminUsers from "./AdminUsers";
 import MarketResearch from "./MarketResearch";
 import GameAdvertising from './GameAdvertising';
+import Hosting from './Hosting';
 
 export {Ads};
 export {AccessKeys};
@@ -107,3 +108,4 @@ export {AdminReports};
 export {AdminUsers};
 export {MarketResearch};
 export {GameAdvertising};
+export {Hosting};

package/src/index.ts

@@ -56,6 +56,7 @@ import {AdminReports} from './api';
 import {AdminUsers} from './api';
 import {MarketResearch} from './api';
 import {GameAdvertising} from './api';
+import {Hosting} from './api';
 
 import Requests from "./util/Requests";
 import Parser from "./util/Parser";
@@ -141,6 +142,7 @@ class Glitch {
         AdminUsers : AdminUsers,
         MarketResearch : MarketResearch,
         GameAdvertising: GameAdvertising,
+        Hosting: Hosting,
     }
 
     public static util = {

package/src/routes/HostingRoute.ts

@@ -0,0 +1,33 @@
+import Route from './interface';
+import HTTP_METHODS from '../constants/HttpMethods';
+
+/** Route catalog for Azure-backed game website hosting. */
+class HostingRoute {
+  public static routes: { [key: string]: Route } = {
+    catalog: { url: '/hosting/catalog', method: HTTP_METHODS.GET },
+    dashboard: { url: '/titles/{title_id}/hosting', method: HTTP_METHODS.GET },
+    channelAnalytics: { url: '/titles/{title_id}/hosting/analytics/channels', method: HTTP_METHODS.GET },
+    createSite: { url: '/titles/{title_id}/hosting/sites', method: HTTP_METHODS.POST },
+    updateSite: { url: '/titles/{title_id}/hosting/sites/{site_id}', method: HTTP_METHODS.PUT },
+    uploadUrl: { url: '/titles/{title_id}/hosting/sites/{site_id}/upload-url', method: HTTP_METHODS.POST },
+    releases: { url: '/titles/{title_id}/hosting/sites/{site_id}/releases', method: HTTP_METHODS.GET },
+    createRelease: { url: '/titles/{title_id}/hosting/sites/{site_id}/releases', method: HTTP_METHODS.POST },
+    promoteRelease: { url: '/titles/{title_id}/hosting/sites/{site_id}/releases/{release_id}/promote', method: HTTP_METHODS.POST },
+    connectDomain: { url: '/titles/{title_id}/hosting/sites/{site_id}/domains', method: HTTP_METHODS.POST },
+    verifyDomain: { url: '/titles/{title_id}/hosting/sites/{site_id}/domains/{domain_id}/verify', method: HTTP_METHODS.POST },
+    checkDomain: { url: '/hosting/domains/check', method: HTTP_METHODS.POST },
+    purchaseDomain: { url: '/titles/{title_id}/hosting/sites/{site_id}/domains/purchase', method: HTTP_METHODS.POST },
+    aiInstructions: { url: '/titles/{title_id}/hosting/sites/{site_id}/ai-instructions', method: HTTP_METHODS.POST },
+    resolve: { url: '/hosting/resolve', method: HTTP_METHODS.GET },
+    startPlaySession: { url: '/hosting/play-sessions', method: HTTP_METHODS.POST },
+    heartbeatPlaySession: { url: '/hosting/play-sessions/{session_id}/heartbeat', method: HTTP_METHODS.POST },
+    databases: { url: '/titles/{title_id}/hosting/sites/{site_id}/databases', method: HTTP_METHODS.GET },
+    createDatabase: { url: '/titles/{title_id}/hosting/sites/{site_id}/databases', method: HTTP_METHODS.POST },
+    database: { url: '/titles/{title_id}/hosting/sites/{site_id}/databases/{database_id}', method: HTTP_METHODS.GET },
+    updateDatabase: { url: '/titles/{title_id}/hosting/sites/{site_id}/databases/{database_id}', method: HTTP_METHODS.PUT },
+    retryDatabase: { url: '/titles/{title_id}/hosting/sites/{site_id}/databases/{database_id}/retry', method: HTTP_METHODS.POST },
+    deleteDatabase: { url: '/titles/{title_id}/hosting/sites/{site_id}/databases/{database_id}', method: HTTP_METHODS.DELETE },
+  };
+}
+
+export default HostingRoute;