@heyai-rules/pilo-masterkit 2.1.0 → 3.1.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.
- package/.agent/agents/PILO_MASTER.md +77 -77
- package/.agent/agents/architect.md +211 -211
- package/.agent/agents/backend-specialist.md +263 -263
- package/.agent/agents/build-error-resolver.md +114 -114
- package/.agent/agents/chief-of-staff.md +151 -151
- package/.agent/agents/code-archaeologist.md +106 -106
- package/.agent/agents/code-reviewer.md +237 -237
- package/.agent/agents/cpp-build-resolver.md +90 -90
- package/.agent/agents/cpp-reviewer.md +72 -72
- package/.agent/agents/csharp-reviewer.md +101 -101
- package/.agent/agents/dart-build-resolver.md +201 -201
- package/.agent/agents/database-architect.md +226 -226
- package/.agent/agents/database-reviewer.md +91 -91
- package/.agent/agents/debugger.md +225 -225
- package/.agent/agents/devops-engineer.md +242 -242
- package/.agent/agents/doc-updater.md +107 -107
- package/.agent/agents/docs-lookup.md +68 -68
- package/.agent/agents/documentation-writer.md +104 -104
- package/.agent/agents/e2e-runner.md +107 -107
- package/.agent/agents/explorer-agent.md +73 -73
- package/.agent/agents/flutter-reviewer.md +243 -243
- package/.agent/agents/frontend-specialist.md +593 -593
- package/.agent/agents/game-developer.md +162 -162
- package/.agent/agents/gan-evaluator.md +209 -209
- package/.agent/agents/gan-generator.md +131 -131
- package/.agent/agents/gan-planner.md +99 -99
- package/.agent/agents/go-build-resolver.md +94 -94
- package/.agent/agents/go-reviewer.md +76 -76
- package/.agent/agents/harness-optimizer.md +35 -35
- package/.agent/agents/healthcare-reviewer.md +83 -83
- package/.agent/agents/java-build-resolver.md +153 -153
- package/.agent/agents/java-reviewer.md +92 -92
- package/.agent/agents/kotlin-build-resolver.md +118 -118
- package/.agent/agents/kotlin-reviewer.md +159 -159
- package/.agent/agents/loop-operator.md +36 -36
- package/.agent/agents/mobile-developer.md +377 -377
- package/.agent/agents/opensource-forker.md +198 -198
- package/.agent/agents/opensource-packager.md +249 -249
- package/.agent/agents/opensource-sanitizer.md +188 -188
- package/.agent/agents/orchestrator.md +416 -416
- package/.agent/agents/penetration-tester.md +188 -188
- package/.agent/agents/performance-optimizer.md +446 -446
- package/.agent/agents/personas/athena-agent/agent.json +10 -10
- package/.agent/agents/personas/athena-agent/athena-backend-logic-architecture-profile.md +3 -3
- package/.agent/agents/personas/athena-agent/context-files/agents.md +1 -1
- package/.agent/agents/personas/athena-agent/context-files/identity.md +1 -1
- package/.agent/agents/personas/athena-agent/context-files/soul.md +1 -1
- package/.agent/agents/personas/athena-agent/context-files/user-predefined.md +1 -1
- package/.agent/agents/personas/athena-agent/user-context-files/system/bootstrap.md +1 -1
- package/.agent/agents/personas/athena-agent/user-context-files/system/user.md +1 -1
- package/.agent/agents/personas/da-vinci-agent/agent.json +10 -10
- package/.agent/agents/personas/da-vinci-agent/context-files/agents.md +1 -1
- package/.agent/agents/personas/da-vinci-agent/context-files/identity.md +1 -1
- package/.agent/agents/personas/da-vinci-agent/context-files/soul.md +1 -1
- package/.agent/agents/personas/da-vinci-agent/context-files/user-predefined.md +1 -1
- package/.agent/agents/personas/da-vinci-agent/da-vinci-frontend-ui-ux-design-profile.md +3 -3
- package/.agent/agents/personas/da-vinci-agent/user-context-files/system/bootstrap.md +1 -1
- package/.agent/agents/personas/da-vinci-agent/user-context-files/system/user.md +1 -1
- package/.agent/agents/personas/duong-tang-agent/agent.json +10 -10
- package/.agent/agents/personas/duong-tang-agent/context-files/agents.md +1 -1
- package/.agent/agents/personas/duong-tang-agent/context-files/identity.md +1 -1
- package/.agent/agents/personas/duong-tang-agent/context-files/soul.md +1 -1
- package/.agent/agents/personas/duong-tang-agent/context-files/user-predefined.md +1 -1
- package/.agent/agents/personas/duong-tang-agent/tang-monk-quality-testing-documentation-profile.md +3 -3
- package/.agent/agents/personas/duong-tang-agent/user-context-files/system/bootstrap.md +1 -1
- package/.agent/agents/personas/duong-tang-agent/user-context-files/system/user.md +1 -1
- package/.agent/agents/personas/gia-cat-luong-agent/agent.json +10 -10
- package/.agent/agents/personas/gia-cat-luong-agent/context-files/agents.md +1 -1
- package/.agent/agents/personas/gia-cat-luong-agent/context-files/identity.md +1 -1
- package/.agent/agents/personas/gia-cat-luong-agent/context-files/soul.md +1 -1
- package/.agent/agents/personas/gia-cat-luong-agent/context-files/user-predefined.md +1 -1
- package/.agent/agents/personas/gia-cat-luong-agent/kongming-research-strategy-analysis-profile.md +3 -3
- package/.agent/agents/personas/gia-cat-luong-agent/user-context-files/system/bootstrap.md +1 -1
- package/.agent/agents/personas/gia-cat-luong-agent/user-context-files/system/user.md +1 -1
- package/.agent/agents/personas/mihata-agent/agent.json +10 -10
- package/.agent/agents/personas/mihata-agent/context-files/agents.md +1 -1
- package/.agent/agents/personas/mihata-agent/context-files/identity.md +1 -1
- package/.agent/agents/personas/mihata-agent/context-files/soul.md +1 -1
- package/.agent/agents/personas/mihata-agent/context-files/user-predefined.md +1 -1
- package/.agent/agents/personas/mihata-agent/mihata-multi-agent-orchestration-profile.md +3 -3
- package/.agent/agents/personas/mihata-agent/user-context-files/system/bootstrap.md +1 -1
- package/.agent/agents/personas/mihata-agent/user-context-files/system/user.md +1 -1
- package/.agent/agents/personas/tesla-agent/agent.json +10 -10
- package/.agent/agents/personas/tesla-agent/context-files/agents.md +1 -1
- package/.agent/agents/personas/tesla-agent/context-files/identity.md +1 -1
- package/.agent/agents/personas/tesla-agent/context-files/soul.md +1 -1
- package/.agent/agents/personas/tesla-agent/context-files/user-predefined.md +1 -1
- package/.agent/agents/personas/tesla-agent/tesla-fullstack-system-optimization-profile.md +3 -3
- package/.agent/agents/personas/tesla-agent/user-context-files/system/bootstrap.md +1 -1
- package/.agent/agents/personas/tesla-agent/user-context-files/system/user.md +1 -1
- package/.agent/agents/personas/tu-ma-y-agent/agent.json +10 -10
- package/.agent/agents/personas/tu-ma-y-agent/context-files/agents.md +1 -1
- package/.agent/agents/personas/tu-ma-y-agent/context-files/identity.md +1 -1
- package/.agent/agents/personas/tu-ma-y-agent/context-files/soul.md +1 -1
- package/.agent/agents/personas/tu-ma-y-agent/context-files/user-predefined.md +1 -1
- package/.agent/agents/personas/tu-ma-y-agent/simayi-feasibility-risk-control-profile.md +3 -3
- package/.agent/agents/personas/tu-ma-y-agent/user-context-files/system/bootstrap.md +1 -1
- package/.agent/agents/personas/tu-ma-y-agent/user-context-files/system/user.md +1 -1
- package/.agent/agents/personas/venti-agent/agent.json +10 -10
- package/.agent/agents/personas/venti-agent/context-files/agents.md +1 -1
- package/.agent/agents/personas/venti-agent/context-files/identity.md +1 -1
- package/.agent/agents/personas/venti-agent/context-files/soul.md +1 -1
- package/.agent/agents/personas/venti-agent/context-files/user-predefined.md +1 -1
- package/.agent/agents/personas/venti-agent/user-context-files/system/bootstrap.md +1 -1
- package/.agent/agents/personas/venti-agent/user-context-files/system/user.md +1 -1
- package/.agent/agents/personas/venti-agent/venti-learning-communication-mentoring-profile.md +3 -3
- package/.agent/agents/planner.md +212 -212
- package/.agent/agents/product-manager.md +112 -112
- package/.agent/agents/product-owner.md +95 -95
- package/.agent/agents/project-planner.md +406 -406
- package/.agent/agents/python-reviewer.md +98 -98
- package/.agent/agents/pytorch-build-resolver.md +120 -120
- package/.agent/agents/qa-automation-engineer.md +103 -103
- package/.agent/agents/refactor-cleaner.md +85 -85
- package/.agent/agents/rust-build-resolver.md +148 -148
- package/.agent/agents/rust-reviewer.md +94 -94
- package/.agent/agents/security-auditor.md +170 -170
- package/.agent/agents/security-reviewer.md +108 -108
- package/.agent/agents/seo-specialist.md +111 -111
- package/.agent/agents/tdd-guide.md +91 -91
- package/.agent/agents/test-engineer.md +158 -158
- package/.agent/agents/typescript-reviewer.md +112 -112
- package/.agent/contexts/dev.md +20 -20
- package/.agent/contexts/research.md +26 -26
- package/.agent/contexts/review.md +22 -22
- package/.agent/hooks/hooks.json +395 -395
- package/.agent/hooks/readme.md +222 -222
- package/.agent/mcp-configs/mcp-servers.json +181 -181
- package/.agent/rules/ARCHITECTURAL_BLUEPRINTS.md +62 -62
- package/.agent/rules/CODE_CRAFTSMANSHIP.md +69 -69
- package/.agent/rules/CORE_RULES.md +72 -72
- package/.agent/rules/PROJECT_MAP.md +58 -58
- package/.agent/rules/QUALITY_ASSURANCE.md +54 -54
- package/.agent/rules/SECURITY_ARMOR.md +44 -44
- package/.agent/rules/VERSION_ORCHESTRATION.md +64 -64
- package/.agent/rules/WORKFLOW_ORCHESTRATION.md +55 -55
- package/.agent/rules/common/agents.md +50 -50
- package/.agent/rules/common/code-review.md +124 -124
- package/.agent/rules/common/coding-style.md +48 -48
- package/.agent/rules/common/development-workflow.md +44 -44
- package/.agent/rules/common/git-workflow.md +24 -24
- package/.agent/rules/common/hooks.md +30 -30
- package/.agent/rules/common/patterns.md +31 -31
- package/.agent/rules/common/performance.md +55 -55
- package/.agent/rules/common/security.md +29 -29
- package/.agent/rules/common/testing.md +29 -29
- package/.agent/rules/cpp/coding-style.md +44 -44
- package/.agent/rules/cpp/hooks.md +39 -39
- package/.agent/rules/cpp/patterns.md +51 -51
- package/.agent/rules/cpp/security.md +51 -51
- package/.agent/rules/cpp/testing.md +44 -44
- package/.agent/rules/csharp/coding-style.md +72 -72
- package/.agent/rules/csharp/hooks.md +25 -25
- package/.agent/rules/csharp/patterns.md +50 -50
- package/.agent/rules/csharp/security.md +58 -58
- package/.agent/rules/csharp/testing.md +46 -46
- package/.agent/rules/dart/coding-style.md +159 -159
- package/.agent/rules/dart/hooks.md +66 -66
- package/.agent/rules/dart/patterns.md +261 -261
- package/.agent/rules/dart/security.md +135 -135
- package/.agent/rules/dart/testing.md +215 -215
- package/.agent/rules/golang/coding-style.md +32 -32
- package/.agent/rules/golang/hooks.md +17 -17
- package/.agent/rules/golang/patterns.md +45 -45
- package/.agent/rules/golang/security.md +34 -34
- package/.agent/rules/golang/testing.md +31 -31
- package/.agent/rules/java/coding-style.md +114 -114
- package/.agent/rules/java/hooks.md +18 -18
- package/.agent/rules/java/patterns.md +146 -146
- package/.agent/rules/java/security.md +100 -100
- package/.agent/rules/java/testing.md +131 -131
- package/.agent/rules/kotlin/coding-style.md +86 -86
- package/.agent/rules/kotlin/hooks.md +17 -17
- package/.agent/rules/kotlin/patterns.md +146 -146
- package/.agent/rules/kotlin/security.md +82 -82
- package/.agent/rules/kotlin/testing.md +128 -128
- package/.agent/rules/perl/coding-style.md +46 -46
- package/.agent/rules/perl/hooks.md +22 -22
- package/.agent/rules/perl/patterns.md +76 -76
- package/.agent/rules/perl/security.md +69 -69
- package/.agent/rules/perl/testing.md +54 -54
- package/.agent/rules/php/coding-style.md +40 -40
- package/.agent/rules/php/hooks.md +24 -24
- package/.agent/rules/php/patterns.md +33 -33
- package/.agent/rules/php/security.md +37 -37
- package/.agent/rules/php/testing.md +39 -39
- package/.agent/rules/python/coding-style.md +42 -42
- package/.agent/rules/python/hooks.md +19 -19
- package/.agent/rules/python/patterns.md +39 -39
- package/.agent/rules/python/security.md +30 -30
- package/.agent/rules/python/testing.md +38 -38
- package/.agent/rules/readme.md +111 -111
- package/.agent/rules/rust/coding-style.md +151 -151
- package/.agent/rules/rust/hooks.md +16 -16
- package/.agent/rules/rust/patterns.md +168 -168
- package/.agent/rules/rust/security.md +141 -141
- package/.agent/rules/rust/testing.md +154 -154
- package/.agent/rules/swift/coding-style.md +47 -47
- package/.agent/rules/swift/hooks.md +20 -20
- package/.agent/rules/swift/patterns.md +66 -66
- package/.agent/rules/swift/security.md +33 -33
- package/.agent/rules/swift/testing.md +45 -45
- package/.agent/rules/typescript/coding-style.md +199 -199
- package/.agent/rules/typescript/hooks.md +22 -22
- package/.agent/rules/typescript/patterns.md +52 -52
- package/.agent/rules/typescript/security.md +28 -28
- package/.agent/rules/typescript/testing.md +18 -18
- package/.agent/rules/web/coding-style.md +96 -96
- package/.agent/rules/web/design-quality.md +63 -63
- package/.agent/rules/web/hooks.md +120 -120
- package/.agent/rules/web/patterns.md +79 -79
- package/.agent/rules/web/performance.md +64 -64
- package/.agent/rules/web/security.md +57 -57
- package/.agent/rules/web/testing.md +55 -55
- package/.agent/rules/zh/agents.md +50 -50
- package/.agent/rules/zh/code-review.md +124 -124
- package/.agent/rules/zh/coding-style.md +48 -48
- package/.agent/rules/zh/development-workflow.md +44 -44
- package/.agent/rules/zh/git-workflow.md +24 -24
- package/.agent/rules/zh/hooks.md +30 -30
- package/.agent/rules/zh/patterns.md +31 -31
- package/.agent/rules/zh/performance.md +55 -55
- package/.agent/rules/zh/readme.md +108 -108
- package/.agent/rules/zh/security.md +29 -29
- package/.agent/rules/zh/testing.md +29 -29
- package/.agent/scripts/auto_preview.py +148 -148
- package/.agent/scripts/checklist.py +217 -217
- package/.agent/scripts/session_manager.py +120 -120
- package/.agent/scripts/verify_all.py +327 -327
- package/.agent/skills/agent-eval/SKILL.md +145 -145
- package/.agent/skills/agent-harness-construction/SKILL.md +73 -73
- package/.agent/skills/agent-payment-x402/SKILL.md +178 -178
- package/.agent/skills/agentic-engineering/SKILL.md +63 -63
- package/.agent/skills/ai-first-engineering/SKILL.md +51 -51
- package/.agent/skills/ai-regression-testing/SKILL.md +385 -385
- package/.agent/skills/android-clean-architecture/SKILL.md +339 -339
- package/.agent/skills/api-design/SKILL.md +523 -523
- package/.agent/skills/api-patterns/SKILL.md +81 -81
- package/.agent/skills/api-patterns/api-style.md +42 -42
- package/.agent/skills/api-patterns/auth.md +24 -24
- package/.agent/skills/api-patterns/documentation.md +26 -26
- package/.agent/skills/api-patterns/graphql.md +41 -41
- package/.agent/skills/api-patterns/rate-limiting.md +31 -31
- package/.agent/skills/api-patterns/response.md +37 -37
- package/.agent/skills/api-patterns/rest.md +40 -40
- package/.agent/skills/api-patterns/scripts/api_validator.py +211 -211
- package/.agent/skills/api-patterns/security-testing.md +122 -122
- package/.agent/skills/api-patterns/trpc.md +41 -41
- package/.agent/skills/api-patterns/versioning.md +22 -22
- package/.agent/skills/app-builder/SKILL.md +75 -75
- package/.agent/skills/app-builder/agent-coordination.md +71 -71
- package/.agent/skills/app-builder/feature-building.md +53 -53
- package/.agent/skills/app-builder/project-detection.md +34 -34
- package/.agent/skills/app-builder/scaffolding.md +118 -118
- package/.agent/skills/app-builder/tech-stack.md +41 -41
- package/.agent/skills/app-builder/templates/SKILL.md +39 -39
- package/.agent/skills/app-builder/templates/astro-static/TEMPLATE.md +76 -76
- package/.agent/skills/app-builder/templates/chrome-extension/TEMPLATE.md +92 -92
- package/.agent/skills/app-builder/templates/cli-tool/TEMPLATE.md +88 -88
- package/.agent/skills/app-builder/templates/electron-desktop/TEMPLATE.md +88 -88
- package/.agent/skills/app-builder/templates/express-api/TEMPLATE.md +83 -83
- package/.agent/skills/app-builder/templates/flutter-app/TEMPLATE.md +90 -90
- package/.agent/skills/app-builder/templates/monorepo-turborepo/TEMPLATE.md +90 -90
- package/.agent/skills/app-builder/templates/nextjs-fullstack/TEMPLATE.md +122 -122
- package/.agent/skills/app-builder/templates/nextjs-saas/TEMPLATE.md +122 -122
- package/.agent/skills/app-builder/templates/nextjs-static/TEMPLATE.md +169 -169
- package/.agent/skills/app-builder/templates/nuxt-app/TEMPLATE.md +134 -134
- package/.agent/skills/app-builder/templates/python-fastapi/TEMPLATE.md +83 -83
- package/.agent/skills/app-builder/templates/react-native-app/TEMPLATE.md +119 -119
- package/.agent/skills/architecture/SKILL.md +55 -55
- package/.agent/skills/architecture/context-discovery.md +43 -43
- package/.agent/skills/architecture/examples.md +94 -94
- package/.agent/skills/architecture/pattern-selection.md +68 -68
- package/.agent/skills/architecture/patterns-reference.md +50 -50
- package/.agent/skills/architecture/trade-off-analysis.md +77 -77
- package/.agent/skills/architecture-decision-records/SKILL.md +179 -179
- package/.agent/skills/article-writing/SKILL.md +79 -79
- package/.agent/skills/autonomous-agent-harness/SKILL.md +267 -267
- package/.agent/skills/autonomous-loops/SKILL.md +610 -610
- package/.agent/skills/backend-patterns/SKILL.md +598 -598
- package/.agent/skills/bash-linux/SKILL.md +199 -199
- package/.agent/skills/behavioral-modes/SKILL.md +242 -242
- package/.agent/skills/benchmark/SKILL.md +93 -93
- package/.agent/skills/blueprint/SKILL.md +105 -105
- package/.agent/skills/brainstorming/SKILL.md +163 -163
- package/.agent/skills/brainstorming/dynamic-questioning.md +350 -350
- package/.agent/skills/brand-voice/SKILL.md +97 -97
- package/.agent/skills/brand-voice/references/voice-profile-schema.md +55 -55
- package/.agent/skills/browser-qa/SKILL.md +87 -87
- package/.agent/skills/bun-runtime/SKILL.md +84 -84
- package/.agent/skills/canary-watch/SKILL.md +99 -99
- package/.agent/skills/carrier-relationship-management/SKILL.md +212 -212
- package/.agent/skills/ck/SKILL.md +147 -147
- package/.agent/skills/ck/commands/forget.mjs +44 -44
- package/.agent/skills/ck/commands/info.mjs +24 -24
- package/.agent/skills/ck/commands/init.mjs +143 -143
- package/.agent/skills/ck/commands/list.mjs +40 -40
- package/.agent/skills/ck/commands/migrate.mjs +202 -202
- package/.agent/skills/ck/commands/resume.mjs +36 -36
- package/.agent/skills/ck/commands/save.mjs +210 -210
- package/.agent/skills/ck/commands/shared.mjs +387 -387
- package/.agent/skills/ck/hooks/session-start.mjs +224 -224
- package/.agent/skills/claude-api/SKILL.md +337 -337
- package/.agent/skills/claude-devfleet/SKILL.md +103 -103
- package/.agent/skills/clean-code/SKILL.md +201 -201
- package/.agent/skills/click-path-audit/SKILL.md +244 -244
- package/.agent/skills/clickhouse-io/SKILL.md +439 -439
- package/.agent/skills/code-review-checklist/SKILL.md +109 -109
- package/.agent/skills/codebase-onboarding/SKILL.md +233 -233
- package/.agent/skills/coding-standards/SKILL.md +530 -530
- package/.agent/skills/compose-multiplatform-patterns/SKILL.md +299 -299
- package/.agent/skills/configure-ecc/SKILL.md +367 -367
- package/.agent/skills/connections-optimizer/SKILL.md +189 -189
- package/.agent/skills/content-engine/SKILL.md +131 -131
- package/.agent/skills/content-hash-cache-pattern/SKILL.md +161 -161
- package/.agent/skills/context-budget/SKILL.md +135 -135
- package/.agent/skills/continuous-agent-loop/SKILL.md +45 -45
- package/.agent/skills/continuous-learning/SKILL.md +119 -119
- package/.agent/skills/continuous-learning/config.json +18 -18
- package/.agent/skills/continuous-learning/evaluate-session.sh +69 -69
- package/.agent/skills/continuous-learning-v2/SKILL.md +365 -365
- package/.agent/skills/continuous-learning-v2/agents/observer-loop.sh +271 -271
- package/.agent/skills/continuous-learning-v2/agents/observer.md +198 -198
- package/.agent/skills/continuous-learning-v2/agents/session-guardian.sh +150 -150
- package/.agent/skills/continuous-learning-v2/agents/start-observer.sh +244 -244
- package/.agent/skills/continuous-learning-v2/config.json +8 -8
- package/.agent/skills/continuous-learning-v2/hooks/observe.sh +428 -428
- package/.agent/skills/continuous-learning-v2/scripts/detect-project.sh +228 -228
- package/.agent/skills/continuous-learning-v2/scripts/instinct-cli.py +1426 -1426
- package/.agent/skills/continuous-learning-v2/scripts/test-parse-instinct.py +984 -984
- package/.agent/skills/cost-aware-llm-pipeline/SKILL.md +183 -183
- package/.agent/skills/cpp-coding-standards/SKILL.md +723 -723
- package/.agent/skills/cpp-testing/SKILL.md +324 -324
- package/.agent/skills/crosspost/SKILL.md +111 -111
- package/.agent/skills/csharp-testing/SKILL.md +321 -321
- package/.agent/skills/customer-billing-ops/SKILL.md +140 -140
- package/.agent/skills/customs-trade-compliance/SKILL.md +263 -263
- package/.agent/skills/dart-flutter-patterns/SKILL.md +563 -563
- package/.agent/skills/data-scraper-agent/SKILL.md +764 -764
- package/.agent/skills/database-design/SKILL.md +52 -52
- package/.agent/skills/database-design/database-selection.md +43 -43
- package/.agent/skills/database-design/indexing.md +39 -39
- package/.agent/skills/database-design/migrations.md +48 -48
- package/.agent/skills/database-design/optimization.md +36 -36
- package/.agent/skills/database-design/orm-selection.md +30 -30
- package/.agent/skills/database-design/schema-design.md +56 -56
- package/.agent/skills/database-design/scripts/schema_validator.py +172 -172
- package/.agent/skills/database-migrations/SKILL.md +429 -429
- package/.agent/skills/deep-research/SKILL.md +155 -155
- package/.agent/skills/deployment-patterns/SKILL.md +427 -427
- package/.agent/skills/deployment-procedures/SKILL.md +241 -241
- package/.agent/skills/design-system/SKILL.md +82 -82
- package/.agent/skills/django-patterns/SKILL.md +734 -734
- package/.agent/skills/django-security/SKILL.md +593 -593
- package/.agent/skills/django-tdd/SKILL.md +729 -729
- package/.agent/skills/django-verification/SKILL.md +469 -469
- package/.agent/skills/dmux-workflows/SKILL.md +191 -191
- package/.agent/skills/doc.md +177 -177
- package/.agent/skills/docker-patterns/SKILL.md +364 -364
- package/.agent/skills/documentation-lookup/SKILL.md +90 -90
- package/.agent/skills/documentation-templates/SKILL.md +194 -194
- package/.agent/skills/dotnet-patterns/SKILL.md +321 -321
- package/.agent/skills/e2e-testing/SKILL.md +326 -326
- package/.agent/skills/energy-procurement/SKILL.md +228 -228
- package/.agent/skills/enterprise-agent-ops/SKILL.md +50 -50
- package/.agent/skills/eval-harness/SKILL.md +270 -270
- package/.agent/skills/exa-search/SKILL.md +103 -103
- package/.agent/skills/fal-ai-media/SKILL.md +284 -284
- package/.agent/skills/flutter-dart-code-review/SKILL.md +435 -435
- package/.agent/skills/foundation-models-on-device/SKILL.md +243 -243
- package/.agent/skills/frontend-design/SKILL.md +452 -452
- package/.agent/skills/frontend-design/animation-guide.md +331 -331
- package/.agent/skills/frontend-design/color-system.md +311 -311
- package/.agent/skills/frontend-design/decision-trees.md +418 -418
- package/.agent/skills/frontend-design/motion-graphics.md +306 -306
- package/.agent/skills/frontend-design/scripts/accessibility_checker.py +183 -183
- package/.agent/skills/frontend-design/scripts/ux_audit.py +722 -722
- package/.agent/skills/frontend-design/typography-system.md +345 -345
- package/.agent/skills/frontend-design/ux-psychology.md +1116 -1116
- package/.agent/skills/frontend-design/visual-effects.md +383 -383
- package/.agent/skills/frontend-patterns/SKILL.md +642 -642
- package/.agent/skills/frontend-slides/SKILL.md +184 -184
- package/.agent/skills/frontend-slides/style-presets.md +330 -330
- package/.agent/skills/game-development/2d-games/SKILL.md +119 -119
- package/.agent/skills/game-development/3d-games/SKILL.md +135 -135
- package/.agent/skills/game-development/SKILL.md +167 -167
- package/.agent/skills/game-development/game-art/SKILL.md +185 -185
- package/.agent/skills/game-development/game-audio/SKILL.md +190 -190
- package/.agent/skills/game-development/game-design/SKILL.md +129 -129
- package/.agent/skills/game-development/mobile-games/SKILL.md +108 -108
- package/.agent/skills/game-development/multiplayer/SKILL.md +132 -132
- package/.agent/skills/game-development/pc-games/SKILL.md +144 -144
- package/.agent/skills/game-development/vr-ar/SKILL.md +123 -123
- package/.agent/skills/game-development/web-games/SKILL.md +150 -150
- package/.agent/skills/gan-style-harness/SKILL.md +278 -278
- package/.agent/skills/geo-fundamentals/SKILL.md +156 -156
- package/.agent/skills/geo-fundamentals/scripts/geo_checker.py +289 -289
- package/.agent/skills/git-workflow/SKILL.md +715 -715
- package/.agent/skills/golang-patterns/SKILL.md +674 -674
- package/.agent/skills/golang-testing/SKILL.md +720 -720
- package/.agent/skills/google-workspace-ops/SKILL.md +95 -95
- package/.agent/skills/healthcare-cdss-patterns/SKILL.md +245 -245
- package/.agent/skills/healthcare-emr-patterns/SKILL.md +159 -159
- package/.agent/skills/healthcare-eval-harness/SKILL.md +207 -207
- package/.agent/skills/healthcare-phi-compliance/SKILL.md +145 -145
- package/.agent/skills/hexagonal-architecture/SKILL.md +276 -276
- package/.agent/skills/i18n-localization/SKILL.md +154 -154
- package/.agent/skills/i18n-localization/scripts/i18n_checker.py +241 -241
- package/.agent/skills/intelligent-routing/SKILL.md +335 -335
- package/.agent/skills/inventory-demand-planning/SKILL.md +247 -247
- package/.agent/skills/investor-materials/SKILL.md +96 -96
- package/.agent/skills/investor-outreach/SKILL.md +91 -91
- package/.agent/skills/iterative-retrieval/SKILL.md +211 -211
- package/.agent/skills/java-coding-standards/SKILL.md +147 -147
- package/.agent/skills/jira-integration/SKILL.md +293 -293
- package/.agent/skills/jpa-patterns/SKILL.md +151 -151
- package/.agent/skills/kotlin-coroutines-flows/SKILL.md +284 -284
- package/.agent/skills/kotlin-exposed-patterns/SKILL.md +719 -719
- package/.agent/skills/kotlin-ktor-patterns/SKILL.md +689 -689
- package/.agent/skills/kotlin-patterns/SKILL.md +711 -711
- package/.agent/skills/kotlin-testing/SKILL.md +824 -824
- package/.agent/skills/laravel-patterns/SKILL.md +415 -415
- package/.agent/skills/laravel-plugin-discovery/SKILL.md +229 -229
- package/.agent/skills/laravel-security/SKILL.md +285 -285
- package/.agent/skills/laravel-tdd/SKILL.md +283 -283
- package/.agent/skills/laravel-verification/SKILL.md +179 -179
- package/.agent/skills/lead-intelligence/SKILL.md +321 -321
- package/.agent/skills/lead-intelligence/agents/enrichment-agent.md +85 -85
- package/.agent/skills/lead-intelligence/agents/mutual-mapper.md +75 -75
- package/.agent/skills/lead-intelligence/agents/outreach-drafter.md +98 -98
- package/.agent/skills/lead-intelligence/agents/signal-scorer.md +60 -60
- package/.agent/skills/lint-and-validate/SKILL.md +45 -45
- package/.agent/skills/lint-and-validate/scripts/lint_runner.py +184 -184
- package/.agent/skills/lint-and-validate/scripts/type_coverage.py +173 -173
- package/.agent/skills/liquid-glass-design/SKILL.md +279 -279
- package/.agent/skills/logistics-exception-management/SKILL.md +222 -222
- package/.agent/skills/manim-video/SKILL.md +89 -89
- package/.agent/skills/manim-video/assets/network-graph-scene.py +52 -52
- package/.agent/skills/market-research/SKILL.md +75 -75
- package/.agent/skills/mcp-server-patterns/SKILL.md +67 -67
- package/.agent/skills/mobile-design/SKILL.md +394 -394
- package/.agent/skills/mobile-design/decision-trees.md +516 -516
- package/.agent/skills/mobile-design/mobile-backend.md +491 -491
- package/.agent/skills/mobile-design/mobile-color-system.md +420 -420
- package/.agent/skills/mobile-design/mobile-debugging.md +122 -122
- package/.agent/skills/mobile-design/mobile-design-thinking.md +357 -357
- package/.agent/skills/mobile-design/mobile-navigation.md +458 -458
- package/.agent/skills/mobile-design/mobile-performance.md +767 -767
- package/.agent/skills/mobile-design/mobile-testing.md +356 -356
- package/.agent/skills/mobile-design/mobile-typography.md +433 -433
- package/.agent/skills/mobile-design/platform-android.md +666 -666
- package/.agent/skills/mobile-design/platform-ios.md +561 -561
- package/.agent/skills/mobile-design/scripts/mobile_audit.py +670 -670
- package/.agent/skills/mobile-design/touch-psychology.md +537 -537
- package/.agent/skills/nanoclaw-repl/SKILL.md +33 -33
- package/.agent/skills/nestjs-patterns/SKILL.md +230 -230
- package/.agent/skills/nextjs-react-expert/1-async-eliminating-waterfalls.md +351 -351
- package/.agent/skills/nextjs-react-expert/2-bundle-bundle-size-optimization.md +240 -240
- package/.agent/skills/nextjs-react-expert/3-server-server-side-performance.md +490 -490
- package/.agent/skills/nextjs-react-expert/4-client-client-side-data-fetching.md +264 -264
- package/.agent/skills/nextjs-react-expert/5-rerender-re-render-optimization.md +581 -581
- package/.agent/skills/nextjs-react-expert/6-rendering-rendering-performance.md +432 -432
- package/.agent/skills/nextjs-react-expert/7-js-javascript-performance.md +684 -684
- package/.agent/skills/nextjs-react-expert/8-advanced-advanced-patterns.md +150 -150
- package/.agent/skills/nextjs-react-expert/9-cache-components.md +103 -103
- package/.agent/skills/nextjs-react-expert/SKILL.md +293 -293
- package/.agent/skills/nextjs-react-expert/scripts/convert_rules.py +222 -222
- package/.agent/skills/nextjs-react-expert/scripts/react_performance_checker.py +252 -252
- package/.agent/skills/nextjs-turbopack/SKILL.md +44 -44
- package/.agent/skills/nodejs-best-practices/SKILL.md +333 -333
- package/.agent/skills/nutrient-document-processing/SKILL.md +167 -167
- package/.agent/skills/nuxt4-patterns/SKILL.md +100 -100
- package/.agent/skills/openclaw-persona-forge/SKILL.md +296 -296
- package/.agent/skills/openclaw-persona-forge/gacha.py +224 -224
- package/.agent/skills/openclaw-persona-forge/gacha.sh +5 -5
- package/.agent/skills/openclaw-persona-forge/references/avatar-style.md +124 -124
- package/.agent/skills/openclaw-persona-forge/references/boundary-rules.md +53 -53
- package/.agent/skills/openclaw-persona-forge/references/error-handling.md +53 -53
- package/.agent/skills/openclaw-persona-forge/references/identity-tension.md +48 -48
- package/.agent/skills/openclaw-persona-forge/references/naming-system.md +39 -39
- package/.agent/skills/openclaw-persona-forge/references/output-template.md +166 -166
- package/.agent/skills/opensource-pipeline/SKILL.md +255 -255
- package/.agent/skills/parallel-agents/SKILL.md +175 -175
- package/.agent/skills/performance-profiling/SKILL.md +143 -143
- package/.agent/skills/performance-profiling/scripts/lighthouse_audit.py +76 -76
- package/.agent/skills/perl-patterns/SKILL.md +504 -504
- package/.agent/skills/perl-security/SKILL.md +503 -503
- package/.agent/skills/perl-testing/SKILL.md +475 -475
- package/.agent/skills/plan-writing/SKILL.md +152 -152
- package/.agent/skills/plankton-code-quality/SKILL.md +236 -236
- package/.agent/skills/postgres-patterns/SKILL.md +147 -147
- package/.agent/skills/powershell-windows/SKILL.md +167 -167
- package/.agent/skills/product-lens/SKILL.md +85 -85
- package/.agent/skills/production-scheduling/SKILL.md +238 -238
- package/.agent/skills/project-flow-ops/SKILL.md +111 -111
- package/.agent/skills/project-guidelines-example/SKILL.md +349 -349
- package/.agent/skills/prompt-optimizer/SKILL.md +397 -397
- package/.agent/skills/python-patterns/SKILL.md +750 -750
- package/.agent/skills/python-testing/SKILL.md +816 -816
- package/.agent/skills/pytorch-patterns/SKILL.md +396 -396
- package/.agent/skills/quality-nonconformance/SKILL.md +260 -260
- package/.agent/skills/ralphinho-rfc-pipeline/SKILL.md +67 -67
- package/.agent/skills/red-team-tactics/SKILL.md +199 -199
- package/.agent/skills/regex-vs-llm-structured-text/SKILL.md +220 -220
- package/.agent/skills/remotion-video-creation/SKILL.md +43 -43
- package/.agent/skills/remotion-video-creation/rules/3d.md +86 -86
- package/.agent/skills/remotion-video-creation/rules/animations.md +29 -29
- package/.agent/skills/remotion-video-creation/rules/assets/charts-bar-chart.tsx +173 -173
- package/.agent/skills/remotion-video-creation/rules/assets/text-animations-typewriter.tsx +100 -100
- package/.agent/skills/remotion-video-creation/rules/assets/text-animations-word-highlight.tsx +108 -108
- package/.agent/skills/remotion-video-creation/rules/assets.md +78 -78
- package/.agent/skills/remotion-video-creation/rules/audio.md +172 -172
- package/.agent/skills/remotion-video-creation/rules/calculate-metadata.md +104 -104
- package/.agent/skills/remotion-video-creation/rules/can-decode.md +75 -75
- package/.agent/skills/remotion-video-creation/rules/charts.md +58 -58
- package/.agent/skills/remotion-video-creation/rules/compositions.md +146 -146
- package/.agent/skills/remotion-video-creation/rules/display-captions.md +126 -126
- package/.agent/skills/remotion-video-creation/rules/extract-frames.md +229 -229
- package/.agent/skills/remotion-video-creation/rules/fonts.md +152 -152
- package/.agent/skills/remotion-video-creation/rules/get-audio-duration.md +58 -58
- package/.agent/skills/remotion-video-creation/rules/get-video-dimensions.md +68 -68
- package/.agent/skills/remotion-video-creation/rules/get-video-duration.md +58 -58
- package/.agent/skills/remotion-video-creation/rules/gifs.md +138 -138
- package/.agent/skills/remotion-video-creation/rules/images.md +130 -130
- package/.agent/skills/remotion-video-creation/rules/import-srt-captions.md +67 -67
- package/.agent/skills/remotion-video-creation/rules/lottie.md +67 -67
- package/.agent/skills/remotion-video-creation/rules/measuring-dom-nodes.md +34 -34
- package/.agent/skills/remotion-video-creation/rules/measuring-text.md +143 -143
- package/.agent/skills/remotion-video-creation/rules/sequencing.md +106 -106
- package/.agent/skills/remotion-video-creation/rules/tailwind.md +11 -11
- package/.agent/skills/remotion-video-creation/rules/text-animations.md +20 -20
- package/.agent/skills/remotion-video-creation/rules/timing.md +179 -179
- package/.agent/skills/remotion-video-creation/rules/transcribe-captions.md +19 -19
- package/.agent/skills/remotion-video-creation/rules/transitions.md +122 -122
- package/.agent/skills/remotion-video-creation/rules/trimming.md +52 -52
- package/.agent/skills/remotion-video-creation/rules/videos.md +171 -171
- package/.agent/skills/repo-scan/SKILL.md +63 -63
- package/.agent/skills/returns-reverse-logistics/SKILL.md +240 -240
- package/.agent/skills/rules-distill/SKILL.md +264 -264
- package/.agent/skills/rules-distill/scripts/scan-rules.sh +58 -58
- package/.agent/skills/rules-distill/scripts/scan-skills.sh +129 -129
- package/.agent/skills/rust-patterns/SKILL.md +499 -499
- package/.agent/skills/rust-pro/SKILL.md +175 -175
- package/.agent/skills/rust-testing/SKILL.md +500 -500
- package/.agent/skills/safety-guard/SKILL.md +75 -75
- package/.agent/skills/santa-method/SKILL.md +306 -306
- package/.agent/skills/search-first/SKILL.md +161 -161
- package/.agent/skills/security-review/SKILL.md +495 -495
- package/.agent/skills/security-review/cloud-infrastructure-security.md +361 -361
- package/.agent/skills/security-scan/SKILL.md +165 -165
- package/.agent/skills/seo-fundamentals/SKILL.md +129 -129
- package/.agent/skills/seo-fundamentals/scripts/seo_checker.py +219 -219
- package/.agent/skills/server-management/SKILL.md +161 -161
- package/.agent/skills/skill-comply/SKILL.md +58 -58
- package/.agent/skills/skill-comply/fixtures/compliant-trace.jsonl +5 -5
- package/.agent/skills/skill-comply/fixtures/noncompliant-trace.jsonl +3 -3
- package/.agent/skills/skill-comply/fixtures/tdd-spec.yaml +44 -44
- package/.agent/skills/skill-comply/prompts/classifier.md +24 -24
- package/.agent/skills/skill-comply/prompts/scenario-generator.md +62 -62
- package/.agent/skills/skill-comply/prompts/spec-generator.md +42 -42
- package/.agent/skills/skill-comply/pyproject.toml +15 -15
- package/.agent/skills/skill-comply/scripts/classifier.py +85 -85
- package/.agent/skills/skill-comply/scripts/grader.py +122 -122
- package/.agent/skills/skill-comply/scripts/parser.py +107 -107
- package/.agent/skills/skill-comply/scripts/report.py +170 -170
- package/.agent/skills/skill-comply/scripts/run.py +127 -127
- package/.agent/skills/skill-comply/scripts/runner.py +161 -161
- package/.agent/skills/skill-comply/scripts/scenario-generator.py +70 -70
- package/.agent/skills/skill-comply/scripts/spec-generator.py +72 -72
- package/.agent/skills/skill-comply/scripts/utils.py +13 -13
- package/.agent/skills/skill-comply/tests/test-grader.py +137 -137
- package/.agent/skills/skill-comply/tests/test-parser.py +90 -90
- package/.agent/skills/skill-stocktake/SKILL.md +193 -193
- package/.agent/skills/skill-stocktake/scripts/quick-diff.sh +87 -87
- package/.agent/skills/skill-stocktake/scripts/save-results.sh +56 -56
- package/.agent/skills/skill-stocktake/scripts/scan.sh +170 -170
- package/.agent/skills/social-graph-ranker/SKILL.md +154 -154
- package/.agent/skills/springboot-patterns/SKILL.md +314 -314
- package/.agent/skills/springboot-security/SKILL.md +272 -272
- package/.agent/skills/springboot-tdd/SKILL.md +158 -158
- package/.agent/skills/springboot-verification/SKILL.md +231 -231
- package/.agent/skills/strategic-compact/SKILL.md +131 -131
- package/.agent/skills/strategic-compact/suggest-compact.sh +54 -54
- package/.agent/skills/swift-actor-persistence/SKILL.md +143 -143
- package/.agent/skills/swift-concurrency-6-2/SKILL.md +216 -216
- package/.agent/skills/swift-protocol-di-testing/SKILL.md +190 -190
- package/.agent/skills/swiftui-patterns/SKILL.md +259 -259
- package/.agent/skills/systematic-debugging/SKILL.md +109 -109
- package/.agent/skills/tailwind-patterns/SKILL.md +269 -269
- package/.agent/skills/tdd-workflow/SKILL.md +463 -463
- package/.agent/skills/team-builder/SKILL.md +168 -168
- package/.agent/skills/testing-patterns/SKILL.md +178 -178
- package/.agent/skills/testing-patterns/scripts/test_runner.py +219 -219
- package/.agent/skills/token-budget-advisor/SKILL.md +133 -133
- package/.agent/skills/ui-demo/SKILL.md +465 -465
- package/.agent/skills/ui-ux-pro-max/SKILL.md +292 -292
- package/.agent/skills/ui-ux-pro-max/data/charts.csv +26 -26
- package/.agent/skills/ui-ux-pro-max/data/colors.csv +97 -97
- package/.agent/skills/ui-ux-pro-max/data/icons.csv +101 -101
- package/.agent/skills/ui-ux-pro-max/data/landing.csv +31 -31
- package/.agent/skills/ui-ux-pro-max/data/products.csv +96 -96
- package/.agent/skills/ui-ux-pro-max/data/react-performance.csv +45 -45
- package/.agent/skills/ui-ux-pro-max/data/stacks/astro.csv +54 -54
- package/.agent/skills/ui-ux-pro-max/data/stacks/flutter.csv +53 -53
- package/.agent/skills/ui-ux-pro-max/data/stacks/html-tailwind.csv +56 -56
- package/.agent/skills/ui-ux-pro-max/data/stacks/jetpack-compose.csv +53 -53
- package/.agent/skills/ui-ux-pro-max/data/stacks/nextjs.csv +53 -53
- package/.agent/skills/ui-ux-pro-max/data/stacks/nuxt-ui.csv +51 -51
- package/.agent/skills/ui-ux-pro-max/data/stacks/nuxtjs.csv +59 -59
- package/.agent/skills/ui-ux-pro-max/data/stacks/react-native.csv +52 -52
- package/.agent/skills/ui-ux-pro-max/data/stacks/react.csv +54 -54
- package/.agent/skills/ui-ux-pro-max/data/stacks/shadcn.csv +61 -61
- package/.agent/skills/ui-ux-pro-max/data/stacks/svelte.csv +54 -54
- package/.agent/skills/ui-ux-pro-max/data/stacks/swiftui.csv +51 -51
- package/.agent/skills/ui-ux-pro-max/data/stacks/vue.csv +50 -50
- package/.agent/skills/ui-ux-pro-max/data/styles.csv +68 -68
- package/.agent/skills/ui-ux-pro-max/data/typography.csv +57 -57
- package/.agent/skills/ui-ux-pro-max/data/ui-reasoning.csv +101 -101
- package/.agent/skills/ui-ux-pro-max/data/ux-guidelines.csv +99 -99
- package/.agent/skills/ui-ux-pro-max/data/web-interface.csv +31 -31
- package/.agent/skills/ui-ux-pro-max/scripts/core.py +253 -253
- package/.agent/skills/ui-ux-pro-max/scripts/design_system.py +1067 -1067
- package/.agent/skills/ui-ux-pro-max/scripts/search.py +114 -114
- package/.agent/skills/verification-loop/SKILL.md +126 -126
- package/.agent/skills/video-editing/SKILL.md +310 -310
- package/.agent/skills/videodb/SKILL.md +374 -374
- package/.agent/skills/videodb/reference/api-reference.md +550 -550
- package/.agent/skills/videodb/reference/capture-reference.md +407 -407
- package/.agent/skills/videodb/reference/capture.md +101 -101
- package/.agent/skills/videodb/reference/editor.md +443 -443
- package/.agent/skills/videodb/reference/generative.md +331 -331
- package/.agent/skills/videodb/reference/rtstream-reference.md +564 -564
- package/.agent/skills/videodb/reference/rtstream.md +65 -65
- package/.agent/skills/videodb/reference/search.md +230 -230
- package/.agent/skills/videodb/reference/streaming.md +406 -406
- package/.agent/skills/videodb/reference/use-cases.md +118 -118
- package/.agent/skills/videodb/scripts/ws-listener.py +282 -282
- package/.agent/skills/visa-doc-translate/SKILL.md +117 -117
- package/.agent/skills/visa-doc-translate/readme.md +86 -86
- package/.agent/skills/vulnerability-scanner/SKILL.md +276 -276
- package/.agent/skills/vulnerability-scanner/checklists.md +121 -121
- package/.agent/skills/vulnerability-scanner/scripts/security_scan.py +458 -458
- package/.agent/skills/web-design-guidelines/SKILL.md +57 -57
- package/.agent/skills/webapp-testing/SKILL.md +187 -187
- package/.agent/skills/webapp-testing/scripts/playwright_runner.py +173 -173
- package/.agent/skills/workspace-surface-audit/SKILL.md +125 -125
- package/.agent/skills/x-api/SKILL.md +230 -230
- package/.agent/tasks/lessons.md +40 -40
- package/.agent/tasks/todo.md +33 -33
- package/.agent/tasks/two-track-merge-contract.md +1 -1
- package/.agent/workflows/aside.md +164 -164
- package/.agent/workflows/brainstorm.md +113 -113
- package/.agent/workflows/build-fix.md +62 -62
- package/.agent/workflows/checkpoint.md +74 -74
- package/.agent/workflows/claw.md +23 -23
- package/.agent/workflows/clean-memory.md +34 -34
- package/.agent/workflows/code-review.md +289 -289
- package/.agent/workflows/context-budget.md +23 -23
- package/.agent/workflows/cpp-build.md +173 -173
- package/.agent/workflows/cpp-review.md +132 -132
- package/.agent/workflows/cpp-test.md +251 -251
- package/.agent/workflows/create.md +59 -59
- package/.agent/workflows/debug.md +103 -103
- package/.agent/workflows/deploy.md +176 -176
- package/.agent/workflows/devfleet.md +23 -23
- package/.agent/workflows/docs.md +23 -23
- package/.agent/workflows/e2e.md +268 -268
- package/.agent/workflows/enhance.md +63 -63
- package/.agent/workflows/eval.md +23 -23
- package/.agent/workflows/evolve.md +178 -178
- package/.agent/workflows/flutter-build.md +164 -164
- package/.agent/workflows/flutter-review.md +116 -116
- package/.agent/workflows/flutter-test.md +144 -144
- package/.agent/workflows/gan-build.md +99 -99
- package/.agent/workflows/gan-design.md +35 -35
- package/.agent/workflows/go-build.md +183 -183
- package/.agent/workflows/go-review.md +148 -148
- package/.agent/workflows/go-test.md +268 -268
- package/.agent/workflows/gradle-build.md +70 -70
- package/.agent/workflows/harness-audit.md +73 -73
- package/.agent/workflows/init-docs.md +46 -46
- package/.agent/workflows/instinct-export.md +66 -66
- package/.agent/workflows/instinct-import.md +114 -114
- package/.agent/workflows/instinct-status.md +59 -59
- package/.agent/workflows/jira.md +106 -106
- package/.agent/workflows/kotlin-build.md +174 -174
- package/.agent/workflows/kotlin-review.md +140 -140
- package/.agent/workflows/kotlin-test.md +312 -312
- package/.agent/workflows/learn-eval.md +116 -116
- package/.agent/workflows/learn.md +70 -70
- package/.agent/workflows/loop-start.md +32 -32
- package/.agent/workflows/loop-status.md +24 -24
- package/.agent/workflows/model-route.md +26 -26
- package/.agent/workflows/multi-backend.md +158 -158
- package/.agent/workflows/multi-execute.md +315 -315
- package/.agent/workflows/multi-frontend.md +158 -158
- package/.agent/workflows/multi-plan.md +268 -268
- package/.agent/workflows/multi-workflow.md +191 -191
- package/.agent/workflows/orchestrate.md +135 -135
- package/.agent/workflows/plan.md +117 -117
- package/.agent/workflows/pm2.md +272 -272
- package/.agent/workflows/preview.md +81 -81
- package/.agent/workflows/projects.md +39 -39
- package/.agent/workflows/promote.md +41 -41
- package/.agent/workflows/prompt-optimize.md +23 -23
- package/.agent/workflows/prp-commit.md +112 -112
- package/.agent/workflows/prp-implement.md +385 -385
- package/.agent/workflows/prp-plan.md +502 -502
- package/.agent/workflows/prp-pr.md +184 -184
- package/.agent/workflows/prp-prd.md +447 -447
- package/.agent/workflows/prune.md +31 -31
- package/.agent/workflows/python-review.md +297 -297
- package/.agent/workflows/quality-gate.md +29 -29
- package/.agent/workflows/refactor-clean.md +80 -80
- package/.agent/workflows/resume-session.md +156 -156
- package/.agent/workflows/rules-distill.md +20 -20
- package/.agent/workflows/rust-build.md +187 -187
- package/.agent/workflows/rust-review.md +142 -142
- package/.agent/workflows/rust-test.md +308 -308
- package/.agent/workflows/santa-loop.md +175 -175
- package/.agent/workflows/save-session.md +275 -275
- package/.agent/workflows/sessions.md +333 -333
- package/.agent/workflows/setup-pm.md +80 -80
- package/.agent/workflows/skill-create.md +174 -174
- package/.agent/workflows/skill-health.md +54 -54
- package/.agent/workflows/status.md +86 -86
- package/.agent/workflows/tdd.md +231 -231
- package/.agent/workflows/test-coverage.md +69 -69
- package/.agent/workflows/test.md +144 -144
- package/.agent/workflows/ui-ux-pro-max.md +295 -295
- package/.agent/workflows/update-codemaps.md +72 -72
- package/.agent/workflows/update-docs.md +84 -84
- package/.agent/workflows/verify.md +23 -23
- package/LICENSE +176 -176
- package/README.md +144 -144
- package/package.json +1 -1
- package/scripts/release-check.js +55 -55
- package/src/bin/cli.js +424 -354
- package/src/lib/installer.js +223 -11
|
@@ -1,689 +1,689 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: kotlin-ktor-patterns
|
|
3
|
-
description: Ktor server patterns including routing DSL, plugins, authentication, Koin DI, kotlinx.serialization, WebSockets, and testApplication testing.
|
|
4
|
-
origin: ECC
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
# Ktor Server Patterns
|
|
8
|
-
|
|
9
|
-
Comprehensive Ktor patterns for building robust, maintainable HTTP servers with Kotlin coroutines.
|
|
10
|
-
|
|
11
|
-
## When to Activate
|
|
12
|
-
|
|
13
|
-
- Building Ktor HTTP servers
|
|
14
|
-
- Configuring Ktor plugins (Auth, CORS, ContentNegotiation, StatusPages)
|
|
15
|
-
- Implementing REST APIs with Ktor
|
|
16
|
-
- Setting up dependency injection with Koin
|
|
17
|
-
- Writing Ktor integration tests with testApplication
|
|
18
|
-
- Working with WebSockets in Ktor
|
|
19
|
-
|
|
20
|
-
## Application Structure
|
|
21
|
-
|
|
22
|
-
### Standard Ktor Project Layout
|
|
23
|
-
|
|
24
|
-
```text
|
|
25
|
-
src/main/kotlin/
|
|
26
|
-
├── com/example/
|
|
27
|
-
│ ├── Application.kt # Entry point, module configuration
|
|
28
|
-
│ ├── plugins/
|
|
29
|
-
│ │ ├── Routing.kt # Route definitions
|
|
30
|
-
│ │ ├── Serialization.kt # Content negotiation setup
|
|
31
|
-
│ │ ├── Authentication.kt # Auth configuration
|
|
32
|
-
│ │ ├── StatusPages.kt # Error handling
|
|
33
|
-
│ │ └── CORS.kt # CORS configuration
|
|
34
|
-
│ ├── routes/
|
|
35
|
-
│ │ ├── UserRoutes.kt # /users endpoints
|
|
36
|
-
│ │ ├── AuthRoutes.kt # /auth endpoints
|
|
37
|
-
│ │ └── HealthRoutes.kt # /health endpoints
|
|
38
|
-
│ ├── models/
|
|
39
|
-
│ │ ├── User.kt # Domain models
|
|
40
|
-
│ │ └── ApiResponse.kt # Response envelopes
|
|
41
|
-
│ ├── services/
|
|
42
|
-
│ │ ├── UserService.kt # Business logic
|
|
43
|
-
│ │ └── AuthService.kt # Auth logic
|
|
44
|
-
│ ├── repositories/
|
|
45
|
-
│ │ ├── UserRepository.kt # Data access interface
|
|
46
|
-
│ │ └── ExposedUserRepository.kt
|
|
47
|
-
│ └── di/
|
|
48
|
-
│ └── AppModule.kt # Koin modules
|
|
49
|
-
src/test/kotlin/
|
|
50
|
-
├── com/example/
|
|
51
|
-
│ ├── routes/
|
|
52
|
-
│ │ └── UserRoutesTest.kt
|
|
53
|
-
│ └── services/
|
|
54
|
-
│ └── UserServiceTest.kt
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
### Application Entry Point
|
|
58
|
-
|
|
59
|
-
```kotlin
|
|
60
|
-
// Application.kt
|
|
61
|
-
fun main() {
|
|
62
|
-
embeddedServer(Netty, port = 8080, module = Application::module).start(wait = true)
|
|
63
|
-
}
|
|
64
|
-
|
|
65
|
-
fun Application.module() {
|
|
66
|
-
configureSerialization()
|
|
67
|
-
configureAuthentication()
|
|
68
|
-
configureStatusPages()
|
|
69
|
-
configureCORS()
|
|
70
|
-
configureDI()
|
|
71
|
-
configureRouting()
|
|
72
|
-
}
|
|
73
|
-
```
|
|
74
|
-
|
|
75
|
-
## Routing DSL
|
|
76
|
-
|
|
77
|
-
### Basic Routes
|
|
78
|
-
|
|
79
|
-
```kotlin
|
|
80
|
-
// plugins/Routing.kt
|
|
81
|
-
fun Application.configureRouting() {
|
|
82
|
-
routing {
|
|
83
|
-
userRoutes()
|
|
84
|
-
authRoutes()
|
|
85
|
-
healthRoutes()
|
|
86
|
-
}
|
|
87
|
-
}
|
|
88
|
-
|
|
89
|
-
// routes/UserRoutes.kt
|
|
90
|
-
fun Route.userRoutes() {
|
|
91
|
-
val userService by inject<UserService>()
|
|
92
|
-
|
|
93
|
-
route("/users") {
|
|
94
|
-
get {
|
|
95
|
-
val users = userService.getAll()
|
|
96
|
-
call.respond(users)
|
|
97
|
-
}
|
|
98
|
-
|
|
99
|
-
get("/{id}") {
|
|
100
|
-
val id = call.parameters["id"]
|
|
101
|
-
?: return@get call.respond(HttpStatusCode.BadRequest, "Missing id")
|
|
102
|
-
val user = userService.getById(id)
|
|
103
|
-
?: return@get call.respond(HttpStatusCode.NotFound)
|
|
104
|
-
call.respond(user)
|
|
105
|
-
}
|
|
106
|
-
|
|
107
|
-
post {
|
|
108
|
-
val request = call.receive<CreateUserRequest>()
|
|
109
|
-
val user = userService.create(request)
|
|
110
|
-
call.respond(HttpStatusCode.Created, user)
|
|
111
|
-
}
|
|
112
|
-
|
|
113
|
-
put("/{id}") {
|
|
114
|
-
val id = call.parameters["id"]
|
|
115
|
-
?: return@put call.respond(HttpStatusCode.BadRequest, "Missing id")
|
|
116
|
-
val request = call.receive<UpdateUserRequest>()
|
|
117
|
-
val user = userService.update(id, request)
|
|
118
|
-
?: return@put call.respond(HttpStatusCode.NotFound)
|
|
119
|
-
call.respond(user)
|
|
120
|
-
}
|
|
121
|
-
|
|
122
|
-
delete("/{id}") {
|
|
123
|
-
val id = call.parameters["id"]
|
|
124
|
-
?: return@delete call.respond(HttpStatusCode.BadRequest, "Missing id")
|
|
125
|
-
val deleted = userService.delete(id)
|
|
126
|
-
if (deleted) call.respond(HttpStatusCode.NoContent)
|
|
127
|
-
else call.respond(HttpStatusCode.NotFound)
|
|
128
|
-
}
|
|
129
|
-
}
|
|
130
|
-
}
|
|
131
|
-
```
|
|
132
|
-
|
|
133
|
-
### Route Organization with Authenticated Routes
|
|
134
|
-
|
|
135
|
-
```kotlin
|
|
136
|
-
fun Route.userRoutes() {
|
|
137
|
-
route("/users") {
|
|
138
|
-
// Public routes
|
|
139
|
-
get { /* list users */ }
|
|
140
|
-
get("/{id}") { /* get user */ }
|
|
141
|
-
|
|
142
|
-
// Protected routes
|
|
143
|
-
authenticate("jwt") {
|
|
144
|
-
post { /* create user - requires auth */ }
|
|
145
|
-
put("/{id}") { /* update user - requires auth */ }
|
|
146
|
-
delete("/{id}") { /* delete user - requires auth */ }
|
|
147
|
-
}
|
|
148
|
-
}
|
|
149
|
-
}
|
|
150
|
-
```
|
|
151
|
-
|
|
152
|
-
## Content Negotiation & Serialization
|
|
153
|
-
|
|
154
|
-
### kotlinx.serialization Setup
|
|
155
|
-
|
|
156
|
-
```kotlin
|
|
157
|
-
// plugins/Serialization.kt
|
|
158
|
-
fun Application.configureSerialization() {
|
|
159
|
-
install(ContentNegotiation) {
|
|
160
|
-
json(Json {
|
|
161
|
-
prettyPrint = true
|
|
162
|
-
isLenient = false
|
|
163
|
-
ignoreUnknownKeys = true
|
|
164
|
-
encodeDefaults = true
|
|
165
|
-
explicitNulls = false
|
|
166
|
-
})
|
|
167
|
-
}
|
|
168
|
-
}
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
### Serializable Models
|
|
172
|
-
|
|
173
|
-
```kotlin
|
|
174
|
-
@Serializable
|
|
175
|
-
data class UserResponse(
|
|
176
|
-
val id: String,
|
|
177
|
-
val name: String,
|
|
178
|
-
val email: String,
|
|
179
|
-
val role: Role,
|
|
180
|
-
@Serializable(with = InstantSerializer::class)
|
|
181
|
-
val createdAt: Instant,
|
|
182
|
-
)
|
|
183
|
-
|
|
184
|
-
@Serializable
|
|
185
|
-
data class CreateUserRequest(
|
|
186
|
-
val name: String,
|
|
187
|
-
val email: String,
|
|
188
|
-
val role: Role = Role.USER,
|
|
189
|
-
)
|
|
190
|
-
|
|
191
|
-
@Serializable
|
|
192
|
-
data class ApiResponse<T>(
|
|
193
|
-
val success: Boolean,
|
|
194
|
-
val data: T? = null,
|
|
195
|
-
val error: String? = null,
|
|
196
|
-
) {
|
|
197
|
-
companion object {
|
|
198
|
-
fun <T> ok(data: T): ApiResponse<T> = ApiResponse(success = true, data = data)
|
|
199
|
-
fun <T> error(message: String): ApiResponse<T> = ApiResponse(success = false, error = message)
|
|
200
|
-
}
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
@Serializable
|
|
204
|
-
data class PaginatedResponse<T>(
|
|
205
|
-
val data: List<T>,
|
|
206
|
-
val total: Long,
|
|
207
|
-
val page: Int,
|
|
208
|
-
val limit: Int,
|
|
209
|
-
)
|
|
210
|
-
```
|
|
211
|
-
|
|
212
|
-
### Custom Serializers
|
|
213
|
-
|
|
214
|
-
```kotlin
|
|
215
|
-
object InstantSerializer : KSerializer<Instant> {
|
|
216
|
-
override val descriptor = PrimitiveSerialDescriptor("Instant", PrimitiveKind.STRING)
|
|
217
|
-
override fun serialize(encoder: Encoder, value: Instant) =
|
|
218
|
-
encoder.encodeString(value.toString())
|
|
219
|
-
override fun deserialize(decoder: Decoder): Instant =
|
|
220
|
-
Instant.parse(decoder.decodeString())
|
|
221
|
-
}
|
|
222
|
-
```
|
|
223
|
-
|
|
224
|
-
## Authentication
|
|
225
|
-
|
|
226
|
-
### JWT Authentication
|
|
227
|
-
|
|
228
|
-
```kotlin
|
|
229
|
-
// plugins/Authentication.kt
|
|
230
|
-
fun Application.configureAuthentication() {
|
|
231
|
-
val jwtSecret = environment.config.property("jwt.secret").getString()
|
|
232
|
-
val jwtIssuer = environment.config.property("jwt.issuer").getString()
|
|
233
|
-
val jwtAudience = environment.config.property("jwt.audience").getString()
|
|
234
|
-
val jwtRealm = environment.config.property("jwt.realm").getString()
|
|
235
|
-
|
|
236
|
-
install(Authentication) {
|
|
237
|
-
jwt("jwt") {
|
|
238
|
-
realm = jwtRealm
|
|
239
|
-
verifier(
|
|
240
|
-
JWT.require(Algorithm.HMAC256(jwtSecret))
|
|
241
|
-
.withAudience(jwtAudience)
|
|
242
|
-
.withIssuer(jwtIssuer)
|
|
243
|
-
.build()
|
|
244
|
-
)
|
|
245
|
-
validate { credential ->
|
|
246
|
-
if (credential.payload.audience.contains(jwtAudience)) {
|
|
247
|
-
JWTPrincipal(credential.payload)
|
|
248
|
-
} else {
|
|
249
|
-
null
|
|
250
|
-
}
|
|
251
|
-
}
|
|
252
|
-
challenge { _, _ ->
|
|
253
|
-
call.respond(HttpStatusCode.Unauthorized, ApiResponse.error<Unit>("Invalid or expired token"))
|
|
254
|
-
}
|
|
255
|
-
}
|
|
256
|
-
}
|
|
257
|
-
}
|
|
258
|
-
|
|
259
|
-
// Extracting user from JWT
|
|
260
|
-
fun ApplicationCall.userId(): String =
|
|
261
|
-
principal<JWTPrincipal>()
|
|
262
|
-
?.payload
|
|
263
|
-
?.getClaim("userId")
|
|
264
|
-
?.asString()
|
|
265
|
-
?: throw AuthenticationException("No userId in token")
|
|
266
|
-
```
|
|
267
|
-
|
|
268
|
-
### Auth Routes
|
|
269
|
-
|
|
270
|
-
```kotlin
|
|
271
|
-
fun Route.authRoutes() {
|
|
272
|
-
val authService by inject<AuthService>()
|
|
273
|
-
|
|
274
|
-
route("/auth") {
|
|
275
|
-
post("/login") {
|
|
276
|
-
val request = call.receive<LoginRequest>()
|
|
277
|
-
val token = authService.login(request.email, request.password)
|
|
278
|
-
?: return@post call.respond(
|
|
279
|
-
HttpStatusCode.Unauthorized,
|
|
280
|
-
ApiResponse.error<Unit>("Invalid credentials"),
|
|
281
|
-
)
|
|
282
|
-
call.respond(ApiResponse.ok(TokenResponse(token)))
|
|
283
|
-
}
|
|
284
|
-
|
|
285
|
-
post("/register") {
|
|
286
|
-
val request = call.receive<RegisterRequest>()
|
|
287
|
-
val user = authService.register(request)
|
|
288
|
-
call.respond(HttpStatusCode.Created, ApiResponse.ok(user))
|
|
289
|
-
}
|
|
290
|
-
|
|
291
|
-
authenticate("jwt") {
|
|
292
|
-
get("/me") {
|
|
293
|
-
val userId = call.userId()
|
|
294
|
-
val user = authService.getProfile(userId)
|
|
295
|
-
call.respond(ApiResponse.ok(user))
|
|
296
|
-
}
|
|
297
|
-
}
|
|
298
|
-
}
|
|
299
|
-
}
|
|
300
|
-
```
|
|
301
|
-
|
|
302
|
-
## Status Pages (Error Handling)
|
|
303
|
-
|
|
304
|
-
```kotlin
|
|
305
|
-
// plugins/StatusPages.kt
|
|
306
|
-
fun Application.configureStatusPages() {
|
|
307
|
-
install(StatusPages) {
|
|
308
|
-
exception<ContentTransformationException> { call, cause ->
|
|
309
|
-
call.respond(
|
|
310
|
-
HttpStatusCode.BadRequest,
|
|
311
|
-
ApiResponse.error<Unit>("Invalid request body: ${cause.message}"),
|
|
312
|
-
)
|
|
313
|
-
}
|
|
314
|
-
|
|
315
|
-
exception<IllegalArgumentException> { call, cause ->
|
|
316
|
-
call.respond(
|
|
317
|
-
HttpStatusCode.BadRequest,
|
|
318
|
-
ApiResponse.error<Unit>(cause.message ?: "Bad request"),
|
|
319
|
-
)
|
|
320
|
-
}
|
|
321
|
-
|
|
322
|
-
exception<AuthenticationException> { call, _ ->
|
|
323
|
-
call.respond(
|
|
324
|
-
HttpStatusCode.Unauthorized,
|
|
325
|
-
ApiResponse.error<Unit>("Authentication required"),
|
|
326
|
-
)
|
|
327
|
-
}
|
|
328
|
-
|
|
329
|
-
exception<AuthorizationException> { call, _ ->
|
|
330
|
-
call.respond(
|
|
331
|
-
HttpStatusCode.Forbidden,
|
|
332
|
-
ApiResponse.error<Unit>("Access denied"),
|
|
333
|
-
)
|
|
334
|
-
}
|
|
335
|
-
|
|
336
|
-
exception<NotFoundException> { call, cause ->
|
|
337
|
-
call.respond(
|
|
338
|
-
HttpStatusCode.NotFound,
|
|
339
|
-
ApiResponse.error<Unit>(cause.message ?: "Resource not found"),
|
|
340
|
-
)
|
|
341
|
-
}
|
|
342
|
-
|
|
343
|
-
exception<Throwable> { call, cause ->
|
|
344
|
-
call.application.log.error("Unhandled exception", cause)
|
|
345
|
-
call.respond(
|
|
346
|
-
HttpStatusCode.InternalServerError,
|
|
347
|
-
ApiResponse.error<Unit>("Internal server error"),
|
|
348
|
-
)
|
|
349
|
-
}
|
|
350
|
-
|
|
351
|
-
status(HttpStatusCode.NotFound) { call, status ->
|
|
352
|
-
call.respond(status, ApiResponse.error<Unit>("Route not found"))
|
|
353
|
-
}
|
|
354
|
-
}
|
|
355
|
-
}
|
|
356
|
-
```
|
|
357
|
-
|
|
358
|
-
## CORS Configuration
|
|
359
|
-
|
|
360
|
-
```kotlin
|
|
361
|
-
// plugins/CORS.kt
|
|
362
|
-
fun Application.configureCORS() {
|
|
363
|
-
install(CORS) {
|
|
364
|
-
allowHost("localhost:3000")
|
|
365
|
-
allowHost("example.com", schemes = listOf("https"))
|
|
366
|
-
allowHeader(HttpHeaders.ContentType)
|
|
367
|
-
allowHeader(HttpHeaders.Authorization)
|
|
368
|
-
allowMethod(HttpMethod.Put)
|
|
369
|
-
allowMethod(HttpMethod.Delete)
|
|
370
|
-
allowMethod(HttpMethod.Patch)
|
|
371
|
-
allowCredentials = true
|
|
372
|
-
maxAgeInSeconds = 3600
|
|
373
|
-
}
|
|
374
|
-
}
|
|
375
|
-
```
|
|
376
|
-
|
|
377
|
-
## Koin Dependency Injection
|
|
378
|
-
|
|
379
|
-
### Module Definition
|
|
380
|
-
|
|
381
|
-
```kotlin
|
|
382
|
-
// di/AppModule.kt
|
|
383
|
-
val appModule = module {
|
|
384
|
-
// Database
|
|
385
|
-
single<Database> { DatabaseFactory.create(get()) }
|
|
386
|
-
|
|
387
|
-
// Repositories
|
|
388
|
-
single<UserRepository> { ExposedUserRepository(get()) }
|
|
389
|
-
single<OrderRepository> { ExposedOrderRepository(get()) }
|
|
390
|
-
|
|
391
|
-
// Services
|
|
392
|
-
single { UserService(get()) }
|
|
393
|
-
single { OrderService(get(), get()) }
|
|
394
|
-
single { AuthService(get(), get()) }
|
|
395
|
-
}
|
|
396
|
-
|
|
397
|
-
// Application setup
|
|
398
|
-
fun Application.configureDI() {
|
|
399
|
-
install(Koin) {
|
|
400
|
-
modules(appModule)
|
|
401
|
-
}
|
|
402
|
-
}
|
|
403
|
-
```
|
|
404
|
-
|
|
405
|
-
### Using Koin in Routes
|
|
406
|
-
|
|
407
|
-
```kotlin
|
|
408
|
-
fun Route.userRoutes() {
|
|
409
|
-
val userService by inject<UserService>()
|
|
410
|
-
|
|
411
|
-
route("/users") {
|
|
412
|
-
get {
|
|
413
|
-
val users = userService.getAll()
|
|
414
|
-
call.respond(ApiResponse.ok(users))
|
|
415
|
-
}
|
|
416
|
-
}
|
|
417
|
-
}
|
|
418
|
-
```
|
|
419
|
-
|
|
420
|
-
### Koin for Testing
|
|
421
|
-
|
|
422
|
-
```kotlin
|
|
423
|
-
class UserServiceTest : FunSpec(), KoinTest {
|
|
424
|
-
override fun extensions() = listOf(KoinExtension(testModule))
|
|
425
|
-
|
|
426
|
-
private val testModule = module {
|
|
427
|
-
single<UserRepository> { mockk() }
|
|
428
|
-
single { UserService(get()) }
|
|
429
|
-
}
|
|
430
|
-
|
|
431
|
-
private val repository by inject<UserRepository>()
|
|
432
|
-
private val service by inject<UserService>()
|
|
433
|
-
|
|
434
|
-
init {
|
|
435
|
-
test("getUser returns user") {
|
|
436
|
-
coEvery { repository.findById("1") } returns testUser
|
|
437
|
-
service.getById("1") shouldBe testUser
|
|
438
|
-
}
|
|
439
|
-
}
|
|
440
|
-
}
|
|
441
|
-
```
|
|
442
|
-
|
|
443
|
-
## Request Validation
|
|
444
|
-
|
|
445
|
-
```kotlin
|
|
446
|
-
// Validate request data in routes
|
|
447
|
-
fun Route.userRoutes() {
|
|
448
|
-
val userService by inject<UserService>()
|
|
449
|
-
|
|
450
|
-
post("/users") {
|
|
451
|
-
val request = call.receive<CreateUserRequest>()
|
|
452
|
-
|
|
453
|
-
// Validate
|
|
454
|
-
require(request.name.isNotBlank()) { "Name is required" }
|
|
455
|
-
require(request.name.length <= 100) { "Name must be 100 characters or less" }
|
|
456
|
-
require(request.email.matches(Regex(".+@.+\\..+"))) { "Invalid email format" }
|
|
457
|
-
|
|
458
|
-
val user = userService.create(request)
|
|
459
|
-
call.respond(HttpStatusCode.Created, ApiResponse.ok(user))
|
|
460
|
-
}
|
|
461
|
-
}
|
|
462
|
-
|
|
463
|
-
// Or use a validation extension
|
|
464
|
-
fun CreateUserRequest.validate() {
|
|
465
|
-
require(name.isNotBlank()) { "Name is required" }
|
|
466
|
-
require(name.length <= 100) { "Name must be 100 characters or less" }
|
|
467
|
-
require(email.matches(Regex(".+@.+\\..+"))) { "Invalid email format" }
|
|
468
|
-
}
|
|
469
|
-
```
|
|
470
|
-
|
|
471
|
-
## WebSockets
|
|
472
|
-
|
|
473
|
-
```kotlin
|
|
474
|
-
fun Application.configureWebSockets() {
|
|
475
|
-
install(WebSockets) {
|
|
476
|
-
pingPeriod = 15.seconds
|
|
477
|
-
timeout = 15.seconds
|
|
478
|
-
maxFrameSize = 64 * 1024 // 64 KiB — increase only if your protocol requires larger frames
|
|
479
|
-
masking = false // Server-to-client frames are unmasked per RFC 6455; client-to-server are always masked by Ktor
|
|
480
|
-
}
|
|
481
|
-
}
|
|
482
|
-
|
|
483
|
-
fun Route.chatRoutes() {
|
|
484
|
-
val connections = Collections.synchronizedSet<Connection>(LinkedHashSet())
|
|
485
|
-
|
|
486
|
-
webSocket("/chat") {
|
|
487
|
-
val thisConnection = Connection(this)
|
|
488
|
-
connections += thisConnection
|
|
489
|
-
|
|
490
|
-
try {
|
|
491
|
-
send("Connected! Users online: ${connections.size}")
|
|
492
|
-
|
|
493
|
-
for (frame in incoming) {
|
|
494
|
-
frame as? Frame.Text ?: continue
|
|
495
|
-
val text = frame.readText()
|
|
496
|
-
val message = ChatMessage(thisConnection.name, text)
|
|
497
|
-
|
|
498
|
-
// Snapshot under lock to avoid ConcurrentModificationException
|
|
499
|
-
val snapshot = synchronized(connections) { connections.toList() }
|
|
500
|
-
snapshot.forEach { conn ->
|
|
501
|
-
conn.session.send(Json.encodeToString(message))
|
|
502
|
-
}
|
|
503
|
-
}
|
|
504
|
-
} catch (e: Exception) {
|
|
505
|
-
logger.error("WebSocket error", e)
|
|
506
|
-
} finally {
|
|
507
|
-
connections -= thisConnection
|
|
508
|
-
}
|
|
509
|
-
}
|
|
510
|
-
}
|
|
511
|
-
|
|
512
|
-
data class Connection(val session: DefaultWebSocketSession) {
|
|
513
|
-
val name: String = "User-${counter.getAndIncrement()}"
|
|
514
|
-
|
|
515
|
-
companion object {
|
|
516
|
-
private val counter = AtomicInteger(0)
|
|
517
|
-
}
|
|
518
|
-
}
|
|
519
|
-
```
|
|
520
|
-
|
|
521
|
-
## testApplication Testing
|
|
522
|
-
|
|
523
|
-
### Basic Route Testing
|
|
524
|
-
|
|
525
|
-
```kotlin
|
|
526
|
-
class UserRoutesTest : FunSpec({
|
|
527
|
-
test("GET /users returns list of users") {
|
|
528
|
-
testApplication {
|
|
529
|
-
application {
|
|
530
|
-
install(Koin) { modules(testModule) }
|
|
531
|
-
configureSerialization()
|
|
532
|
-
configureRouting()
|
|
533
|
-
}
|
|
534
|
-
|
|
535
|
-
val response = client.get("/users")
|
|
536
|
-
|
|
537
|
-
response.status shouldBe HttpStatusCode.OK
|
|
538
|
-
val body = response.body<ApiResponse<List<UserResponse>>>()
|
|
539
|
-
body.success shouldBe true
|
|
540
|
-
body.data.shouldNotBeNull().shouldNotBeEmpty()
|
|
541
|
-
}
|
|
542
|
-
}
|
|
543
|
-
|
|
544
|
-
test("POST /users creates a user") {
|
|
545
|
-
testApplication {
|
|
546
|
-
application {
|
|
547
|
-
install(Koin) { modules(testModule) }
|
|
548
|
-
configureSerialization()
|
|
549
|
-
configureStatusPages()
|
|
550
|
-
configureRouting()
|
|
551
|
-
}
|
|
552
|
-
|
|
553
|
-
val client = createClient {
|
|
554
|
-
install(io.ktor.client.plugins.contentnegotiation.ContentNegotiation) {
|
|
555
|
-
json()
|
|
556
|
-
}
|
|
557
|
-
}
|
|
558
|
-
|
|
559
|
-
val response = client.post("/users") {
|
|
560
|
-
contentType(ContentType.Application.Json)
|
|
561
|
-
setBody(CreateUserRequest("Alice", "alice@example.com"))
|
|
562
|
-
}
|
|
563
|
-
|
|
564
|
-
response.status shouldBe HttpStatusCode.Created
|
|
565
|
-
}
|
|
566
|
-
}
|
|
567
|
-
|
|
568
|
-
test("GET /users/{id} returns 404 for unknown id") {
|
|
569
|
-
testApplication {
|
|
570
|
-
application {
|
|
571
|
-
install(Koin) { modules(testModule) }
|
|
572
|
-
configureSerialization()
|
|
573
|
-
configureStatusPages()
|
|
574
|
-
configureRouting()
|
|
575
|
-
}
|
|
576
|
-
|
|
577
|
-
val response = client.get("/users/unknown-id")
|
|
578
|
-
|
|
579
|
-
response.status shouldBe HttpStatusCode.NotFound
|
|
580
|
-
}
|
|
581
|
-
}
|
|
582
|
-
})
|
|
583
|
-
```
|
|
584
|
-
|
|
585
|
-
### Testing Authenticated Routes
|
|
586
|
-
|
|
587
|
-
```kotlin
|
|
588
|
-
class AuthenticatedRoutesTest : FunSpec({
|
|
589
|
-
test("protected route requires JWT") {
|
|
590
|
-
testApplication {
|
|
591
|
-
application {
|
|
592
|
-
install(Koin) { modules(testModule) }
|
|
593
|
-
configureSerialization()
|
|
594
|
-
configureAuthentication()
|
|
595
|
-
configureRouting()
|
|
596
|
-
}
|
|
597
|
-
|
|
598
|
-
val response = client.post("/users") {
|
|
599
|
-
contentType(ContentType.Application.Json)
|
|
600
|
-
setBody(CreateUserRequest("Alice", "alice@example.com"))
|
|
601
|
-
}
|
|
602
|
-
|
|
603
|
-
response.status shouldBe HttpStatusCode.Unauthorized
|
|
604
|
-
}
|
|
605
|
-
}
|
|
606
|
-
|
|
607
|
-
test("protected route succeeds with valid JWT") {
|
|
608
|
-
testApplication {
|
|
609
|
-
application {
|
|
610
|
-
install(Koin) { modules(testModule) }
|
|
611
|
-
configureSerialization()
|
|
612
|
-
configureAuthentication()
|
|
613
|
-
configureRouting()
|
|
614
|
-
}
|
|
615
|
-
|
|
616
|
-
val token = generateTestJWT(userId = "test-user")
|
|
617
|
-
|
|
618
|
-
val client = createClient {
|
|
619
|
-
install(io.ktor.client.plugins.contentnegotiation.ContentNegotiation) { json() }
|
|
620
|
-
}
|
|
621
|
-
|
|
622
|
-
val response = client.post("/users") {
|
|
623
|
-
contentType(ContentType.Application.Json)
|
|
624
|
-
bearerAuth(token)
|
|
625
|
-
setBody(CreateUserRequest("Alice", "alice@example.com"))
|
|
626
|
-
}
|
|
627
|
-
|
|
628
|
-
response.status shouldBe HttpStatusCode.Created
|
|
629
|
-
}
|
|
630
|
-
}
|
|
631
|
-
})
|
|
632
|
-
```
|
|
633
|
-
|
|
634
|
-
## Configuration
|
|
635
|
-
|
|
636
|
-
### application.yaml
|
|
637
|
-
|
|
638
|
-
```yaml
|
|
639
|
-
ktor:
|
|
640
|
-
application:
|
|
641
|
-
modules:
|
|
642
|
-
- com.example.ApplicationKt.module
|
|
643
|
-
deployment:
|
|
644
|
-
port: 8080
|
|
645
|
-
|
|
646
|
-
jwt:
|
|
647
|
-
secret: ${JWT_SECRET}
|
|
648
|
-
issuer: "https://example.com"
|
|
649
|
-
audience: "https://example.com/api"
|
|
650
|
-
realm: "example"
|
|
651
|
-
|
|
652
|
-
database:
|
|
653
|
-
url: ${DATABASE_URL}
|
|
654
|
-
driver: "org.postgresql.Driver"
|
|
655
|
-
maxPoolSize: 10
|
|
656
|
-
```
|
|
657
|
-
|
|
658
|
-
### Reading Config
|
|
659
|
-
|
|
660
|
-
```kotlin
|
|
661
|
-
fun Application.configureDI() {
|
|
662
|
-
val dbUrl = environment.config.property("database.url").getString()
|
|
663
|
-
val dbDriver = environment.config.property("database.driver").getString()
|
|
664
|
-
val maxPoolSize = environment.config.property("database.maxPoolSize").getString().toInt()
|
|
665
|
-
|
|
666
|
-
install(Koin) {
|
|
667
|
-
modules(module {
|
|
668
|
-
single { DatabaseConfig(dbUrl, dbDriver, maxPoolSize) }
|
|
669
|
-
single { DatabaseFactory.create(get()) }
|
|
670
|
-
})
|
|
671
|
-
}
|
|
672
|
-
}
|
|
673
|
-
```
|
|
674
|
-
|
|
675
|
-
## Quick Reference: Ktor Patterns
|
|
676
|
-
|
|
677
|
-
| Pattern | Description |
|
|
678
|
-
|---------|-------------|
|
|
679
|
-
| `route("/path") { get { } }` | Route grouping with DSL |
|
|
680
|
-
| `call.receive<T>()` | Deserialize request body |
|
|
681
|
-
| `call.respond(status, body)` | Send response with status |
|
|
682
|
-
| `call.parameters["id"]` | Read path parameters |
|
|
683
|
-
| `call.request.queryParameters["q"]` | Read query parameters |
|
|
684
|
-
| `install(Plugin) { }` | Install and configure plugin |
|
|
685
|
-
| `authenticate("name") { }` | Protect routes with auth |
|
|
686
|
-
| `by inject<T>()` | Koin dependency injection |
|
|
687
|
-
| `testApplication { }` | Integration testing |
|
|
688
|
-
|
|
689
|
-
**Remember**: Ktor is designed around Kotlin coroutines and DSLs. Keep routes thin, push logic to services, and use Koin for dependency injection. Test with `testApplication` for full integration coverage.
|
|
1
|
+
---
|
|
2
|
+
name: kotlin-ktor-patterns
|
|
3
|
+
description: Ktor server patterns including routing DSL, plugins, authentication, Koin DI, kotlinx.serialization, WebSockets, and testApplication testing.
|
|
4
|
+
origin: ECC
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Ktor Server Patterns
|
|
8
|
+
|
|
9
|
+
Comprehensive Ktor patterns for building robust, maintainable HTTP servers with Kotlin coroutines.
|
|
10
|
+
|
|
11
|
+
## When to Activate
|
|
12
|
+
|
|
13
|
+
- Building Ktor HTTP servers
|
|
14
|
+
- Configuring Ktor plugins (Auth, CORS, ContentNegotiation, StatusPages)
|
|
15
|
+
- Implementing REST APIs with Ktor
|
|
16
|
+
- Setting up dependency injection with Koin
|
|
17
|
+
- Writing Ktor integration tests with testApplication
|
|
18
|
+
- Working with WebSockets in Ktor
|
|
19
|
+
|
|
20
|
+
## Application Structure
|
|
21
|
+
|
|
22
|
+
### Standard Ktor Project Layout
|
|
23
|
+
|
|
24
|
+
```text
|
|
25
|
+
src/main/kotlin/
|
|
26
|
+
├── com/example/
|
|
27
|
+
│ ├── Application.kt # Entry point, module configuration
|
|
28
|
+
│ ├── plugins/
|
|
29
|
+
│ │ ├── Routing.kt # Route definitions
|
|
30
|
+
│ │ ├── Serialization.kt # Content negotiation setup
|
|
31
|
+
│ │ ├── Authentication.kt # Auth configuration
|
|
32
|
+
│ │ ├── StatusPages.kt # Error handling
|
|
33
|
+
│ │ └── CORS.kt # CORS configuration
|
|
34
|
+
│ ├── routes/
|
|
35
|
+
│ │ ├── UserRoutes.kt # /users endpoints
|
|
36
|
+
│ │ ├── AuthRoutes.kt # /auth endpoints
|
|
37
|
+
│ │ └── HealthRoutes.kt # /health endpoints
|
|
38
|
+
│ ├── models/
|
|
39
|
+
│ │ ├── User.kt # Domain models
|
|
40
|
+
│ │ └── ApiResponse.kt # Response envelopes
|
|
41
|
+
│ ├── services/
|
|
42
|
+
│ │ ├── UserService.kt # Business logic
|
|
43
|
+
│ │ └── AuthService.kt # Auth logic
|
|
44
|
+
│ ├── repositories/
|
|
45
|
+
│ │ ├── UserRepository.kt # Data access interface
|
|
46
|
+
│ │ └── ExposedUserRepository.kt
|
|
47
|
+
│ └── di/
|
|
48
|
+
│ └── AppModule.kt # Koin modules
|
|
49
|
+
src/test/kotlin/
|
|
50
|
+
├── com/example/
|
|
51
|
+
│ ├── routes/
|
|
52
|
+
│ │ └── UserRoutesTest.kt
|
|
53
|
+
│ └── services/
|
|
54
|
+
│ └── UserServiceTest.kt
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
### Application Entry Point
|
|
58
|
+
|
|
59
|
+
```kotlin
|
|
60
|
+
// Application.kt
|
|
61
|
+
fun main() {
|
|
62
|
+
embeddedServer(Netty, port = 8080, module = Application::module).start(wait = true)
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
fun Application.module() {
|
|
66
|
+
configureSerialization()
|
|
67
|
+
configureAuthentication()
|
|
68
|
+
configureStatusPages()
|
|
69
|
+
configureCORS()
|
|
70
|
+
configureDI()
|
|
71
|
+
configureRouting()
|
|
72
|
+
}
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Routing DSL
|
|
76
|
+
|
|
77
|
+
### Basic Routes
|
|
78
|
+
|
|
79
|
+
```kotlin
|
|
80
|
+
// plugins/Routing.kt
|
|
81
|
+
fun Application.configureRouting() {
|
|
82
|
+
routing {
|
|
83
|
+
userRoutes()
|
|
84
|
+
authRoutes()
|
|
85
|
+
healthRoutes()
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
// routes/UserRoutes.kt
|
|
90
|
+
fun Route.userRoutes() {
|
|
91
|
+
val userService by inject<UserService>()
|
|
92
|
+
|
|
93
|
+
route("/users") {
|
|
94
|
+
get {
|
|
95
|
+
val users = userService.getAll()
|
|
96
|
+
call.respond(users)
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
get("/{id}") {
|
|
100
|
+
val id = call.parameters["id"]
|
|
101
|
+
?: return@get call.respond(HttpStatusCode.BadRequest, "Missing id")
|
|
102
|
+
val user = userService.getById(id)
|
|
103
|
+
?: return@get call.respond(HttpStatusCode.NotFound)
|
|
104
|
+
call.respond(user)
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
post {
|
|
108
|
+
val request = call.receive<CreateUserRequest>()
|
|
109
|
+
val user = userService.create(request)
|
|
110
|
+
call.respond(HttpStatusCode.Created, user)
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
put("/{id}") {
|
|
114
|
+
val id = call.parameters["id"]
|
|
115
|
+
?: return@put call.respond(HttpStatusCode.BadRequest, "Missing id")
|
|
116
|
+
val request = call.receive<UpdateUserRequest>()
|
|
117
|
+
val user = userService.update(id, request)
|
|
118
|
+
?: return@put call.respond(HttpStatusCode.NotFound)
|
|
119
|
+
call.respond(user)
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
delete("/{id}") {
|
|
123
|
+
val id = call.parameters["id"]
|
|
124
|
+
?: return@delete call.respond(HttpStatusCode.BadRequest, "Missing id")
|
|
125
|
+
val deleted = userService.delete(id)
|
|
126
|
+
if (deleted) call.respond(HttpStatusCode.NoContent)
|
|
127
|
+
else call.respond(HttpStatusCode.NotFound)
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
### Route Organization with Authenticated Routes
|
|
134
|
+
|
|
135
|
+
```kotlin
|
|
136
|
+
fun Route.userRoutes() {
|
|
137
|
+
route("/users") {
|
|
138
|
+
// Public routes
|
|
139
|
+
get { /* list users */ }
|
|
140
|
+
get("/{id}") { /* get user */ }
|
|
141
|
+
|
|
142
|
+
// Protected routes
|
|
143
|
+
authenticate("jwt") {
|
|
144
|
+
post { /* create user - requires auth */ }
|
|
145
|
+
put("/{id}") { /* update user - requires auth */ }
|
|
146
|
+
delete("/{id}") { /* delete user - requires auth */ }
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
}
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
## Content Negotiation & Serialization
|
|
153
|
+
|
|
154
|
+
### kotlinx.serialization Setup
|
|
155
|
+
|
|
156
|
+
```kotlin
|
|
157
|
+
// plugins/Serialization.kt
|
|
158
|
+
fun Application.configureSerialization() {
|
|
159
|
+
install(ContentNegotiation) {
|
|
160
|
+
json(Json {
|
|
161
|
+
prettyPrint = true
|
|
162
|
+
isLenient = false
|
|
163
|
+
ignoreUnknownKeys = true
|
|
164
|
+
encodeDefaults = true
|
|
165
|
+
explicitNulls = false
|
|
166
|
+
})
|
|
167
|
+
}
|
|
168
|
+
}
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
### Serializable Models
|
|
172
|
+
|
|
173
|
+
```kotlin
|
|
174
|
+
@Serializable
|
|
175
|
+
data class UserResponse(
|
|
176
|
+
val id: String,
|
|
177
|
+
val name: String,
|
|
178
|
+
val email: String,
|
|
179
|
+
val role: Role,
|
|
180
|
+
@Serializable(with = InstantSerializer::class)
|
|
181
|
+
val createdAt: Instant,
|
|
182
|
+
)
|
|
183
|
+
|
|
184
|
+
@Serializable
|
|
185
|
+
data class CreateUserRequest(
|
|
186
|
+
val name: String,
|
|
187
|
+
val email: String,
|
|
188
|
+
val role: Role = Role.USER,
|
|
189
|
+
)
|
|
190
|
+
|
|
191
|
+
@Serializable
|
|
192
|
+
data class ApiResponse<T>(
|
|
193
|
+
val success: Boolean,
|
|
194
|
+
val data: T? = null,
|
|
195
|
+
val error: String? = null,
|
|
196
|
+
) {
|
|
197
|
+
companion object {
|
|
198
|
+
fun <T> ok(data: T): ApiResponse<T> = ApiResponse(success = true, data = data)
|
|
199
|
+
fun <T> error(message: String): ApiResponse<T> = ApiResponse(success = false, error = message)
|
|
200
|
+
}
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
@Serializable
|
|
204
|
+
data class PaginatedResponse<T>(
|
|
205
|
+
val data: List<T>,
|
|
206
|
+
val total: Long,
|
|
207
|
+
val page: Int,
|
|
208
|
+
val limit: Int,
|
|
209
|
+
)
|
|
210
|
+
```
|
|
211
|
+
|
|
212
|
+
### Custom Serializers
|
|
213
|
+
|
|
214
|
+
```kotlin
|
|
215
|
+
object InstantSerializer : KSerializer<Instant> {
|
|
216
|
+
override val descriptor = PrimitiveSerialDescriptor("Instant", PrimitiveKind.STRING)
|
|
217
|
+
override fun serialize(encoder: Encoder, value: Instant) =
|
|
218
|
+
encoder.encodeString(value.toString())
|
|
219
|
+
override fun deserialize(decoder: Decoder): Instant =
|
|
220
|
+
Instant.parse(decoder.decodeString())
|
|
221
|
+
}
|
|
222
|
+
```
|
|
223
|
+
|
|
224
|
+
## Authentication
|
|
225
|
+
|
|
226
|
+
### JWT Authentication
|
|
227
|
+
|
|
228
|
+
```kotlin
|
|
229
|
+
// plugins/Authentication.kt
|
|
230
|
+
fun Application.configureAuthentication() {
|
|
231
|
+
val jwtSecret = environment.config.property("jwt.secret").getString()
|
|
232
|
+
val jwtIssuer = environment.config.property("jwt.issuer").getString()
|
|
233
|
+
val jwtAudience = environment.config.property("jwt.audience").getString()
|
|
234
|
+
val jwtRealm = environment.config.property("jwt.realm").getString()
|
|
235
|
+
|
|
236
|
+
install(Authentication) {
|
|
237
|
+
jwt("jwt") {
|
|
238
|
+
realm = jwtRealm
|
|
239
|
+
verifier(
|
|
240
|
+
JWT.require(Algorithm.HMAC256(jwtSecret))
|
|
241
|
+
.withAudience(jwtAudience)
|
|
242
|
+
.withIssuer(jwtIssuer)
|
|
243
|
+
.build()
|
|
244
|
+
)
|
|
245
|
+
validate { credential ->
|
|
246
|
+
if (credential.payload.audience.contains(jwtAudience)) {
|
|
247
|
+
JWTPrincipal(credential.payload)
|
|
248
|
+
} else {
|
|
249
|
+
null
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
challenge { _, _ ->
|
|
253
|
+
call.respond(HttpStatusCode.Unauthorized, ApiResponse.error<Unit>("Invalid or expired token"))
|
|
254
|
+
}
|
|
255
|
+
}
|
|
256
|
+
}
|
|
257
|
+
}
|
|
258
|
+
|
|
259
|
+
// Extracting user from JWT
|
|
260
|
+
fun ApplicationCall.userId(): String =
|
|
261
|
+
principal<JWTPrincipal>()
|
|
262
|
+
?.payload
|
|
263
|
+
?.getClaim("userId")
|
|
264
|
+
?.asString()
|
|
265
|
+
?: throw AuthenticationException("No userId in token")
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
### Auth Routes
|
|
269
|
+
|
|
270
|
+
```kotlin
|
|
271
|
+
fun Route.authRoutes() {
|
|
272
|
+
val authService by inject<AuthService>()
|
|
273
|
+
|
|
274
|
+
route("/auth") {
|
|
275
|
+
post("/login") {
|
|
276
|
+
val request = call.receive<LoginRequest>()
|
|
277
|
+
val token = authService.login(request.email, request.password)
|
|
278
|
+
?: return@post call.respond(
|
|
279
|
+
HttpStatusCode.Unauthorized,
|
|
280
|
+
ApiResponse.error<Unit>("Invalid credentials"),
|
|
281
|
+
)
|
|
282
|
+
call.respond(ApiResponse.ok(TokenResponse(token)))
|
|
283
|
+
}
|
|
284
|
+
|
|
285
|
+
post("/register") {
|
|
286
|
+
val request = call.receive<RegisterRequest>()
|
|
287
|
+
val user = authService.register(request)
|
|
288
|
+
call.respond(HttpStatusCode.Created, ApiResponse.ok(user))
|
|
289
|
+
}
|
|
290
|
+
|
|
291
|
+
authenticate("jwt") {
|
|
292
|
+
get("/me") {
|
|
293
|
+
val userId = call.userId()
|
|
294
|
+
val user = authService.getProfile(userId)
|
|
295
|
+
call.respond(ApiResponse.ok(user))
|
|
296
|
+
}
|
|
297
|
+
}
|
|
298
|
+
}
|
|
299
|
+
}
|
|
300
|
+
```
|
|
301
|
+
|
|
302
|
+
## Status Pages (Error Handling)
|
|
303
|
+
|
|
304
|
+
```kotlin
|
|
305
|
+
// plugins/StatusPages.kt
|
|
306
|
+
fun Application.configureStatusPages() {
|
|
307
|
+
install(StatusPages) {
|
|
308
|
+
exception<ContentTransformationException> { call, cause ->
|
|
309
|
+
call.respond(
|
|
310
|
+
HttpStatusCode.BadRequest,
|
|
311
|
+
ApiResponse.error<Unit>("Invalid request body: ${cause.message}"),
|
|
312
|
+
)
|
|
313
|
+
}
|
|
314
|
+
|
|
315
|
+
exception<IllegalArgumentException> { call, cause ->
|
|
316
|
+
call.respond(
|
|
317
|
+
HttpStatusCode.BadRequest,
|
|
318
|
+
ApiResponse.error<Unit>(cause.message ?: "Bad request"),
|
|
319
|
+
)
|
|
320
|
+
}
|
|
321
|
+
|
|
322
|
+
exception<AuthenticationException> { call, _ ->
|
|
323
|
+
call.respond(
|
|
324
|
+
HttpStatusCode.Unauthorized,
|
|
325
|
+
ApiResponse.error<Unit>("Authentication required"),
|
|
326
|
+
)
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
exception<AuthorizationException> { call, _ ->
|
|
330
|
+
call.respond(
|
|
331
|
+
HttpStatusCode.Forbidden,
|
|
332
|
+
ApiResponse.error<Unit>("Access denied"),
|
|
333
|
+
)
|
|
334
|
+
}
|
|
335
|
+
|
|
336
|
+
exception<NotFoundException> { call, cause ->
|
|
337
|
+
call.respond(
|
|
338
|
+
HttpStatusCode.NotFound,
|
|
339
|
+
ApiResponse.error<Unit>(cause.message ?: "Resource not found"),
|
|
340
|
+
)
|
|
341
|
+
}
|
|
342
|
+
|
|
343
|
+
exception<Throwable> { call, cause ->
|
|
344
|
+
call.application.log.error("Unhandled exception", cause)
|
|
345
|
+
call.respond(
|
|
346
|
+
HttpStatusCode.InternalServerError,
|
|
347
|
+
ApiResponse.error<Unit>("Internal server error"),
|
|
348
|
+
)
|
|
349
|
+
}
|
|
350
|
+
|
|
351
|
+
status(HttpStatusCode.NotFound) { call, status ->
|
|
352
|
+
call.respond(status, ApiResponse.error<Unit>("Route not found"))
|
|
353
|
+
}
|
|
354
|
+
}
|
|
355
|
+
}
|
|
356
|
+
```
|
|
357
|
+
|
|
358
|
+
## CORS Configuration
|
|
359
|
+
|
|
360
|
+
```kotlin
|
|
361
|
+
// plugins/CORS.kt
|
|
362
|
+
fun Application.configureCORS() {
|
|
363
|
+
install(CORS) {
|
|
364
|
+
allowHost("localhost:3000")
|
|
365
|
+
allowHost("example.com", schemes = listOf("https"))
|
|
366
|
+
allowHeader(HttpHeaders.ContentType)
|
|
367
|
+
allowHeader(HttpHeaders.Authorization)
|
|
368
|
+
allowMethod(HttpMethod.Put)
|
|
369
|
+
allowMethod(HttpMethod.Delete)
|
|
370
|
+
allowMethod(HttpMethod.Patch)
|
|
371
|
+
allowCredentials = true
|
|
372
|
+
maxAgeInSeconds = 3600
|
|
373
|
+
}
|
|
374
|
+
}
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
## Koin Dependency Injection
|
|
378
|
+
|
|
379
|
+
### Module Definition
|
|
380
|
+
|
|
381
|
+
```kotlin
|
|
382
|
+
// di/AppModule.kt
|
|
383
|
+
val appModule = module {
|
|
384
|
+
// Database
|
|
385
|
+
single<Database> { DatabaseFactory.create(get()) }
|
|
386
|
+
|
|
387
|
+
// Repositories
|
|
388
|
+
single<UserRepository> { ExposedUserRepository(get()) }
|
|
389
|
+
single<OrderRepository> { ExposedOrderRepository(get()) }
|
|
390
|
+
|
|
391
|
+
// Services
|
|
392
|
+
single { UserService(get()) }
|
|
393
|
+
single { OrderService(get(), get()) }
|
|
394
|
+
single { AuthService(get(), get()) }
|
|
395
|
+
}
|
|
396
|
+
|
|
397
|
+
// Application setup
|
|
398
|
+
fun Application.configureDI() {
|
|
399
|
+
install(Koin) {
|
|
400
|
+
modules(appModule)
|
|
401
|
+
}
|
|
402
|
+
}
|
|
403
|
+
```
|
|
404
|
+
|
|
405
|
+
### Using Koin in Routes
|
|
406
|
+
|
|
407
|
+
```kotlin
|
|
408
|
+
fun Route.userRoutes() {
|
|
409
|
+
val userService by inject<UserService>()
|
|
410
|
+
|
|
411
|
+
route("/users") {
|
|
412
|
+
get {
|
|
413
|
+
val users = userService.getAll()
|
|
414
|
+
call.respond(ApiResponse.ok(users))
|
|
415
|
+
}
|
|
416
|
+
}
|
|
417
|
+
}
|
|
418
|
+
```
|
|
419
|
+
|
|
420
|
+
### Koin for Testing
|
|
421
|
+
|
|
422
|
+
```kotlin
|
|
423
|
+
class UserServiceTest : FunSpec(), KoinTest {
|
|
424
|
+
override fun extensions() = listOf(KoinExtension(testModule))
|
|
425
|
+
|
|
426
|
+
private val testModule = module {
|
|
427
|
+
single<UserRepository> { mockk() }
|
|
428
|
+
single { UserService(get()) }
|
|
429
|
+
}
|
|
430
|
+
|
|
431
|
+
private val repository by inject<UserRepository>()
|
|
432
|
+
private val service by inject<UserService>()
|
|
433
|
+
|
|
434
|
+
init {
|
|
435
|
+
test("getUser returns user") {
|
|
436
|
+
coEvery { repository.findById("1") } returns testUser
|
|
437
|
+
service.getById("1") shouldBe testUser
|
|
438
|
+
}
|
|
439
|
+
}
|
|
440
|
+
}
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
## Request Validation
|
|
444
|
+
|
|
445
|
+
```kotlin
|
|
446
|
+
// Validate request data in routes
|
|
447
|
+
fun Route.userRoutes() {
|
|
448
|
+
val userService by inject<UserService>()
|
|
449
|
+
|
|
450
|
+
post("/users") {
|
|
451
|
+
val request = call.receive<CreateUserRequest>()
|
|
452
|
+
|
|
453
|
+
// Validate
|
|
454
|
+
require(request.name.isNotBlank()) { "Name is required" }
|
|
455
|
+
require(request.name.length <= 100) { "Name must be 100 characters or less" }
|
|
456
|
+
require(request.email.matches(Regex(".+@.+\\..+"))) { "Invalid email format" }
|
|
457
|
+
|
|
458
|
+
val user = userService.create(request)
|
|
459
|
+
call.respond(HttpStatusCode.Created, ApiResponse.ok(user))
|
|
460
|
+
}
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
// Or use a validation extension
|
|
464
|
+
fun CreateUserRequest.validate() {
|
|
465
|
+
require(name.isNotBlank()) { "Name is required" }
|
|
466
|
+
require(name.length <= 100) { "Name must be 100 characters or less" }
|
|
467
|
+
require(email.matches(Regex(".+@.+\\..+"))) { "Invalid email format" }
|
|
468
|
+
}
|
|
469
|
+
```
|
|
470
|
+
|
|
471
|
+
## WebSockets
|
|
472
|
+
|
|
473
|
+
```kotlin
|
|
474
|
+
fun Application.configureWebSockets() {
|
|
475
|
+
install(WebSockets) {
|
|
476
|
+
pingPeriod = 15.seconds
|
|
477
|
+
timeout = 15.seconds
|
|
478
|
+
maxFrameSize = 64 * 1024 // 64 KiB — increase only if your protocol requires larger frames
|
|
479
|
+
masking = false // Server-to-client frames are unmasked per RFC 6455; client-to-server are always masked by Ktor
|
|
480
|
+
}
|
|
481
|
+
}
|
|
482
|
+
|
|
483
|
+
fun Route.chatRoutes() {
|
|
484
|
+
val connections = Collections.synchronizedSet<Connection>(LinkedHashSet())
|
|
485
|
+
|
|
486
|
+
webSocket("/chat") {
|
|
487
|
+
val thisConnection = Connection(this)
|
|
488
|
+
connections += thisConnection
|
|
489
|
+
|
|
490
|
+
try {
|
|
491
|
+
send("Connected! Users online: ${connections.size}")
|
|
492
|
+
|
|
493
|
+
for (frame in incoming) {
|
|
494
|
+
frame as? Frame.Text ?: continue
|
|
495
|
+
val text = frame.readText()
|
|
496
|
+
val message = ChatMessage(thisConnection.name, text)
|
|
497
|
+
|
|
498
|
+
// Snapshot under lock to avoid ConcurrentModificationException
|
|
499
|
+
val snapshot = synchronized(connections) { connections.toList() }
|
|
500
|
+
snapshot.forEach { conn ->
|
|
501
|
+
conn.session.send(Json.encodeToString(message))
|
|
502
|
+
}
|
|
503
|
+
}
|
|
504
|
+
} catch (e: Exception) {
|
|
505
|
+
logger.error("WebSocket error", e)
|
|
506
|
+
} finally {
|
|
507
|
+
connections -= thisConnection
|
|
508
|
+
}
|
|
509
|
+
}
|
|
510
|
+
}
|
|
511
|
+
|
|
512
|
+
data class Connection(val session: DefaultWebSocketSession) {
|
|
513
|
+
val name: String = "User-${counter.getAndIncrement()}"
|
|
514
|
+
|
|
515
|
+
companion object {
|
|
516
|
+
private val counter = AtomicInteger(0)
|
|
517
|
+
}
|
|
518
|
+
}
|
|
519
|
+
```
|
|
520
|
+
|
|
521
|
+
## testApplication Testing
|
|
522
|
+
|
|
523
|
+
### Basic Route Testing
|
|
524
|
+
|
|
525
|
+
```kotlin
|
|
526
|
+
class UserRoutesTest : FunSpec({
|
|
527
|
+
test("GET /users returns list of users") {
|
|
528
|
+
testApplication {
|
|
529
|
+
application {
|
|
530
|
+
install(Koin) { modules(testModule) }
|
|
531
|
+
configureSerialization()
|
|
532
|
+
configureRouting()
|
|
533
|
+
}
|
|
534
|
+
|
|
535
|
+
val response = client.get("/users")
|
|
536
|
+
|
|
537
|
+
response.status shouldBe HttpStatusCode.OK
|
|
538
|
+
val body = response.body<ApiResponse<List<UserResponse>>>()
|
|
539
|
+
body.success shouldBe true
|
|
540
|
+
body.data.shouldNotBeNull().shouldNotBeEmpty()
|
|
541
|
+
}
|
|
542
|
+
}
|
|
543
|
+
|
|
544
|
+
test("POST /users creates a user") {
|
|
545
|
+
testApplication {
|
|
546
|
+
application {
|
|
547
|
+
install(Koin) { modules(testModule) }
|
|
548
|
+
configureSerialization()
|
|
549
|
+
configureStatusPages()
|
|
550
|
+
configureRouting()
|
|
551
|
+
}
|
|
552
|
+
|
|
553
|
+
val client = createClient {
|
|
554
|
+
install(io.ktor.client.plugins.contentnegotiation.ContentNegotiation) {
|
|
555
|
+
json()
|
|
556
|
+
}
|
|
557
|
+
}
|
|
558
|
+
|
|
559
|
+
val response = client.post("/users") {
|
|
560
|
+
contentType(ContentType.Application.Json)
|
|
561
|
+
setBody(CreateUserRequest("Alice", "alice@example.com"))
|
|
562
|
+
}
|
|
563
|
+
|
|
564
|
+
response.status shouldBe HttpStatusCode.Created
|
|
565
|
+
}
|
|
566
|
+
}
|
|
567
|
+
|
|
568
|
+
test("GET /users/{id} returns 404 for unknown id") {
|
|
569
|
+
testApplication {
|
|
570
|
+
application {
|
|
571
|
+
install(Koin) { modules(testModule) }
|
|
572
|
+
configureSerialization()
|
|
573
|
+
configureStatusPages()
|
|
574
|
+
configureRouting()
|
|
575
|
+
}
|
|
576
|
+
|
|
577
|
+
val response = client.get("/users/unknown-id")
|
|
578
|
+
|
|
579
|
+
response.status shouldBe HttpStatusCode.NotFound
|
|
580
|
+
}
|
|
581
|
+
}
|
|
582
|
+
})
|
|
583
|
+
```
|
|
584
|
+
|
|
585
|
+
### Testing Authenticated Routes
|
|
586
|
+
|
|
587
|
+
```kotlin
|
|
588
|
+
class AuthenticatedRoutesTest : FunSpec({
|
|
589
|
+
test("protected route requires JWT") {
|
|
590
|
+
testApplication {
|
|
591
|
+
application {
|
|
592
|
+
install(Koin) { modules(testModule) }
|
|
593
|
+
configureSerialization()
|
|
594
|
+
configureAuthentication()
|
|
595
|
+
configureRouting()
|
|
596
|
+
}
|
|
597
|
+
|
|
598
|
+
val response = client.post("/users") {
|
|
599
|
+
contentType(ContentType.Application.Json)
|
|
600
|
+
setBody(CreateUserRequest("Alice", "alice@example.com"))
|
|
601
|
+
}
|
|
602
|
+
|
|
603
|
+
response.status shouldBe HttpStatusCode.Unauthorized
|
|
604
|
+
}
|
|
605
|
+
}
|
|
606
|
+
|
|
607
|
+
test("protected route succeeds with valid JWT") {
|
|
608
|
+
testApplication {
|
|
609
|
+
application {
|
|
610
|
+
install(Koin) { modules(testModule) }
|
|
611
|
+
configureSerialization()
|
|
612
|
+
configureAuthentication()
|
|
613
|
+
configureRouting()
|
|
614
|
+
}
|
|
615
|
+
|
|
616
|
+
val token = generateTestJWT(userId = "test-user")
|
|
617
|
+
|
|
618
|
+
val client = createClient {
|
|
619
|
+
install(io.ktor.client.plugins.contentnegotiation.ContentNegotiation) { json() }
|
|
620
|
+
}
|
|
621
|
+
|
|
622
|
+
val response = client.post("/users") {
|
|
623
|
+
contentType(ContentType.Application.Json)
|
|
624
|
+
bearerAuth(token)
|
|
625
|
+
setBody(CreateUserRequest("Alice", "alice@example.com"))
|
|
626
|
+
}
|
|
627
|
+
|
|
628
|
+
response.status shouldBe HttpStatusCode.Created
|
|
629
|
+
}
|
|
630
|
+
}
|
|
631
|
+
})
|
|
632
|
+
```
|
|
633
|
+
|
|
634
|
+
## Configuration
|
|
635
|
+
|
|
636
|
+
### application.yaml
|
|
637
|
+
|
|
638
|
+
```yaml
|
|
639
|
+
ktor:
|
|
640
|
+
application:
|
|
641
|
+
modules:
|
|
642
|
+
- com.example.ApplicationKt.module
|
|
643
|
+
deployment:
|
|
644
|
+
port: 8080
|
|
645
|
+
|
|
646
|
+
jwt:
|
|
647
|
+
secret: ${JWT_SECRET}
|
|
648
|
+
issuer: "https://example.com"
|
|
649
|
+
audience: "https://example.com/api"
|
|
650
|
+
realm: "example"
|
|
651
|
+
|
|
652
|
+
database:
|
|
653
|
+
url: ${DATABASE_URL}
|
|
654
|
+
driver: "org.postgresql.Driver"
|
|
655
|
+
maxPoolSize: 10
|
|
656
|
+
```
|
|
657
|
+
|
|
658
|
+
### Reading Config
|
|
659
|
+
|
|
660
|
+
```kotlin
|
|
661
|
+
fun Application.configureDI() {
|
|
662
|
+
val dbUrl = environment.config.property("database.url").getString()
|
|
663
|
+
val dbDriver = environment.config.property("database.driver").getString()
|
|
664
|
+
val maxPoolSize = environment.config.property("database.maxPoolSize").getString().toInt()
|
|
665
|
+
|
|
666
|
+
install(Koin) {
|
|
667
|
+
modules(module {
|
|
668
|
+
single { DatabaseConfig(dbUrl, dbDriver, maxPoolSize) }
|
|
669
|
+
single { DatabaseFactory.create(get()) }
|
|
670
|
+
})
|
|
671
|
+
}
|
|
672
|
+
}
|
|
673
|
+
```
|
|
674
|
+
|
|
675
|
+
## Quick Reference: Ktor Patterns
|
|
676
|
+
|
|
677
|
+
| Pattern | Description |
|
|
678
|
+
|---------|-------------|
|
|
679
|
+
| `route("/path") { get { } }` | Route grouping with DSL |
|
|
680
|
+
| `call.receive<T>()` | Deserialize request body |
|
|
681
|
+
| `call.respond(status, body)` | Send response with status |
|
|
682
|
+
| `call.parameters["id"]` | Read path parameters |
|
|
683
|
+
| `call.request.queryParameters["q"]` | Read query parameters |
|
|
684
|
+
| `install(Plugin) { }` | Install and configure plugin |
|
|
685
|
+
| `authenticate("name") { }` | Protect routes with auth |
|
|
686
|
+
| `by inject<T>()` | Koin dependency injection |
|
|
687
|
+
| `testApplication { }` | Integration testing |
|
|
688
|
+
|
|
689
|
+
**Remember**: Ktor is designed around Kotlin coroutines and DSLs. Keep routes thin, push logic to services, and use Koin for dependency injection. Test with `testApplication` for full integration coverage.
|