@rune-kit/rune 2.8.0 → 2.11.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.
Files changed (287) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +68 -34
  3. package/agents/adversary.md +27 -0
  4. package/agents/architect.md +19 -29
  5. package/agents/asset-creator.md +18 -4
  6. package/agents/audit.md +25 -4
  7. package/agents/autopsy.md +19 -4
  8. package/agents/ba.md +35 -0
  9. package/agents/brainstorm.md +31 -4
  10. package/agents/browser-pilot.md +21 -4
  11. package/agents/coder.md +21 -29
  12. package/agents/completion-gate.md +20 -4
  13. package/agents/constraint-check.md +18 -4
  14. package/agents/context-engine.md +22 -4
  15. package/agents/context-pack.md +32 -0
  16. package/agents/cook.md +41 -4
  17. package/agents/db.md +19 -4
  18. package/agents/debug.md +33 -4
  19. package/agents/dependency-doctor.md +20 -4
  20. package/agents/deploy.md +27 -4
  21. package/agents/design.md +22 -4
  22. package/agents/doc-processor.md +27 -0
  23. package/agents/docs-seeker.md +19 -4
  24. package/agents/docs.md +31 -0
  25. package/agents/fix.md +37 -4
  26. package/agents/git.md +29 -0
  27. package/agents/hallucination-guard.md +20 -4
  28. package/agents/incident.md +21 -4
  29. package/agents/integrity-check.md +18 -4
  30. package/agents/journal.md +19 -4
  31. package/agents/launch.md +32 -4
  32. package/agents/logic-guardian.md +26 -11
  33. package/agents/marketing.md +23 -4
  34. package/agents/mcp-builder.md +26 -0
  35. package/agents/neural-memory.md +30 -0
  36. package/agents/onboard.md +22 -4
  37. package/agents/perf.md +21 -4
  38. package/agents/plan.md +29 -4
  39. package/agents/preflight.md +22 -4
  40. package/agents/problem-solver.md +20 -4
  41. package/agents/rescue.md +23 -4
  42. package/agents/research.md +19 -4
  43. package/agents/researcher.md +19 -29
  44. package/agents/retro.md +32 -0
  45. package/agents/review-intake.md +20 -4
  46. package/agents/review.md +32 -4
  47. package/agents/reviewer.md +20 -28
  48. package/agents/safeguard.md +19 -4
  49. package/agents/sast.md +18 -4
  50. package/agents/scaffold.md +41 -0
  51. package/agents/scanner.md +19 -28
  52. package/agents/scope-guard.md +18 -4
  53. package/agents/scout.md +23 -4
  54. package/agents/sentinel-env.md +26 -0
  55. package/agents/sentinel.md +33 -4
  56. package/agents/sequential-thinking.md +20 -4
  57. package/agents/session-bridge.md +24 -4
  58. package/agents/skill-forge.md +22 -4
  59. package/agents/skill-router.md +26 -4
  60. package/agents/slides.md +24 -0
  61. package/agents/surgeon.md +19 -4
  62. package/agents/team.md +30 -4
  63. package/agents/test.md +36 -4
  64. package/agents/trend-scout.md +17 -4
  65. package/agents/verification.md +20 -4
  66. package/agents/video-creator.md +20 -4
  67. package/agents/watchdog.md +19 -4
  68. package/agents/worktree.md +17 -4
  69. package/commands/rune.md +168 -168
  70. package/compiler/__tests__/analytics.test.js +370 -0
  71. package/compiler/adapters/openclaw.js +2 -2
  72. package/compiler/analytics.js +385 -0
  73. package/compiler/bin/rune.js +68 -2
  74. package/compiler/dashboard.js +883 -0
  75. package/compiler/transforms/branding.js +1 -1
  76. package/contexts/dev.md +34 -34
  77. package/contexts/research.md +43 -43
  78. package/contexts/review.md +55 -55
  79. package/extensions/ai-ml/PACK.md +88 -88
  80. package/extensions/ai-ml/skills/ai-agents.md +172 -172
  81. package/extensions/ai-ml/skills/code-sandbox.md +187 -187
  82. package/extensions/ai-ml/skills/deep-research.md +146 -146
  83. package/extensions/ai-ml/skills/embedding-search.md +66 -66
  84. package/extensions/ai-ml/skills/fine-tuning-guide.md +74 -74
  85. package/extensions/ai-ml/skills/llm-architect.md +125 -125
  86. package/extensions/ai-ml/skills/llm-integration.md +64 -64
  87. package/extensions/ai-ml/skills/prompt-patterns.md +72 -72
  88. package/extensions/ai-ml/skills/rag-patterns.md +66 -66
  89. package/extensions/ai-ml/skills/web-extraction.md +114 -114
  90. package/extensions/analytics/PACK.md +92 -92
  91. package/extensions/analytics/skills/ab-testing.md +72 -72
  92. package/extensions/analytics/skills/dashboard-patterns.md +83 -83
  93. package/extensions/analytics/skills/data-validation.md +68 -68
  94. package/extensions/analytics/skills/funnel-analysis.md +81 -81
  95. package/extensions/analytics/skills/sql-patterns.md +57 -57
  96. package/extensions/analytics/skills/statistical-analysis.md +79 -79
  97. package/extensions/analytics/skills/tracking-setup.md +71 -71
  98. package/extensions/backend/PACK.md +104 -104
  99. package/extensions/backend/skills/api-patterns.md +84 -84
  100. package/extensions/backend/skills/async-pipeline.md +193 -193
  101. package/extensions/backend/skills/auth-patterns.md +97 -97
  102. package/extensions/backend/skills/background-jobs.md +133 -133
  103. package/extensions/backend/skills/caching-patterns.md +108 -108
  104. package/extensions/backend/skills/cli-generation.md +133 -133
  105. package/extensions/backend/skills/database-patterns.md +87 -87
  106. package/extensions/backend/skills/middleware-patterns.md +104 -104
  107. package/extensions/chrome-ext/PACK.md +93 -93
  108. package/extensions/chrome-ext/skills/cws-preflight.md +143 -143
  109. package/extensions/chrome-ext/skills/cws-publish.md +104 -104
  110. package/extensions/chrome-ext/skills/ext-ai-integration.md +251 -251
  111. package/extensions/chrome-ext/skills/ext-messaging.md +139 -139
  112. package/extensions/chrome-ext/skills/ext-storage.md +133 -133
  113. package/extensions/chrome-ext/skills/mv3-scaffold.md +164 -164
  114. package/extensions/content/PACK.md +96 -96
  115. package/extensions/content/skills/blog-patterns.md +88 -88
  116. package/extensions/content/skills/cms-integration.md +131 -131
  117. package/extensions/content/skills/content-scoring.md +107 -107
  118. package/extensions/content/skills/i18n.md +83 -83
  119. package/extensions/content/skills/mdx-authoring.md +137 -137
  120. package/extensions/content/skills/reference.md +1014 -1014
  121. package/extensions/content/skills/seo-patterns.md +67 -67
  122. package/extensions/content/skills/video-repurpose.md +153 -153
  123. package/extensions/devops/PACK.md +101 -101
  124. package/extensions/devops/skills/chaos-testing.md +67 -67
  125. package/extensions/devops/skills/ci-cd.md +75 -75
  126. package/extensions/devops/skills/docker.md +58 -58
  127. package/extensions/devops/skills/edge-serverless.md +163 -163
  128. package/extensions/devops/skills/infra-as-code.md +158 -158
  129. package/extensions/devops/skills/kubernetes.md +110 -110
  130. package/extensions/devops/skills/monitoring.md +57 -57
  131. package/extensions/devops/skills/server-setup.md +64 -64
  132. package/extensions/devops/skills/ssl-domain.md +42 -42
  133. package/extensions/ecommerce/PACK.md +116 -116
  134. package/extensions/ecommerce/skills/cart-system.md +79 -79
  135. package/extensions/ecommerce/skills/inventory-mgmt.md +102 -102
  136. package/extensions/ecommerce/skills/order-management.md +126 -126
  137. package/extensions/ecommerce/skills/payment-integration.md +472 -472
  138. package/extensions/ecommerce/skills/shopify-dev.md +69 -69
  139. package/extensions/ecommerce/skills/subscription-billing.md +93 -93
  140. package/extensions/ecommerce/skills/tax-compliance.md +117 -117
  141. package/extensions/gamedev/PACK.md +142 -142
  142. package/extensions/gamedev/skills/asset-pipeline.md +74 -74
  143. package/extensions/gamedev/skills/audio-system.md +129 -129
  144. package/extensions/gamedev/skills/camera-system.md +87 -87
  145. package/extensions/gamedev/skills/ecs.md +98 -98
  146. package/extensions/gamedev/skills/game-loops.md +72 -72
  147. package/extensions/gamedev/skills/input-system.md +199 -199
  148. package/extensions/gamedev/skills/multiplayer.md +180 -180
  149. package/extensions/gamedev/skills/particles.md +105 -105
  150. package/extensions/gamedev/skills/physics-engine.md +89 -89
  151. package/extensions/gamedev/skills/scene-management.md +146 -146
  152. package/extensions/gamedev/skills/threejs-patterns.md +90 -90
  153. package/extensions/gamedev/skills/webgl.md +71 -71
  154. package/extensions/mobile/PACK.md +106 -106
  155. package/extensions/mobile/skills/app-store-connect.md +152 -152
  156. package/extensions/mobile/skills/app-store-prep.md +66 -66
  157. package/extensions/mobile/skills/deep-linking.md +109 -109
  158. package/extensions/mobile/skills/flutter.md +60 -60
  159. package/extensions/mobile/skills/ios-build-pipeline.md +142 -142
  160. package/extensions/mobile/skills/native-bridge.md +66 -66
  161. package/extensions/mobile/skills/ota-updates.md +97 -97
  162. package/extensions/mobile/skills/push-notifications.md +111 -111
  163. package/extensions/mobile/skills/react-native.md +82 -82
  164. package/extensions/saas/PACK.md +116 -116
  165. package/extensions/saas/skills/billing-integration.md +200 -200
  166. package/extensions/saas/skills/feature-flags.md +130 -130
  167. package/extensions/saas/skills/multi-tenant.md +103 -103
  168. package/extensions/saas/skills/onboarding-flow.md +139 -139
  169. package/extensions/saas/skills/subscription-flow.md +95 -95
  170. package/extensions/saas/skills/team-management.md +144 -144
  171. package/extensions/security/PACK.md +99 -99
  172. package/extensions/security/skills/api-security.md +140 -140
  173. package/extensions/security/skills/compliance.md +68 -68
  174. package/extensions/security/skills/owasp-audit.md +64 -64
  175. package/extensions/security/skills/pentest-patterns.md +77 -77
  176. package/extensions/security/skills/secret-mgmt.md +65 -65
  177. package/extensions/security/skills/supply-chain.md +65 -65
  178. package/extensions/trading/PACK.md +80 -80
  179. package/extensions/trading/skills/chart-components.md +55 -55
  180. package/extensions/trading/skills/experiment-loop.md +125 -125
  181. package/extensions/trading/skills/fintech-patterns.md +47 -47
  182. package/extensions/trading/skills/indicator-library.md +58 -58
  183. package/extensions/trading/skills/quant-analysis.md +111 -111
  184. package/extensions/trading/skills/realtime-data.md +58 -58
  185. package/extensions/trading/skills/trade-logic.md +104 -104
  186. package/extensions/ui/PACK.md +130 -130
  187. package/extensions/ui/skills/a11y-audit.md +91 -91
  188. package/extensions/ui/skills/animation-patterns.md +127 -106
  189. package/extensions/ui/skills/component-patterns.md +100 -75
  190. package/extensions/ui/skills/design-decision.md +108 -108
  191. package/extensions/ui/skills/design-system.md +68 -68
  192. package/extensions/ui/skills/landing-patterns.md +155 -155
  193. package/extensions/ui/skills/palette-picker.md +173 -173
  194. package/extensions/ui/skills/react-health.md +90 -90
  195. package/extensions/ui/skills/type-system.md +125 -125
  196. package/extensions/ui/skills/web-vitals.md +153 -153
  197. package/extensions/zalo/PACK.md +145 -145
  198. package/extensions/zalo/skills/zalo-oa-mcp.md +317 -317
  199. package/extensions/zalo/skills/zalo-oa-messaging.md +429 -429
  200. package/extensions/zalo/skills/zalo-oa-setup.md +236 -236
  201. package/extensions/zalo/skills/zalo-oa-webhook.md +189 -189
  202. package/extensions/zalo/skills/zalo-personal-messaging.md +194 -194
  203. package/extensions/zalo/skills/zalo-personal-setup.md +153 -153
  204. package/extensions/zalo/skills/zalo-rate-guard.md +219 -219
  205. package/hooks/auto-format/index.cjs +48 -48
  206. package/hooks/context-watch/index.cjs +95 -68
  207. package/hooks/hooks.json +111 -111
  208. package/hooks/metrics-collector/index.cjs +86 -42
  209. package/hooks/post-session-reflect/index.cjs +189 -153
  210. package/hooks/pre-compact/index.cjs +95 -95
  211. package/hooks/run-hook.cmd +1 -1
  212. package/hooks/secrets-scan/index.cjs +100 -100
  213. package/hooks/session-start/index.cjs +71 -65
  214. package/hooks/typecheck/index.cjs +65 -65
  215. package/package.json +63 -63
  216. package/references/ui-pro-max-data/LICENSE-UI-PRO-MAX +21 -21
  217. package/references/ui-pro-max-data/charts.csv +26 -26
  218. package/references/ui-pro-max-data/colors.csv +161 -161
  219. package/references/ui-pro-max-data/styles.csv +68 -68
  220. package/references/ui-pro-max-data/typography.csv +74 -74
  221. package/references/ui-pro-max-data/ui-reasoning.csv +162 -162
  222. package/references/ui-pro-max-data/ux-guidelines.csv +99 -99
  223. package/skills/adversary/SKILL.md +283 -283
  224. package/skills/asset-creator/SKILL.md +157 -157
  225. package/skills/audit/SKILL.md +148 -2
  226. package/skills/autopsy/SKILL.md +335 -259
  227. package/skills/autopsy/references/repo-analysis-patterns.md +113 -0
  228. package/skills/ba/SKILL.md +72 -2
  229. package/skills/brainstorm/SKILL.md +342 -341
  230. package/skills/browser-pilot/SKILL.md +168 -168
  231. package/skills/constraint-check/SKILL.md +165 -165
  232. package/skills/context-engine/SKILL.md +404 -404
  233. package/skills/cook/SKILL.md +917 -834
  234. package/skills/cook/references/output-format.md +33 -0
  235. package/skills/db/SKILL.md +273 -272
  236. package/skills/debug/SKILL.md +465 -443
  237. package/skills/dependency-doctor/SKILL.md +265 -235
  238. package/skills/deploy/SKILL.md +274 -231
  239. package/skills/design/DESIGN-REFERENCE.md +365 -365
  240. package/skills/design/SKILL.md +589 -482
  241. package/skills/doc-processor/SKILL.md +254 -254
  242. package/skills/docs/SKILL.md +374 -373
  243. package/skills/docs-seeker/SKILL.md +177 -177
  244. package/skills/fix/SKILL.md +330 -308
  245. package/skills/git/SKILL.md +339 -339
  246. package/skills/graft/SKILL.md +352 -0
  247. package/skills/graft/references/challenge-framework.md +98 -0
  248. package/skills/graft/references/mode-decision.md +44 -0
  249. package/skills/hallucination-guard/SKILL.md +219 -219
  250. package/skills/incident/SKILL.md +254 -251
  251. package/skills/integrity-check/SKILL.md +169 -169
  252. package/skills/journal/SKILL.md +240 -238
  253. package/skills/launch/SKILL.md +344 -342
  254. package/skills/logic-guardian/SKILL.md +251 -251
  255. package/skills/marketing/SKILL.md +290 -245
  256. package/skills/mcp-builder/SKILL.md +425 -423
  257. package/skills/mcp-builder/references/auto-discovery-pattern.md +169 -0
  258. package/skills/neural-memory/SKILL.md +362 -362
  259. package/skills/onboard/SKILL.md +404 -403
  260. package/skills/perf/SKILL.md +346 -346
  261. package/skills/plan/SKILL.md +433 -370
  262. package/skills/plan/references/feature-map.md +84 -0
  263. package/skills/preflight/SKILL.md +415 -396
  264. package/skills/problem-solver/SKILL.md +380 -284
  265. package/skills/rescue/SKILL.md +474 -450
  266. package/skills/retro/SKILL.md +5 -1
  267. package/skills/review/SKILL.md +612 -535
  268. package/skills/review-intake/SKILL.md +249 -249
  269. package/skills/safeguard/SKILL.md +200 -200
  270. package/skills/sast/SKILL.md +190 -190
  271. package/skills/scaffold/SKILL.md +328 -286
  272. package/skills/scope-guard/SKILL.md +180 -162
  273. package/skills/scout/SKILL.md +263 -263
  274. package/skills/sentinel/SKILL.md +382 -353
  275. package/skills/sentinel-env/SKILL.md +254 -254
  276. package/skills/sequential-thinking/SKILL.md +234 -234
  277. package/skills/session-bridge/SKILL.md +543 -397
  278. package/skills/skill-forge/SKILL.md +581 -539
  279. package/skills/skill-router/{skill.md → SKILL.md} +30 -2
  280. package/skills/surgeon/SKILL.md +215 -215
  281. package/skills/team/SKILL.md +556 -514
  282. package/skills/test/SKILL.md +614 -587
  283. package/skills/trend-scout/SKILL.md +145 -145
  284. package/skills/verification/SKILL.md +326 -325
  285. package/skills/video-creator/SKILL.md +201 -201
  286. package/skills/watchdog/SKILL.md +168 -168
  287. package/skills/worktree/SKILL.md +140 -140
@@ -1,139 +1,139 @@
1
- ---
2
- name: "onboarding-flow"
3
- pack: "@rune/saas"
4
- description: "User onboarding patterns — progressive disclosure, setup wizards, product tours, activation metrics (AARRR), empty states, re-engagement, and invite flows."
5
- model: sonnet
6
- tools: [Read, Edit, Write, Grep, Glob, Bash]
7
- ---
8
-
9
- # onboarding-flow
10
-
11
- User onboarding patterns — progressive disclosure, setup wizards, product tours, activation metrics (AARRR), empty states, re-engagement, and invite flows.
12
-
13
- #### Workflow
14
-
15
- **Step 1 — Detect onboarding state**
16
- Use Grep to find onboarding code: `onboarding`, `setup`, `wizard`, `tour`, `welcome`, `getting-started`, `empty-state`, `invite`. Read the signup/post-registration flow to understand what happens after account creation.
17
-
18
- **Step 2 — Audit activation funnel**
19
- Check for: signup → empty dashboard (no guidance), missing setup wizard for critical config, no progress indicator during multi-step setup, empty states without action prompts, invite flow that doesn't pre-populate team context, no activation metric tracking.
20
-
21
- **Step 3 — Emit onboarding patterns**
22
- Emit: multi-step setup wizard with progress persistence (resume on reload), context-aware empty states with primary action, team invite flow with role selection, activation checklist component, and analytics event tracking for funnel steps.
23
-
24
- **Step 4 — Activation metric framework (AARRR)**
25
- Define your "Aha moment" — the single action that correlates with long-term retention. Common patterns: "created first project + invited one teammate" (Slack), "connected data source" (analytics tools), "ran first workflow" (automation tools). Instrument this event explicitly: `analytics.track('activation_achieved', { userId, tenantId, daysFromSignup })`. Track activation rate weekly. If <40% of signups activate in 7 days, the onboarding is broken.
26
-
27
- **Step 5 — Re-engagement for dormant users**
28
- Detect dormant: user signed up but never achieved activation, OR activated user with no activity in 14 days. Trigger: Day 3 after signup with no activation → in-app banner + email tip. Day 7 → personalized email with "here's what you haven't tried yet". Day 14 → offer a guided setup call or live demo. Track re-engagement conversion rate separately from organic activation.
29
-
30
- #### Example
31
-
32
- ```typescript
33
- // Onboarding wizard with progress persistence + analytics
34
- const ONBOARDING_STEPS = ['profile', 'workspace', 'invite_team', 'first_project'] as const;
35
- type Step = typeof ONBOARDING_STEPS[number];
36
-
37
- function useOnboarding() {
38
- const [progress, setProgress] = useLocalStorage<Record<Step, boolean>>('onboarding', {
39
- profile: false, workspace: false, invite_team: false, first_project: false,
40
- });
41
-
42
- const currentStep = ONBOARDING_STEPS.find(step => !progress[step]) ?? null;
43
- const complete = (step: Step) => {
44
- setProgress(prev => ({ ...prev, [step]: true }));
45
- analytics.track('onboarding_step_complete', { step, totalSteps: ONBOARDING_STEPS.length });
46
- };
47
- const isComplete = currentStep === null;
48
- const percentComplete = (Object.values(progress).filter(Boolean).length / ONBOARDING_STEPS.length) * 100;
49
- return { currentStep, complete, isComplete, percentComplete, progress };
50
- }
51
-
52
- // Empty state library — 5 common SaaS empty states
53
- const EMPTY_STATES = {
54
- no_projects: {
55
- icon: 'FolderIcon',
56
- title: 'No projects yet',
57
- description: 'Create your first project to get started.',
58
- cta: { label: 'Create Project', href: '/projects/new' },
59
- },
60
- no_team_members: {
61
- icon: 'UsersIcon',
62
- title: 'You\'re working alone',
63
- description: 'Invite your team to collaborate.',
64
- cta: { label: 'Invite Teammates', href: '/settings/members' },
65
- },
66
- no_data: {
67
- icon: 'ChartIcon',
68
- title: 'No data yet',
69
- description: 'Connect your first data source to see analytics.',
70
- cta: { label: 'Connect Source', href: '/integrations' },
71
- },
72
- no_integrations: {
73
- icon: 'PlugIcon',
74
- title: 'No integrations connected',
75
- description: 'Connect your tools to unlock automation.',
76
- cta: { label: 'Browse Integrations', href: '/integrations' },
77
- },
78
- no_billing: {
79
- icon: 'CreditCardIcon',
80
- title: 'No payment method',
81
- description: 'Add a payment method to unlock Pro features.',
82
- cta: { label: 'Add Payment Method', href: '/settings/billing' },
83
- },
84
- } as const;
85
-
86
- // Product tour — step-by-step spotlight with dismiss/snooze
87
- interface TourStep { target: string; title: string; description: string; position: 'top' | 'bottom' | 'left' | 'right'; }
88
-
89
- function useProductTour(tourId: string, steps: TourStep[]) {
90
- const [state, setState] = useLocalStorage<{ completed: boolean; dismissed: boolean; step: number }>(`tour:${tourId}`, {
91
- completed: false, dismissed: false, step: 0,
92
- });
93
-
94
- const advance = () => {
95
- if (state.step + 1 >= steps.length) {
96
- setState(s => ({ ...s, completed: true }));
97
- analytics.track('product_tour_completed', { tourId });
98
- } else {
99
- setState(s => ({ ...s, step: s.step + 1 }));
100
- }
101
- };
102
-
103
- const dismiss = (snoozeMinutes?: number) => {
104
- if (snoozeMinutes) {
105
- const snoozeUntil = Date.now() + snoozeMinutes * 60_000;
106
- setState(s => ({ ...s, dismissed: true }));
107
- localStorage.setItem(`tour:${tourId}:snooze`, String(snoozeUntil));
108
- } else {
109
- setState(s => ({ ...s, dismissed: true }));
110
- analytics.track('product_tour_dismissed', { tourId, atStep: state.step });
111
- }
112
- };
113
-
114
- const isSnoozed = () => {
115
- const snoozeUntil = Number(localStorage.getItem(`tour:${tourId}:snooze`) ?? 0);
116
- return Date.now() < snoozeUntil;
117
- };
118
-
119
- const active = !state.completed && !state.dismissed && !isSnoozed();
120
- return { active, currentStep: steps[state.step], stepIndex: state.step, advance, dismiss };
121
- }
122
-
123
- // Re-engagement detection — server-side cron
124
- const detectDormantUsers = async () => {
125
- const sevenDaysAgo = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
126
- const dormant = await prisma.user.findMany({
127
- where: {
128
- createdAt: { lt: sevenDaysAgo },
129
- activatedAt: null, // never completed activation
130
- lastReEngagementEmailAt: null,
131
- },
132
- take: 500,
133
- });
134
- for (const user of dormant) {
135
- await emailQueue.add('re-engagement', { userId: user.id });
136
- await prisma.user.update({ where: { id: user.id }, data: { lastReEngagementEmailAt: new Date() } });
137
- }
138
- };
139
- ```
1
+ ---
2
+ name: "onboarding-flow"
3
+ pack: "@rune/saas"
4
+ description: "User onboarding patterns — progressive disclosure, setup wizards, product tours, activation metrics (AARRR), empty states, re-engagement, and invite flows."
5
+ model: sonnet
6
+ tools: [Read, Edit, Write, Grep, Glob, Bash]
7
+ ---
8
+
9
+ # onboarding-flow
10
+
11
+ User onboarding patterns — progressive disclosure, setup wizards, product tours, activation metrics (AARRR), empty states, re-engagement, and invite flows.
12
+
13
+ #### Workflow
14
+
15
+ **Step 1 — Detect onboarding state**
16
+ Use Grep to find onboarding code: `onboarding`, `setup`, `wizard`, `tour`, `welcome`, `getting-started`, `empty-state`, `invite`. Read the signup/post-registration flow to understand what happens after account creation.
17
+
18
+ **Step 2 — Audit activation funnel**
19
+ Check for: signup → empty dashboard (no guidance), missing setup wizard for critical config, no progress indicator during multi-step setup, empty states without action prompts, invite flow that doesn't pre-populate team context, no activation metric tracking.
20
+
21
+ **Step 3 — Emit onboarding patterns**
22
+ Emit: multi-step setup wizard with progress persistence (resume on reload), context-aware empty states with primary action, team invite flow with role selection, activation checklist component, and analytics event tracking for funnel steps.
23
+
24
+ **Step 4 — Activation metric framework (AARRR)**
25
+ Define your "Aha moment" — the single action that correlates with long-term retention. Common patterns: "created first project + invited one teammate" (Slack), "connected data source" (analytics tools), "ran first workflow" (automation tools). Instrument this event explicitly: `analytics.track('activation_achieved', { userId, tenantId, daysFromSignup })`. Track activation rate weekly. If <40% of signups activate in 7 days, the onboarding is broken.
26
+
27
+ **Step 5 — Re-engagement for dormant users**
28
+ Detect dormant: user signed up but never achieved activation, OR activated user with no activity in 14 days. Trigger: Day 3 after signup with no activation → in-app banner + email tip. Day 7 → personalized email with "here's what you haven't tried yet". Day 14 → offer a guided setup call or live demo. Track re-engagement conversion rate separately from organic activation.
29
+
30
+ #### Example
31
+
32
+ ```typescript
33
+ // Onboarding wizard with progress persistence + analytics
34
+ const ONBOARDING_STEPS = ['profile', 'workspace', 'invite_team', 'first_project'] as const;
35
+ type Step = typeof ONBOARDING_STEPS[number];
36
+
37
+ function useOnboarding() {
38
+ const [progress, setProgress] = useLocalStorage<Record<Step, boolean>>('onboarding', {
39
+ profile: false, workspace: false, invite_team: false, first_project: false,
40
+ });
41
+
42
+ const currentStep = ONBOARDING_STEPS.find(step => !progress[step]) ?? null;
43
+ const complete = (step: Step) => {
44
+ setProgress(prev => ({ ...prev, [step]: true }));
45
+ analytics.track('onboarding_step_complete', { step, totalSteps: ONBOARDING_STEPS.length });
46
+ };
47
+ const isComplete = currentStep === null;
48
+ const percentComplete = (Object.values(progress).filter(Boolean).length / ONBOARDING_STEPS.length) * 100;
49
+ return { currentStep, complete, isComplete, percentComplete, progress };
50
+ }
51
+
52
+ // Empty state library — 5 common SaaS empty states
53
+ const EMPTY_STATES = {
54
+ no_projects: {
55
+ icon: 'FolderIcon',
56
+ title: 'No projects yet',
57
+ description: 'Create your first project to get started.',
58
+ cta: { label: 'Create Project', href: '/projects/new' },
59
+ },
60
+ no_team_members: {
61
+ icon: 'UsersIcon',
62
+ title: 'You\'re working alone',
63
+ description: 'Invite your team to collaborate.',
64
+ cta: { label: 'Invite Teammates', href: '/settings/members' },
65
+ },
66
+ no_data: {
67
+ icon: 'ChartIcon',
68
+ title: 'No data yet',
69
+ description: 'Connect your first data source to see analytics.',
70
+ cta: { label: 'Connect Source', href: '/integrations' },
71
+ },
72
+ no_integrations: {
73
+ icon: 'PlugIcon',
74
+ title: 'No integrations connected',
75
+ description: 'Connect your tools to unlock automation.',
76
+ cta: { label: 'Browse Integrations', href: '/integrations' },
77
+ },
78
+ no_billing: {
79
+ icon: 'CreditCardIcon',
80
+ title: 'No payment method',
81
+ description: 'Add a payment method to unlock Pro features.',
82
+ cta: { label: 'Add Payment Method', href: '/settings/billing' },
83
+ },
84
+ } as const;
85
+
86
+ // Product tour — step-by-step spotlight with dismiss/snooze
87
+ interface TourStep { target: string; title: string; description: string; position: 'top' | 'bottom' | 'left' | 'right'; }
88
+
89
+ function useProductTour(tourId: string, steps: TourStep[]) {
90
+ const [state, setState] = useLocalStorage<{ completed: boolean; dismissed: boolean; step: number }>(`tour:${tourId}`, {
91
+ completed: false, dismissed: false, step: 0,
92
+ });
93
+
94
+ const advance = () => {
95
+ if (state.step + 1 >= steps.length) {
96
+ setState(s => ({ ...s, completed: true }));
97
+ analytics.track('product_tour_completed', { tourId });
98
+ } else {
99
+ setState(s => ({ ...s, step: s.step + 1 }));
100
+ }
101
+ };
102
+
103
+ const dismiss = (snoozeMinutes?: number) => {
104
+ if (snoozeMinutes) {
105
+ const snoozeUntil = Date.now() + snoozeMinutes * 60_000;
106
+ setState(s => ({ ...s, dismissed: true }));
107
+ localStorage.setItem(`tour:${tourId}:snooze`, String(snoozeUntil));
108
+ } else {
109
+ setState(s => ({ ...s, dismissed: true }));
110
+ analytics.track('product_tour_dismissed', { tourId, atStep: state.step });
111
+ }
112
+ };
113
+
114
+ const isSnoozed = () => {
115
+ const snoozeUntil = Number(localStorage.getItem(`tour:${tourId}:snooze`) ?? 0);
116
+ return Date.now() < snoozeUntil;
117
+ };
118
+
119
+ const active = !state.completed && !state.dismissed && !isSnoozed();
120
+ return { active, currentStep: steps[state.step], stepIndex: state.step, advance, dismiss };
121
+ }
122
+
123
+ // Re-engagement detection — server-side cron
124
+ const detectDormantUsers = async () => {
125
+ const sevenDaysAgo = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000);
126
+ const dormant = await prisma.user.findMany({
127
+ where: {
128
+ createdAt: { lt: sevenDaysAgo },
129
+ activatedAt: null, // never completed activation
130
+ lastReEngagementEmailAt: null,
131
+ },
132
+ take: 500,
133
+ });
134
+ for (const user of dormant) {
135
+ await emailQueue.add('re-engagement', { userId: user.id });
136
+ await prisma.user.update({ where: { id: user.id }, data: { lastReEngagementEmailAt: new Date() } });
137
+ }
138
+ };
139
+ ```
@@ -1,95 +1,95 @@
1
- ---
2
- name: "subscription-flow"
3
- pack: "@rune/saas"
4
- description: "Subscription UI flows — pricing page, checkout, plan upgrades/downgrades, plan migration, annual/monthly toggle with proration preview, coupon codes, lifetime deal support, and cancellation with retention."
5
- model: sonnet
6
- tools: [Read, Edit, Write, Grep, Glob, Bash]
7
- ---
8
-
9
- # subscription-flow
10
-
11
- Subscription UI flows — pricing page, checkout, plan upgrades/downgrades, plan migration, annual/monthly toggle with proration preview, coupon codes, lifetime deal support, and cancellation with retention.
12
-
13
- #### Workflow
14
-
15
- **Step 1 — Detect subscription model**
16
- Use Grep to find plan/tier definitions, feature flags, trial logic, checkout components. Read pricing config to understand: plan tiers, billing intervals, trial duration, feature gates, and upgrade/downgrade rules.
17
-
18
- **Step 2 — Audit subscription UX**
19
- Check for: pricing page without annual toggle, checkout without error recovery, no trial-to-paid conversion flow, plan change without proration explanation, cancellation without retention offer, missing feature gates on protected API routes.
20
-
21
- **Step 3 — Emit subscription patterns**
22
- Emit: type-safe plan configuration, feature gate middleware/hook, checkout flow with error handling, plan change with proration preview, cancellation flow with feedback collection, and trial expiry handling.
23
-
24
- **Step 4 — Plan migration on downgrade**
25
- When a user downgrades to a lower plan that has stricter limits (e.g., Pro 50 projects → Free 3 projects): DO NOT hard-delete over-limit data. Three options: (a) **Read-only grace period** — over-limit items become read-only for 30 days, user prompted to delete or upgrade; (b) **Hard limit** — block new item creation when at limit, existing items preserved; (c) **Grace period + export** — email user with export link, mark items for deletion after 60 days. Default recommendation: option (a) for good UX.
26
-
27
- **Step 5 — Annual/monthly toggle + proration + coupons + lifetime deals**
28
- Show annual price with savings badge ("Save 20%"). On plan change, call Stripe's proration preview endpoint and display "You'll be charged $X today" before confirming. For coupon codes: validate via `stripe.promotionCodes.list`, display discount amount/percentage and expiry. For lifetime deals (AppSumo, LemonSqueezy): create a one-time payment product, on `order_created` webhook set `subscription.plan = 'lifetime'` with `expiresAt = null` — lifetime access never expires.
29
-
30
- #### Example
31
-
32
- ```typescript
33
- // Type-safe plan configuration + feature gating
34
- const PLANS = {
35
- free: { price: 0, limits: { projects: 3, members: 1, storage: '100MB' }, features: ['basic_analytics'] },
36
- pro: { price: 29, limits: { projects: 50, members: 10, storage: '10GB' }, features: ['basic_analytics', 'advanced_analytics', 'api_access', 'priority_support'] },
37
- team: { price: 79, limits: { projects: -1, members: -1, storage: '100GB' }, features: ['basic_analytics', 'advanced_analytics', 'api_access', 'priority_support', 'sso', 'audit_log'] },
38
- lifetime: { price: 199, limits: { projects: -1, members: 25, storage: '50GB' }, features: ['basic_analytics', 'advanced_analytics', 'api_access', 'priority_support'] },
39
- } as const;
40
-
41
- type PlanId = keyof typeof PLANS;
42
- type Feature = typeof PLANS[PlanId]['features'][number];
43
-
44
- function useFeatureGate(feature: Feature): { allowed: boolean; upgradeRequired: PlanId | null } {
45
- const { plan } = useSubscription();
46
- const allowed = (PLANS[plan].features as readonly string[]).includes(feature);
47
- if (allowed) return { allowed: true, upgradeRequired: null };
48
- const requiredPlan = (Object.entries(PLANS) as [PlanId, typeof PLANS[PlanId]][])
49
- .find(([_, p]) => (p.features as readonly string[]).includes(feature));
50
- return { allowed: false, upgradeRequired: requiredPlan?.[0] ?? null };
51
- }
52
-
53
- // Proration preview before plan change
54
- const getProrationPreview = async (tenantId: string, newPriceId: string): Promise<number> => {
55
- const sub = await db.subscription.findUnique({ where: { tenantId } });
56
- const preview = await stripe.invoices.retrieveUpcoming({
57
- customer: sub!.stripeCustomerId,
58
- subscription: sub!.stripeSubscriptionId,
59
- subscription_items: [{ id: sub!.stripeItemId, price: newPriceId }],
60
- subscription_proration_behavior: 'create_prorations',
61
- });
62
- return preview.amount_due / 100; // dollars
63
- };
64
-
65
- // Coupon validation
66
- const validateCoupon = async (code: string) => {
67
- const promos = await stripe.promotionCodes.list({ code, active: true, limit: 1 });
68
- if (!promos.data.length) throw new Error('Invalid or expired coupon');
69
- const promo = promos.data[0];
70
- const coupon = promo.coupon;
71
- return {
72
- id: promo.id,
73
- discount: coupon.percent_off ? `${coupon.percent_off}% off` : `$${(coupon.amount_off! / 100).toFixed(2)} off`,
74
- duration: coupon.duration,
75
- };
76
- };
77
-
78
- // Lifetime deal — LemonSqueezy one-time payment webhook
79
- app.post('/billing/webhook/lemonsqueezy', express.raw({ type: 'application/json' }), async (req, res) => {
80
- // ...signature check...
81
- const payload = JSON.parse(req.body.toString());
82
- if (payload.meta.event_name === 'order_created') {
83
- const email = payload.data.attributes.user_email;
84
- const user = await db.user.findUnique({ where: { email } });
85
- if (user) {
86
- await db.subscription.upsert({
87
- where: { userId: user.id },
88
- update: { plan: 'lifetime', expiresAt: null },
89
- create: { userId: user.id, plan: 'lifetime', expiresAt: null },
90
- });
91
- }
92
- }
93
- res.json({ received: true });
94
- });
95
- ```
1
+ ---
2
+ name: "subscription-flow"
3
+ pack: "@rune/saas"
4
+ description: "Subscription UI flows — pricing page, checkout, plan upgrades/downgrades, plan migration, annual/monthly toggle with proration preview, coupon codes, lifetime deal support, and cancellation with retention."
5
+ model: sonnet
6
+ tools: [Read, Edit, Write, Grep, Glob, Bash]
7
+ ---
8
+
9
+ # subscription-flow
10
+
11
+ Subscription UI flows — pricing page, checkout, plan upgrades/downgrades, plan migration, annual/monthly toggle with proration preview, coupon codes, lifetime deal support, and cancellation with retention.
12
+
13
+ #### Workflow
14
+
15
+ **Step 1 — Detect subscription model**
16
+ Use Grep to find plan/tier definitions, feature flags, trial logic, checkout components. Read pricing config to understand: plan tiers, billing intervals, trial duration, feature gates, and upgrade/downgrade rules.
17
+
18
+ **Step 2 — Audit subscription UX**
19
+ Check for: pricing page without annual toggle, checkout without error recovery, no trial-to-paid conversion flow, plan change without proration explanation, cancellation without retention offer, missing feature gates on protected API routes.
20
+
21
+ **Step 3 — Emit subscription patterns**
22
+ Emit: type-safe plan configuration, feature gate middleware/hook, checkout flow with error handling, plan change with proration preview, cancellation flow with feedback collection, and trial expiry handling.
23
+
24
+ **Step 4 — Plan migration on downgrade**
25
+ When a user downgrades to a lower plan that has stricter limits (e.g., Pro 50 projects → Free 3 projects): DO NOT hard-delete over-limit data. Three options: (a) **Read-only grace period** — over-limit items become read-only for 30 days, user prompted to delete or upgrade; (b) **Hard limit** — block new item creation when at limit, existing items preserved; (c) **Grace period + export** — email user with export link, mark items for deletion after 60 days. Default recommendation: option (a) for good UX.
26
+
27
+ **Step 5 — Annual/monthly toggle + proration + coupons + lifetime deals**
28
+ Show annual price with savings badge ("Save 20%"). On plan change, call Stripe's proration preview endpoint and display "You'll be charged $X today" before confirming. For coupon codes: validate via `stripe.promotionCodes.list`, display discount amount/percentage and expiry. For lifetime deals (AppSumo, LemonSqueezy): create a one-time payment product, on `order_created` webhook set `subscription.plan = 'lifetime'` with `expiresAt = null` — lifetime access never expires.
29
+
30
+ #### Example
31
+
32
+ ```typescript
33
+ // Type-safe plan configuration + feature gating
34
+ const PLANS = {
35
+ free: { price: 0, limits: { projects: 3, members: 1, storage: '100MB' }, features: ['basic_analytics'] },
36
+ pro: { price: 29, limits: { projects: 50, members: 10, storage: '10GB' }, features: ['basic_analytics', 'advanced_analytics', 'api_access', 'priority_support'] },
37
+ team: { price: 79, limits: { projects: -1, members: -1, storage: '100GB' }, features: ['basic_analytics', 'advanced_analytics', 'api_access', 'priority_support', 'sso', 'audit_log'] },
38
+ lifetime: { price: 199, limits: { projects: -1, members: 25, storage: '50GB' }, features: ['basic_analytics', 'advanced_analytics', 'api_access', 'priority_support'] },
39
+ } as const;
40
+
41
+ type PlanId = keyof typeof PLANS;
42
+ type Feature = typeof PLANS[PlanId]['features'][number];
43
+
44
+ function useFeatureGate(feature: Feature): { allowed: boolean; upgradeRequired: PlanId | null } {
45
+ const { plan } = useSubscription();
46
+ const allowed = (PLANS[plan].features as readonly string[]).includes(feature);
47
+ if (allowed) return { allowed: true, upgradeRequired: null };
48
+ const requiredPlan = (Object.entries(PLANS) as [PlanId, typeof PLANS[PlanId]][])
49
+ .find(([_, p]) => (p.features as readonly string[]).includes(feature));
50
+ return { allowed: false, upgradeRequired: requiredPlan?.[0] ?? null };
51
+ }
52
+
53
+ // Proration preview before plan change
54
+ const getProrationPreview = async (tenantId: string, newPriceId: string): Promise<number> => {
55
+ const sub = await db.subscription.findUnique({ where: { tenantId } });
56
+ const preview = await stripe.invoices.retrieveUpcoming({
57
+ customer: sub!.stripeCustomerId,
58
+ subscription: sub!.stripeSubscriptionId,
59
+ subscription_items: [{ id: sub!.stripeItemId, price: newPriceId }],
60
+ subscription_proration_behavior: 'create_prorations',
61
+ });
62
+ return preview.amount_due / 100; // dollars
63
+ };
64
+
65
+ // Coupon validation
66
+ const validateCoupon = async (code: string) => {
67
+ const promos = await stripe.promotionCodes.list({ code, active: true, limit: 1 });
68
+ if (!promos.data.length) throw new Error('Invalid or expired coupon');
69
+ const promo = promos.data[0];
70
+ const coupon = promo.coupon;
71
+ return {
72
+ id: promo.id,
73
+ discount: coupon.percent_off ? `${coupon.percent_off}% off` : `$${(coupon.amount_off! / 100).toFixed(2)} off`,
74
+ duration: coupon.duration,
75
+ };
76
+ };
77
+
78
+ // Lifetime deal — LemonSqueezy one-time payment webhook
79
+ app.post('/billing/webhook/lemonsqueezy', express.raw({ type: 'application/json' }), async (req, res) => {
80
+ // ...signature check...
81
+ const payload = JSON.parse(req.body.toString());
82
+ if (payload.meta.event_name === 'order_created') {
83
+ const email = payload.data.attributes.user_email;
84
+ const user = await db.user.findUnique({ where: { email } });
85
+ if (user) {
86
+ await db.subscription.upsert({
87
+ where: { userId: user.id },
88
+ update: { plan: 'lifetime', expiresAt: null },
89
+ create: { userId: user.id, plan: 'lifetime', expiresAt: null },
90
+ });
91
+ }
92
+ }
93
+ res.json({ received: true });
94
+ });
95
+ ```