@nuxtjs/sitemap 8.2.2 → 8.3.0

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

@@ -1,8 +1,9 @@
 import type { FilterInput } from './types.js';
 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];
+export declare function xmlEscape(value: string | number | boolean | Date): string;
+export declare function mergeOnKey<T, K extends keyof T>(arr: T[], key: K, onMerge?: (key: T[K]) => void): T[];
+export declare function splitForLocales(path: string, locales: readonly string[] | Set<string>): [string | null, string];
 /**
  * Resolve which locale a multi-sitemap name belongs to.
  *
@@ -20,10 +21,10 @@ export declare function normalizeRuntimeFilters(input?: FilterInput[]): (RegExp
 export declare function createPathFilter(options?: {
     include?: (FilterInput | string | RegExp)[];
     exclude?: (FilterInput | string | RegExp)[];
-}, baseURL?: string): (loc: string) => boolean;
+}, baseURL?: string): (loc: string, pathname?: string) => boolean;
 export interface PageMatch {
     mappings: Record<string, string | false>;
     paramSegments: string[];
 }
-export declare function findPageMapping(pathWithoutPrefix: string, pages: Record<string, Record<string, string | false>>): PageMatch | null;
+export declare function findPageMapping(pathWithoutPrefix: string, pages: Record<string, Record<string, string | false>>, sortedKeys?: string[]): PageMatch | null;
 export declare function applyDynamicParams(customPath: string, paramSegments: string[]): string;

package/dist/runtime/utils-pure.js

@@ -1,39 +1,59 @@
 import { createConsola } from "consola";
 import { createDefu } from "defu";
 import { createFilter } from "nuxtseo-shared/utils";
-import { parseURL, withLeadingSlash, withoutBase } from "ufo";
+import { parseURL, withoutBase } from "ufo";
 export { createFilter } from "nuxtseo-shared/utils";
 export const logger = createConsola({
   defaults: {
     tag: "@nuxt/sitemap"
   }
 });
+const XML_ENTITIES = {
+  "&": "&",
+  "<": "&lt;",
+  ">": "&gt;",
+  '"': "&quot;",
+  "'": "&apos;"
+};
+const XML_SPECIAL_CHARS_RE = /[&<>"']/g;
+const HAS_XML_SPECIAL_CHARS_RE = /[&<>"']/;
+export function xmlEscape(value) {
+  const input = String(value);
+  return HAS_XML_SPECIAL_CHARS_RE.test(input) ? input.replace(XML_SPECIAL_CHARS_RE, (char) => XML_ENTITIES[char]) : input;
+}
 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) {
+export function mergeOnKey(arr, key, onMerge) {
+  if (arr.length < 2)
+    return arr;
   const seen = /* @__PURE__ */ new Map();
   let resultLength = 0;
-  const result = Array.from({ length: arr.length });
   for (const item of arr) {
     const k = item[key];
     if (seen.has(k)) {
       const existingIndex = seen.get(k);
-      result[existingIndex] = merger(item, result[existingIndex]);
+      onMerge?.(item[key]);
+      arr[existingIndex] = merger(item, arr[existingIndex]);
     } else {
       seen.set(k, resultLength);
-      result[resultLength++] = item;
+      arr[resultLength++] = item;
     }
   }
-  result.length = resultLength;
-  return result;
+  arr.length = resultLength;
+  return arr;
 }
 export function splitForLocales(path, locales) {
-  const prefix = withLeadingSlash(path).split("/")[1];
-  if (prefix && locales.includes(prefix))
-    return [prefix, path.replace(`/${prefix}`, "")];
+  const start = path.charCodeAt(0) === 47 ? 1 : 0;
+  const end = path.indexOf("/", start);
+  const prefix = path.slice(start, end === -1 ? path.length : end);
+  const hasLocale = locales instanceof Set ? locales.has(prefix) : locales.includes(prefix);
+  if (prefix && hasLocale) {
+    const prefixEnd = start + prefix.length;
+    return [prefix, start === 1 ? path.slice(prefixEnd) : path];
+  }
   return [null, path];
 }
 export function resolveI18nSitemapLocaleKey(sitemapName, localeSitemapKeys) {
@@ -63,25 +83,27 @@ export function createPathFilter(options = {}, baseURL) {
     exclude: normalizeRuntimeFilters(options.exclude)
   });
   const hasBase = baseURL && baseURL !== "/";
-  return (loc) => {
-    let path = loc;
-    try {
-      path = parseURL(loc).pathname;
-    } catch {
-      return false;
+  return (loc, pathname) => {
+    let path = pathname;
+    if (typeof path !== "string") {
+      try {
+        path = parseURL(loc).pathname;
+      } catch {
+        return false;
+      }
     }
     if (hasBase)
       path = withoutBase(path, baseURL);
     return urlFilter(path);
   };
 }
-export function findPageMapping(pathWithoutPrefix, pages) {
+export function findPageMapping(pathWithoutPrefix, pages, sortedKeys) {
   const stripped = pathWithoutPrefix[0] === "/" ? pathWithoutPrefix.slice(1) : pathWithoutPrefix;
   const pageKey = stripped.endsWith("/index") ? stripped.slice(0, -6) || "index" : stripped || "index";
   if (pages[pageKey])
     return { mappings: pages[pageKey], paramSegments: [] };
-  const sortedKeys = Object.keys(pages).sort((a, b) => b.length - a.length);
-  for (const key of sortedKeys) {
+  const keys = sortedKeys || Object.keys(pages).sort((a, b) => b.length - a.length);
+  for (const key of keys) {
     if (pageKey.startsWith(`${key}/`)) {
       const paramPath = pageKey.slice(key.length + 1);
       return { mappings: pages[key], paramSegments: paramPath.split("/") };

package/dist/utils.d.mts

@@ -22,6 +22,34 @@ interface SitemapParseResult {
     urls: SitemapUrlInput[];
     warnings: SitemapWarning[];
 }
+type SitemapXmlChunk = string | Uint8Array;
+type SitemapXmlInput = SitemapXmlChunk | Iterable<SitemapXmlChunk> | AsyncIterable<SitemapXmlChunk> | ReadableStream<SitemapXmlChunk>;
+interface SitemapStreamOptions {
+    maxEntryBytes?: number;
+    maxBufferBytes?: number;
+}
+type SitemapXmlStreamEvent = {
+    _tag: 'url';
+    url: SitemapUrlInput;
+} | {
+    _tag: 'warning';
+    warning: SitemapWarning;
+};
+type SitemapIndexStreamEvent = {
+    _tag: 'sitemap';
+    sitemap: SitemapIndexEntry;
+} | {
+    _tag: 'warning';
+    warning: SitemapWarning;
+};
+type SitemapKind = 'urlset' | 'index';
+type SitemapStreamEvent = {
+    _tag: 'kind';
+    kind: SitemapKind;
+} | SitemapXmlStreamEvent | SitemapIndexStreamEvent;
+declare function parseSitemapStream(input: SitemapXmlInput, options?: SitemapStreamOptions): AsyncGenerator<SitemapStreamEvent>;
+declare function parseSitemapXmlStream(input: SitemapXmlInput, options?: SitemapStreamOptions): AsyncGenerator<SitemapXmlStreamEvent>;
+declare function parseSitemapIndexStream(input: SitemapXmlInput, options?: SitemapStreamOptions): AsyncGenerator<SitemapIndexStreamEvent>;
 declare function parseSitemapXml(xml: string): Promise<SitemapParseResult>;
 
 interface SitemapIndexEntry {
@@ -35,5 +63,5 @@ interface SitemapIndexParseResult {
 declare function parseSitemapIndex(xml: string): Promise<SitemapIndexParseResult>;
 declare function isSitemapIndex(xml: string): boolean;
 
-export { isSitemapIndex, parseHtmlExtractSitemapMeta, parseSitemapIndex, parseSitemapXml };
-export type { SitemapIndexEntry, SitemapIndexParseResult, SitemapParseResult, SitemapWarning };
+export { isSitemapIndex, parseHtmlExtractSitemapMeta, parseSitemapIndex, parseSitemapIndexStream, parseSitemapStream, parseSitemapXml, parseSitemapXmlStream };
+export type { SitemapIndexEntry, SitemapIndexParseResult, SitemapIndexStreamEvent, SitemapKind, SitemapParseResult, SitemapStreamEvent, SitemapStreamOptions, SitemapWarning, SitemapXmlChunk, SitemapXmlInput, SitemapXmlStreamEvent };

package/dist/utils.d.ts

@@ -22,6 +22,34 @@ interface SitemapParseResult {
     urls: SitemapUrlInput[];
     warnings: SitemapWarning[];
 }
+type SitemapXmlChunk = string | Uint8Array;
+type SitemapXmlInput = SitemapXmlChunk | Iterable<SitemapXmlChunk> | AsyncIterable<SitemapXmlChunk> | ReadableStream<SitemapXmlChunk>;
+interface SitemapStreamOptions {
+    maxEntryBytes?: number;
+    maxBufferBytes?: number;
+}
+type SitemapXmlStreamEvent = {
+    _tag: 'url';
+    url: SitemapUrlInput;
+} | {
+    _tag: 'warning';
+    warning: SitemapWarning;
+};
+type SitemapIndexStreamEvent = {
+    _tag: 'sitemap';
+    sitemap: SitemapIndexEntry;
+} | {
+    _tag: 'warning';
+    warning: SitemapWarning;
+};
+type SitemapKind = 'urlset' | 'index';
+type SitemapStreamEvent = {
+    _tag: 'kind';
+    kind: SitemapKind;
+} | SitemapXmlStreamEvent | SitemapIndexStreamEvent;
+declare function parseSitemapStream(input: SitemapXmlInput, options?: SitemapStreamOptions): AsyncGenerator<SitemapStreamEvent>;
+declare function parseSitemapXmlStream(input: SitemapXmlInput, options?: SitemapStreamOptions): AsyncGenerator<SitemapXmlStreamEvent>;
+declare function parseSitemapIndexStream(input: SitemapXmlInput, options?: SitemapStreamOptions): AsyncGenerator<SitemapIndexStreamEvent>;
 declare function parseSitemapXml(xml: string): Promise<SitemapParseResult>;
 
 interface SitemapIndexEntry {
@@ -35,5 +63,5 @@ interface SitemapIndexParseResult {
 declare function parseSitemapIndex(xml: string): Promise<SitemapIndexParseResult>;
 declare function isSitemapIndex(xml: string): boolean;
 
-export { isSitemapIndex, parseHtmlExtractSitemapMeta, parseSitemapIndex, parseSitemapXml };
-export type { SitemapIndexEntry, SitemapIndexParseResult, SitemapParseResult, SitemapWarning };
+export { isSitemapIndex, parseHtmlExtractSitemapMeta, parseSitemapIndex, parseSitemapIndexStream, parseSitemapStream, parseSitemapXml, parseSitemapXmlStream };
+export type { SitemapIndexEntry, SitemapIndexParseResult, SitemapIndexStreamEvent, SitemapKind, SitemapParseResult, SitemapStreamEvent, SitemapStreamOptions, SitemapWarning, SitemapXmlChunk, SitemapXmlInput, SitemapXmlStreamEvent };