sitemap - npm Package Compare versions

Comparing version 6.1.3 to 6.1.4

api.md

 # API
 
 - [SitemapStream](#sitemapstream)
-- [XMLToSitemapOptions](#XMLToSitemapOptions)
+- [XMLToSitemapItemStream](#XMLToSitemapItemStream)
 - [sitemapAndIndexStream](#sitemapandindexstream)
@@ -29,3 +29,3 @@ - [createSitemapsAndIndex](#createsitemapsandindex)
   lastmodDateOnly: false // defaults to false, flip to true for baidu
-  xmlNS: { // XML namespaces to turn on - all by default
+  xmlns: { // XML namespaces to turn on - all by default
     news: true,
@@ -42,3 +42,3 @@ xhtml: true,
 
-### XMLToSitemapOptions
+### XMLToSitemapItemStream
 
@@ -50,7 +50,7 @@ Takes a stream of xml and transforms it into a stream of SitemapOptions.
 const { createReadStream, createWriteStream } = require('fs');
-const { XMLToISitemapOptions, ObjectStreamToJSON } = require('sitemap');
+const { XMLToSitemapItemStream, ObjectStreamToJSON } = require('sitemap');
 
 createReadStream('./some/sitemap.xml')
 // turn the xml into sitemap option item options
-.pipe(new XMLToISitemapOptions())
+.pipe(new XMLToSitemapItemStream())
 // convert the object stream to JSON
@@ -57,0 +57,0 @@ .pipe(new ObjectStreamToJSON())

CHANGELOG.md

 # Changelog
 
+## 6.1.4
+
+- remove stale files from dist #298
+- Correct documentation on renamed XMLToSitemapOptions, XMLToSitemapItemStream #297
+- bump node typedef to 14.0.1
+
 ## 6.1.3
@@ -97,3 +103,3 @@
     separated config compatible with the --json input option for cli
-  
+
   lib: import parseSitemap and pass it a stream
@@ -100,0 +106,0 @@

dist/index.js

 "use strict";
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !exports.hasOwnProperty(p)) __createBinding(exports, m, p);
 }
@@ -12,24 +19,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var sitemap_item_stream_1 = require("./lib/sitemap-item-stream");
-exports.SitemapItemStream = sitemap_item_stream_1.SitemapItemStream;
+Object.defineProperty(exports, "SitemapItemStream", { enumerable: true, get: function () { return sitemap_item_stream_1.SitemapItemStream; } });
 var sitemap_index_stream_1 = require("./lib/sitemap-index-stream");
-exports.IndexTagNames = sitemap_index_stream_1.IndexTagNames;
-exports.SitemapIndexStream = sitemap_index_stream_1.SitemapIndexStream;
-exports.createSitemapsAndIndex = sitemap_index_stream_1.createSitemapsAndIndex;
-exports.SitemapAndIndexStream = sitemap_index_stream_1.SitemapAndIndexStream;
+Object.defineProperty(exports, "IndexTagNames", { enumerable: true, get: function () { return sitemap_index_stream_1.IndexTagNames; } });
+Object.defineProperty(exports, "SitemapIndexStream", { enumerable: true, get: function () { return sitemap_index_stream_1.SitemapIndexStream; } });
+Object.defineProperty(exports, "createSitemapsAndIndex", { enumerable: true, get: function () { return sitemap_index_stream_1.createSitemapsAndIndex; } });
+Object.defineProperty(exports, "SitemapAndIndexStream", { enumerable: true, get: function () { return sitemap_index_stream_1.SitemapAndIndexStream; } });
 var sitemap_stream_1 = require("./lib/sitemap-stream");
-exports.streamToPromise = sitemap_stream_1.streamToPromise;
-exports.SitemapStream = sitemap_stream_1.SitemapStream;
-__export(require("./lib/errors"));
-__export(require("./lib/types"));
+Object.defineProperty(exports, "streamToPromise", { enumerable: true, get: function () { return sitemap_stream_1.streamToPromise; } });
+Object.defineProperty(exports, "SitemapStream", { enumerable: true, get: function () { return sitemap_stream_1.SitemapStream; } });
+__exportStar(require("./lib/errors"), exports);
+__exportStar(require("./lib/types"), exports);
 var utils_1 = require("./lib/utils");
-exports.lineSeparatedURLsToSitemapOptions = utils_1.lineSeparatedURLsToSitemapOptions;
-exports.mergeStreams = utils_1.mergeStreams;
-exports.validateSMIOptions = utils_1.validateSMIOptions;
-exports.normalizeURL = utils_1.normalizeURL;
-exports.ReadlineStream = utils_1.ReadlineStream;
+Object.defineProperty(exports, "lineSeparatedURLsToSitemapOptions", { enumerable: true, get: function () { return utils_1.lineSeparatedURLsToSitemapOptions; } });
+Object.defineProperty(exports, "mergeStreams", { enumerable: true, get: function () { return utils_1.mergeStreams; } });
+Object.defineProperty(exports, "validateSMIOptions", { enumerable: true, get: function () { return utils_1.validateSMIOptions; } });
+Object.defineProperty(exports, "normalizeURL", { enumerable: true, get: function () { return utils_1.normalizeURL; } });
+Object.defineProperty(exports, "ReadlineStream", { enumerable: true, get: function () { return utils_1.ReadlineStream; } });
 var xmllint_1 = require("./lib/xmllint");
-exports.xmlLint = xmllint_1.xmlLint;
+Object.defineProperty(exports, "xmlLint", { enumerable: true, get: function () { return xmllint_1.xmlLint; } });
 var sitemap_parser_1 = require("./lib/sitemap-parser");
-exports.parseSitemap = sitemap_parser_1.parseSitemap;
-exports.XMLToSitemapItemStream = sitemap_parser_1.XMLToSitemapItemStream;
-exports.ObjectStreamToJSON = sitemap_parser_1.ObjectStreamToJSON;
+Object.defineProperty(exports, "parseSitemap", { enumerable: true, get: function () { return sitemap_parser_1.parseSitemap; } });
+Object.defineProperty(exports, "XMLToSitemapItemStream", { enumerable: true, get: function () { return sitemap_parser_1.XMLToSitemapItemStream; } });
+Object.defineProperty(exports, "ObjectStreamToJSON", { enumerable: true, get: function () { return sitemap_parser_1.ObjectStreamToJSON; } });

dist/lib/errors.js

@@ -9,2 +9,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.InvalidVideoPriceCurrency = exports.InvalidVideoResolution = exports.InvalidVideoPriceType = exports.InvalidVideoRestrictionRelationship = exports.InvalidVideoRestriction = exports.InvalidVideoFamilyFriendly = exports.InvalidVideoCategory = exports.InvalidVideoTagCount = exports.InvalidVideoViewCount = exports.InvalidVideoTitle = exports.XMLLintUnavailable = exports.InvalidNewsAccessValue = exports.InvalidNewsFormat = exports.InvalidAttr = exports.InvalidAttrValue = exports.InvalidVideoRating = exports.InvalidVideoDescription = exports.InvalidVideoDuration = exports.InvalidVideoFormat = exports.UndefinedTargetFolder = exports.PriorityInvalidError = exports.ChangeFreqInvalidError = exports.NoConfigError = exports.NoURLError = void 0;
 /**
@@ -11,0 +12,0 @@ * URL in SitemapItem does not exist

dist/lib/sitemap-index-stream.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitemapAndIndexStream = exports.createSitemapsAndIndex = exports.SitemapIndexStream = exports.IndexTagNames = void 0;
 const util_1 = require("util");
@@ -4,0 +5,0 @@ const url_1 = require("url");

dist/lib/sitemap-item-stream.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SitemapItemStream = void 0;
 const stream_1 = require("stream");
@@ -4,0 +5,0 @@ const errors_1 = require("./errors");

dist/lib/sitemap-parser.js

@@ -6,2 +6,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ObjectStreamToJSON = exports.parseSitemap = exports.XMLToSitemapItemStream = void 0;
 /* eslint-disable @typescript-eslint/camelcase */
@@ -391,2 +392,6 @@ const sax_1 = __importDefault(require("sax"));
     _transform(data, encoding, callback) {
+        // correcting the type here can be done without making it a breaking change
+        // TODO fix this
+        // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+        // @ts-ignore
         this.saxStream.write(data, encoding);
@@ -393,0 +398,0 @@ callback();

dist/lib/sitemap-stream.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.streamToPromise = exports.SitemapStream = exports.closetag = exports.stylesheetInclude = void 0;
 const url_1 = require("url");
@@ -4,0 +5,0 @@ const stream_1 = require("stream");

dist/lib/sitemap-xml.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.element = exports.ctag = exports.otag = exports.text = void 0;
 // eslint-disable-next-line no-control-regex
@@ -4,0 +5,0 @@ const invalidXMLUnicodeRegex = /[\u0001-\u0008\u000B\u000C\u000E-\u001F\u007F-\u0084\u0086-\u009F\uD800-\uDFFF\uFDD0-\uFDDF\u{1FFFE}-\u{1FFFF}\u{2FFFE}-\u{2FFFF}\u{3FFFE}-\u{3FFFF}\u{4FFFE}-\u{4FFFF}\u{5FFFE}-\u{5FFFF}\u{6FFFE}-\u{6FFFF}\u{7FFFE}-\u{7FFFF}\u{8FFFE}-\u{8FFFF}\u{9FFFE}-\u{9FFFF}\u{AFFFE}-\u{AFFFF}\u{BFFFE}-\u{BFFFF}\u{CFFFE}-\u{CFFFF}\u{DFFFE}-\u{DFFFF}\u{EFFFE}-\u{EFFFF}\u{FFFFE}-\u{FFFFF}\u{10FFFE}-\u{10FFFF}]/gu;

dist/lib/types.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.TagNames = exports.ErrorLevel = exports.isAllowDeny = exports.EnumAllowDeny = exports.isValidYesNo = exports.EnumYesNo = exports.isValidChangeFreq = exports.CHANGEFREQ = exports.isResolution = exports.isPriceType = exports.validators = exports.EnumChangefreq = void 0;
 /**
@@ -4,0 +5,0 @@ * How frequently the page is likely to change. This value provides general

dist/lib/utils.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeURL = exports.chunk = exports.lineSeparatedURLsToSitemapOptions = exports.ReadlineStream = exports.mergeStreams = exports.validateSMIOptions = void 0;
 /*!
@@ -4,0 +5,0 @@ * Sitemap

dist/lib/xmllint.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.xmlLint = void 0;
 const path_1 = require("path");
@@ -4,0 +5,0 @@ const child_process_1 = require("child_process");

package.json

 {
   "name": "sitemap",
-  "version": "6.1.3",
+  "version": "6.1.4",
   "description": "Sitemap-generating lib/cli",
@@ -28,3 +28,3 @@ "keywords": [
     "build": "tsc",
-    "prepublishOnly": "sort-package-json && npm run test",
+    "prepublishOnly": "rm -rf dist && npm run test",
     "test": "eslint lib/* ./cli.ts && tsc && jest && npm run test:xmllint",
@@ -143,3 +143,3 @@ "test:fast": "eslint lib/* ./cli.ts && tsc && jest ./tests/sitemap*",
   "dependencies": {
-    "@types/node": "^13.13.5",
+    "@types/node": "^14.0.1",
     "@types/sax": "^1.2.1",
@@ -158,4 +158,4 @@ "arg": "^4.1.3",
     "@types/jest": "^25.2.1",
-    "@typescript-eslint/eslint-plugin": "^2.31.0",
-    "@typescript-eslint/parser": "^2.31.0",
+    "@typescript-eslint/eslint-plugin": "^2.33.0",
+    "@typescript-eslint/parser": "^2.33.0",
     "babel-eslint": "^10.1.0",
@@ -166,3 +166,3 @@ "babel-polyfill": "^6.26.0",
     "eslint-config-prettier": "^6.11.0",
-    "eslint-plugin-jest": "^23.10.0",
+    "eslint-plugin-jest": "^23.11.0",
     "eslint-plugin-prettier": "^3.1.3",
@@ -179,3 +179,3 @@ "express": "^4.17.1",
     "through2-map": "^3.0.0",
-    "typescript": "^3.8.3"
+    "typescript": "^3.9.2"
   },
@@ -182,0 +182,0 @@ "engines": {

README.md

@@ -136,2 +136,6 @@ # sitemap ![MIT License](https://img.shields.io/npm/l/sitemap)[![Build Status](https://travis-ci.org/ekalinin/sitemap.js.svg?branch=master)](https://travis-ci.org/ekalinin/sitemap.js)![Monthly Downloads](https://img.shields.io/npm/dm/sitemap)
     video: true,
+    custom: [
+      'xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd"',
+      'xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"',
+    ],
   }
@@ -138,0 +142,0 @@ })

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

218

increased by1.87%

Number of low supply chain risk alerts

3

decreased by-40%

Worsened metrics

Total package byte prevSize

144026

decreased by-17.89%

Number of package files

29

decreased by-17.14%

Lines of code

2644

decreased by-25.75%

Dependency changes

• + Added@types/node@14.18.63(transitive)

• - Removed@types/node@13.13.52(transitive)

• Updated@types/node@^14.0.1