@docusaurus/plugin-sitemap 3.9.1 → 3.9.2-alpha.0-canary-6548

package/lib/createSitemapItem.js

@@ -9,9 +9,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createSitemapItem = createSitemapItem;
 const utils_common_1 = require("@docusaurus/utils-common");
 const utils_1 = require("@docusaurus/utils");
-async function getRouteLastUpdatedAt(route) {
+async function getRouteLastUpdatedAt(route, vcs) {
     // Important to bail-out early here
-    // This can lead to duplicated getLastUpdate() calls and performance problems
+    // This can lead to duplicated VCS calls and performance problems
     // See https://github.com/facebook/docusaurus/pull/11211
     if (route.metadata?.lastUpdatedAt === null) {
         return null;
@@ -20,8 +20,8 @@ async function getRouteLastUpdatedAt(route) {
         return route.metadata?.lastUpdatedAt;
     }
     if (route.metadata?.sourceFilePath) {
-        const lastUpdate = await (0, utils_1.getLastUpdate)(route.metadata?.sourceFilePath);
-        return lastUpdate?.lastUpdatedAt ?? null;
+        const lastUpdateInfo = await vcs.getFileLastUpdateInfo(route.metadata?.sourceFilePath);
+        return lastUpdateInfo?.timestamp ?? null;
     }
     return undefined;
 }
@@ -33,11 +33,11 @@ function formatLastmod(timestamp, lastmodOption) {
     const format = LastmodFormatters[lastmodOption];
     return format(timestamp);
 }
-async function getRouteLastmod({ route, lastmod, }) {
+async function getRouteLastmod({ route, lastmod, vcs, }) {
     if (lastmod === null) {
         return null;
     }
-    const lastUpdatedAt = (await getRouteLastUpdatedAt(route)) ?? null;
+    const lastUpdatedAt = (await getRouteLastUpdatedAt(route, vcs)) ?? null;
     return lastUpdatedAt ? formatLastmod(lastUpdatedAt, lastmod) : null;
 }
 async function createSitemapItem({ route, siteConfig, options, }) {
@@ -52,6 +52,10 @@ async function createSitemapItem({ route, siteConfig, options, }) {
         ]),
         changefreq,
         priority,
-        lastmod: await getRouteLastmod({ route, lastmod }),
+        lastmod: await getRouteLastmod({
+            route,
+            lastmod,
+            vcs: siteConfig.future.experimental_vcs,
+        }),
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-sitemap",
-  "version": "3.9.1",
+  "version": "3.9.2-alpha.0-canary-6548",
   "description": "Simple sitemap generation plugin for Docusaurus.",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -18,12 +18,12 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "3.9.1",
-    "@docusaurus/logger": "3.9.1",
-    "@docusaurus/types": "3.9.1",
-    "@docusaurus/utils": "3.9.1",
-    "@docusaurus/utils-common": "3.9.1",
-    "@docusaurus/utils-validation": "3.9.1",
+    "@docusaurus/core": "3.9.2-alpha.0-canary-6548",
+    "@docusaurus/logger": "3.9.2-alpha.0-canary-6548",
+    "@docusaurus/types": "3.9.2-alpha.0-canary-6548",
+    "@docusaurus/utils": "3.9.2-alpha.0-canary-6548",
+    "@docusaurus/utils-common": "3.9.2-alpha.0-canary-6548",
+    "@docusaurus/utils-validation": "3.9.2-alpha.0-canary-6548",
     "fs-extra": "^11.1.1",
     "sitemap": "^7.1.1",
     "tslib": "^2.6.0"
@@ -38,5 +38,5 @@
   "engines": {
     "node": ">=20.0"
   },
-  "gitHead": "c0dd59f0e712f85b6053c59e46b0514b5d2d1414"
+  "gitHead": "7694572787296be09b95c6ff0a541ae19185a9f5"
 }

package/src/createSitemapItem.ts

@@ -6,16 +6,17 @@
  */
 
 import {applyTrailingSlash} from '@docusaurus/utils-common';
-import {getLastUpdate, normalizeUrl} from '@docusaurus/utils';
+import {normalizeUrl} from '@docusaurus/utils';
 import type {LastModOption, SitemapItem} from './types';
-import type {DocusaurusConfig, RouteConfig} from '@docusaurus/types';
+import type {DocusaurusConfig, RouteConfig, VcsConfig} from '@docusaurus/types';
 import type {PluginOptions} from './options';
 
 async function getRouteLastUpdatedAt(
   route: RouteConfig,
+  vcs: Pick<VcsConfig, 'getFileLastUpdateInfo'>,
 ): Promise<number | null | undefined> {
   // Important to bail-out early here
-  // This can lead to duplicated getLastUpdate() calls and performance problems
+  // This can lead to duplicated VCS calls and performance problems
   // See https://github.com/facebook/docusaurus/pull/11211
   if (route.metadata?.lastUpdatedAt === null) {
     return null;
@@ -24,8 +25,10 @@ async function getRouteLastUpdatedAt(
     return route.metadata?.lastUpdatedAt;
   }
   if (route.metadata?.sourceFilePath) {
-    const lastUpdate = await getLastUpdate(route.metadata?.sourceFilePath);
-    return lastUpdate?.lastUpdatedAt ?? null;
+    const lastUpdateInfo = await vcs.getFileLastUpdateInfo(
+      route.metadata?.sourceFilePath,
+    );
+    return lastUpdateInfo?.timestamp ?? null;
   }
 
   return undefined;
@@ -46,14 +49,16 @@ function formatLastmod(timestamp: number, lastmodOption: LastModOption) {
 async function getRouteLastmod({
   route,
   lastmod,
+  vcs,
 }: {
   route: RouteConfig;
   lastmod: LastModOption | null;
+  vcs: Pick<VcsConfig, 'getFileLastUpdateInfo'>;
 }): Promise<string | null> {
   if (lastmod === null) {
     return null;
   }
-  const lastUpdatedAt = (await getRouteLastUpdatedAt(route)) ?? null;
+  const lastUpdatedAt = (await getRouteLastUpdatedAt(route, vcs)) ?? null;
   return lastUpdatedAt ? formatLastmod(lastUpdatedAt, lastmod) : null;
 }
 
@@ -77,6 +82,10 @@ export async function createSitemapItem({
     ]),
     changefreq,
     priority,
-    lastmod: await getRouteLastmod({route, lastmod}),
+    lastmod: await getRouteLastmod({
+      route,
+      lastmod,
+      vcs: siteConfig.future.experimental_vcs,
+    }),
   };
 }