@contractspec/example.learning-journey-ui-coaching 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.
Files changed (57) hide show
  1. package/.turbo/turbo-build.log +3 -3
  2. package/AGENTS.md +50 -25
  3. package/CHANGELOG.md +32 -0
  4. package/README.md +63 -20
  5. package/dist/CoachingMiniApp.js +178 -178
  6. package/dist/browser/CoachingMiniApp.js +178 -178
  7. package/dist/browser/components/EngagementMeter.js +2 -2
  8. package/dist/browser/components/TipCard.js +3 -3
  9. package/dist/browser/components/TipFeed.js +6 -6
  10. package/dist/browser/components/index.js +11 -11
  11. package/dist/browser/index.js +179 -178
  12. package/dist/browser/views/Overview.js +16 -16
  13. package/dist/browser/views/Progress.js +10 -10
  14. package/dist/browser/views/Steps.js +6 -6
  15. package/dist/browser/views/Timeline.js +9 -9
  16. package/dist/browser/views/index.js +174 -174
  17. package/dist/components/EngagementMeter.js +2 -2
  18. package/dist/components/TipCard.js +3 -3
  19. package/dist/components/TipFeed.js +6 -6
  20. package/dist/components/index.d.ts +1 -1
  21. package/dist/components/index.js +11 -11
  22. package/dist/index.d.ts +3 -3
  23. package/dist/index.js +179 -178
  24. package/dist/node/CoachingMiniApp.js +178 -178
  25. package/dist/node/components/EngagementMeter.js +2 -2
  26. package/dist/node/components/TipCard.js +3 -3
  27. package/dist/node/components/TipFeed.js +6 -6
  28. package/dist/node/components/index.js +11 -11
  29. package/dist/node/index.js +179 -178
  30. package/dist/node/views/Overview.js +16 -16
  31. package/dist/node/views/Progress.js +10 -10
  32. package/dist/node/views/Steps.js +6 -6
  33. package/dist/node/views/Timeline.js +9 -9
  34. package/dist/node/views/index.js +174 -174
  35. package/dist/views/Overview.js +16 -16
  36. package/dist/views/Progress.js +10 -10
  37. package/dist/views/Steps.js +6 -6
  38. package/dist/views/Timeline.js +9 -9
  39. package/dist/views/index.d.ts +1 -1
  40. package/dist/views/index.js +174 -174
  41. package/package.json +12 -12
  42. package/src/CoachingMiniApp.tsx +70 -70
  43. package/src/components/EngagementMeter.tsx +82 -82
  44. package/src/components/TipCard.tsx +81 -81
  45. package/src/components/TipFeed.tsx +80 -80
  46. package/src/components/index.ts +1 -1
  47. package/src/docs/learning-journey-ui-coaching.docblock.ts +10 -10
  48. package/src/example.ts +25 -25
  49. package/src/index.ts +4 -6
  50. package/src/learning-journey-ui-coaching.feature.ts +12 -12
  51. package/src/views/Overview.tsx +136 -136
  52. package/src/views/Progress.tsx +146 -146
  53. package/src/views/Steps.tsx +57 -57
  54. package/src/views/Timeline.tsx +101 -101
  55. package/src/views/index.ts +1 -1
  56. package/tsconfig.json +7 -8
  57. 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 17ms
6
+ Bundled 15 modules in 24ms
7
7
 
8
8
  ./CoachingMiniApp.js 44.47 KB (entry point)
9
9
  ./index.js 46.87 KB (entry point)
@@ -22,7 +22,7 @@ Bundled 15 modules in 17ms
22
22
  ./example.js 0.93 KB (entry point)
23
23
 
24
24
  [contractspec-bun-build] transpile target=node root=src entries=15 noBundle=false
25
- Bundled 15 modules in 23ms
25
+ Bundled 15 modules in 17ms
26
26
 
27
27
  ./CoachingMiniApp.js 44.44 KB (entry point)
28
28
  ./index.js 46.83 KB (entry point)
@@ -41,7 +41,7 @@ Bundled 15 modules in 23ms
41
41
  ./example.js 0.92 KB (entry point)
42
42
 
43
43
  [contractspec-bun-build] transpile target=browser root=src entries=15 noBundle=false
44
- Bundled 15 modules in 31ms
44
+ Bundled 15 modules in 24ms
45
45
 
46
46
  ./CoachingMiniApp.js 44.44 KB (entry point)
47
47
  ./index.js 46.83 KB (entry point)
package/AGENTS.md CHANGED
@@ -1,34 +1,59 @@
1
- # AI Agent Guide -- `@contractspec/example.learning-journey-ui-coaching`
1
+ # AI Agent Guide `@contractspec/example.learning-journey-ui-coaching`
2
2
 
3
3
  Scope: `packages/examples/learning-journey-ui-coaching/*`
4
4
 
5
- Demonstrates a contextual coaching UI with tip cards, engagement tracking, and multi-view navigation.
5
+ Contextual coaching UI with tip cards and engagement tracking.
6
6
 
7
7
  ## Quick Context
8
8
 
9
- - **Layer**: example
10
- - **Related Packages**: `module.learning-journey`, `lib.contracts-spec`, `lib.design-system`, `lib.ui-kit-web`, `example.learning-journey-ui-shared`, `example.learning-journey-ambient-coach`, `example.learning-journey-crm-onboarding`
11
-
12
- ## What This Demonstrates
13
-
14
- - CoachingMiniApp as a self-contained React application
15
- - TipCard, TipFeed, and EngagementMeter components
16
- - Multi-view layout (Overview, Progress, Steps, Timeline)
17
- - Integration with ambient-coach and crm-onboarding tracks
18
- - Design system and UI kit usage patterns
19
-
20
- ## Public Exports
21
-
22
- - `.` -- root barrel
23
- - `./CoachingMiniApp` -- main mini-app component
24
- - `./components` -- TipCard, TipFeed, EngagementMeter
25
- - `./views` -- Overview, Progress, Steps, Timeline views
26
- - `./docs` -- DocBlock documentation
27
- - `./example` -- runnable example entry point
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-ambient-coach`, `@contractspec/example.learning-journey-crm-onboarding`, `@contractspec/example.learning-journey-ui-shared`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.design-system`, `@contractspec/lib.ui-kit-web`, ...
13
+
14
+ ## Architecture
15
+
16
+ - `src/CoachingMiniApp.tsx` is part of the package's public or composition surface.
17
+ - `src/components/` contains reusable UI components and view composition.
18
+ - `src/docs/` contains docblocks and documentation-facing exports.
19
+ - `src/example.ts` is the runnable example entrypoint.
20
+ - `src/index.ts` is the root public barrel and package entrypoint.
21
+ - `src/learning-journey-ui-coaching.feature.ts` defines a feature entrypoint.
22
+ - `src/views/` contains view-level composition.
23
+
24
+ ## Public Surface
25
+
26
+ - Export `.` resolves through `./src/index.ts`.
27
+ - Export `./CoachingMiniApp` resolves through `./src/CoachingMiniApp.tsx`.
28
+ - Export `./components` resolves through `./src/components/index.ts`.
29
+ - Export `./components/EngagementMeter` resolves through `./src/components/EngagementMeter.tsx`.
30
+ - Export `./components/TipCard` resolves through `./src/components/TipCard.tsx`.
31
+ - Export `./components/TipFeed` resolves through `./src/components/TipFeed.tsx`.
32
+ - Export `./docs` resolves through `./src/docs/index.ts`.
33
+ - Export `./docs/learning-journey-ui-coaching.docblock` resolves through `./src/docs/learning-journey-ui-coaching.docblock.ts`.
34
+ - Export `./example` resolves through `./src/example.ts`.
35
+ - Export `./learning-journey-ui-coaching.feature` resolves through `./src/learning-journey-ui-coaching.feature.ts`.
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-ambient-coach`, `@contractspec/example.learning-journey-crm-onboarding`, `@contractspec/example.learning-journey-ui-shared`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.design-system`, `@contractspec/lib.ui-kit-web`, ....
43
+ - Changes here can affect downstream packages such as `@contractspec/example.learning-journey-ambient-coach`, `@contractspec/example.learning-journey-crm-onboarding`, `@contractspec/example.learning-journey-ui-shared`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.design-system`, `@contractspec/lib.ui-kit-web`, ...
28
44
 
29
45
  ## Local Commands
30
46
 
31
- - Build: `bun run build`
32
- - Dev: `bun run dev`
33
- - Test: `bun test`
34
- - 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/CHANGELOG.md CHANGED
@@ -1,5 +1,33 @@
1
1
  # @contractspec/example.learning-journey-ui-coaching
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-crm-onboarding@3.7.10
10
+ - @contractspec/example.learning-journey-ambient-coach@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-web@3.9.2
16
+
17
+ ## 3.7.9
18
+
19
+ ### Patch Changes
20
+
21
+ - fix: release
22
+ - Updated dependencies
23
+ - @contractspec/example.learning-journey-crm-onboarding@3.7.9
24
+ - @contractspec/example.learning-journey-ambient-coach@3.7.9
25
+ - @contractspec/example.learning-journey-ui-shared@3.7.9
26
+ - @contractspec/module.learning-journey@3.7.9
27
+ - @contractspec/lib.contracts-spec@4.1.1
28
+ - @contractspec/lib.design-system@3.8.2
29
+ - @contractspec/lib.ui-kit-web@3.9.1
30
+
3
31
  ## 3.7.6
4
32
 
5
33
  ### Patch Changes
@@ -559,6 +587,7 @@
559
587
  - 7f3203a: fix: make workspace test runs resilient when packages have no tests
560
588
 
561
589
  Updates package test scripts to pass cleanly when no matching test files exist:
590
+
562
591
  - Uses `bun test --pass-with-no-tests` in Bun-based packages that currently ship without test files.
563
592
  - Uses `jest --passWithNoTests` for the UI kit web package.
564
593
  - Adds `.vscode-test.mjs` for `vscode-contractspec` so VS Code extension test runs have an explicit config and stop failing on missing default configuration.
@@ -1035,14 +1064,17 @@
1035
1064
  feat: Contract layers support (features, examples, app-configs)
1036
1065
 
1037
1066
  ### New CLI Commands
1067
+
1038
1068
  - `contractspec list layers` - List all contract layers with filtering
1039
1069
 
1040
1070
  ### Enhanced Commands
1071
+
1041
1072
  - `contractspec ci` - New `layers` check category validates features/examples/config
1042
1073
  - `contractspec doctor` - New `layers` health checks
1043
1074
  - `contractspec integrity` - Now shows layer statistics
1044
1075
 
1045
1076
  ### New APIs
1077
+
1046
1078
  - `discoverLayers()` - Scan workspace for all layer files
1047
1079
  - `scanExampleSource()` - Parse ExampleSpec from source code
1048
1080
  - `isExampleFile()` - Check if file is an example spec
package/README.md CHANGED
@@ -1,32 +1,75 @@
1
1
  # @contractspec/example.learning-journey-ui-coaching
2
2
 
3
- Website: https://contractspec.io/
3
+ Website: https://contractspec.io
4
4
 
5
+ **Contextual coaching UI with tip cards and engagement tracking.**
5
6
 
6
- Contextual coaching UI with tip cards and engagement tracking.
7
+ ## What This Demonstrates
7
8
 
8
- ## Features
9
+ - CoachingMiniApp as a self-contained React application.
10
+ - TipCard, TipFeed, and EngagementMeter components.
11
+ - Multi-view layout (Overview, Progress, Steps, Timeline).
12
+ - Integration with ambient-coach and crm-onboarding tracks.
13
+ - Design system and UI kit usage patterns.
14
+ - `src/docs/` contains docblocks and documentation-facing exports.
9
15
 
10
- - **Overview**: Active tips carousel with quick stats
11
- - **Steps**: Stacked tip cards with action/dismiss buttons
12
- - **Progress**: Engagement donut chart, streak counter, XP bar
13
- - **Timeline**: Reverse-chronological feed of tip activity
16
+ ## Running Locally
17
+
18
+ From `packages/examples/learning-journey-ui-coaching`:
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 { CoachingMiniApp } from '@contractspec/example.learning-journey-ui-coaching';
19
- import { moneyAmbientCoachTrack } from '@contractspec/example.learning-journey-ambient-coach/track';
26
+ Use `@contractspec/example.learning-journey-ui-coaching` as a reference implementation, or import its exported surfaces into a workspace that composes ContractSpec examples and bundles.
27
+
28
+ ## Architecture
29
+
30
+ - `src/CoachingMiniApp.tsx` is part of the package's public or composition surface.
31
+ - `src/components/` contains reusable UI components and view composition.
32
+ - `src/docs/` contains docblocks and documentation-facing exports.
33
+ - `src/example.ts` is the runnable example entrypoint.
34
+ - `src/index.ts` is the root public barrel and package entrypoint.
35
+ - `src/learning-journey-ui-coaching.feature.ts` defines a feature entrypoint.
36
+ - `src/views/` contains view-level composition.
37
+
38
+ ## Public Entry Points
39
+
40
+ - Export `.` resolves through `./src/index.ts`.
41
+ - Export `./CoachingMiniApp` resolves through `./src/CoachingMiniApp.tsx`.
42
+ - Export `./components` resolves through `./src/components/index.ts`.
43
+ - Export `./components/EngagementMeter` resolves through `./src/components/EngagementMeter.tsx`.
44
+ - Export `./components/TipCard` resolves through `./src/components/TipCard.tsx`.
45
+ - Export `./components/TipFeed` resolves through `./src/components/TipFeed.tsx`.
46
+ - Export `./docs` resolves through `./src/docs/index.ts`.
47
+ - Export `./docs/learning-journey-ui-coaching.docblock` resolves through `./src/docs/learning-journey-ui-coaching.docblock.ts`.
48
+ - Export `./example` resolves through `./src/example.ts`.
49
+ - Export `./learning-journey-ui-coaching.feature` resolves through `./src/learning-journey-ui-coaching.feature.ts`.
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
20
69
 
21
- function MyApp() {
22
- return (
23
- <CoachingMiniApp track={moneyAmbientCoachTrack} initialView="overview" />
24
- );
25
- }
26
- ```
70
+ - Replace eslint+prettier by biomejs to optimize speed.
71
+ - Missing contract layers.
27
72
 
28
- ## Components
73
+ ## Notes
29
74
 
30
- - **TipCard** - Individual coaching tip with action/dismiss options
31
- - **EngagementMeter** - Donut chart showing actioned/acknowledged/pending
32
- - **TipFeed** - Timeline feed of tip activity
75
+ - Works alongside `@contractspec/example.learning-journey-ambient-coach`, `@contractspec/example.learning-journey-crm-onboarding`, `@contractspec/example.learning-journey-ui-shared`, `@contractspec/lib.contracts-spec`, `@contractspec/lib.design-system`, ...