@dreamboard-games/api-client 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +89 -0
- package/NOTICE +1 -0
- package/dist/@tanstack/react-query.gen.d.ts +1037 -0
- package/dist/@tanstack/react-query.gen.d.ts.map +1 -0
- package/dist/@tanstack/react-query.gen.js +1016 -0
- package/dist/client/client.gen.d.ts +3 -0
- package/dist/client/client.gen.d.ts.map +1 -0
- package/dist/client/client.gen.js +235 -0
- package/dist/client/index.d.ts +9 -0
- package/dist/client/index.d.ts.map +1 -0
- package/dist/client/index.js +6 -0
- package/dist/client/types.gen.d.ts +118 -0
- package/dist/client/types.gen.d.ts.map +1 -0
- package/dist/client/types.gen.js +2 -0
- package/dist/client/utils.gen.d.ts +34 -0
- package/dist/client/utils.gen.d.ts.map +1 -0
- package/dist/client/utils.gen.js +233 -0
- package/dist/client.gen.d.ts +13 -0
- package/dist/client.gen.d.ts.map +1 -0
- package/dist/client.gen.js +3 -0
- package/dist/core/auth.gen.d.ts +19 -0
- package/dist/core/auth.gen.d.ts.map +1 -0
- package/dist/core/auth.gen.js +14 -0
- package/dist/core/bodySerializer.gen.d.ts +26 -0
- package/dist/core/bodySerializer.gen.d.ts.map +1 -0
- package/dist/core/bodySerializer.gen.js +57 -0
- package/dist/core/params.gen.d.ts +44 -0
- package/dist/core/params.gen.d.ts.map +1 -0
- package/dist/core/params.gen.js +100 -0
- package/dist/core/pathSerializer.gen.d.ts +34 -0
- package/dist/core/pathSerializer.gen.d.ts.map +1 -0
- package/dist/core/pathSerializer.gen.js +114 -0
- package/dist/core/queryKeySerializer.gen.d.ts +19 -0
- package/dist/core/queryKeySerializer.gen.d.ts.map +1 -0
- package/dist/core/queryKeySerializer.gen.js +99 -0
- package/dist/core/serverSentEvents.gen.d.ts +72 -0
- package/dist/core/serverSentEvents.gen.d.ts.map +1 -0
- package/dist/core/serverSentEvents.gen.js +136 -0
- package/dist/core/types.gen.d.ts +79 -0
- package/dist/core/types.gen.d.ts.map +1 -0
- package/dist/core/types.gen.js +2 -0
- package/dist/core/utils.gen.d.ts +20 -0
- package/dist/core/utils.gen.d.ts.map +1 -0
- package/dist/core/utils.gen.js +87 -0
- package/dist/generated/problem-types.gen.d.ts +26 -0
- package/dist/generated/problem-types.gen.d.ts.map +1 -0
- package/dist/generated/problem-types.gen.js +23 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +4 -0
- package/dist/sdk.gen.d.ts +364 -0
- package/dist/sdk.gen.d.ts.map +1 -0
- package/dist/sdk.gen.js +634 -0
- package/dist/source-revisions.d.ts +27 -0
- package/dist/source-revisions.d.ts.map +1 -0
- package/dist/source-revisions.js +174 -0
- package/dist/storage-paths.d.ts +17 -0
- package/dist/storage-paths.d.ts.map +1 -0
- package/dist/storage-paths.js +16 -0
- package/dist/types.gen.d.ts +5007 -0
- package/dist/types.gen.d.ts.map +1 -0
- package/dist/types.gen.js +2 -0
- package/dist/zod.gen.d.ts +37398 -0
- package/dist/zod.gen.d.ts.map +1 -0
- package/dist/zod.gen.js +2396 -0
- package/package.json +105 -0
- package/src/@tanstack/react-query.gen.ts +1114 -0
- package/src/client/client.gen.ts +311 -0
- package/src/client/index.ts +25 -0
- package/src/client/types.gen.ts +241 -0
- package/src/client/utils.gen.ts +332 -0
- package/src/client.gen.ts +16 -0
- package/src/core/auth.gen.ts +42 -0
- package/src/core/bodySerializer.gen.ts +100 -0
- package/src/core/params.gen.ts +176 -0
- package/src/core/pathSerializer.gen.ts +181 -0
- package/src/core/queryKeySerializer.gen.ts +136 -0
- package/src/core/serverSentEvents.gen.ts +265 -0
- package/src/core/types.gen.ts +118 -0
- package/src/core/utils.gen.ts +143 -0
- package/src/generated/problem-types.gen.ts +35 -0
- package/src/index.ts +7 -0
- package/src/sdk.gen.ts +709 -0
- package/src/source-revisions.ts +283 -0
- package/src/storage-paths.ts +19 -0
- package/src/types.gen.ts +5486 -0
- package/src/zod.gen.ts +2705 -0
|
@@ -0,0 +1,1037 @@
|
|
|
1
|
+
import { type UseMutationOptions } from '@tanstack/react-query';
|
|
2
|
+
import { type Options } from '../sdk.gen.js';
|
|
3
|
+
import type { AddSeatData, AddSeatError, AddSeatResponse, AssignSeatData, AssignSeatError, AssignSeatResponse, CancelGameRunData, CancelGameRunError, CreateAuthoringStateData, CreateAuthoringStateError, CreateAuthoringStateResponse, CreateDemoGameSessionData, CreateDemoGameSessionError, CreateDemoGameSessionResponse, CreateGameData, CreateGameError, CreateGameResponse, CreateGameRuleData, CreateGameRuleError, CreateGameRuleResponse2, CreateGameRunData, CreateGameRunError, CreateGameRunResponse2, CreateSessionData, CreateSessionError, CreateSessionFromReducerSnapshotData, CreateSessionFromReducerSnapshotError, CreateSessionFromReducerSnapshotResponse, CreateSessionResponse2, CreateSourceBlobUploadSessionData, CreateSourceBlobUploadSessionError, CreateSourceBlobUploadSessionResponse, CreateSourceRevisionData, CreateSourceRevisionError, CreateSourceRevisionResponse, DeleteGameData, DeleteGameError, DeleteGameResponse2, DescribePlayerActionData, DisconnectSessionEventsData, DisconnectSessionEventsError, DownloadGameSourcesData, EnsureDevCompileData, EnsureDevCompileError, EnsureDevCompileResponse2, ExtractGameSpecData, ExtractGameSpecError, ExtractGameSpecResponse2, FetchUiBundleData, FindManifestsData, GetActiveJobData, GetApiVersionData, GetAuthoringHeadData, GetCompiledResultData, GetDemoGameData, GetDemoGameThumbnailData, GetGameBySlugData, GetGameData, GetGameRuleData, GetGameScriptsData, GetGameSourcesData, GetJobData, GetLatestCompiledResultData, GetLatestGameRuleData, GetManifestData, GetPlayerActionTargetsData, GetSessionByShortCodeData, GetSessionSnapshotData, HealthCheckData, ListCompiledResultsData, ListDemoGamesData, ListGameRulesData, ListGamesData, ListPlayerActionsData, QueryWorkshopRulebookData, QueueCompiledResultJobData, QueueCompiledResultJobError, QueueCompiledResultJobResponse2, RemoveSeatData, RemoveSeatError, RemoveSeatResponse, RestoreHistoryData, RestoreHistoryError, RestoreHistoryResponse2, SaveManifestData, SaveManifestError, SaveManifestResponse2, StartGameData, StartGameError, StartGameResponse, SubmitPlayerActionData, SubmitPlayerActionError, SubmitPlayerActionResponse, UnassignSeatData, UnassignSeatError, UnassignSeatResponse, UpdateGameData, UpdateGameError, UpdateGameResponse, UpdateSeatData, UpdateSeatError, UpdateSeatResponse, ValidatePlayerActionData, ValidatePlayerActionError, ValidatePlayerActionResponse } from '../types.gen.js';
|
|
4
|
+
export type QueryKey<TOptions extends Options> = [
|
|
5
|
+
Pick<TOptions, 'baseUrl' | 'body' | 'headers' | 'path' | 'query'> & {
|
|
6
|
+
_id: string;
|
|
7
|
+
_infinite?: boolean;
|
|
8
|
+
tags?: ReadonlyArray<string>;
|
|
9
|
+
}
|
|
10
|
+
];
|
|
11
|
+
export declare const healthCheckQueryKey: (options?: Options<HealthCheckData>) => [Pick<Options<HealthCheckData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
12
|
+
_id: string;
|
|
13
|
+
_infinite?: boolean;
|
|
14
|
+
tags?: ReadonlyArray<string>;
|
|
15
|
+
}];
|
|
16
|
+
/**
|
|
17
|
+
* Health check endpoint
|
|
18
|
+
*
|
|
19
|
+
* Returns a simple health check message
|
|
20
|
+
*/
|
|
21
|
+
export declare const healthCheckOptions: (options?: Options<HealthCheckData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<string, Error, string, [Pick<Options<HealthCheckData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
22
|
+
_id: string;
|
|
23
|
+
_infinite?: boolean;
|
|
24
|
+
tags?: ReadonlyArray<string>;
|
|
25
|
+
}]>, "queryFn"> & {
|
|
26
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<string, [Pick<Options<HealthCheckData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
27
|
+
_id: string;
|
|
28
|
+
_infinite?: boolean;
|
|
29
|
+
tags?: ReadonlyArray<string>;
|
|
30
|
+
}], never> | undefined;
|
|
31
|
+
} & {
|
|
32
|
+
queryKey: [Pick<Options<HealthCheckData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
33
|
+
_id: string;
|
|
34
|
+
_infinite?: boolean;
|
|
35
|
+
tags?: ReadonlyArray<string>;
|
|
36
|
+
}] & {
|
|
37
|
+
[dataTagSymbol]: string;
|
|
38
|
+
[dataTagErrorSymbol]: Error;
|
|
39
|
+
};
|
|
40
|
+
};
|
|
41
|
+
export declare const getApiVersionQueryKey: (options?: Options<GetApiVersionData>) => [Pick<Options<GetApiVersionData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
42
|
+
_id: string;
|
|
43
|
+
_infinite?: boolean;
|
|
44
|
+
tags?: ReadonlyArray<string>;
|
|
45
|
+
}];
|
|
46
|
+
/**
|
|
47
|
+
* Get backend version metadata
|
|
48
|
+
*
|
|
49
|
+
* Returns backend revision metadata and the UI SDK version expected by the backend runtime.
|
|
50
|
+
*/
|
|
51
|
+
export declare const getApiVersionOptions: (options?: Options<GetApiVersionData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").ApiVersionResponse, Error, import("../types.gen.js").ApiVersionResponse, [Pick<Options<GetApiVersionData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
52
|
+
_id: string;
|
|
53
|
+
_infinite?: boolean;
|
|
54
|
+
tags?: ReadonlyArray<string>;
|
|
55
|
+
}]>, "queryFn"> & {
|
|
56
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").ApiVersionResponse, [Pick<Options<GetApiVersionData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
57
|
+
_id: string;
|
|
58
|
+
_infinite?: boolean;
|
|
59
|
+
tags?: ReadonlyArray<string>;
|
|
60
|
+
}], never> | undefined;
|
|
61
|
+
} & {
|
|
62
|
+
queryKey: [Pick<Options<GetApiVersionData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
63
|
+
_id: string;
|
|
64
|
+
_infinite?: boolean;
|
|
65
|
+
tags?: ReadonlyArray<string>;
|
|
66
|
+
}] & {
|
|
67
|
+
[dataTagSymbol]: import("../types.gen.js").ApiVersionResponse;
|
|
68
|
+
[dataTagErrorSymbol]: Error;
|
|
69
|
+
};
|
|
70
|
+
};
|
|
71
|
+
export declare const listGamesQueryKey: (options?: Options<ListGamesData>) => [Pick<Options<ListGamesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
72
|
+
_id: string;
|
|
73
|
+
_infinite?: boolean;
|
|
74
|
+
tags?: ReadonlyArray<string>;
|
|
75
|
+
}];
|
|
76
|
+
/**
|
|
77
|
+
* List user's games
|
|
78
|
+
*
|
|
79
|
+
* Retrieve a list of all games owned by the authenticated user
|
|
80
|
+
*/
|
|
81
|
+
export declare const listGamesOptions: (options?: Options<ListGamesData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").Game[], import("../types.gen.js").ProblemDetails, import("../types.gen.js").Game[], [Pick<Options<ListGamesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
82
|
+
_id: string;
|
|
83
|
+
_infinite?: boolean;
|
|
84
|
+
tags?: ReadonlyArray<string>;
|
|
85
|
+
}]>, "queryFn"> & {
|
|
86
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").Game[], [Pick<Options<ListGamesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
87
|
+
_id: string;
|
|
88
|
+
_infinite?: boolean;
|
|
89
|
+
tags?: ReadonlyArray<string>;
|
|
90
|
+
}], never> | undefined;
|
|
91
|
+
} & {
|
|
92
|
+
queryKey: [Pick<Options<ListGamesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
93
|
+
_id: string;
|
|
94
|
+
_infinite?: boolean;
|
|
95
|
+
tags?: ReadonlyArray<string>;
|
|
96
|
+
}] & {
|
|
97
|
+
[dataTagSymbol]: import("../types.gen.js").Game[];
|
|
98
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
99
|
+
};
|
|
100
|
+
};
|
|
101
|
+
/**
|
|
102
|
+
* Create a new game
|
|
103
|
+
*
|
|
104
|
+
* Create a new game definition
|
|
105
|
+
*/
|
|
106
|
+
export declare const createGameMutation: (options?: Partial<Options<CreateGameData>>) => UseMutationOptions<CreateGameResponse, CreateGameError, Options<CreateGameData>>;
|
|
107
|
+
/**
|
|
108
|
+
* Extract a structured game spec
|
|
109
|
+
*
|
|
110
|
+
* Extract a normalized structured game spec from pasted rule text.
|
|
111
|
+
*/
|
|
112
|
+
export declare const extractGameSpecMutation: (options?: Partial<Options<ExtractGameSpecData>>) => UseMutationOptions<ExtractGameSpecResponse2, ExtractGameSpecError, Options<ExtractGameSpecData>>;
|
|
113
|
+
/**
|
|
114
|
+
* Delete game
|
|
115
|
+
*
|
|
116
|
+
* Delete a game definition permanently
|
|
117
|
+
*/
|
|
118
|
+
export declare const deleteGameMutation: (options?: Partial<Options<DeleteGameData>>) => UseMutationOptions<DeleteGameResponse2, DeleteGameError, Options<DeleteGameData>>;
|
|
119
|
+
export declare const getGameQueryKey: (options: Options<GetGameData>) => [Pick<Options<GetGameData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
120
|
+
_id: string;
|
|
121
|
+
_infinite?: boolean;
|
|
122
|
+
tags?: ReadonlyArray<string>;
|
|
123
|
+
}];
|
|
124
|
+
/**
|
|
125
|
+
* Get game by ID
|
|
126
|
+
*
|
|
127
|
+
* Retrieve a specific game definition by its ID
|
|
128
|
+
*/
|
|
129
|
+
export declare const getGameOptions: (options: Options<GetGameData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").Game, import("../types.gen.js").ProblemDetails, import("../types.gen.js").Game, [Pick<Options<GetGameData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
130
|
+
_id: string;
|
|
131
|
+
_infinite?: boolean;
|
|
132
|
+
tags?: ReadonlyArray<string>;
|
|
133
|
+
}]>, "queryFn"> & {
|
|
134
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").Game, [Pick<Options<GetGameData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
135
|
+
_id: string;
|
|
136
|
+
_infinite?: boolean;
|
|
137
|
+
tags?: ReadonlyArray<string>;
|
|
138
|
+
}], never> | undefined;
|
|
139
|
+
} & {
|
|
140
|
+
queryKey: [Pick<Options<GetGameData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
141
|
+
_id: string;
|
|
142
|
+
_infinite?: boolean;
|
|
143
|
+
tags?: ReadonlyArray<string>;
|
|
144
|
+
}] & {
|
|
145
|
+
[dataTagSymbol]: import("../types.gen.js").Game;
|
|
146
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
147
|
+
};
|
|
148
|
+
};
|
|
149
|
+
/**
|
|
150
|
+
* Update game
|
|
151
|
+
*
|
|
152
|
+
* Update an existing game definition
|
|
153
|
+
*/
|
|
154
|
+
export declare const updateGameMutation: (options?: Partial<Options<UpdateGameData>>) => UseMutationOptions<UpdateGameResponse, UpdateGameError, Options<UpdateGameData>>;
|
|
155
|
+
export declare const getGameBySlugQueryKey: (options: Options<GetGameBySlugData>) => [Pick<Options<GetGameBySlugData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
156
|
+
_id: string;
|
|
157
|
+
_infinite?: boolean;
|
|
158
|
+
tags?: ReadonlyArray<string>;
|
|
159
|
+
}];
|
|
160
|
+
/**
|
|
161
|
+
* Get game by slug
|
|
162
|
+
*
|
|
163
|
+
* Retrieve a specific game definition by its slug
|
|
164
|
+
*/
|
|
165
|
+
export declare const getGameBySlugOptions: (options: Options<GetGameBySlugData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").Game, import("../types.gen.js").ProblemDetails, import("../types.gen.js").Game, [Pick<Options<GetGameBySlugData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
166
|
+
_id: string;
|
|
167
|
+
_infinite?: boolean;
|
|
168
|
+
tags?: ReadonlyArray<string>;
|
|
169
|
+
}]>, "queryFn"> & {
|
|
170
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").Game, [Pick<Options<GetGameBySlugData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
171
|
+
_id: string;
|
|
172
|
+
_infinite?: boolean;
|
|
173
|
+
tags?: ReadonlyArray<string>;
|
|
174
|
+
}], never> | undefined;
|
|
175
|
+
} & {
|
|
176
|
+
queryKey: [Pick<Options<GetGameBySlugData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
177
|
+
_id: string;
|
|
178
|
+
_infinite?: boolean;
|
|
179
|
+
tags?: ReadonlyArray<string>;
|
|
180
|
+
}] & {
|
|
181
|
+
[dataTagSymbol]: import("../types.gen.js").Game;
|
|
182
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
183
|
+
};
|
|
184
|
+
};
|
|
185
|
+
export declare const queryWorkshopRulebookQueryKey: (options: Options<QueryWorkshopRulebookData>) => [Pick<Options<QueryWorkshopRulebookData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
186
|
+
_id: string;
|
|
187
|
+
_infinite?: boolean;
|
|
188
|
+
tags?: ReadonlyArray<string>;
|
|
189
|
+
}];
|
|
190
|
+
/**
|
|
191
|
+
* Query rulebook text by title
|
|
192
|
+
*
|
|
193
|
+
* Search ranked rulebook candidates for the provided title, try up to the top 3 matches, and return extracted text from the first valid PDF found.
|
|
194
|
+
*/
|
|
195
|
+
export declare const queryWorkshopRulebookOptions: (options: Options<QueryWorkshopRulebookData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").WorkshopRuleTextResponse, import("../types.gen.js").ProblemDetails, import("../types.gen.js").WorkshopRuleTextResponse, [Pick<Options<QueryWorkshopRulebookData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
196
|
+
_id: string;
|
|
197
|
+
_infinite?: boolean;
|
|
198
|
+
tags?: ReadonlyArray<string>;
|
|
199
|
+
}]>, "queryFn"> & {
|
|
200
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").WorkshopRuleTextResponse, [Pick<Options<QueryWorkshopRulebookData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
201
|
+
_id: string;
|
|
202
|
+
_infinite?: boolean;
|
|
203
|
+
tags?: ReadonlyArray<string>;
|
|
204
|
+
}], never> | undefined;
|
|
205
|
+
} & {
|
|
206
|
+
queryKey: [Pick<Options<QueryWorkshopRulebookData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
207
|
+
_id: string;
|
|
208
|
+
_infinite?: boolean;
|
|
209
|
+
tags?: ReadonlyArray<string>;
|
|
210
|
+
}] & {
|
|
211
|
+
[dataTagSymbol]: import("../types.gen.js").WorkshopRuleTextResponse;
|
|
212
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
213
|
+
};
|
|
214
|
+
};
|
|
215
|
+
export declare const findManifestsQueryKey: (options: Options<FindManifestsData>) => [Pick<Options<FindManifestsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
216
|
+
_id: string;
|
|
217
|
+
_infinite?: boolean;
|
|
218
|
+
tags?: ReadonlyArray<string>;
|
|
219
|
+
}];
|
|
220
|
+
/**
|
|
221
|
+
* Find manifests for game
|
|
222
|
+
*
|
|
223
|
+
* Retrieve a list of manifest versions for a game, ordered by version descending (newest first)
|
|
224
|
+
*/
|
|
225
|
+
export declare const findManifestsOptions: (options: Options<FindManifestsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").FindManifestsResponse, import("../types.gen.js").ProblemDetails, import("../types.gen.js").FindManifestsResponse, [Pick<Options<FindManifestsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
226
|
+
_id: string;
|
|
227
|
+
_infinite?: boolean;
|
|
228
|
+
tags?: ReadonlyArray<string>;
|
|
229
|
+
}]>, "queryFn"> & {
|
|
230
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").FindManifestsResponse, [Pick<Options<FindManifestsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
231
|
+
_id: string;
|
|
232
|
+
_infinite?: boolean;
|
|
233
|
+
tags?: ReadonlyArray<string>;
|
|
234
|
+
}], never> | undefined;
|
|
235
|
+
} & {
|
|
236
|
+
queryKey: [Pick<Options<FindManifestsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
237
|
+
_id: string;
|
|
238
|
+
_infinite?: boolean;
|
|
239
|
+
tags?: ReadonlyArray<string>;
|
|
240
|
+
}] & {
|
|
241
|
+
[dataTagSymbol]: import("../types.gen.js").FindManifestsResponse;
|
|
242
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
243
|
+
};
|
|
244
|
+
};
|
|
245
|
+
/**
|
|
246
|
+
* Save game manifest
|
|
247
|
+
*
|
|
248
|
+
* Create a new versioned manifest for a game. Each save creates a new version with automatic version numbering.
|
|
249
|
+
*/
|
|
250
|
+
export declare const saveManifestMutation: (options?: Partial<Options<SaveManifestData>>) => UseMutationOptions<SaveManifestResponse2, SaveManifestError, Options<SaveManifestData>>;
|
|
251
|
+
export declare const getManifestQueryKey: (options: Options<GetManifestData>) => [Pick<Options<GetManifestData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
252
|
+
_id: string;
|
|
253
|
+
_infinite?: boolean;
|
|
254
|
+
tags?: ReadonlyArray<string>;
|
|
255
|
+
}];
|
|
256
|
+
/**
|
|
257
|
+
* Get manifest by ID
|
|
258
|
+
*
|
|
259
|
+
* Retrieve a specific manifest version by its ID with full board manifest details
|
|
260
|
+
*/
|
|
261
|
+
export declare const getManifestOptions: (options: Options<GetManifestData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").GameManifestDto, import("../types.gen.js").ProblemDetails, import("../types.gen.js").GameManifestDto, [Pick<Options<GetManifestData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
262
|
+
_id: string;
|
|
263
|
+
_infinite?: boolean;
|
|
264
|
+
tags?: ReadonlyArray<string>;
|
|
265
|
+
}]>, "queryFn"> & {
|
|
266
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").GameManifestDto, [Pick<Options<GetManifestData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
267
|
+
_id: string;
|
|
268
|
+
_infinite?: boolean;
|
|
269
|
+
tags?: ReadonlyArray<string>;
|
|
270
|
+
}], never> | undefined;
|
|
271
|
+
} & {
|
|
272
|
+
queryKey: [Pick<Options<GetManifestData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
273
|
+
_id: string;
|
|
274
|
+
_infinite?: boolean;
|
|
275
|
+
tags?: ReadonlyArray<string>;
|
|
276
|
+
}] & {
|
|
277
|
+
[dataTagSymbol]: import("../types.gen.js").GameManifestDto;
|
|
278
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
279
|
+
};
|
|
280
|
+
};
|
|
281
|
+
export declare const getLatestCompiledResultQueryKey: (options: Options<GetLatestCompiledResultData>) => [Pick<Options<GetLatestCompiledResultData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
282
|
+
_id: string;
|
|
283
|
+
_infinite?: boolean;
|
|
284
|
+
tags?: ReadonlyArray<string>;
|
|
285
|
+
}];
|
|
286
|
+
/**
|
|
287
|
+
* Get latest compiled result for a game
|
|
288
|
+
*
|
|
289
|
+
* Return the most recent compiled result for the specified game.
|
|
290
|
+
*/
|
|
291
|
+
export declare const getLatestCompiledResultOptions: (options: Options<GetLatestCompiledResultData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").CompiledResult, import("../types.gen.js").ProblemDetails, import("../types.gen.js").CompiledResult, [Pick<Options<GetLatestCompiledResultData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
292
|
+
_id: string;
|
|
293
|
+
_infinite?: boolean;
|
|
294
|
+
tags?: ReadonlyArray<string>;
|
|
295
|
+
}]>, "queryFn"> & {
|
|
296
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").CompiledResult, [Pick<Options<GetLatestCompiledResultData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
297
|
+
_id: string;
|
|
298
|
+
_infinite?: boolean;
|
|
299
|
+
tags?: ReadonlyArray<string>;
|
|
300
|
+
}], never> | undefined;
|
|
301
|
+
} & {
|
|
302
|
+
queryKey: [Pick<Options<GetLatestCompiledResultData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
303
|
+
_id: string;
|
|
304
|
+
_infinite?: boolean;
|
|
305
|
+
tags?: ReadonlyArray<string>;
|
|
306
|
+
}] & {
|
|
307
|
+
[dataTagSymbol]: import("../types.gen.js").CompiledResult;
|
|
308
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
309
|
+
};
|
|
310
|
+
};
|
|
311
|
+
export declare const listCompiledResultsQueryKey: (options: Options<ListCompiledResultsData>) => [Pick<Options<ListCompiledResultsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
312
|
+
_id: string;
|
|
313
|
+
_infinite?: boolean;
|
|
314
|
+
tags?: ReadonlyArray<string>;
|
|
315
|
+
}];
|
|
316
|
+
/**
|
|
317
|
+
* List compiled results for a game
|
|
318
|
+
*
|
|
319
|
+
* Retrieve a list of compiled results for a game, ordered by creation date descending (newest first). Includes both successful and failed compilations.
|
|
320
|
+
*/
|
|
321
|
+
export declare const listCompiledResultsOptions: (options: Options<ListCompiledResultsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").ListCompiledResultsResponse, import("../types.gen.js").ProblemDetails, import("../types.gen.js").ListCompiledResultsResponse, [Pick<Options<ListCompiledResultsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
322
|
+
_id: string;
|
|
323
|
+
_infinite?: boolean;
|
|
324
|
+
tags?: ReadonlyArray<string>;
|
|
325
|
+
}]>, "queryFn"> & {
|
|
326
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").ListCompiledResultsResponse, [Pick<Options<ListCompiledResultsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
327
|
+
_id: string;
|
|
328
|
+
_infinite?: boolean;
|
|
329
|
+
tags?: ReadonlyArray<string>;
|
|
330
|
+
}], never> | undefined;
|
|
331
|
+
} & {
|
|
332
|
+
queryKey: [Pick<Options<ListCompiledResultsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
333
|
+
_id: string;
|
|
334
|
+
_infinite?: boolean;
|
|
335
|
+
tags?: ReadonlyArray<string>;
|
|
336
|
+
}] & {
|
|
337
|
+
[dataTagSymbol]: import("../types.gen.js").ListCompiledResultsResponse;
|
|
338
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
339
|
+
};
|
|
340
|
+
};
|
|
341
|
+
/**
|
|
342
|
+
* Queue a compile job for an authoring state
|
|
343
|
+
*
|
|
344
|
+
* Queue an asynchronous compile for a specific authoring state. Poll `/api/jobs/{jobId}` and fetch the final compiled result by ID when the job completes.
|
|
345
|
+
*/
|
|
346
|
+
export declare const queueCompiledResultJobMutation: (options?: Partial<Options<QueueCompiledResultJobData>>) => UseMutationOptions<QueueCompiledResultJobResponse2, QueueCompiledResultJobError, Options<QueueCompiledResultJobData>>;
|
|
347
|
+
/**
|
|
348
|
+
* Ensure a private dev compile exists
|
|
349
|
+
*
|
|
350
|
+
* Reuse or create a session-scoped dev compilation for the provided workspace fingerprint without advancing the canonical authored head.
|
|
351
|
+
*/
|
|
352
|
+
export declare const ensureDevCompileMutation: (options?: Partial<Options<EnsureDevCompileData>>) => UseMutationOptions<EnsureDevCompileResponse2, EnsureDevCompileError, Options<EnsureDevCompileData>>;
|
|
353
|
+
export declare const getCompiledResultQueryKey: (options: Options<GetCompiledResultData>) => [Pick<Options<GetCompiledResultData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
354
|
+
_id: string;
|
|
355
|
+
_infinite?: boolean;
|
|
356
|
+
tags?: ReadonlyArray<string>;
|
|
357
|
+
}];
|
|
358
|
+
/**
|
|
359
|
+
* Get compiled result by ID
|
|
360
|
+
*
|
|
361
|
+
* Fetch a specific compiled result for a game, including failed results and diagnostics.
|
|
362
|
+
*/
|
|
363
|
+
export declare const getCompiledResultOptions: (options: Options<GetCompiledResultData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").CompiledResult, import("../types.gen.js").ProblemDetails, import("../types.gen.js").CompiledResult, [Pick<Options<GetCompiledResultData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
364
|
+
_id: string;
|
|
365
|
+
_infinite?: boolean;
|
|
366
|
+
tags?: ReadonlyArray<string>;
|
|
367
|
+
}]>, "queryFn"> & {
|
|
368
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").CompiledResult, [Pick<Options<GetCompiledResultData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
369
|
+
_id: string;
|
|
370
|
+
_infinite?: boolean;
|
|
371
|
+
tags?: ReadonlyArray<string>;
|
|
372
|
+
}], never> | undefined;
|
|
373
|
+
} & {
|
|
374
|
+
queryKey: [Pick<Options<GetCompiledResultData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
375
|
+
_id: string;
|
|
376
|
+
_infinite?: boolean;
|
|
377
|
+
tags?: ReadonlyArray<string>;
|
|
378
|
+
}] & {
|
|
379
|
+
[dataTagSymbol]: import("../types.gen.js").CompiledResult;
|
|
380
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
381
|
+
};
|
|
382
|
+
};
|
|
383
|
+
export declare const downloadGameSourcesQueryKey: (options: Options<DownloadGameSourcesData>) => [Pick<Options<DownloadGameSourcesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
384
|
+
_id: string;
|
|
385
|
+
_infinite?: boolean;
|
|
386
|
+
tags?: ReadonlyArray<string>;
|
|
387
|
+
}];
|
|
388
|
+
/**
|
|
389
|
+
* Download authored game source files
|
|
390
|
+
*
|
|
391
|
+
* Download the authored source files for the current authoring head as a ZIP archive.
|
|
392
|
+
*/
|
|
393
|
+
export declare const downloadGameSourcesOptions: (options: Options<DownloadGameSourcesData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<Blob | File, import("../types.gen.js").ProblemDetails, Blob | File, [Pick<Options<DownloadGameSourcesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
394
|
+
_id: string;
|
|
395
|
+
_infinite?: boolean;
|
|
396
|
+
tags?: ReadonlyArray<string>;
|
|
397
|
+
}]>, "queryFn"> & {
|
|
398
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<Blob | File, [Pick<Options<DownloadGameSourcesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
399
|
+
_id: string;
|
|
400
|
+
_infinite?: boolean;
|
|
401
|
+
tags?: ReadonlyArray<string>;
|
|
402
|
+
}], never> | undefined;
|
|
403
|
+
} & {
|
|
404
|
+
queryKey: [Pick<Options<DownloadGameSourcesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
405
|
+
_id: string;
|
|
406
|
+
_infinite?: boolean;
|
|
407
|
+
tags?: ReadonlyArray<string>;
|
|
408
|
+
}] & {
|
|
409
|
+
[dataTagSymbol]: Blob | File;
|
|
410
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
411
|
+
};
|
|
412
|
+
};
|
|
413
|
+
export declare const getGameSourcesQueryKey: (options: Options<GetGameSourcesData>) => [Pick<Options<GetGameSourcesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
414
|
+
_id: string;
|
|
415
|
+
_infinite?: boolean;
|
|
416
|
+
tags?: ReadonlyArray<string>;
|
|
417
|
+
}];
|
|
418
|
+
/**
|
|
419
|
+
* Get authored game source files
|
|
420
|
+
*
|
|
421
|
+
* Retrieve authored source files as JSON for the selected authoring state. If no authoring state is provided, the current authoring head is used.
|
|
422
|
+
*/
|
|
423
|
+
export declare const getGameSourcesOptions: (options: Options<GetGameSourcesData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").GameSourcesResponse, import("../types.gen.js").ProblemDetails, import("../types.gen.js").GameSourcesResponse, [Pick<Options<GetGameSourcesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
424
|
+
_id: string;
|
|
425
|
+
_infinite?: boolean;
|
|
426
|
+
tags?: ReadonlyArray<string>;
|
|
427
|
+
}]>, "queryFn"> & {
|
|
428
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").GameSourcesResponse, [Pick<Options<GetGameSourcesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
429
|
+
_id: string;
|
|
430
|
+
_infinite?: boolean;
|
|
431
|
+
tags?: ReadonlyArray<string>;
|
|
432
|
+
}], never> | undefined;
|
|
433
|
+
} & {
|
|
434
|
+
queryKey: [Pick<Options<GetGameSourcesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
435
|
+
_id: string;
|
|
436
|
+
_infinite?: boolean;
|
|
437
|
+
tags?: ReadonlyArray<string>;
|
|
438
|
+
}] & {
|
|
439
|
+
[dataTagSymbol]: import("../types.gen.js").GameSourcesResponse;
|
|
440
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
441
|
+
};
|
|
442
|
+
};
|
|
443
|
+
/**
|
|
444
|
+
* Create a source revision for a game
|
|
445
|
+
*
|
|
446
|
+
* Create a new authored source revision from a hash-addressed change set. The request must be based on the current head revision for the game.
|
|
447
|
+
*/
|
|
448
|
+
export declare const createSourceRevisionMutation: (options?: Partial<Options<CreateSourceRevisionData>>) => UseMutationOptions<CreateSourceRevisionResponse, CreateSourceRevisionError, Options<CreateSourceRevisionData>>;
|
|
449
|
+
/**
|
|
450
|
+
* Create direct-upload targets for source blobs
|
|
451
|
+
*
|
|
452
|
+
* Create a direct-upload session for one or more source blobs referenced by a forthcoming source revision.
|
|
453
|
+
*/
|
|
454
|
+
export declare const createSourceBlobUploadSessionMutation: (options?: Partial<Options<CreateSourceBlobUploadSessionData>>) => UseMutationOptions<CreateSourceBlobUploadSessionResponse, CreateSourceBlobUploadSessionError, Options<CreateSourceBlobUploadSessionData>>;
|
|
455
|
+
export declare const getAuthoringHeadQueryKey: (options: Options<GetAuthoringHeadData>) => [Pick<Options<GetAuthoringHeadData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
456
|
+
_id: string;
|
|
457
|
+
_infinite?: boolean;
|
|
458
|
+
tags?: ReadonlyArray<string>;
|
|
459
|
+
}];
|
|
460
|
+
/**
|
|
461
|
+
* Get current authoring head for a game
|
|
462
|
+
*
|
|
463
|
+
* Retrieve the current remote authoring head for the specified game.
|
|
464
|
+
*/
|
|
465
|
+
export declare const getAuthoringHeadOptions: (options: Options<GetAuthoringHeadData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").AuthoringState, import("../types.gen.js").ProblemDetails, import("../types.gen.js").AuthoringState, [Pick<Options<GetAuthoringHeadData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
466
|
+
_id: string;
|
|
467
|
+
_infinite?: boolean;
|
|
468
|
+
tags?: ReadonlyArray<string>;
|
|
469
|
+
}]>, "queryFn"> & {
|
|
470
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").AuthoringState, [Pick<Options<GetAuthoringHeadData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
471
|
+
_id: string;
|
|
472
|
+
_infinite?: boolean;
|
|
473
|
+
tags?: ReadonlyArray<string>;
|
|
474
|
+
}], never> | undefined;
|
|
475
|
+
} & {
|
|
476
|
+
queryKey: [Pick<Options<GetAuthoringHeadData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
477
|
+
_id: string;
|
|
478
|
+
_infinite?: boolean;
|
|
479
|
+
tags?: ReadonlyArray<string>;
|
|
480
|
+
}] & {
|
|
481
|
+
[dataTagSymbol]: import("../types.gen.js").AuthoringState;
|
|
482
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
483
|
+
};
|
|
484
|
+
};
|
|
485
|
+
/**
|
|
486
|
+
* Advance the authoring head for a game
|
|
487
|
+
*
|
|
488
|
+
* Create a new immutable authoring state and make it the current authoring head for the specified game.
|
|
489
|
+
*/
|
|
490
|
+
export declare const createAuthoringStateMutation: (options?: Partial<Options<CreateAuthoringStateData>>) => UseMutationOptions<CreateAuthoringStateResponse, CreateAuthoringStateError, Options<CreateAuthoringStateData>>;
|
|
491
|
+
export declare const getGameScriptsQueryKey: (options: Options<GetGameScriptsData>) => [Pick<Options<GetGameScriptsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
492
|
+
_id: string;
|
|
493
|
+
_infinite?: boolean;
|
|
494
|
+
tags?: ReadonlyArray<string>;
|
|
495
|
+
}];
|
|
496
|
+
/**
|
|
497
|
+
* Get game scripts
|
|
498
|
+
*
|
|
499
|
+
* Retrieve all compiled app and UI scripts for a specific manifest
|
|
500
|
+
*/
|
|
501
|
+
export declare const getGameScriptsOptions: (options: Options<GetGameScriptsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").GameScriptsResponse, import("../types.gen.js").ProblemDetails, import("../types.gen.js").GameScriptsResponse, [Pick<Options<GetGameScriptsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
502
|
+
_id: string;
|
|
503
|
+
_infinite?: boolean;
|
|
504
|
+
tags?: ReadonlyArray<string>;
|
|
505
|
+
}]>, "queryFn"> & {
|
|
506
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").GameScriptsResponse, [Pick<Options<GetGameScriptsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
507
|
+
_id: string;
|
|
508
|
+
_infinite?: boolean;
|
|
509
|
+
tags?: ReadonlyArray<string>;
|
|
510
|
+
}], never> | undefined;
|
|
511
|
+
} & {
|
|
512
|
+
queryKey: [Pick<Options<GetGameScriptsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
513
|
+
_id: string;
|
|
514
|
+
_infinite?: boolean;
|
|
515
|
+
tags?: ReadonlyArray<string>;
|
|
516
|
+
}] & {
|
|
517
|
+
[dataTagSymbol]: import("../types.gen.js").GameScriptsResponse;
|
|
518
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
519
|
+
};
|
|
520
|
+
};
|
|
521
|
+
export declare const getActiveJobQueryKey: (options: Options<GetActiveJobData>) => [Pick<Options<GetActiveJobData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
522
|
+
_id: string;
|
|
523
|
+
_infinite?: boolean;
|
|
524
|
+
tags?: ReadonlyArray<string>;
|
|
525
|
+
}];
|
|
526
|
+
/**
|
|
527
|
+
* Get active job for a game
|
|
528
|
+
*
|
|
529
|
+
* Returns the currently active (PENDING or RUNNING) job for a game, if any. Jobs older than 15 minutes are considered stale and ignored.
|
|
530
|
+
*/
|
|
531
|
+
export declare const getActiveJobOptions: (options: Options<GetActiveJobData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").ActiveJobResponse, import("../types.gen.js").ProblemDetails, import("../types.gen.js").ActiveJobResponse, [Pick<Options<GetActiveJobData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
532
|
+
_id: string;
|
|
533
|
+
_infinite?: boolean;
|
|
534
|
+
tags?: ReadonlyArray<string>;
|
|
535
|
+
}]>, "queryFn"> & {
|
|
536
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").ActiveJobResponse, [Pick<Options<GetActiveJobData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
537
|
+
_id: string;
|
|
538
|
+
_infinite?: boolean;
|
|
539
|
+
tags?: ReadonlyArray<string>;
|
|
540
|
+
}], never> | undefined;
|
|
541
|
+
} & {
|
|
542
|
+
queryKey: [Pick<Options<GetActiveJobData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
543
|
+
_id: string;
|
|
544
|
+
_infinite?: boolean;
|
|
545
|
+
tags?: ReadonlyArray<string>;
|
|
546
|
+
}] & {
|
|
547
|
+
[dataTagSymbol]: import("../types.gen.js").ActiveJobResponse;
|
|
548
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
549
|
+
};
|
|
550
|
+
};
|
|
551
|
+
export declare const getJobQueryKey: (options: Options<GetJobData>) => [Pick<Options<GetJobData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
552
|
+
_id: string;
|
|
553
|
+
_infinite?: boolean;
|
|
554
|
+
tags?: ReadonlyArray<string>;
|
|
555
|
+
}];
|
|
556
|
+
/**
|
|
557
|
+
* Get job details
|
|
558
|
+
*
|
|
559
|
+
* Fetch details for a specific async job, including ordered user-facing tasks.
|
|
560
|
+
*/
|
|
561
|
+
export declare const getJobOptions: (options: Options<GetJobData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").JobDetailResponse, import("../types.gen.js").ProblemDetails, import("../types.gen.js").JobDetailResponse, [Pick<Options<GetJobData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
562
|
+
_id: string;
|
|
563
|
+
_infinite?: boolean;
|
|
564
|
+
tags?: ReadonlyArray<string>;
|
|
565
|
+
}]>, "queryFn"> & {
|
|
566
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").JobDetailResponse, [Pick<Options<GetJobData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
567
|
+
_id: string;
|
|
568
|
+
_infinite?: boolean;
|
|
569
|
+
tags?: ReadonlyArray<string>;
|
|
570
|
+
}], never> | undefined;
|
|
571
|
+
} & {
|
|
572
|
+
queryKey: [Pick<Options<GetJobData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
573
|
+
_id: string;
|
|
574
|
+
_infinite?: boolean;
|
|
575
|
+
tags?: ReadonlyArray<string>;
|
|
576
|
+
}] & {
|
|
577
|
+
[dataTagSymbol]: import("../types.gen.js").JobDetailResponse;
|
|
578
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
579
|
+
};
|
|
580
|
+
};
|
|
581
|
+
/**
|
|
582
|
+
* Create a game build run
|
|
583
|
+
*
|
|
584
|
+
* Create a new game draft build job from a structured game spec.
|
|
585
|
+
*/
|
|
586
|
+
export declare const createGameRunMutation: (options?: Partial<Options<CreateGameRunData>>) => UseMutationOptions<CreateGameRunResponse2, CreateGameRunError, Options<CreateGameRunData>>;
|
|
587
|
+
/**
|
|
588
|
+
* Cancel a game build run
|
|
589
|
+
*
|
|
590
|
+
* Request cancellation of an active game draft build job.
|
|
591
|
+
*/
|
|
592
|
+
export declare const cancelGameRunMutation: (options?: Partial<Options<CancelGameRunData>>) => UseMutationOptions<unknown, CancelGameRunError, Options<CancelGameRunData>>;
|
|
593
|
+
export declare const listGameRulesQueryKey: (options: Options<ListGameRulesData>) => [Pick<Options<ListGameRulesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
594
|
+
_id: string;
|
|
595
|
+
_infinite?: boolean;
|
|
596
|
+
tags?: ReadonlyArray<string>;
|
|
597
|
+
}];
|
|
598
|
+
/**
|
|
599
|
+
* List game rules for a game
|
|
600
|
+
*
|
|
601
|
+
* Retrieve a list of rule versions for a game, ordered by version descending (newest first)
|
|
602
|
+
*/
|
|
603
|
+
export declare const listGameRulesOptions: (options: Options<ListGameRulesData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").ListGameRulesResponse, import("../types.gen.js").ProblemDetails, import("../types.gen.js").ListGameRulesResponse, [Pick<Options<ListGameRulesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
604
|
+
_id: string;
|
|
605
|
+
_infinite?: boolean;
|
|
606
|
+
tags?: ReadonlyArray<string>;
|
|
607
|
+
}]>, "queryFn"> & {
|
|
608
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").ListGameRulesResponse, [Pick<Options<ListGameRulesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
609
|
+
_id: string;
|
|
610
|
+
_infinite?: boolean;
|
|
611
|
+
tags?: ReadonlyArray<string>;
|
|
612
|
+
}], never> | undefined;
|
|
613
|
+
} & {
|
|
614
|
+
queryKey: [Pick<Options<ListGameRulesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
615
|
+
_id: string;
|
|
616
|
+
_infinite?: boolean;
|
|
617
|
+
tags?: ReadonlyArray<string>;
|
|
618
|
+
}] & {
|
|
619
|
+
[dataTagSymbol]: import("../types.gen.js").ListGameRulesResponse;
|
|
620
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
621
|
+
};
|
|
622
|
+
};
|
|
623
|
+
/**
|
|
624
|
+
* Create a new game rule
|
|
625
|
+
*
|
|
626
|
+
* Create a new versioned rule for a game. Each save creates a new version with automatic version numbering.
|
|
627
|
+
*/
|
|
628
|
+
export declare const createGameRuleMutation: (options?: Partial<Options<CreateGameRuleData>>) => UseMutationOptions<CreateGameRuleResponse2, CreateGameRuleError, Options<CreateGameRuleData>>;
|
|
629
|
+
export declare const getLatestGameRuleQueryKey: (options: Options<GetLatestGameRuleData>) => [Pick<Options<GetLatestGameRuleData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
630
|
+
_id: string;
|
|
631
|
+
_infinite?: boolean;
|
|
632
|
+
tags?: ReadonlyArray<string>;
|
|
633
|
+
}];
|
|
634
|
+
/**
|
|
635
|
+
* Get the latest game rule
|
|
636
|
+
*
|
|
637
|
+
* Retrieve the most recent rule version for a game with full details including the complete rule text
|
|
638
|
+
*/
|
|
639
|
+
export declare const getLatestGameRuleOptions: (options: Options<GetLatestGameRuleData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").GameRule, import("../types.gen.js").ProblemDetails, import("../types.gen.js").GameRule, [Pick<Options<GetLatestGameRuleData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
640
|
+
_id: string;
|
|
641
|
+
_infinite?: boolean;
|
|
642
|
+
tags?: ReadonlyArray<string>;
|
|
643
|
+
}]>, "queryFn"> & {
|
|
644
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").GameRule, [Pick<Options<GetLatestGameRuleData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
645
|
+
_id: string;
|
|
646
|
+
_infinite?: boolean;
|
|
647
|
+
tags?: ReadonlyArray<string>;
|
|
648
|
+
}], never> | undefined;
|
|
649
|
+
} & {
|
|
650
|
+
queryKey: [Pick<Options<GetLatestGameRuleData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
651
|
+
_id: string;
|
|
652
|
+
_infinite?: boolean;
|
|
653
|
+
tags?: ReadonlyArray<string>;
|
|
654
|
+
}] & {
|
|
655
|
+
[dataTagSymbol]: import("../types.gen.js").GameRule;
|
|
656
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
657
|
+
};
|
|
658
|
+
};
|
|
659
|
+
export declare const getGameRuleQueryKey: (options: Options<GetGameRuleData>) => [Pick<Options<GetGameRuleData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
660
|
+
_id: string;
|
|
661
|
+
_infinite?: boolean;
|
|
662
|
+
tags?: ReadonlyArray<string>;
|
|
663
|
+
}];
|
|
664
|
+
/**
|
|
665
|
+
* Get game rule by ID
|
|
666
|
+
*
|
|
667
|
+
* Retrieve a specific game rule version by its ID with full details
|
|
668
|
+
*/
|
|
669
|
+
export declare const getGameRuleOptions: (options: Options<GetGameRuleData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").GameRule, import("../types.gen.js").ProblemDetails, import("../types.gen.js").GameRule, [Pick<Options<GetGameRuleData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
670
|
+
_id: string;
|
|
671
|
+
_infinite?: boolean;
|
|
672
|
+
tags?: ReadonlyArray<string>;
|
|
673
|
+
}]>, "queryFn"> & {
|
|
674
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").GameRule, [Pick<Options<GetGameRuleData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
675
|
+
_id: string;
|
|
676
|
+
_infinite?: boolean;
|
|
677
|
+
tags?: ReadonlyArray<string>;
|
|
678
|
+
}], never> | undefined;
|
|
679
|
+
} & {
|
|
680
|
+
queryKey: [Pick<Options<GetGameRuleData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
681
|
+
_id: string;
|
|
682
|
+
_infinite?: boolean;
|
|
683
|
+
tags?: ReadonlyArray<string>;
|
|
684
|
+
}] & {
|
|
685
|
+
[dataTagSymbol]: import("../types.gen.js").GameRule;
|
|
686
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
687
|
+
};
|
|
688
|
+
};
|
|
689
|
+
/**
|
|
690
|
+
* Create a new game session
|
|
691
|
+
*
|
|
692
|
+
* Create a new game session in lobby phase with initial seat configuration
|
|
693
|
+
*/
|
|
694
|
+
export declare const createSessionMutation: (options?: Partial<Options<CreateSessionData>>) => UseMutationOptions<CreateSessionResponse2, CreateSessionError, Options<CreateSessionData>>;
|
|
695
|
+
/**
|
|
696
|
+
* Create a session from a reducer snapshot
|
|
697
|
+
*
|
|
698
|
+
* Create an auto-assigned gameplay session from a reducer-native snapshot produced by the CLI scenario harness.
|
|
699
|
+
*/
|
|
700
|
+
export declare const createSessionFromReducerSnapshotMutation: (options?: Partial<Options<CreateSessionFromReducerSnapshotData>>) => UseMutationOptions<CreateSessionFromReducerSnapshotResponse, CreateSessionFromReducerSnapshotError, Options<CreateSessionFromReducerSnapshotData>>;
|
|
701
|
+
export declare const getSessionByShortCodeQueryKey: (options: Options<GetSessionByShortCodeData>) => [Pick<Options<GetSessionByShortCodeData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
702
|
+
_id: string;
|
|
703
|
+
_infinite?: boolean;
|
|
704
|
+
tags?: ReadonlyArray<string>;
|
|
705
|
+
}];
|
|
706
|
+
/**
|
|
707
|
+
* Get session by short code
|
|
708
|
+
*
|
|
709
|
+
* Look up and hydrate a session using its memorable short code.
|
|
710
|
+
*/
|
|
711
|
+
export declare const getSessionByShortCodeOptions: (options: Options<GetSessionByShortCodeData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").HostSessionSnapshot, import("../types.gen.js").ProblemDetails, import("../types.gen.js").HostSessionSnapshot, [Pick<Options<GetSessionByShortCodeData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
712
|
+
_id: string;
|
|
713
|
+
_infinite?: boolean;
|
|
714
|
+
tags?: ReadonlyArray<string>;
|
|
715
|
+
}]>, "queryFn"> & {
|
|
716
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").HostSessionSnapshot, [Pick<Options<GetSessionByShortCodeData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
717
|
+
_id: string;
|
|
718
|
+
_infinite?: boolean;
|
|
719
|
+
tags?: ReadonlyArray<string>;
|
|
720
|
+
}], never> | undefined;
|
|
721
|
+
} & {
|
|
722
|
+
queryKey: [Pick<Options<GetSessionByShortCodeData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
723
|
+
_id: string;
|
|
724
|
+
_infinite?: boolean;
|
|
725
|
+
tags?: ReadonlyArray<string>;
|
|
726
|
+
}] & {
|
|
727
|
+
[dataTagSymbol]: import("../types.gen.js").HostSessionSnapshot;
|
|
728
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
729
|
+
};
|
|
730
|
+
};
|
|
731
|
+
export declare const getSessionSnapshotQueryKey: (options: Options<GetSessionSnapshotData>) => [Pick<Options<GetSessionSnapshotData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
732
|
+
_id: string;
|
|
733
|
+
_infinite?: boolean;
|
|
734
|
+
tags?: ReadonlyArray<string>;
|
|
735
|
+
}];
|
|
736
|
+
/**
|
|
737
|
+
* Get a session snapshot
|
|
738
|
+
*
|
|
739
|
+
* Return the canonical selected-perspective session snapshot for first render or explicit resync.
|
|
740
|
+
*/
|
|
741
|
+
export declare const getSessionSnapshotOptions: (options: Options<GetSessionSnapshotData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").HostSessionSnapshot, import("../types.gen.js").ProblemDetails, import("../types.gen.js").HostSessionSnapshot, [Pick<Options<GetSessionSnapshotData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
742
|
+
_id: string;
|
|
743
|
+
_infinite?: boolean;
|
|
744
|
+
tags?: ReadonlyArray<string>;
|
|
745
|
+
}]>, "queryFn"> & {
|
|
746
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").HostSessionSnapshot, [Pick<Options<GetSessionSnapshotData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
747
|
+
_id: string;
|
|
748
|
+
_infinite?: boolean;
|
|
749
|
+
tags?: ReadonlyArray<string>;
|
|
750
|
+
}], never> | undefined;
|
|
751
|
+
} & {
|
|
752
|
+
queryKey: [Pick<Options<GetSessionSnapshotData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
753
|
+
_id: string;
|
|
754
|
+
_infinite?: boolean;
|
|
755
|
+
tags?: ReadonlyArray<string>;
|
|
756
|
+
}] & {
|
|
757
|
+
[dataTagSymbol]: import("../types.gen.js").HostSessionSnapshot;
|
|
758
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
759
|
+
};
|
|
760
|
+
};
|
|
761
|
+
/**
|
|
762
|
+
* Release a session events stream slot
|
|
763
|
+
*
|
|
764
|
+
* Best-effort disconnect signal used by browser tabs during unload and reconnect transitions so stale event stream slots are released promptly.
|
|
765
|
+
*/
|
|
766
|
+
export declare const disconnectSessionEventsMutation: (options?: Partial<Options<DisconnectSessionEventsData>>) => UseMutationOptions<unknown, DisconnectSessionEventsError, Options<DisconnectSessionEventsData>>;
|
|
767
|
+
/**
|
|
768
|
+
* Start the game
|
|
769
|
+
*
|
|
770
|
+
* Transition session from lobby to gameplay phase (host only)
|
|
771
|
+
*/
|
|
772
|
+
export declare const startGameMutation: (options?: Partial<Options<StartGameData>>) => UseMutationOptions<StartGameResponse, StartGameError, Options<StartGameData>>;
|
|
773
|
+
export declare const listPlayerActionsQueryKey: (options: Options<ListPlayerActionsData>) => [Pick<Options<ListPlayerActionsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
774
|
+
_id: string;
|
|
775
|
+
_infinite?: boolean;
|
|
776
|
+
tags?: ReadonlyArray<string>;
|
|
777
|
+
}];
|
|
778
|
+
/**
|
|
779
|
+
* List current actions for a selected player
|
|
780
|
+
*
|
|
781
|
+
* Returns the current server-authored descriptors and action-set revision for the selected player.
|
|
782
|
+
*/
|
|
783
|
+
export declare const listPlayerActionsOptions: (options: Options<ListPlayerActionsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").PlayerActionsResponse, import("../types.gen.js").ProblemDetails, import("../types.gen.js").PlayerActionsResponse, [Pick<Options<ListPlayerActionsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
784
|
+
_id: string;
|
|
785
|
+
_infinite?: boolean;
|
|
786
|
+
tags?: ReadonlyArray<string>;
|
|
787
|
+
}]>, "queryFn"> & {
|
|
788
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").PlayerActionsResponse, [Pick<Options<ListPlayerActionsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
789
|
+
_id: string;
|
|
790
|
+
_infinite?: boolean;
|
|
791
|
+
tags?: ReadonlyArray<string>;
|
|
792
|
+
}], never> | undefined;
|
|
793
|
+
} & {
|
|
794
|
+
queryKey: [Pick<Options<ListPlayerActionsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
795
|
+
_id: string;
|
|
796
|
+
_infinite?: boolean;
|
|
797
|
+
tags?: ReadonlyArray<string>;
|
|
798
|
+
}] & {
|
|
799
|
+
[dataTagSymbol]: import("../types.gen.js").PlayerActionsResponse;
|
|
800
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
801
|
+
};
|
|
802
|
+
};
|
|
803
|
+
export declare const describePlayerActionQueryKey: (options: Options<DescribePlayerActionData>) => [Pick<Options<DescribePlayerActionData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
804
|
+
_id: string;
|
|
805
|
+
_infinite?: boolean;
|
|
806
|
+
tags?: ReadonlyArray<string>;
|
|
807
|
+
}];
|
|
808
|
+
/**
|
|
809
|
+
* Describe one current action
|
|
810
|
+
*
|
|
811
|
+
* Returns the full current descriptor and action-set revision for one selected-player interaction.
|
|
812
|
+
*/
|
|
813
|
+
export declare const describePlayerActionOptions: (options: Options<DescribePlayerActionData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").PlayerActionResponse, import("../types.gen.js").ProblemDetails, import("../types.gen.js").PlayerActionResponse, [Pick<Options<DescribePlayerActionData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
814
|
+
_id: string;
|
|
815
|
+
_infinite?: boolean;
|
|
816
|
+
tags?: ReadonlyArray<string>;
|
|
817
|
+
}]>, "queryFn"> & {
|
|
818
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").PlayerActionResponse, [Pick<Options<DescribePlayerActionData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
819
|
+
_id: string;
|
|
820
|
+
_infinite?: boolean;
|
|
821
|
+
tags?: ReadonlyArray<string>;
|
|
822
|
+
}], never> | undefined;
|
|
823
|
+
} & {
|
|
824
|
+
queryKey: [Pick<Options<DescribePlayerActionData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
825
|
+
_id: string;
|
|
826
|
+
_infinite?: boolean;
|
|
827
|
+
tags?: ReadonlyArray<string>;
|
|
828
|
+
}] & {
|
|
829
|
+
[dataTagSymbol]: import("../types.gen.js").PlayerActionResponse;
|
|
830
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
831
|
+
};
|
|
832
|
+
};
|
|
833
|
+
export declare const getPlayerActionTargetsQueryKey: (options: Options<GetPlayerActionTargetsData>) => [Pick<Options<GetPlayerActionTargetsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
834
|
+
_id: string;
|
|
835
|
+
_infinite?: boolean;
|
|
836
|
+
tags?: ReadonlyArray<string>;
|
|
837
|
+
}];
|
|
838
|
+
/**
|
|
839
|
+
* Describe the current valid target/domain values for one action input
|
|
840
|
+
*
|
|
841
|
+
* Returns the current server-authored input domain for a selected-player action input.
|
|
842
|
+
*/
|
|
843
|
+
export declare const getPlayerActionTargetsOptions: (options: Options<GetPlayerActionTargetsData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").PlayerActionTargetsResponse, import("../types.gen.js").ProblemDetails, import("../types.gen.js").PlayerActionTargetsResponse, [Pick<Options<GetPlayerActionTargetsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
844
|
+
_id: string;
|
|
845
|
+
_infinite?: boolean;
|
|
846
|
+
tags?: ReadonlyArray<string>;
|
|
847
|
+
}]>, "queryFn"> & {
|
|
848
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").PlayerActionTargetsResponse, [Pick<Options<GetPlayerActionTargetsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
849
|
+
_id: string;
|
|
850
|
+
_infinite?: boolean;
|
|
851
|
+
tags?: ReadonlyArray<string>;
|
|
852
|
+
}], never> | undefined;
|
|
853
|
+
} & {
|
|
854
|
+
queryKey: [Pick<Options<GetPlayerActionTargetsData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
855
|
+
_id: string;
|
|
856
|
+
_infinite?: boolean;
|
|
857
|
+
tags?: ReadonlyArray<string>;
|
|
858
|
+
}] & {
|
|
859
|
+
[dataTagSymbol]: import("../types.gen.js").PlayerActionTargetsResponse;
|
|
860
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
861
|
+
};
|
|
862
|
+
};
|
|
863
|
+
/**
|
|
864
|
+
* Validate collector-shaped action inputs
|
|
865
|
+
*
|
|
866
|
+
* Validates one selected-player action using collector-shaped inputs. Path fields are authoritative; clients do not send a GameInput envelope.
|
|
867
|
+
*/
|
|
868
|
+
export declare const validatePlayerActionMutation: (options?: Partial<Options<ValidatePlayerActionData>>) => UseMutationOptions<ValidatePlayerActionResponse, ValidatePlayerActionError, Options<ValidatePlayerActionData>>;
|
|
869
|
+
/**
|
|
870
|
+
* Submit collector-shaped action inputs
|
|
871
|
+
*
|
|
872
|
+
* Submits one selected-player action using collector-shaped inputs. Path fields are authoritative; clients do not send a GameInput envelope.
|
|
873
|
+
*/
|
|
874
|
+
export declare const submitPlayerActionMutation: (options?: Partial<Options<SubmitPlayerActionData>>) => UseMutationOptions<SubmitPlayerActionResponse, SubmitPlayerActionError, Options<SubmitPlayerActionData>>;
|
|
875
|
+
/**
|
|
876
|
+
* Add a seat to the lobby
|
|
877
|
+
*
|
|
878
|
+
* Add a new seat to the lobby (host only, up to maxPlayers)
|
|
879
|
+
*/
|
|
880
|
+
export declare const addSeatMutation: (options?: Partial<Options<AddSeatData>>) => UseMutationOptions<AddSeatResponse, AddSeatError, Options<AddSeatData>>;
|
|
881
|
+
/**
|
|
882
|
+
* Remove a seat from the lobby
|
|
883
|
+
*
|
|
884
|
+
* Remove a seat from the lobby (host only, down to minPlayers)
|
|
885
|
+
*/
|
|
886
|
+
export declare const removeSeatMutation: (options?: Partial<Options<RemoveSeatData>>) => UseMutationOptions<RemoveSeatResponse, RemoveSeatError, Options<RemoveSeatData>>;
|
|
887
|
+
/**
|
|
888
|
+
* Update seat settings
|
|
889
|
+
*
|
|
890
|
+
* Update seat display name and/or player color. User must be assigned to the seat.
|
|
891
|
+
*/
|
|
892
|
+
export declare const updateSeatMutation: (options?: Partial<Options<UpdateSeatData>>) => UseMutationOptions<UpdateSeatResponse, UpdateSeatError, Options<UpdateSeatData>>;
|
|
893
|
+
/**
|
|
894
|
+
* Assign a seat to current user
|
|
895
|
+
*
|
|
896
|
+
* Assign the current authenticated user to a specific seat
|
|
897
|
+
*/
|
|
898
|
+
export declare const assignSeatMutation: (options?: Partial<Options<AssignSeatData>>) => UseMutationOptions<AssignSeatResponse, AssignSeatError, Options<AssignSeatData>>;
|
|
899
|
+
/**
|
|
900
|
+
* Restore game state from history
|
|
901
|
+
*
|
|
902
|
+
* Restore the game to a previous state from history (host only)
|
|
903
|
+
*/
|
|
904
|
+
export declare const restoreHistoryMutation: (options?: Partial<Options<RestoreHistoryData>>) => UseMutationOptions<RestoreHistoryResponse2, RestoreHistoryError, Options<RestoreHistoryData>>;
|
|
905
|
+
/**
|
|
906
|
+
* Unassign a seat
|
|
907
|
+
*
|
|
908
|
+
* Unassign the current user from a specific seat
|
|
909
|
+
*/
|
|
910
|
+
export declare const unassignSeatMutation: (options?: Partial<Options<UnassignSeatData>>) => UseMutationOptions<UnassignSeatResponse, UnassignSeatError, Options<UnassignSeatData>>;
|
|
911
|
+
export declare const fetchUiBundleQueryKey: (options?: Options<FetchUiBundleData>) => [Pick<Options<FetchUiBundleData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
912
|
+
_id: string;
|
|
913
|
+
_infinite?: boolean;
|
|
914
|
+
tags?: ReadonlyArray<string>;
|
|
915
|
+
}];
|
|
916
|
+
/**
|
|
917
|
+
* Fetch UI bundle
|
|
918
|
+
*
|
|
919
|
+
* Fetch and return the HTML content of a UI bundle from Supabase storage based on the last compiled UI result
|
|
920
|
+
*/
|
|
921
|
+
export declare const fetchUiBundleOptions: (options?: Options<FetchUiBundleData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<string, import("../types.gen.js").ProblemDetails, string, [Pick<Options<FetchUiBundleData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
922
|
+
_id: string;
|
|
923
|
+
_infinite?: boolean;
|
|
924
|
+
tags?: ReadonlyArray<string>;
|
|
925
|
+
}]>, "queryFn"> & {
|
|
926
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<string, [Pick<Options<FetchUiBundleData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
927
|
+
_id: string;
|
|
928
|
+
_infinite?: boolean;
|
|
929
|
+
tags?: ReadonlyArray<string>;
|
|
930
|
+
}], never> | undefined;
|
|
931
|
+
} & {
|
|
932
|
+
queryKey: [Pick<Options<FetchUiBundleData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
933
|
+
_id: string;
|
|
934
|
+
_infinite?: boolean;
|
|
935
|
+
tags?: ReadonlyArray<string>;
|
|
936
|
+
}] & {
|
|
937
|
+
[dataTagSymbol]: string;
|
|
938
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
939
|
+
};
|
|
940
|
+
};
|
|
941
|
+
export declare const listDemoGamesQueryKey: (options?: Options<ListDemoGamesData>) => [Pick<Options<ListDemoGamesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
942
|
+
_id: string;
|
|
943
|
+
_infinite?: boolean;
|
|
944
|
+
tags?: ReadonlyArray<string>;
|
|
945
|
+
}];
|
|
946
|
+
/**
|
|
947
|
+
* List demo games
|
|
948
|
+
*
|
|
949
|
+
* List bundled demo games that can be opened without a normal user account.
|
|
950
|
+
*/
|
|
951
|
+
export declare const listDemoGamesOptions: (options?: Options<ListDemoGamesData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").DemoGameSummary[], import("../types.gen.js").ProblemDetails, import("../types.gen.js").DemoGameSummary[], [Pick<Options<ListDemoGamesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
952
|
+
_id: string;
|
|
953
|
+
_infinite?: boolean;
|
|
954
|
+
tags?: ReadonlyArray<string>;
|
|
955
|
+
}]>, "queryFn"> & {
|
|
956
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").DemoGameSummary[], [Pick<Options<ListDemoGamesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
957
|
+
_id: string;
|
|
958
|
+
_infinite?: boolean;
|
|
959
|
+
tags?: ReadonlyArray<string>;
|
|
960
|
+
}], never> | undefined;
|
|
961
|
+
} & {
|
|
962
|
+
queryKey: [Pick<Options<ListDemoGamesData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
963
|
+
_id: string;
|
|
964
|
+
_infinite?: boolean;
|
|
965
|
+
tags?: ReadonlyArray<string>;
|
|
966
|
+
}] & {
|
|
967
|
+
[dataTagSymbol]: import("../types.gen.js").DemoGameSummary[];
|
|
968
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
969
|
+
};
|
|
970
|
+
};
|
|
971
|
+
export declare const getDemoGameQueryKey: (options: Options<GetDemoGameData>) => [Pick<Options<GetDemoGameData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
972
|
+
_id: string;
|
|
973
|
+
_infinite?: boolean;
|
|
974
|
+
tags?: ReadonlyArray<string>;
|
|
975
|
+
}];
|
|
976
|
+
/**
|
|
977
|
+
* Get demo game
|
|
978
|
+
*
|
|
979
|
+
* Return registration and playability metadata for a bundled demo game.
|
|
980
|
+
*/
|
|
981
|
+
export declare const getDemoGameOptions: (options: Options<GetDemoGameData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<import("../types.gen.js").DemoGameDetails, import("../types.gen.js").ProblemDetails, import("../types.gen.js").DemoGameDetails, [Pick<Options<GetDemoGameData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
982
|
+
_id: string;
|
|
983
|
+
_infinite?: boolean;
|
|
984
|
+
tags?: ReadonlyArray<string>;
|
|
985
|
+
}]>, "queryFn"> & {
|
|
986
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<import("../types.gen.js").DemoGameDetails, [Pick<Options<GetDemoGameData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
987
|
+
_id: string;
|
|
988
|
+
_infinite?: boolean;
|
|
989
|
+
tags?: ReadonlyArray<string>;
|
|
990
|
+
}], never> | undefined;
|
|
991
|
+
} & {
|
|
992
|
+
queryKey: [Pick<Options<GetDemoGameData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
993
|
+
_id: string;
|
|
994
|
+
_infinite?: boolean;
|
|
995
|
+
tags?: ReadonlyArray<string>;
|
|
996
|
+
}] & {
|
|
997
|
+
[dataTagSymbol]: import("../types.gen.js").DemoGameDetails;
|
|
998
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
999
|
+
};
|
|
1000
|
+
};
|
|
1001
|
+
export declare const getDemoGameThumbnailQueryKey: (options: Options<GetDemoGameThumbnailData>) => [Pick<Options<GetDemoGameThumbnailData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
1002
|
+
_id: string;
|
|
1003
|
+
_infinite?: boolean;
|
|
1004
|
+
tags?: ReadonlyArray<string>;
|
|
1005
|
+
}];
|
|
1006
|
+
/**
|
|
1007
|
+
* Get demo game thumbnail
|
|
1008
|
+
*
|
|
1009
|
+
* Return the static thumbnail image for an active bundled demo game.
|
|
1010
|
+
*/
|
|
1011
|
+
export declare const getDemoGameThumbnailOptions: (options: Options<GetDemoGameThumbnailData>) => import("@tanstack/react-query").OmitKeyof<import("@tanstack/react-query").UseQueryOptions<Blob | File, import("../types.gen.js").ProblemDetails, Blob | File, [Pick<Options<GetDemoGameThumbnailData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
1012
|
+
_id: string;
|
|
1013
|
+
_infinite?: boolean;
|
|
1014
|
+
tags?: ReadonlyArray<string>;
|
|
1015
|
+
}]>, "queryFn"> & {
|
|
1016
|
+
queryFn?: import("@tanstack/react-query").QueryFunction<Blob | File, [Pick<Options<GetDemoGameThumbnailData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
1017
|
+
_id: string;
|
|
1018
|
+
_infinite?: boolean;
|
|
1019
|
+
tags?: ReadonlyArray<string>;
|
|
1020
|
+
}], never> | undefined;
|
|
1021
|
+
} & {
|
|
1022
|
+
queryKey: [Pick<Options<GetDemoGameThumbnailData>, "query" | "body" | "headers" | "path" | "baseUrl"> & {
|
|
1023
|
+
_id: string;
|
|
1024
|
+
_infinite?: boolean;
|
|
1025
|
+
tags?: ReadonlyArray<string>;
|
|
1026
|
+
}] & {
|
|
1027
|
+
[dataTagSymbol]: Blob | File;
|
|
1028
|
+
[dataTagErrorSymbol]: import("../types.gen.js").ProblemDetails;
|
|
1029
|
+
};
|
|
1030
|
+
};
|
|
1031
|
+
/**
|
|
1032
|
+
* Create demo session
|
|
1033
|
+
*
|
|
1034
|
+
* Create a fresh guest-play session for a bundled demo game.
|
|
1035
|
+
*/
|
|
1036
|
+
export declare const createDemoGameSessionMutation: (options?: Partial<Options<CreateDemoGameSessionData>>) => UseMutationOptions<CreateDemoGameSessionResponse, CreateDemoGameSessionError, Options<CreateDemoGameSessionData>>;
|
|
1037
|
+
//# sourceMappingURL=react-query.gen.d.ts.map
|