@seriousgaming/sdk-tools 1.3.0 → 1.5.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/dist/cli.js +4055 -2646
- package/dist/client.js +807 -172
- package/dist/core/session-host.d.ts +4 -2
- package/dist/core/settings-locks.d.ts +27 -2
- package/dist/dev/console/assets/{index-DEV8N0na.js → index-BVF8exas.js} +22 -22
- package/dist/dev/console/index.html +1 -1
- package/dist/dev/public-origins.d.ts +61 -0
- package/dist/dev/routes.d.ts +4 -0
- package/dist/dev/shell.d.ts +32 -4
- package/dist/dev/view/batch.d.ts +7 -1
- package/dist/docs/ai-agents.md +5 -0
- package/dist/docs/api/index.md +1 -1
- package/dist/docs/api/sdk-tools-client.md +1 -0
- package/dist/docs/api/sdk.md +79 -2
- package/dist/docs/changelog-0.x.md +2 -2
- package/dist/docs/changelog.md +62 -4
- package/dist/docs/cli-and-dev-server.md +58 -0
- package/dist/docs/cli-error-codes.md +39 -36
- package/dist/docs/cli-reference.md +68 -21
- package/dist/docs/concepts/terminology.md +1 -1
- package/dist/docs/environment-variables.md +10 -5
- package/dist/docs/guides/ai-facilitation.md +2 -0
- package/dist/docs/guides/capabilities.md +4 -0
- package/dist/docs/guides/designing-a-game.md +2 -0
- package/dist/docs/guides/designing-screens.md +133 -0
- package/dist/docs/guides/endpoints.md +4 -2
- package/dist/docs/guides/engine-testing.md +6 -2
- package/dist/docs/guides/engine.md +2 -0
- package/dist/docs/guides/file-handling.md +116 -22
- package/dist/docs/guides/games.md +3 -1
- package/dist/docs/guides/global-settings.md +2 -0
- package/dist/docs/guides/guide.md +2 -0
- package/dist/docs/guides/hooks.md +2 -0
- package/dist/docs/guides/index.md +9 -0
- package/dist/docs/guides/internationalization.md +2 -0
- package/dist/docs/guides/llm-integration.md +5 -3
- package/dist/docs/guides/multi-team-games.md +3 -1
- package/dist/docs/guides/patterns.md +2 -0
- package/dist/docs/guides/presentation.md +1 -1
- package/dist/docs/guides/production-constraints.md +2 -0
- package/dist/docs/guides/scenario-editor.md +3 -1
- package/dist/docs/guides/scenarios.md +15 -3
- package/dist/docs/guides/session-game-flow.md +365 -0
- package/dist/docs/guides/session-hooks.md +205 -0
- package/dist/docs/guides/session.md +27 -565
- package/dist/docs/guides/settings.md +64 -2
- package/dist/docs/guides/setup.md +3 -1
- package/dist/docs/guides/speech-generation.md +2 -0
- package/dist/docs/guides/starter-game.md +61 -21
- package/dist/docs/guides/testing.md +2 -0
- package/dist/docs/guides/tick-controller.md +3 -1
- package/dist/docs/guides/type-safety.md +2 -0
- package/dist/docs/guides/ui-files-and-llms.md +328 -0
- package/dist/docs/guides/ui-participants.md +281 -0
- package/dist/docs/guides/ui-styling.md +263 -0
- package/dist/docs/guides/ui-ticks.md +247 -0
- package/dist/docs/guides/ui.md +11 -1092
- package/dist/docs/guides/upgrading.md +2 -0
- package/dist/docs/guides/validators.md +64 -4
- package/dist/docs/guides/waiting-room.md +1 -1
- package/dist/docs/index.md +2 -1
- package/dist/docs/page-index.md +145 -0
- package/dist/docs/recipes/adapt-a-game-for-walkthroughs.md +1 -1
- package/dist/docs/recipes/adapt-ui-for-observers.md +1 -1
- package/dist/docs/recipes/create-presentation.md +11 -0
- package/dist/docs/recipes/create-scenario-editor.md +1 -0
- package/dist/docs/recipes/create-session-ui.md +2 -1
- package/dist/docs/recipes/create-setup.md +1 -0
- package/dist/docs/recipes/create-user-interface.md +1 -0
- package/dist/docs/recipes/create-waiting-room-ui.md +1 -0
- package/dist/docs/recipes/design-state-for-concurrent-writes.md +1 -1
- package/dist/docs/recipes/fix-duplicate-packages.md +2 -2
- package/dist/docs/recipes/index.md +3 -0
- package/dist/docs/recipes/screenshot-a-surface.md +80 -0
- package/dist/docs/recipes/test-a-multi-role-game.md +1 -1
- package/dist/docs/recipes/upload-and-display-files.md +7 -7
- package/dist/docs/recipes/use-request-tick.md +2 -2
- package/dist/docs/recipes/validate-scenarios.md +4 -1
- package/dist/execution/config-resolver.d.ts +4 -1
- package/dist/execution/endpoint-runner.d.ts +6 -0
- package/dist/execution/logic-calls.d.ts +7 -2
- package/dist/execution/scenario-gates.d.ts +21 -1
- package/dist/guide/settings.d.ts +1 -1
- package/dist/host.js +64 -2
- package/dist/runtime/manifest-version.d.ts +1 -1
- package/dist/runtime.js +7 -2
- package/dist/storage/asset-resolver.d.ts +24 -1
- package/dist/storage/blob-store.d.ts +7 -0
- package/dist/templates/package/CLAUDE.md.template +14 -5
- package/dist/templates/package/DESIGN.md.liquid +39 -7
- package/dist/templates/package/README.md.liquid +1 -1
- package/dist/templates/package/claude/rules/workflow-create-user-interface.md +1 -1
- package/dist/templates/package/pnpm-workspace.yaml.template +13 -0
- package/dist/templates/starter-game/capabilities/pacing/capability.sdk.json +18 -0
- package/dist/templates/starter-game/package.json +2 -0
- package/dist/templates/starter-game/presentation/defaults.ts +52 -0
- package/dist/templates/starter-game/presentation/index.html +20 -0
- package/dist/templates/starter-game/presentation/presentation.sdk.json +10 -0
- package/dist/templates/starter-game/presentation/src/App.tsx +55 -0
- package/dist/templates/starter-game/presentation/src/Band.tsx +40 -0
- package/dist/templates/starter-game/presentation/src/Slides.tsx +415 -0
- package/dist/templates/starter-game/presentation/src/WeatherIcon.tsx +21 -0
- package/dist/templates/starter-game/presentation/src/i18n.ts +88 -0
- package/dist/templates/starter-game/presentation/src/main.tsx +15 -0
- package/dist/templates/starter-game/presentation/src/stalls.test.ts +196 -0
- package/dist/templates/starter-game/presentation/src/stalls.ts +199 -0
- package/dist/templates/starter-game/presentation/types.ts +94 -0
- package/dist/templates/starter-game/seriousgaming.sdk.json +2 -1
- package/dist/templates/starter-game/session/defaults.ts +6 -0
- package/dist/templates/starter-game/session/index.html +1 -1
- package/dist/templates/starter-game/session/session.sdk.json +2 -2
- package/dist/templates/starter-game/session/src/App.test.tsx +436 -115
- package/dist/templates/starter-game/session/src/App.tsx +372 -222
- package/dist/templates/starter-game/session/src/JoinCodes.tsx +184 -0
- package/dist/templates/starter-game/session/src/ManagePanel.tsx +188 -0
- package/dist/templates/starter-game/session/src/Results.tsx +340 -0
- package/dist/templates/starter-game/session/src/SessionBar.tsx +179 -0
- package/dist/templates/starter-game/session/src/SessionPanels.tsx +105 -0
- package/dist/templates/starter-game/session/src/SidePanel.tsx +89 -0
- package/dist/templates/starter-game/session/src/StallCard.tsx +253 -0
- package/dist/templates/starter-game/session/src/TopBar.tsx +36 -0
- package/dist/templates/starter-game/session/src/i18n.ts +91 -24
- package/dist/templates/starter-game/session/src/status.ts +28 -0
- package/dist/templates/starter-game/session/types.ts +8 -2
- package/dist/templates/starter-game/shared/Awning.tsx +31 -0
- package/dist/templates/starter-game/shared/HostLogo.test.tsx +38 -0
- package/dist/templates/starter-game/shared/HostLogo.tsx +48 -0
- package/dist/templates/starter-game/shared/StallIcons.tsx +83 -0
- package/dist/templates/starter-game/shared/days.ts +11 -0
- package/dist/templates/starter-game/shared/format.test.ts +13 -0
- package/dist/templates/starter-game/{ui/src → shared}/format.ts +1 -1
- package/dist/templates/starter-game/testing/e2e/game.spec.ts +42 -8
- package/dist/templates/starter-game/ui/defaults.ts +3 -0
- package/dist/templates/starter-game/ui/src/App.test.tsx +197 -29
- package/dist/templates/starter-game/ui/src/App.tsx +176 -99
- package/dist/templates/starter-game/ui/src/DayBar.test.tsx +50 -7
- package/dist/templates/starter-game/ui/src/DayBar.tsx +96 -38
- package/dist/templates/starter-game/ui/src/DaysTable.tsx +69 -0
- package/dist/templates/starter-game/ui/src/FirstDay.tsx +37 -0
- package/dist/templates/starter-game/ui/src/Header.tsx +257 -0
- package/dist/templates/starter-game/ui/src/Lesson.tsx +63 -0
- package/dist/templates/starter-game/ui/src/MakeRow.tsx +98 -71
- package/dist/templates/starter-game/ui/src/Notices.tsx +59 -0
- package/dist/templates/starter-game/ui/src/PastDay.tsx +88 -0
- package/dist/templates/starter-game/ui/src/Section.tsx +26 -26
- package/dist/templates/starter-game/ui/src/ThemeToggle.tsx +25 -11
- package/dist/templates/starter-game/ui/src/TodayPanel.test.tsx +37 -33
- package/dist/templates/starter-game/ui/src/TodayPanel.tsx +66 -52
- package/dist/templates/starter-game/ui/src/WeatherCard.tsx +47 -0
- package/dist/templates/starter-game/ui/src/WeekOver.tsx +145 -0
- package/dist/templates/starter-game/ui/src/YesterdayPanel.tsx +65 -114
- package/dist/templates/starter-game/ui/src/days.ts +58 -0
- package/dist/templates/starter-game/ui/src/i18n.ts +86 -32
- package/dist/templates/starter-game/ui/src/test-helpers.ts +1 -0
- package/dist/templates/starter-game/ui/src/theme.ts +8 -8
- package/dist/templates/starter-game/ui/types.ts +6 -0
- package/dist/templates/starter-game/ui/ui.sdk.json +1 -1
- package/dist/templates/starter-game/validators/daylimit/defaults.ts +13 -0
- package/dist/templates/starter-game/validators/daylimit/logic/logic.test.ts +20 -0
- package/dist/templates/starter-game/validators/daylimit/logic/logic.ts +23 -0
- package/dist/templates/starter-game/validators/daylimit/types.ts +23 -0
- package/dist/templates/starter-game/validators/daylimit/validator.sdk.json +10 -0
- package/dist/templates/starter-game/waiting_room/src/App.test.tsx +83 -5
- package/dist/templates/starter-game/waiting_room/src/App.tsx +262 -119
- package/dist/templates/starter-game/waiting_room/src/i18n.ts +8 -4
- package/dist/utils/error-codes.d.ts +12 -0
- package/dist/utils/local-refs.d.ts +40 -0
- package/dist/utils/schema-members.d.ts +19 -0
- package/package.json +11 -4
- package/dist/templates/starter-game/session/src/Section.tsx +0 -37
- package/dist/templates/starter-game/session/src/TeamDoor.tsx +0 -96
- package/dist/templates/starter-game/session/src/format.ts +0 -8
- package/dist/templates/starter-game/ui/src/HistoryPanel.test.tsx +0 -74
- package/dist/templates/starter-game/ui/src/HistoryPanel.tsx +0 -120
- package/dist/templates/starter-game/ui/src/HostLogo.test.tsx +0 -25
- package/dist/templates/starter-game/ui/src/HostLogo.tsx +0 -38
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { logicArgs } from '@seriousgaming/sdk/testing';
|
|
2
|
+
import { describe, expect, it } from 'vitest';
|
|
3
|
+
|
|
4
|
+
import { RequestTick } from './logic';
|
|
5
|
+
|
|
6
|
+
const verdict = (requestedTick: number, LastOpenDay: number) =>
|
|
7
|
+
RequestTick(logicArgs.requestTick({ context: { pacing: { LastOpenDay } }, requestedTick }));
|
|
8
|
+
|
|
9
|
+
describe('RequestTick', () => {
|
|
10
|
+
it('lets a stall open a day the facilitator has opened', async () => {
|
|
11
|
+
expect(await verdict(3, 3)).toEqual({ ok: true });
|
|
12
|
+
});
|
|
13
|
+
|
|
14
|
+
it('holds a stall at the last open day, and says who opens the next', async () => {
|
|
15
|
+
expect(await verdict(4, 3)).toEqual({
|
|
16
|
+
ok: false,
|
|
17
|
+
message: 'Day 4 is not open yet. Your facilitator opens it.',
|
|
18
|
+
});
|
|
19
|
+
});
|
|
20
|
+
});
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { RequestTickFunction } from '../types';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* The facilitator's hold on the room.
|
|
5
|
+
*
|
|
6
|
+
* Each stall opens its own days, so without this a fast table could play the
|
|
7
|
+
* whole week before a slow one has finished the first. The session surface
|
|
8
|
+
* writes `pacing.LastOpenDay`, and a stall asking to open a later day is
|
|
9
|
+
* refused here, on the server, rather than only by a disabled button.
|
|
10
|
+
*
|
|
11
|
+
* Only a participant's request reaches a `RequestTick` gate: the facilitator's
|
|
12
|
+
* own tick and undo are never held.
|
|
13
|
+
*/
|
|
14
|
+
export const RequestTick: RequestTickFunction = async ({ requestedTick, context }) => {
|
|
15
|
+
const { LastOpenDay } = context.pacing;
|
|
16
|
+
if (requestedTick > LastOpenDay) {
|
|
17
|
+
return {
|
|
18
|
+
ok: false,
|
|
19
|
+
message: `Day ${requestedTick} is not open yet. Your facilitator opens it.`,
|
|
20
|
+
};
|
|
21
|
+
}
|
|
22
|
+
return { ok: true };
|
|
23
|
+
};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
// This file is auto-generated from the validator's capability definitions.
|
|
2
|
+
// Do not edit this file directly. It will be regenerated on build.
|
|
3
|
+
|
|
4
|
+
export interface Context {
|
|
5
|
+
pacing: {
|
|
6
|
+
/**
|
|
7
|
+
* The last day a stall may open. The facilitator lowers it to hold the room at a day, and raises it to let them on; the default opens all ten
|
|
8
|
+
*/
|
|
9
|
+
LastOpenDay: number;
|
|
10
|
+
};
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
export type Settings = Record<string, never>;
|
|
14
|
+
|
|
15
|
+
import type {
|
|
16
|
+
RequestTickFunction as SDKRequestTickFunction,
|
|
17
|
+
ScenarioFunction as SDKScenarioFunction,
|
|
18
|
+
ValidatorFunction as SDKValidatorFunction,
|
|
19
|
+
} from '@seriousgaming/sdk';
|
|
20
|
+
|
|
21
|
+
export type ValidatorFunction = SDKValidatorFunction<Context, Settings>;
|
|
22
|
+
export type RequestTickFunction = SDKRequestTickFunction<Context, Settings>;
|
|
23
|
+
export type ScenarioFunction = SDKScenarioFunction<Settings>;
|
|
@@ -26,16 +26,31 @@ const settings: Settings = {
|
|
|
26
26
|
},
|
|
27
27
|
};
|
|
28
28
|
|
|
29
|
+
const stall = { teamId: 'team-1', index: 0, name: 'Squeeze Street' };
|
|
29
30
|
const ada = createMockParticipant({ id: 'participant-1', name: 'Ada' });
|
|
30
31
|
|
|
31
32
|
const render = (options: Parameters<typeof renderUserInterface>[1] = {}) =>
|
|
32
|
-
renderUserInterface(<App />, {
|
|
33
|
+
renderUserInterface(<App />, {
|
|
34
|
+
data: baseContext,
|
|
35
|
+
settings,
|
|
36
|
+
participant: ada,
|
|
37
|
+
ownTeam: stall,
|
|
38
|
+
...options,
|
|
39
|
+
});
|
|
33
40
|
|
|
34
41
|
describe('before the session starts', () => {
|
|
35
42
|
it('says so, rather than showing an empty stall', () => {
|
|
36
43
|
render({ completedTicks: 0 });
|
|
37
44
|
|
|
38
|
-
expect(
|
|
45
|
+
expect(
|
|
46
|
+
screen.getByRole('heading', { level: 1, name: 'Your stall opens soon' })
|
|
47
|
+
).toBeInTheDocument();
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
it('names the stall in the top bar', () => {
|
|
51
|
+
render();
|
|
52
|
+
|
|
53
|
+
expect(screen.getByRole('banner')).toHaveTextContent('Squeeze Street');
|
|
39
54
|
});
|
|
40
55
|
|
|
41
56
|
it('lists the team, marking the reader', () => {
|
|
@@ -58,21 +73,40 @@ describe('before the session starts', () => {
|
|
|
58
73
|
|
|
59
74
|
expect(screen.getByText('Iced tea')).toBeInTheDocument();
|
|
60
75
|
});
|
|
76
|
+
|
|
77
|
+
it('marks who has stepped away', () => {
|
|
78
|
+
render({
|
|
79
|
+
participants: [createMockParticipant({ id: '2', name: 'Bea', connected: false })],
|
|
80
|
+
});
|
|
81
|
+
|
|
82
|
+
expect(screen.getByText('Bea · away')).toBeInTheDocument();
|
|
83
|
+
});
|
|
84
|
+
|
|
85
|
+
it('waits for a stall rather than offering one to name, when there is none yet', () => {
|
|
86
|
+
render({ ownTeam: null, participant: null, viewerRole: 'observer' });
|
|
87
|
+
|
|
88
|
+
expect(
|
|
89
|
+
screen.getByText('Waiting for the facilitator to put you on a stall')
|
|
90
|
+
).toBeInTheDocument();
|
|
91
|
+
expect(screen.queryByLabelText('Stall name')).not.toBeInTheDocument();
|
|
92
|
+
});
|
|
61
93
|
});
|
|
62
94
|
|
|
63
95
|
describe('when the facilitator parks a live session', () => {
|
|
64
96
|
// The room can be opened at any point, and the two cases need different
|
|
65
|
-
// words: '
|
|
97
|
+
// words: 'opens soon' is wrong on day five.
|
|
66
98
|
it('says the session is paused rather than not started', () => {
|
|
67
99
|
render({ completedTicks: 4 });
|
|
68
100
|
|
|
69
|
-
expect(
|
|
101
|
+
expect(
|
|
102
|
+
screen.getByRole('heading', { level: 1, name: 'Closed for a moment' })
|
|
103
|
+
).toBeInTheDocument();
|
|
70
104
|
});
|
|
71
105
|
|
|
72
106
|
it('carries the briefing through', () => {
|
|
73
107
|
render({ data: { ...baseContext, briefing: { Message: 'Back in five minutes' } } });
|
|
74
108
|
|
|
75
|
-
expect(screen.
|
|
109
|
+
expect(screen.getByRole('note')).toHaveTextContent('Back in five minutes');
|
|
76
110
|
});
|
|
77
111
|
});
|
|
78
112
|
|
|
@@ -100,3 +134,47 @@ describe('naming the stall', () => {
|
|
|
100
134
|
expect(await screen.findByText('A stall name cannot be blank.')).toBeInTheDocument();
|
|
101
135
|
});
|
|
102
136
|
});
|
|
137
|
+
|
|
138
|
+
describe('bringing in a latecomer', () => {
|
|
139
|
+
const ownTeamJoinLink = { joinUrl: 'https://example.test/join/one' };
|
|
140
|
+
|
|
141
|
+
it('copies the join link rather than printing it', async () => {
|
|
142
|
+
const writeText = vi.fn().mockResolvedValue(undefined);
|
|
143
|
+
Object.assign(navigator, { clipboard: { writeText } });
|
|
144
|
+
render({ ownTeamJoinLink });
|
|
145
|
+
|
|
146
|
+
expect(screen.queryByText(ownTeamJoinLink.joinUrl)).not.toBeInTheDocument();
|
|
147
|
+
fireEvent.click(screen.getByRole('button', { name: 'Copy the join link' }));
|
|
148
|
+
|
|
149
|
+
await waitFor(() => expect(writeText).toHaveBeenCalledWith(ownTeamJoinLink.joinUrl));
|
|
150
|
+
expect(await screen.findByRole('button', { name: 'Copied' })).toBeInTheDocument();
|
|
151
|
+
});
|
|
152
|
+
|
|
153
|
+
// Permissions Policy decides whether a frame may write to the clipboard,
|
|
154
|
+
// so a refusal is a real outcome to design for.
|
|
155
|
+
it('shows the link to copy by hand when the clipboard refuses', async () => {
|
|
156
|
+
const writeText = vi.fn().mockRejectedValue(new Error('blocked'));
|
|
157
|
+
Object.assign(navigator, { clipboard: { writeText } });
|
|
158
|
+
render({ ownTeamJoinLink });
|
|
159
|
+
|
|
160
|
+
fireEvent.click(screen.getByRole('button', { name: 'Copy the join link' }));
|
|
161
|
+
|
|
162
|
+
expect(await screen.findByText(ownTeamJoinLink.joinUrl)).toBeInTheDocument();
|
|
163
|
+
});
|
|
164
|
+
|
|
165
|
+
it('offers nothing before the host has delivered the link', () => {
|
|
166
|
+
render({ ownTeamJoinLink: null });
|
|
167
|
+
|
|
168
|
+
expect(
|
|
169
|
+
screen.queryByRole('button', { name: 'Copy the join link' })
|
|
170
|
+
).not.toBeInTheDocument();
|
|
171
|
+
});
|
|
172
|
+
});
|
|
173
|
+
|
|
174
|
+
describe('the host’s logo', () => {
|
|
175
|
+
it('is absent when the host sends none', () => {
|
|
176
|
+
render();
|
|
177
|
+
|
|
178
|
+
expect(screen.queryByTestId('host-logo')).not.toBeInTheDocument();
|
|
179
|
+
});
|
|
180
|
+
});
|
|
@@ -1,14 +1,14 @@
|
|
|
1
|
+
import StorefrontIcon from '@mui/icons-material/Storefront';
|
|
1
2
|
import {
|
|
2
3
|
Box,
|
|
3
4
|
Button,
|
|
4
|
-
Chip,
|
|
5
5
|
CssBaseline,
|
|
6
|
-
Divider,
|
|
7
6
|
Stack,
|
|
8
7
|
TextField,
|
|
9
8
|
ThemeProvider,
|
|
10
9
|
Typography,
|
|
11
10
|
} from '@mui/material';
|
|
11
|
+
import { alpha } from '@mui/material/styles';
|
|
12
12
|
import {
|
|
13
13
|
MutationError,
|
|
14
14
|
useUserInterfaceOwnTeam,
|
|
@@ -18,9 +18,11 @@ import {
|
|
|
18
18
|
useUserInterfaceParticipant,
|
|
19
19
|
useUserInterfaceParticipants,
|
|
20
20
|
} from '@seriousgaming/sdk/ui';
|
|
21
|
-
import { useState } from 'react';
|
|
21
|
+
import { useState, type FormEvent } from 'react';
|
|
22
22
|
import { useTranslation } from 'react-i18next';
|
|
23
23
|
|
|
24
|
+
import { Awning } from '../../shared/Awning';
|
|
25
|
+
import HostLogo from '../../shared/HostLogo';
|
|
24
26
|
import type { Settings, Context } from '../types';
|
|
25
27
|
import { useAppTheme } from './theme';
|
|
26
28
|
|
|
@@ -42,143 +44,284 @@ import { useAppTheme } from './theme';
|
|
|
42
44
|
* nothing to stop
|
|
43
45
|
*/
|
|
44
46
|
function Shell() {
|
|
45
|
-
const {
|
|
47
|
+
const { completedTicks } = useUserInterfaceData<Context, Settings>();
|
|
46
48
|
const { t } = useTranslation();
|
|
47
49
|
const ownTeam = useUserInterfaceOwnTeam();
|
|
48
|
-
const
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
50
|
+
const before = completedTicks === 0;
|
|
51
|
+
|
|
52
|
+
return (
|
|
53
|
+
<Box sx={{ minHeight: '100vh', display: 'flex', flexDirection: 'column' }}>
|
|
54
|
+
<Box
|
|
55
|
+
component="header"
|
|
56
|
+
sx={{
|
|
57
|
+
bgcolor: 'primary.main',
|
|
58
|
+
color: 'primary.contrastText',
|
|
59
|
+
px: 2,
|
|
60
|
+
pt: 1.75,
|
|
61
|
+
pb: 2.25,
|
|
62
|
+
display: 'flex',
|
|
63
|
+
alignItems: 'center',
|
|
64
|
+
justifyContent: 'space-between',
|
|
65
|
+
gap: 2,
|
|
66
|
+
minHeight: 28,
|
|
67
|
+
}}
|
|
68
|
+
>
|
|
69
|
+
<HostLogo height={28} />
|
|
70
|
+
{ownTeam && (
|
|
71
|
+
<Typography
|
|
72
|
+
sx={{
|
|
73
|
+
ml: 'auto',
|
|
74
|
+
fontSize: 13,
|
|
75
|
+
fontWeight: 600,
|
|
76
|
+
bgcolor: (theme) => alpha(theme.palette.primary.contrastText, 0.18),
|
|
77
|
+
borderRadius: 999,
|
|
78
|
+
px: 1.5,
|
|
79
|
+
py: 0.625,
|
|
80
|
+
}}
|
|
81
|
+
>
|
|
82
|
+
{ownTeam.name}
|
|
83
|
+
</Typography>
|
|
84
|
+
)}
|
|
85
|
+
</Box>
|
|
86
|
+
<Awning depth={14} />
|
|
87
|
+
|
|
88
|
+
<Stack
|
|
89
|
+
component="main"
|
|
90
|
+
spacing={3}
|
|
91
|
+
sx={{ flex: 1, width: '100%', maxWidth: 480, mx: 'auto', px: 2.5, py: 3 }}
|
|
92
|
+
>
|
|
93
|
+
<Stack spacing={1.25} sx={{ alignItems: 'center', textAlign: 'center' }}>
|
|
94
|
+
<Box
|
|
95
|
+
aria-hidden
|
|
96
|
+
sx={{
|
|
97
|
+
width: 112,
|
|
98
|
+
height: 112,
|
|
99
|
+
borderRadius: 7,
|
|
100
|
+
display: 'grid',
|
|
101
|
+
placeItems: 'center',
|
|
102
|
+
color: 'primary.main',
|
|
103
|
+
bgcolor: (theme) => alpha(theme.palette.primary.main, 0.12),
|
|
104
|
+
}}
|
|
105
|
+
>
|
|
106
|
+
<StorefrontIcon sx={{ fontSize: 72 }} />
|
|
107
|
+
</Box>
|
|
108
|
+
<Typography variant="h4" component="h1" sx={{ fontWeight: 700 }}>
|
|
109
|
+
{before ? t('waiting.beforeStart') : t('waiting.paused')}
|
|
110
|
+
</Typography>
|
|
111
|
+
<Typography color="text.secondary">
|
|
112
|
+
{before ? t('waiting.beforeStartHint') : t('waiting.pausedHint')}
|
|
113
|
+
</Typography>
|
|
114
|
+
</Stack>
|
|
115
|
+
|
|
116
|
+
<Briefing />
|
|
117
|
+
|
|
118
|
+
{ownTeam ? (
|
|
119
|
+
<>
|
|
120
|
+
<StallName />
|
|
121
|
+
<Roster />
|
|
122
|
+
<JoinLink />
|
|
123
|
+
</>
|
|
124
|
+
) : (
|
|
125
|
+
<Typography color="text.secondary" sx={{ textAlign: 'center' }}>
|
|
126
|
+
{t('waiting.noTeamYet')}
|
|
127
|
+
</Typography>
|
|
128
|
+
)}
|
|
129
|
+
</Stack>
|
|
130
|
+
</Box>
|
|
131
|
+
);
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
/** The facilitator's note to every stall, when there is one. */
|
|
135
|
+
function Briefing() {
|
|
136
|
+
const { data } = useUserInterfaceData<Context, Settings>();
|
|
137
|
+
const message = data.briefing.Message;
|
|
138
|
+
if (message === '') return null;
|
|
52
139
|
|
|
140
|
+
return (
|
|
141
|
+
<Box
|
|
142
|
+
role="note"
|
|
143
|
+
sx={{
|
|
144
|
+
borderLeft: 4,
|
|
145
|
+
borderColor: 'primary.main',
|
|
146
|
+
bgcolor: (theme) => alpha(theme.palette.primary.main, 0.06),
|
|
147
|
+
borderRadius: 1,
|
|
148
|
+
px: 2,
|
|
149
|
+
py: 1.5,
|
|
150
|
+
}}
|
|
151
|
+
>
|
|
152
|
+
<Typography>{message}</Typography>
|
|
153
|
+
</Box>
|
|
154
|
+
);
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
/**
|
|
158
|
+
* The team names itself here, and that name is the team's name everywhere,
|
|
159
|
+
* including the host's own chrome. So the top bar renders `ownTeam.name`
|
|
160
|
+
* rather than what this just sent: the facilitator can be renaming the same
|
|
161
|
+
* team at the same moment.
|
|
162
|
+
*/
|
|
163
|
+
function StallName() {
|
|
164
|
+
const { t } = useTranslation();
|
|
165
|
+
const { renameOwnTeam } = useUserInterfaceCallbacks();
|
|
53
166
|
const [draftName, setDraftName] = useState('');
|
|
54
167
|
// The host's own reason, not a flag of ours. It knows whether the name was
|
|
55
168
|
// blank or too long, and a fixed 'try a shorter one' is wrong half the time.
|
|
56
169
|
const [refusal, setRefusal] = useState<string | null>(null);
|
|
57
170
|
|
|
58
|
-
|
|
171
|
+
return (
|
|
172
|
+
<Box
|
|
173
|
+
component="form"
|
|
174
|
+
noValidate
|
|
175
|
+
onSubmit={async (event: FormEvent) => {
|
|
176
|
+
event.preventDefault();
|
|
177
|
+
try {
|
|
178
|
+
await renameOwnTeam(draftName);
|
|
179
|
+
setDraftName('');
|
|
180
|
+
} catch (error) {
|
|
181
|
+
setRefusal(
|
|
182
|
+
error instanceof MutationError ? error.message : t('waiting.nameFailed')
|
|
183
|
+
);
|
|
184
|
+
}
|
|
185
|
+
}}
|
|
186
|
+
sx={{ display: 'flex', gap: 1, alignItems: 'flex-start' }}
|
|
187
|
+
>
|
|
188
|
+
<TextField
|
|
189
|
+
fullWidth
|
|
190
|
+
label={t('waiting.namePrompt')}
|
|
191
|
+
value={draftName}
|
|
192
|
+
error={refusal !== null}
|
|
193
|
+
helperText={refusal ?? undefined}
|
|
194
|
+
onChange={(event) => {
|
|
195
|
+
setDraftName(event.target.value);
|
|
196
|
+
setRefusal(null);
|
|
197
|
+
}}
|
|
198
|
+
/>
|
|
199
|
+
<Button type="submit" variant="contained" size="large" sx={{ height: 56, px: 2.5 }}>
|
|
200
|
+
{t('waiting.nameSave')}
|
|
201
|
+
</Button>
|
|
202
|
+
</Box>
|
|
203
|
+
);
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
/** Who is at the stall, who is connected, and which item each looks after. */
|
|
207
|
+
function Roster() {
|
|
208
|
+
const { t } = useTranslation();
|
|
209
|
+
const { data, settings } = useUserInterfaceData<Context, Settings>();
|
|
210
|
+
const participants = useUserInterfaceParticipants();
|
|
211
|
+
const self = useUserInterfaceParticipant();
|
|
59
212
|
const looksAfter = data.roles.LooksAfter;
|
|
60
213
|
const roster = [...participants].sort((a, b) => a.index - b.index);
|
|
61
214
|
|
|
62
215
|
return (
|
|
63
216
|
<Box
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
alignItems: 'center',
|
|
68
|
-
justifyContent: 'center',
|
|
69
|
-
gap: 2.5,
|
|
70
|
-
minHeight: '100vh',
|
|
71
|
-
p: 4,
|
|
72
|
-
textAlign: 'center',
|
|
73
|
-
}}
|
|
217
|
+
component="section"
|
|
218
|
+
aria-labelledby="at-this-stall"
|
|
219
|
+
sx={{ border: 1, borderColor: 'divider', borderRadius: 4, p: 2 }}
|
|
74
220
|
>
|
|
75
|
-
<Typography variant="
|
|
76
|
-
{
|
|
221
|
+
<Typography id="at-this-stall" variant="h6" component="h2" sx={{ fontSize: 16, mb: 1 }}>
|
|
222
|
+
{t('waiting.rosterHeading')}
|
|
77
223
|
</Typography>
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
{
|
|
86
|
-
|
|
224
|
+
{roster.length === 0 ? (
|
|
225
|
+
<Typography color="text.secondary">{t('waiting.rosterEmpty')}</Typography>
|
|
226
|
+
) : (
|
|
227
|
+
<Box
|
|
228
|
+
component="ul"
|
|
229
|
+
sx={{ listStyle: 'none', p: 0, m: 0, display: 'grid', gap: 1.25 }}
|
|
230
|
+
>
|
|
231
|
+
{roster.map((participant) => {
|
|
232
|
+
// The hook stores the item's id; the roster shows its
|
|
233
|
+
// name, so nobody has to know that 'icedtea' means Iced tea.
|
|
234
|
+
const item = looksAfter[participant.id];
|
|
235
|
+
const name =
|
|
236
|
+
participant.id === self?.id
|
|
237
|
+
? t('waiting.you', { name: participant.name })
|
|
238
|
+
: participant.name;
|
|
239
|
+
return (
|
|
240
|
+
<Box
|
|
241
|
+
component="li"
|
|
242
|
+
key={participant.id}
|
|
243
|
+
sx={{
|
|
244
|
+
display: 'flex',
|
|
245
|
+
alignItems: 'center',
|
|
246
|
+
gap: 1.25,
|
|
247
|
+
color: participant.connected
|
|
248
|
+
? 'text.primary'
|
|
249
|
+
: 'text.secondary',
|
|
250
|
+
}}
|
|
251
|
+
>
|
|
252
|
+
<Box
|
|
253
|
+
aria-hidden
|
|
254
|
+
sx={{
|
|
255
|
+
width: 8,
|
|
256
|
+
height: 8,
|
|
257
|
+
flex: 'none',
|
|
258
|
+
borderRadius: '50%',
|
|
259
|
+
bgcolor: participant.connected
|
|
260
|
+
? 'success.main'
|
|
261
|
+
: 'text.disabled',
|
|
262
|
+
}}
|
|
263
|
+
/>
|
|
264
|
+
<Typography sx={{ flex: 1, minWidth: 0 }}>
|
|
265
|
+
{participant.connected ? name : t('waiting.away', { name })}
|
|
266
|
+
</Typography>
|
|
267
|
+
{item && (
|
|
268
|
+
<Typography variant="body2" color="text.secondary">
|
|
269
|
+
{settings.menu.Menu[item]?.Name ?? item}
|
|
270
|
+
</Typography>
|
|
271
|
+
)}
|
|
272
|
+
</Box>
|
|
273
|
+
);
|
|
274
|
+
})}
|
|
275
|
+
</Box>
|
|
87
276
|
)}
|
|
277
|
+
</Box>
|
|
278
|
+
);
|
|
279
|
+
}
|
|
88
280
|
|
|
89
|
-
|
|
281
|
+
/**
|
|
282
|
+
* Every player surface receives its own team's join link, so a latecomer can
|
|
283
|
+
* be sent straight to the team already in front of them. The screen offers to
|
|
284
|
+
* copy it rather than printing it: a long URL is unreadable across a table,
|
|
285
|
+
* and the form the host sends is its own business. Null until the host
|
|
286
|
+
* delivers it, so the section is absent rather than empty.
|
|
287
|
+
*/
|
|
288
|
+
function JoinLink() {
|
|
289
|
+
const { t } = useTranslation();
|
|
290
|
+
const joinLink = useUserInterfaceOwnTeamJoinLink();
|
|
291
|
+
const [copy, setCopy] = useState<'idle' | 'copied' | 'refused'>('idle');
|
|
292
|
+
if (!joinLink) return null;
|
|
90
293
|
|
|
91
|
-
|
|
92
|
-
|
|
294
|
+
return (
|
|
295
|
+
<Stack spacing={0.75} sx={{ alignItems: 'center', textAlign: 'center' }}>
|
|
296
|
+
<Typography sx={{ fontWeight: 600, fontSize: 14 }}>
|
|
297
|
+
{t('waiting.joinHeading')}
|
|
93
298
|
</Typography>
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
await renameOwnTeam(draftName);
|
|
116
|
-
setDraftName('');
|
|
117
|
-
} catch (error) {
|
|
118
|
-
setRefusal(
|
|
119
|
-
error instanceof MutationError
|
|
120
|
-
? error.message
|
|
121
|
-
: t('waiting.nameFailed')
|
|
122
|
-
);
|
|
123
|
-
}
|
|
124
|
-
}}
|
|
299
|
+
<Button
|
|
300
|
+
variant="outlined"
|
|
301
|
+
size="large"
|
|
302
|
+
onClick={async () => {
|
|
303
|
+
try {
|
|
304
|
+
await navigator.clipboard.writeText(joinLink.joinUrl);
|
|
305
|
+
setCopy('copied');
|
|
306
|
+
} catch {
|
|
307
|
+
setCopy('refused');
|
|
308
|
+
}
|
|
309
|
+
}}
|
|
310
|
+
>
|
|
311
|
+
{copy === 'copied' ? t('waiting.joinCopied') : t('waiting.joinCopy')}
|
|
312
|
+
</Button>
|
|
313
|
+
{/* The frame's permissions decide whether the clipboard works, and
|
|
314
|
+
a button that silently does nothing is the worse failure, so
|
|
315
|
+
a refusal falls back to the link itself, to copy by hand. */}
|
|
316
|
+
{copy === 'refused' && (
|
|
317
|
+
<Typography
|
|
318
|
+
variant="body2"
|
|
319
|
+
sx={{ fontFamily: 'monospace', wordBreak: 'break-all', userSelect: 'all' }}
|
|
125
320
|
>
|
|
126
|
-
{
|
|
127
|
-
</
|
|
128
|
-
</Stack>
|
|
129
|
-
|
|
130
|
-
<Box component="ul" sx={{ listStyle: 'none', p: 0, m: 0, display: 'grid', gap: 1 }}>
|
|
131
|
-
{roster.map((participant) => (
|
|
132
|
-
<Box
|
|
133
|
-
component="li"
|
|
134
|
-
key={participant.id}
|
|
135
|
-
sx={{
|
|
136
|
-
display: 'flex',
|
|
137
|
-
alignItems: 'center',
|
|
138
|
-
justifyContent: 'center',
|
|
139
|
-
gap: 1,
|
|
140
|
-
}}
|
|
141
|
-
>
|
|
142
|
-
<Box
|
|
143
|
-
aria-hidden
|
|
144
|
-
sx={{
|
|
145
|
-
width: 8,
|
|
146
|
-
height: 8,
|
|
147
|
-
borderRadius: '50%',
|
|
148
|
-
bgcolor: participant.connected ? 'success.main' : 'text.disabled',
|
|
149
|
-
}}
|
|
150
|
-
/>
|
|
151
|
-
<Typography variant="body2">
|
|
152
|
-
{participant.id === self?.id
|
|
153
|
-
? t('waiting.you', { name: participant.name })
|
|
154
|
-
: participant.name}
|
|
155
|
-
</Typography>
|
|
156
|
-
{looksAfter[participant.id] && (
|
|
157
|
-
<Chip
|
|
158
|
-
size="small"
|
|
159
|
-
label={
|
|
160
|
-
settings.menu.Menu[looksAfter[participant.id] as string]
|
|
161
|
-
?.Name ?? looksAfter[participant.id]
|
|
162
|
-
}
|
|
163
|
-
/>
|
|
164
|
-
)}
|
|
165
|
-
</Box>
|
|
166
|
-
))}
|
|
167
|
-
</Box>
|
|
168
|
-
|
|
169
|
-
{/* Every player surface receives its own team's join link, so a
|
|
170
|
-
latecomer joins the team already in front of them rather than
|
|
171
|
-
waiting for somebody to read a URL out. Null until the host
|
|
172
|
-
delivers it, so the panel is absent rather than empty. */}
|
|
173
|
-
{joinLink && (
|
|
174
|
-
<Box sx={{ display: 'grid', gap: 0.5 }}>
|
|
175
|
-
<Typography variant="subtitle2">{t('waiting.joinHeading')}</Typography>
|
|
176
|
-
<Typography variant="body2" sx={{ fontFamily: 'monospace' }}>
|
|
177
|
-
{joinLink.joinUrl}
|
|
178
|
-
</Typography>
|
|
179
|
-
</Box>
|
|
321
|
+
{joinLink.joinUrl}
|
|
322
|
+
</Typography>
|
|
180
323
|
)}
|
|
181
|
-
</
|
|
324
|
+
</Stack>
|
|
182
325
|
);
|
|
183
326
|
}
|
|
184
327
|
|
|
@@ -5,19 +5,23 @@ const resources = {
|
|
|
5
5
|
en: {
|
|
6
6
|
translation: {
|
|
7
7
|
waiting: {
|
|
8
|
-
beforeStart: '
|
|
8
|
+
beforeStart: 'Your stall opens soon',
|
|
9
9
|
beforeStartHint:
|
|
10
|
-
'
|
|
10
|
+
'Choose a name while you wait. Your facilitator will open the stalls together.',
|
|
11
11
|
paused: 'Closed for a moment',
|
|
12
12
|
pausedHint:
|
|
13
13
|
'Your stall is exactly as you left it. You will be back on your own screen shortly.',
|
|
14
|
-
youAre: 'You are on {{team}}',
|
|
15
14
|
noTeamYet: 'Waiting for the facilitator to put you on a stall',
|
|
16
15
|
namePrompt: 'Stall name',
|
|
17
16
|
nameSave: 'Save',
|
|
18
17
|
nameFailed: 'That name was not accepted.',
|
|
18
|
+
rosterHeading: 'At this stall',
|
|
19
|
+
rosterEmpty: 'Nobody has arrived yet',
|
|
19
20
|
you: '{{name}} (you)',
|
|
20
|
-
|
|
21
|
+
away: '{{name}} · away',
|
|
22
|
+
joinHeading: 'Someone else joining this stall?',
|
|
23
|
+
joinCopy: 'Copy the join link',
|
|
24
|
+
joinCopied: 'Copied',
|
|
21
25
|
},
|
|
22
26
|
},
|
|
23
27
|
},
|