Merge pull request #350 from ekalinin/content_loc

added support for content_loc, uploader info, error handler in sitema…
ekalinin · Feb 17, 2021 · 0921341 · 0921341
2 parents 30c392d + 4ae411f
commit 0921341
Show file tree

Hide file tree

Showing 13 changed files with 534 additions and 380 deletions.
diff --git a/CHANGELOG.md b/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

diff --git a/lib/sitemap-item-stream.ts b/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) {

diff --git a/lib/sitemap-parser.ts b/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);
       }

diff --git a/lib/types.ts b/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.

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "sitemap",
-  "version": "6.3.6",
+  "version": "6.4.0",
   "description": "Sitemap-generating lib/cli",
   "keywords": [
     "sitemap",
@@ -155,28 +155,28 @@
     }
   },
   "dependencies": {
-    "@types/node": "^14.14.25",
+    "@types/node": "^14.14.28",
     "@types/sax": "^1.2.1",
     "arg": "^5.0.0",
     "sax": "^1.2.4"
   },
   "devDependencies": {
-    "@babel/core": "^7.12.13",
+    "@babel/core": "^7.12.16",
     "@babel/plugin-proposal-class-properties": "^7.12.13",
     "@babel/plugin-proposal-nullish-coalescing-operator": "^7.12.13",
-    "@babel/plugin-proposal-optional-chaining": "^7.12.13",
-    "@babel/plugin-transform-typescript": "^7.12.13",
-    "@babel/preset-env": "^7.12.13",
-    "@babel/preset-typescript": "^7.12.13",
+    "@babel/plugin-proposal-optional-chaining": "^7.12.16",
+    "@babel/plugin-transform-typescript": "^7.12.16",
+    "@babel/preset-env": "^7.12.16",
+    "@babel/preset-typescript": "^7.12.16",
     "@types/jest": "^26.0.20",
-    "@typescript-eslint/eslint-plugin": "^4.15.0",
-    "@typescript-eslint/parser": "^4.15.0",
+    "@typescript-eslint/eslint-plugin": "^4.15.1",
+    "@typescript-eslint/parser": "^4.15.1",
     "babel-eslint": "^10.1.0",
     "babel-polyfill": "^6.26.0",
     "concurrently": "^5.3.0",
-    "eslint": "^7.19.0",
+    "eslint": "^7.20.0",
     "eslint-config-prettier": "^7.2.0",
-    "eslint-plugin-jest": "^24.1.3",
+    "eslint-plugin-jest": "^24.1.5",
     "eslint-plugin-prettier": "^3.3.1",
     "express": "^4.17.1",
     "husky": "^4.3.8",

diff --git a/tests/mocks/alltags.cdata.xml b/tests/mocks/alltags.cdata.xml
@@ -44,7 +44,7 @@
       <video:gallery_loc title="awhu series page&amp;>&lt;'&quot;">https://roosterteeth.com/series/awhu&amp;&gt;&lt;'"</video:gallery_loc>
       <video:price resolution="HD" currency="USD" type="rent">1.99</video:price>
       <video:requires_subscription>no</video:requires_subscription>
-      <video:uploader>GrillyMcGrillerson&amp;&gt;&lt;'"</video:uploader>
+      <video:uploader info="http://www.example.com/users/grillymcgrillerson">GrillyMcGrillerson&amp;&gt;&lt;'"</video:uploader>
       <video:platform relationship="allow">tv</video:platform>
       <video:live>no</video:live>
     </video:video>
@@ -62,7 +62,7 @@
       <video:description>
         <![CDATA[Achievement Hunter's House Party quest for some one-night intimacy continues. Can they use Ashley and Madison's sibling rivalry for their own dubious gains?&><'"]]>
       </video:description>
-      <video:player_loc>https://roosterteeth.com/embed/let-s-watch-2018-house-party-part-2&amp;&gt;&lt;'"</video:player_loc>
+      <video:content_loc>http://streamserver.example.com/video123.mp4</video:content_loc>
       <video:duration>2422</video:duration>
       <video:publication_date>2018-04-26T17:00:00.000Z</video:publication_date>
       <video:requires_subscription>no</video:requires_subscription>

diff --git a/tests/mocks/alltags.xml b/tests/mocks/alltags.xml
@@ -36,7 +36,7 @@
       <video:gallery_loc title="awhu series page&amp;>&lt;'&quot;">https://roosterteeth.com/series/awhu&amp;&gt;&lt;'"</video:gallery_loc>
       <video:price resolution="HD" currency="USD" type="rent">1.99</video:price>
       <video:requires_subscription>no</video:requires_subscription>
-      <video:uploader>GrillyMcGrillerson&amp;&gt;&lt;'"</video:uploader>
+      <video:uploader info="http://www.example.com/users/grillymcgrillerson">GrillyMcGrillerson&amp;&gt;&lt;'"</video:uploader>
       <video:platform relationship="allow">tv</video:platform>
       <video:live>no</video:live>
     </video:video>
@@ -50,7 +50,8 @@
       <video:thumbnail_loc>https://rtv3-img-roosterteeth.akamaized.net/store/9dd9681a-0557-45fe-86b3-b662c91bbae7.jpg/sm/thumblwhouseparty2v4.jpg&amp;&gt;&lt;'"</video:thumbnail_loc>
       <video:title>2018:E10 - House Party - Part 2 (Uncensored)&amp;&gt;&lt;'"</video:title>
       <video:description>Achievement Hunter's House Party quest for some one-night intimacy continues. Can they use Ashley and Madison's sibling rivalry for their own dubious gains?&amp;&gt;&lt;'"</video:description>
-      <video:player_loc>https://roosterteeth.com/embed/let-s-watch-2018-house-party-part-2&amp;&gt;&lt;'"</video:player_loc>
+      <video:content_loc>
+        http://streamserver.example.com/video123.mp4</video:content_loc>
       <video:duration>2422</video:duration>
       <video:publication_date>2018-04-26T17:00:00.000Z</video:publication_date>
       <video:requires_subscription>no</video:requires_subscription>

diff --git a/tests/mocks/bad-tag-sitemap.xml b/tests/mocks/bad-tag-sitemap.xml
@@ -39,7 +39,7 @@
       <video:gallery_loc title="awhu series page&amp;>&lt;'&quot;">https://roosterteeth.com/series/awhu&amp;&gt;&lt;'"</video:gallery_loc>
       <video:price resolution="HD" currency="USD" type="rent">1.99</video:price>
       <video:requires_subscription>no</video:requires_subscription>
-      <video:uploader>GrillyMcGrillerson&amp;&gt;&lt;'"</video:uploader>
+      <video:uploader info="http://www.example.com/users/grillymcgrillerson">GrillyMcGrillerson&amp;&gt;&lt;'"</video:uploader>
       <video:platform relationship="allow">tv</video:platform>
       <video:live>no</video:live>
     </video:video>
@@ -53,7 +53,7 @@
       <video:thumbnail_loc>https://rtv3-img-roosterteeth.akamaized.net/store/9dd9681a-0557-45fe-86b3-b662c91bbae7.jpg/sm/thumblwhouseparty2v4.jpg&amp;&gt;&lt;'"</video:thumbnail_loc>
       <video:title>2018:E10 - House Party - Part 2 (Uncensored)&amp;&gt;&lt;'"</video:title>
       <video:description>Achievement Hunter's House Party quest for some one-night intimacy continues. Can they use Ashley and Madison's sibling rivalry for their own dubious gains?&amp;&gt;&lt;'"</video:description>
-      <video:player_loc>https://roosterteeth.com/embed/let-s-watch-2018-house-party-part-2&amp;&gt;&lt;'"</video:player_loc>
+      <video:content_loc>http://streamserver.example.com/video123.mp4</video:content_loc>
       <video:duration>2422</video:duration>
       <video:publication_date>2018-04-26T17:00:00.000Z</video:publication_date>
       <video:requires_subscription>no</video:requires_subscription>