feedsub 0.7.4 → 0.7.8

package/README.md

@@ -73,8 +73,8 @@ Creates a new instance of FeedSub. `options` defaults to.
 ### FeedSub#read([callback(err, items)])
 Reads the feed. Calls `callback` with possible error or new items discovered if provided. Causes `reader` to emit new item events.
 
-### FeedSub#start()
-Starts checking the feed for any new items. It checks right away, and then, every `options.interval` minutes.
+### FeedSub#start(readOnStart)
+Starts checking the feed for any new items every `options.interval` minutes. If `readOnStart` is true, it checks right away.
 
 ### FeedSub#options
 Options that were passed to the constructor along with any defaults are kept here.
@@ -88,7 +88,7 @@ Stops the reader from automatically reading the feed.
 Emitted whenever there is a new item.
 
 ### Event: items
-* `Array.Object` - List of items.
+* `Array.<Object>` - List of items.
 
 Emits all new items from one request in one array.
 

package/dist/feedsub.d.ts

@@ -0,0 +1,62 @@
+import { TypedEmitter } from 'tiny-typed-emitter';
+import { FeedItem } from 'feedme';
+import NewsEmitter from 'newsemitter';
+import miniget from 'miniget';
+export interface Options {
+    interval?: number;
+    forceInterval?: boolean;
+    autoStart?: boolean;
+    emitOnStart?: boolean;
+    lastDate?: null | string;
+    history?: string[];
+    maxHistory?: number;
+    skipHours?: boolean;
+    hoursToSkip?: number[];
+    skipDays?: boolean;
+    daysToSkip?: string[];
+    requestOpts?: miniget.Options;
+}
+export declare type DefaultOptions = Required<Options>;
+interface FeedSubEvents {
+    'error': (err: Error) => void;
+    'item': (item: FeedItem) => void;
+    'items': (items: FeedItem[]) => void;
+}
+export { FeedItem } from 'feedme';
+export default class FeedSub extends TypedEmitter<FeedSubEvents> {
+    feed: string;
+    options: DefaultOptions;
+    news: NewsEmitter;
+    getOpts: miniget.Options & {
+        headers: Record<string, string>;
+    };
+    private _first;
+    private _intervalid;
+    /**
+     * @constructor
+     * @param {string} feed
+     * @param {!Object} options
+     */
+    constructor(feed: string, options?: Options);
+    /**
+     * Start calling the read function on interval.
+     *
+     * @param {boolean} readOnStart
+     */
+    start(readOnStart?: boolean): void;
+    /**
+     * Stop interval if any
+     */
+    stop(): void;
+    /**
+     * Reads feed and determines if there are any new items
+     * emits new items through event `item`
+     * if there are new items, emits `items` event at end with all items
+     *
+     * if callback is given, calls callback with all new items
+     * even when there are 0.
+     *
+     * @param {!Function(!Error, Array.<Object>)} callback
+     */
+    read(callback?: (err: null | Error, items?: FeedItem[]) => void): void;
+}

package/dist/feedsub.js

@@ -0,0 +1,280 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const tiny_typed_emitter_1 = require("tiny-typed-emitter");
+const feedme_1 = __importDefault(require("feedme"));
+const newsemitter_1 = __importDefault(require("newsemitter"));
+const miniget_1 = __importDefault(require("miniget"));
+const zlib_1 = __importDefault(require("zlib"));
+// Used for the skipdays tag.
+const DAYS = ['sunday', 'monday', 'tuesday', 'wednesday',
+    'thursday', 'friday', 'saturday'];
+class FeedSub extends tiny_typed_emitter_1.TypedEmitter {
+    /**
+     * @constructor
+     * @param {string} feed
+     * @param {!Object} options
+     */
+    constructor(feed, options) {
+        super();
+        this.feed = feed;
+        this.options = Object.assign({
+            interval: 10,
+            forceInterval: false,
+            autoStart: false,
+            emitOnStart: false,
+            lastDate: null,
+            history: [],
+            maxHistory: 10,
+            skipHours: false,
+            hoursToSkip: null,
+            skipDays: false,
+            daysToSkip: null,
+            requestOpts: {},
+        }, options);
+        // Create news emitter.
+        this.news = new newsemitter_1.default({
+            maxHistory: this.options.maxHistory,
+            manageHistory: true,
+            identifier: (item) => {
+                let feedItem = item[0];
+                return [
+                    feedItem.title,
+                    feedItem.link,
+                    feedItem.pubdate,
+                    feedItem.published,
+                    feedItem.updated
+                ].join(',');
+            }
+        });
+        this.news.addHistory('item', this.options.history);
+        this._first = this.news.history.get('item').size === 0;
+        this.getOpts = Object.assign({
+            headers: {},
+            acceptEncoding: {
+                gzip: () => zlib_1.default.createGunzip(),
+                deflate: () => zlib_1.default.createInflate(),
+            },
+        }, this.options.requestOpts);
+        if (this.options.autoStart) {
+            this.start(true);
+        }
+    }
+    /**
+     * Start calling the read function on interval.
+     *
+     * @param {boolean} readOnStart
+     */
+    start(readOnStart) {
+        this.stop();
+        let ms = this.options.interval * 60000;
+        this._intervalid = setInterval(this.read.bind(this), ms);
+        if (readOnStart) {
+            this.read();
+        }
+    }
+    /**
+     * Stop interval if any
+     */
+    stop() {
+        clearInterval(this._intervalid);
+    }
+    /**
+     * Reads feed and determines if there are any new items
+     * emits new items through event `item`
+     * if there are new items, emits `items` event at end with all items
+     *
+     * if callback is given, calls callback with all new items
+     * even when there are 0.
+     *
+     * @param {!Function(!Error, Array.<Object>)} callback
+     */
+    read(callback) {
+        let ended = false;
+        let req;
+        let items = [];
+        let newItems = [];
+        let sortOrder = 0;
+        const error = (err) => {
+            ended = true;
+            this._first = false;
+            if (typeof callback === 'function') {
+                callback(err);
+            }
+            else {
+                this.emit('error', err);
+            }
+            req.destroy();
+        };
+        const success = () => {
+            if (ended) {
+                return;
+            }
+            ended = true;
+            if (sortOrder <= 0) {
+                newItems.reverse();
+            }
+            this.news.addHistory('item', newItems.map((item) => [item]));
+            if (this._first && !this.options.emitOnStart) {
+                newItems = [];
+            }
+            newItems.forEach(item => this.emit('item', item));
+            this.emit('items', newItems);
+            if (req) {
+                req.destroy();
+            }
+            if (typeof callback === 'function') {
+                callback(null, newItems);
+            }
+        };
+        // If skipHours or skipDays are enabled and feed provides hours/days
+        // to skip and it's currently one of those hours/days, abort.
+        const now = new Date();
+        const shouldSkip = () => {
+            return ((!this._first || !this.options.emitOnStart) &&
+                (this.options.hoursToSkip || this.options.daysToSkip)) && ((this.options.hoursToSkip &&
+                this.options.hoursToSkip.indexOf(now.getHours()) !== -1) ||
+                (this.options.daysToSkip &&
+                    this.options.daysToSkip.some((day) => {
+                        return day.toLowerCase() === DAYS[now.getDay()];
+                    })));
+        };
+        if (shouldSkip()) {
+            return success();
+        }
+        req = miniget_1.default(this.feed, this.getOpts);
+        req.on('response', (res) => {
+            // Check if not modified code is sent back
+            // in this case, the body will be empty.
+            if (res.statusCode === 304) {
+                return success();
+            }
+            // Check headers for conditional get.
+            if (res.headers['last-modified']) {
+                this.getOpts.headers['If-Modified-Since'] = res.headers['last-modified'];
+            }
+            if (res.headers.etag) {
+                this.getOpts.headers['If-None-Match'] = res.headers.etag;
+            }
+            // Save date.
+            let date;
+            let getdate = (text) => date = text;
+            // Create feed parser.
+            const parser = new feedme_1.default();
+            parser.on('error', error);
+            // Try to get date from one of the fields.
+            parser.once('pubdate', getdate);
+            parser.once('lastbuilddate', getdate);
+            parser.once('updated', getdate);
+            // Change interval time if ttl available.
+            if (!this.options.forceInterval) {
+                parser.once('ttl', (minutes) => {
+                    minutes = parseInt(minutes, 10);
+                    // Only update if ttl is longer than requested interval.
+                    if (minutes > this.options.interval) {
+                        this.options.interval = minutes;
+                        if (this.options.autoStart) {
+                            this.start(false);
+                        }
+                    }
+                });
+            }
+            // Listen for skipHours if enabled.
+            if (this.options.skipHours && !this.options.hoursToSkip) {
+                parser.once('skiphours', (data) => {
+                    this.options.hoursToSkip =
+                        [].concat(data.hour).map(h => parseInt(h, 10));
+                });
+            }
+            // Listen for skipDays if enabled.
+            if (this.options.skipDays !== false && !this.options.daysToSkip) {
+                parser.once('skipdays', (data) => {
+                    this.options.daysToSkip = [].concat(data.day);
+                });
+            }
+            // Compare date when first item is encountered.
+            const firstitem = (item) => {
+                // If date is the same as last, abort.
+                if (date && this.options.lastDate === date) {
+                    return success();
+                }
+                if (shouldSkip()) {
+                    return success();
+                }
+                // Continue if dates differ.
+                if (date) {
+                    this.options.lastDate = date;
+                }
+                parser.on('item', getItem);
+                getItem(item);
+            };
+            parser.once('item', firstitem);
+            const getItemDate = (item) => +new Date(item.pubdate || item.published || 0);
+            const getItem = (item) => {
+                if (sortOrder === 0) {
+                    items.push(item);
+                    sortOrder = getItemDate(item) - getItemDate(items[0]);
+                    if (sortOrder < 0) {
+                        items.forEach(getOlderItem);
+                    }
+                    else if (sortOrder > 0) {
+                        items.forEach(getNewerItem);
+                    }
+                }
+                else if (sortOrder < 0) {
+                    getOlderItem(item);
+                }
+                else {
+                    getNewerItem(item);
+                }
+            };
+            const getOlderItem = (item) => {
+                if (this._first) {
+                    newItems.push(item);
+                }
+                else if (!ended) {
+                    let emitted = this.news.emit('item', item);
+                    if (emitted) {
+                        newItems.push(item);
+                    }
+                    else {
+                        // Check if this item has already been read in previous requests
+                        // if it has, then stop parsing the rest of the document.
+                        parser.removeListener('item', getItem);
+                        success();
+                    }
+                }
+            };
+            let foundPrevItem = false;
+            const getNewerItem = (item) => {
+                if (this._first) {
+                    newItems.push(item);
+                }
+                else if (!foundPrevItem && !this.news.emit('item', item)) {
+                    foundPrevItem = true;
+                }
+                else if (foundPrevItem && this.news.emit('item', item)) {
+                    newItems.push(item);
+                }
+            };
+            req.pipe(parser);
+            parser.on('finish', () => {
+                if (ended) {
+                    return;
+                }
+                // Process items in descending order if no order found at end.
+                if (sortOrder === 0 && newItems.length === 0) {
+                    items.forEach(getOlderItem);
+                }
+                success();
+                this._first = false;
+            });
+        });
+        req.on('error', error);
+    }
+}
+exports.default = FeedSub;
+module.exports = FeedSub;
+//# sourceMappingURL=feedsub.js.map

package/dist/feedsub.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"feedsub.js","sourceRoot":"","sources":["../src/feedsub.ts"],"names":[],"mappings":";;;;;AAAA,2DAAkD;AAClD,oDAAqD;AACrD,8DAAsC;AACtC,sDAA8B;AAC9B,gDAAwB;AAGxB,6BAA6B;AAC7B,MAAM,IAAI,GAAG,CAAC,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,WAAW;IACtD,UAAU,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;AA4BpC,MAAqB,OAAQ,SAAQ,iCAA2B;IAQ9D;;;;OAIG;IACH,YAAY,IAAY,EAAE,OAAiB;QACzC,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC;YAC3B,QAAQ,EAAQ,EAAE;YAClB,aAAa,EAAG,KAAK;YACrB,SAAS,EAAO,KAAK;YACrB,WAAW,EAAK,KAAK;YACrB,QAAQ,EAAQ,IAAI;YACpB,OAAO,EAAS,EAAE;YAClB,UAAU,EAAM,EAAE;YAClB,SAAS,EAAO,KAAK;YACrB,WAAW,EAAK,IAAI;YACpB,QAAQ,EAAQ,KAAK;YACrB,UAAU,EAAM,IAAI;YACpB,WAAW,EAAK,EAAE;SACnB,EAAE,OAAO,CAAC,CAAC;QAEZ,uBAAuB;QACvB,IAAI,CAAC,IAAI,GAAG,IAAI,qBAAW,CAAC;YAC1B,UAAU,EAAE,IAAI,CAAC,OAAO,CAAC,UAAU;YACnC,aAAa,EAAE,IAAI;YACnB,UAAU,EAAE,CAAC,IAAW,EAAE,EAAE;gBAC1B,IAAI,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;gBACvB,OAAO;oBACL,QAAQ,CAAC,KAAK;oBACd,QAAQ,CAAC,IAAI;oBACb,QAAQ,CAAC,OAAO;oBAChB,QAAQ,CAAC,SAAS;oBAClB,QAAQ,CAAC,OAAO;iBACjB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACd,CAAC;SACF,CAAC,CAAC;QAEH,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACnD,IAAI,CAAC,MAAM,GAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAiB,CAAC,IAAI,KAAK,CAAC,CAAC;QACxE,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC;YAC3B,OAAO,EAAE,EAA4B;YACrC,cAAc,EAAE;gBACd,IAAI,EAAE,GAAG,EAAE,CAAC,cAAI,CAAC,YAAY,EAAE;gBAC/B,OAAO,EAAE,GAAG,EAAE,CAAC,cAAI,CAAC,aAAa,EAAE;aACpC;SACF,EAAE,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC7B,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;YAC1B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;SAClB;IACH,CAAC;IAGD;;;;OAIG;IACH,KAAK,CAAC,WAAqB;QACzB,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,IAAI,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,GAAG,KAAK,CAAC;QACvC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QACzD,IAAI,WAAW,EAAE;YACf,IAAI,CAAC,IAAI,EAAE,CAAC;SACb;IACH,CAAC;IAGD;;OAEG;IACH,IAAI;QACF,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAClC,CAAC;IAGD;;;;;;;;;OASG;IACH,IAAI,CAAC,QAA0D;QAC7D,IAAI,KAAK,GAAG,KAAK,CAAC;QAClB,IAAI,GAAmB,CAAC;QACxB,IAAI,KAAK,GAAe,EAAE,CAAC;QAC3B,IAAI,QAAQ,GAAe,EAAE,CAAC;QAC9B,IAAI,SAAS,GAAG,CAAC,CAAC;QAElB,MAAM,KAAK,GAAG,CAAC,GAAU,EAAE,EAAE;YAC3B,KAAK,GAAG,IAAI,CAAC;YACb,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;YACpB,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;gBAClC,QAAQ,CAAC,GAAG,CAAC,CAAC;aACf;iBAAM;gBACL,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;aACzB;YACD,GAAG,CAAC,OAAO,EAAE,CAAC;QAChB,CAAC,CAAC;QAEF,MAAM,OAAO,GAAG,GAAG,EAAE;YACnB,IAAI,KAAK,EAAE;gBAAE,OAAO;aAAE;YACtB,KAAK,GAAG,IAAI,CAAC;YACb,IAAI,SAAS,IAAI,CAAC,EAAE;gBAClB,QAAQ,CAAC,OAAO,EAAE,CAAC;aACpB;YACD,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7D,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE;gBAC5C,QAAQ,GAAG,EAAE,CAAC;aACf;YACD,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;YAClD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC7B,IAAI,GAAG,EAAE;gBACP,GAAG,CAAC,OAAO,EAAE,CAAC;aACf;YACD,IAAI,OAAO,QAAQ,KAAK,UAAU,EAAE;gBAClC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;aAC1B;QACH,CAAC,CAAC;QAEF,oEAAoE;QACpE,6DAA6D;QAC7D,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,UAAU,GAAG,GAAG,EAAE;YACtB,OAAO,CACL,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC;gBAC3C,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CACtD,IAAI,CACH,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW;gBACxB,IAAI,CAAC,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;gBACzD,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU;oBACvB,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;wBACnC,OAAO,GAAG,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;oBAClD,CAAC,CAAC,CACF,CACF,CAAC;QACJ,CAAC,CAAC;QAEF,IAAI,UAAU,EAAE,EAAE;YAChB,OAAO,OAAO,EAAE,CAAC;SAClB;QAED,GAAG,GAAG,iBAAO,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACvC,GAAG,CAAC,EAAE,CAAC,UAAU,EAAE,CAAC,GAAG,EAAE,EAAE;YACzB,0CAA0C;YAC1C,wCAAwC;YACxC,IAAI,GAAG,CAAC,UAAU,KAAK,GAAG,EAAE;gBAC1B,OAAO,OAAO,EAAE,CAAC;aAClB;YAED,qCAAqC;YACrC,IAAI,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,EAAE;gBAChC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,mBAAmB,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;aAC1E;YACD,IAAI,GAAG,CAAC,OAAO,CAAC,IAAI,EAAE;gBACpB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC;aAC1D;YAED,aAAa;YACb,IAAI,IAAY,CAAC;YACjB,IAAI,OAAO,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,IAAI,GAAG,IAAI,CAAC;YAE5C,sBAAsB;YACtB,MAAM,MAAM,GAAG,IAAI,gBAAM,EAAE,CAAC;YAC5B,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;YAE1B,0CAA0C;YAC1C,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAChC,MAAM,CAAC,IAAI,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;YACtC,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAEhC,yCAAyC;YACzC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE;gBAC/B,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,OAAO,EAAE,EAAE;oBAC7B,OAAO,GAAG,QAAQ,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;oBAEhC,wDAAwD;oBACxD,IAAI,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE;wBACnC,IAAI,CAAC,OAAO,CAAC,QAAQ,GAAG,OAAO,CAAC;wBAChC,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE;4BAC1B,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;yBACnB;qBACF;gBACH,CAAC,CAAC,CAAC;aACJ;YAED,mCAAmC;YACnC,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE;gBACvD,MAAM,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,EAAE;oBAChC,IAAI,CAAC,OAAO,CAAC,WAAW;wBACtB,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;gBACnD,CAAC,CAAC,CAAC;aACJ;YAED,kCAAkC;YAClC,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,KAAK,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;gBAC/D,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC,IAAI,EAAE,EAAE;oBAC/B,IAAI,CAAC,OAAO,CAAC,UAAU,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;gBAChD,CAAC,CAAC,CAAC;aACJ;YAGD,+CAA+C;YAC/C,MAAM,SAAS,GAAG,CAAC,IAAc,EAAE,EAAE;gBACnC,sCAAsC;gBACtC,IAAI,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,QAAQ,KAAK,IAAI,EAAE;oBAC1C,OAAO,OAAO,EAAE,CAAC;iBAClB;gBAED,IAAI,UAAU,EAAE,EAAE;oBAChB,OAAO,OAAO,EAAE,CAAC;iBAClB;gBAED,4BAA4B;gBAC5B,IAAI,IAAI,EAAE;oBACR,IAAI,CAAC,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;iBAC9B;gBACD,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAC3B,OAAO,CAAC,IAAI,CAAC,CAAC;YAChB,CAAC,CAAC;YAEF,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;YAE/B,MAAM,WAAW,GAAG,CAAC,IAAc,EAAE,EAAE,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,OAAiB,IAAI,IAAI,CAAC,SAAmB,IAAI,CAAC,CAAC,CAAC;YAC3G,MAAM,OAAO,GAAG,CAAC,IAAc,EAAE,EAAE;gBACjC,IAAI,SAAS,KAAK,CAAC,EAAE;oBACnB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;oBACjB,SAAS,GAAG,WAAW,CAAC,IAAI,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;oBACtD,IAAI,SAAS,GAAG,CAAC,EAAE;wBACjB,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;qBAC7B;yBAAM,IAAI,SAAS,GAAG,CAAC,EAAE;wBACxB,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;qBAC7B;iBACF;qBAAM,IAAI,SAAS,GAAG,CAAC,EAAE;oBACxB,YAAY,CAAC,IAAI,CAAC,CAAC;iBAEpB;qBAAM;oBACL,YAAY,CAAC,IAAI,CAAC,CAAC;iBACpB;YACH,CAAC,CAAC;YAEF,MAAM,YAAY,GAAG,CAAC,IAAc,EAAE,EAAE;gBACtC,IAAI,IAAI,CAAC,MAAM,EAAE;oBACf,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACrB;qBAAM,IAAI,CAAC,KAAK,EAAE;oBACjB,IAAI,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;oBAC3C,IAAI,OAAO,EAAE;wBACX,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;qBACrB;yBAAM;wBACL,gEAAgE;wBAChE,yDAAyD;wBACzD,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;wBACvC,OAAO,EAAE,CAAC;qBACX;iBACF;YACH,CAAC,CAAC;YAEF,IAAI,aAAa,GAAG,KAAK,CAAC;YAC1B,MAAM,YAAY,GAAG,CAAC,IAAc,EAAE,EAAE;gBACtC,IAAI,IAAI,CAAC,MAAM,EAAE;oBACf,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACrB;qBAAM,IAAI,CAAC,aAAa,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;oBAC1D,aAAa,GAAG,IAAI,CAAC;iBACtB;qBAAM,IAAI,aAAa,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;oBACxD,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACrB;YACH,CAAC,CAAC;YAEF,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAEjB,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;gBACvB,IAAI,KAAK,EAAE;oBAAE,OAAO;iBAAE;gBACtB,8DAA8D;gBAC9D,IAAI,SAAS,KAAK,CAAC,IAAI,QAAQ,CAAC,MAAM,KAAK,CAAC,EAAE;oBAC5C,KAAK,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;iBAC7B;gBACD,OAAO,EAAE,CAAC;gBACV,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;YACtB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACzB,CAAC;CACF;AAxSD,0BAwSC;AAED,MAAM,CAAC,OAAO,GAAG,OAAO,CAAC"}

package/package.json

@@ -8,30 +8,39 @@
     "json",
     "subscribe"
   ],
-  "version": "0.7.4",
+  "version": "0.7.8",
   "repository": {
     "type": "git",
     "url": "git://github.com/fent/node-feedsub.git"
   },
   "author": "fent <fentbox@gmail.com> (https://github.com/fent)",
-  "main": "./lib/feedsub.js",
+  "main": "./dist/feedsub.js",
   "files": [
-    "lib"
+    "dist"
   ],
   "scripts": {
-    "test": "nyc --reporter=lcov --reporter=text-summary mocha -- -t 4000 test/*-test.js"
+    "prepare": "tsc -p tsconfig.build.json",
+    "build": "tsc -p tsconfig.build.json",
+    "test": "nyc --extension .ts --reporter=lcov --reporter=text-summary npm run test:unit",
+    "test:unit": "mocha --require ts-node/register test/*-test.ts"
   },
   "dependencies": {
-    "feedme": "^1.2.0",
-    "miniget": "^3.0.0",
-    "newsemitter": "^1.0.0"
+    "feedme": "^2.0.2",
+    "miniget": "^4.2.2",
+    "newsemitter": "^1.0.2",
+    "tiny-typed-emitter": "^2.0.3"
   },
   "devDependencies": {
+    "@types/mocha": "^8.2.0",
+    "@types/nock": "^11.1.0",
+    "@types/node": "^14.14.11",
+    "@types/sinon": "^9.0.9",
     "mocha": "^6.0.0",
-    "muk-prop": "^1.2.1",
     "nock": "^11.1.0",
     "nyc": "^15.1.0",
-    "sinon": "^8.0.0"
+    "sinon": "^8.0.0",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.1.2"
   },
   "engines": {
     "node": ">=10"

package/lib/feedsub.js

@@ -1,302 +0,0 @@
-const EventEmitter = require('events').EventEmitter;
-const FeedMe       = require('feedme');
-const NewsEmitter  = require('newsemitter');
-const miniget      = require('miniget');
-const zlib         = require('zlib');
-
-
-// Used for the skipdays tag.
-const DAYS = ['sunday', 'monday', 'tuesday', 'wednesday',
-  'thursday', 'friday', 'saturday'];
-
-
-module.exports = class FeedReader extends EventEmitter {
-  /**
-   * @constructor
-   * @param {string} feed
-   * @param {!Object} options
-   */
-  constructor(feed, options) {
-    super();
-    this.feed = feed;
-    this.options = Object.assign({
-      interval      : 10,
-      forceInterval : false,
-      autoStart     : false,
-      emitOnStart   : false,
-      lastDate      : null,
-      history       : [],
-      maxHistory    : 10,
-      skipHours     : false,
-      skipDays      : false,
-    }, options);
-
-    // Create news emitter.
-    this.news = new NewsEmitter({
-      maxHistory: this.options.maxHistory,
-      manageHistory: true,
-      identifier: (item) => {
-        item = item[0];
-        return [
-          item.title,
-          item.link,
-          item.pubdate,
-          item.published,
-          item.updated
-        ].join(',');
-      }
-    });
-
-    this.news.addHistory('item', this.options.history);
-    this.first = this.news.history.get('item').size === 0;
-    this.getOpts = Object.assign({
-      headers: {},
-      acceptEncoding: {
-        gzip: () => zlib.createGunzip(),
-        deflate: () => zlib.createInflate(),
-      },
-    }, this.options.requestOpts);
-    if (this.options.autoStart) {
-      this.start(true);
-    }
-  }
-
-
-  /**
-   * Start calling the read function on interval.
-   *
-   * @param {boolean} readOnStart
-   */
-  start(readOnStart) {
-    this.stop();
-    let ms = this.options.interval * 60000;
-    this._intervalid = setInterval(this.read.bind(this), ms);
-    if (readOnStart) {
-      this.read();
-    }
-  }
-
-
-  /**
-   * Stop interval if any
-   */
-  stop() {
-    clearInterval(this._intervalid);
-  }
-
-
-  /**
-   * Reads feed and determines if there are any new items
-   * emits new items through event `item`
-   * if there are new items, emits `items` event at end with all items
-   *
-   * if callback is given, calls callback with all new items
-   * even when there are 0.
-   *
-   * @param {!Function(!Error, Array.<Object>)} callback
-   */
-  read(callback) {
-    let ended = false;
-    let req;
-    let items = [];
-    let newItems = [];
-    let sortOrder = 0;
-
-    const error = (err) => {
-      ended = true;
-      this.first = false;
-      if (typeof callback === 'function') {
-        callback(err);
-      } else {
-        this.emit('error', err);
-      }
-      req.destroy();
-    };
-
-    const success = () => {
-      if (ended) { return; }
-      ended = true;
-      if (sortOrder <= 0) {
-        newItems.reverse();
-      }
-      this.news.addHistory('item', newItems.map((item) => [item]));
-      if (this.first && !this.options.emitOnStart) {
-        newItems = [];
-      }
-      newItems.forEach(this.emit.bind(this, 'item'));
-      this.emit('items', newItems);
-      if (req) {
-        req.destroy();
-      }
-      if (typeof callback === 'function') {
-        callback(null, newItems);
-      }
-    };
-
-    // If skipHours or skipDays are enabled and feed provides hours/days
-    // to skip and it's currently one of those hours/days, abort.
-    const now = new Date();
-    const shouldSkip = () => {
-      return (
-        (!this.first || !this.options.emitOnStart) &&
-        (this.options.hoursToSkip || this.options.daysToSkip)
-      ) && (
-        (this.options.hoursToSkip &&
-         this.options.hoursToSkip.indexOf(now.getHours()) !== -1) ||
-        (this.options.daysToSkip &&
-         this.options.daysToSkip.some((day) => {
-           return day.toLowerCase() === DAYS[now.getDay()];
-         })
-        )
-      );
-    };
-
-    if (shouldSkip()) {
-      return success();
-    }
-
-    req = miniget(this.feed, this.getOpts);
-    req.on('response', (res) => {
-      // Check if not modified code is sent back
-      // in this case, the body will be empty.
-      if (res.statusCode === 304) {
-        return success();
-      }
-
-      // Check headers for conditional get.
-      if (res.headers['last-modified']) {
-        this.getOpts.headers['If-Modified-Since'] = res.headers['last-modified'];
-      }
-      if (res.headers.etag) {
-        this.getOpts.headers['If-None-Match'] = res.headers.etag;
-      }
-
-      // Save date.
-      let date;
-      let getdate = text => date = text;
-
-      // Create feed parser.
-      const parser = new FeedMe();
-      parser.on('error', error);
-
-      // Try to get date from one of the fields.
-      parser.once('pubdate', getdate);
-      parser.once('lastbuilddate', getdate);
-      parser.once('updated', getdate);
-
-      // Change interval time if ttl available.
-      if (!this.options.forceInterval) {
-        parser.once('ttl', (minutes) => {
-          minutes = parseInt(minutes, 10);
-
-          // Only update if ttl is longer than requested interval.
-          if (minutes > this.options.interval) {
-            this.options.interval = minutes;
-            if (this.options.autoStart) {
-              this.start(false);
-            }
-          }
-        });
-      }
-
-      // Listen for skipHours if enabled.
-      if (this.options.skipHours && !this.options.hoursToSkip) {
-        parser.once('skiphours', (data) => {
-          this.options.hoursToSkip =
-            [].concat(data.hour).map(h => parseInt(h, 10));
-        });
-      }
-
-      // Listen for skipDays if enabled.
-      if (this.options.skipDays !== false && !this.options.daysToSkip) {
-        parser.once('skipdays', (data) => {
-          this.options.daysToSkip = [].concat(data.day);
-        });
-      }
-
-
-      // Compare date when first item is encountered.
-      const firstitem = (item) => {
-        // If date is the same as last, abort.
-        if (date && this.options.lastDate === date) {
-          return success();
-        }
-
-        if (shouldSkip()) {
-          return success();
-        }
-
-        // Continue if dates differ.
-        if (date) {
-          this.options.lastDate = date;
-        }
-        parser.on('item', getItem);
-        getItem(item);
-      };
-
-      parser.once('item', firstitem);
-
-      const getItemDate = (item) => new Date(item.pubdate || item.published || 0);
-      const getItem = (item) => {
-        if (sortOrder === 0) {
-          items.push(item);
-          sortOrder = getItemDate(item) - getItemDate(items[0]);
-          if (sortOrder < 0) {
-            items.forEach(getOlderItem);
-          } else if (sortOrder > 0) {
-            items.forEach(getNewerItem);
-          }
-        } else if (sortOrder < 0) {
-          getOlderItem(item);
-
-        } else {
-          getNewerItem(item);
-        }
-      };
-
-      const getOlderItem = (item) => {
-        if (this.first) {
-          newItems.push(item);
-        } else if (!ended) {
-          let emitted = this.news.emit('item', item);
-          if (emitted) {
-            newItems.push(item);
-          } else {
-            // Check if this item has already been read in previous requests
-            // if it has, then stop parsing the rest of the document.
-            parser.removeListener('item', getItem);
-            success();
-          }
-        }
-      };
-
-      let foundPrevItem = false;
-      const getNewerItem = (item) => {
-        if (this.first) {
-          newItems.push(item);
-        } else if (!foundPrevItem && !this.news.emit('item', item)) {
-          foundPrevItem = true;
-        } else if (foundPrevItem && this.news.emit('item', item)) {
-          newItems.push(item);
-        }
-      };
-
-      req.pipe(parser);
-
-      const onEnd = () => {
-        if (ended) { return; }
-        // Process items in descending order if no order found at end.
-        if (sortOrder === 0 && newItems.length === 0) {
-          items.forEach(getOlderItem);
-        }
-        success();
-        this.first = false;
-      };
-
-      req.on('close', onEnd);
-      req.on('end', onEnd);
-    });
-
-    req.on('error', error);
-  }
-};