CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 6.4.0
+
+- added support for content_loc parsing #347 and uploader info attr
+- added error handler option to sitemapstream #349 Thanks @marcoreni
+
 ## 6.3.6
 
 - bump dependencies

api.md

@@ -1,21 +1,22 @@
 # API
 
-- [SitemapStream](#sitemapstream)
-- [XMLToSitemapItemStream](#XMLToSitemapItemStream)
-- [sitemapAndIndexStream](#sitemapandindexstream)
-- [createSitemapsAndIndex](#createsitemapsandindex)
-- [SitemapIndexStream](#SitemapIndexStream)
-- [xmlLint](#xmllint)
-- [parseSitemap](#parsesitemap)
-- [lineSeparatedURLsToSitemapOptions](#lineseparatedurlstositemapoptions)
-- [streamToPromise](#streamtopromise)
-- [ObjectStreamToJSON](#objectstreamtojson)
-- [SitemapItemStream](#SitemapItemStream)
-- [Sitemap Item Options](#sitemap-item-options)
-- [SitemapImage](#sitemapimage)
-- [VideoItem](#videoitem)
-- [LinkItem](#linkitem)
-- [NewsItem](#newsitem)
+- [API](#api)
+  - [SitemapStream](#sitemapstream)
+  - [XMLToSitemapItemStream](#xmltositemapitemstream)
+  - [sitemapAndIndexStream](#sitemapandindexstream)
+  - [createSitemapsAndIndex](#createsitemapsandindex)
+  - [SitemapIndexStream](#sitemapindexstream)
+  - [xmlLint](#xmllint)
+  - [parseSitemap](#parsesitemap)
+  - [lineSeparatedURLsToSitemapOptions](#lineseparatedurlstositemapoptions)
+  - [streamToPromise](#streamtopromise)
+  - [ObjectStreamToJSON](#objectstreamtojson)
+  - [SitemapItemStream](#sitemapitemstream)
+  - [Sitemap Item Options](#sitemap-item-options)
+  - [SitemapImage](#sitemapimage)
+  - [VideoItem](#videoitem)
+  - [ILinkItem](#ilinkitem)
+  - [NewsItem](#newsitem)
 
 ## SitemapStream
 
@@ -32,7 +33,8 @@ const sms = new SitemapStream({
     image: true,
     video: true,
     // custom: ['xmlns:custom="https://example.com"']
-  }
+  },
+  errorHandler: undefined // defaults to a standard errorLogger that logs to console or throws if the errorLevel is set to throw
 })
 const readable = // a readable stream of objects
 readable.pipe(sms).pipe(process.stdout)

lib/sitemap-item-stream.ts

@@ -187,7 +187,13 @@ export class SitemapItemStream extends Transform {
       }
 
       if (video.uploader) {
-        this.push(element(TagNames['video:uploader'], video.uploader));
+        this.push(
+          element(
+            TagNames['video:uploader'],
+            attrBuilder(video, 'uploader:info'),
+            video.uploader
+          )
+        );
       }
 
       if (video.platform) {

lib/sitemap-parser.ts

@@ -172,6 +172,9 @@ export class XMLToSitemapItemStream extends Transform {
         case TagNames['video:player_loc']:
           currentVideo.player_loc = text;
           break;
+        case TagNames['video:content_loc']:
+          currentVideo.content_loc = text;
+          break;
         case TagNames['video:requires_subscription']:
           if (isValidYesNo(text)) {
             currentVideo.requires_subscription = text;
@@ -410,6 +413,13 @@ export class XMLToSitemapItemStream extends Transform {
             );
           }
           break;
+        case TagNames['video:uploader']:
+          if (attr.name === 'info') {
+            currentVideo['uploader:info'] = attr.value;
+          } else {
+            this.logger('log', 'unhandled attr for video:uploader', attr.name);
+          }
+          break;
         default:
           this.logger('log', 'unhandled attr', currentTag, attr.name);
       }

lib/sitemap-stream.ts

@@ -6,7 +6,7 @@ import {
   Readable,
   Writable,
 } from 'stream';
-import { SitemapItemLoose, ErrorLevel } from './types';
+import { SitemapItemLoose, ErrorLevel, ErrorHandler } from './types';
 import { validateSMIOptions, normalizeURL } from './utils';
 import { SitemapItemStream } from './sitemap-item-stream';
 import { EmptyStream, EmptySitemap } from './errors';
@@ -69,6 +69,7 @@ export interface SitemapStreamOptions extends TransformOptions {
   lastmodDateOnly?: boolean;
   xmlns?: NSArgs;
   xslUrl?: string;
+  errorHandler?: ErrorHandler;
 }
 const defaultXMLNS: NSArgs = {
   news: true,
@@ -92,6 +93,7 @@ export class SitemapStream extends Transform {
   hasHeadOutput: boolean;
   xmlNS: NSArgs;
   xslUrl?: string;
+  errorHandler?: ErrorHandler;
   private smiStream: SitemapItemStream;
   lastmodDateOnly: boolean;
   constructor(opts = defaultStreamOpts) {
@@ -100,6 +102,7 @@ export class SitemapStream extends Transform {
     this.hasHeadOutput = false;
     this.hostname = opts.hostname;
     this.level = opts.level || ErrorLevel.WARN;
+    this.errorHandler = opts.errorHandler;
     this.smiStream = new SitemapItemStream({ level: opts.level });
     this.smiStream.on('data', (data) => this.push(data));
     this.lastmodDateOnly = opts.lastmodDateOnly || false;
@@ -119,7 +122,8 @@ export class SitemapStream extends Transform {
     this.smiStream.write(
       validateSMIOptions(
         normalizeURL(item, this.hostname, this.lastmodDateOnly),
-        this.level
+        this.level,
+        this.errorHandler
       )
     );
     callback();

lib/types.ts

@@ -208,6 +208,12 @@ interface VideoItemBase {
    */
   'restriction:relationship'?: EnumAllowDeny;
   gallery_loc?: string;
+  /**
+   * [Optional] Specifies the URL of a webpage with additional information about this uploader. This URL must be in the same domain as the <loc> tag.
+   * @see https://developers.google.com/search/docs/advanced/sitemaps/video-sitemaps
+   * @example http://www.example.com/users/grillymcgrillerson
+   */
+  'uploader:info'?: string;
   'gallery_loc:title'?: string;
   /**
    * The price to download or view the video. Omit this tag for free videos.
@@ -368,6 +374,8 @@ export enum ErrorLevel {
   THROW = 'throw',
 }
 
+export type ErrorHandler = (error: Error, level: ErrorLevel) => void;
+
 export enum TagNames {
   url = 'url',
   loc = 'loc',

lib/utils.ts

@@ -21,6 +21,7 @@ import {
   isPriceType,
   isResolution,
   NewsItem,
+  ErrorHandler,
 } from './types';
 import {
   ChangeFreqInvalidError,
@@ -83,7 +84,7 @@ function handleError(error: Error, level: ErrorLevel): void {
 export function validateSMIOptions(
   conf: SitemapItem,
   level = ErrorLevel.WARN,
-  errorHandler = handleError
+  errorHandler: ErrorHandler = handleError
 ): SitemapItem {
   if (!conf) {
     throw new NoConfigError();