@mytechtoday/augment-extensions 0.7.0 → 1.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (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,734 +1,734 @@
1
- # REST API Endpoint Example
2
-
3
- ## Overview
4
-
5
- This example demonstrates a complete custom REST API endpoint with route registration, permission callback, endpoint handler, sanitization, validation, JSON response, and error handling.
6
-
7
- **Use Case**: Custom API endpoints for external integrations
8
- **Complexity**: Medium
9
- **Prerequisites**: WordPress 5.0+, PHP 7.4+
10
-
11
- ---
12
-
13
- ## Complete Example: "Book Reviews API"
14
-
15
- A custom REST API for managing book reviews with full CRUD operations, authentication, and validation.
16
-
17
- ---
18
-
19
- ## Directory Structure
20
-
21
- ```
22
- book-reviews-api/
23
- ├── book-reviews-api.php # Main plugin file
24
- ├── includes/
25
- │ ├── class-api.php # API controller
26
- │ ├── class-validator.php # Validation logic
27
- │ └── class-sanitizer.php # Sanitization logic
28
- └── readme.txt # Plugin readme
29
- ```
30
-
31
- ---
32
-
33
- ## 1. Main Plugin File
34
-
35
- ### File: `book-reviews-api.php`
36
-
37
- ```php
38
- <?php
39
- /**
40
- * Plugin Name: Book Reviews API
41
- * Description: Custom REST API for managing book reviews
42
- * Version: 1.0.0
43
- * Requires at least: 5.0
44
- * Requires PHP: 7.4
45
- * Author: Your Name
46
- * License: GPL-2.0+
47
- * Text Domain: book-reviews-api
48
- */
49
-
50
- if (!defined('ABSPATH')) {
51
- exit;
52
- }
53
-
54
- // Include dependencies
55
- require_once plugin_dir_path(__FILE__) . 'includes/class-api.php';
56
- require_once plugin_dir_path(__FILE__) . 'includes/class-validator.php';
57
- require_once plugin_dir_path(__FILE__) . 'includes/class-sanitizer.php';
58
-
59
- /**
60
- * Initialize the API
61
- */
62
- function bra_init() {
63
- $api = new Book_Reviews_API();
64
- $api->register_routes();
65
- }
66
- add_action('rest_api_init', 'bra_init');
67
- ```
68
-
69
- ---
70
-
71
- ## 2. API Controller
72
-
73
- ### File: `includes/class-api.php`
74
-
75
- ```php
76
- <?php
77
- /**
78
- * Book Reviews API Controller
79
- */
80
- class Book_Reviews_API {
81
-
82
- /**
83
- * Namespace for API routes
84
- */
85
- private $namespace = 'book-reviews/v1';
86
-
87
- /**
88
- * Base route
89
- */
90
- private $base = 'reviews';
91
-
92
- /**
93
- * Register all routes
94
- */
95
- public function register_routes() {
96
- // GET - List all reviews
97
- register_rest_route($this->namespace, '/' . $this->base, array(
98
- 'methods' => WP_REST_Server::READABLE,
99
- 'callback' => array($this, 'get_items'),
100
- 'permission_callback' => '__return_true',
101
- 'args' => $this->get_collection_params(),
102
- ));
103
-
104
- // POST - Create review
105
- register_rest_route($this->namespace, '/' . $this->base, array(
106
- 'methods' => WP_REST_Server::CREATABLE,
107
- 'callback' => array($this, 'create_item'),
108
- 'permission_callback' => array($this, 'create_item_permissions_check'),
109
- 'args' => $this->get_endpoint_args_for_item_schema(),
110
- ));
111
-
112
- // GET - Get single review
113
- register_rest_route($this->namespace, '/' . $this->base . '/(?P<id>[\d]+)', array(
114
- 'methods' => WP_REST_Server::READABLE,
115
- 'callback' => array($this, 'get_item'),
116
- 'permission_callback' => '__return_true',
117
- 'args' => array(
118
- 'id' => array(
119
- 'validate_callback' => function($param) {
120
- return is_numeric($param);
121
- },
122
- ),
123
- ),
124
- ));
125
-
126
- // PUT/PATCH - Update review
127
- register_rest_route($this->namespace, '/' . $this->base . '/(?P<id>[\d]+)', array(
128
- 'methods' => WP_REST_Server::EDITABLE,
129
- 'callback' => array($this, 'update_item'),
130
- 'permission_callback' => array($this, 'update_item_permissions_check'),
131
- 'args' => $this->get_endpoint_args_for_item_schema(),
132
- ));
133
-
134
- // DELETE - Delete review
135
- register_rest_route($this->namespace, '/' . $this->base . '/(?P<id>[\d]+)', array(
136
- 'methods' => WP_REST_Server::DELETABLE,
137
- 'callback' => array($this, 'delete_item'),
138
- 'permission_callback' => array($this, 'delete_item_permissions_check'),
139
- ));
140
- }
141
-
142
- /**
143
- * Get collection of reviews
144
- */
145
- public function get_items($request) {
146
- $args = array(
147
- 'post_type' => 'book_review',
148
- 'posts_per_page' => $request->get_param('per_page') ?: 10,
149
- 'paged' => $request->get_param('page') ?: 1,
150
- 'orderby' => $request->get_param('orderby') ?: 'date',
151
- 'order' => $request->get_param('order') ?: 'DESC',
152
- );
153
-
154
- $query = new WP_Query($args);
155
- $reviews = array();
156
-
157
- foreach ($query->posts as $post) {
158
- $reviews[] = $this->prepare_item_for_response($post);
159
- }
160
-
161
- $response = rest_ensure_response($reviews);
162
-
163
- // Add pagination headers
164
- $response->header('X-WP-Total', $query->found_posts);
165
- $response->header('X-WP-TotalPages', $query->max_num_pages);
166
-
167
- return $response;
168
- }
169
-
170
- /**
171
- * Get single review
172
- */
173
- public function get_item($request) {
174
- $id = (int) $request->get_param('id');
175
- $post = get_post($id);
176
-
177
- if (!$post || $post->post_type !== 'book_review') {
178
- return new WP_Error(
179
- 'rest_review_not_found',
180
- __('Review not found.', 'book-reviews-api'),
181
- array('status' => 404)
182
- );
183
- }
184
-
185
- $data = $this->prepare_item_for_response($post);
186
- return rest_ensure_response($data);
187
- }
188
-
189
- /**
190
- * Create new review
191
- */
192
- public function create_item($request) {
193
- $validator = new Book_Reviews_Validator();
194
- $sanitizer = new Book_Reviews_Sanitizer();
195
-
196
- // Validate input
197
- $validation = $validator->validate_review_data($request->get_params());
198
- if (is_wp_error($validation)) {
199
- return $validation;
200
- }
201
-
202
- // Sanitize input
203
- $data = $sanitizer->sanitize_review_data($request->get_params());
204
-
205
- // Create post
206
- $post_id = wp_insert_post(array(
207
- 'post_type' => 'book_review',
208
- 'post_title' => $data['title'],
209
- 'post_content' => $data['content'],
210
- 'post_status' => 'publish',
211
- 'post_author' => get_current_user_id(),
212
- ));
213
-
214
- if (is_wp_error($post_id)) {
215
- return new WP_Error(
216
- 'rest_review_create_failed',
217
- __('Failed to create review.', 'book-reviews-api'),
218
- array('status' => 500)
219
- );
220
- }
221
-
222
- // Save meta data
223
- update_post_meta($post_id, '_book_title', $data['book_title']);
224
- update_post_meta($post_id, '_book_author', $data['book_author']);
225
- update_post_meta($post_id, '_rating', $data['rating']);
226
-
227
- $post = get_post($post_id);
228
- $response = $this->prepare_item_for_response($post);
229
-
230
- return rest_ensure_response($response);
231
- }
232
-
233
- /**
234
- * Update review
235
- */
236
- public function update_item($request) {
237
- $id = (int) $request->get_param('id');
238
- $post = get_post($id);
239
-
240
- if (!$post || $post->post_type !== 'book_review') {
241
- return new WP_Error(
242
- 'rest_review_not_found',
243
- __('Review not found.', 'book-reviews-api'),
244
- array('status' => 404)
245
- );
246
- }
247
-
248
- $validator = new Book_Reviews_Validator();
249
- $sanitizer = new Book_Reviews_Sanitizer();
250
-
251
- // Validate input
252
- $validation = $validator->validate_review_data($request->get_params());
253
- if (is_wp_error($validation)) {
254
- return $validation;
255
- }
256
-
257
- // Sanitize input
258
- $data = $sanitizer->sanitize_review_data($request->get_params());
259
-
260
- // Update post
261
- $updated = wp_update_post(array(
262
- 'ID' => $id,
263
- 'post_title' => $data['title'],
264
- 'post_content' => $data['content'],
265
- ));
266
-
267
- if (is_wp_error($updated)) {
268
- return new WP_Error(
269
- 'rest_review_update_failed',
270
- __('Failed to update review.', 'book-reviews-api'),
271
- array('status' => 500)
272
- );
273
- }
274
-
275
- // Update meta data
276
- update_post_meta($id, '_book_title', $data['book_title']);
277
- update_post_meta($id, '_book_author', $data['book_author']);
278
- update_post_meta($id, '_rating', $data['rating']);
279
-
280
- $post = get_post($id);
281
- $response = $this->prepare_item_for_response($post);
282
-
283
- return rest_ensure_response($response);
284
- }
285
-
286
- /**
287
- * Delete review
288
- */
289
- public function delete_item($request) {
290
- $id = (int) $request->get_param('id');
291
- $post = get_post($id);
292
-
293
- if (!$post || $post->post_type !== 'book_review') {
294
- return new WP_Error(
295
- 'rest_review_not_found',
296
- __('Review not found.', 'book-reviews-api'),
297
- array('status' => 404)
298
- );
299
- }
300
-
301
- $previous = $this->prepare_item_for_response($post);
302
- $result = wp_delete_post($id, true);
303
-
304
- if (!$result) {
305
- return new WP_Error(
306
- 'rest_review_delete_failed',
307
- __('Failed to delete review.', 'book-reviews-api'),
308
- array('status' => 500)
309
- );
310
- }
311
-
312
- return rest_ensure_response(array(
313
- 'deleted' => true,
314
- 'previous' => $previous,
315
- ));
316
- }
317
-
318
- /**
319
- * Permission check for creating reviews
320
- */
321
- public function create_item_permissions_check($request) {
322
- if (!is_user_logged_in()) {
323
- return new WP_Error(
324
- 'rest_forbidden',
325
- __('You must be logged in to create reviews.', 'book-reviews-api'),
326
- array('status' => 401)
327
- );
328
- }
329
-
330
- if (!current_user_can('publish_posts')) {
331
- return new WP_Error(
332
- 'rest_forbidden',
333
- __('You do not have permission to create reviews.', 'book-reviews-api'),
334
- array('status' => 403)
335
- );
336
- }
337
-
338
- return true;
339
- }
340
-
341
- /**
342
- * Permission check for updating reviews
343
- */
344
- public function update_item_permissions_check($request) {
345
- $id = (int) $request->get_param('id');
346
- $post = get_post($id);
347
-
348
- if (!$post) {
349
- return new WP_Error(
350
- 'rest_review_not_found',
351
- __('Review not found.', 'book-reviews-api'),
352
- array('status' => 404)
353
- );
354
- }
355
-
356
- if (!current_user_can('edit_post', $id)) {
357
- return new WP_Error(
358
- 'rest_forbidden',
359
- __('You do not have permission to edit this review.', 'book-reviews-api'),
360
- array('status' => 403)
361
- );
362
- }
363
-
364
- return true;
365
- }
366
-
367
- /**
368
- * Permission check for deleting reviews
369
- */
370
- public function delete_item_permissions_check($request) {
371
- $id = (int) $request->get_param('id');
372
- $post = get_post($id);
373
-
374
- if (!$post) {
375
- return new WP_Error(
376
- 'rest_review_not_found',
377
- __('Review not found.', 'book-reviews-api'),
378
- array('status' => 404)
379
- );
380
- }
381
-
382
- if (!current_user_can('delete_post', $id)) {
383
- return new WP_Error(
384
- 'rest_forbidden',
385
- __('You do not have permission to delete this review.', 'book-reviews-api'),
386
- array('status' => 403)
387
- );
388
- }
389
-
390
- return true;
391
- }
392
-
393
- /**
394
- * Prepare item for response
395
- */
396
- private function prepare_item_for_response($post) {
397
- return array(
398
- 'id' => $post->ID,
399
- 'title' => $post->post_title,
400
- 'content' => $post->post_content,
401
- 'book_title' => get_post_meta($post->ID, '_book_title', true),
402
- 'book_author' => get_post_meta($post->ID, '_book_author', true),
403
- 'rating' => (int) get_post_meta($post->ID, '_rating', true),
404
- 'date' => $post->post_date,
405
- 'author' => $post->post_author,
406
- );
407
- }
408
-
409
- /**
410
- * Get collection parameters
411
- */
412
- private function get_collection_params() {
413
- return array(
414
- 'page' => array(
415
- 'description' => __('Current page of the collection.', 'book-reviews-api'),
416
- 'type' => 'integer',
417
- 'default' => 1,
418
- 'sanitize_callback' => 'absint',
419
- ),
420
- 'per_page' => array(
421
- 'description' => __('Maximum number of items per page.', 'book-reviews-api'),
422
- 'type' => 'integer',
423
- 'default' => 10,
424
- 'sanitize_callback' => 'absint',
425
- ),
426
- 'orderby' => array(
427
- 'description' => __('Sort collection by field.', 'book-reviews-api'),
428
- 'type' => 'string',
429
- 'default' => 'date',
430
- 'enum' => array('date', 'title', 'rating'),
431
- ),
432
- 'order' => array(
433
- 'description' => __('Order sort attribute ascending or descending.', 'book-reviews-api'),
434
- 'type' => 'string',
435
- 'default' => 'DESC',
436
- 'enum' => array('ASC', 'DESC'),
437
- ),
438
- );
439
- }
440
-
441
- /**
442
- * Get endpoint args for item schema
443
- */
444
- private function get_endpoint_args_for_item_schema() {
445
- return array(
446
- 'title' => array(
447
- 'description' => __('Review title.', 'book-reviews-api'),
448
- 'type' => 'string',
449
- 'required' => true,
450
- 'sanitize_callback' => 'sanitize_text_field',
451
- ),
452
- 'content' => array(
453
- 'description' => __('Review content.', 'book-reviews-api'),
454
- 'type' => 'string',
455
- 'required' => true,
456
- 'sanitize_callback' => 'wp_kses_post',
457
- ),
458
- 'book_title' => array(
459
- 'description' => __('Book title.', 'book-reviews-api'),
460
- 'type' => 'string',
461
- 'required' => true,
462
- 'sanitize_callback' => 'sanitize_text_field',
463
- ),
464
- 'book_author' => array(
465
- 'description' => __('Book author.', 'book-reviews-api'),
466
- 'type' => 'string',
467
- 'required' => true,
468
- 'sanitize_callback' => 'sanitize_text_field',
469
- ),
470
- 'rating' => array(
471
- 'description' => __('Rating (1-5).', 'book-reviews-api'),
472
- 'type' => 'integer',
473
- 'required' => true,
474
- 'minimum' => 1,
475
- 'maximum' => 5,
476
- 'sanitize_callback' => 'absint',
477
- ),
478
- );
479
- }
480
- }
481
- ```
482
-
483
- ---
484
-
485
- ## 3. Validator Class
486
-
487
- ### File: `includes/class-validator.php`
488
-
489
- ```php
490
- <?php
491
- /**
492
- * Book Reviews Validator
493
- */
494
- class Book_Reviews_Validator {
495
-
496
- /**
497
- * Validate review data
498
- */
499
- public function validate_review_data($data) {
500
- $errors = new WP_Error();
501
-
502
- // Validate title
503
- if (empty($data['title'])) {
504
- $errors->add(
505
- 'missing_title',
506
- __('Review title is required.', 'book-reviews-api'),
507
- array('status' => 400)
508
- );
509
- }
510
-
511
- // Validate content
512
- if (empty($data['content'])) {
513
- $errors->add(
514
- 'missing_content',
515
- __('Review content is required.', 'book-reviews-api'),
516
- array('status' => 400)
517
- );
518
- }
519
-
520
- // Validate book title
521
- if (empty($data['book_title'])) {
522
- $errors->add(
523
- 'missing_book_title',
524
- __('Book title is required.', 'book-reviews-api'),
525
- array('status' => 400)
526
- );
527
- }
528
-
529
- // Validate book author
530
- if (empty($data['book_author'])) {
531
- $errors->add(
532
- 'missing_book_author',
533
- __('Book author is required.', 'book-reviews-api'),
534
- array('status' => 400)
535
- );
536
- }
537
-
538
- // Validate rating
539
- if (!isset($data['rating'])) {
540
- $errors->add(
541
- 'missing_rating',
542
- __('Rating is required.', 'book-reviews-api'),
543
- array('status' => 400)
544
- );
545
- } elseif ($data['rating'] < 1 || $data['rating'] > 5) {
546
- $errors->add(
547
- 'invalid_rating',
548
- __('Rating must be between 1 and 5.', 'book-reviews-api'),
549
- array('status' => 400)
550
- );
551
- }
552
-
553
- if ($errors->has_errors()) {
554
- return $errors;
555
- }
556
-
557
- return true;
558
- }
559
- }
560
- ```
561
-
562
- ---
563
-
564
- ## 4. Sanitizer Class
565
-
566
- ### File: `includes/class-sanitizer.php`
567
-
568
- ```php
569
- <?php
570
- /**
571
- * Book Reviews Sanitizer
572
- */
573
- class Book_Reviews_Sanitizer {
574
-
575
- /**
576
- * Sanitize review data
577
- */
578
- public function sanitize_review_data($data) {
579
- return array(
580
- 'title' => sanitize_text_field($data['title']),
581
- 'content' => wp_kses_post($data['content']),
582
- 'book_title' => sanitize_text_field($data['book_title']),
583
- 'book_author' => sanitize_text_field($data['book_author']),
584
- 'rating' => absint($data['rating']),
585
- );
586
- }
587
- }
588
- ```
589
-
590
- ---
591
-
592
- ## 5. Testing Steps
593
-
594
- ### Manual Testing with cURL
595
-
596
- **1. List all reviews (GET)**
597
-
598
- ```bash
599
- curl -X GET "https://example.com/wp-json/book-reviews/v1/reviews"
600
- ```
601
-
602
- **2. Get single review (GET)**
603
-
604
- ```bash
605
- curl -X GET "https://example.com/wp-json/book-reviews/v1/reviews/123"
606
- ```
607
-
608
- **3. Create review (POST)**
609
-
610
- ```bash
611
- curl -X POST "https://example.com/wp-json/book-reviews/v1/reviews" \
612
- -H "Content-Type: application/json" \
613
- -H "Authorization: Bearer YOUR_TOKEN" \
614
- -d '{
615
- "title": "Great Book!",
616
- "content": "This book was amazing...",
617
- "book_title": "The Great Gatsby",
618
- "book_author": "F. Scott Fitzgerald",
619
- "rating": 5
620
- }'
621
- ```
622
-
623
- **4. Update review (PUT)**
624
-
625
- ```bash
626
- curl -X PUT "https://example.com/wp-json/book-reviews/v1/reviews/123" \
627
- -H "Content-Type: application/json" \
628
- -H "Authorization: Bearer YOUR_TOKEN" \
629
- -d '{
630
- "title": "Updated Title",
631
- "content": "Updated content...",
632
- "book_title": "The Great Gatsby",
633
- "book_author": "F. Scott Fitzgerald",
634
- "rating": 4
635
- }'
636
- ```
637
-
638
- **5. Delete review (DELETE)**
639
-
640
- ```bash
641
- curl -X DELETE "https://example.com/wp-json/book-reviews/v1/reviews/123" \
642
- -H "Authorization: Bearer YOUR_TOKEN"
643
- ```
644
-
645
- ### Testing with JavaScript
646
-
647
- ```javascript
648
- // Fetch all reviews
649
- fetch('https://example.com/wp-json/book-reviews/v1/reviews')
650
- .then(response => response.json())
651
- .then(data => console.log(data));
652
-
653
- // Create review
654
- fetch('https://example.com/wp-json/book-reviews/v1/reviews', {
655
- method: 'POST',
656
- headers: {
657
- 'Content-Type': 'application/json',
658
- 'X-WP-Nonce': wpApiSettings.nonce
659
- },
660
- body: JSON.stringify({
661
- title: 'Great Book!',
662
- content: 'This book was amazing...',
663
- book_title: 'The Great Gatsby',
664
- book_author: 'F. Scott Fitzgerald',
665
- rating: 5
666
- })
667
- })
668
- .then(response => response.json())
669
- .then(data => console.log(data));
670
- ```
671
-
672
- ### Automated Testing with PHPUnit
673
-
674
- ```php
675
- <?php
676
- class Test_Book_Reviews_API extends WP_UnitTestCase {
677
-
678
- public function test_get_reviews() {
679
- $request = new WP_REST_Request('GET', '/book-reviews/v1/reviews');
680
- $response = rest_do_request($request);
681
-
682
- $this->assertEquals(200, $response->get_status());
683
- $this->assertIsArray($response->get_data());
684
- }
685
-
686
- public function test_create_review_requires_authentication() {
687
- $request = new WP_REST_Request('POST', '/book-reviews/v1/reviews');
688
- $request->set_body_params(array(
689
- 'title' => 'Test Review',
690
- 'content' => 'Test content',
691
- 'book_title' => 'Test Book',
692
- 'book_author' => 'Test Author',
693
- 'rating' => 5,
694
- ));
695
-
696
- $response = rest_do_request($request);
697
-
698
- $this->assertEquals(401, $response->get_status());
699
- }
700
-
701
- public function test_create_review_validates_rating() {
702
- wp_set_current_user($this->factory->user->create(array('role' => 'editor')));
703
-
704
- $request = new WP_REST_Request('POST', '/book-reviews/v1/reviews');
705
- $request->set_body_params(array(
706
- 'title' => 'Test Review',
707
- 'content' => 'Test content',
708
- 'book_title' => 'Test Book',
709
- 'book_author' => 'Test Author',
710
- 'rating' => 10, // Invalid rating
711
- ));
712
-
713
- $response = rest_do_request($request);
714
-
715
- $this->assertEquals(400, $response->get_status());
716
- }
717
- }
718
- ```
719
-
720
- ---
721
-
722
- ## Best Practices Demonstrated
723
-
724
- ✅ **Proper route registration** - Using `register_rest_route()`
725
- ✅ **Permission callbacks** - Authentication and authorization
726
- ✅ **Validation** - Input validation with error messages
727
- ✅ **Sanitization** - Secure data handling
728
- ✅ **Error handling** - WP_Error for failures
729
- ✅ **Pagination** - Collection parameters and headers
730
- ✅ **HTTP methods** - Proper REST verbs (GET, POST, PUT, DELETE)
731
- ✅ **Response formatting** - Consistent JSON responses
732
- ✅ **Nonce verification** - CSRF protection
733
- ✅ **Capability checks** - WordPress permissions integration
734
-
1
+ # REST API Endpoint Example
2
+
3
+ ## Overview
4
+
5
+ This example demonstrates a complete custom REST API endpoint with route registration, permission callback, endpoint handler, sanitization, validation, JSON response, and error handling.
6
+
7
+ **Use Case**: Custom API endpoints for external integrations
8
+ **Complexity**: Medium
9
+ **Prerequisites**: WordPress 5.0+, PHP 7.4+
10
+
11
+ ---
12
+
13
+ ## Complete Example: "Book Reviews API"
14
+
15
+ A custom REST API for managing book reviews with full CRUD operations, authentication, and validation.
16
+
17
+ ---
18
+
19
+ ## Directory Structure
20
+
21
+ ```
22
+ book-reviews-api/
23
+ ├── book-reviews-api.php # Main plugin file
24
+ ├── includes/
25
+ │ ├── class-api.php # API controller
26
+ │ ├── class-validator.php # Validation logic
27
+ │ └── class-sanitizer.php # Sanitization logic
28
+ └── readme.txt # Plugin readme
29
+ ```
30
+
31
+ ---
32
+
33
+ ## 1. Main Plugin File
34
+
35
+ ### File: `book-reviews-api.php`
36
+
37
+ ```php
38
+ <?php
39
+ /**
40
+ * Plugin Name: Book Reviews API
41
+ * Description: Custom REST API for managing book reviews
42
+ * Version: 1.0.0
43
+ * Requires at least: 5.0
44
+ * Requires PHP: 7.4
45
+ * Author: Your Name
46
+ * License: GPL-2.0+
47
+ * Text Domain: book-reviews-api
48
+ */
49
+
50
+ if (!defined('ABSPATH')) {
51
+ exit;
52
+ }
53
+
54
+ // Include dependencies
55
+ require_once plugin_dir_path(__FILE__) . 'includes/class-api.php';
56
+ require_once plugin_dir_path(__FILE__) . 'includes/class-validator.php';
57
+ require_once plugin_dir_path(__FILE__) . 'includes/class-sanitizer.php';
58
+
59
+ /**
60
+ * Initialize the API
61
+ */
62
+ function bra_init() {
63
+ $api = new Book_Reviews_API();
64
+ $api->register_routes();
65
+ }
66
+ add_action('rest_api_init', 'bra_init');
67
+ ```
68
+
69
+ ---
70
+
71
+ ## 2. API Controller
72
+
73
+ ### File: `includes/class-api.php`
74
+
75
+ ```php
76
+ <?php
77
+ /**
78
+ * Book Reviews API Controller
79
+ */
80
+ class Book_Reviews_API {
81
+
82
+ /**
83
+ * Namespace for API routes
84
+ */
85
+ private $namespace = 'book-reviews/v1';
86
+
87
+ /**
88
+ * Base route
89
+ */
90
+ private $base = 'reviews';
91
+
92
+ /**
93
+ * Register all routes
94
+ */
95
+ public function register_routes() {
96
+ // GET - List all reviews
97
+ register_rest_route($this->namespace, '/' . $this->base, array(
98
+ 'methods' => WP_REST_Server::READABLE,
99
+ 'callback' => array($this, 'get_items'),
100
+ 'permission_callback' => '__return_true',
101
+ 'args' => $this->get_collection_params(),
102
+ ));
103
+
104
+ // POST - Create review
105
+ register_rest_route($this->namespace, '/' . $this->base, array(
106
+ 'methods' => WP_REST_Server::CREATABLE,
107
+ 'callback' => array($this, 'create_item'),
108
+ 'permission_callback' => array($this, 'create_item_permissions_check'),
109
+ 'args' => $this->get_endpoint_args_for_item_schema(),
110
+ ));
111
+
112
+ // GET - Get single review
113
+ register_rest_route($this->namespace, '/' . $this->base . '/(?P<id>[\d]+)', array(
114
+ 'methods' => WP_REST_Server::READABLE,
115
+ 'callback' => array($this, 'get_item'),
116
+ 'permission_callback' => '__return_true',
117
+ 'args' => array(
118
+ 'id' => array(
119
+ 'validate_callback' => function($param) {
120
+ return is_numeric($param);
121
+ },
122
+ ),
123
+ ),
124
+ ));
125
+
126
+ // PUT/PATCH - Update review
127
+ register_rest_route($this->namespace, '/' . $this->base . '/(?P<id>[\d]+)', array(
128
+ 'methods' => WP_REST_Server::EDITABLE,
129
+ 'callback' => array($this, 'update_item'),
130
+ 'permission_callback' => array($this, 'update_item_permissions_check'),
131
+ 'args' => $this->get_endpoint_args_for_item_schema(),
132
+ ));
133
+
134
+ // DELETE - Delete review
135
+ register_rest_route($this->namespace, '/' . $this->base . '/(?P<id>[\d]+)', array(
136
+ 'methods' => WP_REST_Server::DELETABLE,
137
+ 'callback' => array($this, 'delete_item'),
138
+ 'permission_callback' => array($this, 'delete_item_permissions_check'),
139
+ ));
140
+ }
141
+
142
+ /**
143
+ * Get collection of reviews
144
+ */
145
+ public function get_items($request) {
146
+ $args = array(
147
+ 'post_type' => 'book_review',
148
+ 'posts_per_page' => $request->get_param('per_page') ?: 10,
149
+ 'paged' => $request->get_param('page') ?: 1,
150
+ 'orderby' => $request->get_param('orderby') ?: 'date',
151
+ 'order' => $request->get_param('order') ?: 'DESC',
152
+ );
153
+
154
+ $query = new WP_Query($args);
155
+ $reviews = array();
156
+
157
+ foreach ($query->posts as $post) {
158
+ $reviews[] = $this->prepare_item_for_response($post);
159
+ }
160
+
161
+ $response = rest_ensure_response($reviews);
162
+
163
+ // Add pagination headers
164
+ $response->header('X-WP-Total', $query->found_posts);
165
+ $response->header('X-WP-TotalPages', $query->max_num_pages);
166
+
167
+ return $response;
168
+ }
169
+
170
+ /**
171
+ * Get single review
172
+ */
173
+ public function get_item($request) {
174
+ $id = (int) $request->get_param('id');
175
+ $post = get_post($id);
176
+
177
+ if (!$post || $post->post_type !== 'book_review') {
178
+ return new WP_Error(
179
+ 'rest_review_not_found',
180
+ __('Review not found.', 'book-reviews-api'),
181
+ array('status' => 404)
182
+ );
183
+ }
184
+
185
+ $data = $this->prepare_item_for_response($post);
186
+ return rest_ensure_response($data);
187
+ }
188
+
189
+ /**
190
+ * Create new review
191
+ */
192
+ public function create_item($request) {
193
+ $validator = new Book_Reviews_Validator();
194
+ $sanitizer = new Book_Reviews_Sanitizer();
195
+
196
+ // Validate input
197
+ $validation = $validator->validate_review_data($request->get_params());
198
+ if (is_wp_error($validation)) {
199
+ return $validation;
200
+ }
201
+
202
+ // Sanitize input
203
+ $data = $sanitizer->sanitize_review_data($request->get_params());
204
+
205
+ // Create post
206
+ $post_id = wp_insert_post(array(
207
+ 'post_type' => 'book_review',
208
+ 'post_title' => $data['title'],
209
+ 'post_content' => $data['content'],
210
+ 'post_status' => 'publish',
211
+ 'post_author' => get_current_user_id(),
212
+ ));
213
+
214
+ if (is_wp_error($post_id)) {
215
+ return new WP_Error(
216
+ 'rest_review_create_failed',
217
+ __('Failed to create review.', 'book-reviews-api'),
218
+ array('status' => 500)
219
+ );
220
+ }
221
+
222
+ // Save meta data
223
+ update_post_meta($post_id, '_book_title', $data['book_title']);
224
+ update_post_meta($post_id, '_book_author', $data['book_author']);
225
+ update_post_meta($post_id, '_rating', $data['rating']);
226
+
227
+ $post = get_post($post_id);
228
+ $response = $this->prepare_item_for_response($post);
229
+
230
+ return rest_ensure_response($response);
231
+ }
232
+
233
+ /**
234
+ * Update review
235
+ */
236
+ public function update_item($request) {
237
+ $id = (int) $request->get_param('id');
238
+ $post = get_post($id);
239
+
240
+ if (!$post || $post->post_type !== 'book_review') {
241
+ return new WP_Error(
242
+ 'rest_review_not_found',
243
+ __('Review not found.', 'book-reviews-api'),
244
+ array('status' => 404)
245
+ );
246
+ }
247
+
248
+ $validator = new Book_Reviews_Validator();
249
+ $sanitizer = new Book_Reviews_Sanitizer();
250
+
251
+ // Validate input
252
+ $validation = $validator->validate_review_data($request->get_params());
253
+ if (is_wp_error($validation)) {
254
+ return $validation;
255
+ }
256
+
257
+ // Sanitize input
258
+ $data = $sanitizer->sanitize_review_data($request->get_params());
259
+
260
+ // Update post
261
+ $updated = wp_update_post(array(
262
+ 'ID' => $id,
263
+ 'post_title' => $data['title'],
264
+ 'post_content' => $data['content'],
265
+ ));
266
+
267
+ if (is_wp_error($updated)) {
268
+ return new WP_Error(
269
+ 'rest_review_update_failed',
270
+ __('Failed to update review.', 'book-reviews-api'),
271
+ array('status' => 500)
272
+ );
273
+ }
274
+
275
+ // Update meta data
276
+ update_post_meta($id, '_book_title', $data['book_title']);
277
+ update_post_meta($id, '_book_author', $data['book_author']);
278
+ update_post_meta($id, '_rating', $data['rating']);
279
+
280
+ $post = get_post($id);
281
+ $response = $this->prepare_item_for_response($post);
282
+
283
+ return rest_ensure_response($response);
284
+ }
285
+
286
+ /**
287
+ * Delete review
288
+ */
289
+ public function delete_item($request) {
290
+ $id = (int) $request->get_param('id');
291
+ $post = get_post($id);
292
+
293
+ if (!$post || $post->post_type !== 'book_review') {
294
+ return new WP_Error(
295
+ 'rest_review_not_found',
296
+ __('Review not found.', 'book-reviews-api'),
297
+ array('status' => 404)
298
+ );
299
+ }
300
+
301
+ $previous = $this->prepare_item_for_response($post);
302
+ $result = wp_delete_post($id, true);
303
+
304
+ if (!$result) {
305
+ return new WP_Error(
306
+ 'rest_review_delete_failed',
307
+ __('Failed to delete review.', 'book-reviews-api'),
308
+ array('status' => 500)
309
+ );
310
+ }
311
+
312
+ return rest_ensure_response(array(
313
+ 'deleted' => true,
314
+ 'previous' => $previous,
315
+ ));
316
+ }
317
+
318
+ /**
319
+ * Permission check for creating reviews
320
+ */
321
+ public function create_item_permissions_check($request) {
322
+ if (!is_user_logged_in()) {
323
+ return new WP_Error(
324
+ 'rest_forbidden',
325
+ __('You must be logged in to create reviews.', 'book-reviews-api'),
326
+ array('status' => 401)
327
+ );
328
+ }
329
+
330
+ if (!current_user_can('publish_posts')) {
331
+ return new WP_Error(
332
+ 'rest_forbidden',
333
+ __('You do not have permission to create reviews.', 'book-reviews-api'),
334
+ array('status' => 403)
335
+ );
336
+ }
337
+
338
+ return true;
339
+ }
340
+
341
+ /**
342
+ * Permission check for updating reviews
343
+ */
344
+ public function update_item_permissions_check($request) {
345
+ $id = (int) $request->get_param('id');
346
+ $post = get_post($id);
347
+
348
+ if (!$post) {
349
+ return new WP_Error(
350
+ 'rest_review_not_found',
351
+ __('Review not found.', 'book-reviews-api'),
352
+ array('status' => 404)
353
+ );
354
+ }
355
+
356
+ if (!current_user_can('edit_post', $id)) {
357
+ return new WP_Error(
358
+ 'rest_forbidden',
359
+ __('You do not have permission to edit this review.', 'book-reviews-api'),
360
+ array('status' => 403)
361
+ );
362
+ }
363
+
364
+ return true;
365
+ }
366
+
367
+ /**
368
+ * Permission check for deleting reviews
369
+ */
370
+ public function delete_item_permissions_check($request) {
371
+ $id = (int) $request->get_param('id');
372
+ $post = get_post($id);
373
+
374
+ if (!$post) {
375
+ return new WP_Error(
376
+ 'rest_review_not_found',
377
+ __('Review not found.', 'book-reviews-api'),
378
+ array('status' => 404)
379
+ );
380
+ }
381
+
382
+ if (!current_user_can('delete_post', $id)) {
383
+ return new WP_Error(
384
+ 'rest_forbidden',
385
+ __('You do not have permission to delete this review.', 'book-reviews-api'),
386
+ array('status' => 403)
387
+ );
388
+ }
389
+
390
+ return true;
391
+ }
392
+
393
+ /**
394
+ * Prepare item for response
395
+ */
396
+ private function prepare_item_for_response($post) {
397
+ return array(
398
+ 'id' => $post->ID,
399
+ 'title' => $post->post_title,
400
+ 'content' => $post->post_content,
401
+ 'book_title' => get_post_meta($post->ID, '_book_title', true),
402
+ 'book_author' => get_post_meta($post->ID, '_book_author', true),
403
+ 'rating' => (int) get_post_meta($post->ID, '_rating', true),
404
+ 'date' => $post->post_date,
405
+ 'author' => $post->post_author,
406
+ );
407
+ }
408
+
409
+ /**
410
+ * Get collection parameters
411
+ */
412
+ private function get_collection_params() {
413
+ return array(
414
+ 'page' => array(
415
+ 'description' => __('Current page of the collection.', 'book-reviews-api'),
416
+ 'type' => 'integer',
417
+ 'default' => 1,
418
+ 'sanitize_callback' => 'absint',
419
+ ),
420
+ 'per_page' => array(
421
+ 'description' => __('Maximum number of items per page.', 'book-reviews-api'),
422
+ 'type' => 'integer',
423
+ 'default' => 10,
424
+ 'sanitize_callback' => 'absint',
425
+ ),
426
+ 'orderby' => array(
427
+ 'description' => __('Sort collection by field.', 'book-reviews-api'),
428
+ 'type' => 'string',
429
+ 'default' => 'date',
430
+ 'enum' => array('date', 'title', 'rating'),
431
+ ),
432
+ 'order' => array(
433
+ 'description' => __('Order sort attribute ascending or descending.', 'book-reviews-api'),
434
+ 'type' => 'string',
435
+ 'default' => 'DESC',
436
+ 'enum' => array('ASC', 'DESC'),
437
+ ),
438
+ );
439
+ }
440
+
441
+ /**
442
+ * Get endpoint args for item schema
443
+ */
444
+ private function get_endpoint_args_for_item_schema() {
445
+ return array(
446
+ 'title' => array(
447
+ 'description' => __('Review title.', 'book-reviews-api'),
448
+ 'type' => 'string',
449
+ 'required' => true,
450
+ 'sanitize_callback' => 'sanitize_text_field',
451
+ ),
452
+ 'content' => array(
453
+ 'description' => __('Review content.', 'book-reviews-api'),
454
+ 'type' => 'string',
455
+ 'required' => true,
456
+ 'sanitize_callback' => 'wp_kses_post',
457
+ ),
458
+ 'book_title' => array(
459
+ 'description' => __('Book title.', 'book-reviews-api'),
460
+ 'type' => 'string',
461
+ 'required' => true,
462
+ 'sanitize_callback' => 'sanitize_text_field',
463
+ ),
464
+ 'book_author' => array(
465
+ 'description' => __('Book author.', 'book-reviews-api'),
466
+ 'type' => 'string',
467
+ 'required' => true,
468
+ 'sanitize_callback' => 'sanitize_text_field',
469
+ ),
470
+ 'rating' => array(
471
+ 'description' => __('Rating (1-5).', 'book-reviews-api'),
472
+ 'type' => 'integer',
473
+ 'required' => true,
474
+ 'minimum' => 1,
475
+ 'maximum' => 5,
476
+ 'sanitize_callback' => 'absint',
477
+ ),
478
+ );
479
+ }
480
+ }
481
+ ```
482
+
483
+ ---
484
+
485
+ ## 3. Validator Class
486
+
487
+ ### File: `includes/class-validator.php`
488
+
489
+ ```php
490
+ <?php
491
+ /**
492
+ * Book Reviews Validator
493
+ */
494
+ class Book_Reviews_Validator {
495
+
496
+ /**
497
+ * Validate review data
498
+ */
499
+ public function validate_review_data($data) {
500
+ $errors = new WP_Error();
501
+
502
+ // Validate title
503
+ if (empty($data['title'])) {
504
+ $errors->add(
505
+ 'missing_title',
506
+ __('Review title is required.', 'book-reviews-api'),
507
+ array('status' => 400)
508
+ );
509
+ }
510
+
511
+ // Validate content
512
+ if (empty($data['content'])) {
513
+ $errors->add(
514
+ 'missing_content',
515
+ __('Review content is required.', 'book-reviews-api'),
516
+ array('status' => 400)
517
+ );
518
+ }
519
+
520
+ // Validate book title
521
+ if (empty($data['book_title'])) {
522
+ $errors->add(
523
+ 'missing_book_title',
524
+ __('Book title is required.', 'book-reviews-api'),
525
+ array('status' => 400)
526
+ );
527
+ }
528
+
529
+ // Validate book author
530
+ if (empty($data['book_author'])) {
531
+ $errors->add(
532
+ 'missing_book_author',
533
+ __('Book author is required.', 'book-reviews-api'),
534
+ array('status' => 400)
535
+ );
536
+ }
537
+
538
+ // Validate rating
539
+ if (!isset($data['rating'])) {
540
+ $errors->add(
541
+ 'missing_rating',
542
+ __('Rating is required.', 'book-reviews-api'),
543
+ array('status' => 400)
544
+ );
545
+ } elseif ($data['rating'] < 1 || $data['rating'] > 5) {
546
+ $errors->add(
547
+ 'invalid_rating',
548
+ __('Rating must be between 1 and 5.', 'book-reviews-api'),
549
+ array('status' => 400)
550
+ );
551
+ }
552
+
553
+ if ($errors->has_errors()) {
554
+ return $errors;
555
+ }
556
+
557
+ return true;
558
+ }
559
+ }
560
+ ```
561
+
562
+ ---
563
+
564
+ ## 4. Sanitizer Class
565
+
566
+ ### File: `includes/class-sanitizer.php`
567
+
568
+ ```php
569
+ <?php
570
+ /**
571
+ * Book Reviews Sanitizer
572
+ */
573
+ class Book_Reviews_Sanitizer {
574
+
575
+ /**
576
+ * Sanitize review data
577
+ */
578
+ public function sanitize_review_data($data) {
579
+ return array(
580
+ 'title' => sanitize_text_field($data['title']),
581
+ 'content' => wp_kses_post($data['content']),
582
+ 'book_title' => sanitize_text_field($data['book_title']),
583
+ 'book_author' => sanitize_text_field($data['book_author']),
584
+ 'rating' => absint($data['rating']),
585
+ );
586
+ }
587
+ }
588
+ ```
589
+
590
+ ---
591
+
592
+ ## 5. Testing Steps
593
+
594
+ ### Manual Testing with cURL
595
+
596
+ **1. List all reviews (GET)**
597
+
598
+ ```bash
599
+ curl -X GET "https://example.com/wp-json/book-reviews/v1/reviews"
600
+ ```
601
+
602
+ **2. Get single review (GET)**
603
+
604
+ ```bash
605
+ curl -X GET "https://example.com/wp-json/book-reviews/v1/reviews/123"
606
+ ```
607
+
608
+ **3. Create review (POST)**
609
+
610
+ ```bash
611
+ curl -X POST "https://example.com/wp-json/book-reviews/v1/reviews" \
612
+ -H "Content-Type: application/json" \
613
+ -H "Authorization: Bearer YOUR_TOKEN" \
614
+ -d '{
615
+ "title": "Great Book!",
616
+ "content": "This book was amazing...",
617
+ "book_title": "The Great Gatsby",
618
+ "book_author": "F. Scott Fitzgerald",
619
+ "rating": 5
620
+ }'
621
+ ```
622
+
623
+ **4. Update review (PUT)**
624
+
625
+ ```bash
626
+ curl -X PUT "https://example.com/wp-json/book-reviews/v1/reviews/123" \
627
+ -H "Content-Type: application/json" \
628
+ -H "Authorization: Bearer YOUR_TOKEN" \
629
+ -d '{
630
+ "title": "Updated Title",
631
+ "content": "Updated content...",
632
+ "book_title": "The Great Gatsby",
633
+ "book_author": "F. Scott Fitzgerald",
634
+ "rating": 4
635
+ }'
636
+ ```
637
+
638
+ **5. Delete review (DELETE)**
639
+
640
+ ```bash
641
+ curl -X DELETE "https://example.com/wp-json/book-reviews/v1/reviews/123" \
642
+ -H "Authorization: Bearer YOUR_TOKEN"
643
+ ```
644
+
645
+ ### Testing with JavaScript
646
+
647
+ ```javascript
648
+ // Fetch all reviews
649
+ fetch('https://example.com/wp-json/book-reviews/v1/reviews')
650
+ .then(response => response.json())
651
+ .then(data => console.log(data));
652
+
653
+ // Create review
654
+ fetch('https://example.com/wp-json/book-reviews/v1/reviews', {
655
+ method: 'POST',
656
+ headers: {
657
+ 'Content-Type': 'application/json',
658
+ 'X-WP-Nonce': wpApiSettings.nonce
659
+ },
660
+ body: JSON.stringify({
661
+ title: 'Great Book!',
662
+ content: 'This book was amazing...',
663
+ book_title: 'The Great Gatsby',
664
+ book_author: 'F. Scott Fitzgerald',
665
+ rating: 5
666
+ })
667
+ })
668
+ .then(response => response.json())
669
+ .then(data => console.log(data));
670
+ ```
671
+
672
+ ### Automated Testing with PHPUnit
673
+
674
+ ```php
675
+ <?php
676
+ class Test_Book_Reviews_API extends WP_UnitTestCase {
677
+
678
+ public function test_get_reviews() {
679
+ $request = new WP_REST_Request('GET', '/book-reviews/v1/reviews');
680
+ $response = rest_do_request($request);
681
+
682
+ $this->assertEquals(200, $response->get_status());
683
+ $this->assertIsArray($response->get_data());
684
+ }
685
+
686
+ public function test_create_review_requires_authentication() {
687
+ $request = new WP_REST_Request('POST', '/book-reviews/v1/reviews');
688
+ $request->set_body_params(array(
689
+ 'title' => 'Test Review',
690
+ 'content' => 'Test content',
691
+ 'book_title' => 'Test Book',
692
+ 'book_author' => 'Test Author',
693
+ 'rating' => 5,
694
+ ));
695
+
696
+ $response = rest_do_request($request);
697
+
698
+ $this->assertEquals(401, $response->get_status());
699
+ }
700
+
701
+ public function test_create_review_validates_rating() {
702
+ wp_set_current_user($this->factory->user->create(array('role' => 'editor')));
703
+
704
+ $request = new WP_REST_Request('POST', '/book-reviews/v1/reviews');
705
+ $request->set_body_params(array(
706
+ 'title' => 'Test Review',
707
+ 'content' => 'Test content',
708
+ 'book_title' => 'Test Book',
709
+ 'book_author' => 'Test Author',
710
+ 'rating' => 10, // Invalid rating
711
+ ));
712
+
713
+ $response = rest_do_request($request);
714
+
715
+ $this->assertEquals(400, $response->get_status());
716
+ }
717
+ }
718
+ ```
719
+
720
+ ---
721
+
722
+ ## Best Practices Demonstrated
723
+
724
+ ✅ **Proper route registration** - Using `register_rest_route()`
725
+ ✅ **Permission callbacks** - Authentication and authorization
726
+ ✅ **Validation** - Input validation with error messages
727
+ ✅ **Sanitization** - Secure data handling
728
+ ✅ **Error handling** - WP_Error for failures
729
+ ✅ **Pagination** - Collection parameters and headers
730
+ ✅ **HTTP methods** - Proper REST verbs (GET, POST, PUT, DELETE)
731
+ ✅ **Response formatting** - Consistent JSON responses
732
+ ✅ **Nonce verification** - CSRF protection
733
+ ✅ **Capability checks** - WordPress permissions integration
734
+