@contractspec/example.learning-journey-ui-onboarding 3.7.6 → 3.7.10
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 +50 -24
- package/CHANGELOG.md +34 -0
- package/README.md +66 -26
- package/dist/OnboardingMiniApp.js +280 -280
- package/dist/browser/OnboardingMiniApp.js +280 -280
- package/dist/browser/components/CodeSnippet.js +4 -4
- package/dist/browser/components/JourneyMap.js +1 -1
- package/dist/browser/components/StepChecklist.js +6 -6
- package/dist/browser/components/index.js +11 -11
- package/dist/browser/index.js +285 -284
- package/dist/browser/views/Overview.js +14 -14
- package/dist/browser/views/Progress.js +9 -9
- package/dist/browser/views/Steps.js +8 -8
- package/dist/browser/views/Timeline.js +6 -6
- package/dist/browser/views/index.js +276 -276
- package/dist/components/CodeSnippet.js +4 -4
- package/dist/components/JourneyMap.js +1 -1
- package/dist/components/StepChecklist.js +6 -6
- package/dist/components/index.d.ts +1 -1
- package/dist/components/index.js +11 -11
- package/dist/index.d.ts +4 -4
- package/dist/index.js +285 -284
- package/dist/node/OnboardingMiniApp.js +280 -280
- package/dist/node/components/CodeSnippet.js +4 -4
- package/dist/node/components/JourneyMap.js +1 -1
- package/dist/node/components/StepChecklist.js +6 -6
- package/dist/node/components/index.js +11 -11
- package/dist/node/index.js +285 -284
- package/dist/node/views/Overview.js +14 -14
- package/dist/node/views/Progress.js +9 -9
- package/dist/node/views/Steps.js +8 -8
- package/dist/node/views/Timeline.js +6 -6
- package/dist/node/views/index.js +276 -276
- package/dist/views/Overview.js +14 -14
- package/dist/views/Progress.js +9 -9
- package/dist/views/Steps.js +8 -8
- package/dist/views/Timeline.js +6 -6
- package/dist/views/index.d.ts +1 -1
- package/dist/views/index.js +276 -276
- package/package.json +13 -13
- package/src/OnboardingMiniApp.tsx +70 -70
- package/src/components/CodeSnippet.tsx +43 -43
- package/src/components/JourneyMap.tsx +70 -70
- package/src/components/StepChecklist.tsx +118 -118
- package/src/components/index.ts +1 -1
- package/src/docs/learning-journey-ui-onboarding.docblock.ts +11 -11
- package/src/example.ts +25 -25
- package/src/index.ts +5 -6
- package/src/learning-journey-ui-onboarding.feature.ts +12 -12
- package/src/views/Overview.tsx +182 -182
- package/src/views/Progress.tsx +167 -167
- package/src/views/Steps.tsx +79 -79
- package/src/views/Timeline.tsx +126 -126
- package/src/views/index.ts +1 -1
- package/tsconfig.json +7 -8
- package/tsdown.config.js +7 -13
package/.turbo/turbo-build.log
CHANGED
|
@@ -3,7 +3,7 @@ $ bun run prebuild && bun run build:bundle && bun run build:types
|
|
|
3
3
|
$ contractspec-bun-build prebuild
|
|
4
4
|
$ contractspec-bun-build transpile
|
|
5
5
|
[contractspec-bun-build] transpile target=bun root=src entries=15 noBundle=false
|
|
6
|
-
Bundled 15 modules in
|
|
6
|
+
Bundled 15 modules in 48ms
|
|
7
7
|
|
|
8
8
|
./OnboardingMiniApp.js 45.50 KB (entry point)
|
|
9
9
|
./index.js 50.35 KB (entry point)
|
|
@@ -22,7 +22,7 @@ Bundled 15 modules in 42ms
|
|
|
22
22
|
./example.js 0.95 KB (entry point)
|
|
23
23
|
|
|
24
24
|
[contractspec-bun-build] transpile target=node root=src entries=15 noBundle=false
|
|
25
|
-
Bundled 15 modules in
|
|
25
|
+
Bundled 15 modules in 62ms
|
|
26
26
|
|
|
27
27
|
./OnboardingMiniApp.js 45.44 KB (entry point)
|
|
28
28
|
./index.js 50.28 KB (entry point)
|
|
@@ -41,7 +41,7 @@ Bundled 15 modules in 45ms
|
|
|
41
41
|
./example.js 0.94 KB (entry point)
|
|
42
42
|
|
|
43
43
|
[contractspec-bun-build] transpile target=browser root=src entries=15 noBundle=false
|
|
44
|
-
Bundled 15 modules in
|
|
44
|
+
Bundled 15 modules in 29ms
|
|
45
45
|
|
|
46
46
|
./OnboardingMiniApp.js 45.44 KB (entry point)
|
|
47
47
|
./index.js 50.28 KB (entry point)
|
package/AGENTS.md
CHANGED
|
@@ -1,33 +1,59 @@
|
|
|
1
|
-
# AI Agent Guide
|
|
1
|
+
# AI Agent Guide — `@contractspec/example.learning-journey-ui-onboarding`
|
|
2
2
|
|
|
3
3
|
Scope: `packages/examples/learning-journey-ui-onboarding/*`
|
|
4
4
|
|
|
5
|
-
Developer onboarding UI with checklists
|
|
5
|
+
Developer onboarding UI with checklists and journey maps.
|
|
6
6
|
|
|
7
7
|
## Quick Context
|
|
8
8
|
|
|
9
|
-
-
|
|
10
|
-
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
-
|
|
17
|
-
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
-
|
|
22
|
-
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
-
|
|
9
|
+
- Layer: `example`.
|
|
10
|
+
- Package visibility: published package.
|
|
11
|
+
- Primary consumers are example explorers, template authors, and documentation readers.
|
|
12
|
+
- Related packages: `@contractspec/example.learning-journey-platform-tour`, `@contractspec/example.learning-journey-studio-onboarding`, `@contractspec/example.learning-journey-ui-shared`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.design-system`, `@contractspec/lib.ui-kit-core`, ...
|
|
13
|
+
|
|
14
|
+
## Architecture
|
|
15
|
+
|
|
16
|
+
- `src/components/` contains reusable UI components and view composition.
|
|
17
|
+
- `src/docs/` contains docblocks and documentation-facing exports.
|
|
18
|
+
- `src/example.ts` is the runnable example entrypoint.
|
|
19
|
+
- `src/index.ts` is the root public barrel and package entrypoint.
|
|
20
|
+
- `src/learning-journey-ui-onboarding.feature.ts` defines a feature entrypoint.
|
|
21
|
+
- `src/OnboardingMiniApp.tsx` is part of the package's public or composition surface.
|
|
22
|
+
- `src/views/` contains view-level composition.
|
|
23
|
+
|
|
24
|
+
## Public Surface
|
|
25
|
+
|
|
26
|
+
- Export `.` resolves through `./src/index.ts`.
|
|
27
|
+
- Export `./components` resolves through `./src/components/index.ts`.
|
|
28
|
+
- Export `./components/CodeSnippet` resolves through `./src/components/CodeSnippet.tsx`.
|
|
29
|
+
- Export `./components/JourneyMap` resolves through `./src/components/JourneyMap.tsx`.
|
|
30
|
+
- Export `./components/StepChecklist` resolves through `./src/components/StepChecklist.tsx`.
|
|
31
|
+
- Export `./docs` resolves through `./src/docs/index.ts`.
|
|
32
|
+
- Export `./docs/learning-journey-ui-onboarding.docblock` resolves through `./src/docs/learning-journey-ui-onboarding.docblock.ts`.
|
|
33
|
+
- Export `./example` resolves through `./src/example.ts`.
|
|
34
|
+
- Export `./learning-journey-ui-onboarding.feature` resolves through `./src/learning-journey-ui-onboarding.feature.ts`.
|
|
35
|
+
- Export `./OnboardingMiniApp` resolves through `./src/OnboardingMiniApp.tsx`.
|
|
36
|
+
- The package publishes 15 total export subpaths; keep docs aligned with `package.json`.
|
|
37
|
+
|
|
38
|
+
## Guardrails
|
|
39
|
+
|
|
40
|
+
- Keep the example package demonstrative, buildable, and aligned with the exported feature surface.
|
|
41
|
+
- Do not add hidden production assumptions that are not actually implemented in the example.
|
|
42
|
+
- Changes here can affect downstream packages such as `@contractspec/example.learning-journey-platform-tour`, `@contractspec/example.learning-journey-studio-onboarding`, `@contractspec/example.learning-journey-ui-shared`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.design-system`, `@contractspec/lib.ui-kit-core`, ....
|
|
43
|
+
- Changes here can affect downstream packages such as `@contractspec/example.learning-journey-platform-tour`, `@contractspec/example.learning-journey-studio-onboarding`, `@contractspec/example.learning-journey-ui-shared`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.design-system`, `@contractspec/lib.ui-kit-core`, ...
|
|
27
44
|
|
|
28
45
|
## Local Commands
|
|
29
46
|
|
|
30
|
-
-
|
|
31
|
-
-
|
|
32
|
-
-
|
|
33
|
-
-
|
|
47
|
+
- `bun run dev` — contractspec-bun-build dev
|
|
48
|
+
- `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
|
|
49
|
+
- `bun run test` — bun test --pass-with-no-tests
|
|
50
|
+
- `bun run lint` — bun lint:fix
|
|
51
|
+
- `bun run lint:check` — biome check .
|
|
52
|
+
- `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
|
|
53
|
+
- `bun run typecheck` — tsc --noEmit
|
|
54
|
+
- `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose
|
|
55
|
+
- `bun run publish:pkg:canary` — bun publish:pkg --tag canary
|
|
56
|
+
- `bun run clean` — rimraf dist .turbo
|
|
57
|
+
- `bun run build:bundle` — contractspec-bun-build transpile
|
|
58
|
+
- `bun run build:types` — contractspec-bun-build types
|
|
59
|
+
- `bun run prebuild` — contractspec-bun-build prebuild
|
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,35 @@
|
|
|
1
1
|
# @contractspec/example.learning-journey-ui-onboarding
|
|
2
2
|
|
|
3
|
+
## 3.7.10
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- 1a44cb6: feat: improve examples to increase coverage of Contracts type
|
|
8
|
+
- Updated dependencies [1a44cb6]
|
|
9
|
+
- @contractspec/example.learning-journey-studio-onboarding@3.7.10
|
|
10
|
+
- @contractspec/example.learning-journey-platform-tour@3.7.10
|
|
11
|
+
- @contractspec/example.learning-journey-ui-shared@3.7.10
|
|
12
|
+
- @contractspec/module.learning-journey@3.7.10
|
|
13
|
+
- @contractspec/lib.contracts-spec@4.1.2
|
|
14
|
+
- @contractspec/lib.design-system@3.8.3
|
|
15
|
+
- @contractspec/lib.ui-kit-core@3.7.8
|
|
16
|
+
- @contractspec/lib.ui-kit-web@3.9.2
|
|
17
|
+
|
|
18
|
+
## 3.7.9
|
|
19
|
+
|
|
20
|
+
### Patch Changes
|
|
21
|
+
|
|
22
|
+
- fix: release
|
|
23
|
+
- Updated dependencies
|
|
24
|
+
- @contractspec/example.learning-journey-studio-onboarding@3.7.9
|
|
25
|
+
- @contractspec/example.learning-journey-platform-tour@3.7.9
|
|
26
|
+
- @contractspec/example.learning-journey-ui-shared@3.7.9
|
|
27
|
+
- @contractspec/module.learning-journey@3.7.9
|
|
28
|
+
- @contractspec/lib.contracts-spec@4.1.1
|
|
29
|
+
- @contractspec/lib.design-system@3.8.2
|
|
30
|
+
- @contractspec/lib.ui-kit-web@3.9.1
|
|
31
|
+
- @contractspec/lib.ui-kit-core@3.7.7
|
|
32
|
+
|
|
3
33
|
## 3.7.6
|
|
4
34
|
|
|
5
35
|
### Patch Changes
|
|
@@ -589,6 +619,7 @@
|
|
|
589
619
|
- 7f3203a: fix: make workspace test runs resilient when packages have no tests
|
|
590
620
|
|
|
591
621
|
Updates package test scripts to pass cleanly when no matching test files exist:
|
|
622
|
+
|
|
592
623
|
- Uses `bun test --pass-with-no-tests` in Bun-based packages that currently ship without test files.
|
|
593
624
|
- Uses `jest --passWithNoTests` for the UI kit web package.
|
|
594
625
|
- Adds `.vscode-test.mjs` for `vscode-contractspec` so VS Code extension test runs have an explicit config and stop failing on missing default configuration.
|
|
@@ -1092,14 +1123,17 @@
|
|
|
1092
1123
|
feat: Contract layers support (features, examples, app-configs)
|
|
1093
1124
|
|
|
1094
1125
|
### New CLI Commands
|
|
1126
|
+
|
|
1095
1127
|
- `contractspec list layers` - List all contract layers with filtering
|
|
1096
1128
|
|
|
1097
1129
|
### Enhanced Commands
|
|
1130
|
+
|
|
1098
1131
|
- `contractspec ci` - New `layers` check category validates features/examples/config
|
|
1099
1132
|
- `contractspec doctor` - New `layers` health checks
|
|
1100
1133
|
- `contractspec integrity` - Now shows layer statistics
|
|
1101
1134
|
|
|
1102
1135
|
### New APIs
|
|
1136
|
+
|
|
1103
1137
|
- `discoverLayers()` - Scan workspace for all layer files
|
|
1104
1138
|
- `scanExampleSource()` - Parse ExampleSpec from source code
|
|
1105
1139
|
- `isExampleFile()` - Check if file is an example spec
|
package/README.md
CHANGED
|
@@ -1,35 +1,75 @@
|
|
|
1
1
|
# @contractspec/example.learning-journey-ui-onboarding
|
|
2
2
|
|
|
3
|
-
Website: https://contractspec.io
|
|
3
|
+
Website: https://contractspec.io
|
|
4
4
|
|
|
5
|
+
**Developer onboarding UI with checklists and journey maps.**
|
|
5
6
|
|
|
6
|
-
|
|
7
|
+
## What This Demonstrates
|
|
7
8
|
|
|
8
|
-
|
|
9
|
+
- React-based onboarding mini-app with checklist and journey map components.
|
|
10
|
+
- Multi-view layout (Overview, Progress, Steps, Timeline).
|
|
11
|
+
- Shared UI component reuse across learning journey examples.
|
|
12
|
+
- DocBlock-driven documentation pattern.
|
|
13
|
+
- `src/docs/` contains docblocks and documentation-facing exports.
|
|
14
|
+
- `src/docs/` contains docblocks and documentation-facing exports.
|
|
9
15
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
-
|
|
13
|
-
-
|
|
16
|
+
## Running Locally
|
|
17
|
+
|
|
18
|
+
From `packages/examples/learning-journey-ui-onboarding`:
|
|
19
|
+
- `bun run dev`
|
|
20
|
+
- `bun run build`
|
|
21
|
+
- `bun run test`
|
|
22
|
+
- `bun run typecheck`
|
|
14
23
|
|
|
15
24
|
## Usage
|
|
16
25
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
-
|
|
34
|
-
-
|
|
35
|
-
-
|
|
26
|
+
Use `@contractspec/example.learning-journey-ui-onboarding` as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.
|
|
27
|
+
|
|
28
|
+
## Architecture
|
|
29
|
+
|
|
30
|
+
- `src/components/` contains reusable UI components and view composition.
|
|
31
|
+
- `src/docs/` contains docblocks and documentation-facing exports.
|
|
32
|
+
- `src/example.ts` is the runnable example entrypoint.
|
|
33
|
+
- `src/index.ts` is the root public barrel and package entrypoint.
|
|
34
|
+
- `src/learning-journey-ui-onboarding.feature.ts` defines a feature entrypoint.
|
|
35
|
+
- `src/OnboardingMiniApp.tsx` is part of the package's public or composition surface.
|
|
36
|
+
- `src/views/` contains view-level composition.
|
|
37
|
+
|
|
38
|
+
## Public Entry Points
|
|
39
|
+
|
|
40
|
+
- Export `.` resolves through `./src/index.ts`.
|
|
41
|
+
- Export `./components` resolves through `./src/components/index.ts`.
|
|
42
|
+
- Export `./components/CodeSnippet` resolves through `./src/components/CodeSnippet.tsx`.
|
|
43
|
+
- Export `./components/JourneyMap` resolves through `./src/components/JourneyMap.tsx`.
|
|
44
|
+
- Export `./components/StepChecklist` resolves through `./src/components/StepChecklist.tsx`.
|
|
45
|
+
- Export `./docs` resolves through `./src/docs/index.ts`.
|
|
46
|
+
- Export `./docs/learning-journey-ui-onboarding.docblock` resolves through `./src/docs/learning-journey-ui-onboarding.docblock.ts`.
|
|
47
|
+
- Export `./example` resolves through `./src/example.ts`.
|
|
48
|
+
- Export `./learning-journey-ui-onboarding.feature` resolves through `./src/learning-journey-ui-onboarding.feature.ts`.
|
|
49
|
+
- Export `./OnboardingMiniApp` resolves through `./src/OnboardingMiniApp.tsx`.
|
|
50
|
+
- The package publishes 15 total export subpaths; keep docs aligned with `package.json`.
|
|
51
|
+
|
|
52
|
+
## Local Commands
|
|
53
|
+
|
|
54
|
+
- `bun run dev` — contractspec-bun-build dev
|
|
55
|
+
- `bun run build` — bun run prebuild && bun run build:bundle && bun run build:types
|
|
56
|
+
- `bun run test` — bun test --pass-with-no-tests
|
|
57
|
+
- `bun run lint` — bun lint:fix
|
|
58
|
+
- `bun run lint:check` — biome check .
|
|
59
|
+
- `bun run lint:fix` — biome check --write --unsafe --only=nursery/useSortedClasses . && biome check --write .
|
|
60
|
+
- `bun run typecheck` — tsc --noEmit
|
|
61
|
+
- `bun run publish:pkg` — bun publish --tolerate-republish --ignore-scripts --verbose
|
|
62
|
+
- `bun run publish:pkg:canary` — bun publish:pkg --tag canary
|
|
63
|
+
- `bun run clean` — rimraf dist .turbo
|
|
64
|
+
- `bun run build:bundle` — contractspec-bun-build transpile
|
|
65
|
+
- `bun run build:types` — contractspec-bun-build types
|
|
66
|
+
- `bun run prebuild` — contractspec-bun-build prebuild
|
|
67
|
+
|
|
68
|
+
## Recent Updates
|
|
69
|
+
|
|
70
|
+
- Replace eslint+prettier by biomejs to optimize speed.
|
|
71
|
+
- Missing contract layers.
|
|
72
|
+
|
|
73
|
+
## Notes
|
|
74
|
+
|
|
75
|
+
- Works alongside `@contractspec/example.learning-journey-platform-tour`, `@contractspec/example.learning-journey-studio-onboarding`, `@contractspec/example.learning-journey-ui-shared`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.design-system`, ...
|