@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,48 @@
|
|
|
1
|
+
import { Box } from '@mui/material';
|
|
2
|
+
import { getLuminance, useTheme } from '@mui/material/styles';
|
|
3
|
+
import { useBrand } from '@seriousgaming/sdk/ui';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* The host's logo on a top bar, where the host sends one, so the game sits
|
|
7
|
+
* inside whoever is running the session. Nothing at all when the host sends no logo: the game
|
|
8
|
+
* never stands in a logo of its own.
|
|
9
|
+
*
|
|
10
|
+
* It sits on the top bar, which is the host's primary colour rather than the
|
|
11
|
+
* page, so the variant is picked for the bar: light artwork when the bar's own
|
|
12
|
+
* text is light, dark artwork otherwise. A host that sent only the other
|
|
13
|
+
* variant gets a small panel of the colour the artwork was drawn for, rather
|
|
14
|
+
* than ink on ink.
|
|
15
|
+
*/
|
|
16
|
+
export default function HostLogo({ height = 24 }: { height?: number }) {
|
|
17
|
+
const { logo, name } = useBrand();
|
|
18
|
+
const onPrimary = useTheme().palette.primary.contrastText;
|
|
19
|
+
if (!logo) return null;
|
|
20
|
+
|
|
21
|
+
const barIsDark = getLuminance(onPrimary) > 0.5;
|
|
22
|
+
const preferred = barIsDark ? logo.onDark : logo.onLight;
|
|
23
|
+
const src = preferred ?? logo.onLight ?? logo.onDark;
|
|
24
|
+
if (!src) return null;
|
|
25
|
+
const drawnFor = src === logo.onDark ? 'dark' : 'light';
|
|
26
|
+
|
|
27
|
+
return (
|
|
28
|
+
<Box
|
|
29
|
+
component="img"
|
|
30
|
+
src={src}
|
|
31
|
+
alt={name}
|
|
32
|
+
data-testid="host-logo"
|
|
33
|
+
sx={{
|
|
34
|
+
height,
|
|
35
|
+
maxWidth: 140,
|
|
36
|
+
objectFit: 'contain',
|
|
37
|
+
flexShrink: 0,
|
|
38
|
+
...(preferred === undefined && {
|
|
39
|
+
bgcolor: drawnFor === 'light' ? '#ffffff' : '#121212',
|
|
40
|
+
borderRadius: 1,
|
|
41
|
+
px: 1,
|
|
42
|
+
py: 0.5,
|
|
43
|
+
boxSizing: 'content-box',
|
|
44
|
+
}),
|
|
45
|
+
}}
|
|
46
|
+
/>
|
|
47
|
+
);
|
|
48
|
+
}
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import CloudRounded from '@mui/icons-material/CloudRounded';
|
|
2
|
+
import CookieRounded from '@mui/icons-material/CookieRounded';
|
|
3
|
+
import EmojiFoodBeverageRounded from '@mui/icons-material/EmojiFoodBeverageRounded';
|
|
4
|
+
import LocalDrinkRounded from '@mui/icons-material/LocalDrinkRounded';
|
|
5
|
+
import StorefrontRounded from '@mui/icons-material/StorefrontRounded';
|
|
6
|
+
import UmbrellaRounded from '@mui/icons-material/UmbrellaRounded';
|
|
7
|
+
import WbSunnyRounded from '@mui/icons-material/WbSunnyRounded';
|
|
8
|
+
import { Box, type SvgIconProps } from '@mui/material';
|
|
9
|
+
import { alpha, darken, lighten, useTheme } from '@mui/material/styles';
|
|
10
|
+
import type { ComponentType } from 'react';
|
|
11
|
+
|
|
12
|
+
type Look = { Icon: ComponentType<SvgIconProps>; hue: string };
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* The menu's pictures, from the icon set rather than drawn by hand, so they
|
|
16
|
+
* match each other and the host's own icons in weight and size.
|
|
17
|
+
*
|
|
18
|
+
* The hues are the food's, not the brand's: lemonade is yellow on every host.
|
|
19
|
+
* They are only ever a tint behind the icon, never a colour the reader has to
|
|
20
|
+
* tell apart, so they sit happily on any host's palette. An item a scenario
|
|
21
|
+
* adds that this list does not know gets a stall and the host's primary colour.
|
|
22
|
+
*/
|
|
23
|
+
const ITEMS: Record<string, Look> = {
|
|
24
|
+
lemonade: { Icon: LocalDrinkRounded, hue: '#E0B000' },
|
|
25
|
+
icedtea: { Icon: EmojiFoodBeverageRounded, hue: '#A0612E' },
|
|
26
|
+
cookies: { Icon: CookieRounded, hue: '#B5823F' },
|
|
27
|
+
};
|
|
28
|
+
|
|
29
|
+
/** One menu item's icon in a tinted rounded square. */
|
|
30
|
+
export function ItemIcon({ id, size = 40 }: { id: string; size?: number }) {
|
|
31
|
+
const theme = useTheme();
|
|
32
|
+
const look = ITEMS[id] ?? { Icon: StorefrontRounded, hue: theme.palette.primary.main };
|
|
33
|
+
const dark = theme.palette.mode === 'dark';
|
|
34
|
+
|
|
35
|
+
return (
|
|
36
|
+
<Box
|
|
37
|
+
aria-hidden
|
|
38
|
+
sx={{
|
|
39
|
+
width: size,
|
|
40
|
+
height: size,
|
|
41
|
+
flex: 'none',
|
|
42
|
+
display: 'grid',
|
|
43
|
+
placeItems: 'center',
|
|
44
|
+
borderRadius: '12px',
|
|
45
|
+
bgcolor: alpha(look.hue, dark ? 0.24 : 0.2),
|
|
46
|
+
color: dark ? lighten(look.hue, 0.35) : darken(look.hue, 0.45),
|
|
47
|
+
}}
|
|
48
|
+
>
|
|
49
|
+
<look.Icon sx={{ fontSize: size * 0.65 }} />
|
|
50
|
+
</Box>
|
|
51
|
+
);
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
export type Weather = 'sunny' | 'cloudy' | 'rainy';
|
|
55
|
+
|
|
56
|
+
const WEATHER: Record<Weather, ComponentType<SvgIconProps>> = {
|
|
57
|
+
sunny: WbSunnyRounded,
|
|
58
|
+
cloudy: CloudRounded,
|
|
59
|
+
rainy: UmbrellaRounded,
|
|
60
|
+
};
|
|
61
|
+
|
|
62
|
+
/**
|
|
63
|
+
* The colour each kind of day is drawn in, taken from the host's palette so a
|
|
64
|
+
* dark theme or another brand still reads: warm for sun, grey for cloud, the
|
|
65
|
+
* host's info colour for rain.
|
|
66
|
+
*/
|
|
67
|
+
export function useWeatherTone(weather: string) {
|
|
68
|
+
const theme = useTheme();
|
|
69
|
+
if (weather === 'sunny') {
|
|
70
|
+
return { ink: theme.palette.warning.main, wash: alpha(theme.palette.warning.main, 0.14) };
|
|
71
|
+
}
|
|
72
|
+
if (weather === 'rainy') {
|
|
73
|
+
return { ink: theme.palette.info.main, wash: alpha(theme.palette.info.main, 0.12) };
|
|
74
|
+
}
|
|
75
|
+
return { ink: theme.palette.text.secondary, wash: theme.palette.action.hover };
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
/** The day's weather as an icon, in its tone. */
|
|
79
|
+
export function WeatherIcon({ weather, size = 44 }: { weather: string; size?: number }) {
|
|
80
|
+
const Icon = WEATHER[weather as Weather] ?? CloudRounded;
|
|
81
|
+
const { ink } = useWeatherTone(weather);
|
|
82
|
+
return <Icon aria-hidden sx={{ fontSize: size, color: ink, flex: 'none' }} />;
|
|
83
|
+
}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import manifest from '../seriousgaming.sdk.json';
|
|
2
|
+
|
|
3
|
+
/**
|
|
4
|
+
* How many days the week runs for: the game's `maxTicks`, read from the
|
|
5
|
+
* manifest so the number is written down once.
|
|
6
|
+
*
|
|
7
|
+
* A presentation is told this by its host; a session surface is not, and a
|
|
8
|
+
* second copy typed in here would drift the first time someone shortened the
|
|
9
|
+
* week.
|
|
10
|
+
*/
|
|
11
|
+
export const LAST_DAY: number = manifest.maxTicks;
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { describe, expect, it } from 'vitest';
|
|
2
|
+
|
|
3
|
+
import { money } from './format';
|
|
4
|
+
|
|
5
|
+
describe('money', () => {
|
|
6
|
+
it('793: the facilitator screen showed a purse of 2200 pence as £2,200', () => {
|
|
7
|
+
expect(money('£', 2200)).toBe('£22.00');
|
|
8
|
+
});
|
|
9
|
+
|
|
10
|
+
it('puts the sign before the symbol', () => {
|
|
11
|
+
expect(money('£', -150)).toBe('-£1.50');
|
|
12
|
+
});
|
|
13
|
+
});
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
/**
|
|
2
|
-
* Display helpers
|
|
2
|
+
* Display helpers every surface uses, so one rounding of a number is decided once.
|
|
3
3
|
*
|
|
4
4
|
* Money is held in pence everywhere, so the sums stay in whole numbers and
|
|
5
5
|
* nothing accumulates a rounding error over ten days. It becomes pounds here,
|
|
@@ -18,7 +18,23 @@ test('a held session shows the waiting room instead of the stall', async ({ page
|
|
|
18
18
|
await page.goto(DEV_SERVER.bare(DEV_SERVER.playerUrl(1)));
|
|
19
19
|
|
|
20
20
|
const frame = page.frameLocator(DEV_SERVER.iframeSelector('waiting_room'));
|
|
21
|
-
await expect(frame.
|
|
21
|
+
await expect(frame.getByRole('heading', { name: 'Your stall opens soon' })).toBeVisible();
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
test('the facilitator’s deck opens, and its days show the room rather than the stalls', async ({
|
|
25
|
+
page,
|
|
26
|
+
}) => {
|
|
27
|
+
await page.goto(DEV_SERVER.bare('/presentation'));
|
|
28
|
+
|
|
29
|
+
const frame = page.frameLocator(DEV_SERVER.iframeSelector('presentation'));
|
|
30
|
+
await expect(frame.getByRole('heading', { level: 1 })).toHaveText('Lemonade Stand');
|
|
31
|
+
|
|
32
|
+
// A click moves the deck on, as a facilitator's clicker would.
|
|
33
|
+
await frame.locator('.deck-root').click();
|
|
34
|
+
await expect(frame.getByText('Day 1 of 10')).toBeVisible();
|
|
35
|
+
await expect(frame.getByRole('heading', { name: 'How a day works' })).toBeVisible();
|
|
36
|
+
// The projector shows the room, never a table of stalls by name.
|
|
37
|
+
await expect(frame.getByRole('table')).toHaveCount(0);
|
|
22
38
|
});
|
|
23
39
|
|
|
24
40
|
test('the stall opens on day one, with the whole day on one screen', async ({ page }) => {
|
|
@@ -26,8 +42,8 @@ test('the stall opens on day one, with the whole day on one screen', async ({ pa
|
|
|
26
42
|
|
|
27
43
|
const frame = page.frameLocator(DEV_SERVER.iframeSelector('ui'));
|
|
28
44
|
await expect(frame.getByTestId('day')).toHaveText('Day 1');
|
|
29
|
-
await expect(frame.getByText('What shall we make
|
|
30
|
-
await expect(frame.
|
|
45
|
+
await expect(frame.getByText('What shall we make?')).toBeVisible();
|
|
46
|
+
await expect(frame.getByTestId('first-day')).toBeVisible();
|
|
31
47
|
});
|
|
32
48
|
|
|
33
49
|
test('changing one item leaves the others alone', async ({ page }) => {
|
|
@@ -76,7 +92,6 @@ test('the stall opens its own day, and reports what happened', async ({ page })
|
|
|
76
92
|
await frame.getByTestId('open-stall').click();
|
|
77
93
|
|
|
78
94
|
await expect(frame.getByTestId('day')).toHaveText('Day 2');
|
|
79
|
-
await expect(frame.getByTestId('line-lemonade')).toBeVisible();
|
|
80
95
|
await expect(frame.getByTestId('day-1')).toBeVisible();
|
|
81
96
|
|
|
82
97
|
const state = (await getState()) as { session: { completedTicks: number } };
|
|
@@ -88,6 +103,25 @@ test('the stall opens its own day, and reports what happened', async ({ page })
|
|
|
88
103
|
await expect(frame.getByTestId('day')).toHaveText('Day 3');
|
|
89
104
|
await expect(frame.getByTestId('day-2')).toBeVisible();
|
|
90
105
|
await expect(frame.getByTestId('day-1')).toBeVisible();
|
|
106
|
+
|
|
107
|
+
// Looking back at a day shows what was made, and nothing can be changed.
|
|
108
|
+
await frame.getByRole('button', { name: 'Look back at day 1' }).click();
|
|
109
|
+
await expect(frame.getByTestId('looking-back')).toBeVisible();
|
|
110
|
+
await expect(frame.getByTestId('line-lemonade')).toBeVisible();
|
|
111
|
+
await frame.getByTestId('back-to-today').click();
|
|
112
|
+
await expect(frame.getByTestId('looking-back')).toHaveCount(0);
|
|
113
|
+
});
|
|
114
|
+
|
|
115
|
+
test('the facilitator’s day limit holds a stall, and the stall says why', async ({ page }) => {
|
|
116
|
+
await runCommand({ type: 'updateSharedContext', payload: { pacing: { LastOpenDay: 1 } } });
|
|
117
|
+
|
|
118
|
+
await page.goto(DEV_SERVER.bare(DEV_SERVER.playerUrl(1)));
|
|
119
|
+
const frame = page.frameLocator(DEV_SERVER.iframeSelector('ui'));
|
|
120
|
+
await frame.getByTestId('open-stall').click();
|
|
121
|
+
await expect(frame.getByTestId('day')).toHaveText('Day 2');
|
|
122
|
+
|
|
123
|
+
await expect(frame.getByTestId('open-stall')).toBeDisabled();
|
|
124
|
+
await expect(frame.getByTestId('open-stall')).toContainText('Your facilitator opens day 2');
|
|
91
125
|
});
|
|
92
126
|
|
|
93
127
|
test('one stall opening up leaves the others where they were', async ({ page }) => {
|
|
@@ -130,10 +164,10 @@ test('the facilitator can reach a stall without joining it', async ({ page }) =>
|
|
|
130
164
|
await page.goto(DEV_SERVER.bare(DEV_SERVER.consoleUrl()));
|
|
131
165
|
const frame = page.frameLocator(DEV_SERVER.iframeSelector('session'));
|
|
132
166
|
|
|
133
|
-
const
|
|
134
|
-
await expect(
|
|
135
|
-
await expect(
|
|
167
|
+
const card = frame.getByTestId('team-team-1');
|
|
168
|
+
await expect(card.getByRole('link', { name: 'Observe' })).toHaveAttribute('target', '_blank');
|
|
169
|
+
await expect(card.getByRole('button', { name: /Copy the join link/ })).toBeVisible();
|
|
136
170
|
|
|
137
171
|
// The facilitator watches; the stalls run their own days.
|
|
138
|
-
await expect(
|
|
172
|
+
await expect(card.getByRole('button', { name: /Run/ })).toHaveCount(0);
|
|
139
173
|
});
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { createMockParticipant, renderUserInterface } from '@seriousgaming/sdk/ui/testing';
|
|
2
|
-
import { fireEvent, screen } from '@testing-library/react';
|
|
2
|
+
import { fireEvent, screen, waitFor, within } from '@testing-library/react';
|
|
3
3
|
import { describe, expect, it, vi } from 'vitest';
|
|
4
4
|
|
|
5
|
+
import type { Context } from '../types';
|
|
5
6
|
import App from './App';
|
|
6
7
|
import './i18n';
|
|
7
8
|
import { baseSettings, baseContext, playedDay } from './test-helpers';
|
|
@@ -16,33 +17,48 @@ const render = (options: Parameters<typeof renderUserInterface>[1] = {}) =>
|
|
|
16
17
|
...options,
|
|
17
18
|
});
|
|
18
19
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
render({ data: playedDay });
|
|
20
|
+
/** Day `n`'s results, as the round that closed it recorded them. */
|
|
21
|
+
function dayResults(n: number, profit: number): Context['results'] {
|
|
22
|
+
return { ...playedDay.results, Day: n, Profit: profit, Purse: profit * n };
|
|
23
|
+
}
|
|
24
24
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
25
|
+
/** A host whose history holds days 1 to `last`, as `getPastState` returns them. */
|
|
26
|
+
function history(last: number, profit = (n: number) => n * 100) {
|
|
27
|
+
return vi.fn(async () =>
|
|
28
|
+
Array.from({ length: last }, (_, index) => ({
|
|
29
|
+
teamId: 'team-1',
|
|
30
|
+
index: 0,
|
|
31
|
+
name: 'Team 1',
|
|
32
|
+
tick: index + 1,
|
|
33
|
+
recordedAt: 0,
|
|
34
|
+
complete: false,
|
|
35
|
+
context: { results: dayResults(index + 1, profit(index + 1)) },
|
|
36
|
+
}))
|
|
37
|
+
);
|
|
38
|
+
}
|
|
29
39
|
|
|
30
|
-
|
|
31
|
-
|
|
40
|
+
describe('the screen, mid-week', () => {
|
|
41
|
+
// Decision first: the forecast and the menu, then how yesterday went.
|
|
42
|
+
it('puts the decision above how yesterday went', () => {
|
|
43
|
+
render({ data: playedDay, completedTicks: 1 });
|
|
32
44
|
|
|
33
|
-
|
|
45
|
+
const make = screen.getByRole('heading', { name: 'What shall we make?' });
|
|
46
|
+
const yesterday = screen.getByRole('heading', { name: 'Yesterday' });
|
|
47
|
+
expect(make.compareDocumentPosition(yesterday)).toBe(Node.DOCUMENT_POSITION_FOLLOWING);
|
|
34
48
|
});
|
|
35
49
|
|
|
36
50
|
it('counts the day the stall is about to trade, not the one it finished', () => {
|
|
37
|
-
render({ completedTicks: 3 });
|
|
51
|
+
render({ data: playedDay, completedTicks: 3 });
|
|
38
52
|
|
|
39
53
|
expect(screen.getByTestId('day')).toHaveTextContent('Day 4');
|
|
54
|
+
expect(screen.getByText(/of 10/)).toBeInTheDocument();
|
|
40
55
|
});
|
|
41
56
|
|
|
42
57
|
it('says what the weather is doing', () => {
|
|
43
|
-
render();
|
|
58
|
+
render({ data: playedDay, completedTicks: 1 });
|
|
44
59
|
|
|
45
|
-
expect(screen.getByText(
|
|
60
|
+
expect(screen.getByText('Sunny today')).toBeInTheDocument();
|
|
61
|
+
expect(screen.getByText('It is going to be busy.')).toBeInTheDocument();
|
|
46
62
|
});
|
|
47
63
|
|
|
48
64
|
it('says who looks after what', () => {
|
|
@@ -67,23 +83,174 @@ describe('the screen', () => {
|
|
|
67
83
|
});
|
|
68
84
|
|
|
69
85
|
describe('yesterday', () => {
|
|
70
|
-
it('
|
|
86
|
+
it('comes down to one figure and one lesson', () => {
|
|
87
|
+
render({ data: playedDay, completedTicks: 1 });
|
|
88
|
+
|
|
89
|
+
expect(screen.getByTestId('stat-profit')).toHaveTextContent('£23.50');
|
|
90
|
+
expect(screen.getByText('profit, from £36.00 taken and £12.50 spent')).toBeInTheDocument();
|
|
91
|
+
// Forty-two people who wanted something and did not get it, and five
|
|
92
|
+
// iced teas nobody bought. Turning people away is the bigger lesson.
|
|
93
|
+
expect(screen.getByTestId('lesson')).toHaveTextContent(
|
|
94
|
+
'42 people were turned away. And 5 went unsold.'
|
|
95
|
+
);
|
|
96
|
+
});
|
|
97
|
+
|
|
98
|
+
it('keeps every day behind a link on a phone', async () => {
|
|
99
|
+
render({
|
|
100
|
+
data: { ...playedDay, results: dayResults(3, 300) },
|
|
101
|
+
completedTicks: 3,
|
|
102
|
+
callbacks: { getPastState: history(2) as never },
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
expect(screen.queryByTestId('day-1')).not.toBeInTheDocument();
|
|
106
|
+
fireEvent.click(screen.getByRole('button', { name: 'See every day so far' }));
|
|
107
|
+
|
|
108
|
+
await waitFor(() => expect(screen.getByTestId('day-1')).toBeInTheDocument());
|
|
109
|
+
expect(screen.getByTestId('day-2')).toBeInTheDocument();
|
|
110
|
+
expect(screen.getByTestId('day-3')).toBeInTheDocument();
|
|
111
|
+
});
|
|
112
|
+
|
|
113
|
+
it('reads the earlier days from the host, and only the latest from context', async () => {
|
|
114
|
+
const getPastState = history(2);
|
|
115
|
+
render({
|
|
116
|
+
data: { ...playedDay, results: dayResults(3, 300) },
|
|
117
|
+
completedTicks: 3,
|
|
118
|
+
callbacks: { getPastState: getPastState as never },
|
|
119
|
+
});
|
|
120
|
+
|
|
121
|
+
fireEvent.click(screen.getByRole('button', { name: 'See every day so far' }));
|
|
122
|
+
|
|
123
|
+
await waitFor(() => expect(screen.getByTestId('day-1')).toBeInTheDocument());
|
|
124
|
+
expect(getPastState).toHaveBeenCalledWith({
|
|
125
|
+
fromTick: 1,
|
|
126
|
+
toTick: 3,
|
|
127
|
+
capabilityIds: ['results'],
|
|
128
|
+
});
|
|
129
|
+
});
|
|
130
|
+
|
|
131
|
+
it('still shows the latest day when the history cannot be read', async () => {
|
|
132
|
+
render({
|
|
133
|
+
data: { ...playedDay, results: dayResults(2, 200) },
|
|
134
|
+
completedTicks: 2,
|
|
135
|
+
callbacks: {
|
|
136
|
+
getPastState: vi.fn(async () => Promise.reject(new Error('no'))) as never,
|
|
137
|
+
},
|
|
138
|
+
});
|
|
139
|
+
|
|
140
|
+
fireEvent.click(screen.getByRole('button', { name: 'See every day so far' }));
|
|
141
|
+
|
|
142
|
+
await waitFor(() => expect(screen.getByTestId('day-2')).toBeInTheDocument());
|
|
143
|
+
expect(screen.queryByTestId('day-1')).not.toBeInTheDocument();
|
|
144
|
+
});
|
|
145
|
+
});
|
|
146
|
+
|
|
147
|
+
describe('before the first day', () => {
|
|
148
|
+
it('says what the game is instead of showing a yesterday of zeroes', () => {
|
|
149
|
+
render();
|
|
150
|
+
|
|
151
|
+
expect(screen.getByText('Your stall opens for 10 days')).toBeInTheDocument();
|
|
152
|
+
expect(screen.queryByRole('heading', { name: 'Yesterday' })).not.toBeInTheDocument();
|
|
153
|
+
expect(screen.getByText('Sunny on day 1')).toBeInTheDocument();
|
|
154
|
+
expect(screen.queryByRole('navigation', { name: 'Days' })).not.toBeInTheDocument();
|
|
155
|
+
});
|
|
156
|
+
|
|
157
|
+
it('lets the team open when the facilitator has opened the week', () => {
|
|
71
158
|
render();
|
|
72
159
|
|
|
160
|
+
expect(screen.getByTestId('day')).toHaveTextContent('Day 1');
|
|
161
|
+
expect(screen.getByText(/Open the stall when your team is ready/)).toBeInTheDocument();
|
|
162
|
+
expect(screen.getByTestId('open-stall')).toBeEnabled();
|
|
163
|
+
});
|
|
164
|
+
|
|
165
|
+
it('says the facilitator opens the first day while they hold it', () => {
|
|
166
|
+
render({ data: { ...baseContext, pacing: { LastOpenDay: 0 } } });
|
|
167
|
+
|
|
168
|
+
expect(screen.getByText('Not open yet')).toBeInTheDocument();
|
|
169
|
+
expect(screen.getByText(/Your facilitator opens the first day/)).toBeInTheDocument();
|
|
170
|
+
expect(screen.getByTestId('open-stall')).toHaveTextContent('Your facilitator opens day 1');
|
|
171
|
+
expect(screen.getByTestId('open-stall')).toBeDisabled();
|
|
172
|
+
});
|
|
173
|
+
});
|
|
174
|
+
|
|
175
|
+
describe('looking back at a past day', () => {
|
|
176
|
+
const midWeek = () =>
|
|
177
|
+
render({
|
|
178
|
+
data: { ...playedDay, results: dayResults(2, 200) },
|
|
179
|
+
completedTicks: 2,
|
|
180
|
+
callbacks: { getPastState: history(1) as never },
|
|
181
|
+
});
|
|
182
|
+
|
|
183
|
+
it('offers every day played, and only those', () => {
|
|
184
|
+
midWeek();
|
|
185
|
+
|
|
186
|
+
const days = screen.getByRole('navigation', { name: 'Days' });
|
|
187
|
+
expect(within(days).getByRole('button', { name: 'Look back at day 1' })).toBeEnabled();
|
|
188
|
+
expect(within(days).getByRole('button', { name: 'Look back at day 2' })).toBeEnabled();
|
|
189
|
+
expect(within(days).queryByRole('button', { name: /day 3/ })).not.toBeInTheDocument();
|
|
190
|
+
expect(within(days).queryByRole('button', { name: /day 4/ })).not.toBeInTheDocument();
|
|
191
|
+
});
|
|
192
|
+
|
|
193
|
+
it('shows that day item by item, and says nothing can change', async () => {
|
|
194
|
+
midWeek();
|
|
195
|
+
|
|
196
|
+
fireEvent.click(screen.getByRole('button', { name: 'Look back at day 1' }));
|
|
197
|
+
|
|
198
|
+
expect(screen.getByTestId('looking-back')).toHaveTextContent(
|
|
199
|
+
'You are looking back at day 1, so nothing here can be changed. Your plan for day 3 is kept.'
|
|
200
|
+
);
|
|
201
|
+
await waitFor(() => expect(screen.getByTestId('line-lemonade')).toBeInTheDocument());
|
|
202
|
+
expect(screen.getByTestId('line-lemonade')).toHaveTextContent('Lemonade406840');
|
|
73
203
|
expect(
|
|
74
|
-
screen.
|
|
75
|
-
).toBeInTheDocument();
|
|
204
|
+
screen.queryByRole('button', { name: 'Make more Lemonade' })
|
|
205
|
+
).not.toBeInTheDocument();
|
|
206
|
+
expect(screen.queryByTestId('open-stall')).not.toBeInTheDocument();
|
|
76
207
|
});
|
|
77
208
|
|
|
78
|
-
it('
|
|
79
|
-
|
|
209
|
+
it('comes back to today with the plan as it was', () => {
|
|
210
|
+
midWeek();
|
|
80
211
|
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
expect(screen.
|
|
85
|
-
expect(screen.getByTestId('
|
|
86
|
-
expect(screen.getByTestId('
|
|
212
|
+
fireEvent.click(screen.getByRole('button', { name: 'Look back at day 2' }));
|
|
213
|
+
fireEvent.click(screen.getByTestId('back-to-today'));
|
|
214
|
+
|
|
215
|
+
expect(screen.queryByTestId('looking-back')).not.toBeInTheDocument();
|
|
216
|
+
expect(screen.getByTestId('made-lemonade')).toHaveTextContent('40');
|
|
217
|
+
expect(screen.getByTestId('open-stall')).toHaveTextContent('Open the stall for day 3');
|
|
218
|
+
});
|
|
219
|
+
});
|
|
220
|
+
|
|
221
|
+
describe('after the last day', () => {
|
|
222
|
+
const weekOver = () =>
|
|
223
|
+
render({
|
|
224
|
+
data: { ...playedDay, results: { ...dayResults(10, 1000), Purse: 21460 } },
|
|
225
|
+
completedTicks: 10,
|
|
226
|
+
callbacks: { getPastState: history(9, (n) => (n === 6 ? 3810 : n * 100)) as never },
|
|
227
|
+
});
|
|
228
|
+
|
|
229
|
+
it('leads with what is in the jar, and offers nothing to open', () => {
|
|
230
|
+
weekOver();
|
|
231
|
+
|
|
232
|
+
expect(screen.getByText('Closed for good')).toBeInTheDocument();
|
|
233
|
+
expect(screen.getByTestId('final-purse')).toHaveTextContent('£214.60');
|
|
234
|
+
expect(screen.queryByTestId('open-stall')).not.toBeInTheDocument();
|
|
235
|
+
expect(screen.queryByRole('button', { name: /Make more/ })).not.toBeInTheDocument();
|
|
236
|
+
});
|
|
237
|
+
|
|
238
|
+
it('picks out the best day and the best seller', async () => {
|
|
239
|
+
weekOver();
|
|
240
|
+
|
|
241
|
+
await waitFor(() => expect(screen.getByText('Day 6 · £38.10')).toBeInTheDocument());
|
|
242
|
+
expect(screen.getByText('Lemonade')).toBeInTheDocument();
|
|
243
|
+
});
|
|
244
|
+
|
|
245
|
+
it('lists the latest days, and every day on request', async () => {
|
|
246
|
+
weekOver();
|
|
247
|
+
|
|
248
|
+
await waitFor(() => expect(screen.getByTestId('day-8')).toBeInTheDocument());
|
|
249
|
+
expect(screen.queryByTestId('day-1')).not.toBeInTheDocument();
|
|
250
|
+
|
|
251
|
+
fireEvent.click(screen.getByRole('button', { name: 'Show all 10 days' }));
|
|
252
|
+
|
|
253
|
+
expect(screen.getByTestId('day-1')).toBeInTheDocument();
|
|
87
254
|
});
|
|
88
255
|
});
|
|
89
256
|
|
|
@@ -123,7 +290,7 @@ describe('when a write is refused', () => {
|
|
|
123
290
|
* rejection channel, which carries the validator's own message. Only the
|
|
124
291
|
* second is worth showing, and this is what holds that choice in place.
|
|
125
292
|
*/
|
|
126
|
-
it('shows the validator’s own reason', () => {
|
|
293
|
+
it('shows the validator’s own reason, beside the button', () => {
|
|
127
294
|
render({
|
|
128
295
|
validationRejections: [
|
|
129
296
|
{
|
|
@@ -133,6 +300,7 @@ describe('when a write is refused', () => {
|
|
|
133
300
|
],
|
|
134
301
|
});
|
|
135
302
|
|
|
136
|
-
|
|
303
|
+
const footer = screen.getByRole('contentinfo');
|
|
304
|
+
expect(within(footer).getByText(/that plan asks for 150/)).toBeInTheDocument();
|
|
137
305
|
});
|
|
138
306
|
});
|