@eso-status/forum-message 1.0.12 → 2.0.0-dev.0

package/lib/formatter/date.formatter.js

@@ -0,0 +1,161 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const moment = require("moment");
+/**
+ * Class for identifying and formatting the date contained in an announcement
+ */
+class DateFormatter {
+    /**
+     * @param raw Raw data of the announcement
+     */
+    constructor(raw) {
+        this.raw = raw;
+        this.checkFormat();
+    }
+    /**
+     * Method for retrieving the raw date and the list of dates present in the announcement based on its format
+     * Case #1: The announcement contains a date with a start and end time (hour/minute)
+     * Case #2: The announcement contains the name of the next maintenance day with a start time (hour/minute)
+     * @private
+     */
+    checkFormat() {
+        let rawDate = this.getRawClassicDate();
+        if (rawDate !== '') {
+            this.rawDate = rawDate;
+            this.dates = this.formatClassic();
+        }
+        rawDate = this.getRawSpecialDate();
+        if (rawDate !== '') {
+            this.rawDate = rawDate;
+            this.dates = this.formatSpecial();
+        }
+    }
+    /**
+     * Method for retrieving the raw date in case #1
+     * @private
+     */
+    getRawClassicDate() {
+        const split = this.raw.split(' – ');
+        if (split.length > 2) {
+            split.shift();
+            return split.join(' – ');
+        }
+        return split.length === 2 ? split[1] : '';
+    }
+    /**
+     * Method for retrieving the raw date in case #2
+     * @private
+     */
+    getRawSpecialDate() {
+        const split = this.raw.split('on the PTS on ');
+        return split.length === 2 ? split[1] : '';
+    }
+    /**
+     * Method for generating the list of correctly formatted dates for case #1
+     * @private
+     */
+    formatClassic() {
+        return [
+            DateFormatter.generateMoment(moment().get('years'), moment().month(this.getRawClassicMouth()).get('months'), this.getRawClassicDay(), this.getRawHour(), this.getRawClassicMinute1()),
+            DateFormatter.generateMoment(moment().get('years'), moment().month(this.getRawClassicMouth()).get('months'), this.getRawClassicDay(), this.getRawClassicHour2(), this.getRawClassicMinute2()),
+        ];
+    }
+    /**
+     * Method for retrieving the month number for case #1
+     * @private
+     */
+    getRawClassicMouth() {
+        return this.rawDate.split(' ')[0];
+    }
+    /**
+     * Method for retrieving the day number for case #1
+     * @private
+     */
+    getRawClassicDay() {
+        return Number(this.rawDate.split(' ')[1].replace(',', ''));
+    }
+    /**
+     * Method for retrieving the hour number from a raw date
+     * @private
+     */
+    getRawHour() {
+        return Number(this.rawDate.split('(')[1].split(':')[0]);
+    }
+    /**
+     * Method for retrieving the minute number of the start time for case #1
+     * @private
+     */
+    getRawClassicMinute1() {
+        return Number(this.rawDate.split('(')[1].split(':')[1].split(' ')[0]);
+    }
+    /**
+     * Method for retrieving the end hour number in case #1
+     * @private
+     */
+    getRawClassicHour2() {
+        return Number(this.rawDate.split('(')[2].split(':')[0]);
+    }
+    /**
+     * Method for retrieving the minute number of the end time in case #1
+     * @private
+     */
+    getRawClassicMinute2() {
+        return Number(this.rawDate.split('(')[2].split(':')[1].split(' ')[0]);
+    }
+    /**
+     * Method for generating the correctly formatted date in case #2
+     * @private
+     */
+    formatSpecial() {
+        const date = this.getSpecialDate();
+        return [
+            DateFormatter.generateMoment(date.get('years'), date.get('months'), date.get('dates'), this.getRawHour(), this.getRawSpecialMinute()),
+        ];
+    }
+    /**
+     * Method for retrieving the maintenance date in case #2
+     * Case #2 does not provide the month or day (i.e., no day number), only the name of the day (Monday, Tuesday, etc.). Therefore, you need to check if the day has already passed in the current week to determine whether to add a week to the maintenance date.
+     * @private
+     */
+    getSpecialDate() {
+        const current = moment();
+        const targetDayIndex = moment()
+            .days(this.rawDate.split(' ')[0])
+            .get('days');
+        current.set('days', targetDayIndex);
+        if (moment().get('days') > targetDayIndex) {
+            current.add(1, 'week');
+        }
+        return current;
+    }
+    /**
+     * Method for retrieving the minute number of the time in case #2
+     * @private
+     */
+    getRawSpecialMinute() {
+        return Number(this.rawDate.split(':')[2].split(' ')[0]);
+    }
+    /**
+     * Method for formatting a date correctly
+     * @param year
+     * @param month
+     * @param day
+     * @param hour
+     * @param minute
+     * @private
+     */
+    static generateMoment(year, month, day, hour, minute) {
+        return moment()
+            .utc()
+            .set('years', year)
+            .set('months', month)
+            .set('date', day)
+            .set('hours', hour)
+            .set('minutes', minute)
+            .set('seconds', 0)
+            .set('milliseconds', 0)
+            .utcOffset(0);
+    }
+}
+exports.default = DateFormatter;
+//# sourceMappingURL=date.formatter.js.map

package/lib/identifier/slug.identifier.d.ts

@@ -0,0 +1,94 @@
+import SlugMatch from './slug.match';
+/**
+ * Class for identifying the list of slugs contained in an announcement
+ */
+export default class SlugIdentifier {
+    private readonly raw;
+    /**
+     * List of slug information found in the announcement
+     */
+    slugMatches: SlugMatch[];
+    /**
+     * List of slugs to check for presence in the announcement
+     * @private
+     */
+    private readonly slugList;
+    /**
+     * List of indicators proving that the announcement pertains to the slug server_pc_eu
+     * @private
+     */
+    private readonly ServerPcEuMatchesList;
+    /**
+     * List of indicators proving that the announcement pertains to the slug server_pc_na
+     * @private
+     */
+    private readonly ServerPcNaMatchesList;
+    /**
+     * List of indicators proving that the announcement pertains to the slug server_pc_pts
+     * @private
+     */
+    private readonly ServerPcPtsMatchesList;
+    /**
+     * List of indicators proving that the announcement pertains to the slug server_ps_eu
+     * @private
+     */
+    private readonly ServerPsEuMatchesList;
+    /**
+     * List of indicators proving that the announcement pertains to the slug server_ps_na
+     * @private
+     */
+    private readonly ServerPsNaMatchesList;
+    /**
+     * List of indicators proving that the announcement pertains to the slug server_xbox_eu
+     * @private
+     */
+    private readonly ServerXboxEuMatchesList;
+    /**
+     * List of indicators proving that the announcement pertains to the slug server_xbox_na
+     * @private
+     */
+    private readonly ServerXboxNaMatchesList;
+    /**
+     * List of indicators proving that the announcement pertains to the slug service_store_eso
+     * @private
+     */
+    private readonly ServiceStoreEsoMatchesList;
+    /**
+     * List of indicators proving that the announcement pertains to the slug service_system_account
+     * @private
+     */
+    private readonly ServiceSystemAccountMatchesList;
+    /**
+     * List of indicators proving that the announcement pertains to the slug service_web_site
+     * @private
+     */
+    private readonly ServiceWebSiteMatchesList;
+    /**
+     * @param raw Raw data of the announcement
+     */
+    constructor(raw: string);
+    /**
+     * Method for retrieving the list of indicators for a slug to test
+     * @param slug Slug to test
+     * @private
+     */
+    private getMatchList;
+    /**
+     * Method for retrieving the name of the list of indicators for a slug to test
+     * @param slug Slug to test
+     * @private
+     */
+    private static getMatchListName;
+    /**
+     * Method for retrieving the indicators of a slug present in the announcement
+     * @param slug Slug to test
+     * @private
+     */
+    private getMatches;
+    /**
+     * Method for testing if the announcement contains indicators of a given slug
+     * @param slug Slug to test
+     * @private
+     */
+    private identify;
+}

package/lib/identifier/slug.identifier.js

@@ -0,0 +1,139 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const slug_match_1 = require("./slug.match");
+/**
+ * Class for identifying the list of slugs contained in an announcement
+ */
+class SlugIdentifier {
+    /**
+     * @param raw Raw data of the announcement
+     */
+    constructor(raw) {
+        this.raw = raw;
+        /**
+         * List of slugs to check for presence in the announcement
+         * @private
+         */
+        this.slugList = [
+            'server_pc_eu',
+            'server_pc_na',
+            'server_pc_pts',
+            'server_ps_eu',
+            'server_ps_na',
+            'server_xbox_eu',
+            'server_xbox_na',
+            'service_store_eso',
+            'service_system_account',
+            'service_web_site',
+        ];
+        /**
+         * List of indicators proving that the announcement pertains to the slug server_pc_eu
+         * @private
+         */
+        this.ServerPcEuMatchesList = [
+            'PC/Mac: EU megaserver for',
+            'PC/Mac: NA and EU megaservers for',
+        ];
+        /**
+         * List of indicators proving that the announcement pertains to the slug server_pc_na
+         * @private
+         */
+        this.ServerPcNaMatchesList = [
+            'PC/Mac: NA megaserver for',
+            'PC/Mac: NA and EU megaservers for',
+        ];
+        /**
+         * List of indicators proving that the announcement pertains to the slug server_pc_pts
+         * @private
+         */
+        this.ServerPcPtsMatchesList = ['PTS'];
+        /**
+         * List of indicators proving that the announcement pertains to the slug server_ps_eu
+         * @private
+         */
+        this.ServerPsEuMatchesList = [
+            'PlayStation®: NA and EU megaservers for',
+        ];
+        /**
+         * List of indicators proving that the announcement pertains to the slug server_ps_na
+         * @private
+         */
+        this.ServerPsNaMatchesList = [
+            'PlayStation®: NA and EU megaservers for',
+        ];
+        /**
+         * List of indicators proving that the announcement pertains to the slug server_xbox_eu
+         * @private
+         */
+        this.ServerXboxEuMatchesList = [
+            'Xbox: NA and EU megaservers for',
+        ];
+        /**
+         * List of indicators proving that the announcement pertains to the slug server_xbox_na
+         * @private
+         */
+        this.ServerXboxNaMatchesList = [
+            'Xbox: NA and EU megaservers for',
+        ];
+        /**
+         * List of indicators proving that the announcement pertains to the slug service_store_eso
+         * @private
+         */
+        this.ServiceStoreEsoMatchesList = ['ESO Store and Account System for'];
+        /**
+         * List of indicators proving that the announcement pertains to the slug service_system_account
+         * @private
+         */
+        this.ServiceSystemAccountMatchesList = ['ESO Store and Account System for'];
+        /**
+         * List of indicators proving that the announcement pertains to the slug service_web_site
+         * @private
+         */
+        this.ServiceWebSiteMatchesList = [
+            'ESO Website for',
+        ];
+        this.slugMatches = [];
+        this.slugList.forEach((slug) => this.identify(slug));
+    }
+    /**
+     * Method for retrieving the list of indicators for a slug to test
+     * @param slug Slug to test
+     * @private
+     */
+    getMatchList(slug) {
+        return this[SlugIdentifier.getMatchListName(slug)];
+    }
+    /**
+     * Method for retrieving the name of the list of indicators for a slug to test
+     * @param slug Slug to test
+     * @private
+     */
+    static getMatchListName(slug) {
+        return `${slug
+            .split('_')
+            .map((item) => item.charAt(0).toUpperCase() + item.slice(1))
+            .join('')}MatchesList`;
+    }
+    /**
+     * Method for retrieving the indicators of a slug present in the announcement
+     * @param slug Slug to test
+     * @private
+     */
+    getMatches(slug) {
+        return this.getMatchList(slug).filter((identifier) => this.raw.includes(identifier));
+    }
+    /**
+     * Method for testing if the announcement contains indicators of a given slug
+     * @param slug Slug to test
+     * @private
+     */
+    identify(slug) {
+        const matches = this.getMatches(slug);
+        if (!matches.length) {
+            return;
+        }
+        this.slugMatches.push(new slug_match_1.default(matches[0], slug));
+    }
+}
+exports.default = SlugIdentifier;
+//# sourceMappingURL=slug.identifier.js.map

package/lib/identifier/slug.match.d.ts

@@ -0,0 +1,26 @@
+import { Slug, Support, Type, Zone } from '@eso-status/types';
+import { RemoteRawSlug } from '../type/remoteRawSlug.type';
+/**
+ * Class for retrieving information about a slug found in an announcement
+ */
+export default class SlugMatch {
+    readonly rawSlug: RemoteRawSlug;
+    readonly slug: Slug;
+    /**
+     * @param rawSlug Data used to identify the presence of the slug in the announcement
+     * @param slug Slug found in the announcement
+     */
+    constructor(rawSlug: RemoteRawSlug, slug: Slug);
+    /**
+     * Method for retrieving the type of the slug
+     */
+    getType(): Type;
+    /**
+     * Method for retrieving the support of the slug
+     */
+    getSupport(): Support;
+    /**
+     * Method for retrieving the area of the slug
+     */
+    getZone(): Zone;
+}

package/lib/identifier/slug.match.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Class for retrieving information about a slug found in an announcement
+ */
+class SlugMatch {
+    /**
+     * @param rawSlug Data used to identify the presence of the slug in the announcement
+     * @param slug Slug found in the announcement
+     */
+    constructor(rawSlug, slug) {
+        this.rawSlug = rawSlug;
+        this.slug = slug;
+    }
+    /**
+     * Method for retrieving the type of the slug
+     */
+    getType() {
+        return this.slug.split('_')[0];
+    }
+    /**
+     * Method for retrieving the support of the slug
+     */
+    getSupport() {
+        return this.slug.split('_')[1];
+    }
+    /**
+     * Method for retrieving the area of the slug
+     */
+    getZone() {
+        return this.slug.split('_')[2];
+    }
+}
+exports.default = SlugMatch;
+//# sourceMappingURL=slug.match.js.map

package/lib/identifier/status.identifier.d.ts

@@ -0,0 +1,63 @@
+import { Status } from '@eso-status/types';
+import { RemoteRawStatus } from '../type/remoteRawStatus.type';
+/**
+ * Class for identifying the status contained in an announcement
+ */
+export default class StatusIdentifier {
+    private readonly raw;
+    /**
+     * Data used to identify the presence of the status in the announcement
+     */
+    rawStatus: RemoteRawStatus;
+    /**
+     * Status found in the announcement
+     */
+    status: Status;
+    /**
+     * List of statuses to check for presence in the announcement
+     * @private
+     */
+    private readonly statusList;
+    /**
+     * List of indicators proving that the announcement pertains to the status up
+     * @private
+     */
+    private readonly upMatchesList;
+    /**
+     * List of indicators proving that the announcement pertains to the status down
+     * @private
+     */
+    private readonly downMatchesList;
+    /**
+     * List of indicators proving that the announcement pertains to the status planned
+     * @private
+     */
+    private readonly plannedMatchesList;
+    /**
+     * @param raw Raw data of the announcement
+     */
+    constructor(raw: string);
+    /**
+     * Method for retrieving the list of indicators for a status to test
+     * @param status Status to test
+     * @private
+     */
+    private getMatchList;
+    /**
+     * Method for retrieving the indicators of a status present in the announcement
+     * @param status Status to test
+     * @private
+     */
+    private getMatches;
+    /**
+     * Method for testing if the announcement contains indicators of a given status
+     * @param status Status to test
+     * @private
+     */
+    private identify;
+    /**
+     * Method for setting the default status to planned in the absence of indicators for other statuses
+     * @private
+     */
+    private default;
+}

package/lib/identifier/status.identifier.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Class for identifying the status contained in an announcement
+ */
+class StatusIdentifier {
+    /**
+     * @param raw Raw data of the announcement
+     */
+    constructor(raw) {
+        this.raw = raw;
+        /**
+         * List of statuses to check for presence in the announcement
+         * @private
+         */
+        this.statusList = ['up', 'down', 'planned'];
+        /**
+         * List of indicators proving that the announcement pertains to the status up
+         * @private
+         */
+        this.upMatchesList = [
+            '[COMPLETE]',
+            'now available',
+            'complete',
+        ];
+        /**
+         * List of indicators proving that the announcement pertains to the status down
+         * @private
+         */
+        this.downMatchesList = [
+            '[EXTENDED]',
+            '[IN PROGRESS]',
+            'unavailable',
+        ];
+        /**
+         * List of indicators proving that the announcement pertains to the status planned
+         * @private
+         */
+        this.plannedMatchesList = [
+            'We will be performing maintenance',
+        ];
+        this.statusList.forEach((status) => this.identify(status));
+        this.default();
+    }
+    /**
+     * Method for retrieving the list of indicators for a status to test
+     * @param status Status to test
+     * @private
+     */
+    getMatchList(status) {
+        return this[`${status}MatchesList`];
+    }
+    /**
+     * Method for retrieving the indicators of a status present in the announcement
+     * @param status Status to test
+     * @private
+     */
+    getMatches(status) {
+        return this.getMatchList(status).filter((identifier) => this.raw.includes(identifier));
+    }
+    /**
+     * Method for testing if the announcement contains indicators of a given status
+     * @param status Status to test
+     * @private
+     */
+    identify(status) {
+        const matches = this.getMatches(status);
+        if (!matches.length) {
+            return;
+        }
+        this.rawStatus = matches.shift();
+        this.status = status;
+    }
+    /**
+     * Method for setting the default status to planned in the absence of indicators for other statuses
+     * @private
+     */
+    default() {
+        if (!this.status) {
+            this.status = 'planned';
+        }
+    }
+}
+exports.default = StatusIdentifier;
+//# sourceMappingURL=status.identifier.js.map

package/lib/index.d.ts

@@ -1,17 +1,15 @@
-import { RawEsoStatus } from '@eso-status/types';
-export declare const ForumMessageURL = "https://forums.elderscrollsonline.com/";
-export declare const ForumMessagePTSURL = "https://forums.elderscrollsonline.com/en/categories/pts";
+import { EsoStatusRawData } from '@eso-status/types';
+import { SourceUrl } from './type/sourceUrl.type';
 /**
- * Class of Forum Message
+ * Class for retrieving announcement information
  */
-export declare class ForumMessage {
+export default class ForumMessage {
     /**
-       * Methode used to get Forum Message data
-       *
-       * @public
-       * @static
-       *
-       * @return Promise<RawEsoStatus[]> Forum Message elements
-       */
-    static getData(url?: string): Promise<RawEsoStatus[]>;
+     * Method for retrieving announcement information
+     */
+    static getData(): Promise<EsoStatusRawData[]>;
+    /**
+     * Method for retrieving announcement information from a specific URL
+     */
+    static getData(url: SourceUrl): Promise<EsoStatusRawData[]>;
 }