create-nextblock 0.16.1 → 0.16.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (264) hide show
  1. package/docker-template/.dockerignore +1 -1
  2. package/libs/db/tsconfig.lib.json +3 -3
  3. package/libs/editor/tsconfig.lib.json +3 -3
  4. package/libs/ui/tsconfig.lib.json +3 -3
  5. package/libs/utils/tsconfig.json +3 -3
  6. package/package.json +50 -50
  7. package/project.json +19 -19
  8. package/templates/nextblock-template/.dockerignore +1 -1
  9. package/templates/nextblock-template/.swcrc +30 -30
  10. package/templates/nextblock-template/AGENTS.md +9 -9
  11. package/templates/nextblock-template/CLAUDE.md +1 -1
  12. package/templates/nextblock-template/app/(auth-pages)/layout.tsx +9 -9
  13. package/templates/nextblock-template/app/(auth-pages)/post-sign-in/page.tsx +27 -27
  14. package/templates/nextblock-template/app/.well-known/ucp/route.ts +16 -16
  15. package/templates/nextblock-template/app/ToasterProvider.tsx +26 -26
  16. package/templates/nextblock-template/app/[slug]/pageClientActions.ts +7 -7
  17. package/templates/nextblock-template/app/actions/contactSellerActions.test.ts +280 -280
  18. package/templates/nextblock-template/app/actions/contactSellerActions.ts +222 -222
  19. package/templates/nextblock-template/app/actions/email-retry.test.ts +62 -62
  20. package/templates/nextblock-template/app/actions/email.ts +241 -241
  21. package/templates/nextblock-template/app/actions/formActions.ts +245 -245
  22. package/templates/nextblock-template/app/actions/interactions.ts +489 -489
  23. package/templates/nextblock-template/app/actions/threadActions.ts +166 -166
  24. package/templates/nextblock-template/app/actions/visibilityActions.ts +210 -210
  25. package/templates/nextblock-template/app/api/ai/seo/alt-text/route.ts +221 -221
  26. package/templates/nextblock-template/app/api/ai/seo/metadata/route.ts +186 -186
  27. package/templates/nextblock-template/app/api/checkout/freemius/sync/route.ts +29 -29
  28. package/templates/nextblock-template/app/api/checkout/route.ts +162 -162
  29. package/templates/nextblock-template/app/api/cron/reset-sandbox/route.ts +4 -4
  30. package/templates/nextblock-template/app/api/cron/reset-sandbox/sandboxResetSql.ts +4542 -2904
  31. package/templates/nextblock-template/app/api/mcp/route.ts +415 -415
  32. package/templates/nextblock-template/app/api/media/record/route.ts +160 -160
  33. package/templates/nextblock-template/app/api/search/route.ts +43 -43
  34. package/templates/nextblock-template/app/api/view/route.ts +114 -114
  35. package/templates/nextblock-template/app/api/visual-editing/block-draft/route.ts +47 -47
  36. package/templates/nextblock-template/app/api/visual-editing/product-draft/route.ts +47 -47
  37. package/templates/nextblock-template/app/auth/callback/route.ts +31 -31
  38. package/templates/nextblock-template/app/cart/page.tsx +7 -7
  39. package/templates/nextblock-template/app/checkout/UcpCartHydrator.tsx +20 -20
  40. package/templates/nextblock-template/app/checkout/page.tsx +57 -57
  41. package/templates/nextblock-template/app/cms/CmsClientLayout.tsx +558 -558
  42. package/templates/nextblock-template/app/cms/blocks/components/BlockEditorModal.tsx +241 -241
  43. package/templates/nextblock-template/app/cms/blocks/components/MediaLibraryModal.tsx +149 -149
  44. package/templates/nextblock-template/app/cms/blocks/editors/FormBlockEditor.tsx +304 -304
  45. package/templates/nextblock-template/app/cms/blocks/editors/ImageBlockEditor.tsx +406 -406
  46. package/templates/nextblock-template/app/cms/components/ContactReminderBanner.tsx +75 -75
  47. package/templates/nextblock-template/app/cms/components/CortexAiActiveContext.tsx +23 -23
  48. package/templates/nextblock-template/app/cms/components/CortexAiPageContext.tsx +58 -58
  49. package/templates/nextblock-template/app/cms/components/FeatureImageField.tsx +254 -254
  50. package/templates/nextblock-template/app/cms/components/FeedbackModal.tsx +36 -36
  51. package/templates/nextblock-template/app/cms/components/PaymentsReminderBanner.tsx +58 -58
  52. package/templates/nextblock-template/app/cms/components/SeoScoreBadge.tsx +40 -0
  53. package/templates/nextblock-template/app/cms/components/TablePagination.tsx +136 -0
  54. package/templates/nextblock-template/app/cms/components/VisibilityBadge.tsx +62 -62
  55. package/templates/nextblock-template/app/cms/components/VisibilityControl.tsx +542 -542
  56. package/templates/nextblock-template/app/cms/coupons/[id]/edit/page.tsx +16 -16
  57. package/templates/nextblock-template/app/cms/coupons/page.tsx +16 -16
  58. package/templates/nextblock-template/app/cms/dashboard/actions.ts +228 -228
  59. package/templates/nextblock-template/app/cms/dashboard/components/DashboardComponents.tsx +200 -200
  60. package/templates/nextblock-template/app/cms/inquiries/actions.ts +66 -66
  61. package/templates/nextblock-template/app/cms/inquiries/page.tsx +12 -12
  62. package/templates/nextblock-template/app/cms/interactions/page.tsx +12 -12
  63. package/templates/nextblock-template/app/cms/layout.tsx +101 -101
  64. package/templates/nextblock-template/app/cms/media/components/FolderNavigator.tsx +273 -273
  65. package/templates/nextblock-template/app/cms/media/components/FolderTree.tsx +122 -122
  66. package/templates/nextblock-template/app/cms/media/components/MediaGridClient.tsx +69 -69
  67. package/templates/nextblock-template/app/cms/messages/MessagesClient.tsx +661 -661
  68. package/templates/nextblock-template/app/cms/messages/actions.ts +404 -404
  69. package/templates/nextblock-template/app/cms/messages/loadInbox.ts +333 -333
  70. package/templates/nextblock-template/app/cms/messages/page.tsx +87 -87
  71. package/templates/nextblock-template/app/cms/messages/require-admin.ts +37 -37
  72. package/templates/nextblock-template/app/cms/navigation/components/NavigationMenuDnd.tsx +3 -3
  73. package/templates/nextblock-template/app/cms/pages/components/PageForm.tsx +649 -649
  74. package/templates/nextblock-template/app/cms/pages/page.tsx +273 -227
  75. package/templates/nextblock-template/app/cms/posts/[id]/edit/page.tsx +2 -0
  76. package/templates/nextblock-template/app/cms/posts/components/PostForm.tsx +624 -618
  77. package/templates/nextblock-template/app/cms/posts/page.tsx +251 -194
  78. package/templates/nextblock-template/app/cms/products/[id]/edit/page.tsx +370 -370
  79. package/templates/nextblock-template/app/cms/products/attributes/page.tsx +12 -12
  80. package/templates/nextblock-template/app/cms/products/inventory/page.tsx +13 -13
  81. package/templates/nextblock-template/app/cms/products/productFormData.ts +133 -133
  82. package/templates/nextblock-template/app/cms/products/settings/page.tsx +5 -5
  83. package/templates/nextblock-template/app/cms/revisions/actions.ts +332 -332
  84. package/templates/nextblock-template/app/cms/revisions/service.test.ts +498 -498
  85. package/templates/nextblock-template/app/cms/revisions/service.ts +569 -569
  86. package/templates/nextblock-template/app/cms/revisions/utils.ts +304 -304
  87. package/templates/nextblock-template/app/cms/settings/cortex-ai/CortexAiSettingsClient.tsx +948 -948
  88. package/templates/nextblock-template/app/cms/settings/cortex-ai/McpServerSettingsCard.tsx +628 -628
  89. package/templates/nextblock-template/app/cms/settings/cortex-ai/mcp-actions.ts +230 -230
  90. package/templates/nextblock-template/app/cms/settings/cortex-ai/require-admin.ts +34 -34
  91. package/templates/nextblock-template/app/cms/settings/currencies/actions.ts +331 -331
  92. package/templates/nextblock-template/app/cms/settings/currencies/page.tsx +494 -494
  93. package/templates/nextblock-template/app/cms/settings/email/components/EmailForm.tsx +227 -227
  94. package/templates/nextblock-template/app/cms/settings/extra-translations/ExtraTranslationsWorkspace.tsx +767 -767
  95. package/templates/nextblock-template/app/cms/settings/extra-translations/actions.ts +276 -276
  96. package/templates/nextblock-template/app/cms/settings/extra-translations/page.tsx +93 -93
  97. package/templates/nextblock-template/app/cms/settings/global-css/components/ThemeEditor.tsx +382 -382
  98. package/templates/nextblock-template/app/cms/settings/global-css/components/ThemeManager.tsx +267 -267
  99. package/templates/nextblock-template/app/cms/settings/global-css/page.tsx +40 -40
  100. package/templates/nextblock-template/app/cms/settings/global-css/theme-actions.ts +259 -259
  101. package/templates/nextblock-template/app/cms/settings/logos/[id]/edit/page.tsx +7 -7
  102. package/templates/nextblock-template/app/cms/settings/logos/components/BrandingSettingsForm.tsx +339 -339
  103. package/templates/nextblock-template/app/cms/settings/logos/new/page.tsx +8 -8
  104. package/templates/nextblock-template/app/cms/settings/seo/RedirectsCard.tsx +514 -514
  105. package/templates/nextblock-template/app/cms/settings/seo/RobotsCard.tsx +529 -529
  106. package/templates/nextblock-template/app/cms/settings/seo/SeoSettingsClient.tsx +57 -57
  107. package/templates/nextblock-template/app/cms/settings/seo/actions.ts +448 -448
  108. package/templates/nextblock-template/app/cms/settings/seo/mappers.ts +93 -93
  109. package/templates/nextblock-template/app/cms/settings/seo/page.tsx +46 -46
  110. package/templates/nextblock-template/app/cms/settings/seo/require-admin.ts +47 -47
  111. package/templates/nextblock-template/app/cms/settings/site-scripts/page.tsx +51 -51
  112. package/templates/nextblock-template/app/cms/settings/taxes/page.tsx +21 -21
  113. package/templates/nextblock-template/app/cms/shipping/page.tsx +20 -20
  114. package/templates/nextblock-template/app/cms/users/components/DeleteUserButton.tsx +12 -12
  115. package/templates/nextblock-template/app/layout.tsx +671 -671
  116. package/templates/nextblock-template/app/lib/seo.ts +319 -319
  117. package/templates/nextblock-template/app/lib/ucp/protocol.ts +190 -190
  118. package/templates/nextblock-template/app/lib/ucp/server.test.ts +56 -56
  119. package/templates/nextblock-template/app/product/[slug]/page.tsx +502 -502
  120. package/templates/nextblock-template/app/profile/ProfilePageHeader.tsx +16 -16
  121. package/templates/nextblock-template/app/profile/ProfilePageMissingState.tsx +9 -9
  122. package/templates/nextblock-template/app/profile/account-links.ts +22 -22
  123. package/templates/nextblock-template/app/profile/orders/CustomerOrdersPageClient.tsx +124 -124
  124. package/templates/nextblock-template/app/profile/orders/page.tsx +19 -19
  125. package/templates/nextblock-template/app/profile/password/PasswordSettingsPageClient.tsx +128 -128
  126. package/templates/nextblock-template/app/profile/password/actions.ts +59 -59
  127. package/templates/nextblock-template/app/profile/password/page.tsx +27 -27
  128. package/templates/nextblock-template/app/providers.tsx +96 -96
  129. package/templates/nextblock-template/app/robots.ts +123 -123
  130. package/templates/nextblock-template/app/thread/ThreadView.tsx +164 -164
  131. package/templates/nextblock-template/app/thread/[token]/route.ts +57 -57
  132. package/templates/nextblock-template/app/thread/layout.tsx +15 -15
  133. package/templates/nextblock-template/app/thread/page.tsx +98 -98
  134. package/templates/nextblock-template/app/ucp/v1/carts/[id]/cancel/route.ts +38 -38
  135. package/templates/nextblock-template/app/ucp/v1/carts/[id]/route.ts +68 -68
  136. package/templates/nextblock-template/app/ucp/v1/carts/route.ts +35 -35
  137. package/templates/nextblock-template/app/ucp/v1/catalog/lookup/route.ts +35 -35
  138. package/templates/nextblock-template/app/ucp/v1/catalog/product/route.ts +35 -35
  139. package/templates/nextblock-template/app/ucp/v1/catalog/search/route.ts +34 -34
  140. package/templates/nextblock-template/components/BlockRenderer.tsx +312 -312
  141. package/templates/nextblock-template/components/CartDrawerLoader.tsx +7 -7
  142. package/templates/nextblock-template/components/CartTranslator.tsx +210 -210
  143. package/templates/nextblock-template/components/ContactSellerSection.tsx +188 -188
  144. package/templates/nextblock-template/components/DeferredCartDrawer.tsx +23 -23
  145. package/templates/nextblock-template/components/DeferredCartTranslator.tsx +51 -51
  146. package/templates/nextblock-template/components/DeferredGlobalSearch.tsx +68 -68
  147. package/templates/nextblock-template/components/DeferredGoogleTagManager.tsx +70 -70
  148. package/templates/nextblock-template/components/DeferredSpeedInsights.tsx +69 -69
  149. package/templates/nextblock-template/components/FooterNavigation.tsx +32 -32
  150. package/templates/nextblock-template/components/GlobalSearch.tsx +557 -557
  151. package/templates/nextblock-template/components/Header.tsx +38 -38
  152. package/templates/nextblock-template/components/HtmlScriptExecutor.tsx +47 -47
  153. package/templates/nextblock-template/components/LanguageSwitcher.tsx +2 -2
  154. package/templates/nextblock-template/components/PostCommentsSection.tsx +378 -378
  155. package/templates/nextblock-template/components/ProductReviewsSection.tsx +426 -426
  156. package/templates/nextblock-template/components/SiteScripts.tsx +56 -56
  157. package/templates/nextblock-template/components/StaffReplies.tsx +102 -102
  158. package/templates/nextblock-template/components/blocks/PostCardSkeleton.tsx +12 -12
  159. package/templates/nextblock-template/components/blocks/PostsGridBlock.tsx +12 -12
  160. package/templates/nextblock-template/components/blocks/PostsGridClient.tsx +48 -48
  161. package/templates/nextblock-template/components/blocks/TestimonialBlock.tsx +9 -9
  162. package/templates/nextblock-template/components/blocks/ecommerceRendererLoaders.ts +23 -23
  163. package/templates/nextblock-template/components/blocks/publicRendererLoaders.ts +25 -25
  164. package/templates/nextblock-template/components/blocks/renderers/ButtonBlockRenderer.tsx +92 -92
  165. package/templates/nextblock-template/components/blocks/renderers/CartBlockRenderer.tsx +18 -18
  166. package/templates/nextblock-template/components/blocks/renderers/CheckoutBlockRenderer.tsx +20 -20
  167. package/templates/nextblock-template/components/blocks/renderers/FeaturedProductBlockRenderer.tsx +25 -25
  168. package/templates/nextblock-template/components/blocks/renderers/FormBlockRenderer.tsx +385 -385
  169. package/templates/nextblock-template/components/blocks/renderers/PostsGridBlockRenderer.tsx +24 -24
  170. package/templates/nextblock-template/components/blocks/renderers/ProductDetailsBlockRenderer.tsx +157 -157
  171. package/templates/nextblock-template/components/blocks/renderers/ProductGridBlockRenderer.tsx +34 -34
  172. package/templates/nextblock-template/components/blocks/renderers/SectionBlockRenderer.tsx +612 -612
  173. package/templates/nextblock-template/components/blocks/renderers/TestimonialBlockRenderer.tsx +57 -57
  174. package/templates/nextblock-template/components/blocks/renderers/inline/AlertWidgetRenderer.tsx +2 -2
  175. package/templates/nextblock-template/components/blocks/renderers/inline/CtaWidgetRenderer.tsx +2 -2
  176. package/templates/nextblock-template/components/blocks/types.ts +7 -7
  177. package/templates/nextblock-template/components/commerce/PaymentReadinessBoundary.tsx +32 -32
  178. package/templates/nextblock-template/components/env-var-warning.tsx +3 -3
  179. package/templates/nextblock-template/components/form-message.tsx +32 -32
  180. package/templates/nextblock-template/components/seo/GenerateMetaButton.tsx +137 -137
  181. package/templates/nextblock-template/components/seo/PageSeoAuditSection.tsx +251 -244
  182. package/templates/nextblock-template/components/seo/SeoAuditPanel.tsx +749 -749
  183. package/templates/nextblock-template/components/seo/SeoIssueList.tsx +195 -195
  184. package/templates/nextblock-template/components/seo/SeoScoreDial.tsx +144 -144
  185. package/templates/nextblock-template/components/seo/SocialPreview.tsx +243 -243
  186. package/templates/nextblock-template/components/seo/SocialPreviewDialog.tsx +110 -110
  187. package/templates/nextblock-template/components/submit-button.tsx +23 -23
  188. package/templates/nextblock-template/components/theme-icon.tsx +78 -78
  189. package/templates/nextblock-template/components/theme-switcher.tsx +85 -85
  190. package/templates/nextblock-template/context/AuthContext.tsx +23 -23
  191. package/templates/nextblock-template/context/ThemeCatalogContext.tsx +44 -44
  192. package/templates/nextblock-template/docs/01-PROJECT-OVERVIEW.md +94 -94
  193. package/templates/nextblock-template/docs/03-CMS-AND-EDITOR.md +77 -77
  194. package/templates/nextblock-template/docs/13-STAYING-UP-TO-DATE.md +372 -372
  195. package/templates/nextblock-template/docs/14-MESSAGES-INBOX.md +309 -309
  196. package/templates/nextblock-template/docs/README.md +42 -42
  197. package/templates/nextblock-template/docs/TECHNICAL_SPECIFICATION.md +12506 -12506
  198. package/templates/nextblock-template/hooks/use-hotkeys.ts +21 -21
  199. package/templates/nextblock-template/hooks/useGlobalSearch.ts +101 -101
  200. package/templates/nextblock-template/index.d.ts +7 -7
  201. package/templates/nextblock-template/lib/auth-redirects.ts +46 -46
  202. package/templates/nextblock-template/lib/blocks/blockColors.test.ts +134 -134
  203. package/templates/nextblock-template/lib/blocks/blockColors.ts +175 -175
  204. package/templates/nextblock-template/lib/blocks/blockRegistry.ts +761 -761
  205. package/templates/nextblock-template/lib/blocks/inlineScriptNonce.ts +20 -20
  206. package/templates/nextblock-template/lib/cms/contact-reminder.ts +64 -64
  207. package/templates/nextblock-template/lib/cms/payments-reminder.test.ts +135 -0
  208. package/templates/nextblock-template/lib/cms/payments-reminder.ts +30 -23
  209. package/templates/nextblock-template/lib/cms/unread-messages.ts +42 -42
  210. package/templates/nextblock-template/lib/commerce/seller-contact.ts +162 -162
  211. package/templates/nextblock-template/lib/config/email-settings.ts +323 -323
  212. package/templates/nextblock-template/lib/config/email-tls.test.ts +57 -57
  213. package/templates/nextblock-template/lib/cortex-ai/alt-text-request.ts +86 -86
  214. package/templates/nextblock-template/lib/cortex-ai/sandbox-headers.ts +60 -60
  215. package/templates/nextblock-template/lib/email/placeholder-address.test.ts +59 -59
  216. package/templates/nextblock-template/lib/email/placeholder-address.ts +39 -39
  217. package/templates/nextblock-template/lib/messages/thread-reference.test.ts +70 -70
  218. package/templates/nextblock-template/lib/messages/thread-token.test.ts +93 -93
  219. package/templates/nextblock-template/lib/messages/thread-token.ts +157 -157
  220. package/templates/nextblock-template/lib/messages/threads.ts +579 -579
  221. package/templates/nextblock-template/lib/posts/readTime.ts +60 -60
  222. package/templates/nextblock-template/lib/publishing/viewUrl.ts +26 -26
  223. package/templates/nextblock-template/lib/search/types.ts +27 -27
  224. package/templates/nextblock-template/lib/seo/alt-text-write-back.test.ts +154 -154
  225. package/templates/nextblock-template/lib/seo/alt-text-write-back.ts +109 -109
  226. package/templates/nextblock-template/lib/seo/block-content.ts +123 -123
  227. package/templates/nextblock-template/lib/seo/fix-prompts.test.ts +242 -242
  228. package/templates/nextblock-template/lib/seo/fix-prompts.ts +204 -204
  229. package/templates/nextblock-template/lib/seo/page-audit-context.tsx +157 -140
  230. package/templates/nextblock-template/lib/seo/page-document.test.ts +384 -350
  231. package/templates/nextblock-template/lib/seo/page-document.ts +463 -412
  232. package/templates/nextblock-template/lib/seo/redirect-store.test.ts +479 -479
  233. package/templates/nextblock-template/lib/seo/redirect-store.ts +466 -466
  234. package/templates/nextblock-template/lib/seo/robots-settings-signature.test.ts +102 -102
  235. package/templates/nextblock-template/lib/seo/robots-settings-signature.ts +41 -41
  236. package/templates/nextblock-template/lib/seo/robots-txt.test.ts +370 -370
  237. package/templates/nextblock-template/lib/seo/robots-txt.ts +510 -510
  238. package/templates/nextblock-template/lib/setup/migrations-bundle.ts +37 -22
  239. package/templates/nextblock-template/lib/site-scripts/revisions.ts +71 -71
  240. package/templates/nextblock-template/lib/site-scripts/types.ts +46 -46
  241. package/templates/nextblock-template/lib/site-url.test.ts +89 -89
  242. package/templates/nextblock-template/lib/site-url.ts +102 -102
  243. package/templates/nextblock-template/lib/themes/buildThemeCss.ts +124 -124
  244. package/templates/nextblock-template/lib/themes/tokenColor.ts +31 -31
  245. package/templates/nextblock-template/lib/themes/tokens.ts +143 -143
  246. package/templates/nextblock-template/lib/visual-editing/draft-content.test.ts +105 -105
  247. package/templates/nextblock-template/lib/visual-editing/draft-route.test.ts +42 -42
  248. package/templates/nextblock-template/lib/visual-editing/edit-info.test.ts +143 -143
  249. package/templates/nextblock-template/lib/visual-editing/edit-info.ts +94 -94
  250. package/templates/nextblock-template/lib/visual-editing/product-drafts.test.ts +81 -81
  251. package/templates/nextblock-template/lib/zod-config.ts +5 -5
  252. package/templates/nextblock-template/next-env.d.ts +1 -2
  253. package/templates/nextblock-template/package.json +1 -1
  254. package/templates/nextblock-template/postcss.config.js +6 -6
  255. package/templates/nextblock-template/scripts/backup.js +115 -115
  256. package/templates/nextblock-template/scripts/restore.js +385 -385
  257. package/templates/nextblock-template/scripts/validate-editor-block-schema.ts +112 -112
  258. package/templates/nextblock-template/tailwind.config.js +25 -25
  259. package/templates/nextblock-template/tools/build-migrate.mjs +102 -102
  260. package/templates/nextblock-template/tools/configure-supabase-auth.js +282 -282
  261. package/templates/nextblock-template/tools/deploy-supabase.js +159 -159
  262. package/templates/nextblock-template/tools/lib/migrate-core.mjs +569 -569
  263. package/templates/nextblock-template/tools/update.mjs +1303 -1303
  264. package/tsconfig.base.json +3 -3
@@ -1,370 +1,370 @@
1
- import { describe, expect, it } from 'vitest';
2
- import type { MetadataRoute } from 'next';
3
- // The serialiser Next itself runs for a dynamic `robots.ts`: the route module the
4
- // metadata loader generates is literally
5
- // `const data = await handler(); const content = resolveRouteData(data, fileType)`,
6
- // importing this exact specifier (see
7
- // next/dist/build/webpack/loaders/next-metadata-route-loader.js). Importing it here
8
- // rather than restating its behaviour is the point of these tests — the preview is
9
- // only provably the served file if the comparison uses the real thing. If a Next
10
- // upgrade moves or changes it, this import (or the assertions below) fail loudly,
11
- // which is the signal we want.
12
- import { resolveRobots as nextResolveRobots } from 'next/dist/build/webpack/loaders/metadata/resolve-route-data';
13
- import { DEFAULT_ROBOTS_SETTINGS, type RobotsSettings } from '@nextblock-cms/utils/seo';
14
-
15
- import {
16
- buildRobotsMetadata,
17
- buildRobotsTxt,
18
- listUnservedCustomRuleLines,
19
- renderRobotsMetadata,
20
- type RobotsTxtOptions,
21
- } from './robots-txt';
22
-
23
- const LIVE: RobotsTxtOptions = { isSandbox: false, sitemapUrl: 'https://example.com/sitemap.xml' };
24
- const SANDBOX: RobotsTxtOptions = { isSandbox: true, sitemapUrl: 'https://example.com/sitemap.xml' };
25
-
26
- /** A settings object built from the shipped defaults plus whatever the test cares about. */
27
- function settings(overrides: Partial<RobotsSettings> = {}): RobotsSettings {
28
- return {
29
- customRules: DEFAULT_ROBOTS_SETTINGS.customRules,
30
- isIndexingEnabled: DEFAULT_ROBOTS_SETTINGS.isIndexingEnabled,
31
- sitemapEnabled: DEFAULT_ROBOTS_SETTINGS.sitemapEnabled,
32
- userAgentRules: [{ allow: ['/'], disallow: [], userAgent: '*' }],
33
- ...overrides,
34
- };
35
- }
36
-
37
- /** What Next would write to /robots.txt for these settings, produced by Next's own code. */
38
- function served(value: RobotsSettings, options: RobotsTxtOptions): string {
39
- return nextResolveRobots(buildRobotsMetadata(value, options));
40
- }
41
-
42
- describe('renderRobotsMetadata', () => {
43
- // buildRobotsTxt is only trustworthy because this renderer is Next's renderer. Each
44
- // case here pins one rendering rule that a hand-written formatter tends to get
45
- // wrong: the capitalised field name, the blank line after the final group, the
46
- // per-entry expansion of `other`, and the position of host/sitemap.
47
- const cases: Array<{ metadata: MetadataRoute.Robots; name: string }> = [
48
- { metadata: { rules: [{ allow: '/', userAgent: '*' }] }, name: 'a single permissive group' },
49
- {
50
- metadata: { rules: [{ disallow: ['/cms', '/api'], userAgent: ['GPTBot', 'CCBot'] }] },
51
- name: 'one group shared by several agents',
52
- },
53
- {
54
- metadata: {
55
- rules: [{ crawlDelay: 10, disallow: [''], userAgent: 'Bingbot' }],
56
- sitemap: ['https://example.com/sitemap.xml', 'https://example.com/news.xml'],
57
- },
58
- name: 'a crawl delay, an empty disallow and two sitemaps',
59
- },
60
- {
61
- metadata: {
62
- host: 'example.com',
63
- rules: [
64
- {
65
- other: { 'Clean-param': ['ref /articles/', 'utm_source /'], 'Request-Rate': '10/1m' },
66
- userAgent: 'Yandex',
67
- },
68
- ],
69
- },
70
- name: 'non-standard directives carried by `other`',
71
- },
72
- ];
73
-
74
- for (const { metadata, name } of cases) {
75
- it(`matches Next's serialiser for ${name}`, () => {
76
- expect(renderRobotsMetadata(metadata)).toBe(nextResolveRobots(metadata));
77
- });
78
- }
79
-
80
- it("emits Next's exact shape, blank trailing line and all", () => {
81
- expect(renderRobotsMetadata({ rules: [{ allow: '/', userAgent: '*' }] })).toBe(
82
- 'User-Agent: *\nAllow: /\n\n'
83
- );
84
- });
85
- });
86
-
87
- describe('buildRobotsTxt', () => {
88
- // The preview and the served file were once produced by two different formatters,
89
- // and the custom-rules block was the case where they disagreed: the preview showed
90
- // lines the metadata route could not carry, so an operator could read a directive
91
- // in the preview that no crawler ever received. Every case below asserts the
92
- // preview IS the served bytes, using Next's own serialiser as the reference.
93
- it('is byte-for-byte what Next serves for the default settings', () => {
94
- expect(buildRobotsTxt(settings(), LIVE)).toBe(served(settings(), LIVE));
95
- expect(buildRobotsTxt(settings(), LIVE)).toBe(
96
- 'User-Agent: *\nAllow: /\n\nSitemap: https://example.com/sitemap.xml\n'
97
- );
98
- });
99
-
100
- it('is byte-for-byte what Next serves when indexing is switched off', () => {
101
- const off = settings({
102
- isIndexingEnabled: false,
103
- userAgentRules: [{ allow: ['/'], disallow: ['/cms'], userAgent: '*' }],
104
- });
105
-
106
- expect(buildRobotsTxt(off, LIVE)).toBe(served(off, LIVE));
107
- // No sitemap either: advertising one next to a blanket disallow is a
108
- // self-contradicting file.
109
- expect(buildRobotsTxt(off, LIVE)).toBe('User-Agent: *\nDisallow: /\n\n');
110
- });
111
-
112
- it('is byte-for-byte what Next serves when the sitemap is switched off', () => {
113
- const noSitemap = settings({ sitemapEnabled: false });
114
-
115
- expect(buildRobotsTxt(noSitemap, LIVE)).toBe(served(noSitemap, LIVE));
116
- expect(buildRobotsTxt(noSitemap, LIVE)).toBe('User-Agent: *\nAllow: /\n\n');
117
- });
118
-
119
- it('is byte-for-byte what Next serves for multiple user agents', () => {
120
- const many = settings({
121
- sitemapEnabled: false,
122
- userAgentRules: [
123
- { allow: ['/', '/public'], disallow: ['/cms', '/api'], userAgent: '*' },
124
- { allow: [], disallow: ['/'], userAgent: 'GPTBot' },
125
- { allow: [], disallow: [], userAgent: 'Bingbot' },
126
- ],
127
- });
128
-
129
- expect(buildRobotsTxt(many, LIVE)).toBe(served(many, LIVE));
130
- expect(buildRobotsTxt(many, LIVE)).toBe(
131
- 'User-Agent: *\nAllow: /\nAllow: /public\nDisallow: /cms\nDisallow: /api\n\n' +
132
- 'User-Agent: GPTBot\nDisallow: /\n\n' +
133
- // A group with no paths at all emits an empty `Disallow` value — the
134
- // specified way of saying "nothing is disallowed" — because a group that is
135
- // nothing but its `User-agent:` header is malformed and some parsers discard
136
- // the groups after it.
137
- 'User-Agent: Bingbot\nDisallow: \n\n'
138
- );
139
- });
140
-
141
- it('is byte-for-byte what Next serves for a custom-rules block', () => {
142
- const custom = settings({
143
- customRules: ' User-agent: AhrefsBot\nDisallow: /\nCrawl-delay: 5 ',
144
- });
145
-
146
- expect(buildRobotsTxt(custom, LIVE)).toBe(served(custom, LIVE));
147
- expect(buildRobotsTxt(custom, LIVE)).toBe(
148
- 'User-Agent: *\nAllow: /\n\n' +
149
- 'User-Agent: AhrefsBot\nDisallow: /\nCrawl-delay: 5\n\n' +
150
- 'Sitemap: https://example.com/sitemap.xml\n'
151
- );
152
- });
153
-
154
- it('serves the non-standard directives it shows, via the per-rule `other` escape hatch', () => {
155
- // These are the lines that used to appear in the preview and vanish from the
156
- // file. `Clean-param`, `Request-rate` and a second `Sitemap` have no typed field
157
- // in `MetadataRoute.Robots`, so before the fix the metadata route dropped them.
158
- const custom = settings({
159
- customRules:
160
- 'User-agent: Yandex\nClean-param: ref /articles/\nClean-param: utm_source /\nHost: example.com',
161
- sitemapEnabled: false,
162
- });
163
-
164
- expect(buildRobotsTxt(custom, LIVE)).toBe(served(custom, LIVE));
165
- expect(buildRobotsTxt(custom, LIVE)).toBe(
166
- 'User-Agent: *\nAllow: /\n\n' +
167
- 'User-Agent: Yandex\nClean-param: ref /articles/\nClean-param: utm_source /\n' +
168
- 'Host: example.com\n\n'
169
- );
170
- });
171
-
172
- it('normalises CRLF in custom rules typed from a Windows browser', () => {
173
- const windows = settings({ customRules: 'Crawl-delay: 10\r\nDisallow: /tmp', sitemapEnabled: false });
174
-
175
- expect(buildRobotsTxt(windows, LIVE)).toBe(served(windows, LIVE));
176
- // The directives are re-ordered into Next's per-group order (paths, then crawl
177
- // delay) rather than the order they were typed. Robots groups are unordered sets
178
- // of directives so nothing changes for a crawler, and — the part that matters —
179
- // the operator sees the re-ordering, because this text is the file.
180
- expect(buildRobotsTxt(windows, LIVE)).toBe(
181
- 'User-Agent: *\nAllow: /\n\nUser-Agent: *\nDisallow: /tmp\nCrawl-delay: 10\n\n'
182
- );
183
- });
184
-
185
- it('falls back to the permissive wildcard when there are no rules', () => {
186
- // A file with no User-agent group is meaningless rather than strict, and
187
- // crawlers disagree about how to read one.
188
- const empty = settings({ sitemapEnabled: false, userAgentRules: [] });
189
-
190
- expect(buildRobotsTxt(empty, LIVE)).toBe(served(empty, LIVE));
191
- expect(buildRobotsTxt(empty, LIVE)).toBe('User-Agent: *\nAllow: /\n\n');
192
- });
193
-
194
- it('omits the sitemap when no site URL is known', () => {
195
- expect(buildRobotsTxt(settings(), { isSandbox: false, sitemapUrl: null })).toBe(
196
- 'User-Agent: *\nAllow: /\n\n'
197
- );
198
- expect(buildRobotsTxt(settings(), { isSandbox: false, sitemapUrl: ' ' })).toBe(
199
- 'User-Agent: *\nAllow: /\n\n'
200
- );
201
- });
202
-
203
- it('still appends custom rules while indexing is off', () => {
204
- const off = settings({ customRules: 'Allow: /.well-known/', isIndexingEnabled: false });
205
-
206
- expect(buildRobotsTxt(off, LIVE)).toBe(served(off, LIVE));
207
- expect(buildRobotsTxt(off, LIVE)).toBe(
208
- 'User-Agent: *\nDisallow: /\n\nUser-Agent: *\nAllow: /.well-known/\n\n'
209
- );
210
- });
211
-
212
- it('ignores every operator setting in the sandbox', () => {
213
- // The sandbox must stay crawlable so Googlebot can read the X-Robots-Tag
214
- // noindex it is served; a Disallow would block the fetch and leave URL-only
215
- // entries in the index forever. A sandbox visitor sharing the demo admin
216
- // login must not be able to cause that.
217
- const hostile = settings({
218
- customRules: 'Disallow: /everything',
219
- isIndexingEnabled: false,
220
- sitemapEnabled: true,
221
- userAgentRules: [{ allow: [], disallow: ['/'], userAgent: '*' }],
222
- });
223
-
224
- for (const value of [hostile, settings()]) {
225
- const text = buildRobotsTxt(value, SANDBOX);
226
- expect(text).toBe(served(value, SANDBOX));
227
- expect(text).toBe('User-Agent: *\nAllow: /\n\n');
228
- expect(text).not.toContain('Sitemap');
229
- expect(text).not.toContain('Disallow');
230
- }
231
- });
232
-
233
- it('always ends with a newline', () => {
234
- for (const options of [LIVE, SANDBOX]) {
235
- expect(buildRobotsTxt(settings(), options).endsWith('\n')).toBe(true);
236
- }
237
- });
238
- });
239
-
240
- describe('buildRobotsMetadata', () => {
241
- it('mirrors the text serializer for the default settings', () => {
242
- expect(buildRobotsMetadata(settings(), LIVE)).toEqual({
243
- rules: [{ allow: ['/'], userAgent: '*' }],
244
- sitemap: 'https://example.com/sitemap.xml',
245
- });
246
- });
247
-
248
- it('omits empty allow/disallow arrays rather than emitting them', () => {
249
- expect(
250
- buildRobotsMetadata(
251
- settings({ sitemapEnabled: false, userAgentRules: [{ allow: [], disallow: ['/cms'], userAgent: 'GPTBot' }] }),
252
- LIVE
253
- )
254
- ).toEqual({ rules: [{ disallow: ['/cms'], userAgent: 'GPTBot' }] });
255
- });
256
-
257
- it('collapses to a site-wide disallow with no sitemap when indexing is off', () => {
258
- expect(
259
- buildRobotsMetadata(
260
- settings({ isIndexingEnabled: false, userAgentRules: [{ allow: ['/'], disallow: [], userAgent: '*' }] }),
261
- LIVE
262
- )
263
- ).toEqual({ rules: [{ disallow: ['/'], userAgent: '*' }] });
264
- });
265
-
266
- it('holds the sandbox invariant just as the text serializer does', () => {
267
- expect(
268
- buildRobotsMetadata(settings({ isIndexingEnabled: false, customRules: 'Disallow: /' }), SANDBOX)
269
- ).toEqual({ rules: [{ allow: ['/'], userAgent: '*' }] });
270
- });
271
-
272
- it('carries the custom-rules block into the served object', () => {
273
- expect(
274
- buildRobotsMetadata(
275
- settings({
276
- customRules:
277
- '# a comment\nUser-agent: GPTBot\nDisallow: /\nCrawl-delay: 10\nRequest-rate: 1/10s',
278
- sitemapEnabled: false,
279
- }),
280
- LIVE
281
- )
282
- ).toEqual({
283
- rules: [
284
- { allow: ['/'], userAgent: '*' },
285
- {
286
- crawlDelay: 10,
287
- disallow: ['/'],
288
- other: { 'Request-rate': '1/10s' },
289
- userAgent: 'GPTBot',
290
- },
291
- ],
292
- });
293
- });
294
-
295
- it('keeps consecutive user-agent lines on one group and repeats a directive via an array', () => {
296
- expect(
297
- buildRobotsMetadata(
298
- settings({
299
- customRules: 'User-agent: GPTBot\nUser-agent: CCBot\nDisallow: /\nCrawl-delay: 2\nCrawl-delay: 4',
300
- sitemapEnabled: false,
301
- }),
302
- LIVE
303
- )
304
- ).toEqual({
305
- rules: [
306
- { allow: ['/'], userAgent: '*' },
307
- {
308
- crawlDelay: 2,
309
- disallow: ['/'],
310
- // The second crawl delay would be lost by the typed field, so it rides
311
- // `other` and reaches the file instead of disappearing.
312
- other: { 'Crawl-delay': '4' },
313
- userAgent: ['GPTBot', 'CCBot'],
314
- },
315
- ],
316
- });
317
- });
318
- });
319
-
320
- describe('listUnservedCustomRuleLines', () => {
321
- it('is empty when every line can be served', () => {
322
- expect(
323
- listUnservedCustomRuleLines(
324
- settings({ customRules: 'User-agent: GPTBot\nDisallow: /\nClean-param: ref /' }),
325
- LIVE
326
- )
327
- ).toEqual([]);
328
- });
329
-
330
- it('names the lines the served file cannot carry', () => {
331
- // Comments and lines that are not `name: value` at all have no representation in
332
- // `MetadataRoute.Robots`. No crawler acts on either, so the file loses nothing —
333
- // but the operator has to be told, because a line that silently disappears from a
334
- // preview reads as a bug and invites a retry.
335
- expect(
336
- listUnservedCustomRuleLines(
337
- settings({ customRules: '# block the scrapers\nnot a directive\nUser-agent:\nDisallow: /x' }),
338
- LIVE
339
- )
340
- ).toEqual(['# block the scrapers', 'not a directive', 'User-agent:']);
341
- });
342
-
343
- it('reports the whole block in the sandbox, where custom rules are inert', () => {
344
- expect(
345
- listUnservedCustomRuleLines(settings({ customRules: 'User-agent: GPTBot\nDisallow: /' }), SANDBOX)
346
- ).toEqual(['User-agent: GPTBot', 'Disallow: /']);
347
- });
348
-
349
- it('accounts for every custom line: each one is either served or reported', () => {
350
- // The property the preview depends on. A line that is neither in the file nor in
351
- // the unserved list is exactly the failure this module was fixed for.
352
- const customRules =
353
- '# note\nUser-agent: GPTBot\nDisallow: /private\nCrawl-delay: 3\nClean-param: ref /\nnonsense';
354
- const value = settings({ customRules, sitemapEnabled: false });
355
-
356
- // Compared case-insensitively because Next writes the canonical `User-Agent:`
357
- // capitalisation whatever the operator typed, and robots.txt field names are
358
- // case-insensitive (RFC 9309 §2.2), so that rewrite carries no meaning.
359
- const text = buildRobotsTxt(value, LIVE).toLowerCase();
360
- const unserved = listUnservedCustomRuleLines(value, LIVE);
361
-
362
- for (const line of customRules.split('\n')) {
363
- if (unserved.includes(line)) {
364
- expect(text).not.toContain(line.toLowerCase());
365
- } else {
366
- expect(text).toContain(line.toLowerCase());
367
- }
368
- }
369
- });
370
- });
1
+ import { describe, expect, it } from 'vitest';
2
+ import type { MetadataRoute } from 'next';
3
+ // The serialiser Next itself runs for a dynamic `robots.ts`: the route module the
4
+ // metadata loader generates is literally
5
+ // `const data = await handler(); const content = resolveRouteData(data, fileType)`,
6
+ // importing this exact specifier (see
7
+ // next/dist/build/webpack/loaders/next-metadata-route-loader.js). Importing it here
8
+ // rather than restating its behaviour is the point of these tests — the preview is
9
+ // only provably the served file if the comparison uses the real thing. If a Next
10
+ // upgrade moves or changes it, this import (or the assertions below) fail loudly,
11
+ // which is the signal we want.
12
+ import { resolveRobots as nextResolveRobots } from 'next/dist/build/webpack/loaders/metadata/resolve-route-data';
13
+ import { DEFAULT_ROBOTS_SETTINGS, type RobotsSettings } from '@nextblock-cms/utils/seo';
14
+
15
+ import {
16
+ buildRobotsMetadata,
17
+ buildRobotsTxt,
18
+ listUnservedCustomRuleLines,
19
+ renderRobotsMetadata,
20
+ type RobotsTxtOptions,
21
+ } from './robots-txt';
22
+
23
+ const LIVE: RobotsTxtOptions = { isSandbox: false, sitemapUrl: 'https://example.com/sitemap.xml' };
24
+ const SANDBOX: RobotsTxtOptions = { isSandbox: true, sitemapUrl: 'https://example.com/sitemap.xml' };
25
+
26
+ /** A settings object built from the shipped defaults plus whatever the test cares about. */
27
+ function settings(overrides: Partial<RobotsSettings> = {}): RobotsSettings {
28
+ return {
29
+ customRules: DEFAULT_ROBOTS_SETTINGS.customRules,
30
+ isIndexingEnabled: DEFAULT_ROBOTS_SETTINGS.isIndexingEnabled,
31
+ sitemapEnabled: DEFAULT_ROBOTS_SETTINGS.sitemapEnabled,
32
+ userAgentRules: [{ allow: ['/'], disallow: [], userAgent: '*' }],
33
+ ...overrides,
34
+ };
35
+ }
36
+
37
+ /** What Next would write to /robots.txt for these settings, produced by Next's own code. */
38
+ function served(value: RobotsSettings, options: RobotsTxtOptions): string {
39
+ return nextResolveRobots(buildRobotsMetadata(value, options));
40
+ }
41
+
42
+ describe('renderRobotsMetadata', () => {
43
+ // buildRobotsTxt is only trustworthy because this renderer is Next's renderer. Each
44
+ // case here pins one rendering rule that a hand-written formatter tends to get
45
+ // wrong: the capitalised field name, the blank line after the final group, the
46
+ // per-entry expansion of `other`, and the position of host/sitemap.
47
+ const cases: Array<{ metadata: MetadataRoute.Robots; name: string }> = [
48
+ { metadata: { rules: [{ allow: '/', userAgent: '*' }] }, name: 'a single permissive group' },
49
+ {
50
+ metadata: { rules: [{ disallow: ['/cms', '/api'], userAgent: ['GPTBot', 'CCBot'] }] },
51
+ name: 'one group shared by several agents',
52
+ },
53
+ {
54
+ metadata: {
55
+ rules: [{ crawlDelay: 10, disallow: [''], userAgent: 'Bingbot' }],
56
+ sitemap: ['https://example.com/sitemap.xml', 'https://example.com/news.xml'],
57
+ },
58
+ name: 'a crawl delay, an empty disallow and two sitemaps',
59
+ },
60
+ {
61
+ metadata: {
62
+ host: 'example.com',
63
+ rules: [
64
+ {
65
+ other: { 'Clean-param': ['ref /articles/', 'utm_source /'], 'Request-Rate': '10/1m' },
66
+ userAgent: 'Yandex',
67
+ },
68
+ ],
69
+ },
70
+ name: 'non-standard directives carried by `other`',
71
+ },
72
+ ];
73
+
74
+ for (const { metadata, name } of cases) {
75
+ it(`matches Next's serialiser for ${name}`, () => {
76
+ expect(renderRobotsMetadata(metadata)).toBe(nextResolveRobots(metadata));
77
+ });
78
+ }
79
+
80
+ it("emits Next's exact shape, blank trailing line and all", () => {
81
+ expect(renderRobotsMetadata({ rules: [{ allow: '/', userAgent: '*' }] })).toBe(
82
+ 'User-Agent: *\nAllow: /\n\n'
83
+ );
84
+ });
85
+ });
86
+
87
+ describe('buildRobotsTxt', () => {
88
+ // The preview and the served file were once produced by two different formatters,
89
+ // and the custom-rules block was the case where they disagreed: the preview showed
90
+ // lines the metadata route could not carry, so an operator could read a directive
91
+ // in the preview that no crawler ever received. Every case below asserts the
92
+ // preview IS the served bytes, using Next's own serialiser as the reference.
93
+ it('is byte-for-byte what Next serves for the default settings', () => {
94
+ expect(buildRobotsTxt(settings(), LIVE)).toBe(served(settings(), LIVE));
95
+ expect(buildRobotsTxt(settings(), LIVE)).toBe(
96
+ 'User-Agent: *\nAllow: /\n\nSitemap: https://example.com/sitemap.xml\n'
97
+ );
98
+ });
99
+
100
+ it('is byte-for-byte what Next serves when indexing is switched off', () => {
101
+ const off = settings({
102
+ isIndexingEnabled: false,
103
+ userAgentRules: [{ allow: ['/'], disallow: ['/cms'], userAgent: '*' }],
104
+ });
105
+
106
+ expect(buildRobotsTxt(off, LIVE)).toBe(served(off, LIVE));
107
+ // No sitemap either: advertising one next to a blanket disallow is a
108
+ // self-contradicting file.
109
+ expect(buildRobotsTxt(off, LIVE)).toBe('User-Agent: *\nDisallow: /\n\n');
110
+ });
111
+
112
+ it('is byte-for-byte what Next serves when the sitemap is switched off', () => {
113
+ const noSitemap = settings({ sitemapEnabled: false });
114
+
115
+ expect(buildRobotsTxt(noSitemap, LIVE)).toBe(served(noSitemap, LIVE));
116
+ expect(buildRobotsTxt(noSitemap, LIVE)).toBe('User-Agent: *\nAllow: /\n\n');
117
+ });
118
+
119
+ it('is byte-for-byte what Next serves for multiple user agents', () => {
120
+ const many = settings({
121
+ sitemapEnabled: false,
122
+ userAgentRules: [
123
+ { allow: ['/', '/public'], disallow: ['/cms', '/api'], userAgent: '*' },
124
+ { allow: [], disallow: ['/'], userAgent: 'GPTBot' },
125
+ { allow: [], disallow: [], userAgent: 'Bingbot' },
126
+ ],
127
+ });
128
+
129
+ expect(buildRobotsTxt(many, LIVE)).toBe(served(many, LIVE));
130
+ expect(buildRobotsTxt(many, LIVE)).toBe(
131
+ 'User-Agent: *\nAllow: /\nAllow: /public\nDisallow: /cms\nDisallow: /api\n\n' +
132
+ 'User-Agent: GPTBot\nDisallow: /\n\n' +
133
+ // A group with no paths at all emits an empty `Disallow` value — the
134
+ // specified way of saying "nothing is disallowed" — because a group that is
135
+ // nothing but its `User-agent:` header is malformed and some parsers discard
136
+ // the groups after it.
137
+ 'User-Agent: Bingbot\nDisallow: \n\n'
138
+ );
139
+ });
140
+
141
+ it('is byte-for-byte what Next serves for a custom-rules block', () => {
142
+ const custom = settings({
143
+ customRules: ' User-agent: AhrefsBot\nDisallow: /\nCrawl-delay: 5 ',
144
+ });
145
+
146
+ expect(buildRobotsTxt(custom, LIVE)).toBe(served(custom, LIVE));
147
+ expect(buildRobotsTxt(custom, LIVE)).toBe(
148
+ 'User-Agent: *\nAllow: /\n\n' +
149
+ 'User-Agent: AhrefsBot\nDisallow: /\nCrawl-delay: 5\n\n' +
150
+ 'Sitemap: https://example.com/sitemap.xml\n'
151
+ );
152
+ });
153
+
154
+ it('serves the non-standard directives it shows, via the per-rule `other` escape hatch', () => {
155
+ // These are the lines that used to appear in the preview and vanish from the
156
+ // file. `Clean-param`, `Request-rate` and a second `Sitemap` have no typed field
157
+ // in `MetadataRoute.Robots`, so before the fix the metadata route dropped them.
158
+ const custom = settings({
159
+ customRules:
160
+ 'User-agent: Yandex\nClean-param: ref /articles/\nClean-param: utm_source /\nHost: example.com',
161
+ sitemapEnabled: false,
162
+ });
163
+
164
+ expect(buildRobotsTxt(custom, LIVE)).toBe(served(custom, LIVE));
165
+ expect(buildRobotsTxt(custom, LIVE)).toBe(
166
+ 'User-Agent: *\nAllow: /\n\n' +
167
+ 'User-Agent: Yandex\nClean-param: ref /articles/\nClean-param: utm_source /\n' +
168
+ 'Host: example.com\n\n'
169
+ );
170
+ });
171
+
172
+ it('normalises CRLF in custom rules typed from a Windows browser', () => {
173
+ const windows = settings({ customRules: 'Crawl-delay: 10\r\nDisallow: /tmp', sitemapEnabled: false });
174
+
175
+ expect(buildRobotsTxt(windows, LIVE)).toBe(served(windows, LIVE));
176
+ // The directives are re-ordered into Next's per-group order (paths, then crawl
177
+ // delay) rather than the order they were typed. Robots groups are unordered sets
178
+ // of directives so nothing changes for a crawler, and — the part that matters —
179
+ // the operator sees the re-ordering, because this text is the file.
180
+ expect(buildRobotsTxt(windows, LIVE)).toBe(
181
+ 'User-Agent: *\nAllow: /\n\nUser-Agent: *\nDisallow: /tmp\nCrawl-delay: 10\n\n'
182
+ );
183
+ });
184
+
185
+ it('falls back to the permissive wildcard when there are no rules', () => {
186
+ // A file with no User-agent group is meaningless rather than strict, and
187
+ // crawlers disagree about how to read one.
188
+ const empty = settings({ sitemapEnabled: false, userAgentRules: [] });
189
+
190
+ expect(buildRobotsTxt(empty, LIVE)).toBe(served(empty, LIVE));
191
+ expect(buildRobotsTxt(empty, LIVE)).toBe('User-Agent: *\nAllow: /\n\n');
192
+ });
193
+
194
+ it('omits the sitemap when no site URL is known', () => {
195
+ expect(buildRobotsTxt(settings(), { isSandbox: false, sitemapUrl: null })).toBe(
196
+ 'User-Agent: *\nAllow: /\n\n'
197
+ );
198
+ expect(buildRobotsTxt(settings(), { isSandbox: false, sitemapUrl: ' ' })).toBe(
199
+ 'User-Agent: *\nAllow: /\n\n'
200
+ );
201
+ });
202
+
203
+ it('still appends custom rules while indexing is off', () => {
204
+ const off = settings({ customRules: 'Allow: /.well-known/', isIndexingEnabled: false });
205
+
206
+ expect(buildRobotsTxt(off, LIVE)).toBe(served(off, LIVE));
207
+ expect(buildRobotsTxt(off, LIVE)).toBe(
208
+ 'User-Agent: *\nDisallow: /\n\nUser-Agent: *\nAllow: /.well-known/\n\n'
209
+ );
210
+ });
211
+
212
+ it('ignores every operator setting in the sandbox', () => {
213
+ // The sandbox must stay crawlable so Googlebot can read the X-Robots-Tag
214
+ // noindex it is served; a Disallow would block the fetch and leave URL-only
215
+ // entries in the index forever. A sandbox visitor sharing the demo admin
216
+ // login must not be able to cause that.
217
+ const hostile = settings({
218
+ customRules: 'Disallow: /everything',
219
+ isIndexingEnabled: false,
220
+ sitemapEnabled: true,
221
+ userAgentRules: [{ allow: [], disallow: ['/'], userAgent: '*' }],
222
+ });
223
+
224
+ for (const value of [hostile, settings()]) {
225
+ const text = buildRobotsTxt(value, SANDBOX);
226
+ expect(text).toBe(served(value, SANDBOX));
227
+ expect(text).toBe('User-Agent: *\nAllow: /\n\n');
228
+ expect(text).not.toContain('Sitemap');
229
+ expect(text).not.toContain('Disallow');
230
+ }
231
+ });
232
+
233
+ it('always ends with a newline', () => {
234
+ for (const options of [LIVE, SANDBOX]) {
235
+ expect(buildRobotsTxt(settings(), options).endsWith('\n')).toBe(true);
236
+ }
237
+ });
238
+ });
239
+
240
+ describe('buildRobotsMetadata', () => {
241
+ it('mirrors the text serializer for the default settings', () => {
242
+ expect(buildRobotsMetadata(settings(), LIVE)).toEqual({
243
+ rules: [{ allow: ['/'], userAgent: '*' }],
244
+ sitemap: 'https://example.com/sitemap.xml',
245
+ });
246
+ });
247
+
248
+ it('omits empty allow/disallow arrays rather than emitting them', () => {
249
+ expect(
250
+ buildRobotsMetadata(
251
+ settings({ sitemapEnabled: false, userAgentRules: [{ allow: [], disallow: ['/cms'], userAgent: 'GPTBot' }] }),
252
+ LIVE
253
+ )
254
+ ).toEqual({ rules: [{ disallow: ['/cms'], userAgent: 'GPTBot' }] });
255
+ });
256
+
257
+ it('collapses to a site-wide disallow with no sitemap when indexing is off', () => {
258
+ expect(
259
+ buildRobotsMetadata(
260
+ settings({ isIndexingEnabled: false, userAgentRules: [{ allow: ['/'], disallow: [], userAgent: '*' }] }),
261
+ LIVE
262
+ )
263
+ ).toEqual({ rules: [{ disallow: ['/'], userAgent: '*' }] });
264
+ });
265
+
266
+ it('holds the sandbox invariant just as the text serializer does', () => {
267
+ expect(
268
+ buildRobotsMetadata(settings({ isIndexingEnabled: false, customRules: 'Disallow: /' }), SANDBOX)
269
+ ).toEqual({ rules: [{ allow: ['/'], userAgent: '*' }] });
270
+ });
271
+
272
+ it('carries the custom-rules block into the served object', () => {
273
+ expect(
274
+ buildRobotsMetadata(
275
+ settings({
276
+ customRules:
277
+ '# a comment\nUser-agent: GPTBot\nDisallow: /\nCrawl-delay: 10\nRequest-rate: 1/10s',
278
+ sitemapEnabled: false,
279
+ }),
280
+ LIVE
281
+ )
282
+ ).toEqual({
283
+ rules: [
284
+ { allow: ['/'], userAgent: '*' },
285
+ {
286
+ crawlDelay: 10,
287
+ disallow: ['/'],
288
+ other: { 'Request-rate': '1/10s' },
289
+ userAgent: 'GPTBot',
290
+ },
291
+ ],
292
+ });
293
+ });
294
+
295
+ it('keeps consecutive user-agent lines on one group and repeats a directive via an array', () => {
296
+ expect(
297
+ buildRobotsMetadata(
298
+ settings({
299
+ customRules: 'User-agent: GPTBot\nUser-agent: CCBot\nDisallow: /\nCrawl-delay: 2\nCrawl-delay: 4',
300
+ sitemapEnabled: false,
301
+ }),
302
+ LIVE
303
+ )
304
+ ).toEqual({
305
+ rules: [
306
+ { allow: ['/'], userAgent: '*' },
307
+ {
308
+ crawlDelay: 2,
309
+ disallow: ['/'],
310
+ // The second crawl delay would be lost by the typed field, so it rides
311
+ // `other` and reaches the file instead of disappearing.
312
+ other: { 'Crawl-delay': '4' },
313
+ userAgent: ['GPTBot', 'CCBot'],
314
+ },
315
+ ],
316
+ });
317
+ });
318
+ });
319
+
320
+ describe('listUnservedCustomRuleLines', () => {
321
+ it('is empty when every line can be served', () => {
322
+ expect(
323
+ listUnservedCustomRuleLines(
324
+ settings({ customRules: 'User-agent: GPTBot\nDisallow: /\nClean-param: ref /' }),
325
+ LIVE
326
+ )
327
+ ).toEqual([]);
328
+ });
329
+
330
+ it('names the lines the served file cannot carry', () => {
331
+ // Comments and lines that are not `name: value` at all have no representation in
332
+ // `MetadataRoute.Robots`. No crawler acts on either, so the file loses nothing —
333
+ // but the operator has to be told, because a line that silently disappears from a
334
+ // preview reads as a bug and invites a retry.
335
+ expect(
336
+ listUnservedCustomRuleLines(
337
+ settings({ customRules: '# block the scrapers\nnot a directive\nUser-agent:\nDisallow: /x' }),
338
+ LIVE
339
+ )
340
+ ).toEqual(['# block the scrapers', 'not a directive', 'User-agent:']);
341
+ });
342
+
343
+ it('reports the whole block in the sandbox, where custom rules are inert', () => {
344
+ expect(
345
+ listUnservedCustomRuleLines(settings({ customRules: 'User-agent: GPTBot\nDisallow: /' }), SANDBOX)
346
+ ).toEqual(['User-agent: GPTBot', 'Disallow: /']);
347
+ });
348
+
349
+ it('accounts for every custom line: each one is either served or reported', () => {
350
+ // The property the preview depends on. A line that is neither in the file nor in
351
+ // the unserved list is exactly the failure this module was fixed for.
352
+ const customRules =
353
+ '# note\nUser-agent: GPTBot\nDisallow: /private\nCrawl-delay: 3\nClean-param: ref /\nnonsense';
354
+ const value = settings({ customRules, sitemapEnabled: false });
355
+
356
+ // Compared case-insensitively because Next writes the canonical `User-Agent:`
357
+ // capitalisation whatever the operator typed, and robots.txt field names are
358
+ // case-insensitive (RFC 9309 §2.2), so that rewrite carries no meaning.
359
+ const text = buildRobotsTxt(value, LIVE).toLowerCase();
360
+ const unserved = listUnservedCustomRuleLines(value, LIVE);
361
+
362
+ for (const line of customRules.split('\n')) {
363
+ if (unserved.includes(line)) {
364
+ expect(text).not.toContain(line.toLowerCase());
365
+ } else {
366
+ expect(text).toContain(line.toLowerCase());
367
+ }
368
+ }
369
+ });
370
+ });