glitch-javascript-sdk 3.10.3 → 3.10.4

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

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

package/dist/index.d.ts

@@ -11769,6 +11769,47 @@ declare class Hosting {
     static deleteDatabase<T>(title_id: string, site_id: string, database_id: string, confirmation: string): AxiosPromise<Response<T>>;
 }
 
+type GameDesignGenre = 'action' | 'adventure' | 'rpg' | 'strategy' | 'simulation' | 'puzzle' | 'survival' | 'platformer' | 'racing' | 'sports' | 'cozy' | 'horror' | 'card' | 'sandbox';
+type GameDesignPlayMode = 'single-player' | 'cooperative' | 'competitive multiplayer' | 'asynchronous multiplayer';
+type GameDesignSessionLength = '5–10 minute' | '15–30 minute' | '30–60 minute' | 'open-ended';
+interface GameDesignBlueprintInput {
+    gameName?: string;
+    genre: GameDesignGenre;
+    playMode: GameDesignPlayMode;
+    sessionLength: GameDesignSessionLength;
+    playerFantasy: string;
+    setting: string;
+    primaryGoal: string;
+    mainPressure: string;
+    signatureTwist: string;
+    progression?: string;
+    preferredActivities?: string;
+}
+interface GameDesignBlueprintItem {
+    title: string;
+    description: string;
+}
+interface GameDesignBlueprint {
+    gameName: string;
+    descriptor: string;
+    shortPitch: string;
+    coreFantasy: string;
+    coreVerbs: string[];
+    pillars: GameDesignBlueprintItem[];
+    mechanics: GameDesignBlueprintItem[];
+    coreLoop: GameDesignBlueprintItem[];
+    sessionLoop: string[];
+    coreTest: string;
+    scopeRules: string[];
+    documentationInstruction: string;
+    ai_used: boolean;
+}
+/** Public AI-assisted tools for turning an early game idea into testable design documentation. */
+declare class GameDesign {
+    /** Generate a mechanics and core-loop blueprint without requiring authentication. */
+    static generateBlueprint<T = GameDesignBlueprint>(input: GameDesignBlueprintInput): AxiosPromise<Response<T>>;
+}
+
 interface Route {
     url: string;
     method: string;
@@ -12141,6 +12182,7 @@ declare class Glitch {
         MarketResearch: typeof MarketResearch;
         GameAdvertising: typeof GameAdvertising;
         Hosting: typeof Hosting;
+        GameDesign: typeof GameDesign;
     };
     static util: {
         Requests: typeof Requests;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "glitch-javascript-sdk",
-  "version": "3.10.3",
+  "version": "3.10.4",
   "description": "Javascript SDK for Glitch",
   "publishConfig": {
     "access": "public"
@@ -13,7 +13,7 @@
   ],
   "types": "dist/index.d.ts",
   "scripts": {
-    "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",
+    "test": "node scripts/test-hosting-routes.cjs && node scripts/test-game-advertising-routes.cjs && node scripts/test-game-design-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/GameDesign.ts

@@ -0,0 +1,79 @@
+import { AxiosPromise } from 'axios';
+import GameDesignRoute from '../routes/GameDesignRoute';
+import Requests from '../util/Requests';
+import Response from '../util/Response';
+
+export type GameDesignGenre =
+  | 'action'
+  | 'adventure'
+  | 'rpg'
+  | 'strategy'
+  | 'simulation'
+  | 'puzzle'
+  | 'survival'
+  | 'platformer'
+  | 'racing'
+  | 'sports'
+  | 'cozy'
+  | 'horror'
+  | 'card'
+  | 'sandbox';
+
+export type GameDesignPlayMode =
+  | 'single-player'
+  | 'cooperative'
+  | 'competitive multiplayer'
+  | 'asynchronous multiplayer';
+
+export type GameDesignSessionLength =
+  | '5–10 minute'
+  | '15–30 minute'
+  | '30–60 minute'
+  | 'open-ended';
+
+export interface GameDesignBlueprintInput {
+  gameName?: string;
+  genre: GameDesignGenre;
+  playMode: GameDesignPlayMode;
+  sessionLength: GameDesignSessionLength;
+  playerFantasy: string;
+  setting: string;
+  primaryGoal: string;
+  mainPressure: string;
+  signatureTwist: string;
+  progression?: string;
+  preferredActivities?: string;
+}
+
+export interface GameDesignBlueprintItem {
+  title: string;
+  description: string;
+}
+
+export interface GameDesignBlueprint {
+  gameName: string;
+  descriptor: string;
+  shortPitch: string;
+  coreFantasy: string;
+  coreVerbs: string[];
+  pillars: GameDesignBlueprintItem[];
+  mechanics: GameDesignBlueprintItem[];
+  coreLoop: GameDesignBlueprintItem[];
+  sessionLoop: string[];
+  coreTest: string;
+  scopeRules: string[];
+  documentationInstruction: string;
+  ai_used: boolean;
+}
+
+/** Public AI-assisted tools for turning an early game idea into testable design documentation. */
+class GameDesign {
+  /** Generate a mechanics and core-loop blueprint without requiring authentication. */
+  static generateBlueprint<T = GameDesignBlueprint>(
+    input: GameDesignBlueprintInput
+  ): AxiosPromise<Response<T>> {
+    return Requests.processRoute<T>(GameDesignRoute.routes.generateBlueprint, input);
+  }
+}
+
+export default GameDesign;

package/src/api/index.ts

@@ -53,6 +53,7 @@ import AdminUsers from "./AdminUsers";
 import MarketResearch from "./MarketResearch";
 import GameAdvertising from './GameAdvertising';
 import Hosting from './Hosting';
+import GameDesign from './GameDesign';
 
 export {Ads};
 export {AccessKeys};
@@ -109,3 +110,4 @@ export {AdminUsers};
 export {MarketResearch};
 export {GameAdvertising};
 export {Hosting};
+export {GameDesign};

package/src/index.ts

@@ -57,6 +57,7 @@ import {AdminUsers} from './api';
 import {MarketResearch} from './api';
 import {GameAdvertising} from './api';
 import {Hosting} from './api';
+import {GameDesign} from './api';
 
 import Requests from "./util/Requests";
 import Parser from "./util/Parser";
@@ -143,6 +144,7 @@ class Glitch {
         MarketResearch : MarketResearch,
         GameAdvertising: GameAdvertising,
         Hosting: Hosting,
+        GameDesign: GameDesign,
     }
 
     public static util = {

package/src/routes/GameDesignRoute.ts

@@ -0,0 +1,13 @@
+import HTTP_METHODS from '../constants/HttpMethods';
+import Route from './interface';
+
+class GameDesignRoute {
+  public static routes: { [key: string]: Route } = {
+    generateBlueprint: {
+      url: '/tools/game-design/blueprint',
+      method: HTTP_METHODS.POST,
+    },
+  };
+}
+
+export default GameDesignRoute;