multi-sitemap

multi-sitemap

Painless creation of large dynamic sitemaps that consist of multiple files.

Features

• Supports generating sitemaps from dynamic data: e.g. generating a sitemap for all entities in a paginated REST endpoint.
• Automatically splits sitemaps into chunks of 50k entries to comply to the Google guidelines.
• Pluggable writers: Use SitemapWriterXml, SitemapWriterTxt or build your own.
• Utilizes streams, so large amounts of data can be processed without memory issues.
• Built with TypeScript so consumers can take advantage of types.

Usage

import {SitemapProcessor, SitemapWriterXml} from 'multi-sitemap';

(async () => {
  const writer = new SitemapWriterXml({directory: './static/sitemap'});
  const processor = new SitemapProcessor({writer});

  await processor.addStatic({
    name: 'pages',
    entries: ['/', '/about']
  });

  await processor.addDynamic({
    name: 'products',
    reader: new SitemapProductsReader()
  });

  await processor.addIndex();
})();

All methods of SitemapProcessor return promises that should be waited for before calling other methods.

Adding dynamic data

Create a reader class that implements the following interface:

interface ISitemapReader {
  hasNext(): boolean;
  getNext(): Promise<SitemapEntryConfig[]>;
}

// Given the following types:

type SitemapEntryConfig = /* url*/ string | ISitemapEntry;

interface ISitemapEntry {
  url: string;
  lastModified?: Date;
  changeFrequency?:
    | 'always'
    | 'hourly'
    | 'daily'
    | 'weekly'
    | 'monthly'
    | 'yearly'
    | 'never';
  priority?: number;
}

An instance of such a class can be passed to the sitemap processor. An example would be:

/**
 * Fetches 7 pages of products, each consisting
 * of 20 entities that are written to a sitemap.
 */
class SitemapProductsReader {
  i = 0;

  hasNext() {
    return this.i < 7;
  }

  getNext() {
    const size = 20;
    const offset = this.i * size;

    this.i++;

    return fetch(`/api/products?offset=${offset}&size=${size}`)
      .then(products => products.map(product => `/products/${product.id}`))
  }
}

processor.addDynamic({
  name: 'products',
  reader: new SitemapProductsReader()
});