@seriousgaming/sdk-tools 1.0.0-alpha.3 → 1.0.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/README.md +5 -5
- package/dist/cli.js +30 -12
- package/dist/client/index.d.ts +2 -2
- package/dist/client/test-session.d.ts +12 -15
- package/dist/client.js +20 -11
- package/dist/docs/api/index.md +1 -1
- package/dist/docs/api/sdk-tools-client.md +40 -32
- package/dist/docs/api/sdk-ui-testing.md +4 -4
- package/dist/docs/api/sdk-ui.md +80 -20
- package/dist/docs/api/sdk.md +37 -21
- package/dist/docs/changelog.md +119 -74
- package/dist/docs/cli-and-dev-server.md +16 -15
- package/dist/docs/concepts/index.md +1 -1
- package/dist/docs/concepts/terminology.md +6 -6
- package/dist/docs/getting-started.md +4 -2
- package/dist/docs/guides/engine-testing.md +1 -1
- package/dist/docs/guides/engine.md +13 -0
- package/dist/docs/guides/file-handling.md +4 -4
- package/dist/docs/guides/internationalization.md +15 -1
- package/dist/docs/guides/llm-integration.md +2 -0
- package/dist/docs/guides/patterns.md +33 -5
- package/dist/docs/guides/presentation.md +9 -9
- package/dist/docs/guides/session.md +22 -19
- package/dist/docs/guides/testing.md +1 -1
- package/dist/docs/guides/tick-controller.md +5 -3
- package/dist/docs/guides/ui.md +5 -1
- package/dist/docs/guides/upgrading.md +40 -5
- package/dist/docs/recipes/create-endpoint.md +1 -1
- package/dist/docs/recipes/start-from-an-empty-package.md +6 -7
- package/dist/docs/recipes/use-request-tick.md +1 -1
- package/dist/docs/troubleshooting.md +6 -4
- package/dist/schema.json +6 -6
- package/dist/templates/endpoint/logic.test.ts.liquid +35 -48
- package/dist/templates/engine/logic-aggregate.test.ts.liquid +34 -53
- package/dist/templates/engine/logic.test.ts.liquid +22 -34
- package/dist/templates/hook/logic.test.ts.liquid +28 -32
- package/dist/templates/package/CLAUDE.md.template +1 -1
- package/dist/templates/package/README.md.liquid +3 -3
- package/dist/templates/package/claude/rules/workflow-create-capability.md +1 -1
- package/dist/templates/package/claude/rules/workflow-create-endpoint.md +1 -1
- package/dist/templates/presentation/src/App.tsx.liquid +1 -1
- package/dist/templates/session/src/main.tsx.liquid +3 -3
- package/dist/templates/settings-editor/src/main.tsx.liquid +3 -3
- package/dist/templates/starter-game/engine/logic.test.ts +37 -47
- package/dist/templates/starter-game/engine/test-helpers.ts +13 -65
- package/dist/templates/starter-game/hooks/assignproducts/logic/logic.test.ts +24 -30
- package/dist/templates/starter-game/session/src/main.tsx +3 -3
- package/dist/templates/starter-game/ui/src/main.tsx +3 -3
- package/dist/templates/starter-game/validators/capacity/logic/logic.test.ts +12 -35
- package/dist/templates/starter-game/waiting_room/src/main.tsx +3 -3
- package/dist/templates/ui/src/App.test.tsx.liquid +2 -2
- package/dist/templates/ui/src/App.tsx.liquid +22 -11
- package/dist/templates/ui/src/i18n.ts.liquid +3 -0
- package/dist/templates/ui/src/main.tsx.liquid +3 -3
- package/dist/templates/validator/logic.test.ts.liquid +21 -30
- package/dist/templates/waiting-room/src/App.test.tsx.liquid +2 -2
- package/dist/templates/waiting-room/src/main.tsx.liquid +3 -3
- package/package.json +3 -3
|
@@ -1,74 +1,22 @@
|
|
|
1
|
-
import
|
|
2
|
-
|
|
3
|
-
import type { Context, Settings } from './types';
|
|
1
|
+
import { defaultContext } from './defaults';
|
|
2
|
+
import type { Context } from './types';
|
|
4
3
|
|
|
5
4
|
/**
|
|
6
|
-
*
|
|
5
|
+
* The context the engine's tests start from.
|
|
7
6
|
*
|
|
8
|
-
* A test spreads what it cares about over
|
|
7
|
+
* A test spreads what it cares about over this rather than restating the whole
|
|
9
8
|
* context, so adding a field to a capability does not break every test that was
|
|
10
|
-
* never about that field.
|
|
9
|
+
* never about that field. It starts from the generated defaults and names only
|
|
10
|
+
* what this suite deliberately runs on instead: a plan with something on it and
|
|
11
|
+
* an ordinary, cloudy forecast.
|
|
12
|
+
*
|
|
13
|
+
* Settings need no fixture of their own: the tests pass the generated
|
|
14
|
+
* `defaultSettings`, and `meta`, the roster and the callbacks are `logicArgs`'s
|
|
15
|
+
* to fill (`@seriousgaming/sdk/testing`).
|
|
11
16
|
*/
|
|
12
|
-
export const baseSettings: Settings = {
|
|
13
|
-
menu: {
|
|
14
|
-
Capacity: 120,
|
|
15
|
-
Menu: {
|
|
16
|
-
lemonade: { Name: 'Lemonade', Order: 1, Cost: 15, Price: 50 },
|
|
17
|
-
icedtea: { Name: 'Iced tea', Order: 2, Cost: 20, Price: 60 },
|
|
18
|
-
cookies: { Name: 'Cookies', Order: 3, Cost: 25, Price: 70 },
|
|
19
|
-
},
|
|
20
|
-
},
|
|
21
|
-
engine: {
|
|
22
|
-
UsualDemand: { lemonade: 55, icedtea: 30, cookies: 20 },
|
|
23
|
-
SunnyPull: 1.3,
|
|
24
|
-
RainyPull: 0.65,
|
|
25
|
-
Variation: 0.2,
|
|
26
|
-
},
|
|
27
|
-
};
|
|
28
|
-
|
|
29
17
|
export const baseContext: Context = {
|
|
18
|
+
...defaultContext,
|
|
30
19
|
plan: { Make: { lemonade: 28, icedtea: 15, cookies: 10 } },
|
|
31
20
|
weather: { Today: 'cloudy', Expected: { lemonade: 55, icedtea: 30, cookies: 20 } },
|
|
32
|
-
results: {
|
|
33
|
-
Day: 0,
|
|
34
|
-
Weather: 'cloudy',
|
|
35
|
-
Lines: {},
|
|
36
|
-
Takings: 0,
|
|
37
|
-
Spent: 0,
|
|
38
|
-
Profit: 0,
|
|
39
|
-
Purse: 0,
|
|
40
|
-
},
|
|
41
|
-
};
|
|
42
|
-
|
|
43
|
-
/**
|
|
44
|
-
* The `meta` the runtime supplies. `seed` is fixed, so the weather and the
|
|
45
|
-
* day's custom are the same every run: this game derives both from it rather
|
|
46
|
-
* than drawing them, which is what makes a test like this possible at all.
|
|
47
|
-
*/
|
|
48
|
-
export const baseMeta: TeamRunMeta = {
|
|
49
|
-
tick: 1,
|
|
50
|
-
locale: 'en',
|
|
51
|
-
teamId: 'team-1',
|
|
52
|
-
index: 0,
|
|
53
|
-
seed: 'lemonade-test-seed',
|
|
54
|
-
runKind: 'session',
|
|
55
|
-
now: 0,
|
|
56
|
-
};
|
|
57
|
-
|
|
58
|
-
/**
|
|
59
|
-
* The engine declares no `uses`, so every gated callback throws rather than
|
|
60
|
-
* returning a benign value: a call that reaches one is a declaration bug, and a
|
|
61
|
-
* test that quietly passes hides it.
|
|
62
|
-
*
|
|
63
|
-
* The ungated ones are a different case. They need no declaration, so reaching
|
|
64
|
-
* one is legitimate, and they answer as a session with nothing in it would.
|
|
65
|
-
*/
|
|
66
|
-
export const callbacks = {
|
|
67
|
-
generateText: async () => {
|
|
68
|
-
throw new Error('generateText is not declared by this engine');
|
|
69
|
-
},
|
|
70
|
-
readAsset: async () => {
|
|
71
|
-
throw new Error('readAsset reached, but this engine references no assets');
|
|
72
|
-
},
|
|
73
|
-
getPastState: async () => [],
|
|
21
|
+
results: { ...defaultContext.results, Weather: 'cloudy' },
|
|
74
22
|
};
|
|
@@ -1,38 +1,32 @@
|
|
|
1
|
+
import { logicArgs } from '@seriousgaming/sdk/testing';
|
|
1
2
|
import { describe, expect, it } from 'vitest';
|
|
2
3
|
|
|
3
|
-
import
|
|
4
|
+
import { defaultContext, defaultSettings } from '../defaults';
|
|
5
|
+
import type { Settings, Context } from '../types';
|
|
4
6
|
import { Run } from './logic';
|
|
5
7
|
|
|
6
|
-
const
|
|
7
|
-
const settings: Settings = {
|
|
8
|
-
menu: {
|
|
9
|
-
Capacity: 120,
|
|
10
|
-
Menu: {
|
|
11
|
-
lemonade: { Name: 'Lemonade', Order: 1, Cost: 15, Price: 50 },
|
|
12
|
-
icedtea: { Name: 'Iced tea', Order: 2, Cost: 20, Price: 60 },
|
|
13
|
-
cookies: { Name: 'Cookies', Order: 3, Cost: 25, Price: 70 },
|
|
14
|
-
},
|
|
15
|
-
},
|
|
16
|
-
};
|
|
8
|
+
const empty: Context = { ...defaultContext, roles: { LooksAfter: {} } };
|
|
17
9
|
|
|
18
|
-
const
|
|
19
|
-
|
|
20
|
-
|
|
10
|
+
const join = async (
|
|
11
|
+
context: Context,
|
|
12
|
+
id: string,
|
|
13
|
+
index: number,
|
|
14
|
+
settings: Settings = defaultSettings
|
|
15
|
+
) =>
|
|
21
16
|
(
|
|
22
|
-
await Run(
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
})
|
|
17
|
+
await Run(
|
|
18
|
+
logicArgs.hook({
|
|
19
|
+
context,
|
|
20
|
+
settings,
|
|
21
|
+
participant: {
|
|
22
|
+
id,
|
|
23
|
+
teamId: 'team-1',
|
|
24
|
+
name: `Participant ${index + 1}`,
|
|
25
|
+
index,
|
|
26
|
+
connected: true,
|
|
27
|
+
},
|
|
28
|
+
})
|
|
29
|
+
)
|
|
36
30
|
).capabilities;
|
|
37
31
|
|
|
38
32
|
describe('Run', () => {
|
|
@@ -69,7 +63,7 @@ describe('Run', () => {
|
|
|
69
63
|
|
|
70
64
|
it('does nothing when the menu is empty', async () => {
|
|
71
65
|
const result = await join(empty, 'participant-1', 0, {
|
|
72
|
-
menu: { ...
|
|
66
|
+
menu: { ...defaultSettings.menu, Menu: {} },
|
|
73
67
|
});
|
|
74
68
|
|
|
75
69
|
expect(result.roles.LooksAfter).toEqual({});
|
|
@@ -28,11 +28,11 @@ function RootWrapper({ children }: { children: React.ReactNode }) {
|
|
|
28
28
|
const { locale } = useSessionUserInterfaceLocale();
|
|
29
29
|
|
|
30
30
|
useEffect(() => {
|
|
31
|
-
|
|
32
|
-
i18n.changeLanguage(
|
|
31
|
+
// The whole tag, so i18next falls back through it: zh-Hant-TW, zh-Hant, zh.
|
|
32
|
+
i18n.changeLanguage(locale);
|
|
33
33
|
}, [locale]);
|
|
34
34
|
|
|
35
|
-
const isRtl = i18n.dir(locale
|
|
35
|
+
const isRtl = i18n.dir(locale) === 'rtl';
|
|
36
36
|
|
|
37
37
|
return <CacheProvider value={isRtl ? cacheRtl : cacheLtr}>{children}</CacheProvider>;
|
|
38
38
|
}
|
|
@@ -28,11 +28,11 @@ function RootWrapper({ children }: { children: React.ReactNode }) {
|
|
|
28
28
|
const { locale } = useUserInterfaceLocale();
|
|
29
29
|
|
|
30
30
|
useEffect(() => {
|
|
31
|
-
|
|
32
|
-
i18n.changeLanguage(
|
|
31
|
+
// The whole tag, so i18next falls back through it: zh-Hant-TW, zh-Hant, zh.
|
|
32
|
+
i18n.changeLanguage(locale);
|
|
33
33
|
}, [locale]);
|
|
34
34
|
|
|
35
|
-
const isRtl = i18n.dir(locale
|
|
35
|
+
const isRtl = i18n.dir(locale) === 'rtl';
|
|
36
36
|
|
|
37
37
|
return <CacheProvider value={isRtl ? cacheRtl : cacheLtr}>{children}</CacheProvider>;
|
|
38
38
|
}
|
|
@@ -1,47 +1,24 @@
|
|
|
1
|
+
import { logicArgs } from '@seriousgaming/sdk/testing';
|
|
1
2
|
import { describe, expect, it } from 'vitest';
|
|
2
3
|
|
|
3
|
-
import
|
|
4
|
+
import { defaultSettings } from '../defaults';
|
|
5
|
+
import type { Context } from '../types';
|
|
4
6
|
import { UpdateData } from './logic';
|
|
5
7
|
|
|
6
|
-
const actor = {
|
|
7
|
-
role: 'participant',
|
|
8
|
-
participant: {
|
|
9
|
-
id: 'participant-1',
|
|
10
|
-
teamId: 'team-1',
|
|
11
|
-
name: 'Ada',
|
|
12
|
-
index: 0,
|
|
13
|
-
connected: true,
|
|
14
|
-
},
|
|
15
|
-
} as const;
|
|
16
|
-
|
|
17
|
-
const settings: Settings = {
|
|
18
|
-
menu: {
|
|
19
|
-
Capacity: 120,
|
|
20
|
-
Menu: {
|
|
21
|
-
lemonade: { Name: 'Lemonade', Order: 1, Cost: 15, Price: 50 },
|
|
22
|
-
icedtea: { Name: 'Iced tea', Order: 2, Cost: 20, Price: 60 },
|
|
23
|
-
cookies: { Name: 'Cookies', Order: 3, Cost: 25, Price: 70 },
|
|
24
|
-
},
|
|
25
|
-
},
|
|
26
|
-
};
|
|
27
|
-
|
|
28
8
|
const START = { lemonade: 40, icedtea: 20, cookies: 10 };
|
|
29
9
|
|
|
30
10
|
/** `next` is the merged state the write would produce, which is what the host hands a validator. */
|
|
31
11
|
const verdict = (
|
|
32
|
-
made:
|
|
33
|
-
over: { previous?:
|
|
12
|
+
made: Context['plan']['Make'],
|
|
13
|
+
over: { previous?: Context['plan']['Make'] } = {}
|
|
34
14
|
) =>
|
|
35
|
-
UpdateData(
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
settings,
|
|
43
|
-
meta: { locale: 'en', seed: 'lemonade-test-seed', runKind: 'session', now: 0 },
|
|
44
|
-
});
|
|
15
|
+
UpdateData(
|
|
16
|
+
logicArgs.validator({
|
|
17
|
+
previous: { plan: { Make: { ...START, ...over.previous } } },
|
|
18
|
+
next: { plan: { Make: { ...START, ...over.previous, ...made } } },
|
|
19
|
+
settings: defaultSettings,
|
|
20
|
+
})
|
|
21
|
+
);
|
|
45
22
|
|
|
46
23
|
describe('UpdateData', () => {
|
|
47
24
|
it('accepts a plan the stall can make', async () => {
|
|
@@ -28,11 +28,11 @@ function RootWrapper({ children }: { children: React.ReactNode }) {
|
|
|
28
28
|
const { locale } = useUserInterfaceLocale();
|
|
29
29
|
|
|
30
30
|
useEffect(() => {
|
|
31
|
-
|
|
32
|
-
i18n.changeLanguage(
|
|
31
|
+
// The whole tag, so i18next falls back through it: zh-Hant-TW, zh-Hant, zh.
|
|
32
|
+
i18n.changeLanguage(locale);
|
|
33
33
|
}, [locale]);
|
|
34
34
|
|
|
35
|
-
const isRtl = i18n.dir(locale
|
|
35
|
+
const isRtl = i18n.dir(locale) === 'rtl';
|
|
36
36
|
|
|
37
37
|
return <CacheProvider value={isRtl ? cacheRtl : cacheLtr}>{children}</CacheProvider>;
|
|
38
38
|
}
|
|
@@ -4,7 +4,7 @@ import {
|
|
|
4
4
|
UserInterfaceThemeContext,
|
|
5
5
|
UserInterfaceDataContext,
|
|
6
6
|
} from '@seriousgaming/sdk/ui';
|
|
7
|
-
import {
|
|
7
|
+
import { createMockUserInterfaceTheme } from '@seriousgaming/sdk/ui/testing';
|
|
8
8
|
import './i18n';
|
|
9
9
|
import App from './App';
|
|
10
10
|
|
|
@@ -12,7 +12,7 @@ import App from './App';
|
|
|
12
12
|
// These replace the iframe communication that the real app uses — no mocking needed.
|
|
13
13
|
const renderApp = (data = {}, settings = {}) =>
|
|
14
14
|
render(
|
|
15
|
-
<UserInterfaceThemeContext.Provider value={
|
|
15
|
+
<UserInterfaceThemeContext.Provider value={createMockUserInterfaceTheme()}>
|
|
16
16
|
<UserInterfaceDataContext.Provider
|
|
17
17
|
value={{ data, settings, completedTicks: 0, isRoundProcessing: false, setData: vi.fn() }}
|
|
18
18
|
>
|
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
import React, { useState } from 'react';
|
|
2
2
|
import {
|
|
3
|
+
Alert,
|
|
3
4
|
Box,
|
|
4
5
|
Button,
|
|
5
6
|
CssBaseline,
|
|
6
7
|
ThemeProvider,
|
|
7
8
|
Typography,
|
|
8
9
|
} from '@mui/material';
|
|
9
|
-
import { useUserInterfaceData } from '@seriousgaming/sdk/ui';
|
|
10
|
+
import { useMutationReporter, useUserInterfaceData } from '@seriousgaming/sdk/ui';
|
|
10
11
|
import { useTranslation } from 'react-i18next';
|
|
11
12
|
import { Context, Settings } from '../types';
|
|
12
13
|
import { useAppTheme } from './theme';
|
|
@@ -50,11 +51,12 @@ shared state, follow these steps:
|
|
|
50
51
|
2. In your ui.sdk.json, add "uicounter" to the `writes` array.
|
|
51
52
|
|
|
52
53
|
3. In this file (App.tsx), uncomment the lines related to `useUserInterfaceData`
|
|
53
|
-
to connect the component to the capability.
|
|
54
|
+
and `useMutationReporter` to connect the component to the capability.
|
|
54
55
|
*/
|
|
55
56
|
|
|
56
57
|
function App() {
|
|
57
58
|
// const { data, setData } = useUserInterfaceData<Context, Settings>();
|
|
59
|
+
// const reporter = useMutationReporter();
|
|
58
60
|
const { t } = useTranslation();
|
|
59
61
|
const theme = useAppTheme();
|
|
60
62
|
const [localCounter, setLocalCounter] = useState(0);
|
|
@@ -65,18 +67,20 @@ function App() {
|
|
|
65
67
|
const counterValue = localCounter;
|
|
66
68
|
// const counterValue = data.uicounter.value;
|
|
67
69
|
|
|
68
|
-
const handleIncrement = () => {
|
|
70
|
+
const handleIncrement = async () => {
|
|
69
71
|
// This is a local state update example.
|
|
70
72
|
setLocalCounter((c) => c + 1);
|
|
71
73
|
|
|
72
|
-
// To send data to the game,
|
|
73
|
-
// setData
|
|
74
|
-
//
|
|
75
|
-
//
|
|
76
|
-
//
|
|
77
|
-
//
|
|
78
|
-
//
|
|
79
|
-
// }
|
|
74
|
+
// To send data to the game, replace the line above with the call below.
|
|
75
|
+
// `setData` rejects when the host refuses the write, so await it through
|
|
76
|
+
// the reporter, which keeps the refusal for the notice rendered below.
|
|
77
|
+
// `uicounter` is declared in `writes`, so it is always present: spread
|
|
78
|
+
// it to keep its other variables, with no fallback.
|
|
79
|
+
// await reporter.run(() =>
|
|
80
|
+
// setData({
|
|
81
|
+
// uicounter: { ...data.uicounter, value: data.uicounter.value + 1 },
|
|
82
|
+
// })
|
|
83
|
+
// );
|
|
80
84
|
};
|
|
81
85
|
|
|
82
86
|
return (
|
|
@@ -91,10 +95,17 @@ function App() {
|
|
|
91
95
|
{t('currentValue', { value: counterValue })}
|
|
92
96
|
</Typography>
|
|
93
97
|
<Box>
|
|
98
|
+
{/* Once connected, add disabled={reporter.pending} while a write is in flight. */}
|
|
94
99
|
<Button variant="contained" onClick={handleIncrement}>
|
|
95
100
|
{t('updateButton')}
|
|
96
101
|
</Button>
|
|
97
102
|
</Box>
|
|
103
|
+
{/* Uncomment to tell the participant when a write did not land.
|
|
104
|
+
{reporter.failure && (
|
|
105
|
+
<Alert severity="error" onClose={reporter.dismiss}>
|
|
106
|
+
{t('writeFailed')}
|
|
107
|
+
</Alert>
|
|
108
|
+
)} */}
|
|
98
109
|
</Box>
|
|
99
110
|
</ThemeProvider>
|
|
100
111
|
);
|
|
@@ -11,6 +11,7 @@ const resources = {
|
|
|
11
11
|
"The component below demonstrates reading and writing data to the game's shared state by using a capability.",
|
|
12
12
|
currentValue: 'Current value: {% raw %}{{value}}{% endraw %}',
|
|
13
13
|
updateButton: 'Increment Value',
|
|
14
|
+
writeFailed: 'That change did not reach the game. Please try again.',
|
|
14
15
|
},
|
|
15
16
|
},
|
|
16
17
|
it: {
|
|
@@ -21,6 +22,7 @@ const resources = {
|
|
|
21
22
|
'Il componente sottostante dimostra come leggere e scrivere dati nello stato condiviso della simulazione utilizzando una capability.',
|
|
22
23
|
currentValue: 'Valore corrente: {% raw %}{{value}}{% endraw %}',
|
|
23
24
|
updateButton: 'Incrementa valore',
|
|
25
|
+
writeFailed: 'La modifica non ha raggiunto la simulazione. Riprova.',
|
|
24
26
|
},
|
|
25
27
|
},
|
|
26
28
|
ar: {
|
|
@@ -31,6 +33,7 @@ const resources = {
|
|
|
31
33
|
'يوضح المكون أدناه قراءة البيانات وكتابتها إلى الحالة المشتركة للمحاكاة باستخدام إحدى الإمكانات.',
|
|
32
34
|
currentValue: 'القيمة الحالية: {% raw %}{{value}}{% endraw %}',
|
|
33
35
|
updateButton: 'زيادة القيمة',
|
|
36
|
+
writeFailed: 'لم يصل هذا التغيير إلى المحاكاة. يرجى المحاولة مرة أخرى.',
|
|
34
37
|
},
|
|
35
38
|
},
|
|
36
39
|
};
|
|
@@ -28,11 +28,11 @@ function RootWrapper({ children }: { children: React.ReactNode }) {
|
|
|
28
28
|
const { locale } = useUserInterfaceLocale();
|
|
29
29
|
|
|
30
30
|
useEffect(() => {
|
|
31
|
-
|
|
32
|
-
i18n.changeLanguage(
|
|
31
|
+
// The whole tag, so i18next falls back through it: zh-Hant-TW, zh-Hant, zh.
|
|
32
|
+
i18n.changeLanguage(locale);
|
|
33
33
|
}, [locale]);
|
|
34
34
|
|
|
35
|
-
const isRtl = i18n.dir(locale
|
|
35
|
+
const isRtl = i18n.dir(locale) === 'rtl';
|
|
36
36
|
|
|
37
37
|
return <CacheProvider value={isRtl ? cacheRtl : cacheLtr}>{children}</CacheProvider>;
|
|
38
38
|
}
|
|
@@ -1,40 +1,31 @@
|
|
|
1
|
+
import { logicArgs } from '@seriousgaming/sdk/testing';
|
|
1
2
|
import { describe, it, expect } from 'vitest';
|
|
2
|
-
import { UpdateData } from './logic';
|
|
3
|
-
import type { Context, Settings } from '../types';
|
|
4
|
-
import type { LogicMeta } from '@seriousgaming/sdk';
|
|
5
3
|
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
// the operation started.
|
|
9
|
-
const meta: LogicMeta = { locale: 'en', seed: 'test-seed', runKind: 'session', now: Date.UTC(2026, 0, 1) };
|
|
4
|
+
import { defaultContext, defaultSettings } from '../defaults';
|
|
5
|
+
import { UpdateData } from './logic';
|
|
10
6
|
|
|
11
|
-
//
|
|
12
|
-
//
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
index: 0,
|
|
20
|
-
connected: true,
|
|
21
|
-
},
|
|
22
|
-
} as const;
|
|
7
|
+
// `defaultContext` and `defaultSettings` are generated beside the types, from
|
|
8
|
+
// the very schemas they satisfy: the values a session opens with. Spread them
|
|
9
|
+
// and name only what the case is about.
|
|
10
|
+
//
|
|
11
|
+
// `logicArgs.validator` fills everything else: `meta` (a fixed locale, seed
|
|
12
|
+
// and clock), a roster of one participant on `team-1`, and that participant
|
|
13
|
+
// as the actor. Pass `actor: { role: 'observer', teamId: 'team-1' }` to cover
|
|
14
|
+
// a facilitator observing the team on the same surface.
|
|
23
15
|
|
|
24
16
|
describe('{{ identifier }}', () => {
|
|
25
17
|
describe('UpdateData', () => {
|
|
26
18
|
it('accepts a valid mutation', async () => {
|
|
27
|
-
const
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
const result = await UpdateData({ previous, next, actor, settings, meta, participants: [actor.participant] });
|
|
19
|
+
const result = await UpdateData(
|
|
20
|
+
logicArgs.validator({
|
|
21
|
+
// TODO: override the capabilities this case is about
|
|
22
|
+
previous: { ...defaultContext },
|
|
23
|
+
// TODO: add the proposed next-state values
|
|
24
|
+
next: { ...defaultContext },
|
|
25
|
+
// TODO: override the settings this case is about
|
|
26
|
+
settings: { ...defaultSettings },
|
|
27
|
+
})
|
|
28
|
+
);
|
|
38
29
|
|
|
39
30
|
expect(result.ok).toBe(true);
|
|
40
31
|
});
|
|
@@ -7,7 +7,7 @@ import {
|
|
|
7
7
|
UserInterfaceParticipantsContext,
|
|
8
8
|
UserInterfaceThemeContext,
|
|
9
9
|
} from '@seriousgaming/sdk/ui';
|
|
10
|
-
import {
|
|
10
|
+
import { createMockUserInterfaceTheme } from '@seriousgaming/sdk/ui/testing';
|
|
11
11
|
import './i18n';
|
|
12
12
|
import App from './App';
|
|
13
13
|
|
|
@@ -21,7 +21,7 @@ const ROSTER = [
|
|
|
21
21
|
|
|
22
22
|
const renderApp = (completedTicks = 0) =>
|
|
23
23
|
render(
|
|
24
|
-
<UserInterfaceThemeContext.Provider value={
|
|
24
|
+
<UserInterfaceThemeContext.Provider value={createMockUserInterfaceTheme()}>
|
|
25
25
|
<UserInterfaceDataContext.Provider
|
|
26
26
|
value={{ data: {}, settings: {}, completedTicks, isRoundProcessing: false, setData: vi.fn() }}
|
|
27
27
|
>
|
|
@@ -28,11 +28,11 @@ function RootWrapper({ children }: { children: React.ReactNode }) {
|
|
|
28
28
|
const { locale } = useUserInterfaceLocale();
|
|
29
29
|
|
|
30
30
|
useEffect(() => {
|
|
31
|
-
|
|
32
|
-
i18n.changeLanguage(
|
|
31
|
+
// The whole tag, so i18next falls back through it: zh-Hant-TW, zh-Hant, zh.
|
|
32
|
+
i18n.changeLanguage(locale);
|
|
33
33
|
}, [locale]);
|
|
34
34
|
|
|
35
|
-
const isRtl = i18n.dir(locale
|
|
35
|
+
const isRtl = i18n.dir(locale) === 'rtl';
|
|
36
36
|
|
|
37
37
|
return <CacheProvider value={isRtl ? cacheRtl : cacheLtr}>{children}</CacheProvider>;
|
|
38
38
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@seriousgaming/sdk-tools",
|
|
3
|
-
"version": "1.0.0
|
|
3
|
+
"version": "1.0.0",
|
|
4
4
|
"description": "SDK tooling for building Serious Gaming games",
|
|
5
5
|
"homepage": "https://sdk.seriousgaming.com/",
|
|
6
6
|
"license": "SEE LICENSE IN LICENSE",
|
|
@@ -68,7 +68,7 @@
|
|
|
68
68
|
"@mui/icons-material": "^9.4.0",
|
|
69
69
|
"@mui/material": "^9.4.0",
|
|
70
70
|
"@playwright/test": "^1.64.0",
|
|
71
|
-
"@seriousgaming/sdk": "1.0.0
|
|
71
|
+
"@seriousgaming/sdk": "1.0.0",
|
|
72
72
|
"@testing-library/jest-dom": "^7.0.1",
|
|
73
73
|
"@testing-library/react": "^16.3.3",
|
|
74
74
|
"@types/adm-zip": "^0.5.8",
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
"vitest": "^5.0.3"
|
|
99
99
|
},
|
|
100
100
|
"peerDependencies": {
|
|
101
|
-
"@seriousgaming/sdk": "^1.0.0
|
|
101
|
+
"@seriousgaming/sdk": "^1.0.0"
|
|
102
102
|
},
|
|
103
103
|
"engines": {
|
|
104
104
|
"node": ">=24"
|