@fzgame/sdk 0.1.0 → 0.3.1

package/dist/index.d.ts

@@ -79,7 +79,144 @@ interface paths {
       responses: {
         200: {
           content: {
-            "application/json": components["schemas"]["AppGameInstance"];
+            "application/json": components["schemas"]["PublicGameInstance"];
+          };
+        };
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/pub/categories": {
+    /** Public game category feed */
+    get: {
+      responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["CategoryFeed"];
+          };
+        };
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/pub/categories/{id}/games": {
+    /** Public games in a category */
+    get: {
+      parameters: {
+        query?: {
+          page?: string;
+          cursor?: string;
+          limit?: string;
+          order?: string;
+          sortBy?: string;
+          cursorField?: string;
+          search?: string;
+          filter?: string;
+          include?: string;
+          searchField?: string;
+        };
+        path: {
+          id: string;
+        };
+      };
+      responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["PagedGame"];
+          };
+        };
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/pub/game-instances/{id}/leaderboard/players": {
+    /** Public top score per player for a published game instance */
+    get: {
+      parameters: {
+        query?: {
+          page?: number;
+          limit?: number;
+        };
+        path: {
+          id: string;
+        };
+      };
+      responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["PagedPlayerLeaderboard"];
+          };
+        };
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/pub/game-instances/{id}/leaderboard/sessions": {
+    /** Public top scoring play sessions for a published game instance */
+    get: {
+      parameters: {
+        query?: {
+          page?: number;
+          limit?: number;
+        };
+        path: {
+          id: string;
+        };
+      };
+      responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["PagedSessionLeaderboard"];
+          };
+        };
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/pub/games/{id}/leaderboard/players": {
+    /** Public top score per player across the published instances of a game */
+    get: {
+      parameters: {
+        query?: {
+          page?: number;
+          limit?: number;
+        };
+        path: {
+          id: string;
+        };
+      };
+      responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["PagedPlayerLeaderboard"];
+          };
+        };
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/pub/games/{id}/leaderboard/sessions": {
+    /** Public top scoring play sessions across the published instances of a game */
+    get: {
+      parameters: {
+        query?: {
+          page?: number;
+          limit?: number;
+        };
+        path: {
+          id: string;
+        };
+      };
+      responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["PagedSessionLeaderboard"];
           };
         };
         401: components["responses"]["Unauthorized"];
@@ -96,6 +233,11 @@ interface paths {
         };
       };
       responses: {
+        201: {
+          content: {
+            "application/json": components["schemas"]["PlayerLoginResponse"];
+          };
+        };
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
       };
@@ -110,6 +252,11 @@ interface paths {
         };
       };
       responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["AppPlayer"];
+          };
+        };
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
       };
@@ -127,6 +274,11 @@ interface paths {
         };
       };
       responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["AppPlayer"];
+          };
+        };
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
       };
@@ -139,6 +291,11 @@ interface paths {
         };
       };
       responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["AppPlayer"];
+          };
+        };
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
       };
@@ -153,12 +310,17 @@ interface paths {
         };
       };
       responses: {
+        201: {
+          content: {
+            "application/json": components["schemas"]["PlayerLogoutResponse"];
+          };
+        };
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
       };
     };
   };
-  "/sessions": {
+  "/sdk/sessions": {
     /** Create a play session (SDK) */
     post: {
       requestBody?: {
@@ -167,12 +329,37 @@ interface paths {
         };
       };
       responses: {
+        201: {
+          content: {
+            "application/json": components["schemas"]["AppPlaySession"];
+          };
+        };
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/sdk/sessions/active": {
+    /** Get the newest live session of a player (SDK) */
+    get: {
+      parameters: {
+        query?: {
+          playerId?: string;
+          gameInstanceId?: string;
+        };
+      };
+      responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["ActivePlaySession"];
+          };
+        };
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
       };
     };
   };
-  "/sessions/{token}": {
+  "/sdk/sessions/{token}": {
     /** Get play session by token (SDK / iframe) */
     get: {
       parameters: {
@@ -181,6 +368,11 @@ interface paths {
         };
       };
       responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["AppPlaySession"];
+          };
+        };
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
       };
@@ -193,39 +385,59 @@ interface paths {
         };
       };
       responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["AppPlaySession"];
+          };
+        };
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
       };
     };
   };
-  "/sessions/{token}/pause": {
+  "/sdk/sessions/{token}/pause": {
     /** Pause a playing session */
     post: {
       responses: {
+        201: {
+          content: {
+            "application/json": components["schemas"]["AppPlaySession"];
+          };
+        };
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
       };
     };
   };
-  "/sessions/{token}/resume": {
+  "/sdk/sessions/{token}/resume": {
     /** Resume a paused session */
     post: {
       responses: {
+        201: {
+          content: {
+            "application/json": components["schemas"]["AppPlaySession"];
+          };
+        };
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
       };
     };
   };
-  "/sessions/{token}/start": {
+  "/sdk/sessions/{token}/start": {
     /** Start play session */
     post: {
       responses: {
+        201: {
+          content: {
+            "application/json": components["schemas"]["AppPlaySession"];
+          };
+        };
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
       };
     };
   };
-  "/sessions/{token}/finish": {
+  "/sdk/sessions/{token}/finish": {
     /** Finish play session */
     post: {
       requestBody?: {
@@ -234,21 +446,31 @@ interface paths {
         };
       };
       responses: {
+        201: {
+          content: {
+            "application/json": components["schemas"]["AppPlaySession"];
+          };
+        };
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
       };
     };
   };
-  "/sessions/{token}/abort": {
+  "/sdk/sessions/{token}/abort": {
     /** Abort play session */
     post: {
       responses: {
+        201: {
+          content: {
+            "application/json": components["schemas"]["AppPlaySession"];
+          };
+        };
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
       };
     };
   };
-  "/sessions/{token}/score": {
+  "/sdk/sessions/{token}/score": {
     /** Update session score */
     post: {
       requestBody?: {
@@ -257,13 +479,18 @@ interface paths {
         };
       };
       responses: {
+        201: {
+          content: {
+            "application/json": components["schemas"]["AppPlaySession"];
+          };
+        };
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
       };
     };
   };
   "/games/runtime/sessions": {
-    /** Fetch or create a play session from gameInstanceId + player token */
+    /** Fetch or create a play session from gameInstanceId + player access token */
     post: {
       requestBody?: {
         content: {
@@ -271,6 +498,11 @@ interface paths {
         };
       };
       responses: {
+        201: {
+          content: {
+            "application/json": components["schemas"]["AppPlaySession"];
+          };
+        };
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
       };
@@ -285,6 +517,11 @@ interface paths {
         };
       };
       responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["AppPlaySession"];
+          };
+        };
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
       };
@@ -304,6 +541,11 @@ interface paths {
         };
       };
       responses: {
+        201: {
+          content: {
+            "application/json": components["schemas"]["AppPlaySession"];
+          };
+        };
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
       };
@@ -322,6 +564,25 @@ interface paths {
           "application/json": components["schemas"]["RuntimeSnapshotDto"];
         };
       };
+      responses: {
+        200: {
+          content: {
+            "application/json": components["schemas"]["AppPlaySession"];
+          };
+        };
+        401: components["responses"]["Unauthorized"];
+        403: components["responses"]["Forbidden"];
+      };
+    };
+  };
+  "/games/runtime/handler": {
+    /** Run a game handler against a finish payload (studio testing; no play session) */
+    post: {
+      requestBody?: {
+        content: {
+          "application/json": components["schemas"]["RuntimeHandlerDto"];
+        };
+      };
       responses: {
         401: components["responses"]["Unauthorized"];
         403: components["responses"]["Forbidden"];
@@ -384,6 +645,7 @@ interface components {
       gitConnectors?: components["schemas"]["GitConnector"][];
       gitSources?: components["schemas"]["GitSource"][];
       deployments?: components["schemas"]["Deployment"][];
+      ciRunners?: components["schemas"]["CiRunner"][];
     };
     Users: {
       id: string;
@@ -445,6 +707,11 @@ interface components {
       backupCodes: string;
       userId: string;
       users?: components["schemas"]["Users"];
+      verified: boolean;
+      /** Format: int32 */
+      failedVerificationCount: number;
+      /** Format: date-time */
+      lockedUntil: string | null;
     };
     UserSpace: {
       id: string;
@@ -607,6 +874,8 @@ interface components {
       /** @enum {string} */
       origin: "OFFICAL" | "DEVELOPER" | "SPACE_PRIVATE";
       configSchema: Record<string, unknown> | null;
+      categoryId: string | null;
+      category?: components["schemas"]["GameCategory"];
       creatorId: string | null;
       creator?: components["schemas"]["Users"];
       spaceId: string | null;
@@ -617,6 +886,21 @@ interface components {
       instances?: components["schemas"]["AppGameInstance"][];
       gitSources?: components["schemas"]["GitSource"][];
     };
+    GameCategory: {
+      id: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      /** Format: date-time */
+      deletedAt: string | null;
+      name: string;
+      slug: string;
+      description: string | null;
+      /** Format: int32 */
+      sortOrder: number;
+      games?: components["schemas"]["Game"][];
+    };
     Deployment: {
       id: string;
       /** Format: date-time */
@@ -752,6 +1036,8 @@ interface components {
       version: string | null;
       creatorId: string | null;
       creator?: components["schemas"]["Users"];
+      spaceId: string | null;
+      space?: components["schemas"]["Space"];
       deployments?: components["schemas"]["Deployment"][];
     };
     Webhook: {
@@ -855,6 +1141,79 @@ interface components {
        */
       hasPreviousPage: boolean;
     };
+    PublicGameInstance: {
+      id: string;
+      /** Format: date-time */
+      createdAt: string;
+      /** Format: date-time */
+      updatedAt: string;
+      spaceId: string;
+      appId: string;
+      name: string;
+      /** @enum {string} */
+      status: "DRAFT" | "PUBLISHED" | "ARCHIVED";
+      resolvedUrl: string | null;
+      /** Format: date-time */
+      resolvedAt: string | null;
+      overrides: Record<string, unknown> | null;
+      gameId: string;
+      game: components["schemas"]["Game"];
+      editorUrl: string | null;
+    };
+    CategoryFeed: {
+      data: components["schemas"]["CategorySummary"][];
+    };
+    CategorySummary: {
+      id: string;
+      name: string;
+      slug: string;
+      description?: string | null;
+      sortOrder: number;
+      /** @description Published games in this category */
+      gameCount: number;
+    };
+    PagedGame: {
+      /** @description Page info */
+      pageInfo: components["schemas"]["PageInfo"];
+      /** @description Array of resource items for the current page */
+      data: components["schemas"]["Game"][];
+    };
+    PagedPlayerLeaderboard: {
+      /** @description Page info */
+      pageInfo: components["schemas"]["PageInfo"];
+      /** @description Array of resource items for the current page */
+      data: components["schemas"]["PlayerLeaderboardEntry"][];
+    };
+    PlayerLeaderboardEntry: {
+      /** @description Rank on the requested page (1-based) */
+      rank: number;
+      player: components["schemas"]["LeaderboardPlayer"];
+      score: number;
+      /** @description Session that holds the player best score */
+      sessionId: string;
+      /** Format: date-time */
+      finishedAt: string | null;
+    };
+    LeaderboardPlayer: {
+      id: string;
+      displayName: string | null;
+      avatarUrl: string | null;
+    };
+    PagedSessionLeaderboard: {
+      /** @description Page info */
+      pageInfo: components["schemas"]["PageInfo"];
+      /** @description Array of resource items for the current page */
+      data: components["schemas"]["SessionLeaderboardEntry"][];
+    };
+    SessionLeaderboardEntry: {
+      /** @description Rank on the requested page (1-based) */
+      rank: number;
+      sessionId: string;
+      player: components["schemas"]["LeaderboardPlayer"];
+      score: number;
+      /** Format: date-time */
+      finishedAt: string | null;
+    };
     IdentifyPlayerDto: {
       identity?: string;
       /** @enum {string} */
@@ -864,12 +1223,22 @@ interface components {
       avatarUrl?: string;
       metadata?: Record<string, unknown>;
     };
+    PlayerLoginResponse: {
+      player: components["schemas"]["AppPlayer"];
+      /** @description Signed player access token (JWT). Pass it to the game as the `playerAccessToken` query parameter; `POST /games/runtime/sessions` verifies it. */
+      playerAccessToken: string;
+    };
     UpdatePlayerDto: {
       externalId?: string;
       displayName?: string;
       avatarUrl?: string;
       metadata?: Record<string, unknown>;
     };
+    PlayerLogoutResponse: {
+      playerId: string;
+      /** @description Live play sessions expired by the logout */
+      revokedSessions: number;
+    };
     CreatePlaySessionDto: {
       playerId: string;
       gameInstanceId: string;
@@ -880,6 +1249,10 @@ interface components {
        */
       expiresAt?: string;
     };
+    ActivePlaySession: {
+      /** @description The newest live session, or null when the player has none. */
+      session?: components["schemas"]["AppPlaySession"];
+    };
     UpdatePlaySessionDto: {
       /**
        * @description Only transitions allowed by the session lifecycle are accepted
@@ -896,7 +1269,8 @@ interface components {
     };
     CreateRuntimeSessionDto: {
       gameInstanceId: string;
-      playerToken: string;
+      /** @description The `playerAccessToken` returned by `POST /sdk/login`. */
+      playerAccessToken: string;
     };
     RuntimeEmitDto: {
       /** @description Session event. The lifecycle names (`LIFECYCLE_EVENTS` in `src/game/lifecycle.ts`: ready, start, pause, finish, abort, score, snapshot) move the session status; any other string is accepted as a custom event, leaves the status alone, and is stored as the session `lastEvent`. */
@@ -906,6 +1280,14 @@ interface components {
     RuntimeSnapshotDto: {
       state: Record<string, unknown>;
     };
+    RuntimeHandlerDto: {
+      /** @description Published game id. Loads handler/index.js from the registry. */
+      gameId?: string;
+      /** @description Handler source for local studio testing. Takes precedence over gameId. */
+      source?: string;
+      /** @description Finish payload: { score, result, config } */
+      payload?: Record<string, unknown>;
+    };
   };
   responses: {
     /** @description Unauthorized access */
@@ -977,5 +1359,23 @@ declare function createSdkClient(options: InitOptions): Client<paths>;
 declare const fetchClient: Client<paths>;
 /** Configure the process-wide client and return it. */
 declare function initializeSDK(options: InitOptions): Client<paths>;
+/** A game instance from `GET /sdk/game-instances`, as generated from the OpenAPI document. */
+type GameInstance = components['schemas']['AppGameInstance'];
+type ResolveGameUrlOptions = {
+    /** API base URL the frame calls. Defaults to the `apiUrl` passed to `initializeSDK`. */
+    apiUrl?: string;
+    /** Config to hand the game as `gameSetting`. Defaults to the instance overrides. */
+    config?: Record<string, unknown> | null;
+};
+/**
+ * Build the URL the host loads in an iframe or webview from the game instance
+ * and the token `POST /sdk/login` returned. It appends `apiUrl`,
+ * `gameInstanceId`, `playerAccessToken`, and `gameSetting`.
+ *
+ * `apiUrl` defaults to the one given to `initializeSDK`. A caller that uses
+ * `createSdkClient` instead must pass `{ apiUrl }`, because that client is not
+ * the process-wide one.
+ */
+declare function resolveGameURL(gameInstance: GameInstance, playerAccessToken: string, options?: ResolveGameUrlOptions): string;
 
-export { APP_KEY_HEADER, APP_SECRET_HEADER, type InitOptions, SdkConfigError, SdkNotInitializedError, type components, createSdkClient, fetchClient, initializeSDK, type operations, type paths };
+export { APP_KEY_HEADER, APP_SECRET_HEADER, type GameInstance, type InitOptions, type ResolveGameUrlOptions, SdkConfigError, SdkNotInitializedError, type components, createSdkClient, fetchClient, initializeSDK, type operations, type paths, resolveGameURL };