@contractspec/example.learning-journey-ui-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.
Files changed (56) hide show
  1. package/.turbo/turbo-build.log +3 -3
  2. package/AGENTS.md +50 -24
  3. package/README.md +66 -26
  4. package/dist/OnboardingMiniApp.js +280 -280
  5. package/dist/browser/OnboardingMiniApp.js +280 -280
  6. package/dist/browser/components/CodeSnippet.js +4 -4
  7. package/dist/browser/components/JourneyMap.js +1 -1
  8. package/dist/browser/components/StepChecklist.js +6 -6
  9. package/dist/browser/components/index.js +11 -11
  10. package/dist/browser/index.js +285 -284
  11. package/dist/browser/views/Overview.js +14 -14
  12. package/dist/browser/views/Progress.js +9 -9
  13. package/dist/browser/views/Steps.js +8 -8
  14. package/dist/browser/views/Timeline.js +6 -6
  15. package/dist/browser/views/index.js +276 -276
  16. package/dist/components/CodeSnippet.js +4 -4
  17. package/dist/components/JourneyMap.js +1 -1
  18. package/dist/components/StepChecklist.js +6 -6
  19. package/dist/components/index.d.ts +1 -1
  20. package/dist/components/index.js +11 -11
  21. package/dist/index.d.ts +4 -4
  22. package/dist/index.js +285 -284
  23. package/dist/node/OnboardingMiniApp.js +280 -280
  24. package/dist/node/components/CodeSnippet.js +4 -4
  25. package/dist/node/components/JourneyMap.js +1 -1
  26. package/dist/node/components/StepChecklist.js +6 -6
  27. package/dist/node/components/index.js +11 -11
  28. package/dist/node/index.js +285 -284
  29. package/dist/node/views/Overview.js +14 -14
  30. package/dist/node/views/Progress.js +9 -9
  31. package/dist/node/views/Steps.js +8 -8
  32. package/dist/node/views/Timeline.js +6 -6
  33. package/dist/node/views/index.js +276 -276
  34. package/dist/views/Overview.js +14 -14
  35. package/dist/views/Progress.js +9 -9
  36. package/dist/views/Steps.js +8 -8
  37. package/dist/views/Timeline.js +6 -6
  38. package/dist/views/index.d.ts +1 -1
  39. package/dist/views/index.js +276 -276
  40. package/package.json +10 -10
  41. package/src/OnboardingMiniApp.tsx +70 -70
  42. package/src/components/CodeSnippet.tsx +43 -43
  43. package/src/components/JourneyMap.tsx +70 -70
  44. package/src/components/StepChecklist.tsx +118 -118
  45. package/src/components/index.ts +1 -1
  46. package/src/docs/learning-journey-ui-onboarding.docblock.ts +11 -11
  47. package/src/example.ts +25 -25
  48. package/src/index.ts +5 -6
  49. package/src/learning-journey-ui-onboarding.feature.ts +12 -12
  50. package/src/views/Overview.tsx +182 -182
  51. package/src/views/Progress.tsx +167 -167
  52. package/src/views/Steps.tsx +79 -79
  53. package/src/views/Timeline.tsx +126 -126
  54. package/src/views/index.ts +1 -1
  55. package/tsconfig.json +7 -8
  56. package/tsdown.config.js +7 -13
@@ -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 42ms
6
+ Bundled 15 modules in 25ms
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 45ms
25
+ Bundled 15 modules in 37ms
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 32ms
44
+ Bundled 15 modules in 22ms
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 -- `@contractspec/example.learning-journey-ui-onboarding`
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, journey maps, and step-by-step progress views.
5
+ Developer onboarding UI with checklists and journey maps.
6
6
 
7
7
  ## Quick Context
8
8
 
9
- - **Layer**: example
10
- - **Related Packages**: `lib.ui-kit-core`, `lib.contracts-spec`, `lib.design-system`, `lib.ui-kit-web`, `module.learning-journey`, `example.learning-journey-ui-shared`, `example.learning-journey-studio-onboarding`, `example.learning-journey-platform-tour`
11
-
12
- ## What This Demonstrates
13
-
14
- - React-based onboarding mini-app with checklist and journey map components
15
- - Multi-view layout (Overview, Progress, Steps, Timeline)
16
- - Shared UI component reuse across learning journey examples
17
- - DocBlock-driven documentation pattern
18
-
19
- ## Public Exports
20
-
21
- - `.` -- root barrel
22
- - `./components` -- CodeSnippet, JourneyMap, StepChecklist
23
- - `./views` -- Overview, Progress, Steps, Timeline
24
- - `./OnboardingMiniApp` -- top-level mini-app component
25
- - `./docs` -- DocBlock documentation
26
- - `./example` -- runnable example entry
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
- - Build: `bun run build`
31
- - Dev: `bun run dev`
32
- - Test: `bun test --pass-with-no-tests`
33
- - Typecheck: `bun run typecheck`
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/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
- Developer onboarding UI with checklists and journey maps.
7
+ ## What This Demonstrates
7
8
 
8
- ## Features
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
- - **Overview**: Welcome banner with progress summary and "Get Started" CTA
11
- - **Steps**: Accordion-style checklist with expandable instructions
12
- - **Progress**: Circular progress indicator, XP bar, and step breakdown
13
- - **Timeline**: Journey map with surface icons and detailed step timeline
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
- ```tsx
18
- import { OnboardingMiniApp } from '@contractspec/example.learning-journey-ui-onboarding';
19
- import { studioGettingStartedTrack } from '@contractspec/example.learning-journey-studio-onboarding/track';
20
-
21
- function MyApp() {
22
- return (
23
- <OnboardingMiniApp
24
- track={studioGettingStartedTrack}
25
- initialView="overview"
26
- />
27
- );
28
- }
29
- ```
30
-
31
- ## Components
32
-
33
- - **StepChecklist** - Expandable accordion step with completion action
34
- - **CodeSnippet** - Inline code display with copy button
35
- - **JourneyMap** - Horizontal connected node journey visualization
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`, ...