@nuxtjs/sitemap 2.4.0 → 5.0.0

package/dist/runtime/types.d.ts

@@ -0,0 +1,355 @@
+import type { FetchOptions } from 'ofetch';
+import type { H3Event } from 'h3';
+export interface ModuleOptions extends SitemapDefinition {
+    /**
+     * Whether the sitemap.xml should be generated.
+     *
+     * @default true
+     */
+    enabled: boolean;
+    /**
+     * Enables debug logs and a debug endpoint.
+     *
+     * @default false
+     */
+    debug: boolean;
+    /**
+     * Should lastmod be automatically added to the sitemap.
+     *
+     * Warning: This may not be following best practices for sitemaps.
+     *
+     * @see https://nuxtseo.com/sitemap/guides/best-practices.
+     * @default false
+     */
+    autoLastmod: boolean;
+    /**
+     * Should pages be automatically added to the sitemap.
+     *
+     * @default true
+     * @deprecated If set to false, use `excludeAppSources: ['pages', 'route-rules', 'prerender']` instead. Otherwise, remove this.
+     */
+    inferStaticPagesAsRoutes: boolean;
+    /**
+     * Sources to exclude from the sitemap.
+     */
+    excludeAppSources: true | (AppSourceContext[]);
+    /**
+     * Multiple sitemap support for large sites.
+     *
+     * @default false
+     */
+    sitemaps?: boolean | MultiSitemapsInput;
+    /**
+     * Path to the xsl that styles sitemap.xml.
+     *
+     * Set to `false` to disable styling.
+     *
+     * @default /__sitemap__/style.xsl
+     */
+    xsl: string | false;
+    /**
+     * Toggle the tips displayed in the xsl.
+     *
+     * @default true
+     */
+    xslTips: boolean;
+    /**
+     * Customised the columns displayed in the xsl.
+     *
+     * @default [{ label: 'URL', width: '50%', select: 'string' }, { label: 'Last Modified', width: '25%', select: 'lastmod' }, { label: 'Change Frequency', width: '25%', select: 'changefreq' }]
+     */
+    xslColumns?: {
+        label: string;
+        width: `${string}%`;
+        select?: string;
+    }[];
+    /**
+     * When prerendering, should images be automatically be discovered and added to the sitemap.
+     *
+     * @default true
+     */
+    discoverImages: boolean;
+    /**
+     * When chunking the sitemaps into multiple files, how many entries should each file contain.
+     *
+     * Set to `false` to disabling chunking completely.
+     *
+     * @default 1000
+     */
+    defaultSitemapsChunkSize: number | false;
+    /**
+     * Modify the cache behavior.
+     *
+     * Passing a boolean will enable or disable the runtime cache with the default options.
+     *
+     * Providing a record will allow you to configure the runtime cache fully.
+     *
+     * @default true
+     * @see https://nitro.unjs.io/guide/storage#mountpoints
+     * @example { driver: 'redis', host: 'localhost', port: 6379, password: 'password' }
+     */
+    runtimeCacheStorage: boolean | (Record<string, any> & {
+        driver: string;
+    });
+    /**
+     * Automatically add alternative links to the sitemap based on a prefix list.
+     * Is used by @nuxtjs/i18n to automatically add alternative links to the sitemap.
+     */
+    autoI18n?: boolean | AutoI18nConfig;
+    /**
+     * Enable when your nuxt/content files match your pages. This will automatically add sitemap content to the sitemap.
+     *
+     * This is similar behavior to using `nuxt/content` with `documentDriven: true`.
+     */
+    strictNuxtContentPaths: boolean;
+    /**
+     * Should the sitemap.xml display credits for the module.
+     *
+     * @default true
+     */
+    credits: boolean;
+    /**
+     * How long, in milliseconds, should the sitemap be cached for.
+     *
+     * @default 1 hour
+     *
+     * @deprecated use cacheMaxAgeSeconds
+     */
+    cacheTtl?: number | false;
+    /**
+     * How long, in seconds, should the sitemap be cached for.
+     *
+     * @default 600
+     */
+    cacheMaxAgeSeconds: number | false;
+    /**
+     * Should the entries be sorted by loc.
+     *
+     * @default true
+     */
+    sortEntries: boolean;
+    /**
+     * Warm up the sitemap route(s) cache when Nitro starts.
+     *
+     * May be implemented by default in a future minor version.
+     *
+     * @experimental Will be enabled by default in v5 (if stable)
+     */
+    experimentalWarmUp?: boolean;
+    /**
+     * Send the Sitemap as a compressed stream supporting gzip, brolti, etc.
+     *
+     * @experimental Will be enabled by default in v5 (if stable)
+     */
+    experimentalCompression?: boolean;
+}
+export interface IndexSitemapRemotes {
+    index?: (string | SitemapIndexEntry)[];
+}
+export interface MultiSitemapEntry {
+    [key: string]: Partial<SitemapDefinition>;
+}
+export type MultiSitemapsInput = Partial<MultiSitemapEntry & IndexSitemapRemotes>;
+export type MaybeFunction<T> = T | (() => T);
+export type MaybePromise<T> = T | Promise<T>;
+export type SitemapUrlInput = SitemapUrl | string;
+export interface SitemapSourceBase {
+    context: {
+        name: string;
+        description?: string;
+        tips?: string[];
+    };
+    fetch?: string | [string, FetchOptions];
+    urls?: SitemapUrlInput[];
+    sourceType?: 'app' | 'user';
+}
+export interface SitemapSourceResolved extends Omit<SitemapSourceBase, 'urls'> {
+    urls: SitemapUrlInput[];
+    error?: any;
+    timeTakenMs?: number;
+}
+export type AppSourceContext = 'nuxt:pages' | 'nuxt:prerender' | 'nuxt:route-rules' | '@nuxtjs/i18n:pages' | '@nuxt/content:document-driven';
+export type SitemapSourceInput = string | SitemapSourceBase | SitemapSourceResolved;
+export type NormalisedLocales = {
+    code: string;
+    iso?: string;
+    domain?: string;
+}[];
+export interface AutoI18nConfig {
+    differentDomains?: boolean;
+    locales: NormalisedLocales;
+    defaultLocale: string;
+    strategy: 'prefix' | 'prefix_except_default' | 'prefix_and_default' | 'no_prefix';
+}
+export interface ModuleRuntimeConfig extends Pick<ModuleOptions, 'cacheMaxAgeSeconds' | 'sitemapName' | 'excludeAppSources' | 'sortEntries' | 'defaultSitemapsChunkSize' | 'xslColumns' | 'xslTips' | 'debug' | 'discoverImages' | 'autoLastmod' | 'xsl' | 'credits'> {
+    version: string;
+    isNuxtContentDocumentDriven: boolean;
+    sitemaps: {
+        index?: Pick<SitemapDefinition, 'sitemapName' | '_route'> & {
+            sitemaps: SitemapIndexEntry[];
+        };
+    } & Record<string, Omit<SitemapDefinition, 'urls' | 'sources'> & {
+        _hasSourceChunk?: boolean;
+    }>;
+    autoI18n?: AutoI18nConfig;
+    isMultiSitemap: boolean;
+    isI18nMapped: boolean;
+}
+export interface SitemapIndexEntry {
+    sitemap: string;
+    lastmod?: string;
+}
+export type FilterInput = (string | RegExp | {
+    regex: string;
+});
+export type ResolvedSitemapUrl = Omit<SitemapUrl, 'url'> & Required<Pick<SitemapUrl, 'loc'>>;
+export interface SitemapDefinition {
+    /**
+     * A collection include patterns for filtering which URLs end up in the sitemap.
+     */
+    include?: FilterInput[];
+    /**
+     * A collection exclude patterns for filtering which URLs end up in the sitemap.
+     */
+    exclude?: FilterInput[];
+    /**
+     * Should the sitemap be generated using global sources.
+     *
+     * This is enabled by default when using a single sitemap. Otherwise, it will be opt-in.
+     */
+    includeAppSources?: boolean;
+    /**
+     * The root sitemap name.
+     * Only works when multiple sitemaps option `sitemaps` isn't used.
+     *
+     * @default `sitemap.xml`
+     */
+    sitemapName: string;
+    /**
+     * A resolvable collection of URLs to include in the sitemap.
+     *
+     * Will be resolved when the sitemap is generated.
+     */
+    urls?: MaybeFunction<MaybePromise<SitemapUrlInput[]>>;
+    /**
+     * Default options for all URLs in the sitemap.
+     */
+    defaults?: Omit<SitemapUrl, 'loc'>;
+    /**
+     * Additional sources of URLs to include in the sitemap.
+     */
+    sources?: SitemapSourceInput[];
+    /**
+     * The endpoint to fetch dynamic URLs from.
+     *
+     * @deprecated use `sources`
+     */
+    dynamicUrlsApiEndpoint?: string | false;
+    /**
+     * @internal
+     */
+    _route?: string;
+}
+export interface SitemapRenderCtx {
+    sitemapName: string;
+    urls: ResolvedSitemapUrl[];
+}
+export interface SitemapOutputHookCtx {
+    sitemapName: string;
+    sitemap: string;
+}
+export type Changefreq = 'always' | 'hourly' | 'daily' | 'weekly' | 'monthly' | 'yearly' | 'never';
+export interface SitemapUrl {
+    loc: string;
+    lastmod?: string | Date;
+    changefreq?: Changefreq;
+    priority?: 0 | 0.1 | 0.2 | 0.3 | 0.4 | 0.5 | 0.6 | 0.7 | 0.8 | 0.9 | 1;
+    alternatives?: Array<AlternativeEntry>;
+    news?: GoogleNewsEntry;
+    images?: Array<ImageEntry>;
+    videos?: Array<VideoEntry>;
+    _i18nTransform?: boolean;
+    _sitemap?: string;
+    /**
+     * @deprecated use `loc`
+     */
+    url?: string;
+}
+export interface AlternativeEntry {
+    hreflang: string;
+    href: string | URL;
+}
+export interface GoogleNewsEntry {
+    /**
+     * The title of the news article.
+     * @example "Companies A, B in Merger Talks"
+     */
+    title: string;
+    /**
+     * The article publication date in W3C format. Specify the original date and time when the article was first
+     * published on your site. Don't specify the time when you added the article to your sitemap.
+     * @example "2008-12-23"
+     */
+    publication_date: Date | string;
+    publication: {
+        /**
+         * The <news:name> tag is the name of the news publication.
+         * It must exactly match the name as it appears on your articles on news.google.com, omitting anything in parentheses.
+         * @example "The Example Times"
+         */
+        name: string;
+        /**
+         * The <news:language> tag is the language of your publication. Use an ISO 639 language code (two or three letters).
+         * @example en
+         */
+        language: string;
+    };
+}
+export interface ImageEntry {
+    loc: string | URL;
+    caption?: string;
+    geoLocation?: string;
+    title?: string;
+    license?: string | URL;
+}
+export interface VideoEntry {
+    title: string;
+    thumbnail_loc: string | URL;
+    description: string;
+    content_loc?: string | URL;
+    player_loc?: string | URL;
+    duration?: number;
+    expiration_date?: Date | string;
+    rating?: number;
+    view_count?: number;
+    publication_date?: Date | string;
+    family_friendly?: 'yes' | 'no' | boolean;
+    restriction?: Restriction;
+    platform?: Platform;
+    price?: ({
+        price?: number | string;
+        currency?: string;
+        type?: 'rent' | 'purchase' | 'package' | 'subscription';
+    })[];
+    requires_subscription?: 'yes' | 'no' | boolean;
+    uploader?: {
+        uploader: string;
+        info?: string | URL;
+    };
+    live?: 'yes' | 'no' | boolean;
+    tag?: string | string[];
+}
+export interface Restriction {
+    relationship: 'allow' | 'deny';
+    restriction: string;
+}
+export interface Platform {
+    relationship: 'allow' | 'deny';
+    platform: string;
+}
+export interface NitroUrlResolvers {
+    event: H3Event;
+    canonicalUrlResolver: (path: string) => string;
+    relativeBaseUrlResolver: (path: string) => string;
+    fixSlashes: (path: string) => string;
+}

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

@@ -0,0 +1,7 @@
+import type { FilterInput } from './types';
+export declare function mergeOnKey<T, K extends keyof T>(arr: T[], key: K): T[];
+export declare function splitForLocales(path: string, locales: string[]): (string | null)[];
+/**
+ * Transform a literal notation string regex to RegExp
+ */
+export declare function normalizeRuntimeFilters(input?: FilterInput[]): (RegExp | string)[];

package/dist/runtime/utils-pure.mjs

@@ -0,0 +1,32 @@
+import { createDefu } from "defu";
+import { withLeadingSlash } from "ufo";
+const merger = createDefu((obj, key, value) => {
+  if (Array.isArray(obj[key]) && Array.isArray(value))
+    obj[key] = Array.from(/* @__PURE__ */ new Set([...obj[key], ...value]));
+  return obj[key];
+});
+export function mergeOnKey(arr, key) {
+  const res = {};
+  arr.forEach((item) => {
+    const k = item[key];
+    res[k] = merger(item, res[k] || {});
+  });
+  return Object.values(res);
+}
+export function splitForLocales(path, locales) {
+  const prefix = withLeadingSlash(path).split("/")[1];
+  if (locales.includes(prefix))
+    return [prefix, path.replace(`/${prefix}`, "")];
+  return [null, path];
+}
+const StringifiedRegExpPattern = /\/(.*?)\/([gimsuy]*)$/;
+export function normalizeRuntimeFilters(input) {
+  return (input || []).map((rule) => {
+    if (rule instanceof RegExp || typeof rule === "string")
+      return rule;
+    const match = rule.regex.match(StringifiedRegExpPattern);
+    if (match)
+      return new RegExp(match[1], match[2]);
+    return false;
+  }).filter(Boolean);
+}

package/dist/types.d.mts

@@ -0,0 +1,18 @@
+
+import type { ModuleOptions, ModuleHooks } from './module.js'
+
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['sitemap']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['sitemap']?: ModuleOptions }
+  interface NuxtHooks extends ModuleHooks {}
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['sitemap']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['sitemap']?: ModuleOptions }
+  interface NuxtHooks extends ModuleHooks {}
+}
+
+
+export type { ModuleHooks, ModuleOptions, default } from './module.js'

package/dist/types.d.ts

@@ -0,0 +1,18 @@
+
+import type { ModuleOptions, ModuleHooks } from './module'
+
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['sitemap']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['sitemap']?: ModuleOptions }
+  interface NuxtHooks extends ModuleHooks {}
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['sitemap']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['sitemap']?: ModuleOptions }
+  interface NuxtHooks extends ModuleHooks {}
+}
+
+
+export type { ModuleHooks, ModuleOptions, default } from './module'

package/package.json

@@ -1,87 +1,91 @@
 {
   "name": "@nuxtjs/sitemap",
-  "version": "2.4.0",
-  "description": "Automatically generate or serve dynamic sitemap.xml for Nuxt.js projects",
-  "keywords": [
-    "nuxt",
-    "nuxt.js",
-    "nuxtjs",
-    "seo",
-    "sitemap",
-    "sitemap.xml",
-    "ssr"
-  ],
-  "repository": "https://github.com/nuxt-community/sitemap-module",
+  "type": "module",
+  "version": "5.0.0",
+  "packageManager": "pnpm@8.14.0",
+  "description": "Powerfully flexible XML Sitemaps that integrate seamlessly, for Nuxt.",
+  "author": {
+    "name": "Harlan Wilton",
+    "email": "harlan@harlanzw.com",
+    "url": "https://harlanzw.com/"
+  },
   "license": "MIT",
-  "contributors": [
-    {
-      "name": "Nicolas Pennec"
-    },
-    {
-      "name": "Pooya Parsa"
-    }
-  ],
-  "files": [
-    "lib"
-  ],
-  "main": "lib/module.js",
-  "scripts": {
-    "build": "nuxt build test/fixture",
-    "dev": "nuxt test/fixture",
-    "format": "yarn lint --fix",
-    "generate": "nuxt generate test/fixture",
-    "lint": "eslint . --ext js,vue",
-    "preview": "standard-version --dry-run",
-    "release": "standard-version && git push --follow-tags && npm publish",
-    "start": "nuxt start test/fixture",
-    "test": "yarn lint && yarn unit",
-    "unit": "jest"
+  "funding": "https://github.com/sponsors/harlan-zw",
+  "homepage": "https://github.com/nuxt-modules/sitemap#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nuxt-modules/sitemap.git"
   },
-  "husky": {
-    "hooks": {
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
-      "pre-commit": "lint-staged",
-      "pre-push": "yarn test"
-    }
+  "bugs": {
+    "url": "https://github.com/nuxt-modules/sitemap/issues"
   },
-  "lint-staged": {
-    "*.{js,vue}": [
-      "eslint --fix"
-    ]
+  "exports": {
+    ".": {
+      "types": "./dist/types.d.ts",
+      "import": "./dist/module.mjs",
+      "require": "./dist/module.cjs"
+    }
   },
+  "main": "./dist/module.cjs",
+  "types": "./dist/types.d.ts",
+  "files": [
+    "dist"
+  ],
   "dependencies": {
-    "async-cache": "^1.1.0",
-    "consola": "^2.13.0",
-    "etag": "^1.8.1",
-    "fresh": "^0.5.2",
-    "fs-extra": "^8.1.0",
-    "is-https": "^2.0.2",
-    "lodash.unionby": "^4.8.0",
-    "minimatch": "^3.0.4",
-    "sitemap": "^4.1.1"
+    "@nuxt/devtools-kit": "^1.0.6",
+    "@nuxt/devtools-ui-kit": "^1.0.6",
+    "@nuxt/kit": "^3.9.1",
+    "@vueuse/core": "^10.7.1",
+    "chalk": "^5.3.0",
+    "defu": "^6.1.4",
+    "floating-vue": "2.0.0-beta.24",
+    "h3-compression": "^0.3.2",
+    "nuxt-site-config": "^2.2.0",
+    "nuxt-site-config-kit": "^2.2.0",
+    "ofetch": "^1.3.3",
+    "pathe": "^1.1.1",
+    "radix3": "^1.1.0",
+    "semver": "^7.5.4",
+    "sirv": "^2.0.4",
+    "site-config-stack": "^2.2.0",
+    "ufo": "^1.3.2"
   },
   "devDependencies": {
-    "@commitlint/cli": "latest",
-    "@commitlint/config-conventional": "latest",
-    "@nuxtjs/eslint-config": "latest",
-    "codecov": "latest",
-    "eslint": "latest",
-    "eslint-config-prettier": "latest",
-    "eslint-plugin-prettier": "latest",
-    "husky": "latest",
-    "jest": "latest",
-    "lint-staged": "latest",
-    "nuxt": "latest",
-    "nuxt-i18n": "latest",
-    "prettier": "latest",
-    "request-promise-native": "latest",
-    "standard-version": "latest"
+    "@antfu/eslint-config": "^2.6.1",
+    "@nuxt/content": "^2.10.0",
+    "@nuxt/kit": "^3.9.1",
+    "@nuxt/module-builder": "^0.5.5",
+    "@nuxt/test-utils": "^3.9.0",
+    "@nuxt/ui": "^2.11.1",
+    "@nuxtjs/eslint-config-typescript": "^12.1.0",
+    "@nuxtjs/i18n": "8.0.0",
+    "bumpp": "^9.2.1",
+    "eslint": "8.56.0",
+    "execa": "^8.0.1",
+    "nuxt": "^3.9.1",
+    "nuxt-icon": "^0.6.8",
+    "nuxt-simple-robots": "^4.0.0-rc.9",
+    "typescript": "^5.3.3",
+    "vitest": "^1.1.3"
   },
-  "engines": {
-    "node": ">=8.9.0",
-    "npm": ">=5.0.0"
+  "build": {
+    "externals": [
+      "h3",
+      "std-env",
+      "nitropack"
+    ]
   },
-  "publishConfig": {
-    "access": "public"
+  "scripts": {
+    "lint": "eslint . --fix",
+    "client:build": "nuxi generate client",
+    "client:dev": "nuxi dev client --port 3300",
+    "build": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxt-module-build build && npm run client:build",
+    "dev": "nuxi dev .playground",
+    "dev:devtool": "nuxi dev .playground-devtools",
+    "dev:build": "nuxi build .playground",
+    "dev:prepare": "nuxt-module-build --stub && nuxi prepare .playground",
+    "release": "pnpm build && bumpp && pnpm -r publish",
+    "typecheck": "tsc --noEmit ",
+    "test": "vitest"
   }
-}
+}