@contractspec/example.learning-journey-studio-onboarding 3.7.6 → 3.7.7
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/.turbo/turbo-build.log +3 -3
- package/AGENTS.md +48 -26
- package/README.md +62 -31
- package/dist/browser/index.js +50 -50
- package/dist/browser/operations/index.js +1 -1
- package/dist/browser/presentations/index.js +1 -1
- package/dist/index.d.ts +4 -4
- package/dist/index.js +50 -50
- package/dist/node/index.js +50 -50
- package/dist/node/operations/index.js +1 -1
- package/dist/node/presentations/index.js +1 -1
- package/dist/operations/index.js +1 -1
- package/dist/presentations/index.js +1 -1
- package/package.json +5 -5
- package/src/docs/studio-onboarding.docblock.ts +11 -11
- package/src/example.ts +25 -25
- package/src/handlers/demo.handlers.ts +27 -27
- package/src/index.ts +4 -4
- package/src/learning-journey-studio-onboarding.feature.ts +51 -51
- package/src/operations/index.test.ts +36 -37
- package/src/operations/index.ts +93 -93
- package/src/presentations/index.ts +41 -41
- package/src/tests/operations.test-spec.ts +27 -27
- package/src/track.ts +79 -79
- package/tsconfig.json +7 -7
- package/tsdown.config.js +7 -13
|
@@ -1,57 +1,57 @@
|
|
|
1
1
|
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
definePresentation,
|
|
3
|
+
type PresentationSpecMeta,
|
|
4
|
+
StabilityEnum,
|
|
5
5
|
} from '@contractspec/lib.contracts-spec';
|
|
6
6
|
import { StudioOnboardingTrackModel } from '../operations';
|
|
7
7
|
|
|
8
8
|
const baseMeta: Pick<
|
|
9
|
-
|
|
10
|
-
|
|
9
|
+
PresentationSpecMeta,
|
|
10
|
+
'domain' | 'owners' | 'tags' | 'title' | 'stability'
|
|
11
11
|
> = {
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
12
|
+
domain: 'learning-journey',
|
|
13
|
+
title: 'Studio Onboarding',
|
|
14
|
+
owners: ['@examples.learning-journey.studio-onboarding'] as string[],
|
|
15
|
+
tags: ['learning', 'onboarding', 'studio'] as string[],
|
|
16
|
+
stability: StabilityEnum.Experimental,
|
|
17
17
|
};
|
|
18
18
|
|
|
19
19
|
export const StudioOnboardingTrackPresentation = definePresentation({
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
20
|
+
meta: {
|
|
21
|
+
key: 'learning.journey.studio.track',
|
|
22
|
+
version: '1.0.0',
|
|
23
|
+
description: 'Studio onboarding track detail',
|
|
24
|
+
goal: 'Visualize the onboarding track for the user.',
|
|
25
|
+
context: 'Displayed in the Studio dashboard.',
|
|
26
|
+
...baseMeta,
|
|
27
|
+
},
|
|
28
|
+
source: {
|
|
29
|
+
type: 'component',
|
|
30
|
+
framework: 'react',
|
|
31
|
+
componentKey: 'LearningTrackDetail',
|
|
32
|
+
props: StudioOnboardingTrackModel,
|
|
33
|
+
},
|
|
34
|
+
targets: ['react', 'markdown', 'application/json'],
|
|
35
35
|
});
|
|
36
36
|
|
|
37
37
|
export const StudioOnboardingWidgetPresentation = definePresentation({
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
38
|
+
meta: {
|
|
39
|
+
key: 'learning.journey.studio.widget',
|
|
40
|
+
version: '1.0.0',
|
|
41
|
+
description: 'Compact widget for Studio onboarding progress',
|
|
42
|
+
goal: 'Show quick progress summary.',
|
|
43
|
+
context: 'Displayed in the Studio sidebar or header.',
|
|
44
|
+
...baseMeta,
|
|
45
|
+
},
|
|
46
|
+
source: {
|
|
47
|
+
type: 'component',
|
|
48
|
+
framework: 'react',
|
|
49
|
+
componentKey: 'LearningTrackProgressWidget',
|
|
50
|
+
},
|
|
51
|
+
targets: ['react'],
|
|
52
52
|
});
|
|
53
53
|
|
|
54
54
|
export const studioOnboardingPresentations = [
|
|
55
|
-
|
|
56
|
-
|
|
55
|
+
StudioOnboardingTrackPresentation,
|
|
56
|
+
StudioOnboardingWidgetPresentation,
|
|
57
57
|
];
|
|
@@ -1,31 +1,31 @@
|
|
|
1
1
|
import { defineTestSpec } from '@contractspec/lib.contracts-spec/tests';
|
|
2
2
|
|
|
3
3
|
export const GetTrackTest = defineTestSpec({
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
4
|
+
meta: {
|
|
5
|
+
key: 'learningJourney.studioOnboarding.getTrack.test',
|
|
6
|
+
version: '1.0.0',
|
|
7
|
+
stability: 'experimental',
|
|
8
|
+
owners: ['@example.learning-journey-studio-onboarding'],
|
|
9
|
+
description: 'Test for getting studio onboarding track',
|
|
10
|
+
tags: ['test'],
|
|
11
|
+
},
|
|
12
|
+
target: {
|
|
13
|
+
type: 'operation',
|
|
14
|
+
operation: {
|
|
15
|
+
key: 'learningJourney.studioOnboarding.getTrack',
|
|
16
|
+
version: '1.0.0',
|
|
17
|
+
},
|
|
18
|
+
},
|
|
19
|
+
scenarios: [
|
|
20
|
+
{
|
|
21
|
+
key: 'success',
|
|
22
|
+
when: { operation: { key: 'learningJourney.studioOnboarding.getTrack' } },
|
|
23
|
+
then: [{ type: 'expectOutput', match: {} }],
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
key: 'error',
|
|
27
|
+
when: { operation: { key: 'learningJourney.studioOnboarding.getTrack' } },
|
|
28
|
+
then: [{ type: 'expectError' }],
|
|
29
|
+
},
|
|
30
|
+
],
|
|
31
31
|
});
|
package/src/track.ts
CHANGED
|
@@ -1,86 +1,86 @@
|
|
|
1
1
|
import type { LearningJourneyTrackSpec } from '@contractspec/module.learning-journey/track-spec';
|
|
2
2
|
|
|
3
3
|
export const studioGettingStartedTrack: LearningJourneyTrackSpec = {
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
4
|
+
id: 'studio_getting_started',
|
|
5
|
+
productId: 'contractspec-studio',
|
|
6
|
+
name: 'Studio Getting Started',
|
|
7
|
+
description:
|
|
8
|
+
'First 30 minutes in Studio: create a project, edit the spec, deploy/regenerate, and try key modules.',
|
|
9
|
+
targetUserSegment: 'new_studio_user',
|
|
10
|
+
targetRole: 'developer',
|
|
11
|
+
totalXp: 110,
|
|
12
|
+
streakRule: { hoursWindow: 48, bonusXp: 25 },
|
|
13
|
+
completionRewards: { xpBonus: 25, badgeKey: 'studio_first_30m' },
|
|
14
|
+
steps: [
|
|
15
|
+
{
|
|
16
|
+
id: 'choose_template',
|
|
17
|
+
title: 'Choose a template',
|
|
18
|
+
description: 'Create your first Studio project (starter template).',
|
|
19
|
+
order: 1,
|
|
20
|
+
completion: {
|
|
21
|
+
eventName: 'studio.template.instantiated',
|
|
22
|
+
sourceModule: '@contractspec/bundle.studio',
|
|
23
|
+
},
|
|
24
|
+
xpReward: 20,
|
|
25
|
+
metadata: { surface: 'projects' },
|
|
26
|
+
},
|
|
27
|
+
{
|
|
28
|
+
id: 'edit_spec',
|
|
29
|
+
title: 'Edit the spec',
|
|
30
|
+
description: 'Change the spec (not generated code) and save.',
|
|
31
|
+
instructions: 'Open spec editor, tweak a contract or presentation, save.',
|
|
32
|
+
order: 2,
|
|
33
|
+
completion: {
|
|
34
|
+
eventName: 'spec.changed',
|
|
35
|
+
sourceModule: '@contractspec/bundle.studio',
|
|
36
|
+
},
|
|
37
|
+
xpReward: 20,
|
|
38
|
+
metadata: { surface: 'spec-editor' },
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
id: 'regenerate_app',
|
|
42
|
+
title: 'Regenerate the app',
|
|
43
|
+
description: 'Regenerate artifacts from the updated spec.',
|
|
44
|
+
order: 3,
|
|
45
|
+
completion: {
|
|
46
|
+
eventName: 'regeneration.completed',
|
|
47
|
+
sourceModule: '@contractspec/lib.contracts-spec/regenerator',
|
|
48
|
+
},
|
|
49
|
+
xpReward: 20,
|
|
50
|
+
metadata: { surface: 'regenerator' },
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
id: 'open_canvas',
|
|
54
|
+
title: 'Open the canvas',
|
|
55
|
+
description: 'Visit the canvas module for your project.',
|
|
56
|
+
order: 4,
|
|
57
|
+
completion: {
|
|
58
|
+
eventName: 'module.navigated',
|
|
59
|
+
sourceModule: '@contractspec/bundle.studio',
|
|
60
|
+
payloadFilter: { moduleId: 'canvas' },
|
|
61
|
+
},
|
|
62
|
+
xpReward: 20,
|
|
63
|
+
metadata: { surface: 'canvas' },
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
id: 'try_evolution_mode',
|
|
67
|
+
title: 'Try evolution mode',
|
|
68
|
+
description: 'Request a change via Evolution, then regenerate.',
|
|
69
|
+
order: 5,
|
|
70
|
+
completion: {
|
|
71
|
+
eventName: 'studio.evolution.applied',
|
|
72
|
+
sourceModule: '@contractspec/lib.evolution',
|
|
73
|
+
},
|
|
74
|
+
xpReward: 30,
|
|
75
|
+
metadata: { surface: 'evolution' },
|
|
76
|
+
},
|
|
77
|
+
],
|
|
78
|
+
metadata: {
|
|
79
|
+
persona: 'first_run',
|
|
80
|
+
surfacedIn: ['studio/home', 'studio/sidebar/learning'],
|
|
81
|
+
},
|
|
82
82
|
};
|
|
83
83
|
|
|
84
84
|
export const studioLearningTracks: LearningJourneyTrackSpec[] = [
|
|
85
|
-
|
|
85
|
+
studioGettingStartedTrack,
|
|
86
86
|
];
|
package/tsconfig.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
2
|
+
"extends": "@contractspec/tool.typescript/react-library.json",
|
|
3
|
+
"include": ["src"],
|
|
4
|
+
"exclude": ["node_modules"],
|
|
5
|
+
"compilerOptions": {
|
|
6
|
+
"rootDir": "src",
|
|
7
|
+
"outDir": "dist"
|
|
8
|
+
}
|
|
9
9
|
}
|
package/tsdown.config.js
CHANGED
|
@@ -1,16 +1,10 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import {
|
|
2
|
+
defineConfig,
|
|
3
|
+
moduleLibrary,
|
|
4
|
+
withDevExports,
|
|
5
|
+
} from '@contractspec/tool.bun';
|
|
2
6
|
|
|
3
7
|
export default defineConfig(() => ({
|
|
4
|
-
|
|
5
|
-
|
|
8
|
+
...moduleLibrary,
|
|
9
|
+
...withDevExports,
|
|
6
10
|
}));
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|