@devo-bmad-custom/agent-orchestration 1.0.2 → 1.0.4

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 (605) hide show
  1. package/lib/installer.js +33 -0
  2. package/package.json +1 -1
  3. package/src/.agents/skills/audit-website/README.md +20 -20
  4. package/src/.agents/skills/audit-website/SKILL.md +470 -470
  5. package/src/.agents/skills/audit-website/agents/openai.yaml +6 -6
  6. package/src/.agents/skills/audit-website/assets/icon-small.svg +41 -41
  7. package/src/.agents/skills/audit-website/references/OUTPUT-FORMAT.md +250 -250
  8. package/src/.agents/skills/clean-code-standards/SKILL.md +104 -104
  9. package/src/.agents/skills/excalidraw-dark-standard/SKILL.md +281 -281
  10. package/src/.agents/skills/frontend-responsive-design-standards/SKILL.md +434 -434
  11. package/src/.agents/skills/java-fundamentals/SKILL.md +116 -116
  12. package/src/.agents/skills/java-performance/SKILL.md +119 -119
  13. package/src/.agents/skills/next-best-practices/SKILL.md +153 -153
  14. package/src/.agents/skills/next-best-practices/async-patterns.md +87 -87
  15. package/src/.agents/skills/next-best-practices/bundling.md +180 -180
  16. package/src/.agents/skills/next-best-practices/data-patterns.md +297 -297
  17. package/src/.agents/skills/next-best-practices/debug-tricks.md +105 -105
  18. package/src/.agents/skills/next-best-practices/directives.md +73 -73
  19. package/src/.agents/skills/next-best-practices/error-handling.md +227 -227
  20. package/src/.agents/skills/next-best-practices/file-conventions.md +140 -140
  21. package/src/.agents/skills/next-best-practices/font.md +245 -245
  22. package/src/.agents/skills/next-best-practices/functions.md +108 -108
  23. package/src/.agents/skills/next-best-practices/hydration-error.md +91 -91
  24. package/src/.agents/skills/next-best-practices/image.md +173 -173
  25. package/src/.agents/skills/next-best-practices/metadata.md +301 -301
  26. package/src/.agents/skills/next-best-practices/parallel-routes.md +287 -287
  27. package/src/.agents/skills/next-best-practices/route-handlers.md +146 -146
  28. package/src/.agents/skills/next-best-practices/rsc-boundaries.md +159 -159
  29. package/src/.agents/skills/next-best-practices/runtime-selection.md +39 -39
  30. package/src/.agents/skills/next-best-practices/scripts.md +141 -141
  31. package/src/.agents/skills/next-best-practices/self-hosting.md +371 -371
  32. package/src/.agents/skills/next-best-practices/suspense-boundaries.md +67 -67
  33. package/src/.agents/skills/nextjs-app-router-patterns/SKILL.md +537 -537
  34. package/src/.agents/skills/postgresql-optimization/SKILL.md +404 -404
  35. package/src/.agents/skills/python-backend/SKILL.md +153 -153
  36. package/src/.agents/skills/python-fundamentals/SKILL.md +234 -234
  37. package/src/.agents/skills/python-performance/SKILL.md +404 -404
  38. package/src/.agents/skills/react-expert/SKILL.md +335 -335
  39. package/src/.agents/skills/redis-best-practices/SKILL.md +438 -438
  40. package/src/.agents/skills/security-best-practices/SKILL.md +288 -288
  41. package/src/.agents/skills/security-review/LICENSE +22 -22
  42. package/src/.agents/skills/security-review/SKILL.md +312 -312
  43. package/src/.agents/skills/security-review/infrastructure/docker.md +432 -432
  44. package/src/.agents/skills/security-review/languages/javascript.md +388 -388
  45. package/src/.agents/skills/security-review/languages/python.md +363 -363
  46. package/src/.agents/skills/security-review/references/api-security.md +519 -519
  47. package/src/.agents/skills/security-review/references/authentication.md +353 -353
  48. package/src/.agents/skills/security-review/references/authorization.md +372 -372
  49. package/src/.agents/skills/security-review/references/business-logic.md +443 -443
  50. package/src/.agents/skills/security-review/references/cryptography.md +329 -329
  51. package/src/.agents/skills/security-review/references/csrf.md +398 -398
  52. package/src/.agents/skills/security-review/references/data-protection.md +378 -378
  53. package/src/.agents/skills/security-review/references/deserialization.md +410 -410
  54. package/src/.agents/skills/security-review/references/error-handling.md +436 -436
  55. package/src/.agents/skills/security-review/references/file-security.md +457 -457
  56. package/src/.agents/skills/security-review/references/injection.md +259 -259
  57. package/src/.agents/skills/security-review/references/logging.md +433 -433
  58. package/src/.agents/skills/security-review/references/misconfiguration.md +435 -435
  59. package/src/.agents/skills/security-review/references/modern-threats.md +475 -475
  60. package/src/.agents/skills/security-review/references/ssrf.md +415 -415
  61. package/src/.agents/skills/security-review/references/supply-chain.md +405 -405
  62. package/src/.agents/skills/security-review/references/xss.md +336 -336
  63. package/src/.agents/skills/subagent-driven-development/SKILL.md +275 -275
  64. package/src/.agents/skills/subagent-driven-development/code-quality-reviewer-prompt.md +26 -26
  65. package/src/.agents/skills/subagent-driven-development/implementer-prompt.md +113 -113
  66. package/src/.agents/skills/subagent-driven-development/spec-reviewer-prompt.md +61 -61
  67. package/src/.agents/skills/systematic-debugging/CREATION-LOG.md +119 -119
  68. package/src/.agents/skills/systematic-debugging/SKILL.md +296 -296
  69. package/src/.agents/skills/systematic-debugging/condition-based-waiting-example.ts +158 -158
  70. package/src/.agents/skills/systematic-debugging/condition-based-waiting.md +115 -115
  71. package/src/.agents/skills/systematic-debugging/defense-in-depth.md +122 -122
  72. package/src/.agents/skills/systematic-debugging/root-cause-tracing.md +169 -169
  73. package/src/.agents/skills/systematic-debugging/test-academic.md +14 -14
  74. package/src/.agents/skills/systematic-debugging/test-pressure-1.md +58 -58
  75. package/src/.agents/skills/systematic-debugging/test-pressure-2.md +68 -68
  76. package/src/.agents/skills/systematic-debugging/test-pressure-3.md +69 -69
  77. package/src/.agents/skills/typescript-best-practices/SKILL.md +373 -373
  78. package/src/.agents/skills/ui-ux-pro-custom/SKILL.md +348 -348
  79. package/src/.agents/skills/ui-ux-pro-custom/data/charts.csv +26 -26
  80. package/src/.agents/skills/ui-ux-pro-custom/data/colors.csv +97 -97
  81. package/src/.agents/skills/ui-ux-pro-custom/data/icons.csv +101 -101
  82. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/SKILL.md +106 -106
  83. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/accessibility.md +475 -475
  84. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/animation.md +466 -466
  85. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/composition-locals.md +231 -231
  86. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/deprecated-patterns.md +323 -323
  87. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/lists-scrolling.md +400 -400
  88. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/modifiers.md +331 -331
  89. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/navigation.md +416 -416
  90. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/performance.md +446 -446
  91. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/side-effects.md +516 -516
  92. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/source-code/foundation-source.md +13327 -13327
  93. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/source-code/material3-source.md +19097 -19097
  94. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/source-code/navigation-source.md +2947 -2947
  95. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/source-code/runtime-source.md +11316 -11316
  96. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/source-code/ui-source.md +7896 -7896
  97. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/state-management.md +377 -377
  98. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/styles-experimental.md +470 -470
  99. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/theming-material3.md +349 -349
  100. package/src/.agents/skills/ui-ux-pro-custom/data/jetpack-compose-expert-skill/references/view-composition.md +595 -595
  101. package/src/.agents/skills/ui-ux-pro-custom/data/landing.csv +31 -31
  102. package/src/.agents/skills/ui-ux-pro-custom/data/mobile-ui-layout.md +654 -654
  103. package/src/.agents/skills/ui-ux-pro-custom/data/products.csv +96 -96
  104. package/src/.agents/skills/ui-ux-pro-custom/data/react-performance.csv +45 -45
  105. package/src/.agents/skills/ui-ux-pro-custom/data/stacks/astro.csv +54 -54
  106. package/src/.agents/skills/ui-ux-pro-custom/data/stacks/flutter.csv +53 -53
  107. package/src/.agents/skills/ui-ux-pro-custom/data/stacks/html-tailwind.csv +56 -56
  108. package/src/.agents/skills/ui-ux-pro-custom/data/stacks/jetpack-compose.csv +53 -53
  109. package/src/.agents/skills/ui-ux-pro-custom/data/stacks/nextjs.csv +53 -53
  110. package/src/.agents/skills/ui-ux-pro-custom/data/stacks/nuxt-ui.csv +51 -51
  111. package/src/.agents/skills/ui-ux-pro-custom/data/stacks/nuxtjs.csv +59 -59
  112. package/src/.agents/skills/ui-ux-pro-custom/data/stacks/react-native.csv +56 -56
  113. package/src/.agents/skills/ui-ux-pro-custom/data/stacks/react.csv +54 -54
  114. package/src/.agents/skills/ui-ux-pro-custom/data/stacks/shadcn.csv +61 -61
  115. package/src/.agents/skills/ui-ux-pro-custom/data/stacks/svelte.csv +54 -54
  116. package/src/.agents/skills/ui-ux-pro-custom/data/stacks/swiftui.csv +51 -51
  117. package/src/.agents/skills/ui-ux-pro-custom/data/stacks/vue.csv +50 -50
  118. package/src/.agents/skills/ui-ux-pro-custom/data/styles.csv +68 -68
  119. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/alarmkit/SKILL.md +438 -438
  120. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/alarmkit/references/alarmkit-patterns.md +584 -584
  121. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/app-clips/SKILL.md +436 -436
  122. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/app-intents/SKILL.md +489 -489
  123. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/app-intents/references/appintents-advanced.md +1076 -1076
  124. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/app-store-review/SKILL.md +340 -340
  125. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/app-store-review/references/privacy-manifest.md +90 -90
  126. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/app-store-review/references/review-checklists.md +106 -106
  127. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/apple-on-device-ai/SKILL.md +500 -500
  128. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/apple-on-device-ai/references/coreml-conversion.md +425 -425
  129. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/apple-on-device-ai/references/coreml-optimization.md +344 -344
  130. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/apple-on-device-ai/references/foundation-models.md +508 -508
  131. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/apple-on-device-ai/references/mlx-swift.md +285 -285
  132. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/authentication/SKILL.md +496 -496
  133. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/authentication/references/keychain-biometric.md +211 -211
  134. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/background-processing/SKILL.md +499 -499
  135. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/background-processing/references/background-task-patterns.md +390 -390
  136. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/callkit-voip/SKILL.md +461 -461
  137. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/callkit-voip/references/callkit-patterns.md +425 -425
  138. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/cloudkit-sync/SKILL.md +492 -492
  139. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/cloudkit-sync/references/cloudkit-patterns.md +461 -461
  140. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/codable-patterns/SKILL.md +467 -467
  141. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/contacts-framework/SKILL.md +425 -425
  142. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/contacts-framework/references/contacts-patterns.md +409 -409
  143. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/core-bluetooth/SKILL.md +491 -491
  144. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/core-bluetooth/references/ble-patterns.md +435 -435
  145. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/core-motion/SKILL.md +388 -388
  146. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/core-motion/references/motion-patterns.md +405 -405
  147. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/core-nfc/SKILL.md +495 -495
  148. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/core-nfc/references/nfc-patterns.md +420 -420
  149. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/coreml/SKILL.md +459 -459
  150. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/coreml/references/coreml-swift-integration.md +765 -765
  151. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/debugging-instruments/SKILL.md +422 -422
  152. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/debugging-instruments/references/instruments-guide.md +387 -387
  153. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/debugging-instruments/references/lldb-patterns.md +298 -298
  154. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/device-integrity/SKILL.md +477 -477
  155. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/energykit/SKILL.md +460 -460
  156. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/energykit/references/energykit-patterns.md +541 -541
  157. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/eventkit-calendar/SKILL.md +483 -483
  158. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/eventkit-calendar/references/eventkit-patterns.md +326 -326
  159. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/healthkit/SKILL.md +498 -498
  160. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/healthkit/references/healthkit-patterns.md +602 -602
  161. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/homekit-matter/SKILL.md +496 -496
  162. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/homekit-matter/references/matter-commissioning.md +455 -455
  163. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/ios-accessibility/SKILL.md +301 -301
  164. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/ios-accessibility/references/a11y-patterns.md +140 -140
  165. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/ios-localization/SKILL.md +418 -418
  166. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/ios-localization/references/formatstyle-locale.md +627 -627
  167. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/ios-localization/references/string-catalogs.md +462 -462
  168. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/ios-networking/SKILL.md +441 -441
  169. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/ios-networking/references/background-websocket.md +862 -862
  170. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/ios-networking/references/lightweight-clients.md +93 -93
  171. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/ios-networking/references/network-framework.md +563 -563
  172. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/ios-networking/references/urlsession-patterns.md +1116 -1116
  173. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/ios-security/SKILL.md +496 -496
  174. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/ios-security/references/app-review-guidelines.md +174 -174
  175. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/ios-security/references/cryptokit-advanced.md +296 -296
  176. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/ios-security/references/file-storage-patterns.md +354 -354
  177. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/ios-security/references/privacy-manifest.md +117 -117
  178. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/live-activities/SKILL.md +500 -500
  179. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/live-activities/references/live-activity-patterns.md +868 -868
  180. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/mapkit-location/SKILL.md +485 -485
  181. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/mapkit-location/references/corelocation-patterns.md +730 -730
  182. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/mapkit-location/references/mapkit-patterns.md +748 -748
  183. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/metrickit-diagnostics/SKILL.md +479 -479
  184. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/musickit-audio/SKILL.md +395 -395
  185. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/musickit-audio/references/musickit-patterns.md +363 -363
  186. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/natural-language/SKILL.md +412 -412
  187. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/natural-language/references/translation-patterns.md +311 -311
  188. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/passkit-wallet/SKILL.md +398 -398
  189. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/passkit-wallet/references/wallet-passes.md +254 -254
  190. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/pencilkit-drawing/SKILL.md +387 -387
  191. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/pencilkit-drawing/references/paperkit-integration.md +376 -376
  192. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/pencilkit-drawing/references/pencilkit-patterns.md +302 -302
  193. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/permissionkit/SKILL.md +446 -446
  194. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/permissionkit/references/permissionkit-patterns.md +435 -435
  195. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/photos-camera-media/SKILL.md +500 -500
  196. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/photos-camera-media/references/av-playback.md +701 -701
  197. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/photos-camera-media/references/camera-capture.md +774 -774
  198. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/photos-camera-media/references/image-loading-caching.md +869 -869
  199. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/photos-camera-media/references/photospicker-patterns.md +597 -597
  200. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/push-notifications/SKILL.md +500 -500
  201. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/push-notifications/references/notification-patterns.md +677 -677
  202. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/push-notifications/references/rich-notifications.md +745 -745
  203. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/realitykit-ar/SKILL.md +479 -479
  204. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/realitykit-ar/references/realitykit-patterns.md +480 -480
  205. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/shareplay-activities/SKILL.md +483 -483
  206. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/shareplay-activities/references/shareplay-patterns.md +544 -544
  207. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/speech-recognition/SKILL.md +485 -485
  208. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/storekit/SKILL.md +478 -478
  209. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/storekit/references/app-review-guidelines.md +58 -58
  210. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/storekit/references/storekit-advanced.md +755 -755
  211. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swift-charts/SKILL.md +487 -487
  212. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swift-charts/references/charts-patterns.md +895 -895
  213. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swift-concurrency/SKILL.md +408 -408
  214. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swift-concurrency/references/approachable-concurrency.md +80 -80
  215. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swift-concurrency/references/swift-6-2-concurrency.md +233 -233
  216. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swift-concurrency/references/swiftui-concurrency.md +187 -187
  217. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swift-concurrency/references/synchronization-primitives.md +341 -341
  218. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swift-language/SKILL.md +498 -498
  219. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swift-language/references/swift-patterns-extended.md +505 -505
  220. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swift-testing/SKILL.md +467 -467
  221. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swift-testing/references/testing-patterns.md +504 -504
  222. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftdata/SKILL.md +334 -334
  223. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftdata/references/core-data-coexistence.md +504 -504
  224. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftdata/references/swiftdata-advanced.md +975 -975
  225. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftdata/references/swiftdata-queries.md +675 -675
  226. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-animation/SKILL.md +481 -481
  227. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-animation/references/animation-advanced.md +804 -804
  228. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-animation/references/core-animation-bridge.md +553 -553
  229. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-gestures/SKILL.md +450 -450
  230. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-gestures/references/gesture-patterns.md +425 -425
  231. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-layout-components/SKILL.md +336 -336
  232. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-layout-components/references/form.md +97 -97
  233. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-layout-components/references/grids.md +69 -69
  234. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-layout-components/references/list.md +99 -99
  235. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-layout-components/references/scrollview.md +147 -147
  236. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-liquid-glass/SKILL.md +325 -325
  237. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-liquid-glass/references/liquid-glass.md +387 -387
  238. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-navigation/SKILL.md +262 -262
  239. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-navigation/references/deeplinks.md +207 -207
  240. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-navigation/references/navigationstack.md +177 -177
  241. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-navigation/references/sheets.md +169 -169
  242. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-navigation/references/tabview.md +178 -178
  243. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-patterns/SKILL.md +381 -381
  244. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-patterns/references/architecture-patterns.md +486 -486
  245. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-patterns/references/deprecated-migration.md +1097 -1097
  246. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-patterns/references/design-polish.md +780 -780
  247. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-patterns/references/platform-and-sharing.md +696 -696
  248. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-performance/SKILL.md +491 -491
  249. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-performance/references/demystify-swiftui-performance-wwdc23.md +46 -46
  250. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-performance/references/optimizing-swiftui-performance-instruments.md +29 -29
  251. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-performance/references/understanding-hangs-in-your-app.md +33 -33
  252. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-performance/references/understanding-improving-swiftui-performance.md +52 -52
  253. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-uikit-interop/SKILL.md +428 -428
  254. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-uikit-interop/references/hosting-migration.md +534 -534
  255. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/swiftui-uikit-interop/references/representable-recipes.md +1133 -1133
  256. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/tipkit/SKILL.md +494 -494
  257. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/tipkit/references/tipkit-patterns.md +782 -782
  258. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/vision-framework/SKILL.md +475 -475
  259. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/vision-framework/references/vision-requests.md +736 -736
  260. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/vision-framework/references/visionkit-scanner.md +738 -738
  261. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/weatherkit/SKILL.md +410 -410
  262. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/weatherkit/references/weatherkit-patterns.md +567 -567
  263. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/widgetkit/SKILL.md +497 -497
  264. package/src/.agents/skills/ui-ux-pro-custom/data/swift-ios-skills/widgetkit/references/widgetkit-advanced.md +871 -871
  265. package/src/.agents/skills/ui-ux-pro-custom/data/typography.csv +57 -57
  266. package/src/.agents/skills/ui-ux-pro-custom/data/ui-reasoning.csv +101 -101
  267. package/src/.agents/skills/ui-ux-pro-custom/data/ux-guidelines.csv +99 -99
  268. package/src/.agents/skills/ui-ux-pro-custom/data/web-interface.csv +31 -31
  269. package/src/.agents/skills/ui-ux-pro-custom/scripts/core.py +253 -253
  270. package/src/.agents/skills/ui-ux-pro-custom/scripts/design_system.py +1067 -1067
  271. package/src/.agents/skills/ui-ux-pro-custom/scripts/search.py +114 -114
  272. package/src/.agents/skills/ux-audit/SKILL.md +150 -150
  273. package/src/.agents/skills/websocket-engineer/SKILL.md +168 -168
  274. package/src/.agents/skills/websocket-engineer/references/alternatives.md +391 -391
  275. package/src/.agents/skills/websocket-engineer/references/patterns.md +400 -400
  276. package/src/.agents/skills/websocket-engineer/references/protocol.md +195 -195
  277. package/src/.agents/skills/websocket-engineer/references/scaling.md +333 -333
  278. package/src/.agents/skills/websocket-engineer/references/security.md +474 -474
  279. package/src/.agents/skills/writing-skills/SKILL.md +655 -655
  280. package/src/.agents/skills/writing-skills/anthropic-best-practices.md +1150 -1150
  281. package/src/.agents/skills/writing-skills/examples/CLAUDE_MD_TESTING.md +189 -189
  282. package/src/.agents/skills/writing-skills/graphviz-conventions.dot +171 -171
  283. package/src/.agents/skills/writing-skills/persuasion-principles.md +187 -187
  284. package/src/.agents/skills/writing-skills/render-graphs.js +168 -168
  285. package/src/.agents/skills/writing-skills/testing-skills-with-subagents.md +384 -384
  286. package/src/.claude/commands/master-orchestrator.md +15 -0
  287. package/src/_memory/config.yaml +11 -11
  288. package/src/_memory/master-orchestrator-sidecar/instructions.md +97 -47
  289. package/src/_memory/skills/nimbalyst-tracking/SKILL.md +103 -103
  290. package/src/_memory/skills/writing-skills/SKILL.md +655 -655
  291. package/src/bmb/agents/agent-builder.md +59 -59
  292. package/src/bmb/agents/module-builder.md +60 -60
  293. package/src/bmb/agents/workflow-builder.md +61 -61
  294. package/src/bmb/config.yaml +12 -12
  295. package/src/bmb/module-help.csv +13 -13
  296. package/src/bmb/workflows/agent/data/agent-architecture.md +258 -258
  297. package/src/bmb/workflows/agent/data/agent-compilation.md +185 -185
  298. package/src/bmb/workflows/agent/data/agent-menu-patterns.md +189 -189
  299. package/src/bmb/workflows/agent/data/agent-metadata.md +133 -133
  300. package/src/bmb/workflows/agent/data/agent-validation.md +111 -111
  301. package/src/bmb/workflows/agent/data/brainstorm-context.md +96 -96
  302. package/src/bmb/workflows/agent/data/communication-presets.csv +61 -61
  303. package/src/bmb/workflows/agent/data/critical-actions.md +75 -75
  304. package/src/bmb/workflows/agent/data/persona-properties.md +252 -252
  305. package/src/bmb/workflows/agent/data/principles-crafting.md +142 -142
  306. package/src/bmb/workflows/agent/data/reference/module-examples/architect.md +68 -68
  307. package/src/bmb/workflows/agent/data/reference/with-sidecar/journal-keeper/journal-keeper-sidecar/entries/yy-mm-dd-entry-template.md +16 -16
  308. package/src/bmb/workflows/agent/data/understanding-agent-types.md +126 -126
  309. package/src/bmb/workflows/agent/steps-c/step-01-brainstorm.md +129 -129
  310. package/src/bmb/workflows/agent/steps-c/step-02-discovery.md +170 -170
  311. package/src/bmb/workflows/agent/steps-c/step-03-sidecar-metadata.md +309 -309
  312. package/src/bmb/workflows/agent/steps-c/step-04-persona.md +213 -213
  313. package/src/bmb/workflows/agent/steps-c/step-05-commands-menu.md +179 -179
  314. package/src/bmb/workflows/agent/steps-c/step-06-activation.md +278 -278
  315. package/src/bmb/workflows/agent/steps-c/step-07-build-agent.md +316 -316
  316. package/src/bmb/workflows/agent/steps-c/step-08-celebrate.md +247 -247
  317. package/src/bmb/workflows/agent/steps-e/e-01-load-existing.md +221 -221
  318. package/src/bmb/workflows/agent/steps-e/e-02-discover-edits.md +195 -195
  319. package/src/bmb/workflows/agent/steps-e/e-04-sidecar-metadata.md +126 -126
  320. package/src/bmb/workflows/agent/steps-e/e-05-persona.md +135 -135
  321. package/src/bmb/workflows/agent/steps-e/e-06-commands-menu.md +123 -123
  322. package/src/bmb/workflows/agent/steps-e/e-07-activation.md +124 -124
  323. package/src/bmb/workflows/agent/steps-e/e-08-edit-agent.md +197 -197
  324. package/src/bmb/workflows/agent/steps-e/e-09-celebrate.md +155 -155
  325. package/src/bmb/workflows/agent/steps-v/v-01-load-review.md +137 -137
  326. package/src/bmb/workflows/agent/steps-v/v-02a-validate-metadata.md +116 -116
  327. package/src/bmb/workflows/agent/steps-v/v-02b-validate-persona.md +124 -124
  328. package/src/bmb/workflows/agent/steps-v/v-02c-validate-menu.md +127 -127
  329. package/src/bmb/workflows/agent/steps-v/v-02d-validate-structure.md +134 -134
  330. package/src/bmb/workflows/agent/steps-v/v-02e-validate-sidecar.md +134 -134
  331. package/src/bmb/workflows/agent/steps-v/v-03-summary.md +104 -104
  332. package/src/bmb/workflows/agent/templates/agent-plan.template.md +5 -5
  333. package/src/bmb/workflows/agent/templates/agent-template.md +89 -89
  334. package/src/bmb/workflows/agent/workflow-create-agent.md +72 -72
  335. package/src/bmb/workflows/agent/workflow-edit-agent.md +75 -75
  336. package/src/bmb/workflows/agent/workflow-validate-agent.md +73 -73
  337. package/src/bmb/workflows/module/data/agent-architecture.md +179 -179
  338. package/src/bmb/workflows/module/data/agent-spec-template.md +79 -79
  339. package/src/bmb/workflows/module/data/module-standards.md +263 -263
  340. package/src/bmb/workflows/module/data/module-yaml-conventions.md +392 -392
  341. package/src/bmb/workflows/module/module-help-generate.md +254 -254
  342. package/src/bmb/workflows/module/steps-b/step-01-welcome.md +148 -148
  343. package/src/bmb/workflows/module/steps-b/step-02-spark.md +141 -141
  344. package/src/bmb/workflows/module/steps-b/step-03-module-type.md +149 -149
  345. package/src/bmb/workflows/module/steps-b/step-04-vision.md +83 -83
  346. package/src/bmb/workflows/module/steps-b/step-05-identity.md +97 -97
  347. package/src/bmb/workflows/module/steps-b/step-06-users.md +86 -86
  348. package/src/bmb/workflows/module/steps-b/step-07-value.md +76 -76
  349. package/src/bmb/workflows/module/steps-b/step-08-agents.md +97 -97
  350. package/src/bmb/workflows/module/steps-b/step-09-workflows.md +83 -83
  351. package/src/bmb/workflows/module/steps-b/step-10-tools.md +91 -91
  352. package/src/bmb/workflows/module/steps-b/step-11-scenarios.md +84 -84
  353. package/src/bmb/workflows/module/steps-b/step-12-creative.md +95 -95
  354. package/src/bmb/workflows/module/steps-b/step-13-review.md +105 -105
  355. package/src/bmb/workflows/module/steps-b/step-14-finalize.md +117 -117
  356. package/src/bmb/workflows/module/steps-c/step-01-load-brief.md +179 -179
  357. package/src/bmb/workflows/module/steps-c/step-01b-continue.md +82 -82
  358. package/src/bmb/workflows/module/steps-c/step-02-structure.md +105 -105
  359. package/src/bmb/workflows/module/steps-c/step-03-config.md +119 -119
  360. package/src/bmb/workflows/module/steps-c/step-04-agents.md +168 -168
  361. package/src/bmb/workflows/module/steps-c/step-05-workflows.md +184 -184
  362. package/src/bmb/workflows/module/steps-c/step-06-docs.md +401 -401
  363. package/src/bmb/workflows/module/steps-c/step-07-complete.md +152 -152
  364. package/src/bmb/workflows/module/steps-e/step-01-load-target.md +81 -81
  365. package/src/bmb/workflows/module/steps-e/step-02-select-edit.md +77 -77
  366. package/src/bmb/workflows/module/steps-e/step-03-apply-edit.md +77 -77
  367. package/src/bmb/workflows/module/steps-e/step-04-review.md +80 -80
  368. package/src/bmb/workflows/module/steps-e/step-05-confirm.md +75 -75
  369. package/src/bmb/workflows/module/steps-v/step-01-load-target.md +96 -96
  370. package/src/bmb/workflows/module/steps-v/step-02-file-structure.md +93 -93
  371. package/src/bmb/workflows/module/steps-v/step-03-module-yaml.md +99 -99
  372. package/src/bmb/workflows/module/steps-v/step-04-agent-specs.md +152 -152
  373. package/src/bmb/workflows/module/steps-v/step-05-workflow-specs.md +152 -152
  374. package/src/bmb/workflows/module/steps-v/step-06-documentation.md +143 -143
  375. package/src/bmb/workflows/module/steps-v/step-07-installation.md +102 -102
  376. package/src/bmb/workflows/module/steps-v/step-08-report.md +197 -197
  377. package/src/bmb/workflows/module/templates/brief-template.md +154 -154
  378. package/src/bmb/workflows/module/templates/workflow-spec-template.md +96 -96
  379. package/src/bmb/workflows/module/workflow-create-module-brief.md +71 -71
  380. package/src/bmb/workflows/module/workflow-create-module.md +86 -86
  381. package/src/bmb/workflows/module/workflow-edit-module.md +66 -66
  382. package/src/bmb/workflows/module/workflow-validate-module.md +66 -66
  383. package/src/bmb/workflows/workflow/data/architecture.md +150 -150
  384. package/src/bmb/workflows/workflow/data/common-workflow-tools.csv +19 -19
  385. package/src/bmb/workflows/workflow/data/csv-data-file-standards.md +53 -53
  386. package/src/bmb/workflows/workflow/data/frontmatter-standards.md +184 -184
  387. package/src/bmb/workflows/workflow/data/input-discovery-standards.md +191 -191
  388. package/src/bmb/workflows/workflow/data/intent-vs-prescriptive-spectrum.md +44 -44
  389. package/src/bmb/workflows/workflow/data/menu-handling-standards.md +133 -133
  390. package/src/bmb/workflows/workflow/data/output-format-standards.md +135 -135
  391. package/src/bmb/workflows/workflow/data/step-file-rules.md +235 -235
  392. package/src/bmb/workflows/workflow/data/step-type-patterns.md +257 -257
  393. package/src/bmb/workflows/workflow/data/subprocess-optimization-patterns.md +188 -188
  394. package/src/bmb/workflows/workflow/data/trimodal-workflow-structure.md +164 -164
  395. package/src/bmb/workflows/workflow/data/workflow-chaining-standards.md +222 -222
  396. package/src/bmb/workflows/workflow/data/workflow-examples.md +232 -232
  397. package/src/bmb/workflows/workflow/data/workflow-type-criteria.md +134 -134
  398. package/src/bmb/workflows/workflow/steps-c/step-00-conversion.md +263 -263
  399. package/src/bmb/workflows/workflow/steps-c/step-01-discovery.md +194 -194
  400. package/src/bmb/workflows/workflow/steps-c/step-01b-continuation.md +3 -3
  401. package/src/bmb/workflows/workflow/steps-c/step-02-classification.md +270 -270
  402. package/src/bmb/workflows/workflow/steps-c/step-03-requirements.md +283 -283
  403. package/src/bmb/workflows/workflow/steps-c/step-04-tools.md +282 -282
  404. package/src/bmb/workflows/workflow/steps-c/step-05-plan-review.md +243 -243
  405. package/src/bmb/workflows/workflow/steps-c/step-06-design.md +330 -330
  406. package/src/bmb/workflows/workflow/steps-c/step-07-foundation.md +239 -239
  407. package/src/bmb/workflows/workflow/steps-c/step-08-build-step-01.md +379 -379
  408. package/src/bmb/workflows/workflow/steps-c/step-09-build-next-step.md +350 -350
  409. package/src/bmb/workflows/workflow/steps-c/step-10-confirmation.md +322 -322
  410. package/src/bmb/workflows/workflow/steps-c/step-11-completion.md +191 -191
  411. package/src/bmb/workflows/workflow/steps-e/step-e-01-assess-workflow.md +237 -237
  412. package/src/bmb/workflows/workflow/steps-e/step-e-02-discover-edits.md +251 -251
  413. package/src/bmb/workflows/workflow/steps-e/step-e-03-fix-validation.md +254 -254
  414. package/src/bmb/workflows/workflow/steps-e/step-e-04-direct-edit.md +277 -277
  415. package/src/bmb/workflows/workflow/steps-e/step-e-05-apply-edit.md +154 -154
  416. package/src/bmb/workflows/workflow/steps-e/step-e-06-validate-after.md +190 -190
  417. package/src/bmb/workflows/workflow/steps-e/step-e-07-complete.md +206 -206
  418. package/src/bmb/workflows/workflow/steps-v/step-01-validate-max-mode.md +109 -109
  419. package/src/bmb/workflows/workflow/steps-v/step-01-validate.md +221 -221
  420. package/src/bmb/workflows/workflow/steps-v/step-01b-structure.md +152 -152
  421. package/src/bmb/workflows/workflow/steps-v/step-02-frontmatter-validation.md +199 -199
  422. package/src/bmb/workflows/workflow/steps-v/step-02b-path-violations.md +265 -265
  423. package/src/bmb/workflows/workflow/steps-v/step-03-menu-validation.md +164 -164
  424. package/src/bmb/workflows/workflow/steps-v/step-04-step-type-validation.md +211 -211
  425. package/src/bmb/workflows/workflow/steps-v/step-05-output-format-validation.md +200 -200
  426. package/src/bmb/workflows/workflow/steps-v/step-06-validation-design-check.md +195 -195
  427. package/src/bmb/workflows/workflow/steps-v/step-07-instruction-style-check.md +209 -209
  428. package/src/bmb/workflows/workflow/steps-v/step-08-collaborative-experience-check.md +199 -199
  429. package/src/bmb/workflows/workflow/steps-v/step-08b-subprocess-optimization.md +179 -179
  430. package/src/bmb/workflows/workflow/steps-v/step-09-cohesive-review.md +186 -186
  431. package/src/bmb/workflows/workflow/steps-v/step-10-report-complete.md +154 -154
  432. package/src/bmb/workflows/workflow/steps-v/step-11-plan-validation.md +237 -237
  433. package/src/bmb/workflows/workflow/templates/minimal-output-template.md +11 -11
  434. package/src/bmb/workflows/workflow/templates/step-01-init-continuable-template.md +241 -241
  435. package/src/bmb/workflows/workflow/templates/step-1b-template.md +224 -224
  436. package/src/bmb/workflows/workflow/templates/step-template.md +294 -294
  437. package/src/bmb/workflows/workflow/templates/workflow-template.md +102 -102
  438. package/src/bmb/workflows/workflow/workflow-create-workflow.md +79 -79
  439. package/src/bmb/workflows/workflow/workflow-edit-workflow.md +65 -65
  440. package/src/bmb/workflows/workflow/workflow-rework-workflow.md +65 -65
  441. package/src/bmb/workflows/workflow/workflow-validate-max-parallel-workflow.md +66 -66
  442. package/src/bmb/workflows/workflow/workflow-validate-workflow.md +65 -65
  443. package/src/bmm/agents/analyst.md +104 -104
  444. package/src/bmm/agents/dev.md +100 -100
  445. package/src/bmm/agents/qa.md +100 -90
  446. package/src/bmm/agents/tech-writer/tech-writer.md +94 -94
  447. package/src/bmm/module-help.csv +31 -31
  448. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-01-init.md +115 -115
  449. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-01b-continue.md +107 -107
  450. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-02-vision.md +141 -141
  451. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-03-users.md +144 -144
  452. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-04-metrics.md +147 -147
  453. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-05-scope.md +161 -161
  454. package/src/bmm/workflows/1-analysis/create-product-brief/steps/step-06-complete.md +99 -99
  455. package/src/bmm/workflows/1-analysis/create-product-brief/workflow.md +57 -57
  456. package/src/bmm/workflows/1-analysis/research/domain-steps/step-01-init.md +87 -87
  457. package/src/bmm/workflows/1-analysis/research/domain-steps/step-02-domain-analysis.md +156 -156
  458. package/src/bmm/workflows/1-analysis/research/domain-steps/step-03-competitive-landscape.md +165 -165
  459. package/src/bmm/workflows/1-analysis/research/domain-steps/step-04-regulatory-focus.md +140 -140
  460. package/src/bmm/workflows/1-analysis/research/domain-steps/step-05-technical-trends.md +152 -152
  461. package/src/bmm/workflows/1-analysis/research/domain-steps/step-06-research-synthesis.md +345 -345
  462. package/src/bmm/workflows/1-analysis/research/market-steps/step-01-init.md +92 -92
  463. package/src/bmm/workflows/1-analysis/research/market-steps/step-02-customer-behavior.md +164 -164
  464. package/src/bmm/workflows/1-analysis/research/market-steps/step-03-customer-pain-points.md +174 -174
  465. package/src/bmm/workflows/1-analysis/research/market-steps/step-04-customer-decisions.md +184 -184
  466. package/src/bmm/workflows/1-analysis/research/market-steps/step-05-competitive-analysis.md +105 -105
  467. package/src/bmm/workflows/1-analysis/research/market-steps/step-06-research-completion.md +360 -360
  468. package/src/bmm/workflows/1-analysis/research/technical-steps/step-01-init.md +87 -87
  469. package/src/bmm/workflows/1-analysis/research/technical-steps/step-02-technical-overview.md +165 -165
  470. package/src/bmm/workflows/1-analysis/research/technical-steps/step-03-integration-patterns.md +174 -174
  471. package/src/bmm/workflows/1-analysis/research/technical-steps/step-04-architectural-patterns.md +141 -141
  472. package/src/bmm/workflows/1-analysis/research/technical-steps/step-05-implementation-research.md +159 -159
  473. package/src/bmm/workflows/1-analysis/research/technical-steps/step-06-research-synthesis.md +387 -387
  474. package/src/bmm/workflows/1-analysis/research/workflow-domain-research.md +54 -54
  475. package/src/bmm/workflows/1-analysis/research/workflow-market-research.md +54 -54
  476. package/src/bmm/workflows/1-analysis/research/workflow-technical-research.md +54 -54
  477. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-01b-continue.md +100 -100
  478. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02-discovery.md +160 -160
  479. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02b-vision.md +88 -88
  480. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-02c-executive-summary.md +99 -99
  481. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-03-success.md +169 -169
  482. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-04-journeys.md +156 -156
  483. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-05-domain.md +136 -136
  484. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-06-innovation.md +176 -176
  485. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-07-project-type.md +184 -184
  486. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-08-scoping.md +174 -174
  487. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-09-functional.md +175 -175
  488. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-10-nonfunctional.md +189 -189
  489. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-11-polish.md +162 -162
  490. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-c/step-12-complete.md +79 -79
  491. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01-discovery.md +183 -183
  492. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-01b-legacy-conversion.md +149 -149
  493. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-02-review.md +187 -187
  494. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-03-edit.md +192 -192
  495. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-e/step-e-04-complete.md +108 -108
  496. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-01-discovery.md +166 -166
  497. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02-format-detection.md +131 -131
  498. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-02b-parity-check.md +150 -150
  499. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-03-density-validation.md +118 -118
  500. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-04-brief-coverage-validation.md +155 -155
  501. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-05-measurability-validation.md +170 -170
  502. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-06-traceability-validation.md +158 -158
  503. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-07-implementation-leakage-validation.md +147 -147
  504. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-08-domain-compliance-validation.md +182 -182
  505. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-09-project-type-validation.md +202 -202
  506. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-10-smart-validation.md +148 -148
  507. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-11-holistic-quality-validation.md +201 -201
  508. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-12-completeness-validation.md +179 -179
  509. package/src/bmm/workflows/2-plan-workflows/create-prd/steps-v/step-v-13-report-complete.md +164 -164
  510. package/src/bmm/workflows/2-plan-workflows/create-prd/workflow-create-prd.md +65 -65
  511. package/src/bmm/workflows/2-plan-workflows/create-prd/workflow-edit-prd.md +65 -65
  512. package/src/bmm/workflows/2-plan-workflows/create-prd/workflow-validate-prd.md +63 -63
  513. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-01b-continue.md +63 -63
  514. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-02-discovery.md +106 -106
  515. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-03-core-experience.md +111 -111
  516. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-04-emotional-response.md +115 -115
  517. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-05-inspiration.md +127 -127
  518. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-06-design-system.md +167 -167
  519. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-07-defining-experience.md +143 -143
  520. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-08-visual-foundation.md +118 -118
  521. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-09-design-directions.md +154 -154
  522. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-10-user-journeys.md +136 -136
  523. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-11-component-strategy.md +165 -165
  524. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-12-ux-patterns.md +135 -135
  525. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-13-responsive-accessibility.md +192 -192
  526. package/src/bmm/workflows/2-plan-workflows/create-ux-design/steps/step-14-complete.md +101 -101
  527. package/src/bmm/workflows/2-plan-workflows/create-ux-design/workflow.md +45 -45
  528. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-01-document-discovery.md +185 -185
  529. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-02-prd-analysis.md +129 -129
  530. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-03-epic-coverage-validation.md +130 -130
  531. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-04-ux-alignment.md +93 -93
  532. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-05-epic-quality-review.md +196 -196
  533. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/steps/step-06-final-assessment.md +129 -129
  534. package/src/bmm/workflows/3-solutioning/check-implementation-readiness/workflow.md +54 -54
  535. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-01b-continue.md +82 -82
  536. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-02-context.md +106 -106
  537. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-03-starter.md +138 -138
  538. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-04-decisions.md +129 -129
  539. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-05-patterns.md +166 -166
  540. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-06-structure.md +186 -186
  541. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-07-validation.md +163 -163
  542. package/src/bmm/workflows/3-solutioning/create-architecture/steps/step-08-complete.md +38 -38
  543. package/src/bmm/workflows/3-solutioning/create-architecture/workflow.md +49 -49
  544. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-02-design-epics.md +124 -124
  545. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-03-create-stories.md +122 -122
  546. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/steps/step-04-final-validation.md +84 -84
  547. package/src/bmm/workflows/3-solutioning/create-epics-and-stories/workflow.md +58 -58
  548. package/src/bmm/workflows/4-implementation/code-review/workflow.yaml +43 -43
  549. package/src/bmm/workflows/4-implementation/correct-course/workflow.yaml +53 -53
  550. package/src/bmm/workflows/4-implementation/create-story/checklist.md +159 -159
  551. package/src/bmm/workflows/4-implementation/create-story/template.md +79 -79
  552. package/src/bmm/workflows/4-implementation/create-story/workflow.yaml +52 -52
  553. package/src/bmm/workflows/4-implementation/dev-story/workflow.yaml +20 -20
  554. package/src/bmm/workflows/4-implementation/retrospective/workflow.yaml +52 -52
  555. package/src/bmm/workflows/4-implementation/sprint-planning/workflow.yaml +52 -52
  556. package/src/bmm/workflows/4-implementation/sprint-status/workflow.yaml +25 -25
  557. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-01-mode-detection.md +158 -158
  558. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-02-context-gathering.md +122 -122
  559. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-03-execute.md +93 -93
  560. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-04-self-check.md +93 -93
  561. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-05-adversarial-review.md +87 -87
  562. package/src/bmm/workflows/bmad-quick-flow/quick-dev/steps/step-06-resolve-findings.md +146 -146
  563. package/src/bmm/workflows/bmad-quick-flow/quick-dev/workflow.md +50 -50
  564. package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-02-investigate.md +152 -152
  565. package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-03-generate.md +123 -123
  566. package/src/bmm/workflows/bmad-quick-flow/quick-spec/steps/step-04-review.md +201 -201
  567. package/src/bmm/workflows/bmad-quick-flow/quick-spec/workflow.md +79 -79
  568. package/src/bmm/workflows/document-project/workflow.yaml +22 -22
  569. package/src/bmm/workflows/generate-project-context/steps/step-01-discover.md +184 -184
  570. package/src/bmm/workflows/generate-project-context/steps/step-02-generate.md +322 -322
  571. package/src/bmm/workflows/generate-project-context/steps/step-03-complete.md +235 -235
  572. package/src/bmm/workflows/generate-project-context/workflow.md +49 -49
  573. package/src/bmm/workflows/qa/automate/workflow.yaml +233 -233
  574. package/src/bmm/workflows/qa-generate-e2e-tests/workflow.yaml +42 -42
  575. package/src/core/config.yaml +9 -9
  576. package/src/core/module-help.csv +10 -10
  577. package/src/core/scripts/generate-loop-report.py +72 -72
  578. package/src/core/tasks/editorial-review-prose.xml +101 -101
  579. package/src/core/tasks/editorial-review-structure.xml +207 -207
  580. package/src/core/tasks/help.md +86 -86
  581. package/src/core/tasks/index-docs.xml +64 -64
  582. package/src/core/tasks/review-adversarial-general.xml +66 -66
  583. package/src/core/tasks/review-adversarial-loop.xml +46 -46
  584. package/src/core/tasks/review-edge-case-hunter.xml +63 -63
  585. package/src/core/tasks/review-party-loop.xml +46 -46
  586. package/src/core/tasks/shard-doc.xml +107 -107
  587. package/src/core/tasks/workflow.xml +235 -235
  588. package/src/core/templates/review-loop-report.html +88 -88
  589. package/src/core/templates/review-loop-report.md +5 -5
  590. package/src/core/workflows/advanced-elicitation/workflow.xml +117 -117
  591. package/src/core/workflows/brainstorming/steps/step-01-session-setup.md +212 -212
  592. package/src/core/workflows/brainstorming/steps/step-01b-continue.md +122 -122
  593. package/src/core/workflows/brainstorming/steps/step-02a-user-selected.md +225 -225
  594. package/src/core/workflows/brainstorming/steps/step-02b-ai-recommended.md +237 -237
  595. package/src/core/workflows/brainstorming/steps/step-02c-random-selection.md +209 -209
  596. package/src/core/workflows/brainstorming/steps/step-02d-progressive-flow.md +264 -264
  597. package/src/core/workflows/brainstorming/steps/step-02e-deep-dive.md +68 -68
  598. package/src/core/workflows/brainstorming/steps/step-03-technique-execution.md +403 -403
  599. package/src/core/workflows/brainstorming/steps/step-04-idea-organization.md +303 -303
  600. package/src/core/workflows/brainstorming/workflow.md +60 -60
  601. package/src/core/workflows/extract-trackers/workflow.md +45 -45
  602. package/src/core/workflows/party-mode/steps/step-01-agent-loading.md +142 -142
  603. package/src/core/workflows/party-mode/workflow.md +194 -194
  604. package/src/docs/dev/tmux/actions_popup.py +291 -291
  605. package/src/docs/dev/tmux/tmux-setup.md +62 -1
@@ -1,467 +1,467 @@
1
- ---
2
- name: codable-patterns
3
- description: "Encode and decode Swift types to and from JSON, property lists, and other external representations using Codable, JSONEncoder, and JSONDecoder. Use when implementing API response parsing, custom CodingKeys for key remapping, custom init(from:) or encode(to:) for complex transformations, nested or flattened JSON structures, heterogeneous array decoding, date and data decoding strategies, lossy array wrappers, Codable integration with URLSession, SwiftData, or UserDefaults, or when configuring encoder/decoder output formatting and key strategies."
4
- ---
5
-
6
- # Codable Patterns
7
-
8
- Encode and decode Swift types using `Codable` (`Encodable & Decodable`) with
9
- `JSONEncoder`, `JSONDecoder`, and related APIs. Targets Swift 6.2 / iOS 26+.
10
-
11
- ## Contents
12
-
13
- - [Basic Conformance](#basic-conformance)
14
- - [Custom CodingKeys](#custom-codingkeys)
15
- - [Custom Decoding and Encoding](#custom-decoding-and-encoding)
16
- - [Nested and Flattened Containers](#nested-and-flattened-containers)
17
- - [Heterogeneous Arrays](#heterogeneous-arrays)
18
- - [Date Decoding Strategies](#date-decoding-strategies)
19
- - [Data and Key Strategies](#data-and-key-strategies)
20
- - [Lossy Array Decoding](#lossy-array-decoding)
21
- - [Single Value Containers](#single-value-containers)
22
- - [Default Values for Missing Keys](#default-values-for-missing-keys)
23
- - [Encoder and Decoder Configuration](#encoder-and-decoder-configuration)
24
- - [Codable with URLSession](#codable-with-urlsession)
25
- - [Codable with SwiftData](#codable-with-swiftdata)
26
- - [Codable with UserDefaults](#codable-with-userdefaults)
27
- - [Common Mistakes](#common-mistakes)
28
- - [Review Checklist](#review-checklist)
29
- - [References](#references)
30
-
31
- ## Basic Conformance
32
-
33
- When all stored properties are themselves `Codable`, the compiler synthesizes
34
- conformance automatically:
35
-
36
- ```swift
37
- struct User: Codable {
38
- let id: Int
39
- let name: String
40
- let email: String
41
- let isVerified: Bool
42
- }
43
-
44
- let user = try JSONDecoder().decode(User.self, from: jsonData)
45
- let encoded = try JSONEncoder().encode(user)
46
- ```
47
-
48
- Prefer `Decodable` for read-only API responses and `Encodable` for write-only.
49
- Use `Codable` only when both directions are required.
50
-
51
- ## Custom CodingKeys
52
-
53
- Rename JSON keys without writing a custom decoder by declaring a `CodingKeys`
54
- enum:
55
-
56
- ```swift
57
- struct Product: Codable {
58
- let id: Int
59
- let displayName: String
60
- let imageURL: URL
61
- let priceInCents: Int
62
-
63
- enum CodingKeys: String, CodingKey {
64
- case id
65
- case displayName = "display_name"
66
- case imageURL = "image_url"
67
- case priceInCents = "price_in_cents"
68
- }
69
- }
70
- ```
71
-
72
- Every stored property must appear in the enum. Omitting a property from
73
- `CodingKeys` excludes it from encoding/decoding -- provide a default value or
74
- compute it separately.
75
-
76
- ## Custom Decoding and Encoding
77
-
78
- Override `init(from:)` and `encode(to:)` for transformations the synthesized
79
- conformance cannot handle:
80
-
81
- ```swift
82
- struct Event: Codable {
83
- let name: String
84
- let timestamp: Date
85
- let tags: [String]
86
-
87
- enum CodingKeys: String, CodingKey {
88
- case name, timestamp, tags
89
- }
90
-
91
- init(from decoder: Decoder) throws {
92
- let container = try decoder.container(keyedBy: CodingKeys.self)
93
- name = try container.decode(String.self, forKey: .name)
94
- // Decode Unix timestamp as Double, convert to Date
95
- let epoch = try container.decode(Double.self, forKey: .timestamp)
96
- timestamp = Date(timeIntervalSince1970: epoch)
97
- // Default to empty array when key is missing
98
- tags = try container.decodeIfPresent([String].self, forKey: .tags) ?? []
99
- }
100
-
101
- func encode(to encoder: Encoder) throws {
102
- var container = encoder.container(keyedBy: CodingKeys.self)
103
- try container.encode(name, forKey: .name)
104
- try container.encode(timestamp.timeIntervalSince1970, forKey: .timestamp)
105
- try container.encode(tags, forKey: .tags)
106
- }
107
- }
108
- ```
109
-
110
- ## Nested and Flattened Containers
111
-
112
- Use `nestedContainer(keyedBy:forKey:)` to navigate and flatten nested JSON:
113
-
114
- ```swift
115
- // JSON: { "id": 1, "location": { "lat": 37.7749, "lng": -122.4194 } }
116
- struct Place: Decodable {
117
- let id: Int
118
- let latitude: Double
119
- let longitude: Double
120
-
121
- enum CodingKeys: String, CodingKey { case id, location }
122
- enum LocationKeys: String, CodingKey { case lat, lng }
123
-
124
- init(from decoder: Decoder) throws {
125
- let container = try decoder.container(keyedBy: CodingKeys.self)
126
- id = try container.decode(Int.self, forKey: .id)
127
- let location = try container.nestedContainer(
128
- keyedBy: LocationKeys.self, forKey: .location)
129
- latitude = try location.decode(Double.self, forKey: .lat)
130
- longitude = try location.decode(Double.self, forKey: .lng)
131
- }
132
- }
133
- ```
134
-
135
- Chain multiple `nestedContainer` calls to flatten deeply nested structures.
136
- Also use `nestedUnkeyedContainer(forKey:)` for nested arrays.
137
-
138
- ## Heterogeneous Arrays
139
-
140
- Decode arrays of mixed types using a discriminator field:
141
-
142
- ```swift
143
- // JSON: [{"type":"text","content":"Hello"},{"type":"image","url":"pic.jpg"}]
144
- enum ContentBlock: Decodable {
145
- case text(String)
146
- case image(URL)
147
-
148
- enum CodingKeys: String, CodingKey { case type, content, url }
149
-
150
- init(from decoder: Decoder) throws {
151
- let container = try decoder.container(keyedBy: CodingKeys.self)
152
- let type = try container.decode(String.self, forKey: .type)
153
- switch type {
154
- case "text":
155
- let content = try container.decode(String.self, forKey: .content)
156
- self = .text(content)
157
- case "image":
158
- let url = try container.decode(URL.self, forKey: .url)
159
- self = .image(url)
160
- default:
161
- throw DecodingError.dataCorruptedError(
162
- forKey: .type, in: container,
163
- debugDescription: "Unknown type: \(type)")
164
- }
165
- }
166
- }
167
-
168
- let blocks = try JSONDecoder().decode([ContentBlock].self, from: jsonData)
169
- ```
170
-
171
- ## Date Decoding Strategies
172
-
173
- Configure `JSONDecoder.dateDecodingStrategy` to match your API:
174
-
175
- ```swift
176
- let decoder = JSONDecoder()
177
-
178
- // ISO 8601 (e.g., "2024-03-15T10:30:00Z")
179
- decoder.dateDecodingStrategy = .iso8601
180
-
181
- // Unix timestamp in seconds (e.g., 1710499800)
182
- decoder.dateDecodingStrategy = .secondsSince1970
183
-
184
- // Custom DateFormatter
185
- let formatter = DateFormatter()
186
- formatter.dateFormat = "yyyy-MM-dd"
187
- formatter.locale = Locale(identifier: "en_US_POSIX")
188
- formatter.timeZone = TimeZone(secondsFromGMT: 0)
189
- decoder.dateDecodingStrategy = .formatted(formatter)
190
-
191
- // Custom closure for multiple formats
192
- decoder.dateDecodingStrategy = .custom { decoder in
193
- let container = try decoder.singleValueContainer()
194
- let string = try container.decode(String.self)
195
- if let date = ISO8601DateFormatter().date(from: string) { return date }
196
- throw DecodingError.dataCorruptedError(
197
- in: container, debugDescription: "Cannot decode date: \(string)")
198
- }
199
- ```
200
-
201
- Set the matching strategy on `JSONEncoder`:
202
- `encoder.dateEncodingStrategy = .iso8601`
203
-
204
- ## Data and Key Strategies
205
-
206
- ```swift
207
- let decoder = JSONDecoder()
208
- decoder.dataDecodingStrategy = .base64 // Base64-encoded Data fields
209
- decoder.keyDecodingStrategy = .convertFromSnakeCase // snake_case -> camelCase
210
- // {"user_name": "Alice"} maps to `var userName: String` -- no CodingKeys needed
211
-
212
- let encoder = JSONEncoder()
213
- encoder.dataEncodingStrategy = .base64
214
- encoder.keyEncodingStrategy = .convertToSnakeCase
215
- ```
216
-
217
- ## Lossy Array Decoding
218
-
219
- By default, one invalid element fails the entire array. Use a wrapper to skip
220
- invalid elements:
221
-
222
- ```swift
223
- struct LossyArray<Element: Decodable>: Decodable {
224
- let elements: [Element]
225
-
226
- init(from decoder: Decoder) throws {
227
- var container = try decoder.unkeyedContainer()
228
- var elements: [Element] = []
229
- while !container.isAtEnd {
230
- if let element = try? container.decode(Element.self) {
231
- elements.append(element)
232
- } else {
233
- _ = try? container.decode(AnyCodableValue.self) // advance past bad element
234
- }
235
- }
236
- self.elements = elements
237
- }
238
- }
239
- private struct AnyCodableValue: Decodable {}
240
- ```
241
-
242
- ## Single Value Containers
243
-
244
- Wrap primitives for type safety using `singleValueContainer()`:
245
-
246
- ```swift
247
- struct UserID: Codable, Hashable {
248
- let rawValue: String
249
-
250
- init(_ rawValue: String) { self.rawValue = rawValue }
251
-
252
- init(from decoder: Decoder) throws {
253
- let container = try decoder.singleValueContainer()
254
- rawValue = try container.decode(String.self)
255
- }
256
-
257
- func encode(to encoder: Encoder) throws {
258
- var container = encoder.singleValueContainer()
259
- try container.encode(rawValue)
260
- }
261
- }
262
- // JSON: "usr_abc123" decodes directly to UserID
263
- ```
264
-
265
- ## Default Values for Missing Keys
266
-
267
- Use `decodeIfPresent` with nil-coalescing to provide defaults:
268
-
269
- ```swift
270
- struct Settings: Decodable {
271
- let theme: String
272
- let fontSize: Int
273
- let notificationsEnabled: Bool
274
-
275
- enum CodingKeys: String, CodingKey {
276
- case theme, fontSize = "font_size"
277
- case notificationsEnabled = "notifications_enabled"
278
- }
279
-
280
- init(from decoder: Decoder) throws {
281
- let container = try decoder.container(keyedBy: CodingKeys.self)
282
- theme = try container.decodeIfPresent(String.self, forKey: .theme) ?? "system"
283
- fontSize = try container.decodeIfPresent(Int.self, forKey: .fontSize) ?? 16
284
- notificationsEnabled = try container.decodeIfPresent(
285
- Bool.self, forKey: .notificationsEnabled) ?? true
286
- }
287
- }
288
- ```
289
-
290
- ## Encoder and Decoder Configuration
291
-
292
- ```swift
293
- let encoder = JSONEncoder()
294
- encoder.outputFormatting = [.prettyPrinted, .sortedKeys, .withoutEscapingSlashes]
295
-
296
- // Non-conforming floats (NaN, Infinity are not valid JSON)
297
- encoder.nonConformingFloatEncodingStrategy = .convertToString(
298
- positiveInfinity: "Infinity", negativeInfinity: "-Infinity", nan: "NaN")
299
- decoder.nonConformingFloatDecodingStrategy = .convertFromString(
300
- positiveInfinity: "Infinity", negativeInfinity: "-Infinity", nan: "NaN")
301
- ```
302
-
303
- ### PropertyListEncoder / PropertyListDecoder
304
-
305
- ```swift
306
- let plistEncoder = PropertyListEncoder()
307
- plistEncoder.outputFormat = .xml // or .binary
308
- let data = try plistEncoder.encode(settings)
309
- let decoded = try PropertyListDecoder().decode(Settings.self, from: data)
310
- ```
311
-
312
- ## Codable with URLSession
313
-
314
- ```swift
315
- func fetchUser(id: Int) async throws -> User {
316
- let url = URL(string: "https://api.example.com/users/\(id)")!
317
- let (data, response) = try await URLSession.shared.data(from: url)
318
- guard let http = response as? HTTPURLResponse,
319
- (200...299).contains(http.statusCode) else {
320
- throw APIError.invalidResponse
321
- }
322
- let decoder = JSONDecoder()
323
- decoder.keyDecodingStrategy = .convertFromSnakeCase
324
- decoder.dateDecodingStrategy = .iso8601
325
- return try decoder.decode(User.self, from: data)
326
- }
327
-
328
- // Generic API envelope for wrapped responses
329
- struct APIResponse<T: Decodable>: Decodable {
330
- let data: T
331
- let meta: Meta?
332
- struct Meta: Decodable { let page: Int; let totalPages: Int }
333
- }
334
- let users = try decoder.decode(APIResponse<[User]>.self, from: data).data
335
- ```
336
-
337
- ## Codable with SwiftData
338
-
339
- `Codable` structs work as composite attributes in SwiftData models. In iOS 18+,
340
- SwiftData natively supports them without explicit `@Attribute(.transformable)`:
341
-
342
- ```swift
343
- struct Address: Codable {
344
- var street: String
345
- var city: String
346
- var zipCode: String
347
- }
348
-
349
- @Model class Contact {
350
- var name: String
351
- var address: Address? // Codable struct stored as composite attribute
352
- init(name: String, address: Address? = nil) {
353
- self.name = name; self.address = address
354
- }
355
- }
356
- ```
357
-
358
- ## Codable with UserDefaults
359
-
360
- Store `Codable` values via `RawRepresentable` for `@AppStorage`:
361
-
362
- ```swift
363
- struct UserPreferences: Codable {
364
- var showOnboarding: Bool = true
365
- var accentColor: String = "blue"
366
- }
367
-
368
- extension UserPreferences: RawRepresentable {
369
- init?(rawValue: String) {
370
- guard let data = rawValue.data(using: .utf8),
371
- let decoded = try? JSONDecoder().decode(Self.self, from: data)
372
- else { return nil }
373
- self = decoded
374
- }
375
- var rawValue: String {
376
- guard let data = try? JSONEncoder().encode(self),
377
- let string = String(data: data, encoding: .utf8)
378
- else { return "{}" }
379
- return string
380
- }
381
- }
382
-
383
- struct SettingsView: View {
384
- @AppStorage("userPrefs") private var prefs = UserPreferences()
385
- var body: some View {
386
- Toggle("Show Onboarding", isOn: $prefs.showOnboarding)
387
- }
388
- }
389
- ```
390
-
391
- ## Common Mistakes
392
-
393
- **1. Not handling missing optional keys:**
394
- ```swift
395
- // DON'T -- crashes if key is absent
396
- let value = try container.decode(String.self, forKey: .bio)
397
- // DO -- returns nil for missing keys
398
- let value = try container.decodeIfPresent(String.self, forKey: .bio) ?? ""
399
- ```
400
-
401
- **2. Failing entire array when one element is invalid:**
402
- ```swift
403
- // DON'T -- one bad element kills the whole decode
404
- let items = try container.decode([Item].self, forKey: .items)
405
- // DO -- use LossyArray or decode elements individually
406
- let items = try container.decode(LossyArray<Item>.self, forKey: .items).elements
407
- ```
408
-
409
- **3. Date strategy mismatch:**
410
- ```swift
411
- // DON'T -- default strategy expects Double, but API sends ISO string
412
- let decoder = JSONDecoder() // dateDecodingStrategy defaults to .deferredToDate
413
- // DO -- set strategy to match your API format
414
- decoder.dateDecodingStrategy = .iso8601
415
- ```
416
-
417
- **4. Force-unwrapping decoded optionals:**
418
- ```swift
419
- // DON'T
420
- let user = try? decoder.decode(User.self, from: data)
421
- print(user!.name)
422
- // DO
423
- guard let user = try? decoder.decode(User.self, from: data) else { return }
424
- ```
425
-
426
- **5. Using Codable when only Decodable is needed:**
427
- ```swift
428
- // DON'T -- unnecessarily constrains the type to also be Encodable
429
- struct APIResponse: Codable { let id: Int; let message: String }
430
- // DO -- use Decodable for read-only API responses
431
- struct APIResponse: Decodable { let id: Int; let message: String }
432
- ```
433
-
434
- **6. Manual CodingKeys for simple snake_case APIs:**
435
- ```swift
436
- // DON'T -- verbose boilerplate for every model
437
- enum CodingKeys: String, CodingKey {
438
- case userName = "user_name"
439
- case avatarUrl = "avatar_url"
440
- }
441
- // DO -- configure once on the decoder
442
- decoder.keyDecodingStrategy = .convertFromSnakeCase
443
- ```
444
-
445
- ## Review Checklist
446
-
447
- - [ ] Types conform to `Decodable` only when encoding is not needed
448
- - [ ] `decodeIfPresent` used with defaults for optional or missing keys
449
- - [ ] `keyDecodingStrategy = .convertFromSnakeCase` used instead of manual CodingKeys for simple snake_case APIs
450
- - [ ] `dateDecodingStrategy` matches the API date format
451
- - [ ] Arrays of unreliable data use lossy decoding to skip invalid elements
452
- - [ ] Custom `init(from:)` validates and transforms data instead of post-decode fixups
453
- - [ ] `JSONEncoder.outputFormatting` includes `.sortedKeys` for deterministic test output
454
- - [ ] Wrapper types (UserID, etc.) use `singleValueContainer` for clean JSON
455
- - [ ] Generic `APIResponse<T>` wrapper used for consistent API envelope handling
456
- - [ ] No force-unwrapping of decoded values
457
- - [ ] `@AppStorage` Codable types conform to `RawRepresentable`
458
- - [ ] SwiftData composite attributes use `Codable` structs
459
-
460
- ## References
461
-
462
- - [Codable](https://sosumi.ai/documentation/swift/codable/) -- protocol combining Encodable and Decodable
463
- - [JSONDecoder](https://sosumi.ai/documentation/foundation/jsondecoder/) -- decodes JSON data into Codable types
464
- - [JSONEncoder](https://sosumi.ai/documentation/foundation/jsonencoder/) -- encodes Codable types as JSON data
465
- - [CodingKey](https://sosumi.ai/documentation/swift/codingkey/) -- protocol for encoding/decoding keys
466
- - [Encoding and Decoding Custom Types](https://sosumi.ai/documentation/foundation/encoding-and-decoding-custom-types/) -- Apple guide on custom Codable conformance
467
- - [Using JSON with Custom Types](https://sosumi.ai/documentation/foundation/archives_and_serialization/using_json_with_custom_types/) -- Apple sample code for JSON patterns
1
+ ---
2
+ name: codable-patterns
3
+ description: "Encode and decode Swift types to and from JSON, property lists, and other external representations using Codable, JSONEncoder, and JSONDecoder. Use when implementing API response parsing, custom CodingKeys for key remapping, custom init(from:) or encode(to:) for complex transformations, nested or flattened JSON structures, heterogeneous array decoding, date and data decoding strategies, lossy array wrappers, Codable integration with URLSession, SwiftData, or UserDefaults, or when configuring encoder/decoder output formatting and key strategies."
4
+ ---
5
+
6
+ # Codable Patterns
7
+
8
+ Encode and decode Swift types using `Codable` (`Encodable & Decodable`) with
9
+ `JSONEncoder`, `JSONDecoder`, and related APIs. Targets Swift 6.2 / iOS 26+.
10
+
11
+ ## Contents
12
+
13
+ - [Basic Conformance](#basic-conformance)
14
+ - [Custom CodingKeys](#custom-codingkeys)
15
+ - [Custom Decoding and Encoding](#custom-decoding-and-encoding)
16
+ - [Nested and Flattened Containers](#nested-and-flattened-containers)
17
+ - [Heterogeneous Arrays](#heterogeneous-arrays)
18
+ - [Date Decoding Strategies](#date-decoding-strategies)
19
+ - [Data and Key Strategies](#data-and-key-strategies)
20
+ - [Lossy Array Decoding](#lossy-array-decoding)
21
+ - [Single Value Containers](#single-value-containers)
22
+ - [Default Values for Missing Keys](#default-values-for-missing-keys)
23
+ - [Encoder and Decoder Configuration](#encoder-and-decoder-configuration)
24
+ - [Codable with URLSession](#codable-with-urlsession)
25
+ - [Codable with SwiftData](#codable-with-swiftdata)
26
+ - [Codable with UserDefaults](#codable-with-userdefaults)
27
+ - [Common Mistakes](#common-mistakes)
28
+ - [Review Checklist](#review-checklist)
29
+ - [References](#references)
30
+
31
+ ## Basic Conformance
32
+
33
+ When all stored properties are themselves `Codable`, the compiler synthesizes
34
+ conformance automatically:
35
+
36
+ ```swift
37
+ struct User: Codable {
38
+ let id: Int
39
+ let name: String
40
+ let email: String
41
+ let isVerified: Bool
42
+ }
43
+
44
+ let user = try JSONDecoder().decode(User.self, from: jsonData)
45
+ let encoded = try JSONEncoder().encode(user)
46
+ ```
47
+
48
+ Prefer `Decodable` for read-only API responses and `Encodable` for write-only.
49
+ Use `Codable` only when both directions are required.
50
+
51
+ ## Custom CodingKeys
52
+
53
+ Rename JSON keys without writing a custom decoder by declaring a `CodingKeys`
54
+ enum:
55
+
56
+ ```swift
57
+ struct Product: Codable {
58
+ let id: Int
59
+ let displayName: String
60
+ let imageURL: URL
61
+ let priceInCents: Int
62
+
63
+ enum CodingKeys: String, CodingKey {
64
+ case id
65
+ case displayName = "display_name"
66
+ case imageURL = "image_url"
67
+ case priceInCents = "price_in_cents"
68
+ }
69
+ }
70
+ ```
71
+
72
+ Every stored property must appear in the enum. Omitting a property from
73
+ `CodingKeys` excludes it from encoding/decoding -- provide a default value or
74
+ compute it separately.
75
+
76
+ ## Custom Decoding and Encoding
77
+
78
+ Override `init(from:)` and `encode(to:)` for transformations the synthesized
79
+ conformance cannot handle:
80
+
81
+ ```swift
82
+ struct Event: Codable {
83
+ let name: String
84
+ let timestamp: Date
85
+ let tags: [String]
86
+
87
+ enum CodingKeys: String, CodingKey {
88
+ case name, timestamp, tags
89
+ }
90
+
91
+ init(from decoder: Decoder) throws {
92
+ let container = try decoder.container(keyedBy: CodingKeys.self)
93
+ name = try container.decode(String.self, forKey: .name)
94
+ // Decode Unix timestamp as Double, convert to Date
95
+ let epoch = try container.decode(Double.self, forKey: .timestamp)
96
+ timestamp = Date(timeIntervalSince1970: epoch)
97
+ // Default to empty array when key is missing
98
+ tags = try container.decodeIfPresent([String].self, forKey: .tags) ?? []
99
+ }
100
+
101
+ func encode(to encoder: Encoder) throws {
102
+ var container = encoder.container(keyedBy: CodingKeys.self)
103
+ try container.encode(name, forKey: .name)
104
+ try container.encode(timestamp.timeIntervalSince1970, forKey: .timestamp)
105
+ try container.encode(tags, forKey: .tags)
106
+ }
107
+ }
108
+ ```
109
+
110
+ ## Nested and Flattened Containers
111
+
112
+ Use `nestedContainer(keyedBy:forKey:)` to navigate and flatten nested JSON:
113
+
114
+ ```swift
115
+ // JSON: { "id": 1, "location": { "lat": 37.7749, "lng": -122.4194 } }
116
+ struct Place: Decodable {
117
+ let id: Int
118
+ let latitude: Double
119
+ let longitude: Double
120
+
121
+ enum CodingKeys: String, CodingKey { case id, location }
122
+ enum LocationKeys: String, CodingKey { case lat, lng }
123
+
124
+ init(from decoder: Decoder) throws {
125
+ let container = try decoder.container(keyedBy: CodingKeys.self)
126
+ id = try container.decode(Int.self, forKey: .id)
127
+ let location = try container.nestedContainer(
128
+ keyedBy: LocationKeys.self, forKey: .location)
129
+ latitude = try location.decode(Double.self, forKey: .lat)
130
+ longitude = try location.decode(Double.self, forKey: .lng)
131
+ }
132
+ }
133
+ ```
134
+
135
+ Chain multiple `nestedContainer` calls to flatten deeply nested structures.
136
+ Also use `nestedUnkeyedContainer(forKey:)` for nested arrays.
137
+
138
+ ## Heterogeneous Arrays
139
+
140
+ Decode arrays of mixed types using a discriminator field:
141
+
142
+ ```swift
143
+ // JSON: [{"type":"text","content":"Hello"},{"type":"image","url":"pic.jpg"}]
144
+ enum ContentBlock: Decodable {
145
+ case text(String)
146
+ case image(URL)
147
+
148
+ enum CodingKeys: String, CodingKey { case type, content, url }
149
+
150
+ init(from decoder: Decoder) throws {
151
+ let container = try decoder.container(keyedBy: CodingKeys.self)
152
+ let type = try container.decode(String.self, forKey: .type)
153
+ switch type {
154
+ case "text":
155
+ let content = try container.decode(String.self, forKey: .content)
156
+ self = .text(content)
157
+ case "image":
158
+ let url = try container.decode(URL.self, forKey: .url)
159
+ self = .image(url)
160
+ default:
161
+ throw DecodingError.dataCorruptedError(
162
+ forKey: .type, in: container,
163
+ debugDescription: "Unknown type: \(type)")
164
+ }
165
+ }
166
+ }
167
+
168
+ let blocks = try JSONDecoder().decode([ContentBlock].self, from: jsonData)
169
+ ```
170
+
171
+ ## Date Decoding Strategies
172
+
173
+ Configure `JSONDecoder.dateDecodingStrategy` to match your API:
174
+
175
+ ```swift
176
+ let decoder = JSONDecoder()
177
+
178
+ // ISO 8601 (e.g., "2024-03-15T10:30:00Z")
179
+ decoder.dateDecodingStrategy = .iso8601
180
+
181
+ // Unix timestamp in seconds (e.g., 1710499800)
182
+ decoder.dateDecodingStrategy = .secondsSince1970
183
+
184
+ // Custom DateFormatter
185
+ let formatter = DateFormatter()
186
+ formatter.dateFormat = "yyyy-MM-dd"
187
+ formatter.locale = Locale(identifier: "en_US_POSIX")
188
+ formatter.timeZone = TimeZone(secondsFromGMT: 0)
189
+ decoder.dateDecodingStrategy = .formatted(formatter)
190
+
191
+ // Custom closure for multiple formats
192
+ decoder.dateDecodingStrategy = .custom { decoder in
193
+ let container = try decoder.singleValueContainer()
194
+ let string = try container.decode(String.self)
195
+ if let date = ISO8601DateFormatter().date(from: string) { return date }
196
+ throw DecodingError.dataCorruptedError(
197
+ in: container, debugDescription: "Cannot decode date: \(string)")
198
+ }
199
+ ```
200
+
201
+ Set the matching strategy on `JSONEncoder`:
202
+ `encoder.dateEncodingStrategy = .iso8601`
203
+
204
+ ## Data and Key Strategies
205
+
206
+ ```swift
207
+ let decoder = JSONDecoder()
208
+ decoder.dataDecodingStrategy = .base64 // Base64-encoded Data fields
209
+ decoder.keyDecodingStrategy = .convertFromSnakeCase // snake_case -> camelCase
210
+ // {"user_name": "Alice"} maps to `var userName: String` -- no CodingKeys needed
211
+
212
+ let encoder = JSONEncoder()
213
+ encoder.dataEncodingStrategy = .base64
214
+ encoder.keyEncodingStrategy = .convertToSnakeCase
215
+ ```
216
+
217
+ ## Lossy Array Decoding
218
+
219
+ By default, one invalid element fails the entire array. Use a wrapper to skip
220
+ invalid elements:
221
+
222
+ ```swift
223
+ struct LossyArray<Element: Decodable>: Decodable {
224
+ let elements: [Element]
225
+
226
+ init(from decoder: Decoder) throws {
227
+ var container = try decoder.unkeyedContainer()
228
+ var elements: [Element] = []
229
+ while !container.isAtEnd {
230
+ if let element = try? container.decode(Element.self) {
231
+ elements.append(element)
232
+ } else {
233
+ _ = try? container.decode(AnyCodableValue.self) // advance past bad element
234
+ }
235
+ }
236
+ self.elements = elements
237
+ }
238
+ }
239
+ private struct AnyCodableValue: Decodable {}
240
+ ```
241
+
242
+ ## Single Value Containers
243
+
244
+ Wrap primitives for type safety using `singleValueContainer()`:
245
+
246
+ ```swift
247
+ struct UserID: Codable, Hashable {
248
+ let rawValue: String
249
+
250
+ init(_ rawValue: String) { self.rawValue = rawValue }
251
+
252
+ init(from decoder: Decoder) throws {
253
+ let container = try decoder.singleValueContainer()
254
+ rawValue = try container.decode(String.self)
255
+ }
256
+
257
+ func encode(to encoder: Encoder) throws {
258
+ var container = encoder.singleValueContainer()
259
+ try container.encode(rawValue)
260
+ }
261
+ }
262
+ // JSON: "usr_abc123" decodes directly to UserID
263
+ ```
264
+
265
+ ## Default Values for Missing Keys
266
+
267
+ Use `decodeIfPresent` with nil-coalescing to provide defaults:
268
+
269
+ ```swift
270
+ struct Settings: Decodable {
271
+ let theme: String
272
+ let fontSize: Int
273
+ let notificationsEnabled: Bool
274
+
275
+ enum CodingKeys: String, CodingKey {
276
+ case theme, fontSize = "font_size"
277
+ case notificationsEnabled = "notifications_enabled"
278
+ }
279
+
280
+ init(from decoder: Decoder) throws {
281
+ let container = try decoder.container(keyedBy: CodingKeys.self)
282
+ theme = try container.decodeIfPresent(String.self, forKey: .theme) ?? "system"
283
+ fontSize = try container.decodeIfPresent(Int.self, forKey: .fontSize) ?? 16
284
+ notificationsEnabled = try container.decodeIfPresent(
285
+ Bool.self, forKey: .notificationsEnabled) ?? true
286
+ }
287
+ }
288
+ ```
289
+
290
+ ## Encoder and Decoder Configuration
291
+
292
+ ```swift
293
+ let encoder = JSONEncoder()
294
+ encoder.outputFormatting = [.prettyPrinted, .sortedKeys, .withoutEscapingSlashes]
295
+
296
+ // Non-conforming floats (NaN, Infinity are not valid JSON)
297
+ encoder.nonConformingFloatEncodingStrategy = .convertToString(
298
+ positiveInfinity: "Infinity", negativeInfinity: "-Infinity", nan: "NaN")
299
+ decoder.nonConformingFloatDecodingStrategy = .convertFromString(
300
+ positiveInfinity: "Infinity", negativeInfinity: "-Infinity", nan: "NaN")
301
+ ```
302
+
303
+ ### PropertyListEncoder / PropertyListDecoder
304
+
305
+ ```swift
306
+ let plistEncoder = PropertyListEncoder()
307
+ plistEncoder.outputFormat = .xml // or .binary
308
+ let data = try plistEncoder.encode(settings)
309
+ let decoded = try PropertyListDecoder().decode(Settings.self, from: data)
310
+ ```
311
+
312
+ ## Codable with URLSession
313
+
314
+ ```swift
315
+ func fetchUser(id: Int) async throws -> User {
316
+ let url = URL(string: "https://api.example.com/users/\(id)")!
317
+ let (data, response) = try await URLSession.shared.data(from: url)
318
+ guard let http = response as? HTTPURLResponse,
319
+ (200...299).contains(http.statusCode) else {
320
+ throw APIError.invalidResponse
321
+ }
322
+ let decoder = JSONDecoder()
323
+ decoder.keyDecodingStrategy = .convertFromSnakeCase
324
+ decoder.dateDecodingStrategy = .iso8601
325
+ return try decoder.decode(User.self, from: data)
326
+ }
327
+
328
+ // Generic API envelope for wrapped responses
329
+ struct APIResponse<T: Decodable>: Decodable {
330
+ let data: T
331
+ let meta: Meta?
332
+ struct Meta: Decodable { let page: Int; let totalPages: Int }
333
+ }
334
+ let users = try decoder.decode(APIResponse<[User]>.self, from: data).data
335
+ ```
336
+
337
+ ## Codable with SwiftData
338
+
339
+ `Codable` structs work as composite attributes in SwiftData models. In iOS 18+,
340
+ SwiftData natively supports them without explicit `@Attribute(.transformable)`:
341
+
342
+ ```swift
343
+ struct Address: Codable {
344
+ var street: String
345
+ var city: String
346
+ var zipCode: String
347
+ }
348
+
349
+ @Model class Contact {
350
+ var name: String
351
+ var address: Address? // Codable struct stored as composite attribute
352
+ init(name: String, address: Address? = nil) {
353
+ self.name = name; self.address = address
354
+ }
355
+ }
356
+ ```
357
+
358
+ ## Codable with UserDefaults
359
+
360
+ Store `Codable` values via `RawRepresentable` for `@AppStorage`:
361
+
362
+ ```swift
363
+ struct UserPreferences: Codable {
364
+ var showOnboarding: Bool = true
365
+ var accentColor: String = "blue"
366
+ }
367
+
368
+ extension UserPreferences: RawRepresentable {
369
+ init?(rawValue: String) {
370
+ guard let data = rawValue.data(using: .utf8),
371
+ let decoded = try? JSONDecoder().decode(Self.self, from: data)
372
+ else { return nil }
373
+ self = decoded
374
+ }
375
+ var rawValue: String {
376
+ guard let data = try? JSONEncoder().encode(self),
377
+ let string = String(data: data, encoding: .utf8)
378
+ else { return "{}" }
379
+ return string
380
+ }
381
+ }
382
+
383
+ struct SettingsView: View {
384
+ @AppStorage("userPrefs") private var prefs = UserPreferences()
385
+ var body: some View {
386
+ Toggle("Show Onboarding", isOn: $prefs.showOnboarding)
387
+ }
388
+ }
389
+ ```
390
+
391
+ ## Common Mistakes
392
+
393
+ **1. Not handling missing optional keys:**
394
+ ```swift
395
+ // DON'T -- crashes if key is absent
396
+ let value = try container.decode(String.self, forKey: .bio)
397
+ // DO -- returns nil for missing keys
398
+ let value = try container.decodeIfPresent(String.self, forKey: .bio) ?? ""
399
+ ```
400
+
401
+ **2. Failing entire array when one element is invalid:**
402
+ ```swift
403
+ // DON'T -- one bad element kills the whole decode
404
+ let items = try container.decode([Item].self, forKey: .items)
405
+ // DO -- use LossyArray or decode elements individually
406
+ let items = try container.decode(LossyArray<Item>.self, forKey: .items).elements
407
+ ```
408
+
409
+ **3. Date strategy mismatch:**
410
+ ```swift
411
+ // DON'T -- default strategy expects Double, but API sends ISO string
412
+ let decoder = JSONDecoder() // dateDecodingStrategy defaults to .deferredToDate
413
+ // DO -- set strategy to match your API format
414
+ decoder.dateDecodingStrategy = .iso8601
415
+ ```
416
+
417
+ **4. Force-unwrapping decoded optionals:**
418
+ ```swift
419
+ // DON'T
420
+ let user = try? decoder.decode(User.self, from: data)
421
+ print(user!.name)
422
+ // DO
423
+ guard let user = try? decoder.decode(User.self, from: data) else { return }
424
+ ```
425
+
426
+ **5. Using Codable when only Decodable is needed:**
427
+ ```swift
428
+ // DON'T -- unnecessarily constrains the type to also be Encodable
429
+ struct APIResponse: Codable { let id: Int; let message: String }
430
+ // DO -- use Decodable for read-only API responses
431
+ struct APIResponse: Decodable { let id: Int; let message: String }
432
+ ```
433
+
434
+ **6. Manual CodingKeys for simple snake_case APIs:**
435
+ ```swift
436
+ // DON'T -- verbose boilerplate for every model
437
+ enum CodingKeys: String, CodingKey {
438
+ case userName = "user_name"
439
+ case avatarUrl = "avatar_url"
440
+ }
441
+ // DO -- configure once on the decoder
442
+ decoder.keyDecodingStrategy = .convertFromSnakeCase
443
+ ```
444
+
445
+ ## Review Checklist
446
+
447
+ - [ ] Types conform to `Decodable` only when encoding is not needed
448
+ - [ ] `decodeIfPresent` used with defaults for optional or missing keys
449
+ - [ ] `keyDecodingStrategy = .convertFromSnakeCase` used instead of manual CodingKeys for simple snake_case APIs
450
+ - [ ] `dateDecodingStrategy` matches the API date format
451
+ - [ ] Arrays of unreliable data use lossy decoding to skip invalid elements
452
+ - [ ] Custom `init(from:)` validates and transforms data instead of post-decode fixups
453
+ - [ ] `JSONEncoder.outputFormatting` includes `.sortedKeys` for deterministic test output
454
+ - [ ] Wrapper types (UserID, etc.) use `singleValueContainer` for clean JSON
455
+ - [ ] Generic `APIResponse<T>` wrapper used for consistent API envelope handling
456
+ - [ ] No force-unwrapping of decoded values
457
+ - [ ] `@AppStorage` Codable types conform to `RawRepresentable`
458
+ - [ ] SwiftData composite attributes use `Codable` structs
459
+
460
+ ## References
461
+
462
+ - [Codable](https://sosumi.ai/documentation/swift/codable/) -- protocol combining Encodable and Decodable
463
+ - [JSONDecoder](https://sosumi.ai/documentation/foundation/jsondecoder/) -- decodes JSON data into Codable types
464
+ - [JSONEncoder](https://sosumi.ai/documentation/foundation/jsonencoder/) -- encodes Codable types as JSON data
465
+ - [CodingKey](https://sosumi.ai/documentation/swift/codingkey/) -- protocol for encoding/decoding keys
466
+ - [Encoding and Decoding Custom Types](https://sosumi.ai/documentation/foundation/encoding-and-decoding-custom-types/) -- Apple guide on custom Codable conformance
467
+ - [Using JSON with Custom Types](https://sosumi.ai/documentation/foundation/archives_and_serialization/using_json_with_custom_types/) -- Apple sample code for JSON patterns