codeply-cli 0.5.1 → 0.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (387) hide show
  1. package/LICENSE +21 -0
  2. package/THIRD_PARTY_NOTICES.md +65 -63
  3. package/bin/codeply.js +1 -1
  4. package/lib/agent.mjs +133 -24
  5. package/lib/ai.js +268 -9
  6. package/lib/ai.mjs +6 -6
  7. package/lib/apply-patch.js +217 -217
  8. package/lib/arity-table.json +138 -138
  9. package/lib/arity.js +70 -70
  10. package/lib/auth.mjs +6 -6
  11. package/lib/bots.js +82 -17
  12. package/lib/chatgpt.js +282 -0
  13. package/lib/cloud-browser.mjs +143 -143
  14. package/lib/cloud.mjs +1186 -1144
  15. package/lib/commands.js +103 -103
  16. package/lib/config.js +83 -3
  17. package/lib/design-library/assemble-artifact.mjs +21 -21
  18. package/lib/design-library/cleanup.mjs +45 -45
  19. package/lib/design-library/index.json +22379 -22379
  20. package/lib/design-library/make-table-data.mjs +39 -39
  21. package/lib/diagnostics.js +192 -192
  22. package/lib/edit-engine.js +364 -364
  23. package/lib/github-agent.mjs +311 -311
  24. package/lib/history.js +75 -75
  25. package/lib/mail-watch.js +504 -0
  26. package/lib/mcp.js +258 -258
  27. package/lib/model-sync.js +114 -0
  28. package/lib/native-tools.mjs +16 -1
  29. package/lib/oauth-connectors.js +146 -24
  30. package/lib/permissions.js +109 -109
  31. package/lib/plugins.js +353 -353
  32. package/lib/publish.js +916 -0
  33. package/lib/reach.js +67 -0
  34. package/lib/server.mjs +457 -457
  35. package/lib/session-db.js +220 -220
  36. package/lib/share.js +168 -168
  37. package/lib/skills.js +2 -0
  38. package/lib/snapshot.js +146 -146
  39. package/lib/telemetry.js +102 -0
  40. package/lib/terminal-hints.js +154 -154
  41. package/lib/tools.mjs +316 -14
  42. package/lib/typecheck-worker.js +147 -147
  43. package/lib/web-tools.js +209 -158
  44. package/package.json +49 -49
  45. package/skills/SOURCE.md +58 -58
  46. package/skills/accessibility/SKILL.md +147 -147
  47. package/skills/agent-architecture-audit/SKILL.md +257 -257
  48. package/skills/agent-eval/SKILL.md +147 -147
  49. package/skills/agent-harness-construction/SKILL.md +74 -74
  50. package/skills/agent-introspection-debugging/SKILL.md +154 -154
  51. package/skills/agent-payment-x402/SKILL.md +225 -225
  52. package/skills/agent-self-evaluation/SKILL.md +182 -182
  53. package/skills/agent-self-evaluation/references/evaluation-criteria.md +71 -71
  54. package/skills/agent-self-evaluation/references/hook-integration.md +64 -64
  55. package/skills/agent-sort/SKILL.md +216 -216
  56. package/skills/agentic-engineering/SKILL.md +64 -64
  57. package/skills/agentic-os/SKILL.md +388 -388
  58. package/skills/ai-first-engineering/SKILL.md +52 -52
  59. package/skills/ai-regression-testing/SKILL.md +386 -386
  60. package/skills/android-clean-architecture/SKILL.md +340 -340
  61. package/skills/angular-developer/SKILL.md +155 -155
  62. package/skills/angular-developer/references/angular-animations.md +160 -160
  63. package/skills/angular-developer/references/angular-aria.md +410 -410
  64. package/skills/angular-developer/references/cli.md +86 -86
  65. package/skills/angular-developer/references/component-harnesses.md +59 -59
  66. package/skills/angular-developer/references/component-styling.md +91 -91
  67. package/skills/angular-developer/references/components.md +117 -117
  68. package/skills/angular-developer/references/creating-services.md +97 -97
  69. package/skills/angular-developer/references/data-resolvers.md +69 -69
  70. package/skills/angular-developer/references/define-routes.md +67 -67
  71. package/skills/angular-developer/references/defining-providers.md +72 -72
  72. package/skills/angular-developer/references/di-fundamentals.md +120 -120
  73. package/skills/angular-developer/references/e2e-testing.md +56 -56
  74. package/skills/angular-developer/references/effects.md +83 -83
  75. package/skills/angular-developer/references/hierarchical-injectors.md +43 -43
  76. package/skills/angular-developer/references/host-elements.md +80 -80
  77. package/skills/angular-developer/references/injection-context.md +63 -63
  78. package/skills/angular-developer/references/inputs.md +101 -101
  79. package/skills/angular-developer/references/linked-signal.md +59 -59
  80. package/skills/angular-developer/references/loading-strategies.md +61 -61
  81. package/skills/angular-developer/references/mcp.md +108 -108
  82. package/skills/angular-developer/references/navigate-to-routes.md +69 -69
  83. package/skills/angular-developer/references/outputs.md +86 -86
  84. package/skills/angular-developer/references/reactive-forms.md +122 -122
  85. package/skills/angular-developer/references/rendering-strategies.md +44 -44
  86. package/skills/angular-developer/references/resource.md +77 -77
  87. package/skills/angular-developer/references/route-animations.md +56 -56
  88. package/skills/angular-developer/references/route-guards.md +52 -52
  89. package/skills/angular-developer/references/router-lifecycle.md +45 -45
  90. package/skills/angular-developer/references/router-testing.md +87 -87
  91. package/skills/angular-developer/references/show-routes-with-outlets.md +68 -68
  92. package/skills/angular-developer/references/signal-forms.md +795 -795
  93. package/skills/angular-developer/references/signals-overview.md +94 -94
  94. package/skills/angular-developer/references/tailwind-css.md +69 -69
  95. package/skills/angular-developer/references/template-driven-forms.md +114 -114
  96. package/skills/angular-developer/references/testing-fundamentals.md +65 -65
  97. package/skills/api-connector-builder/SKILL.md +121 -121
  98. package/skills/api-design/SKILL.md +524 -524
  99. package/skills/architecture-decision-records/SKILL.md +180 -180
  100. package/skills/article-writing/SKILL.md +80 -80
  101. package/skills/automation-audit-ops/SKILL.md +143 -143
  102. package/skills/autonomous-agent-harness/SKILL.md +274 -274
  103. package/skills/autonomous-loops/SKILL.md +611 -611
  104. package/skills/backend-patterns/SKILL.md +562 -562
  105. package/skills/benchmark/SKILL.md +95 -95
  106. package/skills/benchmark-methodology/SKILL.md +191 -191
  107. package/skills/benchmark-optimization-loop/SKILL.md +71 -71
  108. package/skills/blender-motion-state-inspection/SKILL.md +165 -165
  109. package/skills/blueprint/SKILL.md +106 -106
  110. package/skills/brand-discovery/SKILL.md +145 -145
  111. package/skills/brand-discovery/references/10_purpose-why.md +40 -40
  112. package/skills/brand-discovery/references/20_positioning.md +44 -44
  113. package/skills/brand-discovery/references/30_audience-niche.md +52 -52
  114. package/skills/brand-discovery/references/40_personality-archetype.md +57 -57
  115. package/skills/brand-discovery/references/50_voice-tone.md +59 -59
  116. package/skills/brand-discovery/references/60_narrative-story.md +50 -50
  117. package/skills/brand-discovery/references/70_founder-tension.md +49 -49
  118. package/skills/brand-discovery/references/90_SYNTHESIS.md +133 -133
  119. package/skills/brand-voice/SKILL.md +98 -98
  120. package/skills/brand-voice/references/voice-profile-schema.md +55 -55
  121. package/skills/browser-qa/SKILL.md +105 -105
  122. package/skills/bun-runtime/SKILL.md +85 -85
  123. package/skills/canary-watch/SKILL.md +108 -108
  124. package/skills/carrier-relationship-management/SKILL.md +212 -212
  125. package/skills/cisco-ios-patterns/SKILL.md +164 -164
  126. package/skills/ck/SKILL.md +148 -148
  127. package/skills/claude-devfleet/SKILL.md +112 -112
  128. package/skills/click-path-audit/SKILL.md +245 -245
  129. package/skills/clickhouse-io/SKILL.md +445 -445
  130. package/skills/code-tour/SKILL.md +254 -254
  131. package/skills/codebase-onboarding/SKILL.md +234 -234
  132. package/skills/codehealth-mcp/SKILL.md +167 -167
  133. package/skills/coding-standards/SKILL.md +551 -551
  134. package/skills/competitive-platform-analysis/SKILL.md +214 -214
  135. package/skills/competitive-report-structure/SKILL.md +162 -162
  136. package/skills/compose-multiplatform-patterns/SKILL.md +300 -300
  137. package/skills/config-gc/SKILL.md +120 -120
  138. package/skills/configure-ecc/SKILL.md +385 -385
  139. package/skills/connections-optimizer/SKILL.md +190 -190
  140. package/skills/content-engine/SKILL.md +132 -132
  141. package/skills/content-hash-cache-pattern/SKILL.md +162 -162
  142. package/skills/context-budget/SKILL.md +136 -136
  143. package/skills/continuous-agent-loop/SKILL.md +46 -46
  144. package/skills/continuous-learning/SKILL.md +132 -132
  145. package/skills/continuous-learning-v2/SKILL.md +361 -361
  146. package/skills/contract-first/SKILL.md +287 -287
  147. package/skills/cost-aware-llm-pipeline/SKILL.md +184 -184
  148. package/skills/cost-tracking/SKILL.md +97 -97
  149. package/skills/council/SKILL.md +204 -204
  150. package/skills/cpp-coding-standards/SKILL.md +724 -724
  151. package/skills/cpp-testing/SKILL.md +325 -325
  152. package/skills/crosspost/SKILL.md +112 -112
  153. package/skills/csharp-testing/SKILL.md +322 -322
  154. package/skills/customer-billing-ops/SKILL.md +141 -141
  155. package/skills/customs-trade-compliance/SKILL.md +263 -263
  156. package/skills/dart-flutter-patterns/SKILL.md +564 -564
  157. package/skills/dashboard-builder/SKILL.md +109 -109
  158. package/skills/data-scraper-agent/SKILL.md +765 -765
  159. package/skills/data-throughput-accelerator/SKILL.md +74 -74
  160. package/skills/database-migrations/SKILL.md +430 -430
  161. package/skills/deep-research/SKILL.md +160 -160
  162. package/skills/defi-amm-security/SKILL.md +167 -167
  163. package/skills/delivery-gate/SKILL.md +126 -126
  164. package/skills/deployment-patterns/SKILL.md +428 -428
  165. package/skills/design-system/SKILL.md +83 -83
  166. package/skills/django-celery/SKILL.md +458 -458
  167. package/skills/django-patterns/SKILL.md +735 -735
  168. package/skills/django-security/SKILL.md +644 -644
  169. package/skills/django-tdd/SKILL.md +730 -730
  170. package/skills/django-verification/SKILL.md +470 -470
  171. package/skills/dmux-workflows/SKILL.md +192 -192
  172. package/skills/docker-patterns/SKILL.md +365 -365
  173. package/skills/documentation-lookup/SKILL.md +91 -91
  174. package/skills/dotnet-patterns/SKILL.md +322 -322
  175. package/skills/dynamic-workflow-mode/SKILL.md +124 -124
  176. package/skills/e2e-testing/SKILL.md +327 -327
  177. package/skills/ecc-guide/SKILL.md +190 -190
  178. package/skills/ecc-recipes/SKILL.md +149 -149
  179. package/skills/ecc-tools-cost-audit/SKILL.md +161 -161
  180. package/skills/email-ops/SKILL.md +122 -122
  181. package/skills/energy-procurement/SKILL.md +228 -228
  182. package/skills/enterprise-agent-ops/SKILL.md +51 -51
  183. package/skills/error-handling/SKILL.md +377 -377
  184. package/skills/eval-harness/SKILL.md +271 -271
  185. package/skills/evm-token-decimals/SKILL.md +131 -131
  186. package/skills/exa-search/SKILL.md +108 -108
  187. package/skills/fal-ai-media/SKILL.md +289 -289
  188. package/skills/fastapi-patterns/SKILL.md +514 -514
  189. package/skills/finance-billing-ops/SKILL.md +128 -128
  190. package/skills/flox-environments/SKILL.md +497 -497
  191. package/skills/flutter-dart-code-review/SKILL.md +436 -436
  192. package/skills/foundation-models-on-device/SKILL.md +243 -243
  193. package/skills/frontend-a11y/SKILL.md +446 -446
  194. package/skills/frontend-design-direction/SKILL.md +93 -93
  195. package/skills/frontend-patterns/SKILL.md +657 -657
  196. package/skills/frontend-slides/SKILL.md +185 -185
  197. package/skills/fsharp-testing/SKILL.md +281 -281
  198. package/skills/gan-style-harness/SKILL.md +279 -279
  199. package/skills/gateguard/SKILL.md +133 -133
  200. package/skills/generating-python-installer/SKILL.md +820 -820
  201. package/skills/git-workflow/SKILL.md +716 -716
  202. package/skills/github-ops/SKILL.md +145 -145
  203. package/skills/golang-patterns/SKILL.md +676 -676
  204. package/skills/golang-testing/SKILL.md +721 -721
  205. package/skills/google-workspace-ops/SKILL.md +96 -96
  206. package/skills/growth-log/SKILL.md +128 -128
  207. package/skills/healthcare-cdss-patterns/SKILL.md +246 -246
  208. package/skills/healthcare-emr-patterns/SKILL.md +160 -160
  209. package/skills/healthcare-eval-harness/SKILL.md +208 -208
  210. package/skills/healthcare-phi-compliance/SKILL.md +146 -146
  211. package/skills/hermes-imports/SKILL.md +89 -89
  212. package/skills/hexagonal-architecture/SKILL.md +277 -277
  213. package/skills/hipaa-compliance/SKILL.md +79 -79
  214. package/skills/homelab-network-readiness/SKILL.md +170 -170
  215. package/skills/homelab-network-setup/SKILL.md +130 -130
  216. package/skills/homelab-pihole-dns/SKILL.md +275 -275
  217. package/skills/homelab-vlan-segmentation/SKILL.md +312 -312
  218. package/skills/homelab-wireguard-vpn/SKILL.md +306 -306
  219. package/skills/hookify-rules/SKILL.md +128 -128
  220. package/skills/inherit-legacy-style/SKILL.md +157 -157
  221. package/skills/intent-driven-development/SKILL.md +360 -360
  222. package/skills/inventory-demand-planning/SKILL.md +247 -247
  223. package/skills/investor-materials/SKILL.md +97 -97
  224. package/skills/investor-outreach/SKILL.md +92 -92
  225. package/skills/ios-icon-gen/SKILL.md +158 -158
  226. package/skills/iterative-retrieval/SKILL.md +212 -212
  227. package/skills/ito-basket-compare/SKILL.md +64 -64
  228. package/skills/ito-compute/SKILL.md +129 -129
  229. package/skills/ito-data-atlas-agent/SKILL.md +64 -64
  230. package/skills/ito-market-intelligence/SKILL.md +61 -61
  231. package/skills/ito-trade-planner/SKILL.md +68 -68
  232. package/skills/java-coding-standards/SKILL.md +384 -384
  233. package/skills/jira-integration/SKILL.md +303 -303
  234. package/skills/jpa-patterns/SKILL.md +152 -152
  235. package/skills/knowledge-ops/SKILL.md +155 -155
  236. package/skills/kotlin-coroutines-flows/SKILL.md +285 -285
  237. package/skills/kotlin-exposed-patterns/SKILL.md +720 -720
  238. package/skills/kotlin-ktor-patterns/SKILL.md +690 -690
  239. package/skills/kotlin-patterns/SKILL.md +712 -712
  240. package/skills/kotlin-testing/SKILL.md +825 -825
  241. package/skills/kubernetes-patterns/SKILL.md +756 -756
  242. package/skills/laravel-patterns/SKILL.md +416 -416
  243. package/skills/laravel-plugin-discovery/SKILL.md +230 -230
  244. package/skills/laravel-security/SKILL.md +948 -948
  245. package/skills/laravel-tdd/SKILL.md +675 -675
  246. package/skills/laravel-verification/SKILL.md +180 -180
  247. package/skills/latency-critical-systems/SKILL.md +75 -75
  248. package/skills/lead-intelligence/SKILL.md +322 -322
  249. package/skills/liquid-glass-design/SKILL.md +279 -279
  250. package/skills/llm-trading-agent-security/SKILL.md +147 -147
  251. package/skills/logistics-exception-management/SKILL.md +222 -222
  252. package/skills/loop-design-check/SKILL.md +143 -143
  253. package/skills/mailtrap-email-integration/SKILL.md +77 -77
  254. package/skills/make-interfaces-feel-better/SKILL.md +152 -152
  255. package/skills/manim-video/SKILL.md +90 -90
  256. package/skills/market-research/SKILL.md +76 -76
  257. package/skills/marketing-campaign/SKILL.md +114 -114
  258. package/skills/mcp-server-patterns/SKILL.md +70 -70
  259. package/skills/messages-ops/SKILL.md +105 -105
  260. package/skills/ml-adoption-playbook/SKILL.md +57 -57
  261. package/skills/mle-workflow/SKILL.md +348 -348
  262. package/skills/motion-advanced/SKILL.md +596 -596
  263. package/skills/motion-foundations/SKILL.md +299 -299
  264. package/skills/motion-patterns/SKILL.md +434 -434
  265. package/skills/motion-ui/SKILL.md +576 -576
  266. package/skills/mysql-patterns/SKILL.md +413 -413
  267. package/skills/nanoclaw-repl/SKILL.md +34 -34
  268. package/skills/nestjs-patterns/SKILL.md +231 -231
  269. package/skills/netmiko-ssh-automation/SKILL.md +174 -174
  270. package/skills/network-bgp-diagnostics/SKILL.md +168 -168
  271. package/skills/network-config-validation/SKILL.md +211 -211
  272. package/skills/network-interface-health/SKILL.md +153 -153
  273. package/skills/nextjs-turbopack/SKILL.md +58 -58
  274. package/skills/nodejs-keccak256/SKILL.md +103 -103
  275. package/skills/nutrient-document-processing/SKILL.md +168 -168
  276. package/skills/nuxt4-patterns/SKILL.md +101 -101
  277. package/skills/openclaw-persona-forge/SKILL.md +289 -289
  278. package/skills/openclaw-persona-forge/references/avatar-style.md +124 -124
  279. package/skills/openclaw-persona-forge/references/boundary-rules.md +53 -53
  280. package/skills/openclaw-persona-forge/references/error-handling.md +53 -53
  281. package/skills/openclaw-persona-forge/references/identity-tension.md +48 -48
  282. package/skills/openclaw-persona-forge/references/naming-system.md +39 -39
  283. package/skills/openclaw-persona-forge/references/output-template.md +166 -166
  284. package/skills/opensource-pipeline/SKILL.md +256 -256
  285. package/skills/orch-add-feature/SKILL.md +45 -45
  286. package/skills/orch-build-mvp/SKILL.md +49 -49
  287. package/skills/orch-change-feature/SKILL.md +43 -43
  288. package/skills/orch-fix-defect/SKILL.md +43 -43
  289. package/skills/orch-pipeline/SKILL.md +121 -121
  290. package/skills/orch-refine-code/SKILL.md +44 -44
  291. package/skills/parallel-execution-optimizer/SKILL.md +74 -74
  292. package/skills/perl-patterns/SKILL.md +505 -505
  293. package/skills/perl-security/SKILL.md +504 -504
  294. package/skills/perl-testing/SKILL.md +476 -476
  295. package/skills/plan-canvas/SKILL.md +153 -153
  296. package/skills/plan-orchestrate/SKILL.md +263 -263
  297. package/skills/plankton-code-quality/SKILL.md +237 -237
  298. package/skills/postgres-patterns/SKILL.md +148 -148
  299. package/skills/prediction-market-oracle-research/SKILL.md +64 -64
  300. package/skills/prediction-market-risk-review/SKILL.md +61 -61
  301. package/skills/premium-web-design/SKILL.md +154 -154
  302. package/skills/prisma-patterns/SKILL.md +401 -401
  303. package/skills/product-capability/SKILL.md +142 -142
  304. package/skills/product-lens/SKILL.md +93 -93
  305. package/skills/production-audit/SKILL.md +207 -207
  306. package/skills/production-scheduling/SKILL.md +238 -238
  307. package/skills/project-flow-ops/SKILL.md +112 -112
  308. package/skills/prompt-optimizer/SKILL.md +398 -398
  309. package/skills/publish-website/SKILL.md +76 -0
  310. package/skills/python-patterns/SKILL.md +751 -751
  311. package/skills/python-testing/SKILL.md +817 -817
  312. package/skills/pytorch-patterns/SKILL.md +397 -397
  313. package/skills/quality-nonconformance/SKILL.md +260 -260
  314. package/skills/quarkus-patterns/SKILL.md +723 -723
  315. package/skills/quarkus-security/SKILL.md +468 -468
  316. package/skills/quarkus-tdd/SKILL.md +812 -812
  317. package/skills/quarkus-verification/SKILL.md +480 -480
  318. package/skills/ralphinho-rfc-pipeline/SKILL.md +68 -68
  319. package/skills/react-native-patterns/SKILL.md +326 -326
  320. package/skills/react-patterns/SKILL.md +342 -342
  321. package/skills/react-performance/SKILL.md +575 -575
  322. package/skills/react-testing/SKILL.md +424 -424
  323. package/skills/recsys-pipeline-architect/SKILL.md +115 -115
  324. package/skills/recursive-decision-ledger/SKILL.md +81 -81
  325. package/skills/redis-patterns/SKILL.md +404 -404
  326. package/skills/regex-vs-llm-structured-text/SKILL.md +221 -221
  327. package/skills/remotion-video-creation/SKILL.md +43 -43
  328. package/skills/repo-scan/SKILL.md +79 -79
  329. package/skills/research-ops/SKILL.md +113 -113
  330. package/skills/returns-reverse-logistics/SKILL.md +240 -240
  331. package/skills/rules-distill/SKILL.md +265 -265
  332. package/skills/rust-patterns/SKILL.md +500 -500
  333. package/skills/rust-testing/SKILL.md +501 -501
  334. package/skills/safety-guard/SKILL.md +76 -76
  335. package/skills/santa-method/SKILL.md +307 -307
  336. package/skills/scientific-db-pubmed-database/SKILL.md +176 -176
  337. package/skills/scientific-db-uspto-database/SKILL.md +178 -178
  338. package/skills/scientific-pkg-gget/SKILL.md +167 -167
  339. package/skills/scientific-thinking-literature-review/SKILL.md +193 -193
  340. package/skills/scientific-thinking-scholar-evaluation/SKILL.md +161 -161
  341. package/skills/search-first/SKILL.md +183 -183
  342. package/skills/security-bounty-hunter/SKILL.md +100 -100
  343. package/skills/security-review/SKILL.md +504 -504
  344. package/skills/security-scan/SKILL.md +166 -166
  345. package/skills/seo/SKILL.md +155 -155
  346. package/skills/skill-comply/SKILL.md +59 -59
  347. package/skills/skill-scout/SKILL.md +141 -141
  348. package/skills/skill-stocktake/SKILL.md +195 -195
  349. package/skills/social-graph-ranker/SKILL.md +155 -155
  350. package/skills/social-publisher/SKILL.md +130 -130
  351. package/skills/springboot-patterns/SKILL.md +315 -315
  352. package/skills/springboot-security/SKILL.md +273 -273
  353. package/skills/springboot-tdd/SKILL.md +159 -159
  354. package/skills/springboot-verification/SKILL.md +232 -232
  355. package/skills/strategic-compact/SKILL.md +142 -142
  356. package/skills/swift-actor-persistence/SKILL.md +144 -144
  357. package/skills/swift-concurrency-6-2/SKILL.md +216 -216
  358. package/skills/swift-protocol-di-testing/SKILL.md +191 -191
  359. package/skills/swiftui-patterns/SKILL.md +259 -259
  360. package/skills/taste/SKILL.md +264 -264
  361. package/skills/taste/references/genre-taxonomy.md +87 -87
  362. package/skills/tdd-workflow/SKILL.md +583 -583
  363. package/skills/team-agent-orchestration/SKILL.md +111 -111
  364. package/skills/team-builder/SKILL.md +169 -169
  365. package/skills/terminal-ops/SKILL.md +110 -110
  366. package/skills/tinystruct-patterns/SKILL.md +279 -279
  367. package/skills/tinystruct-patterns/references/architecture.md +90 -90
  368. package/skills/tinystruct-patterns/references/data-handling.md +60 -60
  369. package/skills/tinystruct-patterns/references/database.md +99 -99
  370. package/skills/tinystruct-patterns/references/routing.md +64 -64
  371. package/skills/tinystruct-patterns/references/system-usage.md +97 -97
  372. package/skills/tinystruct-patterns/references/testing.md +72 -72
  373. package/skills/token-budget-advisor/SKILL.md +134 -134
  374. package/skills/ui-demo/SKILL.md +466 -466
  375. package/skills/ui-to-vue/SKILL.md +135 -135
  376. package/skills/uncloud/SKILL.md +344 -344
  377. package/skills/unified-memory/SKILL.md +170 -170
  378. package/skills/unified-notifications-ops/SKILL.md +188 -188
  379. package/skills/verification-loop/SKILL.md +129 -129
  380. package/skills/video-editing/SKILL.md +311 -311
  381. package/skills/videodb/SKILL.md +375 -375
  382. package/skills/visa-doc-translate/SKILL.md +117 -117
  383. package/skills/vite-patterns/SKILL.md +450 -450
  384. package/skills/vue-patterns/SKILL.md +471 -471
  385. package/skills/windows-desktop-e2e/SKILL.md +888 -888
  386. package/skills/workspace-surface-audit/SKILL.md +126 -126
  387. package/skills/x-api/SKILL.md +235 -235
@@ -1,690 +1,690 @@
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
- metadata:
5
- origin: ECC
6
- ---
7
-
8
- # Ktor Server Patterns
9
-
10
- Comprehensive Ktor patterns for building robust, maintainable HTTP servers with Kotlin coroutines.
11
-
12
- ## When to Activate
13
-
14
- - Building Ktor HTTP servers
15
- - Configuring Ktor plugins (Auth, CORS, ContentNegotiation, StatusPages)
16
- - Implementing REST APIs with Ktor
17
- - Setting up dependency injection with Koin
18
- - Writing Ktor integration tests with testApplication
19
- - Working with WebSockets in Ktor
20
-
21
- ## Application Structure
22
-
23
- ### Standard Ktor Project Layout
24
-
25
- ```text
26
- src/main/kotlin/
27
- ├── com/example/
28
- │ ├── Application.kt # Entry point, module configuration
29
- │ ├── plugins/
30
- │ │ ├── Routing.kt # Route definitions
31
- │ │ ├── Serialization.kt # Content negotiation setup
32
- │ │ ├── Authentication.kt # Auth configuration
33
- │ │ ├── StatusPages.kt # Error handling
34
- │ │ └── CORS.kt # CORS configuration
35
- │ ├── routes/
36
- │ │ ├── UserRoutes.kt # /users endpoints
37
- │ │ ├── AuthRoutes.kt # /auth endpoints
38
- │ │ └── HealthRoutes.kt # /health endpoints
39
- │ ├── models/
40
- │ │ ├── User.kt # Domain models
41
- │ │ └── ApiResponse.kt # Response envelopes
42
- │ ├── services/
43
- │ │ ├── UserService.kt # Business logic
44
- │ │ └── AuthService.kt # Auth logic
45
- │ ├── repositories/
46
- │ │ ├── UserRepository.kt # Data access interface
47
- │ │ └── ExposedUserRepository.kt
48
- │ └── di/
49
- │ └── AppModule.kt # Koin modules
50
- src/test/kotlin/
51
- ├── com/example/
52
- │ ├── routes/
53
- │ │ └── UserRoutesTest.kt
54
- │ └── services/
55
- │ └── UserServiceTest.kt
56
- ```
57
-
58
- ### Application Entry Point
59
-
60
- ```kotlin
61
- // Application.kt
62
- fun main() {
63
- embeddedServer(Netty, port = 8080, module = Application::module).start(wait = true)
64
- }
65
-
66
- fun Application.module() {
67
- configureSerialization()
68
- configureAuthentication()
69
- configureStatusPages()
70
- configureCORS()
71
- configureDI()
72
- configureRouting()
73
- }
74
- ```
75
-
76
- ## Routing DSL
77
-
78
- ### Basic Routes
79
-
80
- ```kotlin
81
- // plugins/Routing.kt
82
- fun Application.configureRouting() {
83
- routing {
84
- userRoutes()
85
- authRoutes()
86
- healthRoutes()
87
- }
88
- }
89
-
90
- // routes/UserRoutes.kt
91
- fun Route.userRoutes() {
92
- val userService by inject<UserService>()
93
-
94
- route("/users") {
95
- get {
96
- val users = userService.getAll()
97
- call.respond(users)
98
- }
99
-
100
- get("/{id}") {
101
- val id = call.parameters["id"]
102
- ?: return@get call.respond(HttpStatusCode.BadRequest, "Missing id")
103
- val user = userService.getById(id)
104
- ?: return@get call.respond(HttpStatusCode.NotFound)
105
- call.respond(user)
106
- }
107
-
108
- post {
109
- val request = call.receive<CreateUserRequest>()
110
- val user = userService.create(request)
111
- call.respond(HttpStatusCode.Created, user)
112
- }
113
-
114
- put("/{id}") {
115
- val id = call.parameters["id"]
116
- ?: return@put call.respond(HttpStatusCode.BadRequest, "Missing id")
117
- val request = call.receive<UpdateUserRequest>()
118
- val user = userService.update(id, request)
119
- ?: return@put call.respond(HttpStatusCode.NotFound)
120
- call.respond(user)
121
- }
122
-
123
- delete("/{id}") {
124
- val id = call.parameters["id"]
125
- ?: return@delete call.respond(HttpStatusCode.BadRequest, "Missing id")
126
- val deleted = userService.delete(id)
127
- if (deleted) call.respond(HttpStatusCode.NoContent)
128
- else call.respond(HttpStatusCode.NotFound)
129
- }
130
- }
131
- }
132
- ```
133
-
134
- ### Route Organization with Authenticated Routes
135
-
136
- ```kotlin
137
- fun Route.userRoutes() {
138
- route("/users") {
139
- // Public routes
140
- get { /* list users */ }
141
- get("/{id}") { /* get user */ }
142
-
143
- // Protected routes
144
- authenticate("jwt") {
145
- post { /* create user - requires auth */ }
146
- put("/{id}") { /* update user - requires auth */ }
147
- delete("/{id}") { /* delete user - requires auth */ }
148
- }
149
- }
150
- }
151
- ```
152
-
153
- ## Content Negotiation & Serialization
154
-
155
- ### kotlinx.serialization Setup
156
-
157
- ```kotlin
158
- // plugins/Serialization.kt
159
- fun Application.configureSerialization() {
160
- install(ContentNegotiation) {
161
- json(Json {
162
- prettyPrint = true
163
- isLenient = false
164
- ignoreUnknownKeys = true
165
- encodeDefaults = true
166
- explicitNulls = false
167
- })
168
- }
169
- }
170
- ```
171
-
172
- ### Serializable Models
173
-
174
- ```kotlin
175
- @Serializable
176
- data class UserResponse(
177
- val id: String,
178
- val name: String,
179
- val email: String,
180
- val role: Role,
181
- @Serializable(with = InstantSerializer::class)
182
- val createdAt: Instant,
183
- )
184
-
185
- @Serializable
186
- data class CreateUserRequest(
187
- val name: String,
188
- val email: String,
189
- val role: Role = Role.USER,
190
- )
191
-
192
- @Serializable
193
- data class ApiResponse<T>(
194
- val success: Boolean,
195
- val data: T? = null,
196
- val error: String? = null,
197
- ) {
198
- companion object {
199
- fun <T> ok(data: T): ApiResponse<T> = ApiResponse(success = true, data = data)
200
- fun <T> error(message: String): ApiResponse<T> = ApiResponse(success = false, error = message)
201
- }
202
- }
203
-
204
- @Serializable
205
- data class PaginatedResponse<T>(
206
- val data: List<T>,
207
- val total: Long,
208
- val page: Int,
209
- val limit: Int,
210
- )
211
- ```
212
-
213
- ### Custom Serializers
214
-
215
- ```kotlin
216
- object InstantSerializer : KSerializer<Instant> {
217
- override val descriptor = PrimitiveSerialDescriptor("Instant", PrimitiveKind.STRING)
218
- override fun serialize(encoder: Encoder, value: Instant) =
219
- encoder.encodeString(value.toString())
220
- override fun deserialize(decoder: Decoder): Instant =
221
- Instant.parse(decoder.decodeString())
222
- }
223
- ```
224
-
225
- ## Authentication
226
-
227
- ### JWT Authentication
228
-
229
- ```kotlin
230
- // plugins/Authentication.kt
231
- fun Application.configureAuthentication() {
232
- val jwtSecret = environment.config.property("jwt.secret").getString()
233
- val jwtIssuer = environment.config.property("jwt.issuer").getString()
234
- val jwtAudience = environment.config.property("jwt.audience").getString()
235
- val jwtRealm = environment.config.property("jwt.realm").getString()
236
-
237
- install(Authentication) {
238
- jwt("jwt") {
239
- realm = jwtRealm
240
- verifier(
241
- JWT.require(Algorithm.HMAC256(jwtSecret))
242
- .withAudience(jwtAudience)
243
- .withIssuer(jwtIssuer)
244
- .build()
245
- )
246
- validate { credential ->
247
- if (credential.payload.audience.contains(jwtAudience)) {
248
- JWTPrincipal(credential.payload)
249
- } else {
250
- null
251
- }
252
- }
253
- challenge { _, _ ->
254
- call.respond(HttpStatusCode.Unauthorized, ApiResponse.error<Unit>("Invalid or expired token"))
255
- }
256
- }
257
- }
258
- }
259
-
260
- // Extracting user from JWT
261
- fun ApplicationCall.userId(): String =
262
- principal<JWTPrincipal>()
263
- ?.payload
264
- ?.getClaim("userId")
265
- ?.asString()
266
- ?: throw AuthenticationException("No userId in token")
267
- ```
268
-
269
- ### Auth Routes
270
-
271
- ```kotlin
272
- fun Route.authRoutes() {
273
- val authService by inject<AuthService>()
274
-
275
- route("/auth") {
276
- post("/login") {
277
- val request = call.receive<LoginRequest>()
278
- val token = authService.login(request.email, request.password)
279
- ?: return@post call.respond(
280
- HttpStatusCode.Unauthorized,
281
- ApiResponse.error<Unit>("Invalid credentials"),
282
- )
283
- call.respond(ApiResponse.ok(TokenResponse(token)))
284
- }
285
-
286
- post("/register") {
287
- val request = call.receive<RegisterRequest>()
288
- val user = authService.register(request)
289
- call.respond(HttpStatusCode.Created, ApiResponse.ok(user))
290
- }
291
-
292
- authenticate("jwt") {
293
- get("/me") {
294
- val userId = call.userId()
295
- val user = authService.getProfile(userId)
296
- call.respond(ApiResponse.ok(user))
297
- }
298
- }
299
- }
300
- }
301
- ```
302
-
303
- ## Status Pages (Error Handling)
304
-
305
- ```kotlin
306
- // plugins/StatusPages.kt
307
- fun Application.configureStatusPages() {
308
- install(StatusPages) {
309
- exception<ContentTransformationException> { call, cause ->
310
- call.respond(
311
- HttpStatusCode.BadRequest,
312
- ApiResponse.error<Unit>("Invalid request body: ${cause.message}"),
313
- )
314
- }
315
-
316
- exception<IllegalArgumentException> { call, cause ->
317
- call.respond(
318
- HttpStatusCode.BadRequest,
319
- ApiResponse.error<Unit>(cause.message ?: "Bad request"),
320
- )
321
- }
322
-
323
- exception<AuthenticationException> { call, _ ->
324
- call.respond(
325
- HttpStatusCode.Unauthorized,
326
- ApiResponse.error<Unit>("Authentication required"),
327
- )
328
- }
329
-
330
- exception<AuthorizationException> { call, _ ->
331
- call.respond(
332
- HttpStatusCode.Forbidden,
333
- ApiResponse.error<Unit>("Access denied"),
334
- )
335
- }
336
-
337
- exception<NotFoundException> { call, cause ->
338
- call.respond(
339
- HttpStatusCode.NotFound,
340
- ApiResponse.error<Unit>(cause.message ?: "Resource not found"),
341
- )
342
- }
343
-
344
- exception<Throwable> { call, cause ->
345
- call.application.log.error("Unhandled exception", cause)
346
- call.respond(
347
- HttpStatusCode.InternalServerError,
348
- ApiResponse.error<Unit>("Internal server error"),
349
- )
350
- }
351
-
352
- status(HttpStatusCode.NotFound) { call, status ->
353
- call.respond(status, ApiResponse.error<Unit>("Route not found"))
354
- }
355
- }
356
- }
357
- ```
358
-
359
- ## CORS Configuration
360
-
361
- ```kotlin
362
- // plugins/CORS.kt
363
- fun Application.configureCORS() {
364
- install(CORS) {
365
- allowHost("localhost:3000")
366
- allowHost("example.com", schemes = listOf("https"))
367
- allowHeader(HttpHeaders.ContentType)
368
- allowHeader(HttpHeaders.Authorization)
369
- allowMethod(HttpMethod.Put)
370
- allowMethod(HttpMethod.Delete)
371
- allowMethod(HttpMethod.Patch)
372
- allowCredentials = true
373
- maxAgeInSeconds = 3600
374
- }
375
- }
376
- ```
377
-
378
- ## Koin Dependency Injection
379
-
380
- ### Module Definition
381
-
382
- ```kotlin
383
- // di/AppModule.kt
384
- val appModule = module {
385
- // Database
386
- single<Database> { DatabaseFactory.create(get()) }
387
-
388
- // Repositories
389
- single<UserRepository> { ExposedUserRepository(get()) }
390
- single<OrderRepository> { ExposedOrderRepository(get()) }
391
-
392
- // Services
393
- single { UserService(get()) }
394
- single { OrderService(get(), get()) }
395
- single { AuthService(get(), get()) }
396
- }
397
-
398
- // Application setup
399
- fun Application.configureDI() {
400
- install(Koin) {
401
- modules(appModule)
402
- }
403
- }
404
- ```
405
-
406
- ### Using Koin in Routes
407
-
408
- ```kotlin
409
- fun Route.userRoutes() {
410
- val userService by inject<UserService>()
411
-
412
- route("/users") {
413
- get {
414
- val users = userService.getAll()
415
- call.respond(ApiResponse.ok(users))
416
- }
417
- }
418
- }
419
- ```
420
-
421
- ### Koin for Testing
422
-
423
- ```kotlin
424
- class UserServiceTest : FunSpec(), KoinTest {
425
- override fun extensions() = listOf(KoinExtension(testModule))
426
-
427
- private val testModule = module {
428
- single<UserRepository> { mockk() }
429
- single { UserService(get()) }
430
- }
431
-
432
- private val repository by inject<UserRepository>()
433
- private val service by inject<UserService>()
434
-
435
- init {
436
- test("getUser returns user") {
437
- coEvery { repository.findById("1") } returns testUser
438
- service.getById("1") shouldBe testUser
439
- }
440
- }
441
- }
442
- ```
443
-
444
- ## Request Validation
445
-
446
- ```kotlin
447
- // Validate request data in routes
448
- fun Route.userRoutes() {
449
- val userService by inject<UserService>()
450
-
451
- post("/users") {
452
- val request = call.receive<CreateUserRequest>()
453
-
454
- // Validate
455
- require(request.name.isNotBlank()) { "Name is required" }
456
- require(request.name.length <= 100) { "Name must be 100 characters or less" }
457
- require(request.email.matches(Regex(".+@.+\\..+"))) { "Invalid email format" }
458
-
459
- val user = userService.create(request)
460
- call.respond(HttpStatusCode.Created, ApiResponse.ok(user))
461
- }
462
- }
463
-
464
- // Or use a validation extension
465
- fun CreateUserRequest.validate() {
466
- require(name.isNotBlank()) { "Name is required" }
467
- require(name.length <= 100) { "Name must be 100 characters or less" }
468
- require(email.matches(Regex(".+@.+\\..+"))) { "Invalid email format" }
469
- }
470
- ```
471
-
472
- ## WebSockets
473
-
474
- ```kotlin
475
- fun Application.configureWebSockets() {
476
- install(WebSockets) {
477
- pingPeriod = 15.seconds
478
- timeout = 15.seconds
479
- maxFrameSize = 64 * 1024 // 64 KiB — increase only if your protocol requires larger frames
480
- masking = false // Server-to-client frames are unmasked per RFC 6455; client-to-server are always masked by Ktor
481
- }
482
- }
483
-
484
- fun Route.chatRoutes() {
485
- val connections = Collections.synchronizedSet<Connection>(LinkedHashSet())
486
-
487
- webSocket("/chat") {
488
- val thisConnection = Connection(this)
489
- connections += thisConnection
490
-
491
- try {
492
- send("Connected! Users online: ${connections.size}")
493
-
494
- for (frame in incoming) {
495
- frame as? Frame.Text ?: continue
496
- val text = frame.readText()
497
- val message = ChatMessage(thisConnection.name, text)
498
-
499
- // Snapshot under lock to avoid ConcurrentModificationException
500
- val snapshot = synchronized(connections) { connections.toList() }
501
- snapshot.forEach { conn ->
502
- conn.session.send(Json.encodeToString(message))
503
- }
504
- }
505
- } catch (e: Exception) {
506
- logger.error("WebSocket error", e)
507
- } finally {
508
- connections -= thisConnection
509
- }
510
- }
511
- }
512
-
513
- data class Connection(val session: DefaultWebSocketSession) {
514
- val name: String = "User-${counter.getAndIncrement()}"
515
-
516
- companion object {
517
- private val counter = AtomicInteger(0)
518
- }
519
- }
520
- ```
521
-
522
- ## testApplication Testing
523
-
524
- ### Basic Route Testing
525
-
526
- ```kotlin
527
- class UserRoutesTest : FunSpec({
528
- test("GET /users returns list of users") {
529
- testApplication {
530
- application {
531
- install(Koin) { modules(testModule) }
532
- configureSerialization()
533
- configureRouting()
534
- }
535
-
536
- val response = client.get("/users")
537
-
538
- response.status shouldBe HttpStatusCode.OK
539
- val body = response.body<ApiResponse<List<UserResponse>>>()
540
- body.success shouldBe true
541
- body.data.shouldNotBeNull().shouldNotBeEmpty()
542
- }
543
- }
544
-
545
- test("POST /users creates a user") {
546
- testApplication {
547
- application {
548
- install(Koin) { modules(testModule) }
549
- configureSerialization()
550
- configureStatusPages()
551
- configureRouting()
552
- }
553
-
554
- val client = createClient {
555
- install(io.ktor.client.plugins.contentnegotiation.ContentNegotiation) {
556
- json()
557
- }
558
- }
559
-
560
- val response = client.post("/users") {
561
- contentType(ContentType.Application.Json)
562
- setBody(CreateUserRequest("Alice", "alice@example.com"))
563
- }
564
-
565
- response.status shouldBe HttpStatusCode.Created
566
- }
567
- }
568
-
569
- test("GET /users/{id} returns 404 for unknown id") {
570
- testApplication {
571
- application {
572
- install(Koin) { modules(testModule) }
573
- configureSerialization()
574
- configureStatusPages()
575
- configureRouting()
576
- }
577
-
578
- val response = client.get("/users/unknown-id")
579
-
580
- response.status shouldBe HttpStatusCode.NotFound
581
- }
582
- }
583
- })
584
- ```
585
-
586
- ### Testing Authenticated Routes
587
-
588
- ```kotlin
589
- class AuthenticatedRoutesTest : FunSpec({
590
- test("protected route requires JWT") {
591
- testApplication {
592
- application {
593
- install(Koin) { modules(testModule) }
594
- configureSerialization()
595
- configureAuthentication()
596
- configureRouting()
597
- }
598
-
599
- val response = client.post("/users") {
600
- contentType(ContentType.Application.Json)
601
- setBody(CreateUserRequest("Alice", "alice@example.com"))
602
- }
603
-
604
- response.status shouldBe HttpStatusCode.Unauthorized
605
- }
606
- }
607
-
608
- test("protected route succeeds with valid JWT") {
609
- testApplication {
610
- application {
611
- install(Koin) { modules(testModule) }
612
- configureSerialization()
613
- configureAuthentication()
614
- configureRouting()
615
- }
616
-
617
- val token = generateTestJWT(userId = "test-user")
618
-
619
- val client = createClient {
620
- install(io.ktor.client.plugins.contentnegotiation.ContentNegotiation) { json() }
621
- }
622
-
623
- val response = client.post("/users") {
624
- contentType(ContentType.Application.Json)
625
- bearerAuth(token)
626
- setBody(CreateUserRequest("Alice", "alice@example.com"))
627
- }
628
-
629
- response.status shouldBe HttpStatusCode.Created
630
- }
631
- }
632
- })
633
- ```
634
-
635
- ## Configuration
636
-
637
- ### application.yaml
638
-
639
- ```yaml
640
- ktor:
641
- application:
642
- modules:
643
- - com.example.ApplicationKt.module
644
- deployment:
645
- port: 8080
646
-
647
- jwt:
648
- secret: ${JWT_SECRET}
649
- issuer: "https://example.com"
650
- audience: "https://example.com/api"
651
- realm: "example"
652
-
653
- database:
654
- url: ${DATABASE_URL}
655
- driver: "org.postgresql.Driver"
656
- maxPoolSize: 10
657
- ```
658
-
659
- ### Reading Config
660
-
661
- ```kotlin
662
- fun Application.configureDI() {
663
- val dbUrl = environment.config.property("database.url").getString()
664
- val dbDriver = environment.config.property("database.driver").getString()
665
- val maxPoolSize = environment.config.property("database.maxPoolSize").getString().toInt()
666
-
667
- install(Koin) {
668
- modules(module {
669
- single { DatabaseConfig(dbUrl, dbDriver, maxPoolSize) }
670
- single { DatabaseFactory.create(get()) }
671
- })
672
- }
673
- }
674
- ```
675
-
676
- ## Quick Reference: Ktor Patterns
677
-
678
- | Pattern | Description |
679
- |---------|-------------|
680
- | `route("/path") { get { } }` | Route grouping with DSL |
681
- | `call.receive<T>()` | Deserialize request body |
682
- | `call.respond(status, body)` | Send response with status |
683
- | `call.parameters["id"]` | Read path parameters |
684
- | `call.request.queryParameters["q"]` | Read query parameters |
685
- | `install(Plugin) { }` | Install and configure plugin |
686
- | `authenticate("name") { }` | Protect routes with auth |
687
- | `by inject<T>()` | Koin dependency injection |
688
- | `testApplication { }` | Integration testing |
689
-
690
- **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
+ metadata:
5
+ origin: ECC
6
+ ---
7
+
8
+ # Ktor Server Patterns
9
+
10
+ Comprehensive Ktor patterns for building robust, maintainable HTTP servers with Kotlin coroutines.
11
+
12
+ ## When to Activate
13
+
14
+ - Building Ktor HTTP servers
15
+ - Configuring Ktor plugins (Auth, CORS, ContentNegotiation, StatusPages)
16
+ - Implementing REST APIs with Ktor
17
+ - Setting up dependency injection with Koin
18
+ - Writing Ktor integration tests with testApplication
19
+ - Working with WebSockets in Ktor
20
+
21
+ ## Application Structure
22
+
23
+ ### Standard Ktor Project Layout
24
+
25
+ ```text
26
+ src/main/kotlin/
27
+ ├── com/example/
28
+ │ ├── Application.kt # Entry point, module configuration
29
+ │ ├── plugins/
30
+ │ │ ├── Routing.kt # Route definitions
31
+ │ │ ├── Serialization.kt # Content negotiation setup
32
+ │ │ ├── Authentication.kt # Auth configuration
33
+ │ │ ├── StatusPages.kt # Error handling
34
+ │ │ └── CORS.kt # CORS configuration
35
+ │ ├── routes/
36
+ │ │ ├── UserRoutes.kt # /users endpoints
37
+ │ │ ├── AuthRoutes.kt # /auth endpoints
38
+ │ │ └── HealthRoutes.kt # /health endpoints
39
+ │ ├── models/
40
+ │ │ ├── User.kt # Domain models
41
+ │ │ └── ApiResponse.kt # Response envelopes
42
+ │ ├── services/
43
+ │ │ ├── UserService.kt # Business logic
44
+ │ │ └── AuthService.kt # Auth logic
45
+ │ ├── repositories/
46
+ │ │ ├── UserRepository.kt # Data access interface
47
+ │ │ └── ExposedUserRepository.kt
48
+ │ └── di/
49
+ │ └── AppModule.kt # Koin modules
50
+ src/test/kotlin/
51
+ ├── com/example/
52
+ │ ├── routes/
53
+ │ │ └── UserRoutesTest.kt
54
+ │ └── services/
55
+ │ └── UserServiceTest.kt
56
+ ```
57
+
58
+ ### Application Entry Point
59
+
60
+ ```kotlin
61
+ // Application.kt
62
+ fun main() {
63
+ embeddedServer(Netty, port = 8080, module = Application::module).start(wait = true)
64
+ }
65
+
66
+ fun Application.module() {
67
+ configureSerialization()
68
+ configureAuthentication()
69
+ configureStatusPages()
70
+ configureCORS()
71
+ configureDI()
72
+ configureRouting()
73
+ }
74
+ ```
75
+
76
+ ## Routing DSL
77
+
78
+ ### Basic Routes
79
+
80
+ ```kotlin
81
+ // plugins/Routing.kt
82
+ fun Application.configureRouting() {
83
+ routing {
84
+ userRoutes()
85
+ authRoutes()
86
+ healthRoutes()
87
+ }
88
+ }
89
+
90
+ // routes/UserRoutes.kt
91
+ fun Route.userRoutes() {
92
+ val userService by inject<UserService>()
93
+
94
+ route("/users") {
95
+ get {
96
+ val users = userService.getAll()
97
+ call.respond(users)
98
+ }
99
+
100
+ get("/{id}") {
101
+ val id = call.parameters["id"]
102
+ ?: return@get call.respond(HttpStatusCode.BadRequest, "Missing id")
103
+ val user = userService.getById(id)
104
+ ?: return@get call.respond(HttpStatusCode.NotFound)
105
+ call.respond(user)
106
+ }
107
+
108
+ post {
109
+ val request = call.receive<CreateUserRequest>()
110
+ val user = userService.create(request)
111
+ call.respond(HttpStatusCode.Created, user)
112
+ }
113
+
114
+ put("/{id}") {
115
+ val id = call.parameters["id"]
116
+ ?: return@put call.respond(HttpStatusCode.BadRequest, "Missing id")
117
+ val request = call.receive<UpdateUserRequest>()
118
+ val user = userService.update(id, request)
119
+ ?: return@put call.respond(HttpStatusCode.NotFound)
120
+ call.respond(user)
121
+ }
122
+
123
+ delete("/{id}") {
124
+ val id = call.parameters["id"]
125
+ ?: return@delete call.respond(HttpStatusCode.BadRequest, "Missing id")
126
+ val deleted = userService.delete(id)
127
+ if (deleted) call.respond(HttpStatusCode.NoContent)
128
+ else call.respond(HttpStatusCode.NotFound)
129
+ }
130
+ }
131
+ }
132
+ ```
133
+
134
+ ### Route Organization with Authenticated Routes
135
+
136
+ ```kotlin
137
+ fun Route.userRoutes() {
138
+ route("/users") {
139
+ // Public routes
140
+ get { /* list users */ }
141
+ get("/{id}") { /* get user */ }
142
+
143
+ // Protected routes
144
+ authenticate("jwt") {
145
+ post { /* create user - requires auth */ }
146
+ put("/{id}") { /* update user - requires auth */ }
147
+ delete("/{id}") { /* delete user - requires auth */ }
148
+ }
149
+ }
150
+ }
151
+ ```
152
+
153
+ ## Content Negotiation & Serialization
154
+
155
+ ### kotlinx.serialization Setup
156
+
157
+ ```kotlin
158
+ // plugins/Serialization.kt
159
+ fun Application.configureSerialization() {
160
+ install(ContentNegotiation) {
161
+ json(Json {
162
+ prettyPrint = true
163
+ isLenient = false
164
+ ignoreUnknownKeys = true
165
+ encodeDefaults = true
166
+ explicitNulls = false
167
+ })
168
+ }
169
+ }
170
+ ```
171
+
172
+ ### Serializable Models
173
+
174
+ ```kotlin
175
+ @Serializable
176
+ data class UserResponse(
177
+ val id: String,
178
+ val name: String,
179
+ val email: String,
180
+ val role: Role,
181
+ @Serializable(with = InstantSerializer::class)
182
+ val createdAt: Instant,
183
+ )
184
+
185
+ @Serializable
186
+ data class CreateUserRequest(
187
+ val name: String,
188
+ val email: String,
189
+ val role: Role = Role.USER,
190
+ )
191
+
192
+ @Serializable
193
+ data class ApiResponse<T>(
194
+ val success: Boolean,
195
+ val data: T? = null,
196
+ val error: String? = null,
197
+ ) {
198
+ companion object {
199
+ fun <T> ok(data: T): ApiResponse<T> = ApiResponse(success = true, data = data)
200
+ fun <T> error(message: String): ApiResponse<T> = ApiResponse(success = false, error = message)
201
+ }
202
+ }
203
+
204
+ @Serializable
205
+ data class PaginatedResponse<T>(
206
+ val data: List<T>,
207
+ val total: Long,
208
+ val page: Int,
209
+ val limit: Int,
210
+ )
211
+ ```
212
+
213
+ ### Custom Serializers
214
+
215
+ ```kotlin
216
+ object InstantSerializer : KSerializer<Instant> {
217
+ override val descriptor = PrimitiveSerialDescriptor("Instant", PrimitiveKind.STRING)
218
+ override fun serialize(encoder: Encoder, value: Instant) =
219
+ encoder.encodeString(value.toString())
220
+ override fun deserialize(decoder: Decoder): Instant =
221
+ Instant.parse(decoder.decodeString())
222
+ }
223
+ ```
224
+
225
+ ## Authentication
226
+
227
+ ### JWT Authentication
228
+
229
+ ```kotlin
230
+ // plugins/Authentication.kt
231
+ fun Application.configureAuthentication() {
232
+ val jwtSecret = environment.config.property("jwt.secret").getString()
233
+ val jwtIssuer = environment.config.property("jwt.issuer").getString()
234
+ val jwtAudience = environment.config.property("jwt.audience").getString()
235
+ val jwtRealm = environment.config.property("jwt.realm").getString()
236
+
237
+ install(Authentication) {
238
+ jwt("jwt") {
239
+ realm = jwtRealm
240
+ verifier(
241
+ JWT.require(Algorithm.HMAC256(jwtSecret))
242
+ .withAudience(jwtAudience)
243
+ .withIssuer(jwtIssuer)
244
+ .build()
245
+ )
246
+ validate { credential ->
247
+ if (credential.payload.audience.contains(jwtAudience)) {
248
+ JWTPrincipal(credential.payload)
249
+ } else {
250
+ null
251
+ }
252
+ }
253
+ challenge { _, _ ->
254
+ call.respond(HttpStatusCode.Unauthorized, ApiResponse.error<Unit>("Invalid or expired token"))
255
+ }
256
+ }
257
+ }
258
+ }
259
+
260
+ // Extracting user from JWT
261
+ fun ApplicationCall.userId(): String =
262
+ principal<JWTPrincipal>()
263
+ ?.payload
264
+ ?.getClaim("userId")
265
+ ?.asString()
266
+ ?: throw AuthenticationException("No userId in token")
267
+ ```
268
+
269
+ ### Auth Routes
270
+
271
+ ```kotlin
272
+ fun Route.authRoutes() {
273
+ val authService by inject<AuthService>()
274
+
275
+ route("/auth") {
276
+ post("/login") {
277
+ val request = call.receive<LoginRequest>()
278
+ val token = authService.login(request.email, request.password)
279
+ ?: return@post call.respond(
280
+ HttpStatusCode.Unauthorized,
281
+ ApiResponse.error<Unit>("Invalid credentials"),
282
+ )
283
+ call.respond(ApiResponse.ok(TokenResponse(token)))
284
+ }
285
+
286
+ post("/register") {
287
+ val request = call.receive<RegisterRequest>()
288
+ val user = authService.register(request)
289
+ call.respond(HttpStatusCode.Created, ApiResponse.ok(user))
290
+ }
291
+
292
+ authenticate("jwt") {
293
+ get("/me") {
294
+ val userId = call.userId()
295
+ val user = authService.getProfile(userId)
296
+ call.respond(ApiResponse.ok(user))
297
+ }
298
+ }
299
+ }
300
+ }
301
+ ```
302
+
303
+ ## Status Pages (Error Handling)
304
+
305
+ ```kotlin
306
+ // plugins/StatusPages.kt
307
+ fun Application.configureStatusPages() {
308
+ install(StatusPages) {
309
+ exception<ContentTransformationException> { call, cause ->
310
+ call.respond(
311
+ HttpStatusCode.BadRequest,
312
+ ApiResponse.error<Unit>("Invalid request body: ${cause.message}"),
313
+ )
314
+ }
315
+
316
+ exception<IllegalArgumentException> { call, cause ->
317
+ call.respond(
318
+ HttpStatusCode.BadRequest,
319
+ ApiResponse.error<Unit>(cause.message ?: "Bad request"),
320
+ )
321
+ }
322
+
323
+ exception<AuthenticationException> { call, _ ->
324
+ call.respond(
325
+ HttpStatusCode.Unauthorized,
326
+ ApiResponse.error<Unit>("Authentication required"),
327
+ )
328
+ }
329
+
330
+ exception<AuthorizationException> { call, _ ->
331
+ call.respond(
332
+ HttpStatusCode.Forbidden,
333
+ ApiResponse.error<Unit>("Access denied"),
334
+ )
335
+ }
336
+
337
+ exception<NotFoundException> { call, cause ->
338
+ call.respond(
339
+ HttpStatusCode.NotFound,
340
+ ApiResponse.error<Unit>(cause.message ?: "Resource not found"),
341
+ )
342
+ }
343
+
344
+ exception<Throwable> { call, cause ->
345
+ call.application.log.error("Unhandled exception", cause)
346
+ call.respond(
347
+ HttpStatusCode.InternalServerError,
348
+ ApiResponse.error<Unit>("Internal server error"),
349
+ )
350
+ }
351
+
352
+ status(HttpStatusCode.NotFound) { call, status ->
353
+ call.respond(status, ApiResponse.error<Unit>("Route not found"))
354
+ }
355
+ }
356
+ }
357
+ ```
358
+
359
+ ## CORS Configuration
360
+
361
+ ```kotlin
362
+ // plugins/CORS.kt
363
+ fun Application.configureCORS() {
364
+ install(CORS) {
365
+ allowHost("localhost:3000")
366
+ allowHost("example.com", schemes = listOf("https"))
367
+ allowHeader(HttpHeaders.ContentType)
368
+ allowHeader(HttpHeaders.Authorization)
369
+ allowMethod(HttpMethod.Put)
370
+ allowMethod(HttpMethod.Delete)
371
+ allowMethod(HttpMethod.Patch)
372
+ allowCredentials = true
373
+ maxAgeInSeconds = 3600
374
+ }
375
+ }
376
+ ```
377
+
378
+ ## Koin Dependency Injection
379
+
380
+ ### Module Definition
381
+
382
+ ```kotlin
383
+ // di/AppModule.kt
384
+ val appModule = module {
385
+ // Database
386
+ single<Database> { DatabaseFactory.create(get()) }
387
+
388
+ // Repositories
389
+ single<UserRepository> { ExposedUserRepository(get()) }
390
+ single<OrderRepository> { ExposedOrderRepository(get()) }
391
+
392
+ // Services
393
+ single { UserService(get()) }
394
+ single { OrderService(get(), get()) }
395
+ single { AuthService(get(), get()) }
396
+ }
397
+
398
+ // Application setup
399
+ fun Application.configureDI() {
400
+ install(Koin) {
401
+ modules(appModule)
402
+ }
403
+ }
404
+ ```
405
+
406
+ ### Using Koin in Routes
407
+
408
+ ```kotlin
409
+ fun Route.userRoutes() {
410
+ val userService by inject<UserService>()
411
+
412
+ route("/users") {
413
+ get {
414
+ val users = userService.getAll()
415
+ call.respond(ApiResponse.ok(users))
416
+ }
417
+ }
418
+ }
419
+ ```
420
+
421
+ ### Koin for Testing
422
+
423
+ ```kotlin
424
+ class UserServiceTest : FunSpec(), KoinTest {
425
+ override fun extensions() = listOf(KoinExtension(testModule))
426
+
427
+ private val testModule = module {
428
+ single<UserRepository> { mockk() }
429
+ single { UserService(get()) }
430
+ }
431
+
432
+ private val repository by inject<UserRepository>()
433
+ private val service by inject<UserService>()
434
+
435
+ init {
436
+ test("getUser returns user") {
437
+ coEvery { repository.findById("1") } returns testUser
438
+ service.getById("1") shouldBe testUser
439
+ }
440
+ }
441
+ }
442
+ ```
443
+
444
+ ## Request Validation
445
+
446
+ ```kotlin
447
+ // Validate request data in routes
448
+ fun Route.userRoutes() {
449
+ val userService by inject<UserService>()
450
+
451
+ post("/users") {
452
+ val request = call.receive<CreateUserRequest>()
453
+
454
+ // Validate
455
+ require(request.name.isNotBlank()) { "Name is required" }
456
+ require(request.name.length <= 100) { "Name must be 100 characters or less" }
457
+ require(request.email.matches(Regex(".+@.+\\..+"))) { "Invalid email format" }
458
+
459
+ val user = userService.create(request)
460
+ call.respond(HttpStatusCode.Created, ApiResponse.ok(user))
461
+ }
462
+ }
463
+
464
+ // Or use a validation extension
465
+ fun CreateUserRequest.validate() {
466
+ require(name.isNotBlank()) { "Name is required" }
467
+ require(name.length <= 100) { "Name must be 100 characters or less" }
468
+ require(email.matches(Regex(".+@.+\\..+"))) { "Invalid email format" }
469
+ }
470
+ ```
471
+
472
+ ## WebSockets
473
+
474
+ ```kotlin
475
+ fun Application.configureWebSockets() {
476
+ install(WebSockets) {
477
+ pingPeriod = 15.seconds
478
+ timeout = 15.seconds
479
+ maxFrameSize = 64 * 1024 // 64 KiB — increase only if your protocol requires larger frames
480
+ masking = false // Server-to-client frames are unmasked per RFC 6455; client-to-server are always masked by Ktor
481
+ }
482
+ }
483
+
484
+ fun Route.chatRoutes() {
485
+ val connections = Collections.synchronizedSet<Connection>(LinkedHashSet())
486
+
487
+ webSocket("/chat") {
488
+ val thisConnection = Connection(this)
489
+ connections += thisConnection
490
+
491
+ try {
492
+ send("Connected! Users online: ${connections.size}")
493
+
494
+ for (frame in incoming) {
495
+ frame as? Frame.Text ?: continue
496
+ val text = frame.readText()
497
+ val message = ChatMessage(thisConnection.name, text)
498
+
499
+ // Snapshot under lock to avoid ConcurrentModificationException
500
+ val snapshot = synchronized(connections) { connections.toList() }
501
+ snapshot.forEach { conn ->
502
+ conn.session.send(Json.encodeToString(message))
503
+ }
504
+ }
505
+ } catch (e: Exception) {
506
+ logger.error("WebSocket error", e)
507
+ } finally {
508
+ connections -= thisConnection
509
+ }
510
+ }
511
+ }
512
+
513
+ data class Connection(val session: DefaultWebSocketSession) {
514
+ val name: String = "User-${counter.getAndIncrement()}"
515
+
516
+ companion object {
517
+ private val counter = AtomicInteger(0)
518
+ }
519
+ }
520
+ ```
521
+
522
+ ## testApplication Testing
523
+
524
+ ### Basic Route Testing
525
+
526
+ ```kotlin
527
+ class UserRoutesTest : FunSpec({
528
+ test("GET /users returns list of users") {
529
+ testApplication {
530
+ application {
531
+ install(Koin) { modules(testModule) }
532
+ configureSerialization()
533
+ configureRouting()
534
+ }
535
+
536
+ val response = client.get("/users")
537
+
538
+ response.status shouldBe HttpStatusCode.OK
539
+ val body = response.body<ApiResponse<List<UserResponse>>>()
540
+ body.success shouldBe true
541
+ body.data.shouldNotBeNull().shouldNotBeEmpty()
542
+ }
543
+ }
544
+
545
+ test("POST /users creates a user") {
546
+ testApplication {
547
+ application {
548
+ install(Koin) { modules(testModule) }
549
+ configureSerialization()
550
+ configureStatusPages()
551
+ configureRouting()
552
+ }
553
+
554
+ val client = createClient {
555
+ install(io.ktor.client.plugins.contentnegotiation.ContentNegotiation) {
556
+ json()
557
+ }
558
+ }
559
+
560
+ val response = client.post("/users") {
561
+ contentType(ContentType.Application.Json)
562
+ setBody(CreateUserRequest("Alice", "alice@example.com"))
563
+ }
564
+
565
+ response.status shouldBe HttpStatusCode.Created
566
+ }
567
+ }
568
+
569
+ test("GET /users/{id} returns 404 for unknown id") {
570
+ testApplication {
571
+ application {
572
+ install(Koin) { modules(testModule) }
573
+ configureSerialization()
574
+ configureStatusPages()
575
+ configureRouting()
576
+ }
577
+
578
+ val response = client.get("/users/unknown-id")
579
+
580
+ response.status shouldBe HttpStatusCode.NotFound
581
+ }
582
+ }
583
+ })
584
+ ```
585
+
586
+ ### Testing Authenticated Routes
587
+
588
+ ```kotlin
589
+ class AuthenticatedRoutesTest : FunSpec({
590
+ test("protected route requires JWT") {
591
+ testApplication {
592
+ application {
593
+ install(Koin) { modules(testModule) }
594
+ configureSerialization()
595
+ configureAuthentication()
596
+ configureRouting()
597
+ }
598
+
599
+ val response = client.post("/users") {
600
+ contentType(ContentType.Application.Json)
601
+ setBody(CreateUserRequest("Alice", "alice@example.com"))
602
+ }
603
+
604
+ response.status shouldBe HttpStatusCode.Unauthorized
605
+ }
606
+ }
607
+
608
+ test("protected route succeeds with valid JWT") {
609
+ testApplication {
610
+ application {
611
+ install(Koin) { modules(testModule) }
612
+ configureSerialization()
613
+ configureAuthentication()
614
+ configureRouting()
615
+ }
616
+
617
+ val token = generateTestJWT(userId = "test-user")
618
+
619
+ val client = createClient {
620
+ install(io.ktor.client.plugins.contentnegotiation.ContentNegotiation) { json() }
621
+ }
622
+
623
+ val response = client.post("/users") {
624
+ contentType(ContentType.Application.Json)
625
+ bearerAuth(token)
626
+ setBody(CreateUserRequest("Alice", "alice@example.com"))
627
+ }
628
+
629
+ response.status shouldBe HttpStatusCode.Created
630
+ }
631
+ }
632
+ })
633
+ ```
634
+
635
+ ## Configuration
636
+
637
+ ### application.yaml
638
+
639
+ ```yaml
640
+ ktor:
641
+ application:
642
+ modules:
643
+ - com.example.ApplicationKt.module
644
+ deployment:
645
+ port: 8080
646
+
647
+ jwt:
648
+ secret: ${JWT_SECRET}
649
+ issuer: "https://example.com"
650
+ audience: "https://example.com/api"
651
+ realm: "example"
652
+
653
+ database:
654
+ url: ${DATABASE_URL}
655
+ driver: "org.postgresql.Driver"
656
+ maxPoolSize: 10
657
+ ```
658
+
659
+ ### Reading Config
660
+
661
+ ```kotlin
662
+ fun Application.configureDI() {
663
+ val dbUrl = environment.config.property("database.url").getString()
664
+ val dbDriver = environment.config.property("database.driver").getString()
665
+ val maxPoolSize = environment.config.property("database.maxPoolSize").getString().toInt()
666
+
667
+ install(Koin) {
668
+ modules(module {
669
+ single { DatabaseConfig(dbUrl, dbDriver, maxPoolSize) }
670
+ single { DatabaseFactory.create(get()) }
671
+ })
672
+ }
673
+ }
674
+ ```
675
+
676
+ ## Quick Reference: Ktor Patterns
677
+
678
+ | Pattern | Description |
679
+ |---------|-------------|
680
+ | `route("/path") { get { } }` | Route grouping with DSL |
681
+ | `call.receive<T>()` | Deserialize request body |
682
+ | `call.respond(status, body)` | Send response with status |
683
+ | `call.parameters["id"]` | Read path parameters |
684
+ | `call.request.queryParameters["q"]` | Read query parameters |
685
+ | `install(Plugin) { }` | Install and configure plugin |
686
+ | `authenticate("name") { }` | Protect routes with auth |
687
+ | `by inject<T>()` | Koin dependency injection |
688
+ | `testApplication { }` | Integration testing |
689
+
690
+ **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.