@nuxtjs/sitemap 7.5.1 → 7.6.0

package/dist/content.d.mts

@@ -1,11 +1,15 @@
-import { Collection } from '@nuxt/content';
+import { PageCollectionItemBase, Collection } from '@nuxt/content';
 import { z, TypeOf } from 'zod';
 
+declare global {
+    var __sitemapCollectionFilters: Map<string, (entry: any) => boolean> | undefined;
+    var __sitemapCollectionOnUrlFns: Map<string, (url: any, entry: any, collection: string) => void> | undefined;
+}
 declare const schema: z.ZodObject<{
     sitemap: z.ZodOptional<z.ZodObject<{
         loc: z.ZodOptional<z.ZodString>;
         lastmod: z.ZodOptional<z.ZodDate>;
-        changefreq: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"always">, z.ZodLiteral<"hourly">, z.ZodLiteral<"daily">, z.ZodLiteral<"weekly">, z.ZodLiteral<"monthly">, z.ZodLiteral<"yearly">, z.ZodLiteral<"never">]>>;
+        changefreq: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"always">, z.ZodLiteral<"hourly">, z.ZodLiteral<"daily">, z.ZodLiteral<"weekly">, z.ZodLiteral<"monthly">, z.ZodLiteral<"yearly">, z.ZodLiteral<"never">]>>;
         priority: z.ZodOptional<z.ZodNumber>;
         images: z.ZodOptional<z.ZodArray<z.ZodObject<{
             loc: z.ZodString;
@@ -13,19 +17,7 @@ declare const schema: z.ZodObject<{
             geo_location: z.ZodOptional<z.ZodString>;
             title: z.ZodOptional<z.ZodString>;
             license: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            loc: string;
-            caption?: string | undefined;
-            geo_location?: string | undefined;
-            title?: string | undefined;
-            license?: string | undefined;
-        }, {
-            loc: string;
-            caption?: string | undefined;
-            geo_location?: string | undefined;
-            title?: string | undefined;
-            license?: string | undefined;
-        }>, "many">>;
+        }, z.core.$strip>>>;
         videos: z.ZodOptional<z.ZodArray<z.ZodObject<{
             content_loc: z.ZodString;
             player_loc: z.ZodOptional<z.ZodString>;
@@ -40,192 +32,62 @@ declare const schema: z.ZodObject<{
             restriction: z.ZodOptional<z.ZodObject<{
                 relationship: z.ZodOptional<z.ZodLiteral<"allow">>;
                 value: z.ZodOptional<z.ZodString>;
-            }, "strip", z.ZodTypeAny, {
-                value?: string | undefined;
-                relationship?: "allow" | undefined;
-            }, {
-                value?: string | undefined;
-                relationship?: "allow" | undefined;
-            }>>;
+            }, z.core.$strip>>;
             gallery_loc: z.ZodOptional<z.ZodString>;
             price: z.ZodOptional<z.ZodString>;
             requires_subscription: z.ZodOptional<z.ZodBoolean>;
             uploader: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            content_loc: string;
-            player_loc?: string | undefined;
-            duration?: string | undefined;
-            expiration_date?: Date | undefined;
-            rating?: number | undefined;
-            view_count?: number | undefined;
-            publication_date?: Date | undefined;
-            family_friendly?: boolean | undefined;
-            tag?: string | undefined;
-            category?: string | undefined;
-            restriction?: {
-                value?: string | undefined;
-                relationship?: "allow" | undefined;
-            } | undefined;
-            gallery_loc?: string | undefined;
-            price?: string | undefined;
-            requires_subscription?: boolean | undefined;
-            uploader?: string | undefined;
-        }, {
-            content_loc: string;
-            player_loc?: string | undefined;
-            duration?: string | undefined;
-            expiration_date?: Date | undefined;
-            rating?: number | undefined;
-            view_count?: number | undefined;
-            publication_date?: Date | undefined;
-            family_friendly?: boolean | undefined;
-            tag?: string | undefined;
-            category?: string | undefined;
-            restriction?: {
-                value?: string | undefined;
-                relationship?: "allow" | undefined;
-            } | undefined;
-            gallery_loc?: string | undefined;
-            price?: string | undefined;
-            requires_subscription?: boolean | undefined;
-            uploader?: string | undefined;
-        }>, "many">>;
-    }, "strip", z.ZodTypeAny, {
-        loc?: string | undefined;
-        lastmod?: Date | undefined;
-        changefreq?: "never" | "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | undefined;
-        priority?: number | undefined;
-        images?: {
-            loc: string;
-            caption?: string | undefined;
-            geo_location?: string | undefined;
-            title?: string | undefined;
-            license?: string | undefined;
-        }[] | undefined;
-        videos?: {
-            content_loc: string;
-            player_loc?: string | undefined;
-            duration?: string | undefined;
-            expiration_date?: Date | undefined;
-            rating?: number | undefined;
-            view_count?: number | undefined;
-            publication_date?: Date | undefined;
-            family_friendly?: boolean | undefined;
-            tag?: string | undefined;
-            category?: string | undefined;
-            restriction?: {
-                value?: string | undefined;
-                relationship?: "allow" | undefined;
-            } | undefined;
-            gallery_loc?: string | undefined;
-            price?: string | undefined;
-            requires_subscription?: boolean | undefined;
-            uploader?: string | undefined;
-        }[] | undefined;
-    }, {
-        loc?: string | undefined;
-        lastmod?: Date | undefined;
-        changefreq?: "never" | "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | undefined;
-        priority?: number | undefined;
-        images?: {
-            loc: string;
-            caption?: string | undefined;
-            geo_location?: string | undefined;
-            title?: string | undefined;
-            license?: string | undefined;
-        }[] | undefined;
-        videos?: {
-            content_loc: string;
-            player_loc?: string | undefined;
-            duration?: string | undefined;
-            expiration_date?: Date | undefined;
-            rating?: number | undefined;
-            view_count?: number | undefined;
-            publication_date?: Date | undefined;
-            family_friendly?: boolean | undefined;
-            tag?: string | undefined;
-            category?: string | undefined;
-            restriction?: {
-                value?: string | undefined;
-                relationship?: "allow" | undefined;
-            } | undefined;
-            gallery_loc?: string | undefined;
-            price?: string | undefined;
-            requires_subscription?: boolean | undefined;
-            uploader?: string | undefined;
-        }[] | undefined;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    sitemap?: {
-        loc?: string | undefined;
-        lastmod?: Date | undefined;
-        changefreq?: "never" | "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | undefined;
-        priority?: number | undefined;
-        images?: {
-            loc: string;
-            caption?: string | undefined;
-            geo_location?: string | undefined;
-            title?: string | undefined;
-            license?: string | undefined;
-        }[] | undefined;
-        videos?: {
-            content_loc: string;
-            player_loc?: string | undefined;
-            duration?: string | undefined;
-            expiration_date?: Date | undefined;
-            rating?: number | undefined;
-            view_count?: number | undefined;
-            publication_date?: Date | undefined;
-            family_friendly?: boolean | undefined;
-            tag?: string | undefined;
-            category?: string | undefined;
-            restriction?: {
-                value?: string | undefined;
-                relationship?: "allow" | undefined;
-            } | undefined;
-            gallery_loc?: string | undefined;
-            price?: string | undefined;
-            requires_subscription?: boolean | undefined;
-            uploader?: string | undefined;
-        }[] | undefined;
-    } | undefined;
-}, {
-    sitemap?: {
-        loc?: string | undefined;
-        lastmod?: Date | undefined;
-        changefreq?: "never" | "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | undefined;
-        priority?: number | undefined;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+type SitemapSchema = TypeOf<typeof schema>;
+interface AsSitemapCollectionOptions<TEntry = Record<string, unknown>> {
+    /**
+     * Collection name. Must match the key in your collections object.
+     * Required when using `filter` or `onUrl`.
+     * @example
+     * collections: {
+     *   blog: defineCollection(asSitemapCollection({...}, { name: 'blog', filter: ... }))
+     * }
+     */
+    name?: string;
+    /**
+     * Runtime filter function to exclude entries from sitemap.
+     * Receives the full content entry including all schema fields.
+     * Requires `name` parameter to be set.
+     * @example
+     * { name: 'blog', filter: (entry) => !entry.draft && new Date(entry.date) <= new Date() }
+     */
+    filter?: (entry: PageCollectionItemBase & SitemapSchema & TEntry) => boolean;
+    /**
+     * Transform the sitemap URL entry for each item in this collection.
+     * Mutate `url` directly to change `loc`, `lastmod`, `priority`, etc.
+     * The full content entry and collection name are provided for context.
+     * Useful when the collection uses `prefix: ''` in its source config,
+     * which strips the directory prefix from content paths.
+     * Requires `name` parameter to be set.
+     * @example
+     * // Add a locale prefix
+     * { name: 'content_zh', onUrl: (url) => { url.loc = `/zh${url.loc}` } }
+     * @example
+     * // Use content entry fields to set priority
+     * { name: 'blog', onUrl: (url, entry) => { url.priority = entry.featured ? 1.0 : 0.5 } }
+     */
+    onUrl?: (url: {
+        loc: string;
+        lastmod?: string | Date;
+        changefreq?: string;
+        priority?: number;
         images?: {
             loc: string;
-            caption?: string | undefined;
-            geo_location?: string | undefined;
-            title?: string | undefined;
-            license?: string | undefined;
-        }[] | undefined;
+        }[];
         videos?: {
             content_loc: string;
-            player_loc?: string | undefined;
-            duration?: string | undefined;
-            expiration_date?: Date | undefined;
-            rating?: number | undefined;
-            view_count?: number | undefined;
-            publication_date?: Date | undefined;
-            family_friendly?: boolean | undefined;
-            tag?: string | undefined;
-            category?: string | undefined;
-            restriction?: {
-                value?: string | undefined;
-                relationship?: "allow" | undefined;
-            } | undefined;
-            gallery_loc?: string | undefined;
-            price?: string | undefined;
-            requires_subscription?: boolean | undefined;
-            uploader?: string | undefined;
-        }[] | undefined;
-    } | undefined;
-}>;
-type SitemapSchema = TypeOf<typeof schema>;
-declare function asSitemapCollection<T>(collection: Collection<T>): Collection<T>;
+        }[];
+        [key: string]: unknown;
+    }, entry: PageCollectionItemBase & SitemapSchema & TEntry, collection: string) => void;
+}
+declare function asSitemapCollection<T>(collection: Collection<T>, options?: AsSitemapCollectionOptions<T>): Collection<T>;
 
 export { asSitemapCollection, schema };
-export type { SitemapSchema };
+export type { AsSitemapCollectionOptions, SitemapSchema };

package/dist/content.d.ts

@@ -1,11 +1,15 @@
-import { Collection } from '@nuxt/content';
+import { PageCollectionItemBase, Collection } from '@nuxt/content';
 import { z, TypeOf } from 'zod';
 
+declare global {
+    var __sitemapCollectionFilters: Map<string, (entry: any) => boolean> | undefined;
+    var __sitemapCollectionOnUrlFns: Map<string, (url: any, entry: any, collection: string) => void> | undefined;
+}
 declare const schema: z.ZodObject<{
     sitemap: z.ZodOptional<z.ZodObject<{
         loc: z.ZodOptional<z.ZodString>;
         lastmod: z.ZodOptional<z.ZodDate>;
-        changefreq: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"always">, z.ZodLiteral<"hourly">, z.ZodLiteral<"daily">, z.ZodLiteral<"weekly">, z.ZodLiteral<"monthly">, z.ZodLiteral<"yearly">, z.ZodLiteral<"never">]>>;
+        changefreq: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"always">, z.ZodLiteral<"hourly">, z.ZodLiteral<"daily">, z.ZodLiteral<"weekly">, z.ZodLiteral<"monthly">, z.ZodLiteral<"yearly">, z.ZodLiteral<"never">]>>;
         priority: z.ZodOptional<z.ZodNumber>;
         images: z.ZodOptional<z.ZodArray<z.ZodObject<{
             loc: z.ZodString;
@@ -13,19 +17,7 @@ declare const schema: z.ZodObject<{
             geo_location: z.ZodOptional<z.ZodString>;
             title: z.ZodOptional<z.ZodString>;
             license: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            loc: string;
-            caption?: string | undefined;
-            geo_location?: string | undefined;
-            title?: string | undefined;
-            license?: string | undefined;
-        }, {
-            loc: string;
-            caption?: string | undefined;
-            geo_location?: string | undefined;
-            title?: string | undefined;
-            license?: string | undefined;
-        }>, "many">>;
+        }, z.core.$strip>>>;
         videos: z.ZodOptional<z.ZodArray<z.ZodObject<{
             content_loc: z.ZodString;
             player_loc: z.ZodOptional<z.ZodString>;
@@ -40,192 +32,62 @@ declare const schema: z.ZodObject<{
             restriction: z.ZodOptional<z.ZodObject<{
                 relationship: z.ZodOptional<z.ZodLiteral<"allow">>;
                 value: z.ZodOptional<z.ZodString>;
-            }, "strip", z.ZodTypeAny, {
-                value?: string | undefined;
-                relationship?: "allow" | undefined;
-            }, {
-                value?: string | undefined;
-                relationship?: "allow" | undefined;
-            }>>;
+            }, z.core.$strip>>;
             gallery_loc: z.ZodOptional<z.ZodString>;
             price: z.ZodOptional<z.ZodString>;
             requires_subscription: z.ZodOptional<z.ZodBoolean>;
             uploader: z.ZodOptional<z.ZodString>;
-        }, "strip", z.ZodTypeAny, {
-            content_loc: string;
-            player_loc?: string | undefined;
-            duration?: string | undefined;
-            expiration_date?: Date | undefined;
-            rating?: number | undefined;
-            view_count?: number | undefined;
-            publication_date?: Date | undefined;
-            family_friendly?: boolean | undefined;
-            tag?: string | undefined;
-            category?: string | undefined;
-            restriction?: {
-                value?: string | undefined;
-                relationship?: "allow" | undefined;
-            } | undefined;
-            gallery_loc?: string | undefined;
-            price?: string | undefined;
-            requires_subscription?: boolean | undefined;
-            uploader?: string | undefined;
-        }, {
-            content_loc: string;
-            player_loc?: string | undefined;
-            duration?: string | undefined;
-            expiration_date?: Date | undefined;
-            rating?: number | undefined;
-            view_count?: number | undefined;
-            publication_date?: Date | undefined;
-            family_friendly?: boolean | undefined;
-            tag?: string | undefined;
-            category?: string | undefined;
-            restriction?: {
-                value?: string | undefined;
-                relationship?: "allow" | undefined;
-            } | undefined;
-            gallery_loc?: string | undefined;
-            price?: string | undefined;
-            requires_subscription?: boolean | undefined;
-            uploader?: string | undefined;
-        }>, "many">>;
-    }, "strip", z.ZodTypeAny, {
-        loc?: string | undefined;
-        lastmod?: Date | undefined;
-        changefreq?: "never" | "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | undefined;
-        priority?: number | undefined;
-        images?: {
-            loc: string;
-            caption?: string | undefined;
-            geo_location?: string | undefined;
-            title?: string | undefined;
-            license?: string | undefined;
-        }[] | undefined;
-        videos?: {
-            content_loc: string;
-            player_loc?: string | undefined;
-            duration?: string | undefined;
-            expiration_date?: Date | undefined;
-            rating?: number | undefined;
-            view_count?: number | undefined;
-            publication_date?: Date | undefined;
-            family_friendly?: boolean | undefined;
-            tag?: string | undefined;
-            category?: string | undefined;
-            restriction?: {
-                value?: string | undefined;
-                relationship?: "allow" | undefined;
-            } | undefined;
-            gallery_loc?: string | undefined;
-            price?: string | undefined;
-            requires_subscription?: boolean | undefined;
-            uploader?: string | undefined;
-        }[] | undefined;
-    }, {
-        loc?: string | undefined;
-        lastmod?: Date | undefined;
-        changefreq?: "never" | "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | undefined;
-        priority?: number | undefined;
-        images?: {
-            loc: string;
-            caption?: string | undefined;
-            geo_location?: string | undefined;
-            title?: string | undefined;
-            license?: string | undefined;
-        }[] | undefined;
-        videos?: {
-            content_loc: string;
-            player_loc?: string | undefined;
-            duration?: string | undefined;
-            expiration_date?: Date | undefined;
-            rating?: number | undefined;
-            view_count?: number | undefined;
-            publication_date?: Date | undefined;
-            family_friendly?: boolean | undefined;
-            tag?: string | undefined;
-            category?: string | undefined;
-            restriction?: {
-                value?: string | undefined;
-                relationship?: "allow" | undefined;
-            } | undefined;
-            gallery_loc?: string | undefined;
-            price?: string | undefined;
-            requires_subscription?: boolean | undefined;
-            uploader?: string | undefined;
-        }[] | undefined;
-    }>>;
-}, "strip", z.ZodTypeAny, {
-    sitemap?: {
-        loc?: string | undefined;
-        lastmod?: Date | undefined;
-        changefreq?: "never" | "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | undefined;
-        priority?: number | undefined;
-        images?: {
-            loc: string;
-            caption?: string | undefined;
-            geo_location?: string | undefined;
-            title?: string | undefined;
-            license?: string | undefined;
-        }[] | undefined;
-        videos?: {
-            content_loc: string;
-            player_loc?: string | undefined;
-            duration?: string | undefined;
-            expiration_date?: Date | undefined;
-            rating?: number | undefined;
-            view_count?: number | undefined;
-            publication_date?: Date | undefined;
-            family_friendly?: boolean | undefined;
-            tag?: string | undefined;
-            category?: string | undefined;
-            restriction?: {
-                value?: string | undefined;
-                relationship?: "allow" | undefined;
-            } | undefined;
-            gallery_loc?: string | undefined;
-            price?: string | undefined;
-            requires_subscription?: boolean | undefined;
-            uploader?: string | undefined;
-        }[] | undefined;
-    } | undefined;
-}, {
-    sitemap?: {
-        loc?: string | undefined;
-        lastmod?: Date | undefined;
-        changefreq?: "never" | "always" | "hourly" | "daily" | "weekly" | "monthly" | "yearly" | undefined;
-        priority?: number | undefined;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+type SitemapSchema = TypeOf<typeof schema>;
+interface AsSitemapCollectionOptions<TEntry = Record<string, unknown>> {
+    /**
+     * Collection name. Must match the key in your collections object.
+     * Required when using `filter` or `onUrl`.
+     * @example
+     * collections: {
+     *   blog: defineCollection(asSitemapCollection({...}, { name: 'blog', filter: ... }))
+     * }
+     */
+    name?: string;
+    /**
+     * Runtime filter function to exclude entries from sitemap.
+     * Receives the full content entry including all schema fields.
+     * Requires `name` parameter to be set.
+     * @example
+     * { name: 'blog', filter: (entry) => !entry.draft && new Date(entry.date) <= new Date() }
+     */
+    filter?: (entry: PageCollectionItemBase & SitemapSchema & TEntry) => boolean;
+    /**
+     * Transform the sitemap URL entry for each item in this collection.
+     * Mutate `url` directly to change `loc`, `lastmod`, `priority`, etc.
+     * The full content entry and collection name are provided for context.
+     * Useful when the collection uses `prefix: ''` in its source config,
+     * which strips the directory prefix from content paths.
+     * Requires `name` parameter to be set.
+     * @example
+     * // Add a locale prefix
+     * { name: 'content_zh', onUrl: (url) => { url.loc = `/zh${url.loc}` } }
+     * @example
+     * // Use content entry fields to set priority
+     * { name: 'blog', onUrl: (url, entry) => { url.priority = entry.featured ? 1.0 : 0.5 } }
+     */
+    onUrl?: (url: {
+        loc: string;
+        lastmod?: string | Date;
+        changefreq?: string;
+        priority?: number;
         images?: {
             loc: string;
-            caption?: string | undefined;
-            geo_location?: string | undefined;
-            title?: string | undefined;
-            license?: string | undefined;
-        }[] | undefined;
+        }[];
         videos?: {
             content_loc: string;
-            player_loc?: string | undefined;
-            duration?: string | undefined;
-            expiration_date?: Date | undefined;
-            rating?: number | undefined;
-            view_count?: number | undefined;
-            publication_date?: Date | undefined;
-            family_friendly?: boolean | undefined;
-            tag?: string | undefined;
-            category?: string | undefined;
-            restriction?: {
-                value?: string | undefined;
-                relationship?: "allow" | undefined;
-            } | undefined;
-            gallery_loc?: string | undefined;
-            price?: string | undefined;
-            requires_subscription?: boolean | undefined;
-            uploader?: string | undefined;
-        }[] | undefined;
-    } | undefined;
-}>;
-type SitemapSchema = TypeOf<typeof schema>;
-declare function asSitemapCollection<T>(collection: Collection<T>): Collection<T>;
+        }[];
+        [key: string]: unknown;
+    }, entry: PageCollectionItemBase & SitemapSchema & TEntry, collection: string) => void;
+}
+declare function asSitemapCollection<T>(collection: Collection<T>, options?: AsSitemapCollectionOptions<T>): Collection<T>;
 
 export { asSitemapCollection, schema };
-export type { SitemapSchema };
+export type { AsSitemapCollectionOptions, SitemapSchema };

package/dist/content.mjs

@@ -1,5 +1,11 @@
 import { z } from 'zod';
 
+if (!globalThis.__sitemapCollectionFilters)
+  globalThis.__sitemapCollectionFilters = /* @__PURE__ */ new Map();
+if (!globalThis.__sitemapCollectionOnUrlFns)
+  globalThis.__sitemapCollectionOnUrlFns = /* @__PURE__ */ new Map();
+const collectionFilters = globalThis.__sitemapCollectionFilters;
+const collectionOnUrlFns = globalThis.__sitemapCollectionOnUrlFns;
 const schema = z.object({
   sitemap: z.object({
     loc: z.string().optional(),
@@ -35,9 +41,17 @@ const schema = z.object({
     })).optional()
   }).optional()
 });
-function asSitemapCollection(collection) {
+function asSitemapCollection(collection, options) {
   if (collection.type === "page") {
     collection.schema = collection.schema ? schema.extend(collection.schema.shape) : schema;
+    if (options?.filter || options?.onUrl) {
+      if (!options.name)
+        throw new Error("[sitemap] `name` is required when using `filter` or `onUrl` in asSitemapCollection()");
+      if (options.filter)
+        collectionFilters.set(options.name, options.filter);
+      if (options.onUrl)
+        collectionOnUrlFns.set(options.name, options.onUrl);
+    }
   }
   return collection;
 }

package/dist/module.json

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