@seriousgaming/sdk-tools 1.6.1 → 1.8.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 (202) hide show
  1. package/dist/agent/guidance.md +1 -0
  2. package/dist/{cli-2NU2LPEE.js → cli-27M4PX7O.js} +17 -17
  3. package/dist/{cli-2BH7FX27.js → cli-2FXZZLCL.js} +1 -1
  4. package/dist/{cli-5ACDPCXI.js → cli-2KDV2DYC.js} +3 -3
  5. package/dist/{cli-OXAUOWCN.js → cli-2QM63J3I.js} +1 -1
  6. package/dist/{cli-HW53ICZC.js → cli-32NRB2IT.js} +15 -15
  7. package/dist/{cli-45OCBG53.js → cli-3HBYH4VF.js} +11 -11
  8. package/dist/{cli-4VFZHLDG.js → cli-3HPAKEJJ.js} +2 -2
  9. package/dist/{cli-R2MUZQE2.js → cli-3HZGJRQW.js} +11 -11
  10. package/dist/{cli-PGCIHPU7.js → cli-3OCKRPXI.js} +18 -18
  11. package/dist/{cli-64AB62PM.js → cli-3OVXQJEW.js} +2 -2
  12. package/dist/{cli-4UWFQNGF.js → cli-3VV2JLHX.js} +1 -1
  13. package/dist/{cli-XSLNH5PR.js → cli-42ZUP4X3.js} +141 -5
  14. package/dist/{cli-ZJFQ7EEA.js → cli-4B5OBHSY.js} +19 -19
  15. package/dist/{cli-7A6MKCUJ.js → cli-4EMNCU63.js} +27 -19
  16. package/dist/cli-5CG6BMCY.js +36 -0
  17. package/dist/{cli-XZCJIKIV.js → cli-5FRKWNVP.js} +19 -19
  18. package/dist/{cli-Y3DDNMPX.js → cli-5P66N5G6.js} +17 -17
  19. package/dist/{cli-6VNKQ3OX.js → cli-5SYPXJCB.js} +28 -16
  20. package/dist/{cli-G6CANSPL.js → cli-66AHBZRZ.js} +15 -15
  21. package/dist/{cli-BJMS3VX3.js → cli-6AGWTGTO.js} +106 -28
  22. package/dist/{cli-TTMBBEJC.js → cli-6BAZE75K.js} +18 -18
  23. package/dist/{cli-GFNDW2DL.js → cli-6FVHRL3H.js} +19 -19
  24. package/dist/{cli-QVASWX2A.js → cli-6GDPO5VU.js} +2 -2
  25. package/dist/{cli-7XLHO2FE.js → cli-6NBER36P.js} +1 -1
  26. package/dist/{cli-FQRVFGN6.js → cli-726NJARI.js} +0 -0
  27. package/dist/{cli-CD5CIJZI.js → cli-72DRYVTT.js} +13 -13
  28. package/dist/{cli-MMN4BPO4.js → cli-7CW2BBJG.js} +1 -1
  29. package/dist/{cli-XAT25PRU.js → cli-7GJGFILU.js} +15 -15
  30. package/dist/{cli-HFX3YPUL.js → cli-7NCVUM5U.js} +3 -3
  31. package/dist/cli-7S4G4EKK.js +110 -0
  32. package/dist/{cli-J4DKUUTK.js → cli-7V6GUIIS.js} +2 -2
  33. package/dist/{cli-N6H6T2E2.js → cli-AEAFLZGY.js} +12 -0
  34. package/dist/{cli-C47GJATR.js → cli-AGYCXRPR.js} +3 -3
  35. package/dist/{cli-XSVGKI3R.js → cli-BC4KKNLA.js} +1 -1
  36. package/dist/cli-BQ3FHENQ.js +16 -0
  37. package/dist/{cli-KGM6RRQW.js → cli-BXCCODYD.js} +20 -20
  38. package/dist/cli-C2XDL4LD.js +30 -0
  39. package/dist/{cli-MJUYJIEP.js → cli-C45A5VX6.js} +3 -3
  40. package/dist/{cli-DOXRQ3S5.js → cli-C7YZNPWX.js} +11 -11
  41. package/dist/{cli-HOE3WLFH.js → cli-CAX4CQTC.js} +13 -13
  42. package/dist/{cli-YOTGR3NB.js → cli-CVOLMK3Z.js} +1 -1
  43. package/dist/{cli-ILFDANBR.js → cli-D3CZRXVJ.js} +63 -17
  44. package/dist/{cli-4YB3ROVR.js → cli-DMKRP33X.js} +1 -1
  45. package/dist/{cli-Y3O5F4JN.js → cli-DPFN2LIZ.js} +15 -15
  46. package/dist/{cli-6UTPHWRQ.js → cli-DT756M3Z.js} +20 -20
  47. package/dist/{cli-TIDQ4WUE.js → cli-DXHPYN4N.js} +1 -1
  48. package/dist/{cli-6K3VQQUS.js → cli-E665NKUQ.js} +5 -5
  49. package/dist/{cli-O5ABH2WK.js → cli-EK7CGMGS.js} +17 -17
  50. package/dist/{cli-6QB2VFPY.js → cli-ESU3J563.js} +15 -15
  51. package/dist/{cli-VPRRICZA.js → cli-F47ELAXM.js} +47 -47
  52. package/dist/{cli-RLEGRWFM.js → cli-FH4WBZHA.js} +14 -14
  53. package/dist/{cli-3D3ZXWOV.js → cli-FHKRO6OU.js} +19 -19
  54. package/dist/{cli-JZCLIT3O.js → cli-FSEDPZR5.js} +19 -19
  55. package/dist/{cli-XOTNXEJA.js → cli-FV45UZQP.js} +19 -19
  56. package/dist/{cli-AV2FYC5G.js → cli-G7FX7ZIU.js} +12 -12
  57. package/dist/{cli-IP4RXGHM.js → cli-GFONBOJT.js} +129 -38
  58. package/dist/{cli-C5QOJJWX.js → cli-GHIMH6JU.js} +1 -1
  59. package/dist/{cli-IDVUHGKG.js → cli-HC7L5DXV.js} +15 -15
  60. package/dist/{cli-WU43JT4T.js → cli-HJPNNORV.js} +2 -2
  61. package/dist/{cli-QY5NZAR7.js → cli-HMEZHQBC.js} +17 -17
  62. package/dist/{cli-JZOZOEZM.js → cli-HQUVSAHY.js} +18 -18
  63. package/dist/{cli-MYJGMA6U.js → cli-IC5FOT2J.js} +1 -1
  64. package/dist/{cli-VL2P354N.js → cli-IVZ7AHUJ.js} +3 -3
  65. package/dist/{cli-B6YHEKIJ.js → cli-J2OTL6JH.js} +5 -5
  66. package/dist/{cli-Z56ZIVA6.js → cli-JA6UFTSX.js} +17 -17
  67. package/dist/{cli-MJV47HKI.js → cli-JOXCAGM7.js} +19 -19
  68. package/dist/{cli-ZBN5KAIB.js → cli-JQ6I5GGE.js} +3 -3
  69. package/dist/{cli-TDSQSCX4.js → cli-K6M6YB67.js} +1 -1
  70. package/dist/{cli-C6ZLPK2U.js → cli-KFVA7DT3.js} +3 -3
  71. package/dist/{cli-KOGRWFN7.js → cli-KH6FKM5A.js} +15 -15
  72. package/dist/{cli-5IAW3LIF.js → cli-KMT235FV.js} +2 -2
  73. package/dist/{cli-ZDUADFBY.js → cli-KU4PG7ZA.js} +15 -15
  74. package/dist/{cli-N45DREM4.js → cli-L4DEEAMK.js} +17 -17
  75. package/dist/{cli-MU5LB43S.js → cli-ME3JKMJL.js} +19 -19
  76. package/dist/{cli-C3CMJSNL.js → cli-MJ65PIYI.js} +15 -15
  77. package/dist/cli-MM2ROZWO.js +36 -0
  78. package/dist/{cli-RZITKPJX.js → cli-MN7X4UG2.js} +1 -1
  79. package/dist/{cli-4SIWLHQO.js → cli-MPU4FLA7.js} +4 -4
  80. package/dist/{cli-HCRTYQQS.js → cli-MPWTXNF6.js} +2 -2
  81. package/dist/{cli-EVI36HEM.js → cli-N5K2KHPR.js} +15 -15
  82. package/dist/{cli-RSW6EBBD.js → cli-NGOQWOQE.js} +15 -15
  83. package/dist/{cli-ZTWOE3ZT.js → cli-NU4SCD5D.js} +1 -1
  84. package/dist/{cli-BYCHKSSH.js → cli-O3IMNLN2.js} +282 -96
  85. package/dist/{cli-KGT5L7VZ.js → cli-OUFXSQOW.js} +7265 -4467
  86. package/dist/{cli-DFBTZEBX.js → cli-PEY6XZDE.js} +16 -16
  87. package/dist/{cli-QUSCIUOM.js → cli-PLW3TWJ7.js} +19 -19
  88. package/dist/{cli-JVI24FI6.js → cli-PO2ALWHP.js} +13 -13
  89. package/dist/{cli-3BRC32CP.js → cli-PPEB3ENS.js} +18 -18
  90. package/dist/{cli-ZDOTXEKL.js → cli-PZ7G544B.js} +3 -3
  91. package/dist/{cli-L7VYSXQK.js → cli-Q5BKFFDL.js} +4 -4
  92. package/dist/{cli-3ZKWV3PN.js → cli-QAI6T5FL.js} +15 -15
  93. package/dist/{cli-KSGB2ZLK.js → cli-QAVLRCQ5.js} +3 -3
  94. package/dist/{cli-VDBW23SS.js → cli-QDIH2G2P.js} +15 -15
  95. package/dist/cli-SN7D7HTX.js +36 -0
  96. package/dist/{cli-IEMKI7J7.js → cli-SOQJHK4Q.js} +6 -6
  97. package/dist/{cli-4PXNOJQX.js → cli-SPKPDXWD.js} +15 -15
  98. package/dist/{cli-MOPSZ3CS.js → cli-SWUAXVIJ.js} +15 -15
  99. package/dist/cli-TJNLXQJ5.js +36 -0
  100. package/dist/{cli-BUQI5UU4.js → cli-U2EWI6H5.js} +11 -11
  101. package/dist/{cli-TT36JCU5.js → cli-UADUC4JD.js} +2 -2
  102. package/dist/{cli-FWFRKQNE.js → cli-UR63LFVK.js} +2 -2
  103. package/dist/{cli-J4UBELKF.js → cli-UTHPCZYL.js} +2 -2
  104. package/dist/{cli-Q6ZBZYK2.js → cli-UYV3BDPA.js} +3 -3
  105. package/dist/{cli-LQOHATY2.js → cli-UZCQL6YP.js} +3 -3
  106. package/dist/{cli-HKORECAG.js → cli-V5K3CCYZ.js} +2 -2
  107. package/dist/cli-V7L3HEL4.js +36 -0
  108. package/dist/{cli-HSIHDN6K.js → cli-VBSF3R3L.js} +16 -16
  109. package/dist/{cli-NROTDF5Y.js → cli-VQ4OJ4KE.js} +18 -18
  110. package/dist/{cli-IUS2YCD3.js → cli-VTLFQHDO.js} +1 -1
  111. package/dist/{cli-JJSWBW4H.js → cli-W7XCTGQ7.js} +15 -15
  112. package/dist/{cli-UZZFNXRX.js → cli-W7Y7X3FX.js} +19 -19
  113. package/dist/cli-WWNTBK37.js +1973 -0
  114. package/dist/cli-XPJGW375.js +36 -0
  115. package/dist/{cli-SRHBXZCN.js → cli-Y33ULHYO.js} +1 -1
  116. package/dist/{cli-TTKICM5P.js → cli-YLYB4ITF.js} +13 -13
  117. package/dist/{cli-72XDEFU3.js → cli-ZFY6TGU7.js} +4 -4
  118. package/dist/{cli-6SGCYEEC.js → cli-ZSKP2IRP.js} +53 -38
  119. package/dist/cli.js +53 -51
  120. package/dist/client.js +17699 -16630
  121. package/dist/core/game-settings.d.ts +5 -3
  122. package/dist/core/save-scenario.d.ts +1 -0
  123. package/dist/core/session-roster.d.ts +10 -0
  124. package/dist/core/session-start-gate.d.ts +25 -0
  125. package/dist/core/session.d.ts +4 -0
  126. package/dist/dev/console/assets/index-CVNjiRUh.js +208 -0
  127. package/dist/dev/console/index.html +1 -1
  128. package/dist/dev/routes.d.ts +5 -2
  129. package/dist/dev/shell.d.ts +9 -1
  130. package/dist/dev/view/batch.d.ts +11 -1
  131. package/dist/dev/view/route.d.ts +18 -1
  132. package/dist/dev/view/view.d.ts +9 -0
  133. package/dist/docs/api/deck.md +1 -1
  134. package/dist/docs/api/index.md +2 -2
  135. package/dist/docs/api/sdk-commands.md +4 -0
  136. package/dist/docs/api/sdk-e2e.md +12 -6
  137. package/dist/docs/api/sdk-projection.md +1 -0
  138. package/dist/docs/api/sdk-tools-client.md +7 -1
  139. package/dist/docs/api/sdk-tools-playwright.md +1 -8
  140. package/dist/docs/api/sdk-ui-testing.md +1 -0
  141. package/dist/docs/api/sdk-ui.md +67 -63
  142. package/dist/docs/api/sdk.md +12 -1
  143. package/dist/docs/changelog.md +26 -0
  144. package/dist/docs/cli-and-dev-server.md +4 -0
  145. package/dist/docs/cli-error-codes.md +7 -1
  146. package/dist/docs/cli-reference.md +20 -2
  147. package/dist/docs/concepts/index.md +1 -0
  148. package/dist/docs/guides/engine.md +5 -0
  149. package/dist/docs/guides/file-handling.md +4 -1
  150. package/dist/docs/guides/llm-integration.md +3 -2
  151. package/dist/docs/guides/multi-team-games.md +2 -0
  152. package/dist/docs/guides/patterns.md +5 -0
  153. package/dist/docs/guides/presentation.md +11 -10
  154. package/dist/docs/guides/session-hooks.md +16 -0
  155. package/dist/docs/guides/session.md +1 -1
  156. package/dist/docs/guides/settings.md +6 -2
  157. package/dist/docs/guides/setup.md +23 -2
  158. package/dist/docs/guides/speech-generation.md +1 -0
  159. package/dist/docs/guides/testing.md +2 -0
  160. package/dist/docs/guides/tick-controller.md +2 -0
  161. package/dist/docs/guides/type-safety.md +2 -1
  162. package/dist/docs/guides/ui-files-and-llms.md +3 -1
  163. package/dist/docs/guides/upgrading.md +16 -0
  164. package/dist/docs/guides/validators.md +27 -4
  165. package/dist/docs/guides/waiting-room.md +2 -0
  166. package/dist/docs/page-index.md +12 -10
  167. package/dist/docs/recipes/call-endpoint-from-ui.md +1 -0
  168. package/dist/docs/recipes/create-scenario-editor.md +2 -1
  169. package/dist/docs/recipes/create-setup.md +2 -1
  170. package/dist/docs/recipes/declare-api-uses.md +1 -0
  171. package/dist/docs/recipes/describe-setup-with-endpoint.md +69 -0
  172. package/dist/docs/recipes/index.md +3 -1
  173. package/dist/docs/recipes/share-logic-between-engine-and-ui.md +2 -2
  174. package/dist/docs/recipes/test-user-interface.md +1 -1
  175. package/dist/docs/recipes/validate-scenarios.md +9 -3
  176. package/dist/docs/recipes/write-setup-notes.md +58 -0
  177. package/dist/docs/troubleshooting.md +2 -1
  178. package/dist/execution/executor.d.ts +12 -0
  179. package/dist/execution/scenario-gates.d.ts +40 -0
  180. package/dist/host/protocol.d.ts +10 -1
  181. package/dist/host.js +1083 -467
  182. package/dist/playwright.js +17760 -16691
  183. package/dist/runtime/manifest-version.d.ts +1 -1
  184. package/dist/runtime.js +4 -2
  185. package/dist/schema.json +10 -1
  186. package/dist/setup/setup-notes.d.ts +42 -0
  187. package/dist/templates/package/package.json.liquid +15 -15
  188. package/dist/templates/starter-game/package.json +13 -13
  189. package/dist/utils/error-codes.d.ts +13 -1
  190. package/dist/validation/package-validation.d.ts +1 -1
  191. package/package.json +22 -23
  192. package/dist/cli-2GZYGRVL.js +0 -36
  193. package/dist/cli-5SM367K7.js +0 -30
  194. package/dist/cli-DDJYUKQG.js +0 -36
  195. package/dist/cli-LK3V4RI5.js +0 -36
  196. package/dist/cli-N24OHSAN.js +0 -36
  197. package/dist/cli-OMWC75CC.js +0 -256
  198. package/dist/cli-RCIWBCXD.js +0 -36
  199. package/dist/cli-UMEBPAZQ.js +0 -16
  200. package/dist/cli-VQ6HVQW4.js +0 -4010
  201. package/dist/cli-WR3NOY74.js +0 -36
  202. package/dist/dev/console/assets/index-CuMOOH9m.js +0 -204
@@ -57,9 +57,11 @@ export declare function declaredGameSettings(schema: unknown): ResolvedGameSetti
57
57
  /**
58
58
  * Why a session-layer override of the `game` settings is refused, or null
59
59
  * when it is not. `waitingRoom.openOnStart` seeds the waiting-room flag as
60
- * the session is created, before any setup step runs, so a session-layer
61
- * value would be read by nothing; refusing it says so where an inert override
62
- * would read as applied (§6.14.4, §8.2).
60
+ * the session is created, before any setup step runs, and
61
+ * `teams.sessionJoin` is read at the same moment, because people may follow
62
+ * the session link before play starts. A session-layer value of either would
63
+ * be read by nothing; refusing it says so where an inert override would read
64
+ * as applied (§6.10.1, §6.14.4, §8.2).
63
65
  */
64
66
  export declare function gameOverrideRefusal(overrides: unknown): string | null;
65
67
  export {};
@@ -22,4 +22,5 @@ export declare class SaveScenarioError extends Error {
22
22
  /** Throws a {@link SaveScenarioError} for a save refused before anything is written. */
23
23
  export declare function saveSessionScenario(session: Session, packagePath: string, request: SaveScenarioRequest): Promise<{
24
24
  identifier: string;
25
+ warnings?: string[];
25
26
  }>;
@@ -109,6 +109,16 @@ export declare class SessionRoster {
109
109
  type: 'renameSelf';
110
110
  }>): undefined;
111
111
  addParticipant(teamId: string, name?: string): Promise<undefined>;
112
+ /**
113
+ * Join through the session link (§13.4).
114
+ *
115
+ * Which team is this host's own choice, and nothing a game may rely on:
116
+ * the one with the fewest participants, the lowest index on a tie, so a
117
+ * room scanning one code fills its teams evenly. It creates an ordinary
118
+ * participant with an ordinary `participantJoin`, exactly as a team link
119
+ * does.
120
+ */
121
+ joinSession(name?: string): Promise<undefined>;
112
122
  renameParticipant(participantId: string, name: string): undefined;
113
123
  moveParticipant(participantId: string, toTeamId: string): Promise<undefined>;
114
124
  findParticipantTeam(participantId: string): string | undefined;
@@ -0,0 +1,25 @@
1
+ /**
2
+ * The `Scenario` gate run as a session starts (§15.8, `session-validation`).
3
+ *
4
+ * A package scenario passed the gate at build, so a session on one that
5
+ * nobody has changed has nothing new to judge. Once a session-scoped source
6
+ * has changed something, the combination is new, and the game's own rules
7
+ * decide whether it may start. The dev server saves custom scenarios as
8
+ * package scenarios (§6.7.2), so an empty session layer is the whole test here.
9
+ */
10
+ import type { ResolvedPackageManifest, SDKScenario } from '@seriousgaming/sdk';
11
+ import type { SessionSettingsOverrides } from '../execution/types';
12
+ /**
13
+ * Refuse a session start the game's gate refuses, and return its warnings.
14
+ * A gate that fails is reported apart from the problems it finds: only a fix
15
+ * to the game clears it, so changing settings will not.
16
+ */
17
+ export declare function gateSessionStart(options: {
18
+ packagePath: string;
19
+ config: ResolvedPackageManifest | null;
20
+ scenario: SDKScenario | null;
21
+ overrides: SessionSettingsOverrides | null;
22
+ locale: string;
23
+ /** Each gate's bound; the runtime's own when absent. */
24
+ boundMs?: number;
25
+ }): Promise<string[]>;
@@ -137,6 +137,8 @@ export declare class Session {
137
137
  private started;
138
138
  /** True while the game's `setup` slot still owes us a Play (§8.3). */
139
139
  private holdingAtSetup;
140
+ /** The `Scenario` gate's warnings from the last start, for the mutation that caused it. */
141
+ private startWarnings;
140
142
  /** Edits on disk that apply only at the next initialisation (#640). */
141
143
  private pending;
142
144
  /**
@@ -401,6 +403,8 @@ export declare class Session {
401
403
  * facilitator.
402
404
  */
403
405
  private gameName;
406
+ /** Refuse to enter play over the game's `Scenario` gate, keeping its warnings (§15.8). */
407
+ private gateStart;
404
408
  private report;
405
409
  private emitState;
406
410
  private emit;