codeply-cli 0.5.1 → 0.5.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (387) hide show
  1. package/LICENSE +21 -0
  2. package/THIRD_PARTY_NOTICES.md +65 -63
  3. package/bin/codeply.js +1 -1
  4. package/lib/agent.mjs +133 -24
  5. package/lib/ai.js +268 -9
  6. package/lib/ai.mjs +6 -6
  7. package/lib/apply-patch.js +217 -217
  8. package/lib/arity-table.json +138 -138
  9. package/lib/arity.js +70 -70
  10. package/lib/auth.mjs +6 -6
  11. package/lib/bots.js +82 -17
  12. package/lib/chatgpt.js +282 -0
  13. package/lib/cloud-browser.mjs +143 -143
  14. package/lib/cloud.mjs +1250 -1144
  15. package/lib/commands.js +103 -103
  16. package/lib/config.js +83 -3
  17. package/lib/design-library/assemble-artifact.mjs +21 -21
  18. package/lib/design-library/cleanup.mjs +45 -45
  19. package/lib/design-library/index.json +22379 -22379
  20. package/lib/design-library/make-table-data.mjs +39 -39
  21. package/lib/diagnostics.js +192 -192
  22. package/lib/edit-engine.js +364 -364
  23. package/lib/github-agent.mjs +311 -311
  24. package/lib/history.js +75 -75
  25. package/lib/mail-watch.js +504 -0
  26. package/lib/mcp.js +258 -258
  27. package/lib/model-sync.js +114 -0
  28. package/lib/native-tools.mjs +16 -1
  29. package/lib/oauth-connectors.js +146 -24
  30. package/lib/permissions.js +109 -109
  31. package/lib/plugins.js +353 -353
  32. package/lib/publish.js +916 -0
  33. package/lib/reach.js +67 -0
  34. package/lib/server.mjs +457 -457
  35. package/lib/session-db.js +220 -220
  36. package/lib/share.js +168 -168
  37. package/lib/skills.js +2 -0
  38. package/lib/snapshot.js +146 -146
  39. package/lib/telemetry.js +102 -0
  40. package/lib/terminal-hints.js +154 -154
  41. package/lib/tools.mjs +316 -14
  42. package/lib/typecheck-worker.js +147 -147
  43. package/lib/web-tools.js +209 -158
  44. package/package.json +49 -49
  45. package/skills/SOURCE.md +58 -58
  46. package/skills/accessibility/SKILL.md +147 -147
  47. package/skills/agent-architecture-audit/SKILL.md +257 -257
  48. package/skills/agent-eval/SKILL.md +147 -147
  49. package/skills/agent-harness-construction/SKILL.md +74 -74
  50. package/skills/agent-introspection-debugging/SKILL.md +154 -154
  51. package/skills/agent-payment-x402/SKILL.md +225 -225
  52. package/skills/agent-self-evaluation/SKILL.md +182 -182
  53. package/skills/agent-self-evaluation/references/evaluation-criteria.md +71 -71
  54. package/skills/agent-self-evaluation/references/hook-integration.md +64 -64
  55. package/skills/agent-sort/SKILL.md +216 -216
  56. package/skills/agentic-engineering/SKILL.md +64 -64
  57. package/skills/agentic-os/SKILL.md +388 -388
  58. package/skills/ai-first-engineering/SKILL.md +52 -52
  59. package/skills/ai-regression-testing/SKILL.md +386 -386
  60. package/skills/android-clean-architecture/SKILL.md +340 -340
  61. package/skills/angular-developer/SKILL.md +155 -155
  62. package/skills/angular-developer/references/angular-animations.md +160 -160
  63. package/skills/angular-developer/references/angular-aria.md +410 -410
  64. package/skills/angular-developer/references/cli.md +86 -86
  65. package/skills/angular-developer/references/component-harnesses.md +59 -59
  66. package/skills/angular-developer/references/component-styling.md +91 -91
  67. package/skills/angular-developer/references/components.md +117 -117
  68. package/skills/angular-developer/references/creating-services.md +97 -97
  69. package/skills/angular-developer/references/data-resolvers.md +69 -69
  70. package/skills/angular-developer/references/define-routes.md +67 -67
  71. package/skills/angular-developer/references/defining-providers.md +72 -72
  72. package/skills/angular-developer/references/di-fundamentals.md +120 -120
  73. package/skills/angular-developer/references/e2e-testing.md +56 -56
  74. package/skills/angular-developer/references/effects.md +83 -83
  75. package/skills/angular-developer/references/hierarchical-injectors.md +43 -43
  76. package/skills/angular-developer/references/host-elements.md +80 -80
  77. package/skills/angular-developer/references/injection-context.md +63 -63
  78. package/skills/angular-developer/references/inputs.md +101 -101
  79. package/skills/angular-developer/references/linked-signal.md +59 -59
  80. package/skills/angular-developer/references/loading-strategies.md +61 -61
  81. package/skills/angular-developer/references/mcp.md +108 -108
  82. package/skills/angular-developer/references/navigate-to-routes.md +69 -69
  83. package/skills/angular-developer/references/outputs.md +86 -86
  84. package/skills/angular-developer/references/reactive-forms.md +122 -122
  85. package/skills/angular-developer/references/rendering-strategies.md +44 -44
  86. package/skills/angular-developer/references/resource.md +77 -77
  87. package/skills/angular-developer/references/route-animations.md +56 -56
  88. package/skills/angular-developer/references/route-guards.md +52 -52
  89. package/skills/angular-developer/references/router-lifecycle.md +45 -45
  90. package/skills/angular-developer/references/router-testing.md +87 -87
  91. package/skills/angular-developer/references/show-routes-with-outlets.md +68 -68
  92. package/skills/angular-developer/references/signal-forms.md +795 -795
  93. package/skills/angular-developer/references/signals-overview.md +94 -94
  94. package/skills/angular-developer/references/tailwind-css.md +69 -69
  95. package/skills/angular-developer/references/template-driven-forms.md +114 -114
  96. package/skills/angular-developer/references/testing-fundamentals.md +65 -65
  97. package/skills/api-connector-builder/SKILL.md +121 -121
  98. package/skills/api-design/SKILL.md +524 -524
  99. package/skills/architecture-decision-records/SKILL.md +180 -180
  100. package/skills/article-writing/SKILL.md +80 -80
  101. package/skills/automation-audit-ops/SKILL.md +143 -143
  102. package/skills/autonomous-agent-harness/SKILL.md +274 -274
  103. package/skills/autonomous-loops/SKILL.md +611 -611
  104. package/skills/backend-patterns/SKILL.md +562 -562
  105. package/skills/benchmark/SKILL.md +95 -95
  106. package/skills/benchmark-methodology/SKILL.md +191 -191
  107. package/skills/benchmark-optimization-loop/SKILL.md +71 -71
  108. package/skills/blender-motion-state-inspection/SKILL.md +165 -165
  109. package/skills/blueprint/SKILL.md +106 -106
  110. package/skills/brand-discovery/SKILL.md +145 -145
  111. package/skills/brand-discovery/references/10_purpose-why.md +40 -40
  112. package/skills/brand-discovery/references/20_positioning.md +44 -44
  113. package/skills/brand-discovery/references/30_audience-niche.md +52 -52
  114. package/skills/brand-discovery/references/40_personality-archetype.md +57 -57
  115. package/skills/brand-discovery/references/50_voice-tone.md +59 -59
  116. package/skills/brand-discovery/references/60_narrative-story.md +50 -50
  117. package/skills/brand-discovery/references/70_founder-tension.md +49 -49
  118. package/skills/brand-discovery/references/90_SYNTHESIS.md +133 -133
  119. package/skills/brand-voice/SKILL.md +98 -98
  120. package/skills/brand-voice/references/voice-profile-schema.md +55 -55
  121. package/skills/browser-qa/SKILL.md +105 -105
  122. package/skills/bun-runtime/SKILL.md +85 -85
  123. package/skills/canary-watch/SKILL.md +108 -108
  124. package/skills/carrier-relationship-management/SKILL.md +212 -212
  125. package/skills/cisco-ios-patterns/SKILL.md +164 -164
  126. package/skills/ck/SKILL.md +148 -148
  127. package/skills/claude-devfleet/SKILL.md +112 -112
  128. package/skills/click-path-audit/SKILL.md +245 -245
  129. package/skills/clickhouse-io/SKILL.md +445 -445
  130. package/skills/code-tour/SKILL.md +254 -254
  131. package/skills/codebase-onboarding/SKILL.md +234 -234
  132. package/skills/codehealth-mcp/SKILL.md +167 -167
  133. package/skills/coding-standards/SKILL.md +551 -551
  134. package/skills/competitive-platform-analysis/SKILL.md +214 -214
  135. package/skills/competitive-report-structure/SKILL.md +162 -162
  136. package/skills/compose-multiplatform-patterns/SKILL.md +300 -300
  137. package/skills/config-gc/SKILL.md +120 -120
  138. package/skills/configure-ecc/SKILL.md +385 -385
  139. package/skills/connections-optimizer/SKILL.md +190 -190
  140. package/skills/content-engine/SKILL.md +132 -132
  141. package/skills/content-hash-cache-pattern/SKILL.md +162 -162
  142. package/skills/context-budget/SKILL.md +136 -136
  143. package/skills/continuous-agent-loop/SKILL.md +46 -46
  144. package/skills/continuous-learning/SKILL.md +132 -132
  145. package/skills/continuous-learning-v2/SKILL.md +361 -361
  146. package/skills/contract-first/SKILL.md +287 -287
  147. package/skills/cost-aware-llm-pipeline/SKILL.md +184 -184
  148. package/skills/cost-tracking/SKILL.md +97 -97
  149. package/skills/council/SKILL.md +204 -204
  150. package/skills/cpp-coding-standards/SKILL.md +724 -724
  151. package/skills/cpp-testing/SKILL.md +325 -325
  152. package/skills/crosspost/SKILL.md +112 -112
  153. package/skills/csharp-testing/SKILL.md +322 -322
  154. package/skills/customer-billing-ops/SKILL.md +141 -141
  155. package/skills/customs-trade-compliance/SKILL.md +263 -263
  156. package/skills/dart-flutter-patterns/SKILL.md +564 -564
  157. package/skills/dashboard-builder/SKILL.md +109 -109
  158. package/skills/data-scraper-agent/SKILL.md +765 -765
  159. package/skills/data-throughput-accelerator/SKILL.md +74 -74
  160. package/skills/database-migrations/SKILL.md +430 -430
  161. package/skills/deep-research/SKILL.md +160 -160
  162. package/skills/defi-amm-security/SKILL.md +167 -167
  163. package/skills/delivery-gate/SKILL.md +126 -126
  164. package/skills/deployment-patterns/SKILL.md +428 -428
  165. package/skills/design-system/SKILL.md +83 -83
  166. package/skills/django-celery/SKILL.md +458 -458
  167. package/skills/django-patterns/SKILL.md +735 -735
  168. package/skills/django-security/SKILL.md +644 -644
  169. package/skills/django-tdd/SKILL.md +730 -730
  170. package/skills/django-verification/SKILL.md +470 -470
  171. package/skills/dmux-workflows/SKILL.md +192 -192
  172. package/skills/docker-patterns/SKILL.md +365 -365
  173. package/skills/documentation-lookup/SKILL.md +91 -91
  174. package/skills/dotnet-patterns/SKILL.md +322 -322
  175. package/skills/dynamic-workflow-mode/SKILL.md +124 -124
  176. package/skills/e2e-testing/SKILL.md +327 -327
  177. package/skills/ecc-guide/SKILL.md +190 -190
  178. package/skills/ecc-recipes/SKILL.md +149 -149
  179. package/skills/ecc-tools-cost-audit/SKILL.md +161 -161
  180. package/skills/email-ops/SKILL.md +122 -122
  181. package/skills/energy-procurement/SKILL.md +228 -228
  182. package/skills/enterprise-agent-ops/SKILL.md +51 -51
  183. package/skills/error-handling/SKILL.md +377 -377
  184. package/skills/eval-harness/SKILL.md +271 -271
  185. package/skills/evm-token-decimals/SKILL.md +131 -131
  186. package/skills/exa-search/SKILL.md +108 -108
  187. package/skills/fal-ai-media/SKILL.md +289 -289
  188. package/skills/fastapi-patterns/SKILL.md +514 -514
  189. package/skills/finance-billing-ops/SKILL.md +128 -128
  190. package/skills/flox-environments/SKILL.md +497 -497
  191. package/skills/flutter-dart-code-review/SKILL.md +436 -436
  192. package/skills/foundation-models-on-device/SKILL.md +243 -243
  193. package/skills/frontend-a11y/SKILL.md +446 -446
  194. package/skills/frontend-design-direction/SKILL.md +93 -93
  195. package/skills/frontend-patterns/SKILL.md +657 -657
  196. package/skills/frontend-slides/SKILL.md +185 -185
  197. package/skills/fsharp-testing/SKILL.md +281 -281
  198. package/skills/gan-style-harness/SKILL.md +279 -279
  199. package/skills/gateguard/SKILL.md +133 -133
  200. package/skills/generating-python-installer/SKILL.md +820 -820
  201. package/skills/git-workflow/SKILL.md +716 -716
  202. package/skills/github-ops/SKILL.md +145 -145
  203. package/skills/golang-patterns/SKILL.md +676 -676
  204. package/skills/golang-testing/SKILL.md +721 -721
  205. package/skills/google-workspace-ops/SKILL.md +96 -96
  206. package/skills/growth-log/SKILL.md +128 -128
  207. package/skills/healthcare-cdss-patterns/SKILL.md +246 -246
  208. package/skills/healthcare-emr-patterns/SKILL.md +160 -160
  209. package/skills/healthcare-eval-harness/SKILL.md +208 -208
  210. package/skills/healthcare-phi-compliance/SKILL.md +146 -146
  211. package/skills/hermes-imports/SKILL.md +89 -89
  212. package/skills/hexagonal-architecture/SKILL.md +277 -277
  213. package/skills/hipaa-compliance/SKILL.md +79 -79
  214. package/skills/homelab-network-readiness/SKILL.md +170 -170
  215. package/skills/homelab-network-setup/SKILL.md +130 -130
  216. package/skills/homelab-pihole-dns/SKILL.md +275 -275
  217. package/skills/homelab-vlan-segmentation/SKILL.md +312 -312
  218. package/skills/homelab-wireguard-vpn/SKILL.md +306 -306
  219. package/skills/hookify-rules/SKILL.md +128 -128
  220. package/skills/inherit-legacy-style/SKILL.md +157 -157
  221. package/skills/intent-driven-development/SKILL.md +360 -360
  222. package/skills/inventory-demand-planning/SKILL.md +247 -247
  223. package/skills/investor-materials/SKILL.md +97 -97
  224. package/skills/investor-outreach/SKILL.md +92 -92
  225. package/skills/ios-icon-gen/SKILL.md +158 -158
  226. package/skills/iterative-retrieval/SKILL.md +212 -212
  227. package/skills/ito-basket-compare/SKILL.md +64 -64
  228. package/skills/ito-compute/SKILL.md +129 -129
  229. package/skills/ito-data-atlas-agent/SKILL.md +64 -64
  230. package/skills/ito-market-intelligence/SKILL.md +61 -61
  231. package/skills/ito-trade-planner/SKILL.md +68 -68
  232. package/skills/java-coding-standards/SKILL.md +384 -384
  233. package/skills/jira-integration/SKILL.md +303 -303
  234. package/skills/jpa-patterns/SKILL.md +152 -152
  235. package/skills/knowledge-ops/SKILL.md +155 -155
  236. package/skills/kotlin-coroutines-flows/SKILL.md +285 -285
  237. package/skills/kotlin-exposed-patterns/SKILL.md +720 -720
  238. package/skills/kotlin-ktor-patterns/SKILL.md +690 -690
  239. package/skills/kotlin-patterns/SKILL.md +712 -712
  240. package/skills/kotlin-testing/SKILL.md +825 -825
  241. package/skills/kubernetes-patterns/SKILL.md +756 -756
  242. package/skills/laravel-patterns/SKILL.md +416 -416
  243. package/skills/laravel-plugin-discovery/SKILL.md +230 -230
  244. package/skills/laravel-security/SKILL.md +948 -948
  245. package/skills/laravel-tdd/SKILL.md +675 -675
  246. package/skills/laravel-verification/SKILL.md +180 -180
  247. package/skills/latency-critical-systems/SKILL.md +75 -75
  248. package/skills/lead-intelligence/SKILL.md +322 -322
  249. package/skills/liquid-glass-design/SKILL.md +279 -279
  250. package/skills/llm-trading-agent-security/SKILL.md +147 -147
  251. package/skills/logistics-exception-management/SKILL.md +222 -222
  252. package/skills/loop-design-check/SKILL.md +143 -143
  253. package/skills/mailtrap-email-integration/SKILL.md +77 -77
  254. package/skills/make-interfaces-feel-better/SKILL.md +152 -152
  255. package/skills/manim-video/SKILL.md +90 -90
  256. package/skills/market-research/SKILL.md +76 -76
  257. package/skills/marketing-campaign/SKILL.md +114 -114
  258. package/skills/mcp-server-patterns/SKILL.md +70 -70
  259. package/skills/messages-ops/SKILL.md +105 -105
  260. package/skills/ml-adoption-playbook/SKILL.md +57 -57
  261. package/skills/mle-workflow/SKILL.md +348 -348
  262. package/skills/motion-advanced/SKILL.md +596 -596
  263. package/skills/motion-foundations/SKILL.md +299 -299
  264. package/skills/motion-patterns/SKILL.md +434 -434
  265. package/skills/motion-ui/SKILL.md +576 -576
  266. package/skills/mysql-patterns/SKILL.md +413 -413
  267. package/skills/nanoclaw-repl/SKILL.md +34 -34
  268. package/skills/nestjs-patterns/SKILL.md +231 -231
  269. package/skills/netmiko-ssh-automation/SKILL.md +174 -174
  270. package/skills/network-bgp-diagnostics/SKILL.md +168 -168
  271. package/skills/network-config-validation/SKILL.md +211 -211
  272. package/skills/network-interface-health/SKILL.md +153 -153
  273. package/skills/nextjs-turbopack/SKILL.md +58 -58
  274. package/skills/nodejs-keccak256/SKILL.md +103 -103
  275. package/skills/nutrient-document-processing/SKILL.md +168 -168
  276. package/skills/nuxt4-patterns/SKILL.md +101 -101
  277. package/skills/openclaw-persona-forge/SKILL.md +289 -289
  278. package/skills/openclaw-persona-forge/references/avatar-style.md +124 -124
  279. package/skills/openclaw-persona-forge/references/boundary-rules.md +53 -53
  280. package/skills/openclaw-persona-forge/references/error-handling.md +53 -53
  281. package/skills/openclaw-persona-forge/references/identity-tension.md +48 -48
  282. package/skills/openclaw-persona-forge/references/naming-system.md +39 -39
  283. package/skills/openclaw-persona-forge/references/output-template.md +166 -166
  284. package/skills/opensource-pipeline/SKILL.md +256 -256
  285. package/skills/orch-add-feature/SKILL.md +45 -45
  286. package/skills/orch-build-mvp/SKILL.md +49 -49
  287. package/skills/orch-change-feature/SKILL.md +43 -43
  288. package/skills/orch-fix-defect/SKILL.md +43 -43
  289. package/skills/orch-pipeline/SKILL.md +121 -121
  290. package/skills/orch-refine-code/SKILL.md +44 -44
  291. package/skills/parallel-execution-optimizer/SKILL.md +74 -74
  292. package/skills/perl-patterns/SKILL.md +505 -505
  293. package/skills/perl-security/SKILL.md +504 -504
  294. package/skills/perl-testing/SKILL.md +476 -476
  295. package/skills/plan-canvas/SKILL.md +153 -153
  296. package/skills/plan-orchestrate/SKILL.md +263 -263
  297. package/skills/plankton-code-quality/SKILL.md +237 -237
  298. package/skills/postgres-patterns/SKILL.md +148 -148
  299. package/skills/prediction-market-oracle-research/SKILL.md +64 -64
  300. package/skills/prediction-market-risk-review/SKILL.md +61 -61
  301. package/skills/premium-web-design/SKILL.md +154 -154
  302. package/skills/prisma-patterns/SKILL.md +401 -401
  303. package/skills/product-capability/SKILL.md +142 -142
  304. package/skills/product-lens/SKILL.md +93 -93
  305. package/skills/production-audit/SKILL.md +207 -207
  306. package/skills/production-scheduling/SKILL.md +238 -238
  307. package/skills/project-flow-ops/SKILL.md +112 -112
  308. package/skills/prompt-optimizer/SKILL.md +398 -398
  309. package/skills/publish-website/SKILL.md +76 -0
  310. package/skills/python-patterns/SKILL.md +751 -751
  311. package/skills/python-testing/SKILL.md +817 -817
  312. package/skills/pytorch-patterns/SKILL.md +397 -397
  313. package/skills/quality-nonconformance/SKILL.md +260 -260
  314. package/skills/quarkus-patterns/SKILL.md +723 -723
  315. package/skills/quarkus-security/SKILL.md +468 -468
  316. package/skills/quarkus-tdd/SKILL.md +812 -812
  317. package/skills/quarkus-verification/SKILL.md +480 -480
  318. package/skills/ralphinho-rfc-pipeline/SKILL.md +68 -68
  319. package/skills/react-native-patterns/SKILL.md +326 -326
  320. package/skills/react-patterns/SKILL.md +342 -342
  321. package/skills/react-performance/SKILL.md +575 -575
  322. package/skills/react-testing/SKILL.md +424 -424
  323. package/skills/recsys-pipeline-architect/SKILL.md +115 -115
  324. package/skills/recursive-decision-ledger/SKILL.md +81 -81
  325. package/skills/redis-patterns/SKILL.md +404 -404
  326. package/skills/regex-vs-llm-structured-text/SKILL.md +221 -221
  327. package/skills/remotion-video-creation/SKILL.md +43 -43
  328. package/skills/repo-scan/SKILL.md +79 -79
  329. package/skills/research-ops/SKILL.md +113 -113
  330. package/skills/returns-reverse-logistics/SKILL.md +240 -240
  331. package/skills/rules-distill/SKILL.md +265 -265
  332. package/skills/rust-patterns/SKILL.md +500 -500
  333. package/skills/rust-testing/SKILL.md +501 -501
  334. package/skills/safety-guard/SKILL.md +76 -76
  335. package/skills/santa-method/SKILL.md +307 -307
  336. package/skills/scientific-db-pubmed-database/SKILL.md +176 -176
  337. package/skills/scientific-db-uspto-database/SKILL.md +178 -178
  338. package/skills/scientific-pkg-gget/SKILL.md +167 -167
  339. package/skills/scientific-thinking-literature-review/SKILL.md +193 -193
  340. package/skills/scientific-thinking-scholar-evaluation/SKILL.md +161 -161
  341. package/skills/search-first/SKILL.md +183 -183
  342. package/skills/security-bounty-hunter/SKILL.md +100 -100
  343. package/skills/security-review/SKILL.md +504 -504
  344. package/skills/security-scan/SKILL.md +166 -166
  345. package/skills/seo/SKILL.md +155 -155
  346. package/skills/skill-comply/SKILL.md +59 -59
  347. package/skills/skill-scout/SKILL.md +141 -141
  348. package/skills/skill-stocktake/SKILL.md +195 -195
  349. package/skills/social-graph-ranker/SKILL.md +155 -155
  350. package/skills/social-publisher/SKILL.md +130 -130
  351. package/skills/springboot-patterns/SKILL.md +315 -315
  352. package/skills/springboot-security/SKILL.md +273 -273
  353. package/skills/springboot-tdd/SKILL.md +159 -159
  354. package/skills/springboot-verification/SKILL.md +232 -232
  355. package/skills/strategic-compact/SKILL.md +142 -142
  356. package/skills/swift-actor-persistence/SKILL.md +144 -144
  357. package/skills/swift-concurrency-6-2/SKILL.md +216 -216
  358. package/skills/swift-protocol-di-testing/SKILL.md +191 -191
  359. package/skills/swiftui-patterns/SKILL.md +259 -259
  360. package/skills/taste/SKILL.md +264 -264
  361. package/skills/taste/references/genre-taxonomy.md +87 -87
  362. package/skills/tdd-workflow/SKILL.md +583 -583
  363. package/skills/team-agent-orchestration/SKILL.md +111 -111
  364. package/skills/team-builder/SKILL.md +169 -169
  365. package/skills/terminal-ops/SKILL.md +110 -110
  366. package/skills/tinystruct-patterns/SKILL.md +279 -279
  367. package/skills/tinystruct-patterns/references/architecture.md +90 -90
  368. package/skills/tinystruct-patterns/references/data-handling.md +60 -60
  369. package/skills/tinystruct-patterns/references/database.md +99 -99
  370. package/skills/tinystruct-patterns/references/routing.md +64 -64
  371. package/skills/tinystruct-patterns/references/system-usage.md +97 -97
  372. package/skills/tinystruct-patterns/references/testing.md +72 -72
  373. package/skills/token-budget-advisor/SKILL.md +134 -134
  374. package/skills/ui-demo/SKILL.md +466 -466
  375. package/skills/ui-to-vue/SKILL.md +135 -135
  376. package/skills/uncloud/SKILL.md +344 -344
  377. package/skills/unified-memory/SKILL.md +170 -170
  378. package/skills/unified-notifications-ops/SKILL.md +188 -188
  379. package/skills/verification-loop/SKILL.md +129 -129
  380. package/skills/video-editing/SKILL.md +311 -311
  381. package/skills/videodb/SKILL.md +375 -375
  382. package/skills/visa-doc-translate/SKILL.md +117 -117
  383. package/skills/vite-patterns/SKILL.md +450 -450
  384. package/skills/vue-patterns/SKILL.md +471 -471
  385. package/skills/windows-desktop-e2e/SKILL.md +888 -888
  386. package/skills/workspace-surface-audit/SKILL.md +126 -126
  387. package/skills/x-api/SKILL.md +235 -235
@@ -1,795 +1,795 @@
1
- # Signal Forms
2
-
3
- Signal Forms are recommended for new forms when the target Angular version supports them. They provide a reactive, type-safe, and model-driven way to manage form state using Angular Signals.
4
-
5
- When using Signal Forms, do not use `null` as a value or type of any fields.
6
-
7
- ## Imports
8
-
9
- You can import the following from `@angular/forms/signals`:
10
-
11
- ```ts
12
- import {
13
- form,
14
- FormField,
15
- submit,
16
- // Rules for field state
17
- disabled,
18
- hidden,
19
- readonly,
20
- debounce,
21
- // Schema helpers
22
- applyWhen,
23
- applyEach,
24
- schema,
25
- // Custom validation
26
- validate,
27
- validateHttp,
28
- validateStandardSchema,
29
- // Metadata
30
- metadata,
31
- } from '@angular/forms/signals';
32
- ```
33
-
34
- ## Creating a Form
35
-
36
- Use the `form()` function with a Signal model. The structure of the form is derived directly from the model.
37
-
38
- ```ts
39
- import {Component, signal} from '@angular/core';
40
- import {form, FormField} from '@angular/forms/signals';
41
-
42
- @Component({
43
- // ...
44
- imports: [FormField],
45
- })
46
- export class Example {
47
- // 1. Define your model with initial values (avoid undefined)
48
- userModel = signal({
49
- name: '', // CRITICAL: NEVER use null or undefined as initial values
50
- email: '',
51
- age: 0, // Use 0 for numbers, NOT null
52
- address: {
53
- street: '',
54
- city: '',
55
- },
56
- hobbies: [] as string[], // Use [] for arrays, NOT null
57
- });
58
-
59
- // WRONG - DO NOT DO THIS:
60
- // badModel = signal({
61
- // name: null, // ERROR: use '' instead
62
- // age: null, // ERROR: use 0 instead
63
- // items: null // ERROR: use [] instead
64
- // });
65
-
66
- // 2. Create the form
67
- userForm = form(this.userModel);
68
- }
69
- ```
70
-
71
- ## Validation
72
-
73
- Import validators from `@angular/forms/signals`.
74
-
75
- ```ts
76
- import {required, email, min, max, minLength, maxLength, pattern} from '@angular/forms/signals';
77
- ```
78
-
79
- Use them in the schema function passed to `form()`:
80
-
81
- ```ts
82
- userForm = form(this.userModel, (schemaPath) => {
83
- // Required
84
- required(schemaPath.name, {message: 'Name is required'});
85
-
86
- // Conditional required.
87
- required(schemaPath.name, {
88
- when({valueOf}) {
89
- return valueOf(schemaPath.age) > 10;
90
- },
91
- });
92
- // when is only available for required
93
- // Do NOT do this: pattern(p.name, /xxx/, {when /* ERROR */)
94
-
95
- // Email
96
- email(schemaPath.email, {message: 'Invalid email'});
97
-
98
- // Min/Max for numbers
99
- min(schemaPath.age, 18);
100
- max(schemaPath.age, 100);
101
-
102
- // MinLength/MaxLength for strings/arrays
103
- minLength(schemaPath.password, 8);
104
- maxLength(schemaPath.description, 500);
105
-
106
- // Pattern (Regex)
107
- pattern(schemaPath.zipCode, /^\d{5}$/);
108
- });
109
- ```
110
-
111
- ## FieldState vs FormField: The Parental Requirement
112
-
113
- It's important to understand the difference between **FormField** (the structure) and **FieldState** (the actual data/signals).
114
-
115
- **RULE**: You must **CALL** a field as a function to access its state signals (valid, touched, dirty, hidden, etc.).
116
-
117
- ```ts
118
- // f is a FormField (structural)
119
- const f = form(signal({cat: {name: 'pirojok-the-cat', age: 5}}));
120
-
121
- f.cat.name; // FormField: You can't get flags from here!
122
- f.cat.name.touched(); // ERROR: touched() does not exist on FormField
123
-
124
- f.cat.name(); // FieldState: Calling it gives you access to signals
125
- f.cat.name().touched(); // VALID: Accessing the signal
126
- f.cat().name.touched(); // ERROR: f.cat() is state, it doesn't have children!
127
- ```
128
-
129
- Similarly in a template:
130
-
131
- ```html
132
- <!-- WRONG: Property 'hidden' does not exist on type 'FormField' -->
133
- @if (bookingForm.hotelDetails.hidden()) { ... }
134
-
135
- <!-- RIGHT: Call it first -->
136
- @if (bookingForm.hotelDetails().hidden()) { ... }
137
- ```
138
-
139
- ## Disabled / Readonly / Hidden
140
-
141
- Control field status using rules in the schema.
142
-
143
- ```ts
144
- import {disabled, readonly, hidden} from '@angular/forms/signals';
145
-
146
- userForm = form(this.userModel, (schemaPath) => {
147
- // Conditionally disabled
148
- disabled(schemaPath.password, ({valueOf}) => !valueOf(schemaPath.createAccount));
149
-
150
- // Conditionally hidden (does NOT remove from model, just marks as hidden)
151
- hidden(schemaPath.shippingAddress, ({valueOf}) => valueOf(schemaPath.sameAsBilling));
152
-
153
- // Readonly
154
- readonly(schemaPath.username);
155
- });
156
- ```
157
-
158
- ## Binding
159
-
160
- Import `FormField` and use the `[formField]` directive.
161
-
162
- ```ts
163
- import {FormField} from '@angular/forms/signals';
164
- ```
165
-
166
- All props on state, such as `disabled`, `hidden`, `readonly` and `name` are bound automatically.
167
- Do _NOT_ bind the `name` field.
168
-
169
- **CRITICAL: FORBIDDEN ATTRIBUTES**
170
- When using `[formField]`, you MUST NOT set the following attributes in the template (either static or bound):
171
-
172
- - `min`, `max` (Use validators in the schema instead)
173
- - `value`, `[value]`, `[attr.value]` (Already handled by `[formField]`)
174
- - `[attr.min]`, `[attr.max]`
175
- - `[disabled]`, `[readonly]` (Already handled by `[formField]`)
176
-
177
- Do NOT do this: `<input min="1" [formField]>` or `<input [value]="val" [formField]>`.
178
-
179
- ```html
180
- <!-- Input -->
181
- <input [formField]="userForm.name" />
182
-
183
- <!-- Checkbox -->
184
- <input type="checkbox" [formField]="userForm.isAdmin" />
185
-
186
- <!-- Select -->
187
- <select [formField]="userForm.country">
188
- <option value="us">US</option>
189
- </select>
190
-
191
- <!-- userForm.name can NOT be nullable, because input does not accept null-->
192
- <input [formField]="userForm.name" />
193
- ```
194
-
195
- ## Reactive Forms
196
-
197
- **Do NOT import** `FormControl`, `FormGroup`, `FormArray`, or `FormBuilder` from `@angular/forms`. Signal Forms replace these concepts entirely.
198
- Signal forms does NOT have a builder.
199
-
200
- ## Accessing State
201
-
202
- Each field in the form is a function that returns its state.
203
-
204
- ```ts
205
- // Access the field by calling it
206
- const emailState = this.userForm.email();
207
-
208
- // Value (WritableSignal)
209
- const value = this.userForm().value();
210
-
211
- // Validation State (Signals)
212
- const isValid = this.userForm().valid();
213
- const isInvalid = this.userForm().invalid();
214
- const errors = this.userForm().errors(); // Array of errors
215
- const isPending = this.userForm().pending(); // Async validation pending
216
-
217
- // Interaction State (Signals)
218
- const isTouched = this.userForm().touched();
219
- const isDirty = this.userForm().dirty();
220
-
221
- // Availability State (Signals)
222
- const isDisabled = this.userForm().disabled();
223
- const isHidden = this.userForm().hidden();
224
- const isReadonly = this.userForm().readonly();
225
- ```
226
-
227
- IMPORTANT!: Make sure to call the field to get it state.
228
-
229
- ```ts
230
- form().invalid()
231
- form.field().dirty()
232
- form.field.subfield().touched()
233
- form.a.b.c.d().value()
234
- form.address.ssn().pending()
235
- form().reset()
236
-
237
- // The only exception is length:
238
- form.children.length
239
- form.length // NOTE: no parenthesis!
240
- form.client.addresses.length // No "()"
241
-
242
- @for (income of form.addresses; track $index) {/**/}
243
- ```
244
-
245
- ## Submitting
246
-
247
- Use the `submit()` function. It automatically marks all fields as touched before running the action.
248
-
249
- **CRITICAL**: The callback to `submit()` MUST be `async` and MUST return a Promise.
250
-
251
- ```ts
252
- import { submit } from '@angular/forms/signals';
253
-
254
- // CORRECT - async callback
255
- onSubmit() {
256
- submit(this.userForm, async () => {
257
- // This only runs if the form is valid
258
- await this.apiService.save(this.userModel());
259
- console.log('Saved!');
260
- });
261
- }
262
-
263
- // WRONG - missing async keyword
264
- onSubmit() {
265
- submit(this.userForm, () => { // ERROR: must be async
266
- console.log('Saved!');
267
- });
268
- }
269
- ```
270
-
271
- ## Handling Errors
272
-
273
- `field().errors()` returns the errors array of ValidationError:
274
-
275
- ```ts
276
- interface ValidationError {
277
- readonly kind: string;
278
- readonly message?: string;
279
- }
280
- ```
281
-
282
- Do _NOT_ return null from validators.
283
- When there are no errors, return undefined
284
-
285
- ### Context
286
-
287
- Functions passed to rules like `validate()`, `disabled()`, `applyWhen` take a context object. It is **CRITICAL** to understand its structure:
288
-
289
- ```ts
290
- validate(
291
- schemaPath.username,
292
- ({
293
- value, // Signal<T>: Writable current value of the field
294
- fieldTree, // FieldTree<T>: Sub-fields (if it's a group/array)
295
- state, // FieldState<T>: Access flags like state.valid(), state.dirty()
296
- valueOf, // (path) => T: Read values of OTHER fields (tracking dependencies), e.g. valueOf(schemaPath.password)
297
- stateOf, // (path) => FieldState: Access state (valid/dirty) of OTHER fields, e.g. stateOf(schemaPath.password).valid()
298
- pathKeys, // Signal<string[]>: Path from root to this field
299
- }) => {
300
- // WRONG: if (touched()) ... (touched is not in context)
301
- // RIGHT: if (state.touched()) ...
302
-
303
- if (value() === 'admin') {
304
- return {kind: 'reserved', message: 'Username admin is reserved'};
305
- }
306
- },
307
- );
308
- ```
309
-
310
- ### IMPORTANT: Paths are NOT Signals
311
-
312
- Inside the `form()` callback, `schemaPath` and its children (e.g., `schemaPath.user.name`) are **NOT** signals and are **NOT** callable.
313
-
314
- ```ts
315
- // WRONG - This will throw an error:
316
- applyWhen(p.ssn, () => p.ssn().touched(), (ssnField) => { ... });
317
-
318
- // RIGHT - Use stateOf() to get the state of a path:
319
- applyWhen(p.ssn, ({ stateOf }) => stateOf(p.ssn).touched(), (ssnField) => { ... });
320
-
321
- // RIGHT - Use valueOf() to get the value of a path:
322
- applyWhen(p.ssn, ({ valueOf }) => valueOf(p.ssn) !== '', (ssnField) => { ... });
323
- ```
324
-
325
- ### Multiple Items
326
-
327
- - Use `applyEach` for applying rules per item.
328
- - **CRITICAL**: `applyEach` callback takes ONLY ONE argument (the item path), NOT two:
329
-
330
- ```ts
331
- // CORRECT - single argument
332
- applyEach(s.items, (item) => {
333
- required(item.name);
334
- });
335
-
336
- // WRONG - do NOT pass index
337
- applyEach(s.items, (item, index) => {
338
- // ERROR: callback takes 1 argument
339
- required(item.name);
340
- });
341
- ```
342
-
343
- - In the template use `@for` to iterate over the items.
344
- - To remove an item from an array, just remove appropriate item from the array in the data.
345
- - **`select` binding**: You CAN bind to `<select [formField]="form.country">`. Ensure options have `value` attributes.
346
-
347
- ### Nested @for Loops
348
-
349
- **CRITICAL**: Angular does NOT have `$parent`. In nested loops, store outer index in a variable:
350
-
351
- ```html
352
- <!-- WRONG - $parent does not exist -->
353
- @for (item of form.items; track $index) { @for (option of item.options; track $index) {
354
- <button (click)="removeOption($parent.$index, $index)">Remove</button>
355
- <!-- ERROR -->
356
- } }
357
-
358
- <!-- CORRECT - use let to store outer index -->
359
- @for (item of form.items; track $index; let outerIndex = $index) { @for (option of item.options;
360
- track $index) {
361
- <button (click)="removeOption(outerIndex, $index)">Remove</button>
362
- } }
363
- ```
364
-
365
- ### Disabling Form Button
366
-
367
- ```html
368
- <button [disabled]="form().invalid() || form().pending()" />
369
- <!-- Or -->
370
- <button [disabled]="taxForm.invalid()" />
371
- ```
372
-
373
- Do NOT use `[disabled]` on an input. `[formField]` will do this.
374
- Do NOT use `[readonly]` on an input. `[formField]` will do this.
375
- If you need to disable or readonly a field, use `disabled()` or `readonly()` rules in the schema.
376
-
377
- ### Async Validation
378
-
379
- Do not use `validate()` for async, instead use `validateAsync()`:
380
-
381
- **CRITICAL**:
382
-
383
- 1. The `params` option MUST be a function that returns the value to validate.
384
- 2. The `onError` handler is **REQUIRED** - it is NOT optional!
385
-
386
- ```ts
387
- import {resource} from '@angular/core';
388
- import {validateAsync} from '@angular/forms/signals';
389
-
390
- userForm = form(this.userModel, (s) => {
391
- validateAsync(s.username, {
392
- // 1. MUST be a function - params takes context and returns the value
393
- params: ({value}) => value(),
394
-
395
- // 2. Create the resource - factory receives a Signal
396
- factory: (username) =>
397
- resource({
398
- params: username, // Use 'params' in resource()
399
- loader: async ({params: value}) => {
400
- await new Promise((resolve) => setTimeout(resolve, 1000));
401
- return value === 'taken';
402
- },
403
- }),
404
-
405
- // 3. Map success to errors
406
- onSuccess: (isTaken) =>
407
- isTaken ? {kind: 'taken', message: 'Username is already taken'} : undefined,
408
-
409
- // 4. Handle errors - THIS IS REQUIRED!
410
- onError: () => ({kind: 'error', message: 'Validation failed'}),
411
- });
412
- });
413
- ```
414
-
415
- **WRONG Examples:**
416
-
417
- ```ts
418
- // WRONG - params must be a function
419
- validateAsync(s.username, {
420
- params: s.username, // ERROR: must be ({ value }) => value()
421
- // ...
422
- });
423
-
424
- // WRONG - missing onError (it's required!)
425
- validateAsync(s.username, {
426
- params: ({value}) => value(),
427
- factory: (username) =>
428
- resource({
429
- /* ... */
430
- }),
431
- onSuccess: (result) => (result ? {kind: 'error'} : undefined),
432
- // ERROR: 'onError' is missing but required!
433
- });
434
- ```
435
-
436
- ### Using Resource
437
-
438
- **CRITICAL**: In Angular's `resource()`, use `params` for the input signal.
439
-
440
- ```ts
441
- // CORRECT
442
- resource({
443
- params: mySignal,
444
- loader: async ({params: value}) => {
445
- /* ... */
446
- },
447
- });
448
-
449
- // WRONG
450
- resource({
451
- request: mySignal, // ERROR: should be 'params'
452
- loader: async ({request}) => {
453
- /* ... */
454
- },
455
- });
456
- ```
457
-
458
- Use `debounce()` to delay synchronization between the UI and the model.
459
-
460
- ```ts
461
- import {debounce} from '@angular/forms/signals';
462
-
463
- userForm = form(this.userModel, (s) => {
464
- // Delay model updates by 300ms
465
- debounce(s.username, 300);
466
- });
467
- ```
468
-
469
- ### Conditional Validation
470
-
471
- ```ts
472
- form(
473
- data,
474
- (path) => {
475
- applyWhen(
476
- name,
477
- ({value}) => value() !== 'admin',
478
- (namePath) => {
479
- validate(namePath.last /* ... */);
480
- disable(namePath.last /* ... */);
481
- },
482
- );
483
- },
484
- {injector: TestBed.inject(Injector)},
485
- );
486
- ```
487
-
488
- `applyWhen` passes the path mapped to the first argument.
489
- If you need parent field, just pass it to `applyWhen`:
490
-
491
- ```ts
492
- form(
493
- data,
494
- (path) => {
495
- applyWhen(
496
- cat,
497
- ({value}) => value().name !== 'admin',
498
- (catPath) => {
499
- require(cat.catPath /* ... */);
500
- },
501
- );
502
- },
503
- {injector: TestBed.inject(Injector)},
504
- );
505
- ```
506
-
507
- ## Common Pitfalls (DO NOT DO THESE)
508
-
509
- | Error Scenario | WRONG (Common Mistake) | RIGHT (Correct Way) |
510
- | :--------------------- | :-------------------------------------------- | :---------------------------------------------------------- |
511
- | **Accessing Flags** | `form.field.valid()` | `form.field().valid()` |
512
- | **Accessing value** | `form.field.value()` | `form.field().value()` |
513
- | **Setting value** | `form.field.set(x)` | Update model signal: `this.model.update(...)` |
514
- | **Form root flags** | `form.invalid()` | `form().invalid()` |
515
- | **Double-calling** | `form.field()()` | `form.field().value()` |
516
- | **Rules Context** | `({ touched }) => touched()` | `({ state }) => state.touched()` |
517
- | **Calling Paths** | `applyWhen(p.foo, () => p.foo() === 'x')` | `applyWhen(p.foo, ({ valueOf }) => valueOf(p.foo) === 'x')` |
518
- | **applyWhen args** | `applyWhen(condition, () => {...})` | `applyWhen(path, condition, schemaFn)` - needs 3 args |
519
- | **Array length** | `form.items().length` | `form.items.length` (structural) |
520
- | **Multi-select array** | `<select [formField]="form.tags">` (string[]) | Use checkboxes for array fields |
521
- | **readonly attribute** | `<input readonly [formField]>` | Use `readonly()` rule in schema |
522
- | **min/max attributes** | `<input min="1" max="10">` | Use `min()` and `max()` rules in schema |
523
- | **value binding** | `<input [value]="val">` | Do NOT use `[value]` with `[formField]` |
524
- | **when option** | `pattern(p.x, /.../, {when: ...})` | `when` only works with `required()` |
525
- | **Submit callback** | `submit(form, () => { ... })` | `submit(form, async () => { ... })` |
526
- | **Async params** | `params: s.field` | `params: ({ value }) => value()` |
527
- | **Async onError** | Omitting `onError` | `onError` is REQUIRED in `validateAsync` |
528
- | **resource() API** | `request: signal` | `params: signal` |
529
- | **applyEach args** | `applyEach(s.items, (item, index) => ...)` | `applyEach(s.items, (item) => ...)` |
530
- | **Nested @for** | `$parent.$index` | Use `let outerIndex = $index` |
531
- | **FormState import** | `import { FormState }` | `FormState` does not exist, use `FieldState` |
532
- | **Null in model** | `signal({ name: null })` | `signal({ name: '' })` or `signal({ age: 0 })` |
533
- | **Validate syntax** | `validate(s.field, { value } => ...)` | `validate(s.field, ({ value }) => ...)` |
534
- | **Checkbox Array** | `[formField]="form.tags"` (string[]) | Checkboxes ONLY bind to `boolean` |
535
-
536
- ## Big Form Example
537
-
538
- ### `src/app/app.ts`
539
-
540
- ```ts
541
- import {Component, signal, ChangeDetectionStrategy} from '@angular/core';
542
- import {
543
- form,
544
- FormField,
545
- submit,
546
- required,
547
- email,
548
- min,
549
- hidden,
550
- applyEach,
551
- validate,
552
- } from '@angular/forms/signals';
553
-
554
- @Component({
555
- selector: 'app-root',
556
- standalone: true,
557
- imports: [FormField],
558
- templateUrl: './app.html',
559
- changeDetection: ChangeDetectionStrategy.OnPush,
560
- })
561
- export class App {
562
- model = signal({
563
- personalInfo: {
564
- firstName: '',
565
- lastName: '',
566
- email: '',
567
- age: 0,
568
- },
569
- tripDetails: {
570
- destination: 'Mars',
571
- launchDate: '',
572
- },
573
- package: {
574
- tier: 'economy',
575
- extras: [] as string[],
576
- },
577
- companions: [] as Array<{name: string; relation: string}>,
578
- });
579
-
580
- bookingForm = form(this.model, (s) => {
581
- required(s.personalInfo.firstName, {message: 'First name is required'});
582
- required(s.personalInfo.lastName, {message: 'Last name is required'});
583
- required(s.personalInfo.email, {message: 'Email is required'});
584
- email(s.personalInfo.email, {message: 'Invalid email address'});
585
- required(s.personalInfo.age, {message: 'Age is required'});
586
- min(s.personalInfo.age, 18, {message: 'Must be at least 18'});
587
-
588
- required(s.tripDetails.destination);
589
- required(s.tripDetails.launchDate);
590
- validate(s.tripDetails.launchDate, ({value}) => {
591
- const date = new Date(value());
592
- if (isNaN(date.getTime())) return undefined;
593
- const today = new Date();
594
- if (date < today) {
595
- return {kind: 'pastData', message: 'Launch date must be in the future'};
596
- }
597
- return undefined;
598
- });
599
-
600
- // valueOf is used to access values of other fields in rules
601
- hidden(s.package.extras, ({valueOf}) => valueOf(s.package.tier) === 'economy');
602
-
603
- applyEach(s.companions, (companion) => {
604
- required(companion.name, {message: 'Companion name required'});
605
- required(companion.relation, {message: 'Relation required'});
606
- });
607
- });
608
-
609
- addCompanion() {
610
- this.model.update((m) => ({
611
- ...m,
612
- companions: [...m.companions, {name: '', relation: ''}],
613
- }));
614
- }
615
-
616
- removeCompanion(index: number) {
617
- this.model.update((m) => ({
618
- ...m,
619
- companions: m.companions.filter((_, i) => i !== index),
620
- }));
621
- }
622
-
623
- onSubmit() {
624
- // CRITICAL: submit callback MUST be async
625
- submit(this.bookingForm, async () => {
626
- console.log('Booking Confirmed:', this.model());
627
- // If you need to do async work:
628
- // await this.apiService.save(this.model());
629
- });
630
- }
631
- }
632
- ```
633
-
634
- ### `src/app/app.html`
635
-
636
- ```html
637
- <form (submit)="onSubmit(); $event.preventDefault()">
638
- <h1>Interstellar Booking</h1>
639
-
640
- <section>
641
- <h2>Personal Info</h2>
642
-
643
- <label>
644
- First Name
645
- <input [formField]="bookingForm.personalInfo.firstName" />
646
- @if (bookingForm.personalInfo.firstName().touched() &&
647
- bookingForm.personalInfo.firstName().errors().length) {
648
- <span>{{ bookingForm.personalInfo.firstName().errors()[0].message }}</span>
649
- }
650
- </label>
651
-
652
- <label>
653
- Last Name
654
- <input [formField]="bookingForm.personalInfo.lastName" />
655
- @if (bookingForm.personalInfo.lastName().touched() &&
656
- bookingForm.personalInfo.lastName().errors().length) {
657
- <span>{{ bookingForm.personalInfo.lastName().errors()[0].message }}</span>
658
- }
659
- </label>
660
-
661
- <label>
662
- Email
663
- <input type="email" [formField]="bookingForm.personalInfo.email" />
664
- @if (bookingForm.personalInfo.email().touched() &&
665
- bookingForm.personalInfo.email().errors().length) {
666
- <span>{{ bookingForm.personalInfo.email().errors()[0].message }}</span>
667
- }
668
- </label>
669
-
670
- <label>
671
- Age
672
- <input type="number" [formField]="bookingForm.personalInfo.age" />
673
- @if (bookingForm.personalInfo.age().touched() &&
674
- bookingForm.personalInfo.age().errors().length) {
675
- <span>{{ bookingForm.personalInfo.age().errors()[0].message }}</span>
676
- }
677
- </label>
678
- </section>
679
-
680
- <section>
681
- <h2>Trip Details</h2>
682
-
683
- <label>
684
- Destination
685
- <select [formField]="bookingForm.tripDetails.destination">
686
- <option value="Mars">Mars</option>
687
- <option value="Moon">Moon</option>
688
- <option value="Titan">Titan</option>
689
- </select>
690
- </label>
691
-
692
- <label>
693
- Launch Date
694
- <input type="date" [formField]="bookingForm.tripDetails.launchDate" />
695
- @if (bookingForm.tripDetails.launchDate().touched() &&
696
- bookingForm.tripDetails.launchDate().errors().length) {
697
- <span>{{ bookingForm.tripDetails.launchDate().errors()[0].message }}</span>
698
- }
699
- </label>
700
- </section>
701
-
702
- <section>
703
- <h2>Package</h2>
704
-
705
- <label>
706
- <input type="radio" value="economy" [formField]="bookingForm.package.tier" />
707
- Economy
708
- </label>
709
- <label>
710
- <input type="radio" value="business" [formField]="bookingForm.package.tier" />
711
- Business
712
- </label>
713
- <label>
714
- <input type="radio" value="first" [formField]="bookingForm.package.tier" />
715
- First Class
716
- </label>
717
-
718
- @if (!bookingForm.package.extras().hidden()) {
719
- <div>
720
- <h3>Extras</h3>
721
- <!-- Multi-select for arrays must use select multiple -->
722
- <select multiple [formField]="bookingForm.package.extras">
723
- <option value="wifi">WiFi</option>
724
- <option value="gym">Gym</option>
725
- </select>
726
- </div>
727
- }
728
- </section>
729
-
730
- <section>
731
- <h2>Companions</h2>
732
- <button type="button" (click)="addCompanion()">Add Companion</button>
733
-
734
- @for (companion of bookingForm.companions; track $index) {
735
- <div>
736
- <input [formField]="companion.name" placeholder="Name" />
737
- @if (companion.name().touched() && companion.name().errors().length) {
738
- <span>{{ companion.name().errors()[0].message }}</span>
739
- }
740
-
741
- <input [formField]="companion.relation" placeholder="Relation" />
742
- @if (companion.relation().touched() && companion.relation().errors().length) {
743
- <span>{{ companion.relation().errors()[0].message }}</span>
744
- }
745
-
746
- <button type="button" (click)="removeCompanion($index)">Remove</button>
747
- </div>
748
- }
749
- </section>
750
-
751
- <button [disabled]="bookingForm().invalid()">Submit</button>
752
- </form>
753
- ```
754
-
755
- ## Recovering from Build Errors
756
-
757
- If you encounter build errors, here are the most common fixes:
758
-
759
- ### `Property 'value' does not exist on type 'FieldTree'`
760
-
761
- **Problem**: Accessing `.value()` directly on a field without calling it first.
762
-
763
- ```ts
764
- // WRONG
765
- const val = this.form.field.value();
766
- // RIGHT
767
- const val = this.form.field().value();
768
- ```
769
-
770
- ### `Property 'set' does not exist on type 'FieldTree'`
771
-
772
- **Problem**: Trying to set values on the form tree. Signal Forms are model-driven.
773
-
774
- ```ts
775
- // WRONG
776
- this.form.address.street.set('Main St');
777
- // RIGHT - update the model signal instead
778
- this.model.update((m) => ({...m, address: {...m.address, street: 'Main St'}}));
779
- ```
780
-
781
- ### `Type 'string[]' is not assignable to type 'string'`
782
-
783
- **Problem**: Binding `[formField]` to an array field with a single-value `<select>`.
784
-
785
- ```html
786
- <!-- WRONG - assignees is string[], select expects string -->
787
- <select [formField]="form.assignees">
788
- ...
789
- </select>
790
-
791
- <!-- RIGHT - Use select multiple for array fields -->
792
- <select multiple [formField]="form.assignees">
793
- <option value="us">US</option>
794
- </select>
795
- ```
1
+ # Signal Forms
2
+
3
+ Signal Forms are recommended for new forms when the target Angular version supports them. They provide a reactive, type-safe, and model-driven way to manage form state using Angular Signals.
4
+
5
+ When using Signal Forms, do not use `null` as a value or type of any fields.
6
+
7
+ ## Imports
8
+
9
+ You can import the following from `@angular/forms/signals`:
10
+
11
+ ```ts
12
+ import {
13
+ form,
14
+ FormField,
15
+ submit,
16
+ // Rules for field state
17
+ disabled,
18
+ hidden,
19
+ readonly,
20
+ debounce,
21
+ // Schema helpers
22
+ applyWhen,
23
+ applyEach,
24
+ schema,
25
+ // Custom validation
26
+ validate,
27
+ validateHttp,
28
+ validateStandardSchema,
29
+ // Metadata
30
+ metadata,
31
+ } from '@angular/forms/signals';
32
+ ```
33
+
34
+ ## Creating a Form
35
+
36
+ Use the `form()` function with a Signal model. The structure of the form is derived directly from the model.
37
+
38
+ ```ts
39
+ import {Component, signal} from '@angular/core';
40
+ import {form, FormField} from '@angular/forms/signals';
41
+
42
+ @Component({
43
+ // ...
44
+ imports: [FormField],
45
+ })
46
+ export class Example {
47
+ // 1. Define your model with initial values (avoid undefined)
48
+ userModel = signal({
49
+ name: '', // CRITICAL: NEVER use null or undefined as initial values
50
+ email: '',
51
+ age: 0, // Use 0 for numbers, NOT null
52
+ address: {
53
+ street: '',
54
+ city: '',
55
+ },
56
+ hobbies: [] as string[], // Use [] for arrays, NOT null
57
+ });
58
+
59
+ // WRONG - DO NOT DO THIS:
60
+ // badModel = signal({
61
+ // name: null, // ERROR: use '' instead
62
+ // age: null, // ERROR: use 0 instead
63
+ // items: null // ERROR: use [] instead
64
+ // });
65
+
66
+ // 2. Create the form
67
+ userForm = form(this.userModel);
68
+ }
69
+ ```
70
+
71
+ ## Validation
72
+
73
+ Import validators from `@angular/forms/signals`.
74
+
75
+ ```ts
76
+ import {required, email, min, max, minLength, maxLength, pattern} from '@angular/forms/signals';
77
+ ```
78
+
79
+ Use them in the schema function passed to `form()`:
80
+
81
+ ```ts
82
+ userForm = form(this.userModel, (schemaPath) => {
83
+ // Required
84
+ required(schemaPath.name, {message: 'Name is required'});
85
+
86
+ // Conditional required.
87
+ required(schemaPath.name, {
88
+ when({valueOf}) {
89
+ return valueOf(schemaPath.age) > 10;
90
+ },
91
+ });
92
+ // when is only available for required
93
+ // Do NOT do this: pattern(p.name, /xxx/, {when /* ERROR */)
94
+
95
+ // Email
96
+ email(schemaPath.email, {message: 'Invalid email'});
97
+
98
+ // Min/Max for numbers
99
+ min(schemaPath.age, 18);
100
+ max(schemaPath.age, 100);
101
+
102
+ // MinLength/MaxLength for strings/arrays
103
+ minLength(schemaPath.password, 8);
104
+ maxLength(schemaPath.description, 500);
105
+
106
+ // Pattern (Regex)
107
+ pattern(schemaPath.zipCode, /^\d{5}$/);
108
+ });
109
+ ```
110
+
111
+ ## FieldState vs FormField: The Parental Requirement
112
+
113
+ It's important to understand the difference between **FormField** (the structure) and **FieldState** (the actual data/signals).
114
+
115
+ **RULE**: You must **CALL** a field as a function to access its state signals (valid, touched, dirty, hidden, etc.).
116
+
117
+ ```ts
118
+ // f is a FormField (structural)
119
+ const f = form(signal({cat: {name: 'pirojok-the-cat', age: 5}}));
120
+
121
+ f.cat.name; // FormField: You can't get flags from here!
122
+ f.cat.name.touched(); // ERROR: touched() does not exist on FormField
123
+
124
+ f.cat.name(); // FieldState: Calling it gives you access to signals
125
+ f.cat.name().touched(); // VALID: Accessing the signal
126
+ f.cat().name.touched(); // ERROR: f.cat() is state, it doesn't have children!
127
+ ```
128
+
129
+ Similarly in a template:
130
+
131
+ ```html
132
+ <!-- WRONG: Property 'hidden' does not exist on type 'FormField' -->
133
+ @if (bookingForm.hotelDetails.hidden()) { ... }
134
+
135
+ <!-- RIGHT: Call it first -->
136
+ @if (bookingForm.hotelDetails().hidden()) { ... }
137
+ ```
138
+
139
+ ## Disabled / Readonly / Hidden
140
+
141
+ Control field status using rules in the schema.
142
+
143
+ ```ts
144
+ import {disabled, readonly, hidden} from '@angular/forms/signals';
145
+
146
+ userForm = form(this.userModel, (schemaPath) => {
147
+ // Conditionally disabled
148
+ disabled(schemaPath.password, ({valueOf}) => !valueOf(schemaPath.createAccount));
149
+
150
+ // Conditionally hidden (does NOT remove from model, just marks as hidden)
151
+ hidden(schemaPath.shippingAddress, ({valueOf}) => valueOf(schemaPath.sameAsBilling));
152
+
153
+ // Readonly
154
+ readonly(schemaPath.username);
155
+ });
156
+ ```
157
+
158
+ ## Binding
159
+
160
+ Import `FormField` and use the `[formField]` directive.
161
+
162
+ ```ts
163
+ import {FormField} from '@angular/forms/signals';
164
+ ```
165
+
166
+ All props on state, such as `disabled`, `hidden`, `readonly` and `name` are bound automatically.
167
+ Do _NOT_ bind the `name` field.
168
+
169
+ **CRITICAL: FORBIDDEN ATTRIBUTES**
170
+ When using `[formField]`, you MUST NOT set the following attributes in the template (either static or bound):
171
+
172
+ - `min`, `max` (Use validators in the schema instead)
173
+ - `value`, `[value]`, `[attr.value]` (Already handled by `[formField]`)
174
+ - `[attr.min]`, `[attr.max]`
175
+ - `[disabled]`, `[readonly]` (Already handled by `[formField]`)
176
+
177
+ Do NOT do this: `<input min="1" [formField]>` or `<input [value]="val" [formField]>`.
178
+
179
+ ```html
180
+ <!-- Input -->
181
+ <input [formField]="userForm.name" />
182
+
183
+ <!-- Checkbox -->
184
+ <input type="checkbox" [formField]="userForm.isAdmin" />
185
+
186
+ <!-- Select -->
187
+ <select [formField]="userForm.country">
188
+ <option value="us">US</option>
189
+ </select>
190
+
191
+ <!-- userForm.name can NOT be nullable, because input does not accept null-->
192
+ <input [formField]="userForm.name" />
193
+ ```
194
+
195
+ ## Reactive Forms
196
+
197
+ **Do NOT import** `FormControl`, `FormGroup`, `FormArray`, or `FormBuilder` from `@angular/forms`. Signal Forms replace these concepts entirely.
198
+ Signal forms does NOT have a builder.
199
+
200
+ ## Accessing State
201
+
202
+ Each field in the form is a function that returns its state.
203
+
204
+ ```ts
205
+ // Access the field by calling it
206
+ const emailState = this.userForm.email();
207
+
208
+ // Value (WritableSignal)
209
+ const value = this.userForm().value();
210
+
211
+ // Validation State (Signals)
212
+ const isValid = this.userForm().valid();
213
+ const isInvalid = this.userForm().invalid();
214
+ const errors = this.userForm().errors(); // Array of errors
215
+ const isPending = this.userForm().pending(); // Async validation pending
216
+
217
+ // Interaction State (Signals)
218
+ const isTouched = this.userForm().touched();
219
+ const isDirty = this.userForm().dirty();
220
+
221
+ // Availability State (Signals)
222
+ const isDisabled = this.userForm().disabled();
223
+ const isHidden = this.userForm().hidden();
224
+ const isReadonly = this.userForm().readonly();
225
+ ```
226
+
227
+ IMPORTANT!: Make sure to call the field to get it state.
228
+
229
+ ```ts
230
+ form().invalid()
231
+ form.field().dirty()
232
+ form.field.subfield().touched()
233
+ form.a.b.c.d().value()
234
+ form.address.ssn().pending()
235
+ form().reset()
236
+
237
+ // The only exception is length:
238
+ form.children.length
239
+ form.length // NOTE: no parenthesis!
240
+ form.client.addresses.length // No "()"
241
+
242
+ @for (income of form.addresses; track $index) {/**/}
243
+ ```
244
+
245
+ ## Submitting
246
+
247
+ Use the `submit()` function. It automatically marks all fields as touched before running the action.
248
+
249
+ **CRITICAL**: The callback to `submit()` MUST be `async` and MUST return a Promise.
250
+
251
+ ```ts
252
+ import { submit } from '@angular/forms/signals';
253
+
254
+ // CORRECT - async callback
255
+ onSubmit() {
256
+ submit(this.userForm, async () => {
257
+ // This only runs if the form is valid
258
+ await this.apiService.save(this.userModel());
259
+ console.log('Saved!');
260
+ });
261
+ }
262
+
263
+ // WRONG - missing async keyword
264
+ onSubmit() {
265
+ submit(this.userForm, () => { // ERROR: must be async
266
+ console.log('Saved!');
267
+ });
268
+ }
269
+ ```
270
+
271
+ ## Handling Errors
272
+
273
+ `field().errors()` returns the errors array of ValidationError:
274
+
275
+ ```ts
276
+ interface ValidationError {
277
+ readonly kind: string;
278
+ readonly message?: string;
279
+ }
280
+ ```
281
+
282
+ Do _NOT_ return null from validators.
283
+ When there are no errors, return undefined
284
+
285
+ ### Context
286
+
287
+ Functions passed to rules like `validate()`, `disabled()`, `applyWhen` take a context object. It is **CRITICAL** to understand its structure:
288
+
289
+ ```ts
290
+ validate(
291
+ schemaPath.username,
292
+ ({
293
+ value, // Signal<T>: Writable current value of the field
294
+ fieldTree, // FieldTree<T>: Sub-fields (if it's a group/array)
295
+ state, // FieldState<T>: Access flags like state.valid(), state.dirty()
296
+ valueOf, // (path) => T: Read values of OTHER fields (tracking dependencies), e.g. valueOf(schemaPath.password)
297
+ stateOf, // (path) => FieldState: Access state (valid/dirty) of OTHER fields, e.g. stateOf(schemaPath.password).valid()
298
+ pathKeys, // Signal<string[]>: Path from root to this field
299
+ }) => {
300
+ // WRONG: if (touched()) ... (touched is not in context)
301
+ // RIGHT: if (state.touched()) ...
302
+
303
+ if (value() === 'admin') {
304
+ return {kind: 'reserved', message: 'Username admin is reserved'};
305
+ }
306
+ },
307
+ );
308
+ ```
309
+
310
+ ### IMPORTANT: Paths are NOT Signals
311
+
312
+ Inside the `form()` callback, `schemaPath` and its children (e.g., `schemaPath.user.name`) are **NOT** signals and are **NOT** callable.
313
+
314
+ ```ts
315
+ // WRONG - This will throw an error:
316
+ applyWhen(p.ssn, () => p.ssn().touched(), (ssnField) => { ... });
317
+
318
+ // RIGHT - Use stateOf() to get the state of a path:
319
+ applyWhen(p.ssn, ({ stateOf }) => stateOf(p.ssn).touched(), (ssnField) => { ... });
320
+
321
+ // RIGHT - Use valueOf() to get the value of a path:
322
+ applyWhen(p.ssn, ({ valueOf }) => valueOf(p.ssn) !== '', (ssnField) => { ... });
323
+ ```
324
+
325
+ ### Multiple Items
326
+
327
+ - Use `applyEach` for applying rules per item.
328
+ - **CRITICAL**: `applyEach` callback takes ONLY ONE argument (the item path), NOT two:
329
+
330
+ ```ts
331
+ // CORRECT - single argument
332
+ applyEach(s.items, (item) => {
333
+ required(item.name);
334
+ });
335
+
336
+ // WRONG - do NOT pass index
337
+ applyEach(s.items, (item, index) => {
338
+ // ERROR: callback takes 1 argument
339
+ required(item.name);
340
+ });
341
+ ```
342
+
343
+ - In the template use `@for` to iterate over the items.
344
+ - To remove an item from an array, just remove appropriate item from the array in the data.
345
+ - **`select` binding**: You CAN bind to `<select [formField]="form.country">`. Ensure options have `value` attributes.
346
+
347
+ ### Nested @for Loops
348
+
349
+ **CRITICAL**: Angular does NOT have `$parent`. In nested loops, store outer index in a variable:
350
+
351
+ ```html
352
+ <!-- WRONG - $parent does not exist -->
353
+ @for (item of form.items; track $index) { @for (option of item.options; track $index) {
354
+ <button (click)="removeOption($parent.$index, $index)">Remove</button>
355
+ <!-- ERROR -->
356
+ } }
357
+
358
+ <!-- CORRECT - use let to store outer index -->
359
+ @for (item of form.items; track $index; let outerIndex = $index) { @for (option of item.options;
360
+ track $index) {
361
+ <button (click)="removeOption(outerIndex, $index)">Remove</button>
362
+ } }
363
+ ```
364
+
365
+ ### Disabling Form Button
366
+
367
+ ```html
368
+ <button [disabled]="form().invalid() || form().pending()" />
369
+ <!-- Or -->
370
+ <button [disabled]="taxForm.invalid()" />
371
+ ```
372
+
373
+ Do NOT use `[disabled]` on an input. `[formField]` will do this.
374
+ Do NOT use `[readonly]` on an input. `[formField]` will do this.
375
+ If you need to disable or readonly a field, use `disabled()` or `readonly()` rules in the schema.
376
+
377
+ ### Async Validation
378
+
379
+ Do not use `validate()` for async, instead use `validateAsync()`:
380
+
381
+ **CRITICAL**:
382
+
383
+ 1. The `params` option MUST be a function that returns the value to validate.
384
+ 2. The `onError` handler is **REQUIRED** - it is NOT optional!
385
+
386
+ ```ts
387
+ import {resource} from '@angular/core';
388
+ import {validateAsync} from '@angular/forms/signals';
389
+
390
+ userForm = form(this.userModel, (s) => {
391
+ validateAsync(s.username, {
392
+ // 1. MUST be a function - params takes context and returns the value
393
+ params: ({value}) => value(),
394
+
395
+ // 2. Create the resource - factory receives a Signal
396
+ factory: (username) =>
397
+ resource({
398
+ params: username, // Use 'params' in resource()
399
+ loader: async ({params: value}) => {
400
+ await new Promise((resolve) => setTimeout(resolve, 1000));
401
+ return value === 'taken';
402
+ },
403
+ }),
404
+
405
+ // 3. Map success to errors
406
+ onSuccess: (isTaken) =>
407
+ isTaken ? {kind: 'taken', message: 'Username is already taken'} : undefined,
408
+
409
+ // 4. Handle errors - THIS IS REQUIRED!
410
+ onError: () => ({kind: 'error', message: 'Validation failed'}),
411
+ });
412
+ });
413
+ ```
414
+
415
+ **WRONG Examples:**
416
+
417
+ ```ts
418
+ // WRONG - params must be a function
419
+ validateAsync(s.username, {
420
+ params: s.username, // ERROR: must be ({ value }) => value()
421
+ // ...
422
+ });
423
+
424
+ // WRONG - missing onError (it's required!)
425
+ validateAsync(s.username, {
426
+ params: ({value}) => value(),
427
+ factory: (username) =>
428
+ resource({
429
+ /* ... */
430
+ }),
431
+ onSuccess: (result) => (result ? {kind: 'error'} : undefined),
432
+ // ERROR: 'onError' is missing but required!
433
+ });
434
+ ```
435
+
436
+ ### Using Resource
437
+
438
+ **CRITICAL**: In Angular's `resource()`, use `params` for the input signal.
439
+
440
+ ```ts
441
+ // CORRECT
442
+ resource({
443
+ params: mySignal,
444
+ loader: async ({params: value}) => {
445
+ /* ... */
446
+ },
447
+ });
448
+
449
+ // WRONG
450
+ resource({
451
+ request: mySignal, // ERROR: should be 'params'
452
+ loader: async ({request}) => {
453
+ /* ... */
454
+ },
455
+ });
456
+ ```
457
+
458
+ Use `debounce()` to delay synchronization between the UI and the model.
459
+
460
+ ```ts
461
+ import {debounce} from '@angular/forms/signals';
462
+
463
+ userForm = form(this.userModel, (s) => {
464
+ // Delay model updates by 300ms
465
+ debounce(s.username, 300);
466
+ });
467
+ ```
468
+
469
+ ### Conditional Validation
470
+
471
+ ```ts
472
+ form(
473
+ data,
474
+ (path) => {
475
+ applyWhen(
476
+ name,
477
+ ({value}) => value() !== 'admin',
478
+ (namePath) => {
479
+ validate(namePath.last /* ... */);
480
+ disable(namePath.last /* ... */);
481
+ },
482
+ );
483
+ },
484
+ {injector: TestBed.inject(Injector)},
485
+ );
486
+ ```
487
+
488
+ `applyWhen` passes the path mapped to the first argument.
489
+ If you need parent field, just pass it to `applyWhen`:
490
+
491
+ ```ts
492
+ form(
493
+ data,
494
+ (path) => {
495
+ applyWhen(
496
+ cat,
497
+ ({value}) => value().name !== 'admin',
498
+ (catPath) => {
499
+ require(cat.catPath /* ... */);
500
+ },
501
+ );
502
+ },
503
+ {injector: TestBed.inject(Injector)},
504
+ );
505
+ ```
506
+
507
+ ## Common Pitfalls (DO NOT DO THESE)
508
+
509
+ | Error Scenario | WRONG (Common Mistake) | RIGHT (Correct Way) |
510
+ | :--------------------- | :-------------------------------------------- | :---------------------------------------------------------- |
511
+ | **Accessing Flags** | `form.field.valid()` | `form.field().valid()` |
512
+ | **Accessing value** | `form.field.value()` | `form.field().value()` |
513
+ | **Setting value** | `form.field.set(x)` | Update model signal: `this.model.update(...)` |
514
+ | **Form root flags** | `form.invalid()` | `form().invalid()` |
515
+ | **Double-calling** | `form.field()()` | `form.field().value()` |
516
+ | **Rules Context** | `({ touched }) => touched()` | `({ state }) => state.touched()` |
517
+ | **Calling Paths** | `applyWhen(p.foo, () => p.foo() === 'x')` | `applyWhen(p.foo, ({ valueOf }) => valueOf(p.foo) === 'x')` |
518
+ | **applyWhen args** | `applyWhen(condition, () => {...})` | `applyWhen(path, condition, schemaFn)` - needs 3 args |
519
+ | **Array length** | `form.items().length` | `form.items.length` (structural) |
520
+ | **Multi-select array** | `<select [formField]="form.tags">` (string[]) | Use checkboxes for array fields |
521
+ | **readonly attribute** | `<input readonly [formField]>` | Use `readonly()` rule in schema |
522
+ | **min/max attributes** | `<input min="1" max="10">` | Use `min()` and `max()` rules in schema |
523
+ | **value binding** | `<input [value]="val">` | Do NOT use `[value]` with `[formField]` |
524
+ | **when option** | `pattern(p.x, /.../, {when: ...})` | `when` only works with `required()` |
525
+ | **Submit callback** | `submit(form, () => { ... })` | `submit(form, async () => { ... })` |
526
+ | **Async params** | `params: s.field` | `params: ({ value }) => value()` |
527
+ | **Async onError** | Omitting `onError` | `onError` is REQUIRED in `validateAsync` |
528
+ | **resource() API** | `request: signal` | `params: signal` |
529
+ | **applyEach args** | `applyEach(s.items, (item, index) => ...)` | `applyEach(s.items, (item) => ...)` |
530
+ | **Nested @for** | `$parent.$index` | Use `let outerIndex = $index` |
531
+ | **FormState import** | `import { FormState }` | `FormState` does not exist, use `FieldState` |
532
+ | **Null in model** | `signal({ name: null })` | `signal({ name: '' })` or `signal({ age: 0 })` |
533
+ | **Validate syntax** | `validate(s.field, { value } => ...)` | `validate(s.field, ({ value }) => ...)` |
534
+ | **Checkbox Array** | `[formField]="form.tags"` (string[]) | Checkboxes ONLY bind to `boolean` |
535
+
536
+ ## Big Form Example
537
+
538
+ ### `src/app/app.ts`
539
+
540
+ ```ts
541
+ import {Component, signal, ChangeDetectionStrategy} from '@angular/core';
542
+ import {
543
+ form,
544
+ FormField,
545
+ submit,
546
+ required,
547
+ email,
548
+ min,
549
+ hidden,
550
+ applyEach,
551
+ validate,
552
+ } from '@angular/forms/signals';
553
+
554
+ @Component({
555
+ selector: 'app-root',
556
+ standalone: true,
557
+ imports: [FormField],
558
+ templateUrl: './app.html',
559
+ changeDetection: ChangeDetectionStrategy.OnPush,
560
+ })
561
+ export class App {
562
+ model = signal({
563
+ personalInfo: {
564
+ firstName: '',
565
+ lastName: '',
566
+ email: '',
567
+ age: 0,
568
+ },
569
+ tripDetails: {
570
+ destination: 'Mars',
571
+ launchDate: '',
572
+ },
573
+ package: {
574
+ tier: 'economy',
575
+ extras: [] as string[],
576
+ },
577
+ companions: [] as Array<{name: string; relation: string}>,
578
+ });
579
+
580
+ bookingForm = form(this.model, (s) => {
581
+ required(s.personalInfo.firstName, {message: 'First name is required'});
582
+ required(s.personalInfo.lastName, {message: 'Last name is required'});
583
+ required(s.personalInfo.email, {message: 'Email is required'});
584
+ email(s.personalInfo.email, {message: 'Invalid email address'});
585
+ required(s.personalInfo.age, {message: 'Age is required'});
586
+ min(s.personalInfo.age, 18, {message: 'Must be at least 18'});
587
+
588
+ required(s.tripDetails.destination);
589
+ required(s.tripDetails.launchDate);
590
+ validate(s.tripDetails.launchDate, ({value}) => {
591
+ const date = new Date(value());
592
+ if (isNaN(date.getTime())) return undefined;
593
+ const today = new Date();
594
+ if (date < today) {
595
+ return {kind: 'pastData', message: 'Launch date must be in the future'};
596
+ }
597
+ return undefined;
598
+ });
599
+
600
+ // valueOf is used to access values of other fields in rules
601
+ hidden(s.package.extras, ({valueOf}) => valueOf(s.package.tier) === 'economy');
602
+
603
+ applyEach(s.companions, (companion) => {
604
+ required(companion.name, {message: 'Companion name required'});
605
+ required(companion.relation, {message: 'Relation required'});
606
+ });
607
+ });
608
+
609
+ addCompanion() {
610
+ this.model.update((m) => ({
611
+ ...m,
612
+ companions: [...m.companions, {name: '', relation: ''}],
613
+ }));
614
+ }
615
+
616
+ removeCompanion(index: number) {
617
+ this.model.update((m) => ({
618
+ ...m,
619
+ companions: m.companions.filter((_, i) => i !== index),
620
+ }));
621
+ }
622
+
623
+ onSubmit() {
624
+ // CRITICAL: submit callback MUST be async
625
+ submit(this.bookingForm, async () => {
626
+ console.log('Booking Confirmed:', this.model());
627
+ // If you need to do async work:
628
+ // await this.apiService.save(this.model());
629
+ });
630
+ }
631
+ }
632
+ ```
633
+
634
+ ### `src/app/app.html`
635
+
636
+ ```html
637
+ <form (submit)="onSubmit(); $event.preventDefault()">
638
+ <h1>Interstellar Booking</h1>
639
+
640
+ <section>
641
+ <h2>Personal Info</h2>
642
+
643
+ <label>
644
+ First Name
645
+ <input [formField]="bookingForm.personalInfo.firstName" />
646
+ @if (bookingForm.personalInfo.firstName().touched() &&
647
+ bookingForm.personalInfo.firstName().errors().length) {
648
+ <span>{{ bookingForm.personalInfo.firstName().errors()[0].message }}</span>
649
+ }
650
+ </label>
651
+
652
+ <label>
653
+ Last Name
654
+ <input [formField]="bookingForm.personalInfo.lastName" />
655
+ @if (bookingForm.personalInfo.lastName().touched() &&
656
+ bookingForm.personalInfo.lastName().errors().length) {
657
+ <span>{{ bookingForm.personalInfo.lastName().errors()[0].message }}</span>
658
+ }
659
+ </label>
660
+
661
+ <label>
662
+ Email
663
+ <input type="email" [formField]="bookingForm.personalInfo.email" />
664
+ @if (bookingForm.personalInfo.email().touched() &&
665
+ bookingForm.personalInfo.email().errors().length) {
666
+ <span>{{ bookingForm.personalInfo.email().errors()[0].message }}</span>
667
+ }
668
+ </label>
669
+
670
+ <label>
671
+ Age
672
+ <input type="number" [formField]="bookingForm.personalInfo.age" />
673
+ @if (bookingForm.personalInfo.age().touched() &&
674
+ bookingForm.personalInfo.age().errors().length) {
675
+ <span>{{ bookingForm.personalInfo.age().errors()[0].message }}</span>
676
+ }
677
+ </label>
678
+ </section>
679
+
680
+ <section>
681
+ <h2>Trip Details</h2>
682
+
683
+ <label>
684
+ Destination
685
+ <select [formField]="bookingForm.tripDetails.destination">
686
+ <option value="Mars">Mars</option>
687
+ <option value="Moon">Moon</option>
688
+ <option value="Titan">Titan</option>
689
+ </select>
690
+ </label>
691
+
692
+ <label>
693
+ Launch Date
694
+ <input type="date" [formField]="bookingForm.tripDetails.launchDate" />
695
+ @if (bookingForm.tripDetails.launchDate().touched() &&
696
+ bookingForm.tripDetails.launchDate().errors().length) {
697
+ <span>{{ bookingForm.tripDetails.launchDate().errors()[0].message }}</span>
698
+ }
699
+ </label>
700
+ </section>
701
+
702
+ <section>
703
+ <h2>Package</h2>
704
+
705
+ <label>
706
+ <input type="radio" value="economy" [formField]="bookingForm.package.tier" />
707
+ Economy
708
+ </label>
709
+ <label>
710
+ <input type="radio" value="business" [formField]="bookingForm.package.tier" />
711
+ Business
712
+ </label>
713
+ <label>
714
+ <input type="radio" value="first" [formField]="bookingForm.package.tier" />
715
+ First Class
716
+ </label>
717
+
718
+ @if (!bookingForm.package.extras().hidden()) {
719
+ <div>
720
+ <h3>Extras</h3>
721
+ <!-- Multi-select for arrays must use select multiple -->
722
+ <select multiple [formField]="bookingForm.package.extras">
723
+ <option value="wifi">WiFi</option>
724
+ <option value="gym">Gym</option>
725
+ </select>
726
+ </div>
727
+ }
728
+ </section>
729
+
730
+ <section>
731
+ <h2>Companions</h2>
732
+ <button type="button" (click)="addCompanion()">Add Companion</button>
733
+
734
+ @for (companion of bookingForm.companions; track $index) {
735
+ <div>
736
+ <input [formField]="companion.name" placeholder="Name" />
737
+ @if (companion.name().touched() && companion.name().errors().length) {
738
+ <span>{{ companion.name().errors()[0].message }}</span>
739
+ }
740
+
741
+ <input [formField]="companion.relation" placeholder="Relation" />
742
+ @if (companion.relation().touched() && companion.relation().errors().length) {
743
+ <span>{{ companion.relation().errors()[0].message }}</span>
744
+ }
745
+
746
+ <button type="button" (click)="removeCompanion($index)">Remove</button>
747
+ </div>
748
+ }
749
+ </section>
750
+
751
+ <button [disabled]="bookingForm().invalid()">Submit</button>
752
+ </form>
753
+ ```
754
+
755
+ ## Recovering from Build Errors
756
+
757
+ If you encounter build errors, here are the most common fixes:
758
+
759
+ ### `Property 'value' does not exist on type 'FieldTree'`
760
+
761
+ **Problem**: Accessing `.value()` directly on a field without calling it first.
762
+
763
+ ```ts
764
+ // WRONG
765
+ const val = this.form.field.value();
766
+ // RIGHT
767
+ const val = this.form.field().value();
768
+ ```
769
+
770
+ ### `Property 'set' does not exist on type 'FieldTree'`
771
+
772
+ **Problem**: Trying to set values on the form tree. Signal Forms are model-driven.
773
+
774
+ ```ts
775
+ // WRONG
776
+ this.form.address.street.set('Main St');
777
+ // RIGHT - update the model signal instead
778
+ this.model.update((m) => ({...m, address: {...m.address, street: 'Main St'}}));
779
+ ```
780
+
781
+ ### `Type 'string[]' is not assignable to type 'string'`
782
+
783
+ **Problem**: Binding `[formField]` to an array field with a single-value `<select>`.
784
+
785
+ ```html
786
+ <!-- WRONG - assignees is string[], select expects string -->
787
+ <select [formField]="form.assignees">
788
+ ...
789
+ </select>
790
+
791
+ <!-- RIGHT - Use select multiple for array fields -->
792
+ <select multiple [formField]="form.assignees">
793
+ <option value="us">US</option>
794
+ </select>
795
+ ```