svelte-sitemap 4.0.0 → 4.0.2

package/dto/global.interface.d.ts

@@ -2,25 +2,77 @@ import { CHANGE_FREQ, IntegrationMethod } from "../const.js";
 
 //#region src/dto/global.interface.d.ts
 interface Arguments {
+  /**
+   * Your website domain URL (e.g., 'https://example.com').
+   */
   domain: string;
+  /**
+   * Additional sitemap generation options.
+   */
   options?: Options;
 }
 interface Options {
+  /**
+   * Enable debug mode to display detailed log outputs during execution.
+   * @default false
+   */
   debug?: boolean;
+  /**
+   * How frequently the page content is likely to change.
+   * This value provides general information to search engines and may not correlate exactly to how often they crawl the page.
+   * @see {@link ChangeFreq}
+   */
   changeFreq?: ChangeFreq;
+  /**
+   * If set to true, resets the last modified time (`lastmod`) of all pages to the current date/time.
+   * @default false
+   */
   resetTime?: boolean;
+  /**
+   * Custom build/output folder containing the static HTML files.
+   * @default 'build'
+   */
   outDir?: string;
+  /**
+   * Whether to include an attribution comment ("Generated by svelte-sitemap") in the output sitemap.xml.
+   * @default true
+   */
   attribution?: boolean;
+  /**
+   * Glob patterns or specific file/directory paths to exclude from the sitemap.
+   * @default []
+   * @example `ignore: ['**\/admin/**', 'my-secret-page']`
+   */
   ignore?: string | string[];
+  /**
+   * Whether to append a trailing slash to all page URLs in the sitemap.
+   * @default false
+   */
   trailingSlashes?: boolean;
+  /**
+   * Array of additional page paths to manually add to the sitemap (e.g. paths external to SvelteKit or static assets).
+   * @example `additional: ['my-page', 'my-second-page']`
+   */
   additional?: string[];
 }
 interface OptionsSvelteSitemap extends Options {
+  /**
+   * Your website domain URL (e.g., 'https://example.com').
+   */
   domain: string;
 }
 interface PagesJson {
+  /**
+   * The path or URL of the page.
+   */
   page: string;
+  /**
+   * How frequently the page content is likely to change.
+   */
   changeFreq?: ChangeFreq;
+  /**
+   * The last modified timestamp of the page.
+   */
   lastMod?: string;
 }
 /**

package/helpers/file.js

@@ -1,6 +1,6 @@
 import { existsSync } from "fs";
-import { createJiti } from "jiti";
 import { resolve } from "path";
+import { createJiti } from "jiti";
 import { fileURLToPath } from "url";
 //#region src/helpers/file.ts
 const jiti = createJiti(fileURLToPath(import.meta.url));

package/helpers/global.helper.js

@@ -3,6 +3,7 @@ import { version as version$1 } from "../package.js";
 import { cliColors, errorMsgFolder, errorMsgHtmlFiles, errorMsgWrite, successMsg } from "./vars.helper.js";
 import fg from "fast-glob";
 import fs from "fs";
+import path from "path";
 import { create } from "xmlbuilder2";
 //#region src/helpers/global.helper.ts
 const version = version$1;
@@ -53,10 +54,10 @@ const detectErrors = ({ folder, htmlFiles }, outDir = OUT_DIR) => {
 	else if (htmlFiles) console.error(cliColors.red, errorMsgHtmlFiles(outDir));
 };
 const checkPrerenderRoutes = async (pages, outDir, options) => {
-	if (fs.existsSync(`${outDir}/_app`)) {
+	if (fs.existsSync(path.join(outDir, "_app")) && pages.length > 0) {
 		const hasOnlyRootOrFallback = pages.every((page) => {
-			const basename = page.split("/").pop();
-			return basename === "index.html" || basename === "fallback.html";
+			const relative = path.relative(outDir, page);
+			return relative === "index.html" || relative === "fallback.html";
 		});
 		const hasNoAdditional = !options?.additional || options.additional.length === 0;
 		if (hasOnlyRootOrFallback && hasNoAdditional) console.warn(cliColors.yellow, `  ⚠️ Warning: Only the homepage or fallback page was found in '${outDir}/'.\n    If your SvelteKit site has multiple routes, make sure you enabled prerendering for them.\n    For SPA (Single Page Apps), you can add routes manually using the 'additional' option.`);

package/helpers/global.helper.js.map

@@ -1 +1 @@
-{"version":3,"file":"global.helper.js","names":["pkg.version"],"sources":["../../src/helpers/global.helper.ts"],"sourcesContent":["import fg from 'fast-glob';\nimport fs from 'fs';\nimport { create } from 'xmlbuilder2';\nimport type { XMLBuilder } from 'xmlbuilder2/lib/interfaces.js';\nimport pkg from '../../package.json' with { type: 'json' };\nimport { CHANGE_FREQ, CHUNK, OUT_DIR } from '../const.js';\nimport type { ChangeFreq, Options, OptionsSvelteSitemap, PagesJson } from './../dto/index.js';\nimport {\n  cliColors,\n  errorMsgFolder,\n  errorMsgHtmlFiles,\n  errorMsgWrite,\n  successMsg\n} from './vars.helper.js';\n\nconst version = pkg.version;\n\nconst getUrl = (url: string, domain: string, options: Options) => {\n  let slash: '' | '/' = getSlash(domain);\n\n  let trimmed = url\n    .split((options?.outDir ?? OUT_DIR) + '/')\n    .pop()\n    .replace('index.html', '');\n\n  trimmed = removeHtml(trimmed);\n\n  // Add all traling slashes\n  if (options?.trailingSlashes) {\n    trimmed = trimmed.length && !trimmed.endsWith('/') ? trimmed + '/' : trimmed;\n  } else {\n    trimmed = trimmed.endsWith('/') ? trimmed.slice(0, -1) : trimmed;\n    slash = trimmed ? slash : '';\n  }\n\n  // URI-encode each path segment to handle special characters (e.g. spaces → %20).\n  // Decode first to avoid double-encoding already percent-encoded segments.\n  trimmed = trimmed\n    .split('/')\n    .map((segment) => {\n      try {\n        return encodeURIComponent(decodeURIComponent(segment));\n      } catch {\n        return encodeURIComponent(segment);\n      }\n    })\n    .join('/');\n\n  return `${domain}${slash}${trimmed}`;\n};\n\nexport const removeHtml = (fileName: string) => {\n  if (fileName?.endsWith('.html')) {\n    return fileName.slice(0, -5);\n  }\n  return fileName;\n};\n\nexport async function prepareData(domain: string, options?: Options): Promise<PagesJson[]> {\n  const FOLDER = options?.outDir ?? OUT_DIR;\n\n  const ignore = prepareIgnored(options?.ignore, options?.outDir);\n  const changeFreq = prepareChangeFreq(options);\n  const pages: string[] = await fg(`${FOLDER}/**/*.html`, { ignore });\n\n  if (options.additional) pages.push(...options.additional);\n\n  const results = pages.map((page) => {\n    return {\n      page: getUrl(page, domain, options),\n      changeFreq: changeFreq,\n      lastMod: options?.resetTime ? new Date().toISOString().split('T')[0] : ''\n    };\n  });\n\n  detectErrors(\n    {\n      folder: !fs.existsSync(FOLDER),\n      htmlFiles: !pages.length\n    },\n    FOLDER\n  );\n\n  await checkPrerenderRoutes(pages, FOLDER, options);\n\n  return results;\n}\n\nexport const detectErrors = (\n  { folder, htmlFiles }: { folder: boolean; htmlFiles: boolean },\n  outDir: string = OUT_DIR\n) => {\n  if (folder && htmlFiles) {\n    console.error(cliColors.red, errorMsgFolder(outDir));\n  } else if (htmlFiles) {\n    // If no page exists, then the static adapter is probably not used\n    console.error(cliColors.red, errorMsgHtmlFiles(outDir));\n  }\n};\n\nexport const checkPrerenderRoutes = async (pages: string[], outDir: string, options?: Options) => {\n  // Check if it's a SvelteKit build by checking for the '_app' directory in output folder\n  const appDirExists = fs.existsSync(`${outDir}/_app`);\n\n  if (appDirExists) {\n    const hasOnlyRootOrFallback = pages.every((page) => {\n      const basename = page.split('/').pop();\n      return basename === 'index.html' || basename === 'fallback.html';\n    });\n\n    const hasNoAdditional = !options?.additional || options.additional.length === 0;\n\n    if (hasOnlyRootOrFallback && hasNoAdditional) {\n      console.warn(\n        cliColors.yellow,\n        `  ⚠️ Warning: Only the homepage or fallback page was found in '${outDir}/'.\\n` +\n          `    If your SvelteKit site has multiple routes, make sure you enabled prerendering for them.\\n` +\n          `    For SPA (Single Page Apps), you can add routes manually using the 'additional' option.`\n      );\n    }\n  }\n};\n\nexport const writeSitemap = (items: PagesJson[], options: Options, domain: string): void => {\n  const outDir = options?.outDir ?? OUT_DIR;\n\n  if (items?.length <= CHUNK.maxSize) {\n    createFile(items, options, outDir);\n  } else {\n    // If the number of pages is greater than the chunk size, then we split the sitemap into multiple files\n    // and create an index file that links to all of them\n    // https://support.google.com/webmasters/answer/183668?hl=en\n    const numberOfChunks = Math.ceil(items.length / CHUNK.maxSize);\n\n    console.log(\n      cliColors.cyanAndBold,\n      `> Oh, your site is huge! Writing sitemap in chunks of ${numberOfChunks} pages and its index sitemap.xml`\n    );\n\n    for (let i = 0; i < items.length; i += CHUNK.maxSize) {\n      const chunk = items.slice(i, i + CHUNK.maxSize);\n      createFile(chunk, options, outDir, i / CHUNK.maxSize + 1);\n    }\n    createIndexFile(numberOfChunks, outDir, options, domain);\n  }\n};\n\nconst createFile = (\n  items: PagesJson[],\n  options: Options,\n  outDir: string,\n  chunkId?: number\n): void => {\n  const sitemap = createXml('urlset');\n  addAttribution(sitemap, options);\n\n  for (const item of items) {\n    const page = sitemap.ele('url');\n    page.ele('loc').txt(item.page);\n    if (item.changeFreq) {\n      page.ele('changefreq').txt(item.changeFreq);\n    }\n    if (item.lastMod) {\n      page.ele('lastmod').txt(item.lastMod);\n    }\n  }\n\n  const xml = finishXml(sitemap);\n\n  const fileName = chunkId ? `sitemap-${chunkId}.xml` : 'sitemap.xml';\n\n  try {\n    fs.writeFileSync(`${outDir}/${fileName}`, xml);\n    console.log(cliColors.green, successMsg(outDir, fileName));\n  } catch (e) {\n    console.error(cliColors.red, errorMsgWrite(outDir, fileName), e);\n  }\n};\n\nconst createIndexFile = (\n  numberOfChunks: number,\n  outDir: string,\n  options: Options,\n  domain: string\n): void => {\n  const FILENAME = 'sitemap.xml';\n  const slash = getSlash(domain);\n\n  const sitemap = createXml('sitemapindex');\n  addAttribution(sitemap, options);\n\n  for (let i = 1; i <= numberOfChunks; i++) {\n    sitemap.ele('sitemap').ele('loc').txt(`${domain}${slash}sitemap-${i}.xml`);\n  }\n\n  const xml = finishXml(sitemap);\n\n  try {\n    fs.writeFileSync(`${outDir}/${FILENAME}`, xml);\n    console.log(cliColors.green, successMsg(outDir, FILENAME));\n  } catch (e) {\n    console.error(cliColors.red, errorMsgWrite(outDir, FILENAME), e);\n  }\n};\n\nconst prepareIgnored = (\n  ignored: string | string[],\n  outDir: string = OUT_DIR\n): string[] | undefined => {\n  let ignore: string[] | undefined;\n  if (ignored) {\n    ignore = Array.isArray(ignored) ? ignored : [ignored];\n    ignore = ignore.map((ignoredPage) => `${outDir}/${ignoredPage}`);\n  }\n  return ignore;\n};\n\nconst prepareChangeFreq = (options: Options): ChangeFreq => {\n  let result: ChangeFreq = null;\n\n  if (options?.changeFreq) {\n    if (CHANGE_FREQ.includes(options.changeFreq)) {\n      result = options.changeFreq;\n    } else {\n      console.log(\n        cliColors.red,\n        `  × Option \\`--change-freq ${options.changeFreq}\\` is not a valid value. See docs: https://github.com/bartholomej/svelte-sitemap#options`\n      );\n    }\n  }\n  return result;\n};\n\nconst getSlash = (domain: string) => (domain.split('/').pop() ? '/' : '');\n\nconst createXml = (elementName: 'urlset' | 'sitemapindex'): XMLBuilder => {\n  return create({ version: '1.0', encoding: 'UTF-8' }).ele(elementName, {\n    xmlns: 'http://www.sitemaps.org/schemas/sitemap/0.9'\n  });\n};\n\nconst finishXml = (sitemap: XMLBuilder): string => {\n  return sitemap.end({ prettyPrint: true });\n};\n\nconst addAttribution = (sitemap: XMLBuilder, options: Options): void => {\n  if (options?.attribution !== false) {\n    sitemap.com(\n      ` This file was automatically generated by https://github.com/bartholomej/svelte-sitemap v${version} `\n    );\n  }\n};\n"],"mappings":";;;;;;;AAeA,MAAM,UAAUA;AAEhB,MAAM,UAAU,KAAa,QAAgB,YAAqB;CAChE,IAAI,QAAkB,SAAS,MAAM;CAErC,IAAI,UAAU,IACX,OAAO,SAAS,UAAA,WAAqB,GAAG,CAAC,CACzC,IAAI,CAAC,CACL,QAAQ,cAAc,EAAE;CAE3B,UAAU,WAAW,OAAO;CAG5B,IAAI,SAAS,iBACX,UAAU,QAAQ,UAAU,CAAC,QAAQ,SAAS,GAAG,IAAI,UAAU,MAAM;MAChE;EACL,UAAU,QAAQ,SAAS,GAAG,IAAI,QAAQ,MAAM,GAAG,EAAE,IAAI;EACzD,QAAQ,UAAU,QAAQ;CAC5B;CAIA,UAAU,QACP,MAAM,GAAG,CAAC,CACV,KAAK,YAAY;EAChB,IAAI;GACF,OAAO,mBAAmB,mBAAmB,OAAO,CAAC;EACvD,QAAQ;GACN,OAAO,mBAAmB,OAAO;EACnC;CACF,CAAC,CAAC,CACD,KAAK,GAAG;CAEX,OAAO,GAAG,SAAS,QAAQ;AAC7B;AAEA,MAAa,cAAc,aAAqB;CAC9C,IAAI,UAAU,SAAS,OAAO,GAC5B,OAAO,SAAS,MAAM,GAAG,EAAE;CAE7B,OAAO;AACT;AAEA,eAAsB,YAAY,QAAgB,SAAyC;CACzF,MAAM,SAAS,SAAS,UAAA;CAExB,MAAM,SAAS,eAAe,SAAS,QAAQ,SAAS,MAAM;CAC9D,MAAM,aAAa,kBAAkB,OAAO;CAC5C,MAAM,QAAkB,MAAM,GAAG,GAAG,OAAO,aAAa,EAAE,OAAO,CAAC;CAElE,IAAI,QAAQ,YAAY,MAAM,KAAK,GAAG,QAAQ,UAAU;CAExD,MAAM,UAAU,MAAM,KAAK,SAAS;EAClC,OAAO;GACL,MAAM,OAAO,MAAM,QAAQ,OAAO;GACtB;GACZ,SAAS,SAAS,6BAAY,IAAI,KAAK,EAAA,CAAE,YAAY,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK;EACzE;CACF,CAAC;CAED,aACE;EACE,QAAQ,CAAC,GAAG,WAAW,MAAM;EAC7B,WAAW,CAAC,MAAM;CACpB,GACA,MACF;CAEA,MAAM,qBAAqB,OAAO,QAAQ,OAAO;CAEjD,OAAO;AACT;AAEA,MAAa,gBACX,EAAE,QAAQ,aACV,SAAiB,YACd;CACH,IAAI,UAAU,WACZ,QAAQ,MAAM,UAAU,KAAK,eAAe,MAAM,CAAC;MAC9C,IAAI,WAET,QAAQ,MAAM,UAAU,KAAK,kBAAkB,MAAM,CAAC;AAE1D;AAEA,MAAa,uBAAuB,OAAO,OAAiB,QAAgB,YAAsB;CAIhG,IAFqB,GAAG,WAAW,GAAG,OAAO,MAE9B,GAAG;EAChB,MAAM,wBAAwB,MAAM,OAAO,SAAS;GAClD,MAAM,WAAW,KAAK,MAAM,GAAG,CAAC,CAAC,IAAI;GACrC,OAAO,aAAa,gBAAgB,aAAa;EACnD,CAAC;EAED,MAAM,kBAAkB,CAAC,SAAS,cAAc,QAAQ,WAAW,WAAW;EAE9E,IAAI,yBAAyB,iBAC3B,QAAQ,KACN,UAAU,QACV,kEAAkE,OAAO,8LAG3E;CAEJ;AACF;AAEA,MAAa,gBAAgB,OAAoB,SAAkB,WAAyB;CAC1F,MAAM,SAAS,SAAS,UAAA;CAExB,IAAI,OAAO,UAAU,MAAM,SACzB,WAAW,OAAO,SAAS,MAAM;MAC5B;EAIL,MAAM,iBAAiB,KAAK,KAAK,MAAM,SAAS,MAAM,OAAO;EAE7D,QAAQ,IACN,UAAU,aACV,yDAAyD,eAAe,iCAC1E;EAEA,KAAK,IAAI,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK,MAAM,SAE3C,WADc,MAAM,MAAM,GAAG,IAAI,MAAM,OACxB,GAAG,SAAS,QAAQ,IAAI,MAAM,UAAU,CAAC;EAE1D,gBAAgB,gBAAgB,QAAQ,SAAS,MAAM;CACzD;AACF;AAEA,MAAM,cACJ,OACA,SACA,QACA,YACS;CACT,MAAM,UAAU,UAAU,QAAQ;CAClC,eAAe,SAAS,OAAO;CAE/B,KAAK,MAAM,QAAQ,OAAO;EACxB,MAAM,OAAO,QAAQ,IAAI,KAAK;EAC9B,KAAK,IAAI,KAAK,CAAC,CAAC,IAAI,KAAK,IAAI;EAC7B,IAAI,KAAK,YACP,KAAK,IAAI,YAAY,CAAC,CAAC,IAAI,KAAK,UAAU;EAE5C,IAAI,KAAK,SACP,KAAK,IAAI,SAAS,CAAC,CAAC,IAAI,KAAK,OAAO;CAExC;CAEA,MAAM,MAAM,UAAU,OAAO;CAE7B,MAAM,WAAW,UAAU,WAAW,QAAQ,QAAQ;CAEtD,IAAI;EACF,GAAG,cAAc,GAAG,OAAO,GAAG,YAAY,GAAG;EAC7C,QAAQ,IAAI,UAAU,OAAO,WAAW,QAAQ,QAAQ,CAAC;CAC3D,SAAS,GAAG;EACV,QAAQ,MAAM,UAAU,KAAK,cAAc,QAAQ,QAAQ,GAAG,CAAC;CACjE;AACF;AAEA,MAAM,mBACJ,gBACA,QACA,SACA,WACS;CACT,MAAM,WAAW;CACjB,MAAM,QAAQ,SAAS,MAAM;CAE7B,MAAM,UAAU,UAAU,cAAc;CACxC,eAAe,SAAS,OAAO;CAE/B,KAAK,IAAI,IAAI,GAAG,KAAK,gBAAgB,KACnC,QAAQ,IAAI,SAAS,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,GAAG,SAAS,MAAM,UAAU,EAAE,KAAK;CAG3E,MAAM,MAAM,UAAU,OAAO;CAE7B,IAAI;EACF,GAAG,cAAc,GAAG,OAAO,GAAG,YAAY,GAAG;EAC7C,QAAQ,IAAI,UAAU,OAAO,WAAW,QAAQ,QAAQ,CAAC;CAC3D,SAAS,GAAG;EACV,QAAQ,MAAM,UAAU,KAAK,cAAc,QAAQ,QAAQ,GAAG,CAAC;CACjE;AACF;AAEA,MAAM,kBACJ,SACA,SAAiB,YACQ;CACzB,IAAI;CACJ,IAAI,SAAS;EACX,SAAS,MAAM,QAAQ,OAAO,IAAI,UAAU,CAAC,OAAO;EACpD,SAAS,OAAO,KAAK,gBAAgB,GAAG,OAAO,GAAG,aAAa;CACjE;CACA,OAAO;AACT;AAEA,MAAM,qBAAqB,YAAiC;CAC1D,IAAI,SAAqB;CAEzB,IAAI,SAAS,YACX,IAAI,YAAY,SAAS,QAAQ,UAAU,GACzC,SAAS,QAAQ;MAEjB,QAAQ,IACN,UAAU,KACV,8BAA8B,QAAQ,WAAW,yFACnD;CAGJ,OAAO;AACT;AAEA,MAAM,YAAY,WAAoB,OAAO,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,MAAM;AAEtE,MAAM,aAAa,gBAAuD;CACxE,OAAO,OAAO;EAAE,SAAS;EAAO,UAAU;CAAQ,CAAC,CAAC,CAAC,IAAI,aAAa,EACpE,OAAO,8CACT,CAAC;AACH;AAEA,MAAM,aAAa,YAAgC;CACjD,OAAO,QAAQ,IAAI,EAAE,aAAa,KAAK,CAAC;AAC1C;AAEA,MAAM,kBAAkB,SAAqB,YAA2B;CACtE,IAAI,SAAS,gBAAgB,OAC3B,QAAQ,IACN,4FAA4F,QAAQ,EACtG;AAEJ"}
+{"version":3,"file":"global.helper.js","names":["pkg.version"],"sources":["../../src/helpers/global.helper.ts"],"sourcesContent":["import fg from 'fast-glob';\nimport fs from 'fs';\nimport path from 'path';\nimport { create } from 'xmlbuilder2';\nimport type { XMLBuilder } from 'xmlbuilder2/lib/interfaces.js';\nimport pkg from '../../package.json' with { type: 'json' };\nimport { CHANGE_FREQ, CHUNK, OUT_DIR } from '../const.js';\nimport type { ChangeFreq, Options, OptionsSvelteSitemap, PagesJson } from './../dto/index.js';\nimport {\n  cliColors,\n  errorMsgFolder,\n  errorMsgHtmlFiles,\n  errorMsgWrite,\n  successMsg\n} from './vars.helper.js';\n\nconst version = pkg.version;\n\nconst getUrl = (url: string, domain: string, options: Options) => {\n  let slash: '' | '/' = getSlash(domain);\n\n  let trimmed = url\n    .split((options?.outDir ?? OUT_DIR) + '/')\n    .pop()\n    .replace('index.html', '');\n\n  trimmed = removeHtml(trimmed);\n\n  // Add all traling slashes\n  if (options?.trailingSlashes) {\n    trimmed = trimmed.length && !trimmed.endsWith('/') ? trimmed + '/' : trimmed;\n  } else {\n    trimmed = trimmed.endsWith('/') ? trimmed.slice(0, -1) : trimmed;\n    slash = trimmed ? slash : '';\n  }\n\n  // URI-encode each path segment to handle special characters (e.g. spaces → %20).\n  // Decode first to avoid double-encoding already percent-encoded segments.\n  trimmed = trimmed\n    .split('/')\n    .map((segment) => {\n      try {\n        return encodeURIComponent(decodeURIComponent(segment));\n      } catch {\n        return encodeURIComponent(segment);\n      }\n    })\n    .join('/');\n\n  return `${domain}${slash}${trimmed}`;\n};\n\nexport const removeHtml = (fileName: string) => {\n  if (fileName?.endsWith('.html')) {\n    return fileName.slice(0, -5);\n  }\n  return fileName;\n};\n\nexport async function prepareData(domain: string, options?: Options): Promise<PagesJson[]> {\n  const FOLDER = options?.outDir ?? OUT_DIR;\n\n  const ignore = prepareIgnored(options?.ignore, options?.outDir);\n  const changeFreq = prepareChangeFreq(options);\n  const pages: string[] = await fg(`${FOLDER}/**/*.html`, { ignore });\n\n  if (options.additional) pages.push(...options.additional);\n\n  const results = pages.map((page) => {\n    return {\n      page: getUrl(page, domain, options),\n      changeFreq: changeFreq,\n      lastMod: options?.resetTime ? new Date().toISOString().split('T')[0] : ''\n    };\n  });\n\n  detectErrors(\n    {\n      folder: !fs.existsSync(FOLDER),\n      htmlFiles: !pages.length\n    },\n    FOLDER\n  );\n\n  await checkPrerenderRoutes(pages, FOLDER, options);\n\n  return results;\n}\n\nexport const detectErrors = (\n  { folder, htmlFiles }: { folder: boolean; htmlFiles: boolean },\n  outDir: string = OUT_DIR\n) => {\n  if (folder && htmlFiles) {\n    console.error(cliColors.red, errorMsgFolder(outDir));\n  } else if (htmlFiles) {\n    // If no page exists, then the static adapter is probably not used\n    console.error(cliColors.red, errorMsgHtmlFiles(outDir));\n  }\n};\n\nexport const checkPrerenderRoutes = async (pages: string[], outDir: string, options?: Options) => {\n  // Check if it's a SvelteKit build by checking for the '_app' directory in output folder\n  const appDirExists = fs.existsSync(path.join(outDir, '_app'));\n\n  if (appDirExists && pages.length > 0) {\n    const hasOnlyRootOrFallback = pages.every((page) => {\n      const relative = path.relative(outDir, page);\n      return relative === 'index.html' || relative === 'fallback.html';\n    });\n\n    const hasNoAdditional = !options?.additional || options.additional.length === 0;\n\n    if (hasOnlyRootOrFallback && hasNoAdditional) {\n      console.warn(\n        cliColors.yellow,\n        `  ⚠️ Warning: Only the homepage or fallback page was found in '${outDir}/'.\\n` +\n          `    If your SvelteKit site has multiple routes, make sure you enabled prerendering for them.\\n` +\n          `    For SPA (Single Page Apps), you can add routes manually using the 'additional' option.`\n      );\n    }\n  }\n};\n\nexport const writeSitemap = (items: PagesJson[], options: Options, domain: string): void => {\n  const outDir = options?.outDir ?? OUT_DIR;\n\n  if (items?.length <= CHUNK.maxSize) {\n    createFile(items, options, outDir);\n  } else {\n    // If the number of pages is greater than the chunk size, then we split the sitemap into multiple files\n    // and create an index file that links to all of them\n    // https://support.google.com/webmasters/answer/183668?hl=en\n    const numberOfChunks = Math.ceil(items.length / CHUNK.maxSize);\n\n    console.log(\n      cliColors.cyanAndBold,\n      `> Oh, your site is huge! Writing sitemap in chunks of ${numberOfChunks} pages and its index sitemap.xml`\n    );\n\n    for (let i = 0; i < items.length; i += CHUNK.maxSize) {\n      const chunk = items.slice(i, i + CHUNK.maxSize);\n      createFile(chunk, options, outDir, i / CHUNK.maxSize + 1);\n    }\n    createIndexFile(numberOfChunks, outDir, options, domain);\n  }\n};\n\nconst createFile = (\n  items: PagesJson[],\n  options: Options,\n  outDir: string,\n  chunkId?: number\n): void => {\n  const sitemap = createXml('urlset');\n  addAttribution(sitemap, options);\n\n  for (const item of items) {\n    const page = sitemap.ele('url');\n    page.ele('loc').txt(item.page);\n    if (item.changeFreq) {\n      page.ele('changefreq').txt(item.changeFreq);\n    }\n    if (item.lastMod) {\n      page.ele('lastmod').txt(item.lastMod);\n    }\n  }\n\n  const xml = finishXml(sitemap);\n\n  const fileName = chunkId ? `sitemap-${chunkId}.xml` : 'sitemap.xml';\n\n  try {\n    fs.writeFileSync(`${outDir}/${fileName}`, xml);\n    console.log(cliColors.green, successMsg(outDir, fileName));\n  } catch (e) {\n    console.error(cliColors.red, errorMsgWrite(outDir, fileName), e);\n  }\n};\n\nconst createIndexFile = (\n  numberOfChunks: number,\n  outDir: string,\n  options: Options,\n  domain: string\n): void => {\n  const FILENAME = 'sitemap.xml';\n  const slash = getSlash(domain);\n\n  const sitemap = createXml('sitemapindex');\n  addAttribution(sitemap, options);\n\n  for (let i = 1; i <= numberOfChunks; i++) {\n    sitemap.ele('sitemap').ele('loc').txt(`${domain}${slash}sitemap-${i}.xml`);\n  }\n\n  const xml = finishXml(sitemap);\n\n  try {\n    fs.writeFileSync(`${outDir}/${FILENAME}`, xml);\n    console.log(cliColors.green, successMsg(outDir, FILENAME));\n  } catch (e) {\n    console.error(cliColors.red, errorMsgWrite(outDir, FILENAME), e);\n  }\n};\n\nconst prepareIgnored = (\n  ignored: string | string[],\n  outDir: string = OUT_DIR\n): string[] | undefined => {\n  let ignore: string[] | undefined;\n  if (ignored) {\n    ignore = Array.isArray(ignored) ? ignored : [ignored];\n    ignore = ignore.map((ignoredPage) => `${outDir}/${ignoredPage}`);\n  }\n  return ignore;\n};\n\nconst prepareChangeFreq = (options: Options): ChangeFreq => {\n  let result: ChangeFreq = null;\n\n  if (options?.changeFreq) {\n    if (CHANGE_FREQ.includes(options.changeFreq)) {\n      result = options.changeFreq;\n    } else {\n      console.log(\n        cliColors.red,\n        `  × Option \\`--change-freq ${options.changeFreq}\\` is not a valid value. See docs: https://github.com/bartholomej/svelte-sitemap#options`\n      );\n    }\n  }\n  return result;\n};\n\nconst getSlash = (domain: string) => (domain.split('/').pop() ? '/' : '');\n\nconst createXml = (elementName: 'urlset' | 'sitemapindex'): XMLBuilder => {\n  return create({ version: '1.0', encoding: 'UTF-8' }).ele(elementName, {\n    xmlns: 'http://www.sitemaps.org/schemas/sitemap/0.9'\n  });\n};\n\nconst finishXml = (sitemap: XMLBuilder): string => {\n  return sitemap.end({ prettyPrint: true });\n};\n\nconst addAttribution = (sitemap: XMLBuilder, options: Options): void => {\n  if (options?.attribution !== false) {\n    sitemap.com(\n      ` This file was automatically generated by https://github.com/bartholomej/svelte-sitemap v${version} `\n    );\n  }\n};\n"],"mappings":";;;;;;;;AAgBA,MAAM,UAAUA;AAEhB,MAAM,UAAU,KAAa,QAAgB,YAAqB;CAChE,IAAI,QAAkB,SAAS,MAAM;CAErC,IAAI,UAAU,IACX,OAAO,SAAS,UAAA,WAAqB,GAAG,CAAC,CACzC,IAAI,CAAC,CACL,QAAQ,cAAc,EAAE;CAE3B,UAAU,WAAW,OAAO;CAG5B,IAAI,SAAS,iBACX,UAAU,QAAQ,UAAU,CAAC,QAAQ,SAAS,GAAG,IAAI,UAAU,MAAM;MAChE;EACL,UAAU,QAAQ,SAAS,GAAG,IAAI,QAAQ,MAAM,GAAG,EAAE,IAAI;EACzD,QAAQ,UAAU,QAAQ;CAC5B;CAIA,UAAU,QACP,MAAM,GAAG,CAAC,CACV,KAAK,YAAY;EAChB,IAAI;GACF,OAAO,mBAAmB,mBAAmB,OAAO,CAAC;EACvD,QAAQ;GACN,OAAO,mBAAmB,OAAO;EACnC;CACF,CAAC,CAAC,CACD,KAAK,GAAG;CAEX,OAAO,GAAG,SAAS,QAAQ;AAC7B;AAEA,MAAa,cAAc,aAAqB;CAC9C,IAAI,UAAU,SAAS,OAAO,GAC5B,OAAO,SAAS,MAAM,GAAG,EAAE;CAE7B,OAAO;AACT;AAEA,eAAsB,YAAY,QAAgB,SAAyC;CACzF,MAAM,SAAS,SAAS,UAAA;CAExB,MAAM,SAAS,eAAe,SAAS,QAAQ,SAAS,MAAM;CAC9D,MAAM,aAAa,kBAAkB,OAAO;CAC5C,MAAM,QAAkB,MAAM,GAAG,GAAG,OAAO,aAAa,EAAE,OAAO,CAAC;CAElE,IAAI,QAAQ,YAAY,MAAM,KAAK,GAAG,QAAQ,UAAU;CAExD,MAAM,UAAU,MAAM,KAAK,SAAS;EAClC,OAAO;GACL,MAAM,OAAO,MAAM,QAAQ,OAAO;GACtB;GACZ,SAAS,SAAS,6BAAY,IAAI,KAAK,EAAA,CAAE,YAAY,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,KAAK;EACzE;CACF,CAAC;CAED,aACE;EACE,QAAQ,CAAC,GAAG,WAAW,MAAM;EAC7B,WAAW,CAAC,MAAM;CACpB,GACA,MACF;CAEA,MAAM,qBAAqB,OAAO,QAAQ,OAAO;CAEjD,OAAO;AACT;AAEA,MAAa,gBACX,EAAE,QAAQ,aACV,SAAiB,YACd;CACH,IAAI,UAAU,WACZ,QAAQ,MAAM,UAAU,KAAK,eAAe,MAAM,CAAC;MAC9C,IAAI,WAET,QAAQ,MAAM,UAAU,KAAK,kBAAkB,MAAM,CAAC;AAE1D;AAEA,MAAa,uBAAuB,OAAO,OAAiB,QAAgB,YAAsB;CAIhG,IAFqB,GAAG,WAAW,KAAK,KAAK,QAAQ,MAAM,CAE5C,KAAK,MAAM,SAAS,GAAG;EACpC,MAAM,wBAAwB,MAAM,OAAO,SAAS;GAClD,MAAM,WAAW,KAAK,SAAS,QAAQ,IAAI;GAC3C,OAAO,aAAa,gBAAgB,aAAa;EACnD,CAAC;EAED,MAAM,kBAAkB,CAAC,SAAS,cAAc,QAAQ,WAAW,WAAW;EAE9E,IAAI,yBAAyB,iBAC3B,QAAQ,KACN,UAAU,QACV,kEAAkE,OAAO,8LAG3E;CAEJ;AACF;AAEA,MAAa,gBAAgB,OAAoB,SAAkB,WAAyB;CAC1F,MAAM,SAAS,SAAS,UAAA;CAExB,IAAI,OAAO,UAAU,MAAM,SACzB,WAAW,OAAO,SAAS,MAAM;MAC5B;EAIL,MAAM,iBAAiB,KAAK,KAAK,MAAM,SAAS,MAAM,OAAO;EAE7D,QAAQ,IACN,UAAU,aACV,yDAAyD,eAAe,iCAC1E;EAEA,KAAK,IAAI,IAAI,GAAG,IAAI,MAAM,QAAQ,KAAK,MAAM,SAE3C,WADc,MAAM,MAAM,GAAG,IAAI,MAAM,OACxB,GAAG,SAAS,QAAQ,IAAI,MAAM,UAAU,CAAC;EAE1D,gBAAgB,gBAAgB,QAAQ,SAAS,MAAM;CACzD;AACF;AAEA,MAAM,cACJ,OACA,SACA,QACA,YACS;CACT,MAAM,UAAU,UAAU,QAAQ;CAClC,eAAe,SAAS,OAAO;CAE/B,KAAK,MAAM,QAAQ,OAAO;EACxB,MAAM,OAAO,QAAQ,IAAI,KAAK;EAC9B,KAAK,IAAI,KAAK,CAAC,CAAC,IAAI,KAAK,IAAI;EAC7B,IAAI,KAAK,YACP,KAAK,IAAI,YAAY,CAAC,CAAC,IAAI,KAAK,UAAU;EAE5C,IAAI,KAAK,SACP,KAAK,IAAI,SAAS,CAAC,CAAC,IAAI,KAAK,OAAO;CAExC;CAEA,MAAM,MAAM,UAAU,OAAO;CAE7B,MAAM,WAAW,UAAU,WAAW,QAAQ,QAAQ;CAEtD,IAAI;EACF,GAAG,cAAc,GAAG,OAAO,GAAG,YAAY,GAAG;EAC7C,QAAQ,IAAI,UAAU,OAAO,WAAW,QAAQ,QAAQ,CAAC;CAC3D,SAAS,GAAG;EACV,QAAQ,MAAM,UAAU,KAAK,cAAc,QAAQ,QAAQ,GAAG,CAAC;CACjE;AACF;AAEA,MAAM,mBACJ,gBACA,QACA,SACA,WACS;CACT,MAAM,WAAW;CACjB,MAAM,QAAQ,SAAS,MAAM;CAE7B,MAAM,UAAU,UAAU,cAAc;CACxC,eAAe,SAAS,OAAO;CAE/B,KAAK,IAAI,IAAI,GAAG,KAAK,gBAAgB,KACnC,QAAQ,IAAI,SAAS,CAAC,CAAC,IAAI,KAAK,CAAC,CAAC,IAAI,GAAG,SAAS,MAAM,UAAU,EAAE,KAAK;CAG3E,MAAM,MAAM,UAAU,OAAO;CAE7B,IAAI;EACF,GAAG,cAAc,GAAG,OAAO,GAAG,YAAY,GAAG;EAC7C,QAAQ,IAAI,UAAU,OAAO,WAAW,QAAQ,QAAQ,CAAC;CAC3D,SAAS,GAAG;EACV,QAAQ,MAAM,UAAU,KAAK,cAAc,QAAQ,QAAQ,GAAG,CAAC;CACjE;AACF;AAEA,MAAM,kBACJ,SACA,SAAiB,YACQ;CACzB,IAAI;CACJ,IAAI,SAAS;EACX,SAAS,MAAM,QAAQ,OAAO,IAAI,UAAU,CAAC,OAAO;EACpD,SAAS,OAAO,KAAK,gBAAgB,GAAG,OAAO,GAAG,aAAa;CACjE;CACA,OAAO;AACT;AAEA,MAAM,qBAAqB,YAAiC;CAC1D,IAAI,SAAqB;CAEzB,IAAI,SAAS,YACX,IAAI,YAAY,SAAS,QAAQ,UAAU,GACzC,SAAS,QAAQ;MAEjB,QAAQ,IACN,UAAU,KACV,8BAA8B,QAAQ,WAAW,yFACnD;CAGJ,OAAO;AACT;AAEA,MAAM,YAAY,WAAoB,OAAO,MAAM,GAAG,CAAC,CAAC,IAAI,IAAI,MAAM;AAEtE,MAAM,aAAa,gBAAuD;CACxE,OAAO,OAAO;EAAE,SAAS;EAAO,UAAU;CAAQ,CAAC,CAAC,CAAC,IAAI,aAAa,EACpE,OAAO,8CACT,CAAC;AACH;AAEA,MAAM,aAAa,YAAgC;CACjD,OAAO,QAAQ,IAAI,EAAE,aAAa,KAAK,CAAC;AAC1C;AAEA,MAAM,kBAAkB,SAAqB,YAA2B;CACtE,IAAI,SAAS,gBAAgB,OAC3B,QAAQ,IACN,4FAA4F,QAAQ,EACtG;AAEJ"}

package/package.js

@@ -1,5 +1,5 @@
 //#region package.json
-var version = "4.0.0";
+var version = "4.0.2";
 //#endregion
 export { version };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelte-sitemap",
-  "version": "4.0.0",
+  "version": "4.0.2",
   "type": "module",
   "description": "Small helper which scans your Svelte routes folder and generates static sitemap.xml",
   "author": "BART! <bart@bartweb.cz>",