codeply-cli 0.3.1 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (375) hide show
  1. package/THIRD_PARTY_NOTICES.md +63 -63
  2. package/bin/codeply.js +127 -0
  3. package/lib/agent.mjs +2139 -2139
  4. package/lib/ai.mjs +6 -6
  5. package/lib/apply-patch.js +217 -217
  6. package/lib/arity-table.json +138 -138
  7. package/lib/arity.js +70 -70
  8. package/lib/auth.mjs +6 -6
  9. package/lib/cloud.mjs +708 -0
  10. package/lib/commands.js +103 -103
  11. package/lib/design-library/assemble-artifact.mjs +21 -21
  12. package/lib/design-library/cleanup.mjs +45 -45
  13. package/lib/design-library/index.json +22379 -22379
  14. package/lib/design-library/make-table-data.mjs +39 -39
  15. package/lib/diagnostics.js +192 -192
  16. package/lib/edit-engine.js +364 -364
  17. package/lib/github-agent.mjs +311 -307
  18. package/lib/history.js +75 -75
  19. package/lib/mcp.js +258 -258
  20. package/lib/native-tools.mjs +189 -189
  21. package/lib/oauth-connectors.js +2 -1
  22. package/lib/permissions.js +109 -109
  23. package/lib/plugins.js +353 -353
  24. package/lib/server.mjs +457 -457
  25. package/lib/session-db.js +220 -220
  26. package/lib/share.js +168 -168
  27. package/lib/skills.js +416 -416
  28. package/lib/snapshot.js +146 -146
  29. package/lib/terminal-hints.js +154 -154
  30. package/lib/tools.mjs +2012 -2012
  31. package/lib/typecheck-worker.js +147 -147
  32. package/lib/web-tools.js +158 -158
  33. package/package.json +49 -47
  34. package/skills/SOURCE.md +58 -58
  35. package/skills/accessibility/SKILL.md +147 -147
  36. package/skills/agent-architecture-audit/SKILL.md +257 -257
  37. package/skills/agent-eval/SKILL.md +147 -147
  38. package/skills/agent-harness-construction/SKILL.md +74 -74
  39. package/skills/agent-introspection-debugging/SKILL.md +154 -154
  40. package/skills/agent-payment-x402/SKILL.md +225 -225
  41. package/skills/agent-self-evaluation/SKILL.md +182 -182
  42. package/skills/agent-self-evaluation/references/evaluation-criteria.md +71 -71
  43. package/skills/agent-self-evaluation/references/hook-integration.md +64 -64
  44. package/skills/agent-sort/SKILL.md +216 -216
  45. package/skills/agentic-engineering/SKILL.md +64 -64
  46. package/skills/agentic-os/SKILL.md +388 -388
  47. package/skills/ai-first-engineering/SKILL.md +52 -52
  48. package/skills/ai-regression-testing/SKILL.md +386 -386
  49. package/skills/android-clean-architecture/SKILL.md +340 -340
  50. package/skills/angular-developer/SKILL.md +155 -155
  51. package/skills/angular-developer/references/angular-animations.md +160 -160
  52. package/skills/angular-developer/references/angular-aria.md +410 -410
  53. package/skills/angular-developer/references/cli.md +86 -86
  54. package/skills/angular-developer/references/component-harnesses.md +59 -59
  55. package/skills/angular-developer/references/component-styling.md +91 -91
  56. package/skills/angular-developer/references/components.md +117 -117
  57. package/skills/angular-developer/references/creating-services.md +97 -97
  58. package/skills/angular-developer/references/data-resolvers.md +69 -69
  59. package/skills/angular-developer/references/define-routes.md +67 -67
  60. package/skills/angular-developer/references/defining-providers.md +72 -72
  61. package/skills/angular-developer/references/di-fundamentals.md +120 -120
  62. package/skills/angular-developer/references/e2e-testing.md +56 -56
  63. package/skills/angular-developer/references/effects.md +83 -83
  64. package/skills/angular-developer/references/hierarchical-injectors.md +43 -43
  65. package/skills/angular-developer/references/host-elements.md +80 -80
  66. package/skills/angular-developer/references/injection-context.md +63 -63
  67. package/skills/angular-developer/references/inputs.md +101 -101
  68. package/skills/angular-developer/references/linked-signal.md +59 -59
  69. package/skills/angular-developer/references/loading-strategies.md +61 -61
  70. package/skills/angular-developer/references/mcp.md +108 -108
  71. package/skills/angular-developer/references/navigate-to-routes.md +69 -69
  72. package/skills/angular-developer/references/outputs.md +86 -86
  73. package/skills/angular-developer/references/reactive-forms.md +122 -122
  74. package/skills/angular-developer/references/rendering-strategies.md +44 -44
  75. package/skills/angular-developer/references/resource.md +77 -77
  76. package/skills/angular-developer/references/route-animations.md +56 -56
  77. package/skills/angular-developer/references/route-guards.md +52 -52
  78. package/skills/angular-developer/references/router-lifecycle.md +45 -45
  79. package/skills/angular-developer/references/router-testing.md +87 -87
  80. package/skills/angular-developer/references/show-routes-with-outlets.md +68 -68
  81. package/skills/angular-developer/references/signal-forms.md +795 -795
  82. package/skills/angular-developer/references/signals-overview.md +94 -94
  83. package/skills/angular-developer/references/tailwind-css.md +69 -69
  84. package/skills/angular-developer/references/template-driven-forms.md +114 -114
  85. package/skills/angular-developer/references/testing-fundamentals.md +65 -65
  86. package/skills/api-connector-builder/SKILL.md +121 -121
  87. package/skills/api-design/SKILL.md +524 -524
  88. package/skills/architecture-decision-records/SKILL.md +180 -180
  89. package/skills/article-writing/SKILL.md +80 -80
  90. package/skills/automation-audit-ops/SKILL.md +143 -143
  91. package/skills/autonomous-agent-harness/SKILL.md +274 -274
  92. package/skills/autonomous-loops/SKILL.md +611 -611
  93. package/skills/backend-patterns/SKILL.md +562 -562
  94. package/skills/benchmark/SKILL.md +95 -95
  95. package/skills/benchmark-methodology/SKILL.md +191 -191
  96. package/skills/benchmark-optimization-loop/SKILL.md +71 -71
  97. package/skills/blender-motion-state-inspection/SKILL.md +165 -165
  98. package/skills/blueprint/SKILL.md +106 -106
  99. package/skills/brand-discovery/SKILL.md +145 -145
  100. package/skills/brand-discovery/references/10_purpose-why.md +40 -40
  101. package/skills/brand-discovery/references/20_positioning.md +44 -44
  102. package/skills/brand-discovery/references/30_audience-niche.md +52 -52
  103. package/skills/brand-discovery/references/40_personality-archetype.md +57 -57
  104. package/skills/brand-discovery/references/50_voice-tone.md +59 -59
  105. package/skills/brand-discovery/references/60_narrative-story.md +50 -50
  106. package/skills/brand-discovery/references/70_founder-tension.md +49 -49
  107. package/skills/brand-discovery/references/90_SYNTHESIS.md +133 -133
  108. package/skills/brand-voice/SKILL.md +98 -98
  109. package/skills/brand-voice/references/voice-profile-schema.md +55 -55
  110. package/skills/browser-qa/SKILL.md +105 -105
  111. package/skills/bun-runtime/SKILL.md +85 -85
  112. package/skills/canary-watch/SKILL.md +108 -108
  113. package/skills/carrier-relationship-management/SKILL.md +212 -212
  114. package/skills/cisco-ios-patterns/SKILL.md +164 -164
  115. package/skills/ck/SKILL.md +148 -148
  116. package/skills/claude-devfleet/SKILL.md +112 -112
  117. package/skills/click-path-audit/SKILL.md +245 -245
  118. package/skills/clickhouse-io/SKILL.md +445 -445
  119. package/skills/code-tour/SKILL.md +254 -254
  120. package/skills/codebase-onboarding/SKILL.md +234 -234
  121. package/skills/codehealth-mcp/SKILL.md +167 -167
  122. package/skills/coding-standards/SKILL.md +551 -551
  123. package/skills/competitive-platform-analysis/SKILL.md +214 -214
  124. package/skills/competitive-report-structure/SKILL.md +162 -162
  125. package/skills/compose-multiplatform-patterns/SKILL.md +300 -300
  126. package/skills/config-gc/SKILL.md +120 -120
  127. package/skills/configure-ecc/SKILL.md +385 -385
  128. package/skills/connections-optimizer/SKILL.md +190 -190
  129. package/skills/content-engine/SKILL.md +132 -132
  130. package/skills/content-hash-cache-pattern/SKILL.md +162 -162
  131. package/skills/context-budget/SKILL.md +136 -136
  132. package/skills/continuous-agent-loop/SKILL.md +46 -46
  133. package/skills/continuous-learning/SKILL.md +132 -132
  134. package/skills/continuous-learning-v2/SKILL.md +361 -361
  135. package/skills/contract-first/SKILL.md +287 -287
  136. package/skills/cost-aware-llm-pipeline/SKILL.md +184 -184
  137. package/skills/cost-tracking/SKILL.md +97 -97
  138. package/skills/council/SKILL.md +204 -204
  139. package/skills/cpp-coding-standards/SKILL.md +724 -724
  140. package/skills/cpp-testing/SKILL.md +325 -325
  141. package/skills/crosspost/SKILL.md +112 -112
  142. package/skills/csharp-testing/SKILL.md +322 -322
  143. package/skills/customer-billing-ops/SKILL.md +141 -141
  144. package/skills/customs-trade-compliance/SKILL.md +263 -263
  145. package/skills/dart-flutter-patterns/SKILL.md +564 -564
  146. package/skills/dashboard-builder/SKILL.md +109 -109
  147. package/skills/data-scraper-agent/SKILL.md +765 -765
  148. package/skills/data-throughput-accelerator/SKILL.md +74 -74
  149. package/skills/database-migrations/SKILL.md +430 -430
  150. package/skills/deep-research/SKILL.md +160 -160
  151. package/skills/defi-amm-security/SKILL.md +167 -167
  152. package/skills/delivery-gate/SKILL.md +126 -126
  153. package/skills/deployment-patterns/SKILL.md +428 -428
  154. package/skills/design-system/SKILL.md +83 -83
  155. package/skills/django-celery/SKILL.md +458 -458
  156. package/skills/django-patterns/SKILL.md +735 -735
  157. package/skills/django-security/SKILL.md +644 -644
  158. package/skills/django-tdd/SKILL.md +730 -730
  159. package/skills/django-verification/SKILL.md +470 -470
  160. package/skills/dmux-workflows/SKILL.md +192 -192
  161. package/skills/docker-patterns/SKILL.md +365 -365
  162. package/skills/documentation-lookup/SKILL.md +91 -91
  163. package/skills/dotnet-patterns/SKILL.md +322 -322
  164. package/skills/dynamic-workflow-mode/SKILL.md +124 -124
  165. package/skills/e2e-testing/SKILL.md +327 -327
  166. package/skills/ecc-guide/SKILL.md +190 -190
  167. package/skills/ecc-recipes/SKILL.md +149 -149
  168. package/skills/ecc-tools-cost-audit/SKILL.md +161 -161
  169. package/skills/email-ops/SKILL.md +122 -122
  170. package/skills/energy-procurement/SKILL.md +228 -228
  171. package/skills/enterprise-agent-ops/SKILL.md +51 -51
  172. package/skills/error-handling/SKILL.md +377 -377
  173. package/skills/eval-harness/SKILL.md +271 -271
  174. package/skills/evm-token-decimals/SKILL.md +131 -131
  175. package/skills/exa-search/SKILL.md +108 -108
  176. package/skills/fal-ai-media/SKILL.md +289 -289
  177. package/skills/fastapi-patterns/SKILL.md +514 -514
  178. package/skills/finance-billing-ops/SKILL.md +128 -128
  179. package/skills/flox-environments/SKILL.md +497 -497
  180. package/skills/flutter-dart-code-review/SKILL.md +436 -436
  181. package/skills/foundation-models-on-device/SKILL.md +243 -243
  182. package/skills/frontend-a11y/SKILL.md +446 -446
  183. package/skills/frontend-design-direction/SKILL.md +93 -93
  184. package/skills/frontend-patterns/SKILL.md +657 -657
  185. package/skills/frontend-slides/SKILL.md +185 -185
  186. package/skills/fsharp-testing/SKILL.md +281 -281
  187. package/skills/gan-style-harness/SKILL.md +279 -279
  188. package/skills/gateguard/SKILL.md +133 -133
  189. package/skills/generating-python-installer/SKILL.md +820 -820
  190. package/skills/git-workflow/SKILL.md +716 -716
  191. package/skills/github-ops/SKILL.md +145 -145
  192. package/skills/golang-patterns/SKILL.md +676 -676
  193. package/skills/golang-testing/SKILL.md +721 -721
  194. package/skills/google-workspace-ops/SKILL.md +96 -96
  195. package/skills/growth-log/SKILL.md +128 -128
  196. package/skills/healthcare-cdss-patterns/SKILL.md +246 -246
  197. package/skills/healthcare-emr-patterns/SKILL.md +160 -160
  198. package/skills/healthcare-eval-harness/SKILL.md +208 -208
  199. package/skills/healthcare-phi-compliance/SKILL.md +146 -146
  200. package/skills/hermes-imports/SKILL.md +89 -89
  201. package/skills/hexagonal-architecture/SKILL.md +277 -277
  202. package/skills/hipaa-compliance/SKILL.md +79 -79
  203. package/skills/homelab-network-readiness/SKILL.md +170 -170
  204. package/skills/homelab-network-setup/SKILL.md +130 -130
  205. package/skills/homelab-pihole-dns/SKILL.md +275 -275
  206. package/skills/homelab-vlan-segmentation/SKILL.md +312 -312
  207. package/skills/homelab-wireguard-vpn/SKILL.md +306 -306
  208. package/skills/hookify-rules/SKILL.md +128 -128
  209. package/skills/inherit-legacy-style/SKILL.md +157 -157
  210. package/skills/intent-driven-development/SKILL.md +360 -360
  211. package/skills/inventory-demand-planning/SKILL.md +247 -247
  212. package/skills/investor-materials/SKILL.md +97 -97
  213. package/skills/investor-outreach/SKILL.md +92 -92
  214. package/skills/ios-icon-gen/SKILL.md +158 -158
  215. package/skills/iterative-retrieval/SKILL.md +212 -212
  216. package/skills/ito-basket-compare/SKILL.md +64 -64
  217. package/skills/ito-compute/SKILL.md +129 -129
  218. package/skills/ito-data-atlas-agent/SKILL.md +64 -64
  219. package/skills/ito-market-intelligence/SKILL.md +61 -61
  220. package/skills/ito-trade-planner/SKILL.md +68 -68
  221. package/skills/java-coding-standards/SKILL.md +384 -384
  222. package/skills/jira-integration/SKILL.md +303 -303
  223. package/skills/jpa-patterns/SKILL.md +152 -152
  224. package/skills/knowledge-ops/SKILL.md +155 -155
  225. package/skills/kotlin-coroutines-flows/SKILL.md +285 -285
  226. package/skills/kotlin-exposed-patterns/SKILL.md +720 -720
  227. package/skills/kotlin-ktor-patterns/SKILL.md +690 -690
  228. package/skills/kotlin-patterns/SKILL.md +712 -712
  229. package/skills/kotlin-testing/SKILL.md +825 -825
  230. package/skills/kubernetes-patterns/SKILL.md +756 -756
  231. package/skills/laravel-patterns/SKILL.md +416 -416
  232. package/skills/laravel-plugin-discovery/SKILL.md +230 -230
  233. package/skills/laravel-security/SKILL.md +948 -948
  234. package/skills/laravel-tdd/SKILL.md +675 -675
  235. package/skills/laravel-verification/SKILL.md +180 -180
  236. package/skills/latency-critical-systems/SKILL.md +75 -75
  237. package/skills/lead-intelligence/SKILL.md +322 -322
  238. package/skills/liquid-glass-design/SKILL.md +279 -279
  239. package/skills/llm-trading-agent-security/SKILL.md +147 -147
  240. package/skills/logistics-exception-management/SKILL.md +222 -222
  241. package/skills/loop-design-check/SKILL.md +143 -143
  242. package/skills/mailtrap-email-integration/SKILL.md +77 -77
  243. package/skills/make-interfaces-feel-better/SKILL.md +152 -152
  244. package/skills/manim-video/SKILL.md +90 -90
  245. package/skills/market-research/SKILL.md +76 -76
  246. package/skills/marketing-campaign/SKILL.md +114 -114
  247. package/skills/mcp-server-patterns/SKILL.md +70 -70
  248. package/skills/messages-ops/SKILL.md +105 -105
  249. package/skills/ml-adoption-playbook/SKILL.md +57 -57
  250. package/skills/mle-workflow/SKILL.md +348 -348
  251. package/skills/motion-advanced/SKILL.md +596 -596
  252. package/skills/motion-foundations/SKILL.md +299 -299
  253. package/skills/motion-patterns/SKILL.md +434 -434
  254. package/skills/motion-ui/SKILL.md +576 -576
  255. package/skills/mysql-patterns/SKILL.md +413 -413
  256. package/skills/nanoclaw-repl/SKILL.md +34 -34
  257. package/skills/nestjs-patterns/SKILL.md +231 -231
  258. package/skills/netmiko-ssh-automation/SKILL.md +174 -174
  259. package/skills/network-bgp-diagnostics/SKILL.md +168 -168
  260. package/skills/network-config-validation/SKILL.md +211 -211
  261. package/skills/network-interface-health/SKILL.md +153 -153
  262. package/skills/nextjs-turbopack/SKILL.md +58 -58
  263. package/skills/nodejs-keccak256/SKILL.md +103 -103
  264. package/skills/nutrient-document-processing/SKILL.md +168 -168
  265. package/skills/nuxt4-patterns/SKILL.md +101 -101
  266. package/skills/openclaw-persona-forge/SKILL.md +289 -289
  267. package/skills/openclaw-persona-forge/references/avatar-style.md +124 -124
  268. package/skills/openclaw-persona-forge/references/boundary-rules.md +53 -53
  269. package/skills/openclaw-persona-forge/references/error-handling.md +53 -53
  270. package/skills/openclaw-persona-forge/references/identity-tension.md +48 -48
  271. package/skills/openclaw-persona-forge/references/naming-system.md +39 -39
  272. package/skills/openclaw-persona-forge/references/output-template.md +166 -166
  273. package/skills/opensource-pipeline/SKILL.md +256 -256
  274. package/skills/orch-add-feature/SKILL.md +45 -45
  275. package/skills/orch-build-mvp/SKILL.md +49 -49
  276. package/skills/orch-change-feature/SKILL.md +43 -43
  277. package/skills/orch-fix-defect/SKILL.md +43 -43
  278. package/skills/orch-pipeline/SKILL.md +121 -121
  279. package/skills/orch-refine-code/SKILL.md +44 -44
  280. package/skills/parallel-execution-optimizer/SKILL.md +74 -74
  281. package/skills/perl-patterns/SKILL.md +505 -505
  282. package/skills/perl-security/SKILL.md +504 -504
  283. package/skills/perl-testing/SKILL.md +476 -476
  284. package/skills/plan-canvas/SKILL.md +153 -153
  285. package/skills/plan-orchestrate/SKILL.md +263 -263
  286. package/skills/plankton-code-quality/SKILL.md +237 -237
  287. package/skills/postgres-patterns/SKILL.md +148 -148
  288. package/skills/prediction-market-oracle-research/SKILL.md +64 -64
  289. package/skills/prediction-market-risk-review/SKILL.md +61 -61
  290. package/skills/premium-web-design/SKILL.md +154 -154
  291. package/skills/prisma-patterns/SKILL.md +401 -401
  292. package/skills/product-capability/SKILL.md +142 -142
  293. package/skills/product-lens/SKILL.md +93 -93
  294. package/skills/production-audit/SKILL.md +207 -207
  295. package/skills/production-scheduling/SKILL.md +238 -238
  296. package/skills/project-flow-ops/SKILL.md +112 -112
  297. package/skills/prompt-optimizer/SKILL.md +398 -398
  298. package/skills/python-patterns/SKILL.md +751 -751
  299. package/skills/python-testing/SKILL.md +817 -817
  300. package/skills/pytorch-patterns/SKILL.md +397 -397
  301. package/skills/quality-nonconformance/SKILL.md +260 -260
  302. package/skills/quarkus-patterns/SKILL.md +723 -723
  303. package/skills/quarkus-security/SKILL.md +468 -468
  304. package/skills/quarkus-tdd/SKILL.md +812 -812
  305. package/skills/quarkus-verification/SKILL.md +480 -480
  306. package/skills/ralphinho-rfc-pipeline/SKILL.md +68 -68
  307. package/skills/react-native-patterns/SKILL.md +326 -326
  308. package/skills/react-patterns/SKILL.md +342 -342
  309. package/skills/react-performance/SKILL.md +575 -575
  310. package/skills/react-testing/SKILL.md +424 -424
  311. package/skills/recsys-pipeline-architect/SKILL.md +115 -115
  312. package/skills/recursive-decision-ledger/SKILL.md +81 -81
  313. package/skills/redis-patterns/SKILL.md +404 -404
  314. package/skills/regex-vs-llm-structured-text/SKILL.md +221 -221
  315. package/skills/remotion-video-creation/SKILL.md +43 -43
  316. package/skills/repo-scan/SKILL.md +79 -79
  317. package/skills/research-ops/SKILL.md +113 -113
  318. package/skills/returns-reverse-logistics/SKILL.md +240 -240
  319. package/skills/rules-distill/SKILL.md +265 -265
  320. package/skills/rust-patterns/SKILL.md +500 -500
  321. package/skills/rust-testing/SKILL.md +501 -501
  322. package/skills/safety-guard/SKILL.md +76 -76
  323. package/skills/santa-method/SKILL.md +307 -307
  324. package/skills/scientific-db-pubmed-database/SKILL.md +176 -176
  325. package/skills/scientific-db-uspto-database/SKILL.md +178 -178
  326. package/skills/scientific-pkg-gget/SKILL.md +167 -167
  327. package/skills/scientific-thinking-literature-review/SKILL.md +193 -193
  328. package/skills/scientific-thinking-scholar-evaluation/SKILL.md +161 -161
  329. package/skills/search-first/SKILL.md +183 -183
  330. package/skills/security-bounty-hunter/SKILL.md +100 -100
  331. package/skills/security-review/SKILL.md +504 -504
  332. package/skills/security-scan/SKILL.md +166 -166
  333. package/skills/seo/SKILL.md +155 -155
  334. package/skills/skill-comply/SKILL.md +59 -59
  335. package/skills/skill-scout/SKILL.md +141 -141
  336. package/skills/skill-stocktake/SKILL.md +195 -195
  337. package/skills/social-graph-ranker/SKILL.md +155 -155
  338. package/skills/social-publisher/SKILL.md +130 -130
  339. package/skills/springboot-patterns/SKILL.md +315 -315
  340. package/skills/springboot-security/SKILL.md +273 -273
  341. package/skills/springboot-tdd/SKILL.md +159 -159
  342. package/skills/springboot-verification/SKILL.md +232 -232
  343. package/skills/strategic-compact/SKILL.md +142 -142
  344. package/skills/swift-actor-persistence/SKILL.md +144 -144
  345. package/skills/swift-concurrency-6-2/SKILL.md +216 -216
  346. package/skills/swift-protocol-di-testing/SKILL.md +191 -191
  347. package/skills/swiftui-patterns/SKILL.md +259 -259
  348. package/skills/taste/SKILL.md +264 -264
  349. package/skills/taste/references/genre-taxonomy.md +87 -87
  350. package/skills/tdd-workflow/SKILL.md +583 -583
  351. package/skills/team-agent-orchestration/SKILL.md +111 -111
  352. package/skills/team-builder/SKILL.md +169 -169
  353. package/skills/terminal-ops/SKILL.md +110 -110
  354. package/skills/tinystruct-patterns/SKILL.md +279 -279
  355. package/skills/tinystruct-patterns/references/architecture.md +90 -90
  356. package/skills/tinystruct-patterns/references/data-handling.md +60 -60
  357. package/skills/tinystruct-patterns/references/database.md +99 -99
  358. package/skills/tinystruct-patterns/references/routing.md +64 -64
  359. package/skills/tinystruct-patterns/references/system-usage.md +97 -97
  360. package/skills/tinystruct-patterns/references/testing.md +72 -72
  361. package/skills/token-budget-advisor/SKILL.md +134 -134
  362. package/skills/ui-demo/SKILL.md +466 -466
  363. package/skills/ui-to-vue/SKILL.md +135 -135
  364. package/skills/uncloud/SKILL.md +344 -344
  365. package/skills/unified-memory/SKILL.md +170 -170
  366. package/skills/unified-notifications-ops/SKILL.md +188 -188
  367. package/skills/verification-loop/SKILL.md +129 -129
  368. package/skills/video-editing/SKILL.md +311 -311
  369. package/skills/videodb/SKILL.md +375 -375
  370. package/skills/visa-doc-translate/SKILL.md +117 -117
  371. package/skills/vite-patterns/SKILL.md +450 -450
  372. package/skills/vue-patterns/SKILL.md +471 -471
  373. package/skills/windows-desktop-e2e/SKILL.md +888 -888
  374. package/skills/workspace-surface-audit/SKILL.md +126 -126
  375. package/skills/x-api/SKILL.md +235 -235
@@ -1,514 +1,514 @@
1
- ---
2
- name: fastapi-patterns
3
- description: FastAPI best practices covering project structure, Pydantic v2 schemas, dependency injection, async handlers, authentication, authorization, transactional service layers, and testing with httpx and pytest.
4
- metadata:
5
- origin: ECC
6
- ---
7
-
8
- # FastAPI Patterns
9
-
10
- Modern, production-grade FastAPI development: project layout, Pydantic v2 schemas, dependency injection, async patterns, auth, transactional service methods, and testing.
11
-
12
- ## Project Structure
13
-
14
- ```text
15
- my_app/
16
- |-- app/
17
- | |-- main.py # App factory, lifespan, middleware
18
- | |-- config.py # Settings via pydantic-settings
19
- | |-- dependencies.py # Shared FastAPI dependencies
20
- | |-- database.py # SQLAlchemy engine + session
21
- | |-- routers/
22
- | | `-- users.py
23
- | |-- models/ # SQLAlchemy ORM models
24
- | | `-- user.py
25
- | |-- schemas/ # Pydantic request/response schemas
26
- | | `-- user.py
27
- | `-- services/ # Business logic layer
28
- | `-- user_service.py
29
- |-- tests/
30
- | |-- conftest.py
31
- | `-- test_users.py
32
- |-- pyproject.toml
33
- `-- .env
34
- ```
35
-
36
- ---
37
-
38
- ## App Factory and Lifespan
39
-
40
- ```python
41
- # app/main.py
42
- from contextlib import asynccontextmanager
43
- from fastapi import FastAPI
44
- from fastapi.middleware.cors import CORSMiddleware
45
-
46
- from app.config import settings
47
- from app.database import engine, Base
48
- from app.routers import users
49
-
50
-
51
- @asynccontextmanager
52
- async def lifespan(app: FastAPI):
53
- # Automatically create tables on startup for ease of use in dev/demo environments.
54
- # For strict production applications, manage schemas via Alembic migrations instead.
55
- async with engine.begin() as conn:
56
- await conn.run_sync(Base.metadata.create_all)
57
- yield
58
- # Shutdown: close pooled resources.
59
- await engine.dispose()
60
-
61
-
62
- def create_app() -> FastAPI:
63
- app = FastAPI(
64
- title=settings.app_name,
65
- version=settings.app_version,
66
- lifespan=lifespan,
67
- )
68
-
69
- app.add_middleware(
70
- CORSMiddleware,
71
- allow_origins=settings.allowed_origins,
72
- allow_credentials=settings.allow_credentials,
73
- allow_methods=settings.allowed_methods,
74
- allow_headers=settings.allowed_headers,
75
- )
76
-
77
- app.include_router(users.router, prefix="/users", tags=["users"])
78
-
79
- return app
80
-
81
-
82
- app = create_app()
83
- ```
84
-
85
- ---
86
-
87
- ## Configuration with pydantic-settings
88
-
89
- ```python
90
- # app/config.py
91
- from pydantic_settings import BaseSettings, SettingsConfigDict
92
-
93
-
94
- class Settings(BaseSettings):
95
- model_config = SettingsConfigDict(env_file=".env", env_file_encoding="utf-8")
96
-
97
- app_name: str = "My App"
98
- app_version: str = "0.1.0"
99
- debug: bool = False
100
-
101
- database_url: str
102
- secret_key: str
103
- algorithm: str = "HS256"
104
- access_token_expire_minutes: int = 30
105
-
106
- # Pydantic-settings v2 safely evaluates mutable list literals directly
107
- allowed_origins: list[str] = ["http://localhost:3000"]
108
- allowed_methods: list[str] = ["GET", "POST", "PATCH", "DELETE", "OPTIONS"]
109
- allowed_headers: list[str] = ["Authorization", "Content-Type"]
110
- allow_credentials: bool = True
111
-
112
-
113
- settings = Settings()
114
- ```
115
-
116
- ---
117
-
118
- ## Pydantic Schemas (v2)
119
-
120
- ```python
121
- # app/schemas/user.py
122
- from datetime import datetime
123
- from pydantic import BaseModel, EmailStr, Field, model_validator
124
-
125
-
126
- class UserBase(BaseModel):
127
- email: EmailStr
128
- username: str = Field(min_length=3, max_length=50)
129
-
130
-
131
- class UserCreate(UserBase):
132
- password: str = Field(min_length=8)
133
- password_confirm: str
134
-
135
- @model_validator(mode="after")
136
- def passwords_match(self) -> "UserCreate":
137
- if self.password != self.password_confirm:
138
- raise ValueError("Passwords do not match")
139
- return self
140
-
141
-
142
- class UserUpdate(BaseModel):
143
- username: str | None = Field(default=None, min_length=3, max_length=50)
144
- email: EmailStr | None = None
145
-
146
-
147
- class UserResponse(UserBase):
148
- id: int
149
- is_active: bool
150
- created_at: datetime
151
-
152
- model_config = {"from_attributes": True}
153
-
154
-
155
- class UserListResponse(BaseModel):
156
- total: int
157
- items: list[UserResponse]
158
- ```
159
-
160
- ---
161
-
162
- ## Dependency Injection
163
-
164
- ```python
165
- # app/dependencies.py
166
- from typing import Annotated, AsyncGenerator
167
- from fastapi import Depends, HTTPException, status
168
- from fastapi.security import OAuth2PasswordBearer
169
- from jose import JWTError, jwt
170
- from sqlalchemy.ext.asyncio import AsyncSession
171
-
172
- from app.config import settings
173
- from app.database import AsyncSessionLocal
174
- from app.models.user import User
175
-
176
- oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/users/token")
177
-
178
-
179
- async def get_db() -> AsyncGenerator[AsyncSession, None]:
180
- async with AsyncSessionLocal() as session:
181
- try:
182
- yield session
183
- except Exception:
184
- await session.rollback()
185
- raise
186
-
187
-
188
- async def get_current_user(
189
- token: Annotated[str, Depends(oauth2_scheme)],
190
- db: Annotated[AsyncSession, Depends(get_db)],
191
- ) -> User:
192
- credentials_exception = HTTPException(
193
- status_code=status.HTTP_401_UNAUTHORIZED,
194
- detail="Could not validate credentials",
195
- headers={"WWW-Authenticate": "Bearer"},
196
- )
197
- try:
198
- payload = jwt.decode(token, settings.secret_key, algorithms=[settings.algorithm])
199
- subject = payload.get("sub")
200
- if subject is None:
201
- raise credentials_exception
202
- user_id = int(subject)
203
- except (JWTError, TypeError, ValueError):
204
- raise credentials_exception
205
-
206
- user = await db.get(User, user_id)
207
- if user is None:
208
- raise credentials_exception
209
- return user
210
-
211
-
212
- async def get_current_active_user(
213
- current_user: Annotated[User, Depends(get_current_user)],
214
- ) -> User:
215
- if not current_user.is_active:
216
- raise HTTPException(status_code=status.HTTP_403_FORBIDDEN, detail="Inactive user")
217
- return current_user
218
-
219
-
220
- DbDep = Annotated[AsyncSession, Depends(get_db)]
221
- CurrentUserDep = Annotated[User, Depends(get_current_user)]
222
- ActiveUserDep = Annotated[User, Depends(get_current_active_user)]
223
- ```
224
-
225
- ---
226
-
227
- ## Router and Endpoint Design
228
-
229
- ```python
230
- # app/routers/users.py
231
- from typing import Annotated
232
- from fastapi import APIRouter, HTTPException, Query, status
233
- from fastapi.security import OAuth2PasswordRequestForm
234
-
235
- from app.dependencies import ActiveUserDep, DbDep
236
- from app.schemas.user import UserCreate, UserResponse, UserUpdate, UserListResponse
237
- from app.services.user_service import DuplicateUserError, UserService
238
-
239
- router = APIRouter()
240
-
241
-
242
- @router.post("/", response_model=UserResponse, status_code=status.HTTP_201_CREATED)
243
- async def create_user(payload: UserCreate, db: DbDep) -> UserResponse:
244
- service = UserService(db)
245
- try:
246
- return await service.create(payload)
247
- except DuplicateUserError:
248
- raise HTTPException(status_code=400, detail="Email already registered")
249
-
250
-
251
- @router.get("/me", response_model=UserResponse)
252
- async def get_me(current_user: ActiveUserDep) -> UserResponse:
253
- return current_user
254
-
255
-
256
- @router.get("/", response_model=UserListResponse)
257
- async def list_users(
258
- db: DbDep,
259
- current_user: ActiveUserDep,
260
- skip: Annotated[int, Query(ge=0)] = 0,
261
- limit: Annotated[int, Query(ge=1, le=100)] = 20,
262
- ) -> UserListResponse:
263
- service = UserService(db)
264
- users, total = await service.list(skip=skip, limit=limit)
265
- return UserListResponse(total=total, items=users)
266
-
267
-
268
- @router.patch("/{user_id}", response_model=UserResponse)
269
- async def update_user(
270
- user_id: int,
271
- payload: UserUpdate,
272
- db: DbDep,
273
- current_user: ActiveUserDep,
274
- ) -> UserResponse:
275
- if current_user.id != user_id:
276
- raise HTTPException(status_code=403, detail="Not authorized")
277
- service = UserService(db)
278
- try:
279
- user = await service.update(user_id, payload)
280
- except DuplicateUserError:
281
- raise HTTPException(status_code=400, detail="Email already registered")
282
- if user is None:
283
- raise HTTPException(status_code=404, detail="User not found")
284
- return user
285
-
286
-
287
- @router.post("/token")
288
- async def login(
289
- form_data: Annotated[OAuth2PasswordRequestForm, Depends()],
290
- db: DbDep,
291
- ) -> dict[str, str]:
292
- service = UserService(db)
293
- token = await service.authenticate(form_data.username, form_data.password)
294
- if token is None:
295
- raise HTTPException(
296
- status_code=status.HTTP_401_UNAUTHORIZED,
297
- detail="Incorrect username or password",
298
- headers={"WWW-Authenticate": "Bearer"},
299
- )
300
- return {"access_token": token, "token_type": "bearer"}
301
- ```
302
-
303
- ---
304
-
305
- ## Service Layer
306
-
307
- ```python
308
- # app/services/user_service.py
309
- from datetime import datetime, timedelta, timezone
310
-
311
- from jose import jwt
312
- from passlib.context import CryptContext
313
- from sqlalchemy import func, select
314
- from sqlalchemy.exc import IntegrityError
315
- from sqlalchemy.ext.asyncio import AsyncSession
316
-
317
- from app.config import settings
318
- from app.models.user import User
319
- from app.schemas.user import UserCreate, UserUpdate
320
-
321
- pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")
322
-
323
-
324
- class DuplicateUserError(Exception):
325
- """Raised when a unique user field conflicts with an existing row."""
326
-
327
-
328
- class UserService:
329
- def __init__(self, db: AsyncSession) -> None:
330
- self.db = db
331
-
332
- async def get_by_email(self, email: str) -> User | None:
333
- result = await self.db.execute(select(User).where(User.email == email))
334
- return result.scalar_one_or_none()
335
-
336
- async def create(self, payload: UserCreate) -> User:
337
- user = User(
338
- email=payload.email,
339
- username=payload.username,
340
- hashed_password=pwd_context.hash(payload.password),
341
- )
342
- self.db.add(user)
343
- try:
344
- # Rely on atomic DB constraints rather than race-prone application-level prechecks
345
- await self.db.commit()
346
- except IntegrityError as exc:
347
- await self.db.rollback()
348
- raise DuplicateUserError from exc
349
- await self.db.refresh(user)
350
- return user
351
-
352
- async def list(self, skip: int = 0, limit: int = 20) -> tuple[list[User], int]:
353
- total_result = await self.db.execute(select(func.count(User.id)))
354
- total = total_result.scalar_one()
355
- # Enforce explicit deterministic ordering to ensure reliable pagination
356
- result = await self.db.execute(
357
- select(User).order_by(User.id).offset(skip).limit(limit)
358
- )
359
- return list(result.scalars()), total
360
-
361
- async def update(self, user_id: int, payload: UserUpdate) -> User | None:
362
- user = await self.db.get(User, user_id)
363
- if user is None:
364
- return None
365
- for field, value in payload.model_dump(exclude_unset=True).items():
366
- setattr(user, field, value)
367
- try:
368
- await self.db.commit()
369
- except IntegrityError as exc:
370
- await self.db.rollback()
371
- raise DuplicateUserError from exc
372
- await self.db.refresh(user)
373
- return user
374
-
375
- async def authenticate(self, email: str, password: str) -> str | None:
376
- user = await self.get_by_email(email)
377
- if user is None or not pwd_context.verify(password, user.hashed_password):
378
- return None
379
- expire = datetime.now(timezone.utc) + timedelta(
380
- minutes=settings.access_token_expire_minutes
381
- )
382
- return jwt.encode(
383
- {"sub": str(user.id), "exp": expire},
384
- settings.secret_key,
385
- algorithm=settings.algorithm,
386
- )
387
- ```
388
-
389
- > **Note on Database Design:** Application-level unique handling requires an underlying unique database index (e.g., `unique=True` on your SQLAlchemy mapping attributes). Without underlying constraints, application layer error-catching cannot safely prevent concurrent race conditions.
390
-
391
- ---
392
-
393
- ## Testing with httpx and pytest
394
-
395
- ```python
396
- # tests/conftest.py
397
- import pytest_asyncio
398
- from httpx import ASGITransport, AsyncClient
399
- from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine
400
-
401
- from app.database import Base
402
- from app.dependencies import get_db
403
- from app.main import create_app
404
-
405
- TEST_DATABASE_URL = "sqlite+aiosqlite:///:memory:"
406
-
407
- engine = create_async_engine(TEST_DATABASE_URL)
408
- TestingSessionLocal = async_sessionmaker(engine, expire_on_commit=False)
409
-
410
-
411
- @pytest_asyncio.fixture(autouse=True)
412
- async def setup_db():
413
- async with engine.begin() as conn:
414
- await conn.run_sync(Base.metadata.create_all)
415
- yield
416
- async with engine.begin() as conn:
417
- await conn.run_sync(Base.metadata.drop_all)
418
-
419
-
420
- @pytest_asyncio.fixture
421
- async def db_session():
422
- async with TestingSessionLocal() as session:
423
- yield session
424
- await session.rollback()
425
-
426
-
427
- @pytest_asyncio.fixture
428
- async def client(db_session: AsyncSession):
429
- app = create_app()
430
-
431
- async def override_get_db():
432
- yield db_session
433
-
434
- app.dependency_overrides[get_db] = override_get_db
435
-
436
- async with AsyncClient(
437
- transport=ASGITransport(app=app), base_url="http://test"
438
- ) as ac:
439
- yield ac
440
-
441
-
442
- @pytest_asyncio.fixture
443
- async def registered_user(client: AsyncClient) -> dict:
444
- resp = await client.post("/users/", json={
445
- "email": "test@example.com",
446
- "username": "testuser",
447
- "password": "securepass1",
448
- "password_confirm": "securepass1",
449
- })
450
- assert resp.status_code == 201
451
- return resp.json()
452
-
453
-
454
- @pytest_asyncio.fixture
455
- async def auth_token(client: AsyncClient, registered_user: dict) -> str:
456
- resp = await client.post("/users/token", data={
457
- "username": "test@example.com",
458
- "password": "securepass1",
459
- })
460
- assert resp.status_code == 200
461
- return resp.json()["access_token"]
462
-
463
-
464
- @pytest_asyncio.fixture
465
- async def auth_client(client: AsyncClient, auth_token: str) -> AsyncClient:
466
- client.headers.update({"Authorization": f"Bearer {auth_token}"})
467
- return client
468
- ```
469
-
470
- ---
471
-
472
- ## Anti-Patterns
473
-
474
- ```python
475
- # Bad: business logic inside route handlers.
476
- @router.post("/users/")
477
- async def create_user(payload: UserCreate, db: DbDep):
478
- hashed = bcrypt.hash(payload.password)
479
- user = User(email=payload.email, hashed_password=hashed)
480
- db.add(user)
481
- await db.commit()
482
- return user
483
-
484
- # Good: thin route, transactional service handling.
485
- @router.post("/users/", response_model=UserResponse, status_code=201)
486
- async def create_user(payload: UserCreate, db: DbDep):
487
- try:
488
- return await UserService(db).create(payload)
489
- except DuplicateUserError:
490
- raise HTTPException(status_code=400, detail="Email already registered")
491
-
492
-
493
- # Bad: sync DB calls in async routes block the event loop.
494
- @router.get("/items/")
495
- async def list_items(db: Session = Depends(get_db)):
496
- return db.query(Item).all()
497
-
498
- # Good: use async SQLAlchemy executions.
499
- @router.get("/items/")
500
- async def list_items(db: AsyncSession = Depends(get_db)):
501
- result = await db.execute(select(Item))
502
- return result.scalars().all()
503
- ```
504
-
505
- ---
506
-
507
- ## Best Practices
508
-
509
- - Always declare a typed `response_model` to prevent accidental PII/data leaks and output clean OpenAPI schemas.
510
- - Consolidate standard middleware dependency injections via type-aliasing: `DbDep = Annotated[AsyncSession, Depends(get_db)]`.
511
- - Wrap database mutation boundaries gracefully within transactions inside your service layer, catching structural database errors directly.
512
- - Parse JWT parameters defensively, expecting potential string/integer cast mismatches from modern payload variations.
513
- - Enforce deterministic sorting (e.g., `.order_by(Model.id)`) on all offset/limit paginated endpoints to avoid data skips.
514
- - Isolate authorization checks from core authentication dependencies to provide precise REST status signals (`401` vs `403`).
1
+ ---
2
+ name: fastapi-patterns
3
+ description: FastAPI best practices covering project structure, Pydantic v2 schemas, dependency injection, async handlers, authentication, authorization, transactional service layers, and testing with httpx and pytest.
4
+ metadata:
5
+ origin: ECC
6
+ ---
7
+
8
+ # FastAPI Patterns
9
+
10
+ Modern, production-grade FastAPI development: project layout, Pydantic v2 schemas, dependency injection, async patterns, auth, transactional service methods, and testing.
11
+
12
+ ## Project Structure
13
+
14
+ ```text
15
+ my_app/
16
+ |-- app/
17
+ | |-- main.py # App factory, lifespan, middleware
18
+ | |-- config.py # Settings via pydantic-settings
19
+ | |-- dependencies.py # Shared FastAPI dependencies
20
+ | |-- database.py # SQLAlchemy engine + session
21
+ | |-- routers/
22
+ | | `-- users.py
23
+ | |-- models/ # SQLAlchemy ORM models
24
+ | | `-- user.py
25
+ | |-- schemas/ # Pydantic request/response schemas
26
+ | | `-- user.py
27
+ | `-- services/ # Business logic layer
28
+ | `-- user_service.py
29
+ |-- tests/
30
+ | |-- conftest.py
31
+ | `-- test_users.py
32
+ |-- pyproject.toml
33
+ `-- .env
34
+ ```
35
+
36
+ ---
37
+
38
+ ## App Factory and Lifespan
39
+
40
+ ```python
41
+ # app/main.py
42
+ from contextlib import asynccontextmanager
43
+ from fastapi import FastAPI
44
+ from fastapi.middleware.cors import CORSMiddleware
45
+
46
+ from app.config import settings
47
+ from app.database import engine, Base
48
+ from app.routers import users
49
+
50
+
51
+ @asynccontextmanager
52
+ async def lifespan(app: FastAPI):
53
+ # Automatically create tables on startup for ease of use in dev/demo environments.
54
+ # For strict production applications, manage schemas via Alembic migrations instead.
55
+ async with engine.begin() as conn:
56
+ await conn.run_sync(Base.metadata.create_all)
57
+ yield
58
+ # Shutdown: close pooled resources.
59
+ await engine.dispose()
60
+
61
+
62
+ def create_app() -> FastAPI:
63
+ app = FastAPI(
64
+ title=settings.app_name,
65
+ version=settings.app_version,
66
+ lifespan=lifespan,
67
+ )
68
+
69
+ app.add_middleware(
70
+ CORSMiddleware,
71
+ allow_origins=settings.allowed_origins,
72
+ allow_credentials=settings.allow_credentials,
73
+ allow_methods=settings.allowed_methods,
74
+ allow_headers=settings.allowed_headers,
75
+ )
76
+
77
+ app.include_router(users.router, prefix="/users", tags=["users"])
78
+
79
+ return app
80
+
81
+
82
+ app = create_app()
83
+ ```
84
+
85
+ ---
86
+
87
+ ## Configuration with pydantic-settings
88
+
89
+ ```python
90
+ # app/config.py
91
+ from pydantic_settings import BaseSettings, SettingsConfigDict
92
+
93
+
94
+ class Settings(BaseSettings):
95
+ model_config = SettingsConfigDict(env_file=".env", env_file_encoding="utf-8")
96
+
97
+ app_name: str = "My App"
98
+ app_version: str = "0.1.0"
99
+ debug: bool = False
100
+
101
+ database_url: str
102
+ secret_key: str
103
+ algorithm: str = "HS256"
104
+ access_token_expire_minutes: int = 30
105
+
106
+ # Pydantic-settings v2 safely evaluates mutable list literals directly
107
+ allowed_origins: list[str] = ["http://localhost:3000"]
108
+ allowed_methods: list[str] = ["GET", "POST", "PATCH", "DELETE", "OPTIONS"]
109
+ allowed_headers: list[str] = ["Authorization", "Content-Type"]
110
+ allow_credentials: bool = True
111
+
112
+
113
+ settings = Settings()
114
+ ```
115
+
116
+ ---
117
+
118
+ ## Pydantic Schemas (v2)
119
+
120
+ ```python
121
+ # app/schemas/user.py
122
+ from datetime import datetime
123
+ from pydantic import BaseModel, EmailStr, Field, model_validator
124
+
125
+
126
+ class UserBase(BaseModel):
127
+ email: EmailStr
128
+ username: str = Field(min_length=3, max_length=50)
129
+
130
+
131
+ class UserCreate(UserBase):
132
+ password: str = Field(min_length=8)
133
+ password_confirm: str
134
+
135
+ @model_validator(mode="after")
136
+ def passwords_match(self) -> "UserCreate":
137
+ if self.password != self.password_confirm:
138
+ raise ValueError("Passwords do not match")
139
+ return self
140
+
141
+
142
+ class UserUpdate(BaseModel):
143
+ username: str | None = Field(default=None, min_length=3, max_length=50)
144
+ email: EmailStr | None = None
145
+
146
+
147
+ class UserResponse(UserBase):
148
+ id: int
149
+ is_active: bool
150
+ created_at: datetime
151
+
152
+ model_config = {"from_attributes": True}
153
+
154
+
155
+ class UserListResponse(BaseModel):
156
+ total: int
157
+ items: list[UserResponse]
158
+ ```
159
+
160
+ ---
161
+
162
+ ## Dependency Injection
163
+
164
+ ```python
165
+ # app/dependencies.py
166
+ from typing import Annotated, AsyncGenerator
167
+ from fastapi import Depends, HTTPException, status
168
+ from fastapi.security import OAuth2PasswordBearer
169
+ from jose import JWTError, jwt
170
+ from sqlalchemy.ext.asyncio import AsyncSession
171
+
172
+ from app.config import settings
173
+ from app.database import AsyncSessionLocal
174
+ from app.models.user import User
175
+
176
+ oauth2_scheme = OAuth2PasswordBearer(tokenUrl="/users/token")
177
+
178
+
179
+ async def get_db() -> AsyncGenerator[AsyncSession, None]:
180
+ async with AsyncSessionLocal() as session:
181
+ try:
182
+ yield session
183
+ except Exception:
184
+ await session.rollback()
185
+ raise
186
+
187
+
188
+ async def get_current_user(
189
+ token: Annotated[str, Depends(oauth2_scheme)],
190
+ db: Annotated[AsyncSession, Depends(get_db)],
191
+ ) -> User:
192
+ credentials_exception = HTTPException(
193
+ status_code=status.HTTP_401_UNAUTHORIZED,
194
+ detail="Could not validate credentials",
195
+ headers={"WWW-Authenticate": "Bearer"},
196
+ )
197
+ try:
198
+ payload = jwt.decode(token, settings.secret_key, algorithms=[settings.algorithm])
199
+ subject = payload.get("sub")
200
+ if subject is None:
201
+ raise credentials_exception
202
+ user_id = int(subject)
203
+ except (JWTError, TypeError, ValueError):
204
+ raise credentials_exception
205
+
206
+ user = await db.get(User, user_id)
207
+ if user is None:
208
+ raise credentials_exception
209
+ return user
210
+
211
+
212
+ async def get_current_active_user(
213
+ current_user: Annotated[User, Depends(get_current_user)],
214
+ ) -> User:
215
+ if not current_user.is_active:
216
+ raise HTTPException(status_code=status.HTTP_403_FORBIDDEN, detail="Inactive user")
217
+ return current_user
218
+
219
+
220
+ DbDep = Annotated[AsyncSession, Depends(get_db)]
221
+ CurrentUserDep = Annotated[User, Depends(get_current_user)]
222
+ ActiveUserDep = Annotated[User, Depends(get_current_active_user)]
223
+ ```
224
+
225
+ ---
226
+
227
+ ## Router and Endpoint Design
228
+
229
+ ```python
230
+ # app/routers/users.py
231
+ from typing import Annotated
232
+ from fastapi import APIRouter, HTTPException, Query, status
233
+ from fastapi.security import OAuth2PasswordRequestForm
234
+
235
+ from app.dependencies import ActiveUserDep, DbDep
236
+ from app.schemas.user import UserCreate, UserResponse, UserUpdate, UserListResponse
237
+ from app.services.user_service import DuplicateUserError, UserService
238
+
239
+ router = APIRouter()
240
+
241
+
242
+ @router.post("/", response_model=UserResponse, status_code=status.HTTP_201_CREATED)
243
+ async def create_user(payload: UserCreate, db: DbDep) -> UserResponse:
244
+ service = UserService(db)
245
+ try:
246
+ return await service.create(payload)
247
+ except DuplicateUserError:
248
+ raise HTTPException(status_code=400, detail="Email already registered")
249
+
250
+
251
+ @router.get("/me", response_model=UserResponse)
252
+ async def get_me(current_user: ActiveUserDep) -> UserResponse:
253
+ return current_user
254
+
255
+
256
+ @router.get("/", response_model=UserListResponse)
257
+ async def list_users(
258
+ db: DbDep,
259
+ current_user: ActiveUserDep,
260
+ skip: Annotated[int, Query(ge=0)] = 0,
261
+ limit: Annotated[int, Query(ge=1, le=100)] = 20,
262
+ ) -> UserListResponse:
263
+ service = UserService(db)
264
+ users, total = await service.list(skip=skip, limit=limit)
265
+ return UserListResponse(total=total, items=users)
266
+
267
+
268
+ @router.patch("/{user_id}", response_model=UserResponse)
269
+ async def update_user(
270
+ user_id: int,
271
+ payload: UserUpdate,
272
+ db: DbDep,
273
+ current_user: ActiveUserDep,
274
+ ) -> UserResponse:
275
+ if current_user.id != user_id:
276
+ raise HTTPException(status_code=403, detail="Not authorized")
277
+ service = UserService(db)
278
+ try:
279
+ user = await service.update(user_id, payload)
280
+ except DuplicateUserError:
281
+ raise HTTPException(status_code=400, detail="Email already registered")
282
+ if user is None:
283
+ raise HTTPException(status_code=404, detail="User not found")
284
+ return user
285
+
286
+
287
+ @router.post("/token")
288
+ async def login(
289
+ form_data: Annotated[OAuth2PasswordRequestForm, Depends()],
290
+ db: DbDep,
291
+ ) -> dict[str, str]:
292
+ service = UserService(db)
293
+ token = await service.authenticate(form_data.username, form_data.password)
294
+ if token is None:
295
+ raise HTTPException(
296
+ status_code=status.HTTP_401_UNAUTHORIZED,
297
+ detail="Incorrect username or password",
298
+ headers={"WWW-Authenticate": "Bearer"},
299
+ )
300
+ return {"access_token": token, "token_type": "bearer"}
301
+ ```
302
+
303
+ ---
304
+
305
+ ## Service Layer
306
+
307
+ ```python
308
+ # app/services/user_service.py
309
+ from datetime import datetime, timedelta, timezone
310
+
311
+ from jose import jwt
312
+ from passlib.context import CryptContext
313
+ from sqlalchemy import func, select
314
+ from sqlalchemy.exc import IntegrityError
315
+ from sqlalchemy.ext.asyncio import AsyncSession
316
+
317
+ from app.config import settings
318
+ from app.models.user import User
319
+ from app.schemas.user import UserCreate, UserUpdate
320
+
321
+ pwd_context = CryptContext(schemes=["bcrypt"], deprecated="auto")
322
+
323
+
324
+ class DuplicateUserError(Exception):
325
+ """Raised when a unique user field conflicts with an existing row."""
326
+
327
+
328
+ class UserService:
329
+ def __init__(self, db: AsyncSession) -> None:
330
+ self.db = db
331
+
332
+ async def get_by_email(self, email: str) -> User | None:
333
+ result = await self.db.execute(select(User).where(User.email == email))
334
+ return result.scalar_one_or_none()
335
+
336
+ async def create(self, payload: UserCreate) -> User:
337
+ user = User(
338
+ email=payload.email,
339
+ username=payload.username,
340
+ hashed_password=pwd_context.hash(payload.password),
341
+ )
342
+ self.db.add(user)
343
+ try:
344
+ # Rely on atomic DB constraints rather than race-prone application-level prechecks
345
+ await self.db.commit()
346
+ except IntegrityError as exc:
347
+ await self.db.rollback()
348
+ raise DuplicateUserError from exc
349
+ await self.db.refresh(user)
350
+ return user
351
+
352
+ async def list(self, skip: int = 0, limit: int = 20) -> tuple[list[User], int]:
353
+ total_result = await self.db.execute(select(func.count(User.id)))
354
+ total = total_result.scalar_one()
355
+ # Enforce explicit deterministic ordering to ensure reliable pagination
356
+ result = await self.db.execute(
357
+ select(User).order_by(User.id).offset(skip).limit(limit)
358
+ )
359
+ return list(result.scalars()), total
360
+
361
+ async def update(self, user_id: int, payload: UserUpdate) -> User | None:
362
+ user = await self.db.get(User, user_id)
363
+ if user is None:
364
+ return None
365
+ for field, value in payload.model_dump(exclude_unset=True).items():
366
+ setattr(user, field, value)
367
+ try:
368
+ await self.db.commit()
369
+ except IntegrityError as exc:
370
+ await self.db.rollback()
371
+ raise DuplicateUserError from exc
372
+ await self.db.refresh(user)
373
+ return user
374
+
375
+ async def authenticate(self, email: str, password: str) -> str | None:
376
+ user = await self.get_by_email(email)
377
+ if user is None or not pwd_context.verify(password, user.hashed_password):
378
+ return None
379
+ expire = datetime.now(timezone.utc) + timedelta(
380
+ minutes=settings.access_token_expire_minutes
381
+ )
382
+ return jwt.encode(
383
+ {"sub": str(user.id), "exp": expire},
384
+ settings.secret_key,
385
+ algorithm=settings.algorithm,
386
+ )
387
+ ```
388
+
389
+ > **Note on Database Design:** Application-level unique handling requires an underlying unique database index (e.g., `unique=True` on your SQLAlchemy mapping attributes). Without underlying constraints, application layer error-catching cannot safely prevent concurrent race conditions.
390
+
391
+ ---
392
+
393
+ ## Testing with httpx and pytest
394
+
395
+ ```python
396
+ # tests/conftest.py
397
+ import pytest_asyncio
398
+ from httpx import ASGITransport, AsyncClient
399
+ from sqlalchemy.ext.asyncio import AsyncSession, async_sessionmaker, create_async_engine
400
+
401
+ from app.database import Base
402
+ from app.dependencies import get_db
403
+ from app.main import create_app
404
+
405
+ TEST_DATABASE_URL = "sqlite+aiosqlite:///:memory:"
406
+
407
+ engine = create_async_engine(TEST_DATABASE_URL)
408
+ TestingSessionLocal = async_sessionmaker(engine, expire_on_commit=False)
409
+
410
+
411
+ @pytest_asyncio.fixture(autouse=True)
412
+ async def setup_db():
413
+ async with engine.begin() as conn:
414
+ await conn.run_sync(Base.metadata.create_all)
415
+ yield
416
+ async with engine.begin() as conn:
417
+ await conn.run_sync(Base.metadata.drop_all)
418
+
419
+
420
+ @pytest_asyncio.fixture
421
+ async def db_session():
422
+ async with TestingSessionLocal() as session:
423
+ yield session
424
+ await session.rollback()
425
+
426
+
427
+ @pytest_asyncio.fixture
428
+ async def client(db_session: AsyncSession):
429
+ app = create_app()
430
+
431
+ async def override_get_db():
432
+ yield db_session
433
+
434
+ app.dependency_overrides[get_db] = override_get_db
435
+
436
+ async with AsyncClient(
437
+ transport=ASGITransport(app=app), base_url="http://test"
438
+ ) as ac:
439
+ yield ac
440
+
441
+
442
+ @pytest_asyncio.fixture
443
+ async def registered_user(client: AsyncClient) -> dict:
444
+ resp = await client.post("/users/", json={
445
+ "email": "test@example.com",
446
+ "username": "testuser",
447
+ "password": "securepass1",
448
+ "password_confirm": "securepass1",
449
+ })
450
+ assert resp.status_code == 201
451
+ return resp.json()
452
+
453
+
454
+ @pytest_asyncio.fixture
455
+ async def auth_token(client: AsyncClient, registered_user: dict) -> str:
456
+ resp = await client.post("/users/token", data={
457
+ "username": "test@example.com",
458
+ "password": "securepass1",
459
+ })
460
+ assert resp.status_code == 200
461
+ return resp.json()["access_token"]
462
+
463
+
464
+ @pytest_asyncio.fixture
465
+ async def auth_client(client: AsyncClient, auth_token: str) -> AsyncClient:
466
+ client.headers.update({"Authorization": f"Bearer {auth_token}"})
467
+ return client
468
+ ```
469
+
470
+ ---
471
+
472
+ ## Anti-Patterns
473
+
474
+ ```python
475
+ # Bad: business logic inside route handlers.
476
+ @router.post("/users/")
477
+ async def create_user(payload: UserCreate, db: DbDep):
478
+ hashed = bcrypt.hash(payload.password)
479
+ user = User(email=payload.email, hashed_password=hashed)
480
+ db.add(user)
481
+ await db.commit()
482
+ return user
483
+
484
+ # Good: thin route, transactional service handling.
485
+ @router.post("/users/", response_model=UserResponse, status_code=201)
486
+ async def create_user(payload: UserCreate, db: DbDep):
487
+ try:
488
+ return await UserService(db).create(payload)
489
+ except DuplicateUserError:
490
+ raise HTTPException(status_code=400, detail="Email already registered")
491
+
492
+
493
+ # Bad: sync DB calls in async routes block the event loop.
494
+ @router.get("/items/")
495
+ async def list_items(db: Session = Depends(get_db)):
496
+ return db.query(Item).all()
497
+
498
+ # Good: use async SQLAlchemy executions.
499
+ @router.get("/items/")
500
+ async def list_items(db: AsyncSession = Depends(get_db)):
501
+ result = await db.execute(select(Item))
502
+ return result.scalars().all()
503
+ ```
504
+
505
+ ---
506
+
507
+ ## Best Practices
508
+
509
+ - Always declare a typed `response_model` to prevent accidental PII/data leaks and output clean OpenAPI schemas.
510
+ - Consolidate standard middleware dependency injections via type-aliasing: `DbDep = Annotated[AsyncSession, Depends(get_db)]`.
511
+ - Wrap database mutation boundaries gracefully within transactions inside your service layer, catching structural database errors directly.
512
+ - Parse JWT parameters defensively, expecting potential string/integer cast mismatches from modern payload variations.
513
+ - Enforce deterministic sorting (e.g., `.order_by(Model.id)`) on all offset/limit paginated endpoints to avoid data skips.
514
+ - Isolate authorization checks from core authentication dependencies to provide precise REST status signals (`401` vs `403`).