From c9f86698625b63ed0c8d25ea2635cbaa9e49c6c1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Piotr=20B=C5=82a=C5=BCejewicz=20=28Peter=20Blazejewicz=29?=
 <peterblazejewicz@users.noreply.github.com>
Date: Sat, 11 Apr 2020 04:43:08 +0200
Subject: [PATCH] update(express-sitemap-xml): align with v1.1 (#43619)

- minor changes to structure and JSDoc
- version bump to current 1.1
- mantainer added

https://github.com/feross/express-sitemap-xml#api

Tnanks!
---
 .../express-sitemap-xml-tests.ts              |  7 ++++---
 types/express-sitemap-xml/index.d.ts          | 21 +++++++++++++++----
 2 files changed, 21 insertions(+), 7 deletions(-)

diff --git a/types/express-sitemap-xml/express-sitemap-xml-tests.ts b/types/express-sitemap-xml/express-sitemap-xml-tests.ts
index 2952038195..eab2285d05 100644
--- a/types/express-sitemap-xml/express-sitemap-xml-tests.ts
+++ b/types/express-sitemap-xml/express-sitemap-xml-tests.ts
@@ -1,11 +1,11 @@
-import * as express from 'express';
-
+import express = require('express');
 import expressSitemapXml = require('express-sitemap-xml');
+import { buildSitemaps } from 'express-sitemap-xml';
 
 const page2Leaf: expressSitemapXml.LeafObject = {
     changeFreq: 'weekly',
     lastMod: new Date(),
-    url: '/page2'
+    url: '/page2',
 };
 
 const leaves = ['/page1', page2Leaf];
@@ -14,6 +14,7 @@ const getLeaves = () => leaves;
 const getLeavesPromise = () => Promise.resolve(leaves);
 
 expressSitemapXml.buildSitemaps(leaves, base).then(sitemap => typeof sitemap === 'object');
+buildSitemaps(leaves, base).then(sitemap => typeof sitemap === 'object');
 
 const sitemap1 = expressSitemapXml(getLeaves, base);
 const sitemap2 = expressSitemapXml(getLeavesPromise, base);
diff --git a/types/express-sitemap-xml/index.d.ts b/types/express-sitemap-xml/index.d.ts
index bc58282719..bbc5775c90 100644
--- a/types/express-sitemap-xml/index.d.ts
+++ b/types/express-sitemap-xml/index.d.ts
@@ -1,12 +1,20 @@
-// Type definitions for express-sitemap-xml 1.0
+// Type definitions for express-sitemap-xml 1.1
 // Project: https://github.com/feross/express-sitemap-xml
 // Definitions by: Florian Keller <https://github.com/ffflorian>
+//                 Piotr Błażejewicz <https://github.com/peterblazejewicz>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 // TypeScript Version: 2.3
 
-import * as express from 'express';
+import express = require('express');
 
-declare function expressSitemapXml(getUrls: (() => (expressSitemapXml.SitemapLeaf[] | Promise<expressSitemapXml.SitemapLeaf[]>)), base: string): express.RequestHandler;
+/**
+ * Express middleware to serve {@link https://en.wikipedia.org/wiki/Sitemaps|`sitemap.xml`} from a list of URLs
+ * Create a sitemap.xml middleware.
+ */
+declare function expressSitemapXml(
+    getUrls: () => expressSitemapXml.SitemapLeaf[] | Promise<expressSitemapXml.SitemapLeaf[]>,
+    base: string,
+): express.RequestHandler;
 
 declare namespace expressSitemapXml {
     interface LeafObject {
@@ -21,7 +29,12 @@ declare namespace expressSitemapXml {
         [leaf: string]: string;
     }
 
-   function buildSitemaps(urls: SitemapLeaf[], base: string): Promise<Sitemap>;
+    /**
+     *
+     * Create an object where the keys are sitemap URLs to be served by the server
+     * and the values are strings of sitemap XML content
+     */
+    function buildSitemaps(urls: SitemapLeaf[], base: string): Promise<Sitemap>;
 }
 
 export = expressSitemapXml;