codeply-cli 0.5.0 → 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 +493 -16
  12. package/lib/chatgpt.js +282 -0
  13. package/lib/cloud-browser.mjs +143 -143
  14. package/lib/cloud.mjs +1186 -1105
  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,720 +1,720 @@
1
- ---
2
- name: kotlin-exposed-patterns
3
- description: JetBrains Exposed ORM patterns including DSL queries, DAO pattern, transactions, HikariCP connection pooling, Flyway migrations, and repository pattern.
4
- metadata:
5
- origin: ECC
6
- ---
7
-
8
- # Kotlin Exposed Patterns
9
-
10
- Comprehensive patterns for database access with JetBrains Exposed ORM, including DSL queries, DAO, transactions, and production-ready configuration.
11
-
12
- ## When to Use
13
-
14
- - Setting up database access with Exposed
15
- - Writing SQL queries using Exposed DSL or DAO
16
- - Configuring connection pooling with HikariCP
17
- - Creating database migrations with Flyway
18
- - Implementing the repository pattern with Exposed
19
- - Handling JSON columns and complex queries
20
-
21
- ## How It Works
22
-
23
- Exposed provides two query styles: DSL for direct SQL-like expressions and DAO for entity lifecycle management. HikariCP manages a pool of reusable database connections configured via `HikariConfig`. Flyway runs versioned SQL migration scripts at startup to keep the schema in sync. All database operations run inside `newSuspendedTransaction` blocks for coroutine safety and atomicity. The repository pattern wraps Exposed queries behind an interface so business logic stays decoupled from the data layer and tests can use an in-memory H2 database.
24
-
25
- ## Examples
26
-
27
- ### DSL Query
28
-
29
- ```kotlin
30
- suspend fun findUserById(id: UUID): UserRow? =
31
- newSuspendedTransaction {
32
- UsersTable.selectAll()
33
- .where { UsersTable.id eq id }
34
- .map { it.toUser() }
35
- .singleOrNull()
36
- }
37
- ```
38
-
39
- ### DAO Entity Usage
40
-
41
- ```kotlin
42
- suspend fun createUser(request: CreateUserRequest): User =
43
- newSuspendedTransaction {
44
- UserEntity.new {
45
- name = request.name
46
- email = request.email
47
- role = request.role
48
- }.toModel()
49
- }
50
- ```
51
-
52
- ### HikariCP Configuration
53
-
54
- ```kotlin
55
- val hikariConfig = HikariConfig().apply {
56
- driverClassName = config.driver
57
- jdbcUrl = config.url
58
- username = config.username
59
- password = config.password
60
- maximumPoolSize = config.maxPoolSize
61
- isAutoCommit = false
62
- transactionIsolation = "TRANSACTION_READ_COMMITTED"
63
- validate()
64
- }
65
- ```
66
-
67
- ## Database Setup
68
-
69
- ### HikariCP Connection Pooling
70
-
71
- ```kotlin
72
- // DatabaseFactory.kt
73
- object DatabaseFactory {
74
- fun create(config: DatabaseConfig): Database {
75
- val hikariConfig = HikariConfig().apply {
76
- driverClassName = config.driver
77
- jdbcUrl = config.url
78
- username = config.username
79
- password = config.password
80
- maximumPoolSize = config.maxPoolSize
81
- isAutoCommit = false
82
- transactionIsolation = "TRANSACTION_READ_COMMITTED"
83
- validate()
84
- }
85
-
86
- return Database.connect(HikariDataSource(hikariConfig))
87
- }
88
- }
89
-
90
- data class DatabaseConfig(
91
- val url: String,
92
- val driver: String = "org.postgresql.Driver",
93
- val username: String = "",
94
- val password: String = "",
95
- val maxPoolSize: Int = 10,
96
- )
97
- ```
98
-
99
- ### Flyway Migrations
100
-
101
- ```kotlin
102
- // FlywayMigration.kt
103
- fun runMigrations(config: DatabaseConfig) {
104
- Flyway.configure()
105
- .dataSource(config.url, config.username, config.password)
106
- .locations("classpath:db/migration")
107
- .baselineOnMigrate(true)
108
- .load()
109
- .migrate()
110
- }
111
-
112
- // Application startup
113
- fun Application.module() {
114
- val config = DatabaseConfig(
115
- url = environment.config.property("database.url").getString(),
116
- username = environment.config.property("database.username").getString(),
117
- password = environment.config.property("database.password").getString(),
118
- )
119
- runMigrations(config)
120
- val database = DatabaseFactory.create(config)
121
- // ...
122
- }
123
- ```
124
-
125
- ### Migration Files
126
-
127
- ```sql
128
- -- src/main/resources/db/migration/V1__create_users.sql
129
- CREATE TABLE users (
130
- id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
131
- name VARCHAR(100) NOT NULL,
132
- email VARCHAR(255) NOT NULL UNIQUE,
133
- role VARCHAR(20) NOT NULL DEFAULT 'USER',
134
- metadata JSONB,
135
- created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
136
- updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW()
137
- );
138
-
139
- CREATE INDEX idx_users_email ON users(email);
140
- CREATE INDEX idx_users_role ON users(role);
141
- ```
142
-
143
- ## Table Definitions
144
-
145
- ### DSL Style Tables
146
-
147
- ```kotlin
148
- // tables/UsersTable.kt
149
- object UsersTable : UUIDTable("users") {
150
- val name = varchar("name", 100)
151
- val email = varchar("email", 255).uniqueIndex()
152
- val role = enumerationByName<Role>("role", 20)
153
- val metadata = jsonb<UserMetadata>("metadata", Json.Default).nullable()
154
- val createdAt = timestampWithTimeZone("created_at").defaultExpression(CurrentTimestampWithTimeZone)
155
- val updatedAt = timestampWithTimeZone("updated_at").defaultExpression(CurrentTimestampWithTimeZone)
156
- }
157
-
158
- object OrdersTable : UUIDTable("orders") {
159
- val userId = uuid("user_id").references(UsersTable.id)
160
- val status = enumerationByName<OrderStatus>("status", 20)
161
- val totalAmount = long("total_amount")
162
- val currency = varchar("currency", 3)
163
- val createdAt = timestampWithTimeZone("created_at").defaultExpression(CurrentTimestampWithTimeZone)
164
- }
165
-
166
- object OrderItemsTable : UUIDTable("order_items") {
167
- val orderId = uuid("order_id").references(OrdersTable.id, onDelete = ReferenceOption.CASCADE)
168
- val productId = uuid("product_id")
169
- val quantity = integer("quantity")
170
- val unitPrice = long("unit_price")
171
- }
172
- ```
173
-
174
- ### Composite Tables
175
-
176
- ```kotlin
177
- object UserRolesTable : Table("user_roles") {
178
- val userId = uuid("user_id").references(UsersTable.id, onDelete = ReferenceOption.CASCADE)
179
- val roleId = uuid("role_id").references(RolesTable.id, onDelete = ReferenceOption.CASCADE)
180
- override val primaryKey = PrimaryKey(userId, roleId)
181
- }
182
- ```
183
-
184
- ## DSL Queries
185
-
186
- ### Basic CRUD
187
-
188
- ```kotlin
189
- // Insert
190
- suspend fun insertUser(name: String, email: String, role: Role): UUID =
191
- newSuspendedTransaction {
192
- UsersTable.insertAndGetId {
193
- it[UsersTable.name] = name
194
- it[UsersTable.email] = email
195
- it[UsersTable.role] = role
196
- }.value
197
- }
198
-
199
- // Select by ID
200
- suspend fun findUserById(id: UUID): UserRow? =
201
- newSuspendedTransaction {
202
- UsersTable.selectAll()
203
- .where { UsersTable.id eq id }
204
- .map { it.toUser() }
205
- .singleOrNull()
206
- }
207
-
208
- // Select with conditions
209
- suspend fun findActiveAdmins(): List<UserRow> =
210
- newSuspendedTransaction {
211
- UsersTable.selectAll()
212
- .where { (UsersTable.role eq Role.ADMIN) }
213
- .orderBy(UsersTable.name)
214
- .map { it.toUser() }
215
- }
216
-
217
- // Update
218
- suspend fun updateUserEmail(id: UUID, newEmail: String): Boolean =
219
- newSuspendedTransaction {
220
- UsersTable.update({ UsersTable.id eq id }) {
221
- it[email] = newEmail
222
- it[updatedAt] = CurrentTimestampWithTimeZone
223
- } > 0
224
- }
225
-
226
- // Delete
227
- suspend fun deleteUser(id: UUID): Boolean =
228
- newSuspendedTransaction {
229
- UsersTable.deleteWhere { UsersTable.id eq id } > 0
230
- }
231
-
232
- // Row mapping
233
- private fun ResultRow.toUser() = UserRow(
234
- id = this[UsersTable.id].value,
235
- name = this[UsersTable.name],
236
- email = this[UsersTable.email],
237
- role = this[UsersTable.role],
238
- metadata = this[UsersTable.metadata],
239
- createdAt = this[UsersTable.createdAt],
240
- updatedAt = this[UsersTable.updatedAt],
241
- )
242
- ```
243
-
244
- ### Advanced Queries
245
-
246
- ```kotlin
247
- // Join queries
248
- suspend fun findOrdersWithUser(userId: UUID): List<OrderWithUser> =
249
- newSuspendedTransaction {
250
- (OrdersTable innerJoin UsersTable)
251
- .selectAll()
252
- .where { OrdersTable.userId eq userId }
253
- .orderBy(OrdersTable.createdAt, SortOrder.DESC)
254
- .map { row ->
255
- OrderWithUser(
256
- orderId = row[OrdersTable.id].value,
257
- status = row[OrdersTable.status],
258
- totalAmount = row[OrdersTable.totalAmount],
259
- userName = row[UsersTable.name],
260
- )
261
- }
262
- }
263
-
264
- // Aggregation
265
- suspend fun countUsersByRole(): Map<Role, Long> =
266
- newSuspendedTransaction {
267
- UsersTable
268
- .select(UsersTable.role, UsersTable.id.count())
269
- .groupBy(UsersTable.role)
270
- .associate { row ->
271
- row[UsersTable.role] to row[UsersTable.id.count()]
272
- }
273
- }
274
-
275
- // Subqueries
276
- suspend fun findUsersWithOrders(): List<UserRow> =
277
- newSuspendedTransaction {
278
- UsersTable.selectAll()
279
- .where {
280
- UsersTable.id inSubQuery
281
- OrdersTable.select(OrdersTable.userId).withDistinct()
282
- }
283
- .map { it.toUser() }
284
- }
285
-
286
- // LIKE and pattern matching — always escape user input to prevent wildcard injection
287
- private fun escapeLikePattern(input: String): String =
288
- input.replace("\\", "\\\\").replace("%", "\\%").replace("_", "\\_")
289
-
290
- suspend fun searchUsers(query: String): List<UserRow> =
291
- newSuspendedTransaction {
292
- val sanitized = escapeLikePattern(query.lowercase())
293
- UsersTable.selectAll()
294
- .where {
295
- (UsersTable.name.lowerCase() like "%${sanitized}%") or
296
- (UsersTable.email.lowerCase() like "%${sanitized}%")
297
- }
298
- .map { it.toUser() }
299
- }
300
- ```
301
-
302
- ### Pagination
303
-
304
- ```kotlin
305
- data class Page<T>(
306
- val data: List<T>,
307
- val total: Long,
308
- val page: Int,
309
- val limit: Int,
310
- ) {
311
- val totalPages: Int get() = ((total + limit - 1) / limit).toInt()
312
- val hasNext: Boolean get() = page < totalPages
313
- val hasPrevious: Boolean get() = page > 1
314
- }
315
-
316
- suspend fun findUsersPaginated(page: Int, limit: Int): Page<UserRow> =
317
- newSuspendedTransaction {
318
- val total = UsersTable.selectAll().count()
319
- val data = UsersTable.selectAll()
320
- .orderBy(UsersTable.createdAt, SortOrder.DESC)
321
- .limit(limit)
322
- .offset(((page - 1) * limit).toLong())
323
- .map { it.toUser() }
324
-
325
- Page(data = data, total = total, page = page, limit = limit)
326
- }
327
- ```
328
-
329
- ### Batch Operations
330
-
331
- ```kotlin
332
- // Batch insert
333
- suspend fun insertUsers(users: List<CreateUserRequest>): List<UUID> =
334
- newSuspendedTransaction {
335
- UsersTable.batchInsert(users) { user ->
336
- this[UsersTable.name] = user.name
337
- this[UsersTable.email] = user.email
338
- this[UsersTable.role] = user.role
339
- }.map { it[UsersTable.id].value }
340
- }
341
-
342
- // Upsert (insert or update on conflict)
343
- suspend fun upsertUser(id: UUID, name: String, email: String) {
344
- newSuspendedTransaction {
345
- UsersTable.upsert(UsersTable.email) {
346
- it[UsersTable.id] = EntityID(id, UsersTable)
347
- it[UsersTable.name] = name
348
- it[UsersTable.email] = email
349
- it[updatedAt] = CurrentTimestampWithTimeZone
350
- }
351
- }
352
- }
353
- ```
354
-
355
- ## DAO Pattern
356
-
357
- ### Entity Definitions
358
-
359
- ```kotlin
360
- // entities/UserEntity.kt
361
- class UserEntity(id: EntityID<UUID>) : UUIDEntity(id) {
362
- companion object : UUIDEntityClass<UserEntity>(UsersTable)
363
-
364
- var name by UsersTable.name
365
- var email by UsersTable.email
366
- var role by UsersTable.role
367
- var metadata by UsersTable.metadata
368
- var createdAt by UsersTable.createdAt
369
- var updatedAt by UsersTable.updatedAt
370
-
371
- val orders by OrderEntity referrersOn OrdersTable.userId
372
-
373
- fun toModel(): User = User(
374
- id = id.value,
375
- name = name,
376
- email = email,
377
- role = role,
378
- metadata = metadata,
379
- createdAt = createdAt,
380
- updatedAt = updatedAt,
381
- )
382
- }
383
-
384
- class OrderEntity(id: EntityID<UUID>) : UUIDEntity(id) {
385
- companion object : UUIDEntityClass<OrderEntity>(OrdersTable)
386
-
387
- var user by UserEntity referencedOn OrdersTable.userId
388
- var status by OrdersTable.status
389
- var totalAmount by OrdersTable.totalAmount
390
- var currency by OrdersTable.currency
391
- var createdAt by OrdersTable.createdAt
392
-
393
- val items by OrderItemEntity referrersOn OrderItemsTable.orderId
394
- }
395
- ```
396
-
397
- ### DAO Operations
398
-
399
- ```kotlin
400
- suspend fun findUserByEmail(email: String): User? =
401
- newSuspendedTransaction {
402
- UserEntity.find { UsersTable.email eq email }
403
- .firstOrNull()
404
- ?.toModel()
405
- }
406
-
407
- suspend fun createUser(request: CreateUserRequest): User =
408
- newSuspendedTransaction {
409
- UserEntity.new {
410
- name = request.name
411
- email = request.email
412
- role = request.role
413
- }.toModel()
414
- }
415
-
416
- suspend fun updateUser(id: UUID, request: UpdateUserRequest): User? =
417
- newSuspendedTransaction {
418
- UserEntity.findById(id)?.apply {
419
- request.name?.let { name = it }
420
- request.email?.let { email = it }
421
- updatedAt = OffsetDateTime.now(ZoneOffset.UTC)
422
- }?.toModel()
423
- }
424
- ```
425
-
426
- ## Transactions
427
-
428
- ### Suspend Transaction Support
429
-
430
- ```kotlin
431
- // Good: Use newSuspendedTransaction for coroutine support
432
- suspend fun performDatabaseOperation(): Result<User> =
433
- runCatching {
434
- newSuspendedTransaction {
435
- val user = UserEntity.new {
436
- name = "Alice"
437
- email = "alice@example.com"
438
- }
439
- // All operations in this block are atomic
440
- user.toModel()
441
- }
442
- }
443
-
444
- // Good: Nested transactions with savepoints
445
- suspend fun transferFunds(fromId: UUID, toId: UUID, amount: Long) {
446
- newSuspendedTransaction {
447
- val from = UserEntity.findById(fromId) ?: throw NotFoundException("User $fromId not found")
448
- val to = UserEntity.findById(toId) ?: throw NotFoundException("User $toId not found")
449
-
450
- // Debit
451
- from.balance -= amount
452
- // Credit
453
- to.balance += amount
454
-
455
- // Both succeed or both fail
456
- }
457
- }
458
- ```
459
-
460
- ### Transaction Isolation
461
-
462
- ```kotlin
463
- suspend fun readCommittedQuery(): List<User> =
464
- newSuspendedTransaction(transactionIsolation = Connection.TRANSACTION_READ_COMMITTED) {
465
- UserEntity.all().map { it.toModel() }
466
- }
467
-
468
- suspend fun serializableOperation() {
469
- newSuspendedTransaction(transactionIsolation = Connection.TRANSACTION_SERIALIZABLE) {
470
- // Strictest isolation level for critical operations
471
- }
472
- }
473
- ```
474
-
475
- ## Repository Pattern
476
-
477
- ### Interface Definition
478
-
479
- ```kotlin
480
- interface UserRepository {
481
- suspend fun findById(id: UUID): User?
482
- suspend fun findByEmail(email: String): User?
483
- suspend fun findAll(page: Int, limit: Int): Page<User>
484
- suspend fun search(query: String): List<User>
485
- suspend fun create(request: CreateUserRequest): User
486
- suspend fun update(id: UUID, request: UpdateUserRequest): User?
487
- suspend fun delete(id: UUID): Boolean
488
- suspend fun count(): Long
489
- }
490
- ```
491
-
492
- ### Exposed Implementation
493
-
494
- ```kotlin
495
- class ExposedUserRepository(
496
- private val database: Database,
497
- ) : UserRepository {
498
-
499
- override suspend fun findById(id: UUID): User? =
500
- newSuspendedTransaction(db = database) {
501
- UsersTable.selectAll()
502
- .where { UsersTable.id eq id }
503
- .map { it.toUser() }
504
- .singleOrNull()
505
- }
506
-
507
- override suspend fun findByEmail(email: String): User? =
508
- newSuspendedTransaction(db = database) {
509
- UsersTable.selectAll()
510
- .where { UsersTable.email eq email }
511
- .map { it.toUser() }
512
- .singleOrNull()
513
- }
514
-
515
- override suspend fun findAll(page: Int, limit: Int): Page<User> =
516
- newSuspendedTransaction(db = database) {
517
- val total = UsersTable.selectAll().count()
518
- val data = UsersTable.selectAll()
519
- .orderBy(UsersTable.createdAt, SortOrder.DESC)
520
- .limit(limit)
521
- .offset(((page - 1) * limit).toLong())
522
- .map { it.toUser() }
523
- Page(data = data, total = total, page = page, limit = limit)
524
- }
525
-
526
- override suspend fun search(query: String): List<User> =
527
- newSuspendedTransaction(db = database) {
528
- val sanitized = escapeLikePattern(query.lowercase())
529
- UsersTable.selectAll()
530
- .where {
531
- (UsersTable.name.lowerCase() like "%${sanitized}%") or
532
- (UsersTable.email.lowerCase() like "%${sanitized}%")
533
- }
534
- .orderBy(UsersTable.name)
535
- .map { it.toUser() }
536
- }
537
-
538
- override suspend fun create(request: CreateUserRequest): User =
539
- newSuspendedTransaction(db = database) {
540
- UsersTable.insert {
541
- it[name] = request.name
542
- it[email] = request.email
543
- it[role] = request.role
544
- }.resultedValues!!.first().toUser()
545
- }
546
-
547
- override suspend fun update(id: UUID, request: UpdateUserRequest): User? =
548
- newSuspendedTransaction(db = database) {
549
- val updated = UsersTable.update({ UsersTable.id eq id }) {
550
- request.name?.let { name -> it[UsersTable.name] = name }
551
- request.email?.let { email -> it[UsersTable.email] = email }
552
- it[updatedAt] = CurrentTimestampWithTimeZone
553
- }
554
- if (updated > 0) findById(id) else null
555
- }
556
-
557
- override suspend fun delete(id: UUID): Boolean =
558
- newSuspendedTransaction(db = database) {
559
- UsersTable.deleteWhere { UsersTable.id eq id } > 0
560
- }
561
-
562
- override suspend fun count(): Long =
563
- newSuspendedTransaction(db = database) {
564
- UsersTable.selectAll().count()
565
- }
566
-
567
- private fun ResultRow.toUser() = User(
568
- id = this[UsersTable.id].value,
569
- name = this[UsersTable.name],
570
- email = this[UsersTable.email],
571
- role = this[UsersTable.role],
572
- metadata = this[UsersTable.metadata],
573
- createdAt = this[UsersTable.createdAt],
574
- updatedAt = this[UsersTable.updatedAt],
575
- )
576
- }
577
- ```
578
-
579
- ## JSON Columns
580
-
581
- ### JSONB with kotlinx.serialization
582
-
583
- ```kotlin
584
- // Custom column type for JSONB
585
- inline fun <reified T : Any> Table.jsonb(
586
- name: String,
587
- json: Json,
588
- ): Column<T> = registerColumn(name, object : ColumnType<T>() {
589
- override fun sqlType() = "JSONB"
590
-
591
- override fun valueFromDB(value: Any): T = when (value) {
592
- is String -> json.decodeFromString(value)
593
- is PGobject -> {
594
- val jsonString = value.value
595
- ?: throw IllegalArgumentException("PGobject value is null for column '$name'")
596
- json.decodeFromString(jsonString)
597
- }
598
- else -> throw IllegalArgumentException("Unexpected value: $value")
599
- }
600
-
601
- override fun notNullValueToDB(value: T): Any =
602
- PGobject().apply {
603
- type = "jsonb"
604
- this.value = json.encodeToString(value)
605
- }
606
- })
607
-
608
- // Usage in table
609
- @Serializable
610
- data class UserMetadata(
611
- val preferences: Map<String, String> = emptyMap(),
612
- val tags: List<String> = emptyList(),
613
- )
614
-
615
- object UsersTable : UUIDTable("users") {
616
- val metadata = jsonb<UserMetadata>("metadata", Json.Default).nullable()
617
- }
618
- ```
619
-
620
- ## Testing with Exposed
621
-
622
- ### In-Memory Database for Tests
623
-
624
- ```kotlin
625
- class UserRepositoryTest : FunSpec({
626
- lateinit var database: Database
627
- lateinit var repository: UserRepository
628
-
629
- beforeSpec {
630
- database = Database.connect(
631
- url = "jdbc:h2:mem:test;DB_CLOSE_DELAY=-1;MODE=PostgreSQL",
632
- driver = "org.h2.Driver",
633
- )
634
- transaction(database) {
635
- SchemaUtils.create(UsersTable)
636
- }
637
- repository = ExposedUserRepository(database)
638
- }
639
-
640
- beforeTest {
641
- transaction(database) {
642
- UsersTable.deleteAll()
643
- }
644
- }
645
-
646
- test("create and find user") {
647
- val user = repository.create(CreateUserRequest("Alice", "alice@example.com"))
648
-
649
- user.name shouldBe "Alice"
650
- user.email shouldBe "alice@example.com"
651
-
652
- val found = repository.findById(user.id)
653
- found shouldBe user
654
- }
655
-
656
- test("findByEmail returns null for unknown email") {
657
- val result = repository.findByEmail("unknown@example.com")
658
- result.shouldBeNull()
659
- }
660
-
661
- test("pagination works correctly") {
662
- repeat(25) { i ->
663
- repository.create(CreateUserRequest("User $i", "user$i@example.com"))
664
- }
665
-
666
- val page1 = repository.findAll(page = 1, limit = 10)
667
- page1.data shouldHaveSize 10
668
- page1.total shouldBe 25
669
- page1.hasNext shouldBe true
670
-
671
- val page3 = repository.findAll(page = 3, limit = 10)
672
- page3.data shouldHaveSize 5
673
- page3.hasNext shouldBe false
674
- }
675
- })
676
- ```
677
-
678
- ## Gradle Dependencies
679
-
680
- ```kotlin
681
- // build.gradle.kts
682
- dependencies {
683
- // Exposed
684
- implementation("org.jetbrains.exposed:exposed-core:1.0.0")
685
- implementation("org.jetbrains.exposed:exposed-dao:1.0.0")
686
- implementation("org.jetbrains.exposed:exposed-jdbc:1.0.0")
687
- implementation("org.jetbrains.exposed:exposed-kotlin-datetime:1.0.0")
688
- implementation("org.jetbrains.exposed:exposed-json:1.0.0")
689
-
690
- // Database driver
691
- implementation("org.postgresql:postgresql:42.7.5")
692
-
693
- // Connection pooling
694
- implementation("com.zaxxer:HikariCP:6.2.1")
695
-
696
- // Migrations
697
- implementation("org.flywaydb:flyway-core:10.22.0")
698
- implementation("org.flywaydb:flyway-database-postgresql:10.22.0")
699
-
700
- // Testing
701
- testImplementation("com.h2database:h2:2.3.232")
702
- }
703
- ```
704
-
705
- ## Quick Reference: Exposed Patterns
706
-
707
- | Pattern | Description |
708
- |---------|-------------|
709
- | `object Table : UUIDTable("name")` | Define table with UUID primary key |
710
- | `newSuspendedTransaction { }` | Coroutine-safe transaction block |
711
- | `Table.selectAll().where { }` | Query with conditions |
712
- | `Table.insertAndGetId { }` | Insert and return generated ID |
713
- | `Table.update({ condition }) { }` | Update matching rows |
714
- | `Table.deleteWhere { }` | Delete matching rows |
715
- | `Table.batchInsert(items) { }` | Efficient bulk insert |
716
- | `innerJoin` / `leftJoin` | Join tables |
717
- | `orderBy` / `limit` / `offset` | Sort and paginate |
718
- | `count()` / `sum()` / `avg()` | Aggregation functions |
719
-
720
- **Remember**: Use the DSL style for simple queries and the DAO style when you need entity lifecycle management. Always use `newSuspendedTransaction` for coroutine support, and wrap database operations behind a repository interface for testability.
1
+ ---
2
+ name: kotlin-exposed-patterns
3
+ description: JetBrains Exposed ORM patterns including DSL queries, DAO pattern, transactions, HikariCP connection pooling, Flyway migrations, and repository pattern.
4
+ metadata:
5
+ origin: ECC
6
+ ---
7
+
8
+ # Kotlin Exposed Patterns
9
+
10
+ Comprehensive patterns for database access with JetBrains Exposed ORM, including DSL queries, DAO, transactions, and production-ready configuration.
11
+
12
+ ## When to Use
13
+
14
+ - Setting up database access with Exposed
15
+ - Writing SQL queries using Exposed DSL or DAO
16
+ - Configuring connection pooling with HikariCP
17
+ - Creating database migrations with Flyway
18
+ - Implementing the repository pattern with Exposed
19
+ - Handling JSON columns and complex queries
20
+
21
+ ## How It Works
22
+
23
+ Exposed provides two query styles: DSL for direct SQL-like expressions and DAO for entity lifecycle management. HikariCP manages a pool of reusable database connections configured via `HikariConfig`. Flyway runs versioned SQL migration scripts at startup to keep the schema in sync. All database operations run inside `newSuspendedTransaction` blocks for coroutine safety and atomicity. The repository pattern wraps Exposed queries behind an interface so business logic stays decoupled from the data layer and tests can use an in-memory H2 database.
24
+
25
+ ## Examples
26
+
27
+ ### DSL Query
28
+
29
+ ```kotlin
30
+ suspend fun findUserById(id: UUID): UserRow? =
31
+ newSuspendedTransaction {
32
+ UsersTable.selectAll()
33
+ .where { UsersTable.id eq id }
34
+ .map { it.toUser() }
35
+ .singleOrNull()
36
+ }
37
+ ```
38
+
39
+ ### DAO Entity Usage
40
+
41
+ ```kotlin
42
+ suspend fun createUser(request: CreateUserRequest): User =
43
+ newSuspendedTransaction {
44
+ UserEntity.new {
45
+ name = request.name
46
+ email = request.email
47
+ role = request.role
48
+ }.toModel()
49
+ }
50
+ ```
51
+
52
+ ### HikariCP Configuration
53
+
54
+ ```kotlin
55
+ val hikariConfig = HikariConfig().apply {
56
+ driverClassName = config.driver
57
+ jdbcUrl = config.url
58
+ username = config.username
59
+ password = config.password
60
+ maximumPoolSize = config.maxPoolSize
61
+ isAutoCommit = false
62
+ transactionIsolation = "TRANSACTION_READ_COMMITTED"
63
+ validate()
64
+ }
65
+ ```
66
+
67
+ ## Database Setup
68
+
69
+ ### HikariCP Connection Pooling
70
+
71
+ ```kotlin
72
+ // DatabaseFactory.kt
73
+ object DatabaseFactory {
74
+ fun create(config: DatabaseConfig): Database {
75
+ val hikariConfig = HikariConfig().apply {
76
+ driverClassName = config.driver
77
+ jdbcUrl = config.url
78
+ username = config.username
79
+ password = config.password
80
+ maximumPoolSize = config.maxPoolSize
81
+ isAutoCommit = false
82
+ transactionIsolation = "TRANSACTION_READ_COMMITTED"
83
+ validate()
84
+ }
85
+
86
+ return Database.connect(HikariDataSource(hikariConfig))
87
+ }
88
+ }
89
+
90
+ data class DatabaseConfig(
91
+ val url: String,
92
+ val driver: String = "org.postgresql.Driver",
93
+ val username: String = "",
94
+ val password: String = "",
95
+ val maxPoolSize: Int = 10,
96
+ )
97
+ ```
98
+
99
+ ### Flyway Migrations
100
+
101
+ ```kotlin
102
+ // FlywayMigration.kt
103
+ fun runMigrations(config: DatabaseConfig) {
104
+ Flyway.configure()
105
+ .dataSource(config.url, config.username, config.password)
106
+ .locations("classpath:db/migration")
107
+ .baselineOnMigrate(true)
108
+ .load()
109
+ .migrate()
110
+ }
111
+
112
+ // Application startup
113
+ fun Application.module() {
114
+ val config = DatabaseConfig(
115
+ url = environment.config.property("database.url").getString(),
116
+ username = environment.config.property("database.username").getString(),
117
+ password = environment.config.property("database.password").getString(),
118
+ )
119
+ runMigrations(config)
120
+ val database = DatabaseFactory.create(config)
121
+ // ...
122
+ }
123
+ ```
124
+
125
+ ### Migration Files
126
+
127
+ ```sql
128
+ -- src/main/resources/db/migration/V1__create_users.sql
129
+ CREATE TABLE users (
130
+ id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
131
+ name VARCHAR(100) NOT NULL,
132
+ email VARCHAR(255) NOT NULL UNIQUE,
133
+ role VARCHAR(20) NOT NULL DEFAULT 'USER',
134
+ metadata JSONB,
135
+ created_at TIMESTAMPTZ NOT NULL DEFAULT NOW(),
136
+ updated_at TIMESTAMPTZ NOT NULL DEFAULT NOW()
137
+ );
138
+
139
+ CREATE INDEX idx_users_email ON users(email);
140
+ CREATE INDEX idx_users_role ON users(role);
141
+ ```
142
+
143
+ ## Table Definitions
144
+
145
+ ### DSL Style Tables
146
+
147
+ ```kotlin
148
+ // tables/UsersTable.kt
149
+ object UsersTable : UUIDTable("users") {
150
+ val name = varchar("name", 100)
151
+ val email = varchar("email", 255).uniqueIndex()
152
+ val role = enumerationByName<Role>("role", 20)
153
+ val metadata = jsonb<UserMetadata>("metadata", Json.Default).nullable()
154
+ val createdAt = timestampWithTimeZone("created_at").defaultExpression(CurrentTimestampWithTimeZone)
155
+ val updatedAt = timestampWithTimeZone("updated_at").defaultExpression(CurrentTimestampWithTimeZone)
156
+ }
157
+
158
+ object OrdersTable : UUIDTable("orders") {
159
+ val userId = uuid("user_id").references(UsersTable.id)
160
+ val status = enumerationByName<OrderStatus>("status", 20)
161
+ val totalAmount = long("total_amount")
162
+ val currency = varchar("currency", 3)
163
+ val createdAt = timestampWithTimeZone("created_at").defaultExpression(CurrentTimestampWithTimeZone)
164
+ }
165
+
166
+ object OrderItemsTable : UUIDTable("order_items") {
167
+ val orderId = uuid("order_id").references(OrdersTable.id, onDelete = ReferenceOption.CASCADE)
168
+ val productId = uuid("product_id")
169
+ val quantity = integer("quantity")
170
+ val unitPrice = long("unit_price")
171
+ }
172
+ ```
173
+
174
+ ### Composite Tables
175
+
176
+ ```kotlin
177
+ object UserRolesTable : Table("user_roles") {
178
+ val userId = uuid("user_id").references(UsersTable.id, onDelete = ReferenceOption.CASCADE)
179
+ val roleId = uuid("role_id").references(RolesTable.id, onDelete = ReferenceOption.CASCADE)
180
+ override val primaryKey = PrimaryKey(userId, roleId)
181
+ }
182
+ ```
183
+
184
+ ## DSL Queries
185
+
186
+ ### Basic CRUD
187
+
188
+ ```kotlin
189
+ // Insert
190
+ suspend fun insertUser(name: String, email: String, role: Role): UUID =
191
+ newSuspendedTransaction {
192
+ UsersTable.insertAndGetId {
193
+ it[UsersTable.name] = name
194
+ it[UsersTable.email] = email
195
+ it[UsersTable.role] = role
196
+ }.value
197
+ }
198
+
199
+ // Select by ID
200
+ suspend fun findUserById(id: UUID): UserRow? =
201
+ newSuspendedTransaction {
202
+ UsersTable.selectAll()
203
+ .where { UsersTable.id eq id }
204
+ .map { it.toUser() }
205
+ .singleOrNull()
206
+ }
207
+
208
+ // Select with conditions
209
+ suspend fun findActiveAdmins(): List<UserRow> =
210
+ newSuspendedTransaction {
211
+ UsersTable.selectAll()
212
+ .where { (UsersTable.role eq Role.ADMIN) }
213
+ .orderBy(UsersTable.name)
214
+ .map { it.toUser() }
215
+ }
216
+
217
+ // Update
218
+ suspend fun updateUserEmail(id: UUID, newEmail: String): Boolean =
219
+ newSuspendedTransaction {
220
+ UsersTable.update({ UsersTable.id eq id }) {
221
+ it[email] = newEmail
222
+ it[updatedAt] = CurrentTimestampWithTimeZone
223
+ } > 0
224
+ }
225
+
226
+ // Delete
227
+ suspend fun deleteUser(id: UUID): Boolean =
228
+ newSuspendedTransaction {
229
+ UsersTable.deleteWhere { UsersTable.id eq id } > 0
230
+ }
231
+
232
+ // Row mapping
233
+ private fun ResultRow.toUser() = UserRow(
234
+ id = this[UsersTable.id].value,
235
+ name = this[UsersTable.name],
236
+ email = this[UsersTable.email],
237
+ role = this[UsersTable.role],
238
+ metadata = this[UsersTable.metadata],
239
+ createdAt = this[UsersTable.createdAt],
240
+ updatedAt = this[UsersTable.updatedAt],
241
+ )
242
+ ```
243
+
244
+ ### Advanced Queries
245
+
246
+ ```kotlin
247
+ // Join queries
248
+ suspend fun findOrdersWithUser(userId: UUID): List<OrderWithUser> =
249
+ newSuspendedTransaction {
250
+ (OrdersTable innerJoin UsersTable)
251
+ .selectAll()
252
+ .where { OrdersTable.userId eq userId }
253
+ .orderBy(OrdersTable.createdAt, SortOrder.DESC)
254
+ .map { row ->
255
+ OrderWithUser(
256
+ orderId = row[OrdersTable.id].value,
257
+ status = row[OrdersTable.status],
258
+ totalAmount = row[OrdersTable.totalAmount],
259
+ userName = row[UsersTable.name],
260
+ )
261
+ }
262
+ }
263
+
264
+ // Aggregation
265
+ suspend fun countUsersByRole(): Map<Role, Long> =
266
+ newSuspendedTransaction {
267
+ UsersTable
268
+ .select(UsersTable.role, UsersTable.id.count())
269
+ .groupBy(UsersTable.role)
270
+ .associate { row ->
271
+ row[UsersTable.role] to row[UsersTable.id.count()]
272
+ }
273
+ }
274
+
275
+ // Subqueries
276
+ suspend fun findUsersWithOrders(): List<UserRow> =
277
+ newSuspendedTransaction {
278
+ UsersTable.selectAll()
279
+ .where {
280
+ UsersTable.id inSubQuery
281
+ OrdersTable.select(OrdersTable.userId).withDistinct()
282
+ }
283
+ .map { it.toUser() }
284
+ }
285
+
286
+ // LIKE and pattern matching — always escape user input to prevent wildcard injection
287
+ private fun escapeLikePattern(input: String): String =
288
+ input.replace("\\", "\\\\").replace("%", "\\%").replace("_", "\\_")
289
+
290
+ suspend fun searchUsers(query: String): List<UserRow> =
291
+ newSuspendedTransaction {
292
+ val sanitized = escapeLikePattern(query.lowercase())
293
+ UsersTable.selectAll()
294
+ .where {
295
+ (UsersTable.name.lowerCase() like "%${sanitized}%") or
296
+ (UsersTable.email.lowerCase() like "%${sanitized}%")
297
+ }
298
+ .map { it.toUser() }
299
+ }
300
+ ```
301
+
302
+ ### Pagination
303
+
304
+ ```kotlin
305
+ data class Page<T>(
306
+ val data: List<T>,
307
+ val total: Long,
308
+ val page: Int,
309
+ val limit: Int,
310
+ ) {
311
+ val totalPages: Int get() = ((total + limit - 1) / limit).toInt()
312
+ val hasNext: Boolean get() = page < totalPages
313
+ val hasPrevious: Boolean get() = page > 1
314
+ }
315
+
316
+ suspend fun findUsersPaginated(page: Int, limit: Int): Page<UserRow> =
317
+ newSuspendedTransaction {
318
+ val total = UsersTable.selectAll().count()
319
+ val data = UsersTable.selectAll()
320
+ .orderBy(UsersTable.createdAt, SortOrder.DESC)
321
+ .limit(limit)
322
+ .offset(((page - 1) * limit).toLong())
323
+ .map { it.toUser() }
324
+
325
+ Page(data = data, total = total, page = page, limit = limit)
326
+ }
327
+ ```
328
+
329
+ ### Batch Operations
330
+
331
+ ```kotlin
332
+ // Batch insert
333
+ suspend fun insertUsers(users: List<CreateUserRequest>): List<UUID> =
334
+ newSuspendedTransaction {
335
+ UsersTable.batchInsert(users) { user ->
336
+ this[UsersTable.name] = user.name
337
+ this[UsersTable.email] = user.email
338
+ this[UsersTable.role] = user.role
339
+ }.map { it[UsersTable.id].value }
340
+ }
341
+
342
+ // Upsert (insert or update on conflict)
343
+ suspend fun upsertUser(id: UUID, name: String, email: String) {
344
+ newSuspendedTransaction {
345
+ UsersTable.upsert(UsersTable.email) {
346
+ it[UsersTable.id] = EntityID(id, UsersTable)
347
+ it[UsersTable.name] = name
348
+ it[UsersTable.email] = email
349
+ it[updatedAt] = CurrentTimestampWithTimeZone
350
+ }
351
+ }
352
+ }
353
+ ```
354
+
355
+ ## DAO Pattern
356
+
357
+ ### Entity Definitions
358
+
359
+ ```kotlin
360
+ // entities/UserEntity.kt
361
+ class UserEntity(id: EntityID<UUID>) : UUIDEntity(id) {
362
+ companion object : UUIDEntityClass<UserEntity>(UsersTable)
363
+
364
+ var name by UsersTable.name
365
+ var email by UsersTable.email
366
+ var role by UsersTable.role
367
+ var metadata by UsersTable.metadata
368
+ var createdAt by UsersTable.createdAt
369
+ var updatedAt by UsersTable.updatedAt
370
+
371
+ val orders by OrderEntity referrersOn OrdersTable.userId
372
+
373
+ fun toModel(): User = User(
374
+ id = id.value,
375
+ name = name,
376
+ email = email,
377
+ role = role,
378
+ metadata = metadata,
379
+ createdAt = createdAt,
380
+ updatedAt = updatedAt,
381
+ )
382
+ }
383
+
384
+ class OrderEntity(id: EntityID<UUID>) : UUIDEntity(id) {
385
+ companion object : UUIDEntityClass<OrderEntity>(OrdersTable)
386
+
387
+ var user by UserEntity referencedOn OrdersTable.userId
388
+ var status by OrdersTable.status
389
+ var totalAmount by OrdersTable.totalAmount
390
+ var currency by OrdersTable.currency
391
+ var createdAt by OrdersTable.createdAt
392
+
393
+ val items by OrderItemEntity referrersOn OrderItemsTable.orderId
394
+ }
395
+ ```
396
+
397
+ ### DAO Operations
398
+
399
+ ```kotlin
400
+ suspend fun findUserByEmail(email: String): User? =
401
+ newSuspendedTransaction {
402
+ UserEntity.find { UsersTable.email eq email }
403
+ .firstOrNull()
404
+ ?.toModel()
405
+ }
406
+
407
+ suspend fun createUser(request: CreateUserRequest): User =
408
+ newSuspendedTransaction {
409
+ UserEntity.new {
410
+ name = request.name
411
+ email = request.email
412
+ role = request.role
413
+ }.toModel()
414
+ }
415
+
416
+ suspend fun updateUser(id: UUID, request: UpdateUserRequest): User? =
417
+ newSuspendedTransaction {
418
+ UserEntity.findById(id)?.apply {
419
+ request.name?.let { name = it }
420
+ request.email?.let { email = it }
421
+ updatedAt = OffsetDateTime.now(ZoneOffset.UTC)
422
+ }?.toModel()
423
+ }
424
+ ```
425
+
426
+ ## Transactions
427
+
428
+ ### Suspend Transaction Support
429
+
430
+ ```kotlin
431
+ // Good: Use newSuspendedTransaction for coroutine support
432
+ suspend fun performDatabaseOperation(): Result<User> =
433
+ runCatching {
434
+ newSuspendedTransaction {
435
+ val user = UserEntity.new {
436
+ name = "Alice"
437
+ email = "alice@example.com"
438
+ }
439
+ // All operations in this block are atomic
440
+ user.toModel()
441
+ }
442
+ }
443
+
444
+ // Good: Nested transactions with savepoints
445
+ suspend fun transferFunds(fromId: UUID, toId: UUID, amount: Long) {
446
+ newSuspendedTransaction {
447
+ val from = UserEntity.findById(fromId) ?: throw NotFoundException("User $fromId not found")
448
+ val to = UserEntity.findById(toId) ?: throw NotFoundException("User $toId not found")
449
+
450
+ // Debit
451
+ from.balance -= amount
452
+ // Credit
453
+ to.balance += amount
454
+
455
+ // Both succeed or both fail
456
+ }
457
+ }
458
+ ```
459
+
460
+ ### Transaction Isolation
461
+
462
+ ```kotlin
463
+ suspend fun readCommittedQuery(): List<User> =
464
+ newSuspendedTransaction(transactionIsolation = Connection.TRANSACTION_READ_COMMITTED) {
465
+ UserEntity.all().map { it.toModel() }
466
+ }
467
+
468
+ suspend fun serializableOperation() {
469
+ newSuspendedTransaction(transactionIsolation = Connection.TRANSACTION_SERIALIZABLE) {
470
+ // Strictest isolation level for critical operations
471
+ }
472
+ }
473
+ ```
474
+
475
+ ## Repository Pattern
476
+
477
+ ### Interface Definition
478
+
479
+ ```kotlin
480
+ interface UserRepository {
481
+ suspend fun findById(id: UUID): User?
482
+ suspend fun findByEmail(email: String): User?
483
+ suspend fun findAll(page: Int, limit: Int): Page<User>
484
+ suspend fun search(query: String): List<User>
485
+ suspend fun create(request: CreateUserRequest): User
486
+ suspend fun update(id: UUID, request: UpdateUserRequest): User?
487
+ suspend fun delete(id: UUID): Boolean
488
+ suspend fun count(): Long
489
+ }
490
+ ```
491
+
492
+ ### Exposed Implementation
493
+
494
+ ```kotlin
495
+ class ExposedUserRepository(
496
+ private val database: Database,
497
+ ) : UserRepository {
498
+
499
+ override suspend fun findById(id: UUID): User? =
500
+ newSuspendedTransaction(db = database) {
501
+ UsersTable.selectAll()
502
+ .where { UsersTable.id eq id }
503
+ .map { it.toUser() }
504
+ .singleOrNull()
505
+ }
506
+
507
+ override suspend fun findByEmail(email: String): User? =
508
+ newSuspendedTransaction(db = database) {
509
+ UsersTable.selectAll()
510
+ .where { UsersTable.email eq email }
511
+ .map { it.toUser() }
512
+ .singleOrNull()
513
+ }
514
+
515
+ override suspend fun findAll(page: Int, limit: Int): Page<User> =
516
+ newSuspendedTransaction(db = database) {
517
+ val total = UsersTable.selectAll().count()
518
+ val data = UsersTable.selectAll()
519
+ .orderBy(UsersTable.createdAt, SortOrder.DESC)
520
+ .limit(limit)
521
+ .offset(((page - 1) * limit).toLong())
522
+ .map { it.toUser() }
523
+ Page(data = data, total = total, page = page, limit = limit)
524
+ }
525
+
526
+ override suspend fun search(query: String): List<User> =
527
+ newSuspendedTransaction(db = database) {
528
+ val sanitized = escapeLikePattern(query.lowercase())
529
+ UsersTable.selectAll()
530
+ .where {
531
+ (UsersTable.name.lowerCase() like "%${sanitized}%") or
532
+ (UsersTable.email.lowerCase() like "%${sanitized}%")
533
+ }
534
+ .orderBy(UsersTable.name)
535
+ .map { it.toUser() }
536
+ }
537
+
538
+ override suspend fun create(request: CreateUserRequest): User =
539
+ newSuspendedTransaction(db = database) {
540
+ UsersTable.insert {
541
+ it[name] = request.name
542
+ it[email] = request.email
543
+ it[role] = request.role
544
+ }.resultedValues!!.first().toUser()
545
+ }
546
+
547
+ override suspend fun update(id: UUID, request: UpdateUserRequest): User? =
548
+ newSuspendedTransaction(db = database) {
549
+ val updated = UsersTable.update({ UsersTable.id eq id }) {
550
+ request.name?.let { name -> it[UsersTable.name] = name }
551
+ request.email?.let { email -> it[UsersTable.email] = email }
552
+ it[updatedAt] = CurrentTimestampWithTimeZone
553
+ }
554
+ if (updated > 0) findById(id) else null
555
+ }
556
+
557
+ override suspend fun delete(id: UUID): Boolean =
558
+ newSuspendedTransaction(db = database) {
559
+ UsersTable.deleteWhere { UsersTable.id eq id } > 0
560
+ }
561
+
562
+ override suspend fun count(): Long =
563
+ newSuspendedTransaction(db = database) {
564
+ UsersTable.selectAll().count()
565
+ }
566
+
567
+ private fun ResultRow.toUser() = User(
568
+ id = this[UsersTable.id].value,
569
+ name = this[UsersTable.name],
570
+ email = this[UsersTable.email],
571
+ role = this[UsersTable.role],
572
+ metadata = this[UsersTable.metadata],
573
+ createdAt = this[UsersTable.createdAt],
574
+ updatedAt = this[UsersTable.updatedAt],
575
+ )
576
+ }
577
+ ```
578
+
579
+ ## JSON Columns
580
+
581
+ ### JSONB with kotlinx.serialization
582
+
583
+ ```kotlin
584
+ // Custom column type for JSONB
585
+ inline fun <reified T : Any> Table.jsonb(
586
+ name: String,
587
+ json: Json,
588
+ ): Column<T> = registerColumn(name, object : ColumnType<T>() {
589
+ override fun sqlType() = "JSONB"
590
+
591
+ override fun valueFromDB(value: Any): T = when (value) {
592
+ is String -> json.decodeFromString(value)
593
+ is PGobject -> {
594
+ val jsonString = value.value
595
+ ?: throw IllegalArgumentException("PGobject value is null for column '$name'")
596
+ json.decodeFromString(jsonString)
597
+ }
598
+ else -> throw IllegalArgumentException("Unexpected value: $value")
599
+ }
600
+
601
+ override fun notNullValueToDB(value: T): Any =
602
+ PGobject().apply {
603
+ type = "jsonb"
604
+ this.value = json.encodeToString(value)
605
+ }
606
+ })
607
+
608
+ // Usage in table
609
+ @Serializable
610
+ data class UserMetadata(
611
+ val preferences: Map<String, String> = emptyMap(),
612
+ val tags: List<String> = emptyList(),
613
+ )
614
+
615
+ object UsersTable : UUIDTable("users") {
616
+ val metadata = jsonb<UserMetadata>("metadata", Json.Default).nullable()
617
+ }
618
+ ```
619
+
620
+ ## Testing with Exposed
621
+
622
+ ### In-Memory Database for Tests
623
+
624
+ ```kotlin
625
+ class UserRepositoryTest : FunSpec({
626
+ lateinit var database: Database
627
+ lateinit var repository: UserRepository
628
+
629
+ beforeSpec {
630
+ database = Database.connect(
631
+ url = "jdbc:h2:mem:test;DB_CLOSE_DELAY=-1;MODE=PostgreSQL",
632
+ driver = "org.h2.Driver",
633
+ )
634
+ transaction(database) {
635
+ SchemaUtils.create(UsersTable)
636
+ }
637
+ repository = ExposedUserRepository(database)
638
+ }
639
+
640
+ beforeTest {
641
+ transaction(database) {
642
+ UsersTable.deleteAll()
643
+ }
644
+ }
645
+
646
+ test("create and find user") {
647
+ val user = repository.create(CreateUserRequest("Alice", "alice@example.com"))
648
+
649
+ user.name shouldBe "Alice"
650
+ user.email shouldBe "alice@example.com"
651
+
652
+ val found = repository.findById(user.id)
653
+ found shouldBe user
654
+ }
655
+
656
+ test("findByEmail returns null for unknown email") {
657
+ val result = repository.findByEmail("unknown@example.com")
658
+ result.shouldBeNull()
659
+ }
660
+
661
+ test("pagination works correctly") {
662
+ repeat(25) { i ->
663
+ repository.create(CreateUserRequest("User $i", "user$i@example.com"))
664
+ }
665
+
666
+ val page1 = repository.findAll(page = 1, limit = 10)
667
+ page1.data shouldHaveSize 10
668
+ page1.total shouldBe 25
669
+ page1.hasNext shouldBe true
670
+
671
+ val page3 = repository.findAll(page = 3, limit = 10)
672
+ page3.data shouldHaveSize 5
673
+ page3.hasNext shouldBe false
674
+ }
675
+ })
676
+ ```
677
+
678
+ ## Gradle Dependencies
679
+
680
+ ```kotlin
681
+ // build.gradle.kts
682
+ dependencies {
683
+ // Exposed
684
+ implementation("org.jetbrains.exposed:exposed-core:1.0.0")
685
+ implementation("org.jetbrains.exposed:exposed-dao:1.0.0")
686
+ implementation("org.jetbrains.exposed:exposed-jdbc:1.0.0")
687
+ implementation("org.jetbrains.exposed:exposed-kotlin-datetime:1.0.0")
688
+ implementation("org.jetbrains.exposed:exposed-json:1.0.0")
689
+
690
+ // Database driver
691
+ implementation("org.postgresql:postgresql:42.7.5")
692
+
693
+ // Connection pooling
694
+ implementation("com.zaxxer:HikariCP:6.2.1")
695
+
696
+ // Migrations
697
+ implementation("org.flywaydb:flyway-core:10.22.0")
698
+ implementation("org.flywaydb:flyway-database-postgresql:10.22.0")
699
+
700
+ // Testing
701
+ testImplementation("com.h2database:h2:2.3.232")
702
+ }
703
+ ```
704
+
705
+ ## Quick Reference: Exposed Patterns
706
+
707
+ | Pattern | Description |
708
+ |---------|-------------|
709
+ | `object Table : UUIDTable("name")` | Define table with UUID primary key |
710
+ | `newSuspendedTransaction { }` | Coroutine-safe transaction block |
711
+ | `Table.selectAll().where { }` | Query with conditions |
712
+ | `Table.insertAndGetId { }` | Insert and return generated ID |
713
+ | `Table.update({ condition }) { }` | Update matching rows |
714
+ | `Table.deleteWhere { }` | Delete matching rows |
715
+ | `Table.batchInsert(items) { }` | Efficient bulk insert |
716
+ | `innerJoin` / `leftJoin` | Join tables |
717
+ | `orderBy` / `limit` / `offset` | Sort and paginate |
718
+ | `count()` / `sum()` / `avg()` | Aggregation functions |
719
+
720
+ **Remember**: Use the DSL style for simple queries and the DAO style when you need entity lifecycle management. Always use `newSuspendedTransaction` for coroutine support, and wrap database operations behind a repository interface for testability.