@seriousgaming/sdk-tools 1.5.0 → 1.6.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.
Files changed (160) hide show
  1. package/dist/bundling/ui-bundler.d.ts +12 -0
  2. package/dist/cli-25RWY5BQ.js +41 -0
  3. package/dist/cli-272KBNJH.js +97 -0
  4. package/dist/cli-2BH7FX27.js +52 -0
  5. package/dist/cli-2GOFEW26.js +81 -0
  6. package/dist/cli-3E3MD5U4.js +21 -0
  7. package/dist/cli-3HE4AVZG.js +115 -0
  8. package/dist/cli-4AKVLEC4.js +1387 -0
  9. package/dist/cli-4BV45LBH.js +126 -0
  10. package/dist/cli-4LKXZQ2B.js +48 -0
  11. package/dist/cli-4UWFQNGF.js +54 -0
  12. package/dist/cli-4YB3ROVR.js +78 -0
  13. package/dist/cli-57RXC3HQ.js +36 -0
  14. package/dist/cli-5JEGTVTG.js +96 -0
  15. package/dist/cli-6AMT3BUO.js +97 -0
  16. package/dist/cli-6RRVEGFB.js +80 -0
  17. package/dist/cli-6WXLXJVX.js +36 -0
  18. package/dist/cli-7OGYADZ3.js +97 -0
  19. package/dist/cli-AK7OIPWY.js +229 -0
  20. package/dist/cli-B4TN6PJP.js +124 -0
  21. package/dist/cli-B6YHEKIJ.js +248 -0
  22. package/dist/cli-BPYMTOUL.js +89 -0
  23. package/dist/cli-BWX5E7TQ.js +23 -0
  24. package/dist/cli-BYJWFFCF.js +37 -0
  25. package/dist/cli-C3NVCKO6.js +43 -0
  26. package/dist/cli-C47GJATR.js +42 -0
  27. package/dist/cli-C5QOJJWX.js +46 -0
  28. package/dist/cli-C6TH5S7K.js +6417 -0
  29. package/dist/cli-DL2CVMRF.js +89 -0
  30. package/dist/cli-DMW2OQIJ.js +76 -0
  31. package/dist/cli-DZW3XD5F.js +143 -0
  32. package/dist/cli-E2NLWIFE.js +1331 -0
  33. package/dist/cli-E33CJRRQ.js +36 -0
  34. package/dist/cli-E6DJIMYD.js +142 -0
  35. package/dist/cli-EEFJKIGL.js +151 -0
  36. package/dist/cli-EVFS55WN.js +185 -0
  37. package/dist/cli-F2D4GGUA.js +549 -0
  38. package/dist/cli-FBTRTIZJ.js +226 -0
  39. package/dist/cli-FWFRKQNE.js +11 -0
  40. package/dist/cli-FYINNRML.js +760 -0
  41. package/dist/cli-G522CPRL.js +88 -0
  42. package/dist/cli-G6KELFSX.js +2847 -0
  43. package/dist/cli-G6UE5NL4.js +90 -0
  44. package/dist/cli-GBFM76BF.js +16 -0
  45. package/dist/cli-GDQ6ILJY.js +101 -0
  46. package/dist/cli-GFBGYFYD.js +50 -0
  47. package/dist/cli-GGPDQNM3.js +35 -0
  48. package/dist/cli-GTSGLN3Z.js +307 -0
  49. package/dist/cli-GUXKQMJ7.js +13641 -0
  50. package/dist/cli-GXD36NF2.js +60 -0
  51. package/dist/cli-HCRTYQQS.js +16 -0
  52. package/dist/cli-HYY64SUD.js +185 -0
  53. package/dist/cli-I355WTAF.js +463 -0
  54. package/dist/cli-IDKYF5XB.js +59 -0
  55. package/dist/cli-ILKCQNM6.js +8 -0
  56. package/dist/cli-IRZ5KB7D.js +36 -0
  57. package/dist/cli-IUS2YCD3.js +31 -0
  58. package/dist/cli-J4DKUUTK.js +138 -0
  59. package/dist/cli-JFU22EJ2.js +187 -0
  60. package/dist/cli-JMZLT65J.js +226 -0
  61. package/dist/cli-JZM7XTNV.js +89 -0
  62. package/dist/cli-K2B6WHKA.js +81 -0
  63. package/dist/cli-KL3756X6.js +126 -0
  64. package/dist/cli-KNOOKGYW.js +88 -0
  65. package/dist/cli-LFGRFIEO.js +226 -0
  66. package/dist/cli-LFM7GJHI.js +0 -0
  67. package/dist/cli-LMDJCHHD.js +304 -0
  68. package/dist/cli-LXYPE3L5.js +99 -0
  69. package/dist/cli-M6BCQRID.js +153 -0
  70. package/dist/cli-MBNMPVDC.js +367 -0
  71. package/dist/cli-MJUYJIEP.js +13 -0
  72. package/dist/cli-MMN4BPO4.js +145 -0
  73. package/dist/cli-MYJGMA6U.js +40 -0
  74. package/dist/cli-N6H6T2E2.js +616 -0
  75. package/dist/cli-O5KP4OVN.js +61 -0
  76. package/dist/cli-O6PWMJTZ.js +25 -0
  77. package/dist/cli-ORIG557O.js +141 -0
  78. package/dist/cli-PFFCNGHI.js +243 -0
  79. package/dist/cli-PNLYX6R6.js +131 -0
  80. package/dist/cli-PQBXVLEU.js +649 -0
  81. package/dist/cli-PTT5RGKO.js +62 -0
  82. package/dist/cli-Q2XJF5AS.js +127 -0
  83. package/dist/cli-QEVDDBNO.js +60 -0
  84. package/dist/cli-QEVE5HUM.js +167 -0
  85. package/dist/cli-QUIJCBYB.js +391 -0
  86. package/dist/cli-QUNIRH7A.js +57 -0
  87. package/dist/cli-QVASWX2A.js +187 -0
  88. package/dist/cli-QWQMPCL6.js +253 -0
  89. package/dist/cli-R4PCG5YX.js +131 -0
  90. package/dist/cli-RA673NGF.js +53 -0
  91. package/dist/cli-RN6IWTL2.js +36 -0
  92. package/dist/cli-ROT3DRKU.js +145 -0
  93. package/dist/cli-RZITKPJX.js +367 -0
  94. package/dist/cli-S5IVGDDD.js +32 -0
  95. package/dist/cli-S5QDONIQ.js +218 -0
  96. package/dist/cli-SIPDUBFL.js +36 -0
  97. package/dist/cli-SMFSZF2G.js +4009 -0
  98. package/dist/cli-SRHBXZCN.js +159 -0
  99. package/dist/cli-TCY5LJ7E.js +88 -0
  100. package/dist/cli-TDSQSCX4.js +131 -0
  101. package/dist/cli-TIDQ4WUE.js +257 -0
  102. package/dist/cli-TLLA6KAP.js +79 -0
  103. package/dist/cli-TPU4TUR6.js +132 -0
  104. package/dist/cli-U2UE7I7J.js +30 -0
  105. package/dist/cli-UELGBQG7.js +101 -0
  106. package/dist/cli-UHSZBKYO.js +97 -0
  107. package/dist/cli-UJ4UCL2Z.js +38 -0
  108. package/dist/cli-UKQYZYFK.js +31 -0
  109. package/dist/cli-UMFFURZ7.js +81 -0
  110. package/dist/cli-UNAJ2OTE.js +15 -0
  111. package/dist/cli-UNJ5X6BU.js +89 -0
  112. package/dist/cli-UTJU4IYG.js +117 -0
  113. package/dist/cli-V4GHRWOV.js +1837 -0
  114. package/dist/cli-VCI3CG36.js +73 -0
  115. package/dist/cli-VCKOC2EV.js +256 -0
  116. package/dist/cli-VL2P354N.js +46 -0
  117. package/dist/cli-WAE26SVW.js +72 -0
  118. package/dist/cli-WOGIAU2E.js +100 -0
  119. package/dist/cli-WU43JT4T.js +52 -0
  120. package/dist/cli-XCO2VQOH.js +122 -0
  121. package/dist/cli-XSVGKI3R.js +39 -0
  122. package/dist/cli-YOTGR3NB.js +82 -0
  123. package/dist/cli-YVVXUD2G.js +197 -0
  124. package/dist/cli-ZISJ36MM.js +89 -0
  125. package/dist/cli-ZTWOE3ZT.js +65 -0
  126. package/dist/cli-ZVSFYDPQ.js +205 -0
  127. package/dist/cli-ZWPYIXNI.js +68 -0
  128. package/dist/cli.js +148 -43093
  129. package/dist/client/build-surfaces.d.ts +33 -0
  130. package/dist/client/dev-server.d.ts +6 -0
  131. package/dist/client/index.d.ts +1 -0
  132. package/dist/client/playwright.d.ts +62 -0
  133. package/dist/client.js +228 -48
  134. package/dist/core/session.d.ts +15 -1
  135. package/dist/dev/console/assets/{index-BVF8exas.js → index-CuMOOH9m.js} +1 -1
  136. package/dist/dev/console/index.html +1 -1
  137. package/dist/dev/shell.d.ts +19 -0
  138. package/dist/dev/surfaces.d.ts +7 -0
  139. package/dist/docs/api/index.md +14 -12
  140. package/dist/docs/api/sdk-tools-client.md +29 -0
  141. package/dist/docs/api/sdk-tools-playwright.md +104 -0
  142. package/dist/docs/changelog.md +19 -0
  143. package/dist/docs/cli-and-dev-server.md +21 -0
  144. package/dist/docs/cli-reference.md +45 -31
  145. package/dist/docs/environment-variables.md +6 -0
  146. package/dist/docs/guides/designing-a-game.md +29 -4
  147. package/dist/docs/guides/starter-game.md +2 -2
  148. package/dist/docs/guides/testing.md +33 -18
  149. package/dist/docs/page-index.md +8 -7
  150. package/dist/docs/recipes/e2e-testing.md +19 -20
  151. package/dist/playwright.js +32232 -0
  152. package/dist/templates/package/claude/rules/workflow-test-engine-or-ui.md +1 -1
  153. package/dist/templates/package/global-setup.ts.template +7 -18
  154. package/dist/templates/package/playwright.config.ts.liquid +8 -11
  155. package/dist/templates/starter-game/playwright.config.ts +8 -11
  156. package/dist/templates/starter-game/testing/e2e/game.spec.ts +1 -1
  157. package/dist/templates/starter-game/testing/e2e/global-setup.ts +7 -18
  158. package/dist/utils/prompt.d.ts +5 -5
  159. package/dist/utils/resource-scan.d.ts +39 -0
  160. package/package.json +7 -3
@@ -0,0 +1,226 @@
1
+ #!/usr/bin/env node
2
+ import {
3
+ DevShell
4
+ } from "./cli-G6KELFSX.js";
5
+ import "./cli-BWX5E7TQ.js";
6
+ import "./cli-V4GHRWOV.js";
7
+ import "./cli-ILKCQNM6.js";
8
+ import "./cli-JMZLT65J.js";
9
+ import {
10
+ participantsFromArgument,
11
+ requireScenario,
12
+ teamCountFromFlag
13
+ } from "./cli-PFFCNGHI.js";
14
+ import "./cli-LFM7GJHI.js";
15
+ import {
16
+ FakeClock
17
+ } from "./cli-C6TH5S7K.js";
18
+ import {
19
+ loadEnvironmentConfig
20
+ } from "./cli-TDSQSCX4.js";
21
+ import {
22
+ readLockFile
23
+ } from "./cli-SRHBXZCN.js";
24
+ import "./cli-GUXKQMJ7.js";
25
+ import "./cli-4LKXZQ2B.js";
26
+ import "./cli-MMN4BPO4.js";
27
+ import {
28
+ parseDevPort,
29
+ parseDevPortOrAuto,
30
+ resolveErrorOverlay
31
+ } from "./cli-C5QOJJWX.js";
32
+ import {
33
+ resolvePublicOrigins
34
+ } from "./cli-YOTGR3NB.js";
35
+ import "./cli-QUNIRH7A.js";
36
+ import "./cli-VCKOC2EV.js";
37
+ import "./cli-E2NLWIFE.js";
38
+ import "./cli-25RWY5BQ.js";
39
+ import "./cli-QWQMPCL6.js";
40
+ import {
41
+ errorMessage
42
+ } from "./cli-SMFSZF2G.js";
43
+ import "./cli-F2D4GGUA.js";
44
+ import "./cli-4YB3ROVR.js";
45
+ import {
46
+ CliError,
47
+ reportResult,
48
+ requestProcessExit
49
+ } from "./cli-N6H6T2E2.js";
50
+
51
+ // cli/commands/dev.ts
52
+ import { existsSync, statSync } from "fs";
53
+ import { resolve } from "path";
54
+ import dotenv from "dotenv";
55
+ import open from "open";
56
+
57
+ // cli/dev/network-addresses.ts
58
+ import { networkInterfaces } from "os";
59
+ function networkAddresses(interfaces = networkInterfaces()) {
60
+ return Object.values(interfaces).flatMap((entries) => entries ?? []).filter((entry) => entry.family === "IPv4" && !entry.internal).map((entry) => entry.address);
61
+ }
62
+
63
+ // cli/commands/dev.ts
64
+ dotenv.config({ path: ".env", debug: false, quiet: true });
65
+ async function devCommand(options) {
66
+ const packagePath = options.workingDir;
67
+ const port = parseDevPortOrAuto(options.port);
68
+ const vitePort = options.vitePort === void 0 ? void 0 : parseDevPort(options.vitePort);
69
+ const assetPort = options.assetPort === void 0 ? void 0 : parseDevPort(options.assetPort);
70
+ const teams = options.teams === void 0 ? void 0 : teamCountFromFlag(options.teams);
71
+ const scenarioId = options.scenario === void 0 ? void 0 : requireScenario(packagePath, options.scenario);
72
+ const publicOrigins = resolvePublicOrigins(options);
73
+ const errorOverlay = resolveErrorOverlay(options.errorOverlay);
74
+ const builtSurfaces = options.builtSurfaces === void 0 ? void 0 : requireBuiltSurfaces(resolve(packagePath, options.builtSurfaces));
75
+ const envConfig = loadEnvironmentConfig(packagePath, {
76
+ seriousGamingApiKey: options.apiKey,
77
+ seriousGamingApiHost: options.host
78
+ });
79
+ const running = options.isolated ? null : await readLockFile(packagePath);
80
+ if (running) {
81
+ throw new CliError(
82
+ "LOCK_HELD",
83
+ `A dev server for this package is already running at http://localhost:${running.port} (pid ${running.pid}).
84
+
85
+ A package holds one session, so this is it, whichever port you asked for.
86
+
87
+ Open it: http://localhost:${running.port}
88
+ Stop it: pnpm run sdk dev stop`,
89
+ { hint: "To run it somewhere else, stop this one and start again with --port." }
90
+ );
91
+ }
92
+ requestProcessExit();
93
+ for (const stream of [process.stdout, process.stderr]) {
94
+ stream.on("error", (error) => {
95
+ if (error.code !== "EPIPE") throw error;
96
+ });
97
+ }
98
+ console.log("Starting Serious Gaming Dev Server...");
99
+ const server = new DevShell({
100
+ packagePath,
101
+ port,
102
+ ...vitePort === void 0 ? {} : { vitePort },
103
+ ...assetPort === void 0 ? {} : { assetPort },
104
+ ...publicOrigins,
105
+ ...scenarioId === void 0 ? {} : { scenarioId },
106
+ ...envConfig.seriousGamingApiKey === void 0 ? {} : { seriousGamingApiKey: envConfig.seriousGamingApiKey },
107
+ ...envConfig.seriousGamingApiHost === void 0 ? {} : { seriousGamingApiHost: envConfig.seriousGamingApiHost },
108
+ ...envConfig.elevenLabsApiKey === void 0 ? {} : { elevenLabsApiKey: envConfig.elevenLabsApiKey },
109
+ ...options.lan ? { lan: true } : {},
110
+ // Started at the real time, so a `nextTickAt` reads as a plausible
111
+ // moment rather than as 1970.
112
+ ...options.fakeClock ? { clock: new FakeClock(Date.now()) } : {},
113
+ ...options.reinitOnChange ? { reinitOnChange: true } : {},
114
+ ...errorOverlay ? {} : { errorOverlay: false },
115
+ ...builtSurfaces === void 0 ? {} : { builtSurfaces },
116
+ ...options.isolated ? { isolated: true } : {},
117
+ ...options.background ? { background: true } : {},
118
+ ...options.brand?.length ? { brandFiles: options.brand.map((file) => resolve(file)) } : {},
119
+ ...teams === void 0 ? {} : { teams },
120
+ ...options.participants === void 0 ? {} : { participants: participantsFromArgument(options.participants) }
121
+ });
122
+ let isShuttingDown = false;
123
+ let stopped = () => {
124
+ };
125
+ const untilStopped = new Promise((resolve2) => {
126
+ stopped = resolve2;
127
+ });
128
+ const shutdown = async () => {
129
+ if (isShuttingDown) return;
130
+ isShuttingDown = true;
131
+ console.log("\n\nShutting down dev server...");
132
+ try {
133
+ await server.stop();
134
+ console.log("Dev server stopped");
135
+ } catch (error) {
136
+ console.error("Error during shutdown:", error);
137
+ }
138
+ stopped();
139
+ };
140
+ try {
141
+ await server.start();
142
+ const moved = port !== 0 && server.url !== `http://localhost:${port}`;
143
+ console.log(`
144
+ \u2713 Dev server running at ${server.url}`);
145
+ console.log(` Game surfaces are served from ${server.assetUrl}`);
146
+ if (server.publicUrl) console.log(` People reach it at ${server.publicUrl}`);
147
+ if (server.publicAssetUrl) {
148
+ console.log(` Their browsers load game surfaces from ${server.publicAssetUrl}`);
149
+ }
150
+ if (options.isolated) {
151
+ console.log(
152
+ ` Isolated: no lock file, so CLI commands reach it only through SERIOUSGAMING_DEV_URL=${server.url}. Configuration comes from the package alone, and uploads go to a temporary directory removed on stop.`
153
+ );
154
+ }
155
+ if (moved) {
156
+ console.log(
157
+ ` (port ${port} was in use, so this one is on ${server.url.split(":").pop()})`
158
+ );
159
+ }
160
+ console.log(reachability(server.url, server.reachableFromNetwork));
161
+ console.log("\nPress Ctrl+C to stop the server\n");
162
+ if (options.open !== false) {
163
+ await open(server.publicUrl ?? server.url);
164
+ }
165
+ process.on("SIGINT", shutdown);
166
+ process.on("SIGTERM", shutdown);
167
+ if (options.background) {
168
+ const packageWatch = setInterval(() => {
169
+ if (existsSync(packagePath)) return;
170
+ clearInterval(packageWatch);
171
+ console.log(`
172
+ The package at ${packagePath} has been removed.`);
173
+ void shutdown();
174
+ }, 1e3);
175
+ packageWatch.unref();
176
+ }
177
+ } catch (error) {
178
+ if (error instanceof CliError) throw error;
179
+ throw new CliError(
180
+ "DEV_SERVER_START_FAILED",
181
+ `Failed to start dev server: ${errorMessage(error)}`,
182
+ { cause: error }
183
+ );
184
+ }
185
+ await untilStopped;
186
+ reportResult({
187
+ url: server.url,
188
+ assetUrl: server.assetUrl,
189
+ port: Number(new URL(server.url).port),
190
+ assetPort: Number(new URL(server.assetUrl).port),
191
+ ...server.publicUrl ? { publicUrl: server.publicUrl } : {},
192
+ ...server.publicAssetUrl ? { publicAssetUrl: server.publicAssetUrl } : {},
193
+ isolated: options.isolated === true,
194
+ stopped: true
195
+ });
196
+ }
197
+ function reachability(url, reachableFromNetwork, addresses = networkAddresses()) {
198
+ if (!reachableFromNetwork) {
199
+ return " Only this machine can reach it. To test on a phone or tablet, restart with --lan.";
200
+ }
201
+ const port = new URL(url).port;
202
+ const lines = [
203
+ "",
204
+ "\u26A0 Listening on your network (--lan). Anyone on the same network can open this",
205
+ " session, use its API and read your package files. Use it only on a network you trust."
206
+ ];
207
+ if (addresses.length === 0) {
208
+ lines.push(" No network address was found, so no other device can reach it yet.");
209
+ } else {
210
+ lines.push(" On another device, open:");
211
+ lines.push(...addresses.map((address) => ` http://${address}:${port}`));
212
+ }
213
+ return lines.join("\n");
214
+ }
215
+ function requireBuiltSurfaces(directory) {
216
+ if (!statSync(directory, { throwIfNoEntry: false })?.isDirectory()) {
217
+ throw new CliError("BUILD_NOT_FOUND", `No built surfaces at ${directory}.`, {
218
+ hint: "Run `pnpm run sdk build` first, which writes them to dist/."
219
+ });
220
+ }
221
+ return directory;
222
+ }
223
+ export {
224
+ devCommand,
225
+ reachability
226
+ };
@@ -0,0 +1,11 @@
1
+ #!/usr/bin/env node
2
+ import {
3
+ blobUploadCommand,
4
+ guessMimeType
5
+ } from "./cli-2BH7FX27.js";
6
+ import "./cli-QWQMPCL6.js";
7
+ import "./cli-N6H6T2E2.js";
8
+ export {
9
+ blobUploadCommand,
10
+ guessMimeType
11
+ };