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

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 dov118
+Copyright (c) 2024 dov118
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,145 +1,152 @@
 # eso-status/forum-message
+
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=eso-status_forum-message&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=eso-status_forum-message)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=eso-status_forum-message&metric=bugs)](https://sonarcloud.io/summary/new_code?id=eso-status_forum-message)
+[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=eso-status_forum-message&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=eso-status_forum-message)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=eso-status_forum-message&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=eso-status_forum-message)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=eso-status_forum-message&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=eso-status_forum-message)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=eso-status_forum-message&metric=coverage)](https://sonarcloud.io/summary/new_code?id=eso-status_forum-message)
+[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=eso-status_forum-message&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=eso-status_forum-message)
+
 [![npm](https://img.shields.io/npm/v/@eso-status/forum-message)](https://www.npmjs.com/package/@eso-status/forum-message)
 [![license](https://img.shields.io/npm/l/@eso-status/forum-message)](https://github.com/eso-status/forum-message/blob/master/LICENSE.md)
 <img src="https://img.shields.io/npm/dt/@eso-status/forum-message" alt="Downloads" />
-[![LGTM Grade](https://img.shields.io/lgtm/grade/javascript/github/eso-status/forum-message)](https://lgtm.com/projects/g/eso-status/forum-message/context:javascript)
 <img src="https://img.shields.io/node/v/@eso-status/forum-message" alt="Node version" />
+
 [![Build Status](https://github.com/eso-status/forum-message/workflows/CI/badge.svg)](https://github.com/eso-status/forum-message/actions/workflows/CI.yaml)
-[![Delivery Status](https://github.com/eso-status/forum-message/workflows/CD/badge.svg)](https://github.com/eso-status/forum-message/actions/workflows/CD.yaml)
+[![Build Status](https://github.com/eso-status/forum-message/workflows/CD/badge.svg)](https://github.com/eso-status/forum-message/actions/workflows/CD.yaml)
 
-eso-status/forum-message is a library for getting and formatting data can founded in [https://forums.elderscrollsonline.com/](https://forums.elderscrollsonline.com/) and [https://forums.elderscrollsonline.com/en/categories/pts](https://forums.elderscrollsonline.com/en/categories/pts)
+eso-status/forum-message is a library for retrieving and formatting data, which can be found at [https://forums.elderscrollsonline.com](https://forums.elderscrollsonline.com) or [https://forums.elderscrollsonline.com/en/categories/pts](https://forums.elderscrollsonline.com/en/categories/pts).
 
 ## Table of Contents
-- [How to get it ?](#how-to-get-it-)
-- [How to use it ?](#how-to-use-it-)
-- [Returned data format](#returned-data-format-)
+- [Install](#install)
+- [Usage](#usage)
+- [Return exemple](#return-exemple)
 
-### How to get it ?
+### Install
 ```shell
 npm i @eso-status/forum-message
 ```
 
-### How to use it ?
-- TypeScript
-```typescript
+### Usage
+```javascript
+import ForumMessage from '@eso-status/forum-message';
 import { RawEsoStatus } from '@eso-status/types';
-import { ForumMessage } from "@eso-status/forum-message";
+import { ForumMessageURL } from '@eso-status/forum-message/const';
 
-ForumMessage.getData().then((data: RawEsoStatus[]): void => {
-  
-}).catch((error: Error): void => {
-  
-});
-```
-- JavaScript
-```javascript
-const { ForumMessage } = require('@eso-status/forum-message');
+// Homepage data
+const rawEsoStatus: RawEsoStatus = await ForumMessage.getData();
 
-ForumMessage.getData().then(function (data) {
-  
-}).catch(function (error) {
-  
-});
+// PTS category homepage data
+const rawEsoStatus: RawEsoStatus = await ForumMessage.getData(ForumMessageURL);
 ```
-
-### Returned data format ?
+### Return exemple
 ```text
 [
   {
-    sources: [
-      'https://forums.elderscrollsonline.com/en/categories/pts',
-      'https://forums.elderscrollsonline.com/'
-    ],
-    raw: '• PC/Mac: NA and EU megaservers for patch maintenance – July 26, 4:00AM EDT (8:00 UTC) – 8:00AM EDT (12:00 UTC)',
-    slugs: [ 'server_pc_na' ],
-    rawDate: 'July 26, 4:00AM EDT (8:00 UTC) – 8:00AM EDT (12:00 UTC)',
-    date: [ Moment<2021-07-26T06:00:00Z>, Moment<2021-07-26T10:00:00Z> ],
+    source: 'https://forums.elderscrollsonline.com',
+    raw: '• PC/Mac: NA and EU megaservers for patch maintenance – September 3, 4:00AM EDT (8:00 UTC) – 9:00AM EDT (13:00 UTC)',
+    slug: 'server_pc_eu',
     type: 'server',
     support: 'pc',
-    zone: 'na',
-    status: 'planned'
+    zone: 'eu',
+    status: 'planned',
+    rawSlug: 'PC/Mac: NA and EU megaservers for'
   },
   {
-    sources: [
-      'https://forums.elderscrollsonline.com/en/categories/pts',
-      'https://forums.elderscrollsonline.com/'
-    ],
-    raw: '• PC/Mac: NA and EU megaservers for patch maintenance – July 26, 4:00AM EDT (8:00 UTC) – 8:00AM EDT (12:00 UTC)',
-    slugs: [ 'server_pc_eu' ],
-    rawDate: 'July 26, 4:00AM EDT (8:00 UTC) – 8:00AM EDT (12:00 UTC)',
-    date: [ Moment<2021-07-26T06:00:00Z>, Moment<2021-07-26T10:00:00Z> ],
+    source: 'https://forums.elderscrollsonline.com',
+    raw: '• PC/Mac: NA and EU megaservers for patch maintenance – September 3, 4:00AM EDT (8:00 UTC) – 9:00AM EDT (13:00 UTC)',
+    slug: 'server_pc_na',
     type: 'server',
     support: 'pc',
+    zone: 'na',
+    status: 'planned',
+    rawSlug: 'PC/Mac: NA and EU megaservers for'
+  },
+  {
+    source: 'https://forums.elderscrollsonline.com',
+    raw: '• Xbox: NA and EU megaservers for patch maintenance – September 4, 6:00AM EDT (10:00 UTC) - 12:00PM EDT (16:00 UTC)',
+    slug: 'server_xbox_eu',
+    type: 'server',
+    support: 'xbox',
     zone: 'eu',
-    status: 'planned'
+    status: 'planned',
+    rawSlug: 'Xbox: NA and EU megaservers for',
+    rawDate: 'September 4, 6:00AM EDT (10:00 UTC) - 12:00PM EDT (16:00 UTC)',
+    dates: [ Moment<2024-09-04T10:00:00Z>, Moment<2024-09-04T16:00:00Z> ]
   },
   {
-    sources: [
-      'https://forums.elderscrollsonline.com/en/categories/pts',
-      'https://forums.elderscrollsonline.com/'
-    ],
-    raw: '• Xbox: NA and EU megaservers for patch maintenance – July 28, 6:00AM EDT (10:00 UTC) – 10:00AM EDT (14:00 UTC)',
-    slugs: [ 'server_xbox_na' ],
-    rawDate: 'July 28, 6:00AM EDT (10:00 UTC) – 10:00AM EDT (14:00 UTC)',
-    date: [ Moment<2021-07-28T08:00:00Z>, Moment<2021-07-28T12:00:00Z> ],
+    source: 'https://forums.elderscrollsonline.com',
+    raw: '• Xbox: NA and EU megaservers for patch maintenance – September 4, 6:00AM EDT (10:00 UTC) - 12:00PM EDT (16:00 UTC)',
+    slug: 'server_xbox_na',
     type: 'server',
     support: 'xbox',
     zone: 'na',
-    status: 'planned'
+    status: 'planned',
+    rawSlug: 'Xbox: NA and EU megaservers for',
+    rawDate: 'September 4, 6:00AM EDT (10:00 UTC) - 12:00PM EDT (16:00 UTC)',
+    dates: [ Moment<2024-09-04T10:00:00Z>, Moment<2024-09-04T16:00:00Z> ]
   },
   {
-    sources: [
-      'https://forums.elderscrollsonline.com/en/categories/pts',
-      'https://forums.elderscrollsonline.com/'
-    ],
-    raw: '• Xbox: NA and EU megaservers for patch maintenance – July 28, 6:00AM EDT (10:00 UTC) – 10:00AM EDT (14:00 UTC)',
-    slugs: [ 'server_xbox_eu' ],
-    rawDate: 'July 28, 6:00AM EDT (10:00 UTC) – 10:00AM EDT (14:00 UTC)',
-    date: [ Moment<2021-07-28T08:00:00Z>, Moment<2021-07-28T12:00:00Z> ],
+    source: 'https://forums.elderscrollsonline.com',
+    raw: '• PlayStation®: NA and EU megaservers for patch maintenance – September 4, 6:00AM EDT (10:00 UTC) - 12:00PM EDT (16:00 UTC)',
+    slug: 'server_ps_eu',
     type: 'server',
-    support: 'xbox',
+    support: 'ps',
     zone: 'eu',
-    status: 'planned'
+    status: 'planned',
+    rawSlug: 'PlayStation®: NA and EU megaservers for',
+    rawDate: 'September 4, 6:00AM EDT (10:00 UTC) - 12:00PM EDT (16:00 UTC)',
+    dates: [ Moment<2024-09-04T10:00:00Z>, Moment<2024-09-04T16:00:00Z> ]
   },
   {
-    sources: [
-      'https://forums.elderscrollsonline.com/en/categories/pts',
-      'https://forums.elderscrollsonline.com/'
-    ],
-    raw: '• PlayStation®: NA and EU megaservers for patch maintenance – July 28, 6:00AM EDT (10:00 UTC) – 10:00AM EDT (14:00 UTC)',
-    slugs: [ 'server_ps_na' ],
-    rawDate: 'July 28, 6:00AM EDT (10:00 UTC) – 10:00AM EDT (14:00 UTC)',
-    date: [ Moment<2021-07-28T08:00:00Z>, Moment<2021-07-28T12:00:00Z> ],
+    source: 'https://forums.elderscrollsonline.com',
+    raw: '• PlayStation®: NA and EU megaservers for patch maintenance – September 4, 6:00AM EDT (10:00 UTC) - 12:00PM EDT (16:00 UTC)',
+    slug: 'server_ps_na',
     type: 'server',
     support: 'ps',
     zone: 'na',
-    status: 'planned'
+    status: 'planned',
+    rawSlug: 'PlayStation®: NA and EU megaservers for',
+    rawDate: 'September 4, 6:00AM EDT (10:00 UTC) - 12:00PM EDT (16:00 UTC)',
+    dates: [ Moment<2024-09-04T10:00:00Z>, Moment<2024-09-04T16:00:00Z> ]
   },
   {
-    sources: [
-      'https://forums.elderscrollsonline.com/en/categories/pts',
-      'https://forums.elderscrollsonline.com/'
-    ],
-    raw: '• PlayStation®: NA and EU megaservers for patch maintenance – July 28, 6:00AM EDT (10:00 UTC) – 10:00AM EDT (14:00 UTC)',
-    slugs: [ 'server_ps_eu' ],
-    rawDate: 'July 28, 6:00AM EDT (10:00 UTC) – 10:00AM EDT (14:00 UTC)',
-    date: [ Moment<2021-07-28T08:00:00Z>, Moment<2021-07-28T12:00:00Z> ],
-    type: 'server',
-    support: 'ps',
-    zone: 'eu',
-    status: 'planned'
+    source: 'https://forums.elderscrollsonline.com',
+    raw: '• ESO Store and Account System for maintenance – September 4, 10:00AM EDT (14:00 UTC) - 12:00PM EDT (16:00 UTC)',
+    slug: 'service_store_eso',
+    type: 'service',
+    support: 'store',
+    zone: 'eso',
+    status: 'planned',
+    rawSlug: 'ESO Store and Account System for',
+    rawDate: 'September 4, 10:00AM EDT (14:00 UTC) - 12:00PM EDT (16:00 UTC)',
+    dates: [ Moment<2024-09-04T14:00:00Z>, Moment<2024-09-04T16:00:00Z> ]
   },
   {
-    sources: [ 'https://forums.elderscrollsonline.com/en/categories/pts' ],
-    raw: 'We will be performing maintenance for patch 7.1.2 on the PTS on Monday at 2:00AM EDT (06:00 UTC). ',
-    slugs: [ 'server_pc_pts' ],
-    rawDate: 'Monday at 2:00AM EDT (06:00 UTC). ',
-    date: [ Moment<2021-07-24T04:00:00Z> ],
+    source: 'https://forums.elderscrollsonline.com',
+    raw: '• ESO Store and Account System for maintenance – September 4, 10:00AM EDT (14:00 UTC) - 12:00PM EDT (16:00 UTC)',
+    slug: 'service_system_account',
+    type: 'service',
+    support: 'system',
+    zone: 'account',
+    status: 'planned',
+    rawSlug: 'ESO Store and Account System for',
+    rawDate: 'September 4, 10:00AM EDT (14:00 UTC) - 12:00PM EDT (16:00 UTC)',
+    dates: [ Moment<2024-09-04T14:00:00Z>, Moment<2024-09-04T16:00:00Z> ]
+  },
+  {
+    source: 'https://forums.elderscrollsonline.com/en/categories/pts',
+    raw: 'We will be performing maintenance on the PTS on Thursday at 9:00AM EDT (13:00 UTC).',
+    slug: 'server_pc_pts',
     type: 'server',
     support: 'pc',
     zone: 'pts',
-    status: 'planned'
+    status: 'planned',
+    rawSlug: 'PTS',
+    rawDate: 'Thursday at 9:00AM EDT (13:00 UTC). ',
+    dates: [ Moment<2024-09-05T13:00:00Z> ],
+    rawStatus: 'We will be performing maintenance'
   }
 ]
 ```
-

package/lib/connector.d.ts

@@ -0,0 +1,68 @@
+import { SourceUrl } from './type/sourceUrl.type';
+import { EsoStatusRawData } from './interface/esoStatusRawData.interface';
+/**
+ * Class for retrieving information from announcements
+ */
+export default class Connector {
+    private readonly url;
+    private readonly remoteContent;
+    /**
+     * List of raw data from announcements
+     */
+    raw: string[];
+    /**
+     * List of information from announcements
+     */
+    rawEsoStatus: EsoStatusRawData[];
+    /**
+     * @param url URL used as the source to retrieve announcements
+     * @param remoteContent Content of the source retrieved via URL
+     */
+    constructor(url: SourceUrl, remoteContent: string);
+    /**
+     * Method for creating an instance of the connector via a URL
+     * @param url URL used as the source to retrieve announcements
+     */
+    static init(url: SourceUrl): Promise<Connector>;
+    /**
+     * Method for retrieving remote content via a URL
+     * @param url URL serving as the source for retrieving announcements
+     * @private
+     */
+    private static getRemoteContent;
+    /**
+     * Method for retrieving raw announcements for all announcement levels
+     * @private
+     */
+    private getMessages;
+    /**
+     * Method for retrieving raw announcements based on the announcement level
+     * @private
+     */
+    private getMessagesByType;
+    /**
+     * Method for formatting the raw data of retrieved announcements
+     * @private
+     */
+    private replace;
+    /**
+     * Method for separating each announcement message
+     */
+    private split;
+    /**
+     * Method for removing unnecessary announcements
+     * @private
+     */
+    private filter;
+    /**
+     * Method for analyzing each announcement
+     * @private
+     */
+    private fetch;
+    /**
+     * Method for retrieving the information contained in an announcement
+     * @param raw Raw data of the announcement
+     * @private
+     */
+    private fetchEach;
+}

package/lib/connector.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = require("axios");
+const raw_1 = require("./raw");
+/**
+ * Class for retrieving information from announcements
+ */
+class Connector {
+    /**
+     * @param url URL used as the source to retrieve announcements
+     * @param remoteContent Content of the source retrieved via URL
+     */
+    constructor(url, remoteContent) {
+        this.url = url;
+        this.remoteContent = remoteContent;
+        /**
+         * List of raw data from announcements
+         */
+        this.raw = [];
+        /**
+         * List of information from announcements
+         */
+        this.rawEsoStatus = [];
+        this.getMessages();
+        this.replace();
+        this.split();
+        this.filter();
+        this.fetch();
+    }
+    /**
+     * Method for creating an instance of the connector via a URL
+     * @param url URL used as the source to retrieve announcements
+     */
+    static async init(url) {
+        return new Connector(url, await Connector.getRemoteContent(url));
+    }
+    /**
+     * Method for retrieving remote content via a URL
+     * @param url URL serving as the source for retrieving announcements
+     * @private
+     */
+    static async getRemoteContent(url) {
+        const response = await axios_1.default.get(url);
+        return response?.status === 200 && !!response?.data
+            ? String(response?.data)
+            : '';
+    }
+    /**
+     * Method for retrieving raw announcements for all announcement levels
+     * @private
+     */
+    getMessages() {
+        ['WarningMessage', 'AlertMessage'].forEach((type) => this.getMessagesByType(type));
+    }
+    /**
+     * Method for retrieving raw announcements based on the announcement level
+     * @private
+     */
+    getMessagesByType(type) {
+        const split = this.remoteContent.split(`<div class="DismissMessage ${type}">`);
+        split.shift();
+        split.forEach((item) => {
+            const result = item.split('</div>');
+            if (result.length >= 2) {
+                this.raw.push(result[0]);
+            }
+        });
+    }
+    /**
+     * Method for formatting the raw data of retrieved announcements
+     * @private
+     */
+    replace() {
+        this.raw = this.raw.map((raw) => {
+            let initialRaw = raw;
+            initialRaw = initialRaw.replace(/<br\/>\n/g, '<br>');
+            return initialRaw.replace('. ', '.');
+        });
+    }
+    /**
+     * Method for separating each announcement message
+     */
+    split() {
+        const rawList = this.raw;
+        this.raw = [];
+        rawList.forEach((raw) => {
+            raw.split('<br>').forEach((split) => {
+                this.raw.push(split);
+            });
+        });
+    }
+    /**
+     * Method for removing unnecessary announcements
+     * @private
+     */
+    filter() {
+        this.raw = this.raw.filter((raw) => {
+            return (!raw.includes('Maintenance for the week of ') &&
+                !raw.includes('• PC/Mac: No maintenance – ') &&
+                raw !== '');
+        });
+    }
+    /**
+     * Method for analyzing each announcement
+     * @private
+     */
+    fetch() {
+        this.raw.forEach((raw) => this.fetchEach(raw));
+    }
+    /**
+     * Method for retrieving the information contained in an announcement
+     * @param raw Raw data of the announcement
+     * @private
+     */
+    fetchEach(raw) {
+        new raw_1.default(this.url, raw).matches.forEach((match) => {
+            this.rawEsoStatus.push(match);
+        });
+    }
+}
+exports.default = Connector;
+//# sourceMappingURL=connector.js.map

package/lib/const.d.ts

@@ -0,0 +1,9 @@
+import { SourceUrl } from './type/sourceUrl.type';
+/**
+ * Homepage URL
+ */
+export declare const ForumMessageURL: SourceUrl;
+/**
+ * PTS category homepage URL
+ */
+export declare const ForumMessagePTSURL: SourceUrl;

package/lib/const.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ForumMessagePTSURL = exports.ForumMessageURL = void 0;
+/**
+ * Homepage URL
+ */
+exports.ForumMessageURL = 'https://forums.elderscrollsonline.com';
+/**
+ * PTS category homepage URL
+ */
+exports.ForumMessagePTSURL = 'https://forums.elderscrollsonline.com/en/categories/pts';
+//# sourceMappingURL=const.js.map

package/lib/formatter/date.formatter.d.ts

@@ -0,0 +1,97 @@
+import { Moment } from 'moment';
+/**
+ * Class for identifying and formatting the date contained in an announcement
+ */
+export default class DateFormatter {
+    private readonly raw;
+    /**
+     * Raw date data contained in the announcement
+     */
+    rawDate: string;
+    /**
+     * List of dates formatted correctly contained in the announcement
+     */
+    dates: Moment[];
+    /**
+     * @param raw Raw data of the announcement
+     */
+    constructor(raw: string);
+    /**
+     * 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
+     */
+    private checkFormat;
+    /**
+     * Method for retrieving the raw date in case #1
+     * @private
+     */
+    private getRawClassicDate;
+    /**
+     * Method for retrieving the raw date in case #2
+     * @private
+     */
+    private getRawSpecialDate;
+    /**
+     * Method for generating the list of correctly formatted dates for case #1
+     * @private
+     */
+    private formatClassic;
+    /**
+     * Method for retrieving the month number for case #1
+     * @private
+     */
+    private getRawClassicMouth;
+    /**
+     * Method for retrieving the day number for case #1
+     * @private
+     */
+    private getRawClassicDay;
+    /**
+     * Method for retrieving the hour number from a raw date
+     * @private
+     */
+    private getRawHour;
+    /**
+     * Method for retrieving the minute number of the start time for case #1
+     * @private
+     */
+    private getRawClassicMinute1;
+    /**
+     * Method for retrieving the end hour number in case #1
+     * @private
+     */
+    private getRawClassicHour2;
+    /**
+     * Method for retrieving the minute number of the end time in case #1
+     * @private
+     */
+    private getRawClassicMinute2;
+    /**
+     * Method for generating the correctly formatted date in case #2
+     * @private
+     */
+    private formatSpecial;
+    /**
+     * 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
+     */
+    private getSpecialDate;
+    /**
+     * Method for retrieving the minute number of the time in case #2
+     * @private
+     */
+    private getRawSpecialMinute;
+    /**
+     * Method for formatting a date correctly
+     * @param year
+     * @param month
+     * @param day
+     * @param hour
+     * @param minute
+     * @private
+     */
+    private static generateMoment;
+}