@nuxtjs/sitemap 8.1.0 → 8.2.1

package/dist/devtools/components/sitemap/Source.vue

@@ -0,0 +1,148 @@
+<script setup lang="ts">
+import type { SitemapSourceResolved } from '../../lib/sitemap/types'
+import { joinURL } from 'ufo'
+import { computed } from 'vue'
+import { data } from '../../lib/sitemap/state'
+
+const props = defineProps<{ source: SitemapSourceResolved, showContext?: boolean }>()
+
+const fetchUrl = computed(() => {
+  const url = typeof props.source.fetch === 'string' ? props.source.fetch : props.source.fetch![0]
+  if (url.includes('http'))
+    return url
+  return joinURL(data.value?.nitroOrigin || 'localhost', url)
+})
+
+function normaliseTip(tip: string) {
+  return tip.replace(/`([^`]+)`/g, '<code>$1</code>')
+}
+</script>
+
+<template>
+  <DevtoolsSection :class="source.error ? 'source-error' : ''">
+    <template #text>
+      <div class="flex items-center gap-3">
+        <div
+          v-if="source.fetch"
+          class="flex items-center gap-1.5"
+        >
+          <UIcon
+            name="carbon:api-1"
+            class="text-[var(--color-text-muted)]"
+          />
+          <DevtoolsMetric
+            v-if="source.timeTakenMs"
+            :value="source.timeTakenMs"
+            label="ms"
+            variant="info"
+          />
+        </div>
+        <span class="font-semibold">{{ source.context.name }}</span>
+        <DevtoolsMetric
+          :value="source.urls?.length || 0"
+          label="URLs"
+          :variant="source.error ? 'danger' : !source.urls?.length ? 'warning' : 'success'"
+        />
+      </div>
+    </template>
+    <template #description>
+      <div class="flex items-center gap-3">
+        <a
+          v-if="source.fetch"
+          :href="fetchUrl"
+          target="_blank"
+          class="link-external text-sm"
+        >
+          {{ source.fetch }}
+        </a>
+        <span
+          v-if="source.context.description"
+          class="text-xs text-[var(--color-text-muted)]"
+        >
+          {{ source.context.description }}
+        </span>
+      </div>
+    </template>
+    <DevtoolsAlert
+      v-if="source.error"
+      variant="error"
+    >
+      {{ source.error }}
+    </DevtoolsAlert>
+    <template v-else>
+      <DevtoolsAlert
+        v-if="source._urlWarnings?.length"
+        variant="warning"
+      >
+        <div>
+          <div class="text-xs font-semibold mb-1">
+            {{ source._urlWarnings.length }} URL warning{{ source._urlWarnings.length > 1 ? 's' : '' }}
+          </div>
+          <ul class="url-warnings-list">
+            <li
+              v-for="(w, i) in source._urlWarnings"
+              :key="i"
+            >
+              <code>{{ w.loc }}</code> — {{ w.message }}
+            </li>
+          </ul>
+        </div>
+      </DevtoolsAlert>
+      <DevtoolsSnippet
+        :code="JSON.stringify(source.urls, null, 2)"
+        lang="json"
+        label="URLs"
+      />
+    </template>
+    <DevtoolsAlert
+      v-if="source.context.tips?.length"
+      :variant="!source.urls?.length && !source.error ? 'warning' : 'info'"
+    >
+      <div>
+        <h3 class="text-xs font-semibold mb-1.5 text-[var(--color-text)] uppercase tracking-wide opacity-70">
+          Hints
+        </h3>
+        <ul class="space-y-1">
+          <li
+            v-for="(tip, key) in source.context.tips"
+            :key="key"
+            class="text-sm text-[var(--color-text-muted)] leading-relaxed"
+            v-html="normaliseTip(tip)"
+          />
+        </ul>
+      </div>
+    </DevtoolsAlert>
+  </DevtoolsSection>
+</template>
+
+<style scoped>
+.source-error {
+  border-color: oklch(55% 0.15 25 / 0.35);
+}
+
+.source-error:hover {
+  border-color: oklch(55% 0.15 25 / 0.5);
+}
+
+.url-warnings-list {
+  list-style: none;
+  padding: 0;
+  margin: 0;
+  font-size: 0.6875rem;
+  line-height: 1.5;
+  color: var(--color-text-muted);
+}
+
+.url-warnings-list li {
+  padding: 0.125rem 0;
+}
+
+.url-warnings-list code {
+  font-family: var(--font-mono);
+  font-size: 0.625rem;
+  padding: 0.0625rem 0.3125rem;
+  border-radius: 3px;
+  background: var(--color-surface-sunken);
+  color: var(--color-text);
+}
+</style>

package/dist/devtools/lib/sitemap/rpc.ts

@@ -0,0 +1,5 @@
+import { useDevtoolsConnection } from 'nuxtseo-layer-devtools/composables/rpc'
+
+// The layer refreshes data on connect and on every host route change, so sitemap
+// needs no module-level host access.
+useDevtoolsConnection()

package/dist/devtools/lib/sitemap/state.ts

@@ -0,0 +1,71 @@
+import type { ModuleRuntimeConfig, ProductionDebugResponse, SitemapDefinition, SitemapSourceResolved } from './types'
+import { appFetch } from 'nuxtseo-layer-devtools/composables/rpc'
+import { isProductionMode, productionUrl, refreshTime } from 'nuxtseo-layer-devtools/composables/state'
+import { ref, watch } from 'vue'
+
+export const data = ref<{
+  nitroOrigin: string
+  globalSources: SitemapSourceResolved[]
+  sitemaps: SitemapDefinition[]
+  runtimeConfig: ModuleRuntimeConfig
+  siteConfig?: { url?: string }
+} | null>(null)
+
+// Production debug data from the remote /__sitemap__/debug.json (requires debug: true in production)
+export const productionRemoteDebugData = ref<typeof data.value | null>(null)
+
+export const productionData = ref<ProductionDebugResponse | null>(null)
+export const productionLoading = ref(false)
+
+export async function refreshSources() {
+  if (!appFetch.value)
+    return
+  data.value = await appFetch.value('/__sitemap__/debug.json').catch((err) => {
+    console.error('Failed to fetch sitemap debug data:', err)
+    return null
+  }) as typeof data.value
+}
+
+export async function refreshProductionData() {
+  if (!appFetch.value || !productionUrl.value)
+    return
+  productionLoading.value = true
+  productionRemoteDebugData.value = null
+
+  // Try fetching the full debug endpoint from production first (proxied through local server)
+  const remoteDebug = await appFetch.value('/__sitemap__/debug-production.json', {
+    query: { url: productionUrl.value, mode: 'debug' },
+  }).catch(() => null) as (typeof data.value & { error?: string }) | null
+  if (remoteDebug && !remoteDebug.error && remoteDebug.sitemaps && !Array.isArray(remoteDebug.sitemaps)) {
+    // Response has object sitemaps (debug.json format) rather than array (XML fallback format)
+    productionRemoteDebugData.value = remoteDebug
+    productionLoading.value = false
+    return
+  }
+
+  // Fall back to XML-based validation
+  productionData.value = await appFetch.value('/__sitemap__/debug-production.json', {
+    query: { url: productionUrl.value },
+  }).catch((err: Error) => {
+    console.error('Failed to fetch production sitemap data:', err)
+    return null
+  }) as ProductionDebugResponse | null
+  productionLoading.value = false
+}
+
+// Re-fetch the (global) debug data when the host connects or a manual refresh fires
+watch([appFetch, refreshTime], () => {
+  refreshSources()
+})
+
+// Sync production URL from siteConfig when debug data loads
+watch(data, (val) => {
+  if (val?.siteConfig?.url)
+    productionUrl.value = val.siteConfig.url
+}, { immediate: true })
+
+// Fetch production data when switching to production mode
+watch(isProductionMode, (isProd) => {
+  if (isProd && !productionData.value && !productionRemoteDebugData.value)
+    refreshProductionData()
+})

package/dist/devtools/lib/sitemap/types.ts

@@ -0,0 +1,2 @@
+export type { ProductionDebugResponse } from '../../../src/runtime/server/routes/__sitemap__/debug-production'
+export type { ModuleRuntimeConfig, SitemapDefinition, SitemapSourceResolved } from '../../../src/runtime/types'

package/dist/devtools/nuxt.config.ts

@@ -0,0 +1,7 @@
+import { resolve } from 'pathe'
+
+// Nuxt SEO devtools panel, shipped as a layer (Model C). Components flat-registered
+// so intra-panel references resolve by name.
+export default defineNuxtConfig({
+  components: [{ path: resolve(__dirname, './components'), pathPrefix: false }],
+})

package/dist/devtools/pages/sitemap/app-sources.vue

@@ -0,0 +1,33 @@
+<script setup lang="ts">
+import { computed } from 'vue'
+import Source from '../../components/sitemap/Source.vue'
+import { data } from '../../lib/sitemap/state'
+
+const appSources = computed(() => (data.value?.globalSources || []).filter(s => s.sourceType === 'app'))
+</script>
+
+<template>
+  <div class="space-y-5 animate-fade-up">
+    <div>
+      <h2 class="text-lg font-semibold mb-1">
+        App Sources
+      </h2>
+      <p class="text-xs text-[var(--color-text-muted)]">
+        Automatic global sources generated from your application.
+      </p>
+    </div>
+    <template v-if="appSources.length">
+      <Source
+        v-for="(source, key) in appSources"
+        :key="key"
+        :source="source"
+      />
+    </template>
+    <DevtoolsEmptyState
+      v-else
+      title="No app sources detected"
+      description="App sources are automatically discovered from your Nuxt application routes and pages."
+      icon="carbon:bot"
+    />
+  </div>
+</template>

package/dist/devtools/pages/sitemap/debug.vue

@@ -0,0 +1,21 @@
+<script setup lang="ts">
+import { data } from '../../lib/sitemap/state'
+</script>
+
+<template>
+  <div class="space-y-5 animate-fade-up">
+    <DevtoolsSection>
+      <template #text>
+        <h3 class="opacity-80 text-base mb-1">
+          <UIcon name="carbon:settings" class="mr-1" />
+          Runtime Config
+        </h3>
+      </template>
+      <DevtoolsSnippet
+        :code="JSON.stringify(data?.runtimeConfig, null, 2)"
+        lang="json"
+        label="Runtime Config"
+      />
+    </DevtoolsSection>
+  </div>
+</template>

package/dist/devtools/pages/sitemap/docs.vue

@@ -0,0 +1,3 @@
+<template>
+  <DevtoolsDocs url="https://nuxtseo.com/sitemap" />
+</template>

package/dist/devtools/pages/sitemap/index.vue

@@ -0,0 +1,456 @@
+<script setup lang="ts">
+import type { SitemapDefinition, SitemapSourceResolved } from '../../lib/sitemap/types'
+import { isProductionMode, productionUrl } from 'nuxtseo-layer-devtools/composables/state'
+import { joinURL } from 'ufo'
+import { computed } from 'vue'
+import Source from '../../components/sitemap/Source.vue'
+import { data, productionData, productionLoading, productionRemoteDebugData, refreshProductionData } from '../../lib/sitemap/state'
+
+const appSourcesExcluded = computed(() => data.value?.runtimeConfig?.excludeAppSources || [])
+
+function resolveSitemapOrigin() {
+  if (isProductionMode.value && productionUrl.value)
+    return `${productionUrl.value.replace(/\/$/, '')}/`
+  return data.value?.nitroOrigin || ''
+}
+
+function resolveSitemapPath(sitemapName: string) {
+  const source = productionRemoteDebugData.value || data.value
+  if (!source)
+    return ''
+  const prefix = source.runtimeConfig?.sitemapsPathPrefix || ''
+  if (sitemapName === 'sitemap' || sitemapName === 'sitemap.xml')
+    return '/sitemap.xml'
+  if (sitemapName === 'index')
+    return '/sitemap_index.xml'
+  return joinURL('/', prefix, `${sitemapName}-sitemap.xml`)
+}
+
+function resolveSitemapUrl(sitemapName: string) {
+  return `${resolveSitemapOrigin()}${resolveSitemapPath(sitemapName).replace(/^\//, '')}`
+}
+
+function resolveSitemapOptions(definition: SitemapDefinition) {
+  const options: Record<string, any> = {}
+  Object.entries(definition).forEach(([key, value]) => {
+    if (value !== undefined && (!Array.isArray(value) || value.length > 0) && key !== 'includeAppSources')
+      options[key] = value
+  })
+  return options
+}
+
+function sitemapOptionsAsKeyValues(definition: SitemapDefinition) {
+  const options = resolveSitemapOptions(definition)
+  return Object.entries(options).map(([key, value]) => {
+    const isObject = typeof value === 'object'
+    return {
+      key,
+      value: isObject ? JSON.stringify(value, null, 2) : value,
+      mono: true,
+      code: isObject ? 'json' as const : undefined,
+    }
+  })
+}
+
+function sitemapPathFromUrl(url: string) {
+  try {
+    return new URL(url).pathname
+  }
+  catch {
+    return url
+  }
+}
+
+const hasRemoteDebug = computed(() => !!productionRemoteDebugData.value)
+
+const totalProductionUrls = computed(() =>
+  productionData.value?.sitemaps.reduce((sum, s) => sum + s.urlCount, 0) ?? 0,
+)
+
+const totalProductionWarnings = computed(() =>
+  productionData.value?.sitemaps.reduce((sum, s) => sum + s.warnings.length, 0) ?? 0,
+)
+</script>
+
+<template>
+  <div class="space-y-5 animate-fade-up">
+    <!-- Production mode -->
+    <template v-if="isProductionMode">
+      <div class="flex items-center justify-between">
+        <div>
+          <h2 class="text-lg font-semibold mb-1">
+            Production Sitemaps
+          </h2>
+          <p class="text-xs text-[var(--color-text-muted)]">
+            Fetched from {{ productionUrl }}<template v-if="hasRemoteDebug">
+              with debug mode enabled
+            </template>.
+          </p>
+        </div>
+        <UButton
+          icon="carbon:reset"
+          size="xs"
+          variant="ghost"
+          :loading="productionLoading"
+          @click="refreshProductionData()"
+        >
+          Re-validate
+        </UButton>
+      </div>
+
+      <DevtoolsLoading v-if="productionLoading && !productionData && !productionRemoteDebugData" />
+
+      <!-- Full debug view (production has debug: true) -->
+      <template v-if="hasRemoteDebug">
+        <DevtoolsSection
+          v-for="(sitemap, key) in productionRemoteDebugData!.sitemaps"
+          :key="key"
+        >
+          <template #text>
+            <div class="flex items-center gap-2">
+              <span class="font-semibold">{{ sitemap.sitemapName }}</span>
+              <a
+                target="_blank"
+                :href="resolveSitemapUrl(sitemap.sitemapName)"
+                class="link-external text-xs font-mono text-[var(--color-text-muted)]"
+              >
+                {{ resolveSitemapPath(sitemap.sitemapName) }}
+              </a>
+              <UIcon
+                v-if="(sitemap.sources || []).some(s => typeof s !== 'string' && 'error' in s && !!s.error)"
+                name="carbon:warning"
+                class="text-red-500"
+              />
+              <UIcon
+                v-else-if="(sitemap.sources || []).some(s => typeof s !== 'string' && '_urlWarnings' in s && s._urlWarnings?.length)"
+                name="carbon:warning-alt"
+                class="text-amber-500"
+              />
+            </div>
+          </template>
+          <div class="space-y-5">
+            <template v-if="sitemap.sitemapName === 'index'">
+              <DevtoolsAlert variant="info">
+                Links to your other sitemaps.
+                <a
+                  href="https://developers.google.com/search/docs/crawling-indexing/sitemaps/large-sitemaps"
+                  target="_blank"
+                  class="link-external"
+                >
+                  Learn more
+                </a>
+              </DevtoolsAlert>
+            </template>
+            <template v-else>
+              <div
+                v-if="sitemap.sources && sitemap.sources.length"
+                class="flex gap-4"
+              >
+                <div class="w-32 flex-shrink-0">
+                  <div class="font-semibold text-sm">
+                    Sources
+                  </div>
+                </div>
+                <div class="flex-grow space-y-2">
+                  <Source
+                    v-for="(source, k) in (sitemap.sources as SitemapSourceResolved[])"
+                    :key="k"
+                    :source="source"
+                  />
+                </div>
+              </div>
+              <div class="flex gap-4">
+                <div class="w-32 flex-shrink-0">
+                  <div class="font-semibold text-sm">
+                    Options
+                  </div>
+                </div>
+                <div class="flex-grow">
+                  <DevtoolsKeyValue
+                    :items="sitemapOptionsAsKeyValues(sitemap)"
+                    striped
+                  />
+                </div>
+              </div>
+            </template>
+          </div>
+        </DevtoolsSection>
+      </template>
+
+      <!-- XML-based fallback view -->
+      <template v-else-if="productionData?.error">
+        <DevtoolsProductionError :error="productionData.error" />
+      </template>
+
+      <template v-else-if="productionData">
+        <!-- Summary -->
+        <div class="flex items-center gap-4">
+          <DevtoolsMetric
+            :value="productionData.sitemaps.length"
+            :label="productionData.isIndex ? 'child sitemaps' : 'sitemap'"
+            variant="info"
+          />
+          <DevtoolsMetric
+            :value="totalProductionUrls"
+            label="total URLs"
+            variant="success"
+          />
+          <DevtoolsMetric
+            v-if="totalProductionWarnings > 0"
+            :value="totalProductionWarnings"
+            label="warnings"
+            variant="warning"
+          />
+        </div>
+
+        <!-- Each production sitemap -->
+        <DevtoolsSection
+          v-for="(sitemap, i) in productionData.sitemaps"
+          :key="i"
+        >
+          <template #text>
+            <div class="flex items-center gap-2">
+              <span class="font-semibold">{{ sitemapPathFromUrl(sitemap.loc) }}</span>
+              <DevtoolsMetric
+                :value="sitemap.urlCount"
+                label="URLs"
+                variant="success"
+              />
+              <UIcon
+                v-if="sitemap.error"
+                name="carbon:warning"
+                class="text-red-500"
+              />
+              <UIcon
+                v-else-if="sitemap.warnings.length"
+                name="carbon:warning-alt"
+                class="text-amber-500"
+              />
+            </div>
+          </template>
+          <template #description>
+            <a
+              :href="sitemap.loc"
+              target="_blank"
+              class="link-external text-xs font-mono text-[var(--color-text-muted)]"
+            >
+              {{ sitemap.loc }}
+            </a>
+          </template>
+          <div v-if="sitemap.error || sitemap.warnings.length" class="space-y-3">
+            <DevtoolsAlert
+              v-if="sitemap.error"
+              variant="warning"
+            >
+              {{ sitemap.error }}
+            </DevtoolsAlert>
+            <DevtoolsAlert
+              v-if="sitemap.warnings.length"
+              variant="warning"
+            >
+              <div>
+                <div class="text-xs font-semibold mb-1">
+                  {{ sitemap.warnings.length }} validation warning{{ sitemap.warnings.length > 1 ? 's' : '' }}
+                </div>
+                <ul class="prod-warnings-list">
+                  <li
+                    v-for="(w, wi) in sitemap.warnings"
+                    :key="wi"
+                  >
+                    <template v-if="w.context?.url">
+                      <code>{{ w.context.url }}</code>:
+                    </template>
+                    {{ w.message }}
+                  </li>
+                </ul>
+              </div>
+            </DevtoolsAlert>
+          </div>
+        </DevtoolsSection>
+
+        <!-- Hint about debug mode -->
+        <DevtoolsAlert variant="info">
+          Want to see full source details and URL validation? Deploy with <code>sitemap: { debug: true }</code> to get the same detailed view as development mode.
+        </DevtoolsAlert>
+      </template>
+    </template>
+
+    <!-- Local mode -->
+    <template v-else>
+      <div>
+        <h2 class="text-lg font-semibold mb-1">
+          Sitemaps
+        </h2>
+        <p class="text-xs text-[var(--color-text-muted)]">
+          The sitemaps generated from your site.
+        </p>
+      </div>
+      <DevtoolsSection
+        v-for="(sitemap, key) in data?.sitemaps"
+        :key="key"
+      >
+        <template #text>
+          <div class="flex items-center gap-2">
+            <span class="font-semibold">{{ sitemap.sitemapName }}</span>
+            <a
+              target="_blank"
+              :href="resolveSitemapUrl(sitemap.sitemapName)"
+              class="link-external text-xs font-mono text-[var(--color-text-muted)]"
+            >
+              {{ resolveSitemapPath(sitemap.sitemapName) }}
+            </a>
+            <UIcon
+              v-if="(sitemap.sources || []).some(s => typeof s !== 'string' && 'error' in s && !!s.error)"
+              name="carbon:warning"
+              class="text-red-500"
+            />
+            <UIcon
+              v-else-if="(sitemap.sources || []).some(s => typeof s !== 'string' && '_urlWarnings' in s && s._urlWarnings?.length)"
+              name="carbon:warning-alt"
+              class="text-amber-500"
+            />
+          </div>
+        </template>
+        <div class="space-y-5">
+          <template v-if="sitemap.sitemapName === 'index'">
+            <DevtoolsAlert variant="info">
+              Links to your other sitemaps.
+              <a
+                href="https://developers.google.com/search/docs/crawling-indexing/sitemaps/large-sitemaps"
+                target="_blank"
+                class="link-external"
+              >
+                Learn more
+              </a>
+            </DevtoolsAlert>
+          </template>
+          <template v-else>
+            <div
+              v-if="sitemap.sources && sitemap.sources.length"
+              class="flex gap-4"
+            >
+              <div class="w-32 flex-shrink-0">
+                <div class="font-semibold text-sm">
+                  Sources
+                </div>
+              </div>
+              <div class="flex-grow space-y-2">
+                <Source
+                  v-for="(source, k) in (sitemap.sources as SitemapSourceResolved[])"
+                  :key="k"
+                  :source="source"
+                />
+              </div>
+            </div>
+            <div class="flex gap-4">
+              <div class="w-32 flex-shrink-0">
+                <div class="font-semibold text-sm">
+                  App Sources
+                </div>
+              </div>
+              <div class="flex-grow flex items-center gap-3">
+                <div
+                  v-if="sitemap.includeAppSources && appSourcesExcluded !== true"
+                  class="status-enabled"
+                >
+                  <UIcon
+                    name="carbon:checkmark"
+                    class="text-sm"
+                  />
+                  <span>Enabled</span>
+                </div>
+                <div
+                  v-else
+                  class="status-disabled"
+                >
+                  <UIcon
+                    name="carbon:close"
+                    class="text-sm"
+                  />
+                  <span>Disabled</span>
+                </div>
+                <NuxtLink
+                  to="/app-sources"
+                  class="text-xs text-[var(--seo-green)] hover:underline"
+                >
+                  View details
+                </NuxtLink>
+              </div>
+            </div>
+            <div class="flex gap-4">
+              <div class="w-32 flex-shrink-0">
+                <div class="font-semibold text-sm">
+                  Options
+                </div>
+              </div>
+              <div class="flex-grow">
+                <DevtoolsKeyValue
+                  :items="sitemapOptionsAsKeyValues(sitemap)"
+                  striped
+                />
+              </div>
+            </div>
+          </template>
+        </div>
+      </DevtoolsSection>
+    </template>
+  </div>
+</template>
+
+<style scoped>
+.status-enabled {
+  display: inline-flex;
+  align-items: center;
+  gap: 0.375rem;
+  padding: 0.25rem 0.625rem;
+  font-size: 0.75rem;
+  font-weight: 500;
+  border-radius: var(--radius-sm);
+  background: oklch(75% 0.15 145 / 0.12);
+  color: oklch(50% 0.15 145);
+}
+
+.dark .status-enabled {
+  background: oklch(50% 0.15 145 / 0.15);
+  color: oklch(75% 0.18 145);
+}
+
+.status-disabled {
+  display: inline-flex;
+  align-items: center;
+  gap: 0.375rem;
+  padding: 0.25rem 0.625rem;
+  font-size: 0.75rem;
+  font-weight: 500;
+  border-radius: var(--radius-sm);
+  background: oklch(65% 0.12 25 / 0.1);
+  color: oklch(55% 0.15 25);
+}
+
+.dark .status-disabled {
+  background: oklch(45% 0.1 25 / 0.15);
+  color: oklch(70% 0.12 25);
+}
+
+.prod-warnings-list {
+  list-style: none;
+  padding: 0;
+  margin: 0;
+  font-size: 0.6875rem;
+  line-height: 1.5;
+  color: var(--color-text-muted);
+}
+
+.prod-warnings-list li {
+  padding: 0.125rem 0;
+}
+
+.prod-warnings-list code {
+  font-family: var(--font-mono);
+  font-size: 0.625rem;
+  padding: 0.0625rem 0.3125rem;
+  border-radius: 3px;
+  background: var(--color-surface-sunken);
+  color: var(--color-text);
+}
+</style>

package/dist/devtools/pages/sitemap/user-sources.vue

@@ -0,0 +1,33 @@
+<script setup lang="ts">
+import { computed } from 'vue'
+import Source from '../../components/sitemap/Source.vue'
+import { data } from '../../lib/sitemap/state'
+
+const userSources = computed(() => (data.value?.globalSources || []).filter(s => s.sourceType === 'user'))
+</script>
+
+<template>
+  <div class="space-y-5 animate-fade-up">
+    <div>
+      <h2 class="text-lg font-semibold mb-1">
+        User Sources
+      </h2>
+      <p class="text-xs text-[var(--color-text-muted)]">
+        Manually provided global sources provided by you.
+      </p>
+    </div>
+    <template v-if="userSources.length">
+      <Source
+        v-for="(source, key) in userSources"
+        :key="key"
+        :source="source"
+      />
+    </template>
+    <DevtoolsEmptyState
+      v-else
+      title="No user sources configured"
+      description="Add custom sources via the sources option in your sitemap config."
+      icon="carbon:add-alt"
+    />
+  </div>
+</template>

package/dist/devtools/pages/sitemap.vue

@@ -0,0 +1,72 @@
+<script setup lang="ts">
+import { loadShiki } from 'nuxtseo-layer-devtools/composables/shiki'
+import { isProductionMode } from 'nuxtseo-layer-devtools/composables/state'
+import { computed, ref, watch } from 'vue'
+import { navigateTo, useRoute } from '#imports'
+import { data, productionData, productionRemoteDebugData, refreshProductionData, refreshSources } from '../lib/sitemap/state'
+import '../lib/sitemap/rpc'
+
+await loadShiki()
+
+const refreshing = ref(false)
+
+async function refresh() {
+  if (refreshing.value)
+    return
+  refreshing.value = true
+  data.value = null
+  productionData.value = null
+  productionRemoteDebugData.value = null
+  await refreshSources()
+  if (isProductionMode.value)
+    await refreshProductionData()
+  setTimeout(() => {
+    refreshing.value = false
+  }, 300)
+}
+
+const route = useRoute()
+const currentTab = computed(() => {
+  const path = route.path
+  if (path.startsWith('/sitemap/user-sources'))
+    return 'user-sources'
+  if (path.startsWith('/sitemap/app-sources'))
+    return 'app-sources'
+  if (path.startsWith('/sitemap/debug'))
+    return 'debug'
+  if (path.startsWith('/sitemap/docs'))
+    return 'docs'
+  return 'sitemaps'
+})
+
+const navItems = [
+  { value: 'sitemaps', to: '/sitemap', icon: 'carbon:load-balancer-application', label: 'Sitemaps', devOnly: false },
+  { value: 'user-sources', to: '/sitemap/user-sources', icon: 'carbon:group-account', label: 'User Sources', devOnly: true },
+  { value: 'app-sources', to: '/sitemap/app-sources', icon: 'carbon:bot', label: 'App Sources', devOnly: true },
+  { value: 'debug', to: '/sitemap/debug', icon: 'carbon:debug', label: 'Debug', devOnly: true },
+  { value: 'docs', to: '/sitemap/docs', icon: 'carbon:book', label: 'Docs', devOnly: false },
+]
+
+const runtimeVersion = computed(() => data.value?.runtimeConfig?.version)
+
+watch(isProductionMode, (isProd) => {
+  if (isProd && ['user-sources', 'app-sources', 'debug'].includes(currentTab.value))
+    return navigateTo('/sitemap')
+})
+</script>
+
+<template>
+  <DevtoolsLayout
+    v-model:active-tab="currentTab"
+    module-name="sitemap"
+    title="Sitemap"
+    icon="carbon:load-balancer-application"
+    :version="runtimeVersion"
+    :nav-items="navItems"
+    github-url="https://github.com/nuxt-modules/sitemap"
+    :loading="!data?.globalSources || refreshing"
+    @refresh="refresh"
+  >
+    <NuxtPage />
+  </DevtoolsLayout>
+</template>

package/dist/module.json

@@ -4,7 +4,7 @@
     "nuxt": ">=3.9.0"
   },
   "configKey": "sitemap",
-  "version": "8.1.0",
+  "version": "8.2.1",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"

package/dist/module.mjs

@@ -75,6 +75,7 @@ export async function readSourcesFromFilesystem(filename) {
       if (!route.fileName?.endsWith(".html") || !html || ["/200.html", "/404.html"].includes(route.route))
         return;
       if (NuxtRedirectHtmlRegex.test(html)) {
+        route._sitemap = { loc: route.route, _sitemap: false };
         return;
       }
       const extractedMeta = parseHtmlExtractSitemapMeta(html, {
@@ -1128,7 +1129,13 @@ ${onUrlEntries.join("\n")}`;
       const nitro = await nitroPromise;
       const prerenderedRoutes2 = nitro._prerenderedRoutes || [];
       const prerenderUrlsFinal = [
-        ...prerenderedRoutes2.filter(isValidPrerenderRoute).map((r) => r._sitemap).filter((entry) => entry && (typeof entry === "string" || entry._sitemap !== false))
+        ...prerenderedRoutes2.filter(isValidPrerenderRoute).map((r) => {
+          if (r._sitemap)
+            return r._sitemap;
+          if (r.route.startsWith("/api/") || r.route.startsWith("/_"))
+            return void 0;
+          return { loc: r.route };
+        }).filter((entry) => entry && (typeof entry === "string" || entry._sitemap !== false))
       ];
       if (config.debug) {
         logger.info("Prerendered routes:", prerenderUrlsFinal);

package/dist/runtime/server/sitemap/builder/sitemap.js

@@ -3,7 +3,7 @@ import { defineCachedFunction, useRuntimeConfig } from "nitropack/runtime";
 import { resolveSitePath } from "nuxt-site-config/urls";
 import { joinURL, withHttps } from "ufo";
 import staticConfig from "#sitemap-virtual/static-config.mjs";
-import { applyDynamicParams, createPathFilter, findPageMapping, logger, splitForLocales } from "../../../utils-pure.js";
+import { applyDynamicParams, createPathFilter, findPageMapping, logger, resolveI18nSitemapLocaleKey, splitForLocales } from "../../../utils-pure.js";
 import { preNormalizeEntry } from "../urlset/normalise.js";
 import { sortInPlace } from "../urlset/sort.js";
 import { childSitemapSources, globalSitemapSources, resolveSitemapSources } from "../urlset/sources.js";
@@ -189,11 +189,12 @@ export async function buildResolvedSitemapUrls(effectiveSitemap, matchName, isCh
   };
   await nitro?.hooks.callHook("sitemap:input", resolvedCtx);
   const enhancedUrls = resolveSitemapEntries(effectiveSitemap, resolvedCtx.urls, { autoI18n, isI18nMapped }, resolvers, useRuntimeConfig().app.baseURL);
+  const localeSitemapKeys = isI18nMapped && autoI18n ? autoI18n.locales.map((l) => l._sitemap) : [];
   if (isMultiSitemap) {
     const sitemapNames = Object.keys(sitemaps).filter((k) => k !== "index");
     const warnedSitemaps = nitro?._sitemapWarnedSitemaps || /* @__PURE__ */ new Set();
     for (const e of enhancedUrls) {
-      const hasMatchingSitemap = typeof e._sitemap === "string" && (sitemapNames.includes(e._sitemap) || isI18nMapped && sitemapNames.some((name) => name.startsWith(`${e._sitemap}-`)));
+      const hasMatchingSitemap = typeof e._sitemap === "string" && (sitemapNames.includes(e._sitemap) || isI18nMapped && sitemapNames.some((name) => resolveI18nSitemapLocaleKey(name, localeSitemapKeys) === e._sitemap));
       if (typeof e._sitemap === "string" && !hasMatchingSitemap) {
         if (!warnedSitemaps.has(e._sitemap)) {
           warnedSitemaps.add(e._sitemap);
@@ -211,7 +212,11 @@ export async function buildResolvedSitemapUrls(effectiveSitemap, matchName, isCh
     if (isMultiSitemap && e._sitemap && matchName) {
       if (isChunked)
         return e._sitemap === matchName;
-      return e._sitemap === matchName || isI18nMapped && matchName.startsWith(`${e._sitemap}-`);
+      if (e._sitemap === matchName)
+        return true;
+      if (isI18nMapped)
+        return e._sitemap === resolveI18nSitemapLocaleKey(matchName, localeSitemapKeys);
+      return false;
     }
     return true;
   });

package/dist/runtime/utils-pure.d.ts

@@ -3,6 +3,16 @@ export { createFilter, type CreateFilterOptions } from 'nuxtseo-shared/utils';
 export declare const logger: import("consola").ConsolaInstance;
 export declare function mergeOnKey<T, K extends keyof T>(arr: T[], key: K): T[];
 export declare function splitForLocales(path: string, locales: string[]): [string | null, string];
+/**
+ * Resolve which locale a multi-sitemap name belongs to.
+ *
+ * i18n-mapped sitemaps are named either `<localeSitemap>` (default) or
+ * `<localeSitemap>-<name>` (custom sitemaps). Locale `_sitemap` keys can share a
+ * prefix (e.g. `zh` and `zh-Hant`), so a naive `name.startsWith(`${key}-`)` check
+ * collides: `zh-Hant` would match the `zh` locale. Resolve by the longest matching
+ * key to disambiguate.
+ */
+export declare function resolveI18nSitemapLocaleKey(sitemapName: string, localeSitemapKeys: string[]): string | null;
 /**
  * Transform a literal notation string regex to RegExp
  */

package/dist/runtime/utils-pure.js

@@ -36,6 +36,16 @@ export function splitForLocales(path, locales) {
     return [prefix, path.replace(`/${prefix}`, "")];
   return [null, path];
 }
+export function resolveI18nSitemapLocaleKey(sitemapName, localeSitemapKeys) {
+  let best = null;
+  for (const key of localeSitemapKeys) {
+    if (sitemapName === key || sitemapName.startsWith(`${key}-`)) {
+      if (best === null || key.length > best.length)
+        best = key;
+    }
+  }
+  return best;
+}
 const StringifiedRegExpPattern = /\/(.*?)\/([gimsuy]*)$/;
 export function normalizeRuntimeFilters(input) {
   return (input || []).map((rule) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nuxtjs/sitemap",
   "type": "module",
-  "version": "8.1.0",
+  "version": "8.2.1",
   "description": "Powerfully flexible XML Sitemaps that integrate seamlessly, for Nuxt.",
   "author": {
     "name": "Harlan Wilton",
@@ -55,12 +55,12 @@
     }
   },
   "dependencies": {
-    "@nuxt/kit": "^4.4.7",
+    "@nuxt/kit": "^4.4.8",
     "consola": "^3.4.2",
     "defu": "^6.1.7",
     "fast-xml-parser": "^5.8.0",
-    "nuxt-site-config": "^4.0.8",
-    "nuxtseo-shared": "^5.1.4",
+    "nuxt-site-config": "^4.1.0",
+    "nuxtseo-shared": "^5.3.0",
     "ofetch": "^1.5.1",
     "pathe": "^2.0.3",
     "pkg-types": "^2.3.1",
@@ -72,7 +72,7 @@
     "@antfu/eslint-config": "^9.0.0",
     "@arethetypeswrong/cli": "^0.18.3",
     "@nuxt/content": "^3.14.0",
-    "@nuxt/devtools-kit": "4.0.0-alpha.3",
+    "@nuxt/devtools-kit": "4.0.0-alpha.7",
     "@nuxt/module-builder": "^1.0.2",
     "@nuxt/test-utils": "^4.0.3",
     "@nuxt/ui": "^4.8.2",
@@ -85,10 +85,10 @@
     "eslint-plugin-harlanzw": "^0.17.0",
     "execa": "^9.6.1",
     "happy-dom": "^20.10.2",
-    "nuxt": "^4.4.7",
+    "nuxt": "^4.4.8",
     "nuxt-i18n-micro": "^3.18.2",
-    "nuxtseo-layer-devtools": "^5.1.4",
-    "semver": "^7.8.3",
+    "nuxtseo-layer-devtools": "^5.3.0",
+    "semver": "^7.8.4",
     "sirv": "^3.0.2",
     "std-env": "^4.1.0",
     "typescript": "^6.0.3",
@@ -96,18 +96,17 @@
     "vitest": "^4.1.8",
     "vue-tsc": "^3.3.4",
     "zod": "^4.4.3",
-    "@nuxtjs/sitemap": "8.1.0"
+    "@nuxtjs/sitemap": "8.2.1"
   },
   "scripts": {
     "lint": "eslint .",
     "lint:fix": "eslint . --fix",
-    "client:build": "nuxt generate devtools",
-    "devtools": "nuxt dev devtools --port 3030",
+    "client:build": "node -e \"const { cpSync } = require('fs'); const { sep } = require('path'); cpSync('devtools','dist/devtools',{recursive:true,filter:src=>!src.split(sep).some(p=>['.data','.nuxt','node_modules'].includes(p))})\"",
     "build": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxt-module-build build && npm run client:build",
     "dev": "nuxt dev playground",
     "prepare:fixtures": "nuxt prepare test/fixtures/basic && nuxt prepare test/fixtures/i18n && nuxt prepare test/fixtures/i18n-micro",
     "dev:build": "nuxt build playground",
-    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxt prepare playground",
+    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxt prepare playground && pnpm run client:build",
     "release": "pnpm build && bumpp -x \"npx changelogen --output=CHANGELOG.md\"",
     "test": "vitest run && pnpm run test:attw",
     "test:unit": "vitest --project=unit",