@mytechtoday/augment-extensions 0.7.0 → 1.2.1

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 (483) hide show
  1. package/AGENTS.md +265 -232
  2. package/README.md +956 -771
  3. package/augment-extensions/coding-standards/bash/README.md +196 -196
  4. package/augment-extensions/coding-standards/bash/module.json +163 -163
  5. package/augment-extensions/coding-standards/bash/rules/naming-conventions.md +336 -336
  6. package/augment-extensions/coding-standards/bash/rules/universal-standards.md +289 -289
  7. package/augment-extensions/coding-standards/css/README.md +40 -40
  8. package/augment-extensions/coding-standards/css/examples/css-examples.css +550 -550
  9. package/augment-extensions/coding-standards/css/module.json +44 -44
  10. package/augment-extensions/coding-standards/css/rules/css-modern-features.md +448 -448
  11. package/augment-extensions/coding-standards/css/rules/css-standards.md +492 -492
  12. package/augment-extensions/coding-standards/html/README.md +40 -40
  13. package/augment-extensions/coding-standards/html/examples/html-examples.html +267 -267
  14. package/augment-extensions/coding-standards/html/examples/responsive-layout.html +505 -505
  15. package/augment-extensions/coding-standards/html/module.json +44 -44
  16. package/augment-extensions/coding-standards/html/rules/html-standards.md +349 -349
  17. package/augment-extensions/coding-standards/html-css-js/README.md +194 -194
  18. package/augment-extensions/coding-standards/html-css-js/examples/async-examples.js +487 -487
  19. package/augment-extensions/coding-standards/html-css-js/examples/css-examples.css +550 -550
  20. package/augment-extensions/coding-standards/html-css-js/examples/dom-examples.js +667 -667
  21. package/augment-extensions/coding-standards/html-css-js/examples/html-examples.html +267 -267
  22. package/augment-extensions/coding-standards/html-css-js/examples/javascript-examples.js +612 -612
  23. package/augment-extensions/coding-standards/html-css-js/examples/responsive-layout.html +505 -505
  24. package/augment-extensions/coding-standards/html-css-js/module.json +48 -48
  25. package/augment-extensions/coding-standards/html-css-js/rules/async-patterns.md +515 -515
  26. package/augment-extensions/coding-standards/html-css-js/rules/css-modern-features.md +448 -448
  27. package/augment-extensions/coding-standards/html-css-js/rules/css-standards.md +492 -492
  28. package/augment-extensions/coding-standards/html-css-js/rules/dom-manipulation.md +439 -439
  29. package/augment-extensions/coding-standards/html-css-js/rules/html-standards.md +349 -349
  30. package/augment-extensions/coding-standards/html-css-js/rules/javascript-standards.md +486 -486
  31. package/augment-extensions/coding-standards/html-css-js/rules/performance.md +463 -463
  32. package/augment-extensions/coding-standards/html-css-js/rules/tooling.md +543 -543
  33. package/augment-extensions/coding-standards/js/README.md +46 -46
  34. package/augment-extensions/coding-standards/js/examples/async-examples.js +487 -487
  35. package/augment-extensions/coding-standards/js/examples/dom-examples.js +667 -667
  36. package/augment-extensions/coding-standards/js/examples/javascript-examples.js +612 -612
  37. package/augment-extensions/coding-standards/js/module.json +49 -49
  38. package/augment-extensions/coding-standards/js/rules/async-patterns.md +515 -515
  39. package/augment-extensions/coding-standards/js/rules/dom-manipulation.md +439 -439
  40. package/augment-extensions/coding-standards/js/rules/javascript-standards.md +486 -486
  41. package/augment-extensions/coding-standards/js/rules/performance.md +463 -463
  42. package/augment-extensions/coding-standards/js/rules/tooling.md +543 -543
  43. package/augment-extensions/coding-standards/php/README.md +248 -248
  44. package/augment-extensions/coding-standards/php/examples/api-endpoint-example.php +204 -204
  45. package/augment-extensions/coding-standards/php/examples/cli-command-example.php +206 -206
  46. package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php +234 -234
  47. package/augment-extensions/coding-standards/php/examples/web-application-example.php +211 -211
  48. package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php +215 -215
  49. package/augment-extensions/coding-standards/php/examples/wordpress-plugin-example.php +189 -189
  50. package/augment-extensions/coding-standards/php/module.json +166 -166
  51. package/augment-extensions/coding-standards/php/rules/api-development.md +480 -480
  52. package/augment-extensions/coding-standards/php/rules/category-configuration.md +332 -332
  53. package/augment-extensions/coding-standards/php/rules/cli-tools.md +472 -472
  54. package/augment-extensions/coding-standards/php/rules/cms-integration.md +561 -561
  55. package/augment-extensions/coding-standards/php/rules/code-quality.md +402 -402
  56. package/augment-extensions/coding-standards/php/rules/documentation.md +425 -425
  57. package/augment-extensions/coding-standards/php/rules/ecommerce.md +627 -627
  58. package/augment-extensions/coding-standards/php/rules/error-handling.md +336 -336
  59. package/augment-extensions/coding-standards/php/rules/legacy-migration.md +677 -677
  60. package/augment-extensions/coding-standards/php/rules/naming-conventions.md +279 -279
  61. package/augment-extensions/coding-standards/php/rules/performance.md +392 -392
  62. package/augment-extensions/coding-standards/php/rules/psr-standards.md +186 -186
  63. package/augment-extensions/coding-standards/php/rules/security.md +358 -358
  64. package/augment-extensions/coding-standards/php/rules/testing.md +403 -403
  65. package/augment-extensions/coding-standards/php/rules/type-declarations.md +331 -331
  66. package/augment-extensions/coding-standards/php/rules/web-applications.md +426 -426
  67. package/augment-extensions/coding-standards/powershell/README.md +154 -154
  68. package/augment-extensions/coding-standards/powershell/examples/admin-example.ps1 +272 -272
  69. package/augment-extensions/coding-standards/powershell/examples/automation-example.ps1 +173 -173
  70. package/augment-extensions/coding-standards/powershell/examples/cloud-example.ps1 +243 -243
  71. package/augment-extensions/coding-standards/powershell/examples/cross-platform-example.ps1 +297 -297
  72. package/augment-extensions/coding-standards/powershell/examples/dsc-example.ps1 +224 -224
  73. package/augment-extensions/coding-standards/powershell/examples/legacy-migration-example.ps1 +340 -340
  74. package/augment-extensions/coding-standards/powershell/examples/module-example.psm1 +255 -255
  75. package/augment-extensions/coding-standards/powershell/module.json +165 -165
  76. package/augment-extensions/coding-standards/powershell/rules/administrative-tools.md +439 -439
  77. package/augment-extensions/coding-standards/powershell/rules/automation-scripts.md +240 -240
  78. package/augment-extensions/coding-standards/powershell/rules/cloud-orchestration.md +384 -384
  79. package/augment-extensions/coding-standards/powershell/rules/configuration-schema.md +383 -383
  80. package/augment-extensions/coding-standards/powershell/rules/cross-platform-scripts.md +482 -482
  81. package/augment-extensions/coding-standards/powershell/rules/dsc-configurations.md +296 -296
  82. package/augment-extensions/coding-standards/powershell/rules/error-handling.md +314 -314
  83. package/augment-extensions/coding-standards/powershell/rules/legacy-migrations.md +466 -466
  84. package/augment-extensions/coding-standards/powershell/rules/modules-functions.md +244 -244
  85. package/augment-extensions/coding-standards/powershell/rules/naming-conventions.md +266 -266
  86. package/augment-extensions/coding-standards/powershell/rules/performance-optimization.md +209 -209
  87. package/augment-extensions/coding-standards/powershell/rules/security-practices.md +314 -314
  88. package/augment-extensions/coding-standards/powershell/rules/testing-guidelines.md +268 -268
  89. package/augment-extensions/coding-standards/powershell/rules/universal-standards.md +197 -197
  90. package/augment-extensions/coding-standards/python/README.md +48 -48
  91. package/augment-extensions/coding-standards/python/examples/best-practices.py +373 -373
  92. package/augment-extensions/coding-standards/python/module.json +30 -30
  93. package/augment-extensions/coding-standards/python/rules/async-patterns.md +884 -884
  94. package/augment-extensions/coding-standards/python/rules/best-practices.md +232 -232
  95. package/augment-extensions/coding-standards/python/rules/code-organization.md +220 -220
  96. package/augment-extensions/coding-standards/python/rules/documentation.md +831 -831
  97. package/augment-extensions/coding-standards/python/rules/error-handling.md +1008 -1008
  98. package/augment-extensions/coding-standards/python/rules/naming-conventions.md +172 -172
  99. package/augment-extensions/coding-standards/python/rules/testing.md +409 -409
  100. package/augment-extensions/coding-standards/python/rules/tooling.md +446 -446
  101. package/augment-extensions/coding-standards/python/rules/type-hints.md +253 -253
  102. package/augment-extensions/coding-standards/react/README.md +45 -45
  103. package/augment-extensions/coding-standards/react/module.json +27 -27
  104. package/augment-extensions/coding-standards/react/rules/component-patterns.md +214 -214
  105. package/augment-extensions/coding-standards/react/rules/hooks-best-practices.md +235 -235
  106. package/augment-extensions/coding-standards/react/rules/performance.md +300 -300
  107. package/augment-extensions/coding-standards/react/rules/state-management.md +265 -265
  108. package/augment-extensions/coding-standards/react/rules/typescript-react.md +271 -271
  109. package/augment-extensions/coding-standards/typescript/README.md +45 -45
  110. package/augment-extensions/coding-standards/typescript/module.json +27 -27
  111. package/augment-extensions/coding-standards/typescript/rules/naming-conventions.md +225 -225
  112. package/augment-extensions/collections/html-css-js/README.md +82 -82
  113. package/augment-extensions/collections/html-css-js/collection.json +41 -41
  114. package/augment-extensions/domain-rules/api-design/README.md +41 -41
  115. package/augment-extensions/domain-rules/api-design/module.json +27 -27
  116. package/augment-extensions/domain-rules/api-design/rules/authentication.md +263 -263
  117. package/augment-extensions/domain-rules/api-design/rules/documentation.md +395 -395
  118. package/augment-extensions/domain-rules/api-design/rules/error-handling.md +290 -290
  119. package/augment-extensions/domain-rules/api-design/rules/graphql-api.md +313 -313
  120. package/augment-extensions/domain-rules/api-design/rules/rest-api.md +214 -214
  121. package/augment-extensions/domain-rules/api-design/rules/versioning.md +268 -268
  122. package/augment-extensions/domain-rules/database/README.md +161 -161
  123. package/augment-extensions/domain-rules/database/examples/flat-database-example.md +793 -793
  124. package/augment-extensions/domain-rules/database/examples/hybrid-database-example.md +1132 -1132
  125. package/augment-extensions/domain-rules/database/examples/nosql-document-example.md +868 -868
  126. package/augment-extensions/domain-rules/database/examples/nosql-graph-example.md +805 -805
  127. package/augment-extensions/domain-rules/database/examples/relational-schema-example.md +621 -621
  128. package/augment-extensions/domain-rules/database/examples/vector-database-example.md +965 -965
  129. package/augment-extensions/domain-rules/database/module.json +28 -28
  130. package/augment-extensions/domain-rules/database/rules/flat-databases.md +624 -624
  131. package/augment-extensions/domain-rules/database/rules/nosql-databases.md +588 -588
  132. package/augment-extensions/domain-rules/database/rules/nosql-document-stores.md +856 -856
  133. package/augment-extensions/domain-rules/database/rules/nosql-graph-databases.md +778 -778
  134. package/augment-extensions/domain-rules/database/rules/nosql-key-value-stores.md +963 -963
  135. package/augment-extensions/domain-rules/database/rules/performance-optimization.md +1076 -1076
  136. package/augment-extensions/domain-rules/database/rules/relational-databases.md +697 -697
  137. package/augment-extensions/domain-rules/database/rules/relational-indexing.md +671 -671
  138. package/augment-extensions/domain-rules/database/rules/relational-query-optimization.md +607 -607
  139. package/augment-extensions/domain-rules/database/rules/relational-schema-design.md +907 -907
  140. package/augment-extensions/domain-rules/database/rules/relational-transactions.md +783 -783
  141. package/augment-extensions/domain-rules/database/rules/security-standards.md +980 -980
  142. package/augment-extensions/domain-rules/database/rules/universal-best-practices.md +485 -485
  143. package/augment-extensions/domain-rules/database/rules/vector-databases.md +521 -521
  144. package/augment-extensions/domain-rules/database/rules/vector-embeddings.md +858 -858
  145. package/augment-extensions/domain-rules/database/rules/vector-indexing.md +934 -934
  146. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/README.md +23 -23
  147. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/module.json +26 -26
  148. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/README.md +23 -23
  149. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/module.json +26 -26
  150. package/augment-extensions/domain-rules/design/color/themes/dracula/README.md +23 -23
  151. package/augment-extensions/domain-rules/design/color/themes/dracula/module.json +26 -26
  152. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/README.md +23 -23
  153. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/module.json +26 -26
  154. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/README.md +23 -23
  155. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/module.json +26 -26
  156. package/augment-extensions/domain-rules/design/color/themes/high-contrast/README.md +27 -27
  157. package/augment-extensions/domain-rules/design/color/themes/high-contrast/module.json +26 -26
  158. package/augment-extensions/domain-rules/design/color/themes/monokai/README.md +23 -23
  159. package/augment-extensions/domain-rules/design/color/themes/monokai/module.json +26 -26
  160. package/augment-extensions/domain-rules/design/color/themes/nord/README.md +23 -23
  161. package/augment-extensions/domain-rules/design/color/themes/nord/module.json +26 -26
  162. package/augment-extensions/domain-rules/design/color/themes/one-dark/README.md +23 -23
  163. package/augment-extensions/domain-rules/design/color/themes/one-dark/module.json +26 -26
  164. package/augment-extensions/domain-rules/design/color/themes/one-light/README.md +23 -23
  165. package/augment-extensions/domain-rules/design/color/themes/one-light/module.json +26 -26
  166. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/README.md +23 -23
  167. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/module.json +26 -26
  168. package/augment-extensions/domain-rules/design/color/themes/solarized-light/README.md +23 -23
  169. package/augment-extensions/domain-rules/design/color/themes/solarized-light/module.json +26 -26
  170. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/README.md +23 -23
  171. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/module.json +26 -26
  172. package/augment-extensions/domain-rules/mcp/README.md +150 -150
  173. package/augment-extensions/domain-rules/mcp/examples/compressed-example.md +522 -522
  174. package/augment-extensions/domain-rules/mcp/examples/graph-augmented-example.md +520 -520
  175. package/augment-extensions/domain-rules/mcp/examples/hybrid-example.md +570 -570
  176. package/augment-extensions/domain-rules/mcp/examples/state-based-example.md +427 -427
  177. package/augment-extensions/domain-rules/mcp/examples/token-based-example.md +435 -435
  178. package/augment-extensions/domain-rules/mcp/examples/vector-based-example.md +502 -502
  179. package/augment-extensions/domain-rules/mcp/module.json +49 -49
  180. package/augment-extensions/domain-rules/mcp/rules/compressed-mcp.md +595 -595
  181. package/augment-extensions/domain-rules/mcp/rules/configuration.md +345 -345
  182. package/augment-extensions/domain-rules/mcp/rules/graph-augmented-mcp.md +687 -687
  183. package/augment-extensions/domain-rules/mcp/rules/hybrid-mcp.md +636 -636
  184. package/augment-extensions/domain-rules/mcp/rules/state-based-mcp.md +484 -484
  185. package/augment-extensions/domain-rules/mcp/rules/testing-validation.md +360 -360
  186. package/augment-extensions/domain-rules/mcp/rules/token-based-mcp.md +393 -393
  187. package/augment-extensions/domain-rules/mcp/rules/universal-rules.md +194 -194
  188. package/augment-extensions/domain-rules/mcp/rules/vector-based-mcp.md +625 -625
  189. package/augment-extensions/domain-rules/security/README.md +41 -41
  190. package/augment-extensions/domain-rules/security/module.json +28 -28
  191. package/augment-extensions/domain-rules/security/rules/authentication-security.md +361 -361
  192. package/augment-extensions/domain-rules/security/rules/encryption.md +208 -208
  193. package/augment-extensions/domain-rules/security/rules/input-validation.md +294 -294
  194. package/augment-extensions/domain-rules/security/rules/owasp-top-10.md +339 -339
  195. package/augment-extensions/domain-rules/security/rules/secure-coding.md +293 -293
  196. package/augment-extensions/domain-rules/security/rules/web-security.md +268 -268
  197. package/augment-extensions/domain-rules/seo-sales-marketing/ANNOUNCEMENT.md +143 -0
  198. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/README.md +140 -136
  199. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/SCHEMA-VALIDATION-REPORT.md +216 -216
  200. package/augment-extensions/domain-rules/seo-sales-marketing/TEST-VALIDATION.md +129 -0
  201. package/augment-extensions/domain-rules/seo-sales-marketing/USAGE-GUIDES.md +254 -0
  202. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/brand-kit-example.yaml +292 -292
  203. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/campaign-brief-example.yaml +389 -389
  204. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/content-calendar-example.yaml +643 -643
  205. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/email-newsletter-example.md +376 -376
  206. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/landing-page-example.md +934 -934
  207. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/ppc-ad-copy-example.md +301 -301
  208. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/seo-blog-post-example.md +347 -347
  209. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/social-media-campaign-example.md +606 -606
  210. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/module.json +50 -50
  211. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/affiliate-influencer-marketing.md +593 -593
  212. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/asset-management.md +418 -418
  213. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/brand-consistency.md +210 -210
  214. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/content-marketing.md +337 -337
  215. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/conversion-optimization.md +455 -455
  216. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/direct-sales.md +499 -499
  217. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/email-marketing.md +439 -439
  218. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/legal-compliance.md +227 -227
  219. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/ppc-advertising.md +569 -569
  220. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/seo-optimization.md +470 -470
  221. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/social-media-marketing.md +414 -414
  222. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/universal-marketing.md +177 -177
  223. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/asset-inventory.schema.json +247 -247
  224. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/brand-kit.schema.json +326 -326
  225. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/campaign-brief.schema.json +342 -342
  226. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/color-palette.schema.json +223 -223
  227. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/content-template.schema.json +383 -383
  228. package/augment-extensions/domain-rules/wordpress/README.md +163 -163
  229. package/augment-extensions/domain-rules/wordpress/module.json +32 -32
  230. package/augment-extensions/domain-rules/wordpress/rules/coding-standards.md +617 -617
  231. package/augment-extensions/domain-rules/wordpress/rules/directory-structure.md +270 -270
  232. package/augment-extensions/domain-rules/wordpress/rules/file-patterns.md +423 -423
  233. package/augment-extensions/domain-rules/wordpress/rules/gutenberg-blocks.md +493 -493
  234. package/augment-extensions/domain-rules/wordpress/rules/performance.md +568 -568
  235. package/augment-extensions/domain-rules/wordpress/rules/plugin-development.md +510 -510
  236. package/augment-extensions/domain-rules/wordpress/rules/project-detection.md +251 -251
  237. package/augment-extensions/domain-rules/wordpress/rules/rest-api.md +501 -501
  238. package/augment-extensions/domain-rules/wordpress/rules/security.md +564 -564
  239. package/augment-extensions/domain-rules/wordpress/rules/theme-development.md +388 -388
  240. package/augment-extensions/domain-rules/wordpress/rules/woocommerce.md +441 -441
  241. package/augment-extensions/domain-rules/wordpress-plugin/README.md +139 -139
  242. package/augment-extensions/domain-rules/wordpress-plugin/examples/ajax-plugin.md +1599 -1599
  243. package/augment-extensions/domain-rules/wordpress-plugin/examples/custom-post-type-plugin.md +1727 -1727
  244. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block-plugin.md +428 -428
  245. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block.md +422 -422
  246. package/augment-extensions/domain-rules/wordpress-plugin/examples/mvc-plugin.md +1623 -1623
  247. package/augment-extensions/domain-rules/wordpress-plugin/examples/object-oriented-plugin.md +1343 -1343
  248. package/augment-extensions/domain-rules/wordpress-plugin/examples/rest-endpoint.md +734 -734
  249. package/augment-extensions/domain-rules/wordpress-plugin/examples/settings-page-plugin.md +1350 -1350
  250. package/augment-extensions/domain-rules/wordpress-plugin/examples/simple-procedural-plugin.md +503 -503
  251. package/augment-extensions/domain-rules/wordpress-plugin/examples/singleton-plugin.md +971 -971
  252. package/augment-extensions/domain-rules/wordpress-plugin/module.json +53 -53
  253. package/augment-extensions/domain-rules/wordpress-plugin/rules/activation-hooks.md +770 -770
  254. package/augment-extensions/domain-rules/wordpress-plugin/rules/admin-interface.md +874 -874
  255. package/augment-extensions/domain-rules/wordpress-plugin/rules/ajax-handlers.md +629 -629
  256. package/augment-extensions/domain-rules/wordpress-plugin/rules/asset-management.md +559 -559
  257. package/augment-extensions/domain-rules/wordpress-plugin/rules/context-providers.md +709 -709
  258. package/augment-extensions/domain-rules/wordpress-plugin/rules/cron-jobs.md +736 -736
  259. package/augment-extensions/domain-rules/wordpress-plugin/rules/database-management.md +1057 -1057
  260. package/augment-extensions/domain-rules/wordpress-plugin/rules/documentation-standards.md +463 -463
  261. package/augment-extensions/domain-rules/wordpress-plugin/rules/frontend-functionality.md +478 -478
  262. package/augment-extensions/domain-rules/wordpress-plugin/rules/gutenberg-blocks.md +818 -818
  263. package/augment-extensions/domain-rules/wordpress-plugin/rules/internationalization.md +416 -416
  264. package/augment-extensions/domain-rules/wordpress-plugin/rules/migration.md +667 -667
  265. package/augment-extensions/domain-rules/wordpress-plugin/rules/performance-optimization.md +878 -878
  266. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-architecture.md +693 -693
  267. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-structure.md +352 -352
  268. package/augment-extensions/domain-rules/wordpress-plugin/rules/rest-api.md +818 -818
  269. package/augment-extensions/domain-rules/wordpress-plugin/rules/scaffolding-workflow.md +624 -624
  270. package/augment-extensions/domain-rules/wordpress-plugin/rules/security-best-practices.md +866 -866
  271. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing-patterns.md +1165 -1165
  272. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing.md +414 -414
  273. package/augment-extensions/domain-rules/wordpress-plugin/rules/vscode-integration.md +751 -751
  274. package/augment-extensions/domain-rules/wordpress-plugin/rules/woocommerce-integration.md +949 -949
  275. package/augment-extensions/domain-rules/wordpress-plugin/rules/wordpress-org-submission.md +458 -458
  276. package/augment-extensions/examples/design-patterns/README.md +37 -37
  277. package/augment-extensions/examples/design-patterns/examples/behavioral-patterns.md +370 -370
  278. package/augment-extensions/examples/design-patterns/examples/creational-patterns.md +250 -250
  279. package/augment-extensions/examples/design-patterns/examples/structural-patterns.md +264 -264
  280. package/augment-extensions/examples/design-patterns/module.json +27 -27
  281. package/augment-extensions/examples/gutenberg-block-plugin/README.md +101 -101
  282. package/augment-extensions/examples/gutenberg-block-plugin/examples/testimonial-block.md +428 -428
  283. package/augment-extensions/examples/gutenberg-block-plugin/module.json +40 -40
  284. package/augment-extensions/examples/rest-api-plugin/README.md +98 -98
  285. package/augment-extensions/examples/rest-api-plugin/examples/task-manager-api.md +1299 -1299
  286. package/augment-extensions/examples/rest-api-plugin/module.json +40 -40
  287. package/augment-extensions/examples/woocommerce-extension/README.md +98 -98
  288. package/augment-extensions/examples/woocommerce-extension/examples/product-customizer.md +763 -763
  289. package/augment-extensions/examples/woocommerce-extension/module.json +40 -40
  290. package/augment-extensions/workflows/beads/README.md +135 -135
  291. package/augment-extensions/workflows/beads/examples/complete-workflow-example.md +278 -278
  292. package/augment-extensions/workflows/beads/module.json +55 -55
  293. package/augment-extensions/workflows/beads/rules/best-practices.md +398 -398
  294. package/augment-extensions/workflows/beads/rules/file-format.md +327 -327
  295. package/augment-extensions/workflows/beads/rules/manual-setup.md +315 -315
  296. package/augment-extensions/workflows/beads/rules/workflow.md +326 -326
  297. package/augment-extensions/workflows/beads-integration/IMPLEMENTATION-STATUS.md +145 -145
  298. package/augment-extensions/workflows/beads-integration/README.md +143 -143
  299. package/augment-extensions/workflows/beads-integration/config/defaults.json +32 -32
  300. package/augment-extensions/workflows/beads-integration/config/schema.json +140 -140
  301. package/augment-extensions/workflows/beads-integration/examples/basic-task-generation.md +293 -293
  302. package/augment-extensions/workflows/beads-integration/module.json +75 -75
  303. package/augment-extensions/workflows/beads-integration/rules/core-rules.md +219 -219
  304. package/augment-extensions/workflows/beads-integration/rules/effectiveness-standards.md +256 -256
  305. package/augment-extensions/workflows/beads-integration/rules/task-generation.md +607 -607
  306. package/augment-extensions/workflows/database/README.md +195 -195
  307. package/augment-extensions/workflows/database/ai-prompt-testing.md +295 -295
  308. package/augment-extensions/workflows/database/examples/migration-example.md +498 -498
  309. package/augment-extensions/workflows/database/examples/optimization-example.md +496 -496
  310. package/augment-extensions/workflows/database/examples/schema-design-example.md +444 -444
  311. package/augment-extensions/workflows/database/module.json +42 -42
  312. package/augment-extensions/workflows/database/rules/data-migration.md +249 -249
  313. package/augment-extensions/workflows/database/rules/documentation-standards.md +339 -339
  314. package/augment-extensions/workflows/database/rules/migration-workflow.md +352 -352
  315. package/augment-extensions/workflows/database/rules/optimization-workflow.md +435 -435
  316. package/augment-extensions/workflows/database/rules/schema-design-workflow.md +535 -535
  317. package/augment-extensions/workflows/database/rules/testing-patterns.md +305 -305
  318. package/augment-extensions/workflows/database/rules/workflow.md +458 -458
  319. package/augment-extensions/workflows/wordpress-plugin/README.md +232 -232
  320. package/augment-extensions/workflows/wordpress-plugin/ai-prompts.md +839 -839
  321. package/augment-extensions/workflows/wordpress-plugin/bead-decomposition-patterns.md +854 -854
  322. package/augment-extensions/workflows/wordpress-plugin/examples/complete-plugin-example.md +540 -540
  323. package/augment-extensions/workflows/wordpress-plugin/examples/custom-post-type-example.md +1083 -1083
  324. package/augment-extensions/workflows/wordpress-plugin/examples/feature-addition-workflow.md +669 -669
  325. package/augment-extensions/workflows/wordpress-plugin/examples/plugin-creation-workflow.md +597 -597
  326. package/augment-extensions/workflows/wordpress-plugin/examples/secure-form-handler-example.md +925 -925
  327. package/augment-extensions/workflows/wordpress-plugin/examples/security-audit-workflow.md +752 -752
  328. package/augment-extensions/workflows/wordpress-plugin/examples/wordpress-org-submission-workflow.md +773 -773
  329. package/augment-extensions/workflows/wordpress-plugin/module.json +49 -49
  330. package/augment-extensions/workflows/wordpress-plugin/rules/best-practices.md +942 -942
  331. package/augment-extensions/workflows/wordpress-plugin/rules/development-workflow.md +702 -702
  332. package/augment-extensions/workflows/wordpress-plugin/rules/submission-workflow.md +728 -728
  333. package/augment-extensions/workflows/wordpress-plugin/rules/testing-workflow.md +775 -775
  334. package/augment-extensions/writing-standards/screenplay/README.md +339 -300
  335. package/augment-extensions/writing-standards/screenplay/_templates/README.md +121 -121
  336. package/augment-extensions/writing-standards/screenplay/_templates/genre-template.md +153 -153
  337. package/augment-extensions/writing-standards/screenplay/_templates/style-template.md +243 -243
  338. package/augment-extensions/writing-standards/screenplay/_templates/theme-template.md +213 -213
  339. package/augment-extensions/writing-standards/screenplay/examples/aaa-hollywood-scene.fountain +164 -164
  340. package/augment-extensions/writing-standards/screenplay/examples/beat-sheet-example.yaml +95 -95
  341. package/augment-extensions/writing-standards/screenplay/examples/character-profile-example.yaml +116 -116
  342. package/augment-extensions/writing-standards/screenplay/examples/commercial-30sec.fountain +151 -151
  343. package/augment-extensions/writing-standards/screenplay/examples/independent-monologue.fountain +67 -67
  344. package/augment-extensions/writing-standards/screenplay/examples/news-segment.fountain +142 -142
  345. package/augment-extensions/writing-standards/screenplay/examples/plot-outline-example.yaml +184 -184
  346. package/augment-extensions/writing-standards/screenplay/examples/tv-episode-teaser.fountain +204 -204
  347. package/augment-extensions/writing-standards/screenplay/genres/README.md +181 -181
  348. package/augment-extensions/writing-standards/screenplay/genres/examples/.gitkeep +2 -2
  349. package/augment-extensions/writing-standards/screenplay/genres/module.json +70 -70
  350. package/augment-extensions/writing-standards/screenplay/genres/rules/.gitkeep +2 -2
  351. package/augment-extensions/writing-standards/screenplay/genres/rules/action.md +399 -399
  352. package/augment-extensions/writing-standards/screenplay/genres/rules/adventure.md +407 -407
  353. package/augment-extensions/writing-standards/screenplay/genres/rules/animation.md +293 -293
  354. package/augment-extensions/writing-standards/screenplay/genres/rules/biographical.md +293 -293
  355. package/augment-extensions/writing-standards/screenplay/genres/rules/comedy.md +401 -401
  356. package/augment-extensions/writing-standards/screenplay/genres/rules/documentary.md +293 -293
  357. package/augment-extensions/writing-standards/screenplay/genres/rules/drama.md +409 -409
  358. package/augment-extensions/writing-standards/screenplay/genres/rules/fantasy.md +293 -293
  359. package/augment-extensions/writing-standards/screenplay/genres/rules/historical.md +293 -293
  360. package/augment-extensions/writing-standards/screenplay/genres/rules/horror.md +268 -268
  361. package/augment-extensions/writing-standards/screenplay/genres/rules/musical.md +294 -294
  362. package/augment-extensions/writing-standards/screenplay/genres/rules/mystery.md +293 -293
  363. package/augment-extensions/writing-standards/screenplay/genres/rules/noir.md +294 -294
  364. package/augment-extensions/writing-standards/screenplay/genres/rules/romance.md +293 -293
  365. package/augment-extensions/writing-standards/screenplay/genres/rules/sci-fi.md +289 -289
  366. package/augment-extensions/writing-standards/screenplay/genres/rules/superhero.md +293 -293
  367. package/augment-extensions/writing-standards/screenplay/genres/rules/thriller.md +294 -294
  368. package/augment-extensions/writing-standards/screenplay/genres/rules/western.md +293 -293
  369. package/augment-extensions/writing-standards/screenplay/module.json +124 -124
  370. package/augment-extensions/writing-standards/screenplay/rules/aaa-hollywood-films.md +339 -339
  371. package/augment-extensions/writing-standards/screenplay/rules/ai-integration-testing.md +329 -329
  372. package/augment-extensions/writing-standards/screenplay/rules/character-development.md +169 -169
  373. package/augment-extensions/writing-standards/screenplay/rules/commercials.md +437 -437
  374. package/augment-extensions/writing-standards/screenplay/rules/dialogue-writing.md +263 -263
  375. package/augment-extensions/writing-standards/screenplay/rules/diversity-inclusion.md +261 -261
  376. package/augment-extensions/writing-standards/screenplay/rules/examples-guide.md +315 -315
  377. package/augment-extensions/writing-standards/screenplay/rules/file-organization.md +213 -0
  378. package/augment-extensions/writing-standards/screenplay/rules/formatting-validation.md +413 -413
  379. package/augment-extensions/writing-standards/screenplay/rules/fountain-format.md +372 -372
  380. package/augment-extensions/writing-standards/screenplay/rules/independent-films.md +374 -374
  381. package/augment-extensions/writing-standards/screenplay/rules/live-tv-productions.md +443 -443
  382. package/augment-extensions/writing-standards/screenplay/rules/narrative-structures.md +207 -207
  383. package/augment-extensions/writing-standards/screenplay/rules/news-broadcasts.md +444 -444
  384. package/augment-extensions/writing-standards/screenplay/rules/pacing-timing.md +331 -331
  385. package/augment-extensions/writing-standards/screenplay/rules/quality-review-checklist.md +334 -334
  386. package/augment-extensions/writing-standards/screenplay/rules/quick-reference.md +299 -299
  387. package/augment-extensions/writing-standards/screenplay/rules/screen-continuity.md +263 -263
  388. package/augment-extensions/writing-standards/screenplay/rules/streaming-content.md +412 -412
  389. package/augment-extensions/writing-standards/screenplay/rules/trope-management.md +370 -370
  390. package/augment-extensions/writing-standards/screenplay/rules/tv-series.md +374 -374
  391. package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md +339 -339
  392. package/augment-extensions/writing-standards/screenplay/rules/vscode-integration.md +277 -277
  393. package/augment-extensions/writing-standards/screenplay/rules/web-content.md +393 -393
  394. package/augment-extensions/writing-standards/screenplay/schemas/beat-sheet.json +332 -332
  395. package/augment-extensions/writing-standards/screenplay/schemas/character-profile.json +247 -247
  396. package/augment-extensions/writing-standards/screenplay/schemas/feature-selection.json +200 -200
  397. package/augment-extensions/writing-standards/screenplay/schemas/plot-outline.json +233 -233
  398. package/augment-extensions/writing-standards/screenplay/schemas/screenplay-config.json +245 -245
  399. package/augment-extensions/writing-standards/screenplay/schemas/trope-inventory.json +221 -221
  400. package/augment-extensions/writing-standards/screenplay/styles/README.md +159 -159
  401. package/augment-extensions/writing-standards/screenplay/styles/examples/.gitkeep +2 -2
  402. package/augment-extensions/writing-standards/screenplay/styles/examples/style-applications.md +1449 -1449
  403. package/augment-extensions/writing-standards/screenplay/styles/module.json +64 -64
  404. package/augment-extensions/writing-standards/screenplay/styles/rules/.gitkeep +2 -2
  405. package/augment-extensions/writing-standards/screenplay/styles/rules/dialogue-centric.md +520 -520
  406. package/augment-extensions/writing-standards/screenplay/styles/rules/ensemble.md +499 -499
  407. package/augment-extensions/writing-standards/screenplay/styles/rules/epic.md +497 -497
  408. package/augment-extensions/writing-standards/screenplay/styles/rules/experimental.md +492 -492
  409. package/augment-extensions/writing-standards/screenplay/styles/rules/flashback.md +509 -509
  410. package/augment-extensions/writing-standards/screenplay/styles/rules/linear.md +490 -490
  411. package/augment-extensions/writing-standards/screenplay/styles/rules/minimalist.md +499 -499
  412. package/augment-extensions/writing-standards/screenplay/styles/rules/non-linear.md +501 -501
  413. package/augment-extensions/writing-standards/screenplay/styles/rules/poetic.md +499 -499
  414. package/augment-extensions/writing-standards/screenplay/styles/rules/realistic.md +498 -498
  415. package/augment-extensions/writing-standards/screenplay/styles/rules/satirical.md +499 -499
  416. package/augment-extensions/writing-standards/screenplay/styles/rules/surreal.md +508 -508
  417. package/augment-extensions/writing-standards/screenplay/styles/rules/voice-over.md +500 -500
  418. package/augment-extensions/writing-standards/screenplay/themes/README.md +158 -158
  419. package/augment-extensions/writing-standards/screenplay/themes/examples/.gitkeep +2 -2
  420. package/augment-extensions/writing-standards/screenplay/themes/examples/common-mistakes-and-fixes.md +643 -643
  421. package/augment-extensions/writing-standards/screenplay/themes/examples/complete-scene-example.md +311 -311
  422. package/augment-extensions/writing-standards/screenplay/themes/examples/individual-theme-examples.md +562 -562
  423. package/augment-extensions/writing-standards/screenplay/themes/examples/multi-theme-weaving.md +538 -538
  424. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-application-guide.md +432 -432
  425. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-integration-across-acts.md +637 -637
  426. package/augment-extensions/writing-standards/screenplay/themes/module.json +66 -66
  427. package/augment-extensions/writing-standards/screenplay/themes/rules/.gitkeep +2 -2
  428. package/augment-extensions/writing-standards/screenplay/themes/rules/ambition.md +458 -458
  429. package/augment-extensions/writing-standards/screenplay/themes/rules/betrayal.md +490 -490
  430. package/augment-extensions/writing-standards/screenplay/themes/rules/environment.md +458 -458
  431. package/augment-extensions/writing-standards/screenplay/themes/rules/fate.md +459 -459
  432. package/augment-extensions/writing-standards/screenplay/themes/rules/friendship.md +491 -491
  433. package/augment-extensions/writing-standards/screenplay/themes/rules/growth.md +491 -491
  434. package/augment-extensions/writing-standards/screenplay/themes/rules/identity.md +490 -490
  435. package/augment-extensions/writing-standards/screenplay/themes/rules/isolation.md +464 -464
  436. package/augment-extensions/writing-standards/screenplay/themes/rules/justice.md +461 -461
  437. package/augment-extensions/writing-standards/screenplay/themes/rules/love.md +489 -489
  438. package/augment-extensions/writing-standards/screenplay/themes/rules/power.md +494 -494
  439. package/augment-extensions/writing-standards/screenplay/themes/rules/redemption.md +483 -483
  440. package/augment-extensions/writing-standards/screenplay/themes/rules/revenge.md +489 -489
  441. package/augment-extensions/writing-standards/screenplay/themes/rules/survival.md +496 -496
  442. package/augment-extensions/writing-standards/screenplay/themes/rules/technology.md +463 -463
  443. package/augment-extensions/writing-standards/screenplay/utils/__tests__/file-organization.test.ts +169 -0
  444. package/augment-extensions/writing-standards/screenplay/utils/file-organization.ts +165 -0
  445. package/cli/MODULES.md +302 -302
  446. package/cli/dist/cli.js +109 -22
  447. package/cli/dist/cli.js.map +1 -1
  448. package/cli/dist/commands/gui.d.ts.map +1 -1
  449. package/cli/dist/commands/gui.js +54 -6
  450. package/cli/dist/commands/gui.js.map +1 -1
  451. package/cli/dist/commands/init.d.ts.map +1 -1
  452. package/cli/dist/commands/init.js +76 -23
  453. package/cli/dist/commands/init.js.map +1 -1
  454. package/cli/dist/commands/self-remove.d.ts.map +1 -1
  455. package/cli/dist/commands/self-remove.js +48 -74
  456. package/cli/dist/commands/self-remove.js.map +1 -1
  457. package/cli/dist/commands/show.d.ts +11 -0
  458. package/cli/dist/commands/show.d.ts.map +1 -1
  459. package/cli/dist/commands/show.js +120 -0
  460. package/cli/dist/commands/show.js.map +1 -1
  461. package/cli/dist/commands/showCompleted.d.ts +21 -0
  462. package/cli/dist/commands/showCompleted.d.ts.map +1 -0
  463. package/cli/dist/commands/showCompleted.js +225 -0
  464. package/cli/dist/commands/showCompleted.js.map +1 -0
  465. package/cli/dist/commands/skill.js +88 -88
  466. package/cli/dist/commands/update.d.ts +2 -0
  467. package/cli/dist/commands/update.d.ts.map +1 -1
  468. package/cli/dist/commands/update.js +67 -1
  469. package/cli/dist/commands/update.js.map +1 -1
  470. package/cli/dist/utils/beadsCompletedChecker.d.ts +72 -0
  471. package/cli/dist/utils/beadsCompletedChecker.d.ts.map +1 -0
  472. package/cli/dist/utils/beadsCompletedChecker.js +198 -0
  473. package/cli/dist/utils/beadsCompletedChecker.js.map +1 -0
  474. package/cli/dist/utils/catalog-sync.js +13 -13
  475. package/cli/dist/utils/extractCommandHelp.d.ts +51 -0
  476. package/cli/dist/utils/extractCommandHelp.d.ts.map +1 -0
  477. package/cli/dist/utils/extractCommandHelp.js +250 -0
  478. package/cli/dist/utils/extractCommandHelp.js.map +1 -0
  479. package/cli/dist/utils/install-rules.js +55 -55
  480. package/cli/dist/utils/mcp-integration.js +44 -44
  481. package/cli/dist/utils/rule-install-hooks.js +8 -8
  482. package/modules.md +667 -630
  483. package/package.json +85 -85
@@ -1,621 +1,621 @@
1
- # Relational Schema Example: E-Commerce Database
2
-
3
- ## Overview
4
-
5
- This example demonstrates a comprehensive e-commerce database schema with proper normalization, foreign keys, indexes, and constraints.
6
-
7
- **Features:**
8
- - User management
9
- - Product catalog
10
- - Shopping cart
11
- - Order processing
12
- - Inventory tracking
13
- - Reviews and ratings
14
-
15
- ---
16
-
17
- ## Entity-Relationship Diagram
18
-
19
- ```
20
- users (1) ──────< (N) orders
21
- │ │
22
- │ │
23
- │ └──< (N) order_items >──┐
24
- │ │
25
- │ │
26
- └──< (N) cart_items >──┐ │
27
- │ │ │
28
- │ ▼ ▼
29
- │ products (1) ──────< (N) product_images
30
- │ │
31
- │ └──< (N) reviews
32
-
33
- └──< (N) addresses
34
- ```
35
-
36
- ---
37
-
38
- ## Schema Definition
39
-
40
- ### Users Table
41
-
42
- ```sql
43
- CREATE TABLE users (
44
- id SERIAL PRIMARY KEY,
45
- email VARCHAR(255) NOT NULL UNIQUE,
46
- password_hash VARCHAR(255) NOT NULL,
47
- first_name VARCHAR(100) NOT NULL,
48
- last_name VARCHAR(100) NOT NULL,
49
- phone VARCHAR(20),
50
- status VARCHAR(20) NOT NULL DEFAULT 'active' CHECK (status IN ('active', 'inactive', 'suspended')),
51
- created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
52
- updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
53
- );
54
-
55
- -- Indexes
56
- CREATE INDEX idx_users_email ON users(email);
57
- CREATE INDEX idx_users_status ON users(status);
58
- CREATE INDEX idx_users_created_at ON users(created_at);
59
-
60
- -- Comments
61
- COMMENT ON TABLE users IS 'User accounts for the e-commerce platform';
62
- COMMENT ON COLUMN users.status IS 'User account status: active, inactive, or suspended';
63
- ```
64
-
65
- ### Addresses Table
66
-
67
- ```sql
68
- CREATE TABLE addresses (
69
- id SERIAL PRIMARY KEY,
70
- user_id INT NOT NULL REFERENCES users(id) ON DELETE CASCADE,
71
- address_type VARCHAR(20) NOT NULL CHECK (address_type IN ('billing', 'shipping')),
72
- street_line1 VARCHAR(255) NOT NULL,
73
- street_line2 VARCHAR(255),
74
- city VARCHAR(100) NOT NULL,
75
- state VARCHAR(100) NOT NULL,
76
- postal_code VARCHAR(20) NOT NULL,
77
- country VARCHAR(100) NOT NULL DEFAULT 'USA',
78
- is_default BOOLEAN NOT NULL DEFAULT false,
79
- created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
80
- updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
81
- );
82
-
83
- -- Indexes
84
- CREATE INDEX idx_addresses_user_id ON addresses(user_id);
85
- CREATE INDEX idx_addresses_type ON addresses(address_type);
86
-
87
- -- Unique constraint: Only one default address per type per user
88
- CREATE UNIQUE INDEX idx_addresses_default ON addresses(user_id, address_type, is_default)
89
- WHERE is_default = true;
90
-
91
- -- Comments
92
- COMMENT ON TABLE addresses IS 'User billing and shipping addresses';
93
- ```
94
-
95
- ### Products Table
96
-
97
- ```sql
98
- CREATE TABLE products (
99
- id SERIAL PRIMARY KEY,
100
- sku VARCHAR(50) NOT NULL UNIQUE,
101
- name VARCHAR(255) NOT NULL,
102
- description TEXT,
103
- price DECIMAL(10, 2) NOT NULL CHECK (price >= 0),
104
- cost DECIMAL(10, 2) CHECK (cost >= 0),
105
- stock_quantity INT NOT NULL DEFAULT 0 CHECK (stock_quantity >= 0),
106
- low_stock_threshold INT NOT NULL DEFAULT 10,
107
- status VARCHAR(20) NOT NULL DEFAULT 'active' CHECK (status IN ('active', 'inactive', 'discontinued')),
108
- category VARCHAR(100),
109
- brand VARCHAR(100),
110
- weight_kg DECIMAL(8, 2),
111
- created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
112
- updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
113
- );
114
-
115
- -- Indexes
116
- CREATE INDEX idx_products_sku ON products(sku);
117
- CREATE INDEX idx_products_status ON products(status);
118
- CREATE INDEX idx_products_category ON products(category);
119
- CREATE INDEX idx_products_brand ON products(brand);
120
- CREATE INDEX idx_products_price ON products(price);
121
-
122
- -- Full-text search index (PostgreSQL)
123
- CREATE INDEX idx_products_search ON products USING GIN(to_tsvector('english', name || ' ' || COALESCE(description, '')));
124
-
125
- -- Comments
126
- COMMENT ON TABLE products IS 'Product catalog';
127
- COMMENT ON COLUMN products.sku IS 'Stock Keeping Unit - unique product identifier';
128
- COMMENT ON COLUMN products.low_stock_threshold IS 'Alert when stock falls below this level';
129
- ```
130
-
131
- ### Product Images Table
132
-
133
- ```sql
134
- CREATE TABLE product_images (
135
- id SERIAL PRIMARY KEY,
136
- product_id INT NOT NULL REFERENCES products(id) ON DELETE CASCADE,
137
- url VARCHAR(500) NOT NULL,
138
- alt_text VARCHAR(255),
139
- display_order INT NOT NULL DEFAULT 0,
140
- is_primary BOOLEAN NOT NULL DEFAULT false,
141
- created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
142
- );
143
-
144
- -- Indexes
145
- CREATE INDEX idx_product_images_product_id ON product_images(product_id);
146
-
147
- -- Unique constraint: Only one primary image per product
148
- CREATE UNIQUE INDEX idx_product_images_primary ON product_images(product_id, is_primary)
149
- WHERE is_primary = true;
150
-
151
- -- Comments
152
- COMMENT ON TABLE product_images IS 'Product images and photos';
153
- ```
154
-
155
- ### Cart Items Table
156
-
157
- ```sql
158
- CREATE TABLE cart_items (
159
- id SERIAL PRIMARY KEY,
160
- user_id INT NOT NULL REFERENCES users(id) ON DELETE CASCADE,
161
- product_id INT NOT NULL REFERENCES products(id) ON DELETE CASCADE,
162
- quantity INT NOT NULL CHECK (quantity > 0),
163
- added_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
164
- updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
165
-
166
- -- Unique constraint: One row per user-product combination
167
- UNIQUE(user_id, product_id)
168
- );
169
-
170
- -- Indexes
171
- CREATE INDEX idx_cart_items_user_id ON cart_items(user_id);
172
- CREATE INDEX idx_cart_items_product_id ON cart_items(product_id);
173
-
174
- -- Comments
175
- COMMENT ON TABLE cart_items IS 'Shopping cart items for users';
176
- ```
177
-
178
- ### Orders Table
179
-
180
- ```sql
181
- CREATE TABLE orders (
182
- id SERIAL PRIMARY KEY,
183
- user_id INT NOT NULL REFERENCES users(id),
184
- order_number VARCHAR(50) NOT NULL UNIQUE,
185
- status VARCHAR(20) NOT NULL DEFAULT 'pending' CHECK (status IN ('pending', 'processing', 'shipped', 'delivered', 'cancelled')),
186
- subtotal DECIMAL(10, 2) NOT NULL CHECK (subtotal >= 0),
187
- tax DECIMAL(10, 2) NOT NULL DEFAULT 0 CHECK (tax >= 0),
188
- shipping_cost DECIMAL(10, 2) NOT NULL DEFAULT 0 CHECK (shipping_cost >= 0),
189
- total DECIMAL(10, 2) NOT NULL CHECK (total >= 0),
190
- shipping_address_id INT REFERENCES addresses(id),
191
- billing_address_id INT REFERENCES addresses(id),
192
- payment_method VARCHAR(50),
193
- payment_status VARCHAR(20) NOT NULL DEFAULT 'pending' CHECK (payment_status IN ('pending', 'paid', 'failed', 'refunded')),
194
- notes TEXT,
195
- created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
196
- updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
197
- shipped_at TIMESTAMP,
198
- delivered_at TIMESTAMP
199
- );
200
-
201
- -- Indexes
202
- CREATE INDEX idx_orders_user_id ON orders(user_id);
203
- CREATE INDEX idx_orders_order_number ON orders(order_number);
204
- CREATE INDEX idx_orders_status ON orders(status);
205
- CREATE INDEX idx_orders_payment_status ON orders(payment_status);
206
- CREATE INDEX idx_orders_created_at ON orders(created_at DESC);
207
-
208
- -- Composite index for common queries
209
- CREATE INDEX idx_orders_user_status ON orders(user_id, status);
210
-
211
- -- Comments
212
- COMMENT ON TABLE orders IS 'Customer orders';
213
- COMMENT ON COLUMN orders.order_number IS 'Human-readable order number (e.g., ORD-2024-00001)';
214
- ```
215
-
216
- ### Order Items Table
217
-
218
- ```sql
219
- CREATE TABLE order_items (
220
- id SERIAL PRIMARY KEY,
221
- order_id INT NOT NULL REFERENCES orders(id) ON DELETE CASCADE,
222
- product_id INT NOT NULL REFERENCES products(id),
223
- quantity INT NOT NULL CHECK (quantity > 0),
224
- unit_price DECIMAL(10, 2) NOT NULL CHECK (unit_price >= 0),
225
- total_price DECIMAL(10, 2) NOT NULL CHECK (total_price >= 0),
226
- created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
227
- );
228
-
229
- -- Indexes
230
- CREATE INDEX idx_order_items_order_id ON order_items(order_id);
231
- CREATE INDEX idx_order_items_product_id ON order_items(product_id);
232
-
233
- -- Comments
234
- COMMENT ON TABLE order_items IS 'Line items for orders';
235
- COMMENT ON COLUMN order_items.unit_price IS 'Price at time of order (may differ from current product price)';
236
- ```
237
-
238
- ### Reviews Table
239
-
240
- ```sql
241
- CREATE TABLE reviews (
242
- id SERIAL PRIMARY KEY,
243
- product_id INT NOT NULL REFERENCES products(id) ON DELETE CASCADE,
244
- user_id INT NOT NULL REFERENCES users(id) ON DELETE CASCADE,
245
- rating INT NOT NULL CHECK (rating >= 1 AND rating <= 5),
246
- title VARCHAR(255),
247
- comment TEXT,
248
- verified_purchase BOOLEAN NOT NULL DEFAULT false,
249
- helpful_count INT NOT NULL DEFAULT 0,
250
- created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
251
- updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
252
-
253
- -- Unique constraint: One review per user per product
254
- UNIQUE(product_id, user_id)
255
- );
256
-
257
- -- Indexes
258
- CREATE INDEX idx_reviews_product_id ON reviews(product_id);
259
- CREATE INDEX idx_reviews_user_id ON reviews(user_id);
260
- CREATE INDEX idx_reviews_rating ON reviews(rating);
261
- CREATE INDEX idx_reviews_created_at ON reviews(created_at DESC);
262
-
263
- -- Comments
264
- COMMENT ON TABLE reviews IS 'Product reviews and ratings';
265
- COMMENT ON COLUMN reviews.verified_purchase IS 'True if user purchased this product';
266
- ```
267
-
268
- ---
269
-
270
- ## Sample Queries
271
-
272
- ### Query 1: Get User with Addresses
273
-
274
- ```sql
275
- SELECT
276
- u.id,
277
- u.email,
278
- u.first_name,
279
- u.last_name,
280
- json_agg(
281
- json_build_object(
282
- 'id', a.id,
283
- 'type', a.address_type,
284
- 'street', a.street_line1,
285
- 'city', a.city,
286
- 'state', a.state,
287
- 'postal_code', a.postal_code,
288
- 'is_default', a.is_default
289
- )
290
- ) AS addresses
291
- FROM users u
292
- LEFT JOIN addresses a ON a.user_id = u.id
293
- WHERE u.id = 1
294
- GROUP BY u.id;
295
- ```
296
-
297
- **Explanation:**
298
- - Uses `LEFT JOIN` to include users even if they have no addresses
299
- - Uses `json_agg` to aggregate addresses into JSON array
300
- - Groups by user ID to get one row per user
301
-
302
- ### Query 2: Get Product with Images and Average Rating
303
-
304
- ```sql
305
- SELECT
306
- p.id,
307
- p.sku,
308
- p.name,
309
- p.description,
310
- p.price,
311
- p.stock_quantity,
312
- COALESCE(AVG(r.rating), 0) AS avg_rating,
313
- COUNT(r.id) AS review_count,
314
- json_agg(
315
- json_build_object(
316
- 'url', pi.url,
317
- 'alt_text', pi.alt_text,
318
- 'is_primary', pi.is_primary
319
- ) ORDER BY pi.display_order
320
- ) FILTER (WHERE pi.id IS NOT NULL) AS images
321
- FROM products p
322
- LEFT JOIN product_images pi ON pi.product_id = p.id
323
- LEFT JOIN reviews r ON r.product_id = p.id
324
- WHERE p.id = 1
325
- GROUP BY p.id;
326
- ```
327
-
328
- **Explanation:**
329
- - Joins product with images and reviews
330
- - Calculates average rating and review count
331
- - Aggregates images into JSON array ordered by display_order
332
- - Uses `FILTER` to exclude NULL images
333
-
334
- ### Query 3: Get User's Shopping Cart with Product Details
335
-
336
- ```sql
337
- SELECT
338
- ci.id AS cart_item_id,
339
- ci.quantity,
340
- p.id AS product_id,
341
- p.sku,
342
- p.name,
343
- p.price,
344
- p.stock_quantity,
345
- (ci.quantity * p.price) AS line_total,
346
- CASE
347
- WHEN p.stock_quantity >= ci.quantity THEN true
348
- ELSE false
349
- END AS in_stock
350
- FROM cart_items ci
351
- JOIN products p ON p.id = ci.product_id
352
- WHERE ci.user_id = 1
353
- ORDER BY ci.added_at DESC;
354
- ```
355
-
356
- **Explanation:**
357
- - Joins cart items with products
358
- - Calculates line total (quantity × price)
359
- - Checks if product is in stock
360
- - Orders by most recently added
361
-
362
- ### Query 4: Get Order with Items and Product Details
363
-
364
- ```sql
365
- SELECT
366
- o.id AS order_id,
367
- o.order_number,
368
- o.status,
369
- o.total,
370
- o.created_at,
371
- json_agg(
372
- json_build_object(
373
- 'product_id', p.id,
374
- 'product_name', p.name,
375
- 'sku', p.sku,
376
- 'quantity', oi.quantity,
377
- 'unit_price', oi.unit_price,
378
- 'total_price', oi.total_price
379
- )
380
- ) AS items
381
- FROM orders o
382
- JOIN order_items oi ON oi.order_id = o.id
383
- JOIN products p ON p.id = oi.product_id
384
- WHERE o.id = 1
385
- GROUP BY o.id;
386
- ```
387
-
388
- **Explanation:**
389
- - Joins order with order items and products
390
- - Aggregates items into JSON array
391
- - Groups by order ID to get one row per order
392
-
393
- ### Query 5: Get Products with Low Stock
394
-
395
- ```sql
396
- SELECT
397
- id,
398
- sku,
399
- name,
400
- stock_quantity,
401
- low_stock_threshold,
402
- (low_stock_threshold - stock_quantity) AS units_below_threshold
403
- FROM products
404
- WHERE stock_quantity < low_stock_threshold
405
- AND status = 'active'
406
- ORDER BY stock_quantity ASC;
407
- ```
408
-
409
- **Explanation:**
410
- - Filters products below low stock threshold
411
- - Only includes active products
412
- - Calculates how many units below threshold
413
- - Orders by lowest stock first
414
-
415
- ### Query 6: Get Top-Rated Products
416
-
417
- ```sql
418
- SELECT
419
- p.id,
420
- p.sku,
421
- p.name,
422
- p.price,
423
- AVG(r.rating) AS avg_rating,
424
- COUNT(r.id) AS review_count
425
- FROM products p
426
- JOIN reviews r ON r.product_id = p.id
427
- WHERE p.status = 'active'
428
- GROUP BY p.id
429
- HAVING COUNT(r.id) >= 5 -- At least 5 reviews
430
- ORDER BY avg_rating DESC, review_count DESC
431
- LIMIT 10;
432
- ```
433
-
434
- **Explanation:**
435
- - Joins products with reviews
436
- - Calculates average rating and review count
437
- - Filters to products with at least 5 reviews
438
- - Orders by highest rating first
439
- - Limits to top 10 products
440
-
441
- ### Query 7: Get User's Order History
442
-
443
- ```sql
444
- SELECT
445
- o.id,
446
- o.order_number,
447
- o.status,
448
- o.total,
449
- o.created_at,
450
- COUNT(oi.id) AS item_count
451
- FROM orders o
452
- LEFT JOIN order_items oi ON oi.order_id = o.id
453
- WHERE o.user_id = 1
454
- GROUP BY o.id
455
- ORDER BY o.created_at DESC;
456
- ```
457
-
458
- **Explanation:**
459
- - Gets all orders for a user
460
- - Counts number of items in each order
461
- - Orders by most recent first
462
-
463
- ### Query 8: Search Products by Name or Description
464
-
465
- ```sql
466
- -- Full-text search (PostgreSQL)
467
- SELECT
468
- id,
469
- sku,
470
- name,
471
- price,
472
- ts_rank(to_tsvector('english', name || ' ' || COALESCE(description, '')), query) AS rank
473
- FROM products,
474
- to_tsquery('english', 'laptop & gaming') AS query
475
- WHERE to_tsvector('english', name || ' ' || COALESCE(description, '')) @@ query
476
- AND status = 'active'
477
- ORDER BY rank DESC;
478
-
479
- -- Simple LIKE search (works on all databases)
480
- SELECT
481
- id,
482
- sku,
483
- name,
484
- price
485
- FROM products
486
- WHERE (name ILIKE '%laptop%' OR description ILIKE '%laptop%')
487
- AND status = 'active'
488
- ORDER BY name;
489
- ```
490
-
491
- **Explanation:**
492
- - PostgreSQL version uses full-text search with ranking
493
- - LIKE version works on all databases but slower
494
- - Both filter to active products only
495
-
496
- ---
497
-
498
- ## Sample Data Insertion
499
-
500
- ### Insert Users
501
-
502
- ```sql
503
- INSERT INTO users (email, password_hash, first_name, last_name, phone) VALUES
504
- ('john.doe@example.com', '$2b$10$...', 'John', 'Doe', '555-0101'),
505
- ('jane.smith@example.com', '$2b$10$...', 'Jane', 'Smith', '555-0102'),
506
- ('bob.johnson@example.com', '$2b$10$...', 'Bob', 'Johnson', '555-0103');
507
- ```
508
-
509
- ### Insert Addresses
510
-
511
- ```sql
512
- INSERT INTO addresses (user_id, address_type, street_line1, city, state, postal_code, is_default) VALUES
513
- (1, 'shipping', '123 Main St', 'New York', 'NY', '10001', true),
514
- (1, 'billing', '123 Main St', 'New York', 'NY', '10001', true),
515
- (2, 'shipping', '456 Oak Ave', 'Los Angeles', 'CA', '90001', true);
516
- ```
517
-
518
- ### Insert Products
519
-
520
- ```sql
521
- INSERT INTO products (sku, name, description, price, cost, stock_quantity, category, brand) VALUES
522
- ('LAP-001', 'Gaming Laptop Pro', 'High-performance gaming laptop with RTX 4080', 1999.99, 1500.00, 25, 'Laptops', 'TechBrand'),
523
- ('MOU-001', 'Wireless Gaming Mouse', 'Ergonomic wireless mouse with RGB lighting', 79.99, 40.00, 150, 'Accessories', 'PeripheralCo'),
524
- ('KEY-001', 'Mechanical Keyboard', 'RGB mechanical keyboard with Cherry MX switches', 149.99, 80.00, 75, 'Accessories', 'PeripheralCo');
525
- ```
526
-
527
- ### Insert Product Images
528
-
529
- ```sql
530
- INSERT INTO product_images (product_id, url, alt_text, display_order, is_primary) VALUES
531
- (1, 'https://example.com/images/laptop-1.jpg', 'Gaming Laptop Pro - Front View', 0, true),
532
- (1, 'https://example.com/images/laptop-2.jpg', 'Gaming Laptop Pro - Side View', 1, false),
533
- (2, 'https://example.com/images/mouse-1.jpg', 'Wireless Gaming Mouse', 0, true);
534
- ```
535
-
536
- ### Insert Cart Items
537
-
538
- ```sql
539
- INSERT INTO cart_items (user_id, product_id, quantity) VALUES
540
- (1, 1, 1),
541
- (1, 2, 2),
542
- (2, 3, 1);
543
- ```
544
-
545
- ### Insert Orders and Order Items
546
-
547
- ```sql
548
- -- Insert order
549
- INSERT INTO orders (user_id, order_number, status, subtotal, tax, shipping_cost, total, shipping_address_id, billing_address_id, payment_method, payment_status)
550
- VALUES (1, 'ORD-2024-00001', 'processing', 2159.97, 172.80, 15.00, 2347.77, 1, 2, 'credit_card', 'paid');
551
-
552
- -- Insert order items
553
- INSERT INTO order_items (order_id, product_id, quantity, unit_price, total_price) VALUES
554
- (1, 1, 1, 1999.99, 1999.99),
555
- (1, 2, 2, 79.99, 159.98);
556
- ```
557
-
558
- ### Insert Reviews
559
-
560
- ```sql
561
- INSERT INTO reviews (product_id, user_id, rating, title, comment, verified_purchase) VALUES
562
- (1, 2, 5, 'Amazing laptop!', 'Best gaming laptop I have ever owned. Runs all games smoothly.', true),
563
- (2, 1, 4, 'Great mouse', 'Very comfortable and responsive. Battery life could be better.', true);
564
- ```
565
-
566
- ---
567
-
568
- ## Schema Design Principles Demonstrated
569
-
570
- ### 1. Normalization
571
-
572
- **Third Normal Form (3NF):**
573
- - ✅ No repeating groups (separate tables for addresses, order items, etc.)
574
- - ✅ All non-key attributes depend on primary key
575
- - ✅ No transitive dependencies
576
-
577
- **Example:**
578
- - Order items store `unit_price` (price at time of order) instead of referencing current product price
579
- - This prevents historical data from changing when product prices change
580
-
581
- ### 2. Foreign Keys
582
-
583
- **Referential Integrity:**
584
- - ✅ All foreign keys defined with `REFERENCES`
585
- - ✅ Appropriate `ON DELETE` actions (CASCADE for dependent data)
586
- - ✅ Indexes on all foreign key columns for performance
587
-
588
- ### 3. Constraints
589
-
590
- **Data Integrity:**
591
- - ✅ `NOT NULL` for required fields
592
- - ✅ `UNIQUE` for unique values (email, SKU, order_number)
593
- - ✅ `CHECK` for valid values (price >= 0, rating between 1-5)
594
- - ✅ `DEFAULT` for sensible defaults
595
-
596
- ### 4. Indexes
597
-
598
- **Query Performance:**
599
- - ✅ Primary keys automatically indexed
600
- - ✅ Foreign keys indexed
601
- - ✅ Frequently queried columns indexed (email, status, created_at)
602
- - ✅ Composite indexes for common query patterns
603
- - ✅ Unique indexes for constraints
604
-
605
- ### 5. Denormalization (Strategic)
606
-
607
- **Performance Optimization:**
608
- - ✅ `order_items.unit_price` stores price at time of order (prevents joins)
609
- - ✅ `order_items.total_price` stores calculated value (avoids recalculation)
610
- - ✅ Consider adding `products.avg_rating` and `products.review_count` for performance
611
-
612
- ---
613
-
614
- ## Related Documentation
615
-
616
- - **relational-schema-design.md**: Schema design principles and normalization
617
- - **relational-indexing.md**: Indexing strategies
618
- - **relational-query-optimization.md**: Query optimization techniques
619
- - **relational-databases.md**: Relational database fundamentals
620
-
621
-
1
+ # Relational Schema Example: E-Commerce Database
2
+
3
+ ## Overview
4
+
5
+ This example demonstrates a comprehensive e-commerce database schema with proper normalization, foreign keys, indexes, and constraints.
6
+
7
+ **Features:**
8
+ - User management
9
+ - Product catalog
10
+ - Shopping cart
11
+ - Order processing
12
+ - Inventory tracking
13
+ - Reviews and ratings
14
+
15
+ ---
16
+
17
+ ## Entity-Relationship Diagram
18
+
19
+ ```
20
+ users (1) ──────< (N) orders
21
+ │ │
22
+ │ │
23
+ │ └──< (N) order_items >──┐
24
+ │ │
25
+ │ │
26
+ └──< (N) cart_items >──┐ │
27
+ │ │ │
28
+ │ ▼ ▼
29
+ │ products (1) ──────< (N) product_images
30
+ │ │
31
+ │ └──< (N) reviews
32
+
33
+ └──< (N) addresses
34
+ ```
35
+
36
+ ---
37
+
38
+ ## Schema Definition
39
+
40
+ ### Users Table
41
+
42
+ ```sql
43
+ CREATE TABLE users (
44
+ id SERIAL PRIMARY KEY,
45
+ email VARCHAR(255) NOT NULL UNIQUE,
46
+ password_hash VARCHAR(255) NOT NULL,
47
+ first_name VARCHAR(100) NOT NULL,
48
+ last_name VARCHAR(100) NOT NULL,
49
+ phone VARCHAR(20),
50
+ status VARCHAR(20) NOT NULL DEFAULT 'active' CHECK (status IN ('active', 'inactive', 'suspended')),
51
+ created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
52
+ updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
53
+ );
54
+
55
+ -- Indexes
56
+ CREATE INDEX idx_users_email ON users(email);
57
+ CREATE INDEX idx_users_status ON users(status);
58
+ CREATE INDEX idx_users_created_at ON users(created_at);
59
+
60
+ -- Comments
61
+ COMMENT ON TABLE users IS 'User accounts for the e-commerce platform';
62
+ COMMENT ON COLUMN users.status IS 'User account status: active, inactive, or suspended';
63
+ ```
64
+
65
+ ### Addresses Table
66
+
67
+ ```sql
68
+ CREATE TABLE addresses (
69
+ id SERIAL PRIMARY KEY,
70
+ user_id INT NOT NULL REFERENCES users(id) ON DELETE CASCADE,
71
+ address_type VARCHAR(20) NOT NULL CHECK (address_type IN ('billing', 'shipping')),
72
+ street_line1 VARCHAR(255) NOT NULL,
73
+ street_line2 VARCHAR(255),
74
+ city VARCHAR(100) NOT NULL,
75
+ state VARCHAR(100) NOT NULL,
76
+ postal_code VARCHAR(20) NOT NULL,
77
+ country VARCHAR(100) NOT NULL DEFAULT 'USA',
78
+ is_default BOOLEAN NOT NULL DEFAULT false,
79
+ created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
80
+ updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
81
+ );
82
+
83
+ -- Indexes
84
+ CREATE INDEX idx_addresses_user_id ON addresses(user_id);
85
+ CREATE INDEX idx_addresses_type ON addresses(address_type);
86
+
87
+ -- Unique constraint: Only one default address per type per user
88
+ CREATE UNIQUE INDEX idx_addresses_default ON addresses(user_id, address_type, is_default)
89
+ WHERE is_default = true;
90
+
91
+ -- Comments
92
+ COMMENT ON TABLE addresses IS 'User billing and shipping addresses';
93
+ ```
94
+
95
+ ### Products Table
96
+
97
+ ```sql
98
+ CREATE TABLE products (
99
+ id SERIAL PRIMARY KEY,
100
+ sku VARCHAR(50) NOT NULL UNIQUE,
101
+ name VARCHAR(255) NOT NULL,
102
+ description TEXT,
103
+ price DECIMAL(10, 2) NOT NULL CHECK (price >= 0),
104
+ cost DECIMAL(10, 2) CHECK (cost >= 0),
105
+ stock_quantity INT NOT NULL DEFAULT 0 CHECK (stock_quantity >= 0),
106
+ low_stock_threshold INT NOT NULL DEFAULT 10,
107
+ status VARCHAR(20) NOT NULL DEFAULT 'active' CHECK (status IN ('active', 'inactive', 'discontinued')),
108
+ category VARCHAR(100),
109
+ brand VARCHAR(100),
110
+ weight_kg DECIMAL(8, 2),
111
+ created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
112
+ updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
113
+ );
114
+
115
+ -- Indexes
116
+ CREATE INDEX idx_products_sku ON products(sku);
117
+ CREATE INDEX idx_products_status ON products(status);
118
+ CREATE INDEX idx_products_category ON products(category);
119
+ CREATE INDEX idx_products_brand ON products(brand);
120
+ CREATE INDEX idx_products_price ON products(price);
121
+
122
+ -- Full-text search index (PostgreSQL)
123
+ CREATE INDEX idx_products_search ON products USING GIN(to_tsvector('english', name || ' ' || COALESCE(description, '')));
124
+
125
+ -- Comments
126
+ COMMENT ON TABLE products IS 'Product catalog';
127
+ COMMENT ON COLUMN products.sku IS 'Stock Keeping Unit - unique product identifier';
128
+ COMMENT ON COLUMN products.low_stock_threshold IS 'Alert when stock falls below this level';
129
+ ```
130
+
131
+ ### Product Images Table
132
+
133
+ ```sql
134
+ CREATE TABLE product_images (
135
+ id SERIAL PRIMARY KEY,
136
+ product_id INT NOT NULL REFERENCES products(id) ON DELETE CASCADE,
137
+ url VARCHAR(500) NOT NULL,
138
+ alt_text VARCHAR(255),
139
+ display_order INT NOT NULL DEFAULT 0,
140
+ is_primary BOOLEAN NOT NULL DEFAULT false,
141
+ created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
142
+ );
143
+
144
+ -- Indexes
145
+ CREATE INDEX idx_product_images_product_id ON product_images(product_id);
146
+
147
+ -- Unique constraint: Only one primary image per product
148
+ CREATE UNIQUE INDEX idx_product_images_primary ON product_images(product_id, is_primary)
149
+ WHERE is_primary = true;
150
+
151
+ -- Comments
152
+ COMMENT ON TABLE product_images IS 'Product images and photos';
153
+ ```
154
+
155
+ ### Cart Items Table
156
+
157
+ ```sql
158
+ CREATE TABLE cart_items (
159
+ id SERIAL PRIMARY KEY,
160
+ user_id INT NOT NULL REFERENCES users(id) ON DELETE CASCADE,
161
+ product_id INT NOT NULL REFERENCES products(id) ON DELETE CASCADE,
162
+ quantity INT NOT NULL CHECK (quantity > 0),
163
+ added_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
164
+ updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
165
+
166
+ -- Unique constraint: One row per user-product combination
167
+ UNIQUE(user_id, product_id)
168
+ );
169
+
170
+ -- Indexes
171
+ CREATE INDEX idx_cart_items_user_id ON cart_items(user_id);
172
+ CREATE INDEX idx_cart_items_product_id ON cart_items(product_id);
173
+
174
+ -- Comments
175
+ COMMENT ON TABLE cart_items IS 'Shopping cart items for users';
176
+ ```
177
+
178
+ ### Orders Table
179
+
180
+ ```sql
181
+ CREATE TABLE orders (
182
+ id SERIAL PRIMARY KEY,
183
+ user_id INT NOT NULL REFERENCES users(id),
184
+ order_number VARCHAR(50) NOT NULL UNIQUE,
185
+ status VARCHAR(20) NOT NULL DEFAULT 'pending' CHECK (status IN ('pending', 'processing', 'shipped', 'delivered', 'cancelled')),
186
+ subtotal DECIMAL(10, 2) NOT NULL CHECK (subtotal >= 0),
187
+ tax DECIMAL(10, 2) NOT NULL DEFAULT 0 CHECK (tax >= 0),
188
+ shipping_cost DECIMAL(10, 2) NOT NULL DEFAULT 0 CHECK (shipping_cost >= 0),
189
+ total DECIMAL(10, 2) NOT NULL CHECK (total >= 0),
190
+ shipping_address_id INT REFERENCES addresses(id),
191
+ billing_address_id INT REFERENCES addresses(id),
192
+ payment_method VARCHAR(50),
193
+ payment_status VARCHAR(20) NOT NULL DEFAULT 'pending' CHECK (payment_status IN ('pending', 'paid', 'failed', 'refunded')),
194
+ notes TEXT,
195
+ created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
196
+ updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
197
+ shipped_at TIMESTAMP,
198
+ delivered_at TIMESTAMP
199
+ );
200
+
201
+ -- Indexes
202
+ CREATE INDEX idx_orders_user_id ON orders(user_id);
203
+ CREATE INDEX idx_orders_order_number ON orders(order_number);
204
+ CREATE INDEX idx_orders_status ON orders(status);
205
+ CREATE INDEX idx_orders_payment_status ON orders(payment_status);
206
+ CREATE INDEX idx_orders_created_at ON orders(created_at DESC);
207
+
208
+ -- Composite index for common queries
209
+ CREATE INDEX idx_orders_user_status ON orders(user_id, status);
210
+
211
+ -- Comments
212
+ COMMENT ON TABLE orders IS 'Customer orders';
213
+ COMMENT ON COLUMN orders.order_number IS 'Human-readable order number (e.g., ORD-2024-00001)';
214
+ ```
215
+
216
+ ### Order Items Table
217
+
218
+ ```sql
219
+ CREATE TABLE order_items (
220
+ id SERIAL PRIMARY KEY,
221
+ order_id INT NOT NULL REFERENCES orders(id) ON DELETE CASCADE,
222
+ product_id INT NOT NULL REFERENCES products(id),
223
+ quantity INT NOT NULL CHECK (quantity > 0),
224
+ unit_price DECIMAL(10, 2) NOT NULL CHECK (unit_price >= 0),
225
+ total_price DECIMAL(10, 2) NOT NULL CHECK (total_price >= 0),
226
+ created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP
227
+ );
228
+
229
+ -- Indexes
230
+ CREATE INDEX idx_order_items_order_id ON order_items(order_id);
231
+ CREATE INDEX idx_order_items_product_id ON order_items(product_id);
232
+
233
+ -- Comments
234
+ COMMENT ON TABLE order_items IS 'Line items for orders';
235
+ COMMENT ON COLUMN order_items.unit_price IS 'Price at time of order (may differ from current product price)';
236
+ ```
237
+
238
+ ### Reviews Table
239
+
240
+ ```sql
241
+ CREATE TABLE reviews (
242
+ id SERIAL PRIMARY KEY,
243
+ product_id INT NOT NULL REFERENCES products(id) ON DELETE CASCADE,
244
+ user_id INT NOT NULL REFERENCES users(id) ON DELETE CASCADE,
245
+ rating INT NOT NULL CHECK (rating >= 1 AND rating <= 5),
246
+ title VARCHAR(255),
247
+ comment TEXT,
248
+ verified_purchase BOOLEAN NOT NULL DEFAULT false,
249
+ helpful_count INT NOT NULL DEFAULT 0,
250
+ created_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
251
+ updated_at TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
252
+
253
+ -- Unique constraint: One review per user per product
254
+ UNIQUE(product_id, user_id)
255
+ );
256
+
257
+ -- Indexes
258
+ CREATE INDEX idx_reviews_product_id ON reviews(product_id);
259
+ CREATE INDEX idx_reviews_user_id ON reviews(user_id);
260
+ CREATE INDEX idx_reviews_rating ON reviews(rating);
261
+ CREATE INDEX idx_reviews_created_at ON reviews(created_at DESC);
262
+
263
+ -- Comments
264
+ COMMENT ON TABLE reviews IS 'Product reviews and ratings';
265
+ COMMENT ON COLUMN reviews.verified_purchase IS 'True if user purchased this product';
266
+ ```
267
+
268
+ ---
269
+
270
+ ## Sample Queries
271
+
272
+ ### Query 1: Get User with Addresses
273
+
274
+ ```sql
275
+ SELECT
276
+ u.id,
277
+ u.email,
278
+ u.first_name,
279
+ u.last_name,
280
+ json_agg(
281
+ json_build_object(
282
+ 'id', a.id,
283
+ 'type', a.address_type,
284
+ 'street', a.street_line1,
285
+ 'city', a.city,
286
+ 'state', a.state,
287
+ 'postal_code', a.postal_code,
288
+ 'is_default', a.is_default
289
+ )
290
+ ) AS addresses
291
+ FROM users u
292
+ LEFT JOIN addresses a ON a.user_id = u.id
293
+ WHERE u.id = 1
294
+ GROUP BY u.id;
295
+ ```
296
+
297
+ **Explanation:**
298
+ - Uses `LEFT JOIN` to include users even if they have no addresses
299
+ - Uses `json_agg` to aggregate addresses into JSON array
300
+ - Groups by user ID to get one row per user
301
+
302
+ ### Query 2: Get Product with Images and Average Rating
303
+
304
+ ```sql
305
+ SELECT
306
+ p.id,
307
+ p.sku,
308
+ p.name,
309
+ p.description,
310
+ p.price,
311
+ p.stock_quantity,
312
+ COALESCE(AVG(r.rating), 0) AS avg_rating,
313
+ COUNT(r.id) AS review_count,
314
+ json_agg(
315
+ json_build_object(
316
+ 'url', pi.url,
317
+ 'alt_text', pi.alt_text,
318
+ 'is_primary', pi.is_primary
319
+ ) ORDER BY pi.display_order
320
+ ) FILTER (WHERE pi.id IS NOT NULL) AS images
321
+ FROM products p
322
+ LEFT JOIN product_images pi ON pi.product_id = p.id
323
+ LEFT JOIN reviews r ON r.product_id = p.id
324
+ WHERE p.id = 1
325
+ GROUP BY p.id;
326
+ ```
327
+
328
+ **Explanation:**
329
+ - Joins product with images and reviews
330
+ - Calculates average rating and review count
331
+ - Aggregates images into JSON array ordered by display_order
332
+ - Uses `FILTER` to exclude NULL images
333
+
334
+ ### Query 3: Get User's Shopping Cart with Product Details
335
+
336
+ ```sql
337
+ SELECT
338
+ ci.id AS cart_item_id,
339
+ ci.quantity,
340
+ p.id AS product_id,
341
+ p.sku,
342
+ p.name,
343
+ p.price,
344
+ p.stock_quantity,
345
+ (ci.quantity * p.price) AS line_total,
346
+ CASE
347
+ WHEN p.stock_quantity >= ci.quantity THEN true
348
+ ELSE false
349
+ END AS in_stock
350
+ FROM cart_items ci
351
+ JOIN products p ON p.id = ci.product_id
352
+ WHERE ci.user_id = 1
353
+ ORDER BY ci.added_at DESC;
354
+ ```
355
+
356
+ **Explanation:**
357
+ - Joins cart items with products
358
+ - Calculates line total (quantity × price)
359
+ - Checks if product is in stock
360
+ - Orders by most recently added
361
+
362
+ ### Query 4: Get Order with Items and Product Details
363
+
364
+ ```sql
365
+ SELECT
366
+ o.id AS order_id,
367
+ o.order_number,
368
+ o.status,
369
+ o.total,
370
+ o.created_at,
371
+ json_agg(
372
+ json_build_object(
373
+ 'product_id', p.id,
374
+ 'product_name', p.name,
375
+ 'sku', p.sku,
376
+ 'quantity', oi.quantity,
377
+ 'unit_price', oi.unit_price,
378
+ 'total_price', oi.total_price
379
+ )
380
+ ) AS items
381
+ FROM orders o
382
+ JOIN order_items oi ON oi.order_id = o.id
383
+ JOIN products p ON p.id = oi.product_id
384
+ WHERE o.id = 1
385
+ GROUP BY o.id;
386
+ ```
387
+
388
+ **Explanation:**
389
+ - Joins order with order items and products
390
+ - Aggregates items into JSON array
391
+ - Groups by order ID to get one row per order
392
+
393
+ ### Query 5: Get Products with Low Stock
394
+
395
+ ```sql
396
+ SELECT
397
+ id,
398
+ sku,
399
+ name,
400
+ stock_quantity,
401
+ low_stock_threshold,
402
+ (low_stock_threshold - stock_quantity) AS units_below_threshold
403
+ FROM products
404
+ WHERE stock_quantity < low_stock_threshold
405
+ AND status = 'active'
406
+ ORDER BY stock_quantity ASC;
407
+ ```
408
+
409
+ **Explanation:**
410
+ - Filters products below low stock threshold
411
+ - Only includes active products
412
+ - Calculates how many units below threshold
413
+ - Orders by lowest stock first
414
+
415
+ ### Query 6: Get Top-Rated Products
416
+
417
+ ```sql
418
+ SELECT
419
+ p.id,
420
+ p.sku,
421
+ p.name,
422
+ p.price,
423
+ AVG(r.rating) AS avg_rating,
424
+ COUNT(r.id) AS review_count
425
+ FROM products p
426
+ JOIN reviews r ON r.product_id = p.id
427
+ WHERE p.status = 'active'
428
+ GROUP BY p.id
429
+ HAVING COUNT(r.id) >= 5 -- At least 5 reviews
430
+ ORDER BY avg_rating DESC, review_count DESC
431
+ LIMIT 10;
432
+ ```
433
+
434
+ **Explanation:**
435
+ - Joins products with reviews
436
+ - Calculates average rating and review count
437
+ - Filters to products with at least 5 reviews
438
+ - Orders by highest rating first
439
+ - Limits to top 10 products
440
+
441
+ ### Query 7: Get User's Order History
442
+
443
+ ```sql
444
+ SELECT
445
+ o.id,
446
+ o.order_number,
447
+ o.status,
448
+ o.total,
449
+ o.created_at,
450
+ COUNT(oi.id) AS item_count
451
+ FROM orders o
452
+ LEFT JOIN order_items oi ON oi.order_id = o.id
453
+ WHERE o.user_id = 1
454
+ GROUP BY o.id
455
+ ORDER BY o.created_at DESC;
456
+ ```
457
+
458
+ **Explanation:**
459
+ - Gets all orders for a user
460
+ - Counts number of items in each order
461
+ - Orders by most recent first
462
+
463
+ ### Query 8: Search Products by Name or Description
464
+
465
+ ```sql
466
+ -- Full-text search (PostgreSQL)
467
+ SELECT
468
+ id,
469
+ sku,
470
+ name,
471
+ price,
472
+ ts_rank(to_tsvector('english', name || ' ' || COALESCE(description, '')), query) AS rank
473
+ FROM products,
474
+ to_tsquery('english', 'laptop & gaming') AS query
475
+ WHERE to_tsvector('english', name || ' ' || COALESCE(description, '')) @@ query
476
+ AND status = 'active'
477
+ ORDER BY rank DESC;
478
+
479
+ -- Simple LIKE search (works on all databases)
480
+ SELECT
481
+ id,
482
+ sku,
483
+ name,
484
+ price
485
+ FROM products
486
+ WHERE (name ILIKE '%laptop%' OR description ILIKE '%laptop%')
487
+ AND status = 'active'
488
+ ORDER BY name;
489
+ ```
490
+
491
+ **Explanation:**
492
+ - PostgreSQL version uses full-text search with ranking
493
+ - LIKE version works on all databases but slower
494
+ - Both filter to active products only
495
+
496
+ ---
497
+
498
+ ## Sample Data Insertion
499
+
500
+ ### Insert Users
501
+
502
+ ```sql
503
+ INSERT INTO users (email, password_hash, first_name, last_name, phone) VALUES
504
+ ('john.doe@example.com', '$2b$10$...', 'John', 'Doe', '555-0101'),
505
+ ('jane.smith@example.com', '$2b$10$...', 'Jane', 'Smith', '555-0102'),
506
+ ('bob.johnson@example.com', '$2b$10$...', 'Bob', 'Johnson', '555-0103');
507
+ ```
508
+
509
+ ### Insert Addresses
510
+
511
+ ```sql
512
+ INSERT INTO addresses (user_id, address_type, street_line1, city, state, postal_code, is_default) VALUES
513
+ (1, 'shipping', '123 Main St', 'New York', 'NY', '10001', true),
514
+ (1, 'billing', '123 Main St', 'New York', 'NY', '10001', true),
515
+ (2, 'shipping', '456 Oak Ave', 'Los Angeles', 'CA', '90001', true);
516
+ ```
517
+
518
+ ### Insert Products
519
+
520
+ ```sql
521
+ INSERT INTO products (sku, name, description, price, cost, stock_quantity, category, brand) VALUES
522
+ ('LAP-001', 'Gaming Laptop Pro', 'High-performance gaming laptop with RTX 4080', 1999.99, 1500.00, 25, 'Laptops', 'TechBrand'),
523
+ ('MOU-001', 'Wireless Gaming Mouse', 'Ergonomic wireless mouse with RGB lighting', 79.99, 40.00, 150, 'Accessories', 'PeripheralCo'),
524
+ ('KEY-001', 'Mechanical Keyboard', 'RGB mechanical keyboard with Cherry MX switches', 149.99, 80.00, 75, 'Accessories', 'PeripheralCo');
525
+ ```
526
+
527
+ ### Insert Product Images
528
+
529
+ ```sql
530
+ INSERT INTO product_images (product_id, url, alt_text, display_order, is_primary) VALUES
531
+ (1, 'https://example.com/images/laptop-1.jpg', 'Gaming Laptop Pro - Front View', 0, true),
532
+ (1, 'https://example.com/images/laptop-2.jpg', 'Gaming Laptop Pro - Side View', 1, false),
533
+ (2, 'https://example.com/images/mouse-1.jpg', 'Wireless Gaming Mouse', 0, true);
534
+ ```
535
+
536
+ ### Insert Cart Items
537
+
538
+ ```sql
539
+ INSERT INTO cart_items (user_id, product_id, quantity) VALUES
540
+ (1, 1, 1),
541
+ (1, 2, 2),
542
+ (2, 3, 1);
543
+ ```
544
+
545
+ ### Insert Orders and Order Items
546
+
547
+ ```sql
548
+ -- Insert order
549
+ INSERT INTO orders (user_id, order_number, status, subtotal, tax, shipping_cost, total, shipping_address_id, billing_address_id, payment_method, payment_status)
550
+ VALUES (1, 'ORD-2024-00001', 'processing', 2159.97, 172.80, 15.00, 2347.77, 1, 2, 'credit_card', 'paid');
551
+
552
+ -- Insert order items
553
+ INSERT INTO order_items (order_id, product_id, quantity, unit_price, total_price) VALUES
554
+ (1, 1, 1, 1999.99, 1999.99),
555
+ (1, 2, 2, 79.99, 159.98);
556
+ ```
557
+
558
+ ### Insert Reviews
559
+
560
+ ```sql
561
+ INSERT INTO reviews (product_id, user_id, rating, title, comment, verified_purchase) VALUES
562
+ (1, 2, 5, 'Amazing laptop!', 'Best gaming laptop I have ever owned. Runs all games smoothly.', true),
563
+ (2, 1, 4, 'Great mouse', 'Very comfortable and responsive. Battery life could be better.', true);
564
+ ```
565
+
566
+ ---
567
+
568
+ ## Schema Design Principles Demonstrated
569
+
570
+ ### 1. Normalization
571
+
572
+ **Third Normal Form (3NF):**
573
+ - ✅ No repeating groups (separate tables for addresses, order items, etc.)
574
+ - ✅ All non-key attributes depend on primary key
575
+ - ✅ No transitive dependencies
576
+
577
+ **Example:**
578
+ - Order items store `unit_price` (price at time of order) instead of referencing current product price
579
+ - This prevents historical data from changing when product prices change
580
+
581
+ ### 2. Foreign Keys
582
+
583
+ **Referential Integrity:**
584
+ - ✅ All foreign keys defined with `REFERENCES`
585
+ - ✅ Appropriate `ON DELETE` actions (CASCADE for dependent data)
586
+ - ✅ Indexes on all foreign key columns for performance
587
+
588
+ ### 3. Constraints
589
+
590
+ **Data Integrity:**
591
+ - ✅ `NOT NULL` for required fields
592
+ - ✅ `UNIQUE` for unique values (email, SKU, order_number)
593
+ - ✅ `CHECK` for valid values (price >= 0, rating between 1-5)
594
+ - ✅ `DEFAULT` for sensible defaults
595
+
596
+ ### 4. Indexes
597
+
598
+ **Query Performance:**
599
+ - ✅ Primary keys automatically indexed
600
+ - ✅ Foreign keys indexed
601
+ - ✅ Frequently queried columns indexed (email, status, created_at)
602
+ - ✅ Composite indexes for common query patterns
603
+ - ✅ Unique indexes for constraints
604
+
605
+ ### 5. Denormalization (Strategic)
606
+
607
+ **Performance Optimization:**
608
+ - ✅ `order_items.unit_price` stores price at time of order (prevents joins)
609
+ - ✅ `order_items.total_price` stores calculated value (avoids recalculation)
610
+ - ✅ Consider adding `products.avg_rating` and `products.review_count` for performance
611
+
612
+ ---
613
+
614
+ ## Related Documentation
615
+
616
+ - **relational-schema-design.md**: Schema design principles and normalization
617
+ - **relational-indexing.md**: Indexing strategies
618
+ - **relational-query-optimization.md**: Query optimization techniques
619
+ - **relational-databases.md**: Relational database fundamentals
620
+
621
+