@sphido/sitemap 2.0.25 → 3.0.1

package/dist/sitemap.d.ts

@@ -0,0 +1,17 @@
+interface SitemapParams {
+    url: string;
+    date?: Date;
+    priority?: number;
+    changefreq?: "daily" | "weekly" | "monthly" | "yearly";
+}
+export type Sitemap = {
+    add: (params: SitemapParams) => void;
+    end: () => Promise<void>;
+};
+/**
+ * Generate XML sitemap
+ * @see https://www.sitemaps.org/protocol.html
+ */
+export declare function createSitemap(file?: string): Promise<Sitemap>;
+export {};
+//# sourceMappingURL=sitemap.d.ts.map

package/dist/sitemap.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sitemap.d.ts","sourceRoot":"","sources":["../lib/sitemap.ts"],"names":[],"mappings":"AAcA,UAAU,aAAa;IACtB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,IAAI,CAAC;IACZ,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,QAAQ,CAAC;CACvD;AAED,MAAM,MAAM,OAAO,GAAG;IACrB,GAAG,EAAE,CAAC,MAAM,EAAE,aAAa,KAAK,IAAI,CAAC;IACrC,GAAG,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;CACzB,CAAC;AAEF;;;GAGG;AACH,wBAAsB,aAAa,CAAC,IAAI,SAAuB,GAAG,OAAO,CAAC,OAAO,CAAC,CAmCjF"}

package/dist/sitemap.js

@@ -0,0 +1,48 @@
+import { createWriteStream, existsSync } from "node:fs";
+import { mkdir, unlink } from "node:fs/promises";
+import { dirname } from "node:path";
+/** Escape text for XML element content (order: `&` first). */
+function escapeXml(text) {
+    return text
+        .replaceAll("&", "&")
+        .replaceAll("<", "&lt;")
+        .replaceAll(">", "&gt;")
+        .replaceAll('"', "&quot;")
+        .replaceAll("'", "&apos;");
+}
+/**
+ * Generate XML sitemap
+ * @see https://www.sitemaps.org/protocol.html
+ */
+export async function createSitemap(file = "public/sitemap.xml") {
+    // Create directory
+    if (!existsSync(dirname(file))) {
+        await mkdir(dirname(file), { recursive: true });
+    }
+    // Truncate file
+    if (existsSync(file)) {
+        await unlink(file);
+    }
+    // Create stream
+    const sitemap = createWriteStream(file, { flags: "a" });
+    sitemap.write('<?xml version="1.0" encoding="UTF-8"?>\n');
+    sitemap.write('<urlset xmlns="https://www.sitemaps.org/schemas/sitemap/0.9">\n');
+    return {
+        add({ url, date = new Date(), priority = 0.5, changefreq = "monthly" }) {
+            sitemap.write("\t<url>\n");
+            sitemap.write(`\t\t<loc>${escapeXml(String(url))}</loc>\n`);
+            sitemap.write(`\t\t<lastmod>${date.toISOString()}</lastmod>\n`);
+            sitemap.write(`\t\t<priority>${priority}</priority>\n`);
+            sitemap.write(`\t\t<changefreq>${changefreq}</changefreq>\n`);
+            sitemap.write("\t</url>\n");
+        },
+        end() {
+            return new Promise((resolve, reject) => {
+                sitemap.write("</urlset>");
+                sitemap.end();
+                sitemap.on("finish", resolve);
+                sitemap.on("error", reject);
+            });
+        },
+    };
+}

package/package.json

@@ -1,26 +1,32 @@
 {
   "name": "@sphido/sitemap",
-  "version": "2.0.25",
+  "version": "3.0.1",
   "type": "module",
   "author": "Roman Ožana <roman@ozana.cz> (https://ozana.cz)",
   "homepage": "https://sphido.cz",
   "repository": "sphido/sphido",
   "description": "Sitemap XML for Sphido CMS",
-  "exports": "./lib/sitemap.js",
+  "files": [
+    "dist"
+  ],
+  "exports": "./dist/sitemap.js",
+  "types": "dist/sitemap.d.ts",
+  "main": "dist/sitemap.js",
   "keywords": [
     "sphido",
     "sitemap"
   ],
   "engines": {
-    "node": ">=16"
+    "node": ">=22"
   },
   "license": "MIT",
   "devDependencies": {
-    "@sindresorhus/slugify": "^2.2.1",
-    "ava": "^6.1.2"
+    "@sindresorhus/slugify": "^3.0.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.17"
   },
   "scripts": {
-    "test": "ava"
-  },
-  "gitHead": "1fedea6a21c873a1e809b89e1058442034659176"
-}
+    "test": "vitest run --passWithNoTests",
+    "build": "rm -rf dist/* && tsc"
+  }
+}

package/readme.md

@@ -1,9 +1,11 @@
 # @sphido/sitemap
 
+Generates [XML sitemap](https://www.sitemaps.org/protocol.html) files for Sphido CMS.
+
 ## Install
 
 ```bash
-yarn add @sphido/sitemap
+pnpm add @sphido/sitemap
 ```
 
 ## Example
@@ -11,11 +13,10 @@ yarn add @sphido/sitemap
 ```javascript
 #!/usr/bin/env node
 
-import {dirname, relative, join} from 'node:path';
-import {getPages, allPages} from '@sphido/core';
+import { dirname, relative, join } from 'node:path';
+import { getPages, allPages } from '@sphido/core';
 import slugify from '@sindresorhus/slugify';
-import {createSitemap} from '@sphido/sitemap';
-import got from 'got';
+import { createSitemap } from '@sphido/sitemap';
 
 const pages = await getPages({path: 'content'});
 const map = await createSitemap('sitemap.xml');
@@ -36,9 +37,9 @@ for (const page of await allPages(pages)) {
 	map.add(page);
 }
 
-map.end();
+await map.end();
 ```
 
-## Source codes
+## Source code
 
 [@sphido/sitemap](https://github.com/sphido/sphido/tree/main/packages/sphido-sitemap)

package/lib/sitemap.js

@@ -1,53 +0,0 @@
-import {createWriteStream, existsSync} from 'node:fs';
-import {mkdir, unlink} from 'node:fs/promises';
-import {dirname} from 'node:path';
-
-/**
- * Generate XML sitemap
- * @see https://www.sitemaps.org/protocol.html
- * @param {string} file
- * @return {Promise<{add({url: string, date?: Date, priority?: Number, changefreq?: string}=): void, end(): void}>}
- */
-export async function createSitemap(file = 'public/sitemap.xml') {
-	// Create directory
-	if (!existsSync(dirname(file))) {
-		await mkdir(dirname(file), {recursive: true});
-	}
-
-	// Truncate file
-	if (existsSync(file)) {
-		await unlink(file);
-	}
-
-	// Create stream
-	const sitemap = createWriteStream(file, {flags: 'a'});
-	sitemap.write('<?xml version="1.0" encoding="UTF-8"?>\r\n');
-	sitemap.write('<urlset xmlns="https://www.sitemaps.org/schemas/sitemap/0.9">\r\n');
-
-	return {
-		/**
-		 * Add URL to sitemap
-		 * @param {string} url
-		 * @param {Date} date
-		 * @param {Number} priority
-		 * @param {string} changefreq
-		 */
-
-		add({url, date = new Date(), priority = 0.5, changefreq = 'monthly'} = {}) {
-			sitemap.write('\t<url>\r\n');
-			sitemap.write(`\t\t<loc>${url}</loc>\r\n`);
-			sitemap.write(`\t\t<lastmod>${date.toISOString()}</lastmod>\r\n`);
-			sitemap.write(`\t\t<priority>${priority}</priority>\r\n`);
-			sitemap.write(`\t\t<changefreq>${changefreq}</changefreq>\r\n`);
-			sitemap.write('\t</url>\r\n');
-		},
-
-		/**
-		 * Save sitemap end
-		 */
-		end() {
-			sitemap.write('</urlset>');
-			sitemap.end();
-		},
-	};
-}