@eso-status/live-services 1.0.0

package/.npmrc

@@ -0,0 +1 @@
+engine-strict=true

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,119 @@
+# eso-status/live-services
+[![npm](https://img.shields.io/npm/v/@eso-status/live-services)](https://www.npmjs.com/package/@eso-status/live-services)
+[![license](https://img.shields.io/npm/l/@eso-status/live-services)](https://github.com/eso-status/live-services/blob/master/LICENSE.md)
+<img src="https://img.shields.io/npm/dt/@eso-status/live-services" alt="Downloads" />
+[![LGTM Grade](https://img.shields.io/lgtm/grade/javascript/github/eso-status/live-services)](https://lgtm.com/projects/g/eso-status/live-services/context:javascript)
+<img src="https://img.shields.io/node/v/@eso-status/live-services" alt="Node version" />
+[![Build Status](https://github.com/eso-status/live-services/workflows/CI/badge.svg)](https://github.com/eso-status/live-services/actions/workflows/CI.yaml)
+[![Delivery Status](https://github.com/eso-status/live-services/workflows/CD/badge.svg)](https://github.com/eso-status/live-services/actions/workflows/CD.yaml)
+
+eso-status/live-services is a library for getting and formatting data can founded in [https://live-services.elderscrollsonline.com/status/realms](https://live-services.elderscrollsonline.com/status/realms)
+
+## 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-)
+
+### How to get it ?
+```shell
+npm i @eso-status/live-services
+```
+
+### How to use it ?
+- TypeScript
+```typescript
+import { RawEsoStatus } from '@eso-status/types';
+import { LiveServices } from "@eso-status/live-services";
+
+LiveServices.getData().then((data: RawEsoStatus[]): void => {
+  
+}).catch((error: Error): void => {
+  
+});
+```
+- JavaScript
+```javascript
+const { LiveServices } = require('@eso-status/live-services');
+
+LiveServices.getData().then(function (data) {
+  
+}).catch(function (error) {
+  
+});
+```
+
+### Returned data format ?
+```text
+[
+  {
+    sources: [ 'https://live-services.elderscrollsonline.com/status/realms' ],
+    raw: [ 'The Elder Scrolls Online (EU)', 'UP' ],
+    rawSlug: 'The Elder Scrolls Online (EU)',
+    rawStatus: 'UP',
+    slugs: [ 'server_pc_eu' ],
+    support: 'pc',
+    zone: 'eu',
+    status: 'up'
+  },
+  {
+    sources: [ 'https://live-services.elderscrollsonline.com/status/realms' ],
+    raw: [ 'The Elder Scrolls Online (NA)', 'UP' ],
+    rawSlug: 'The Elder Scrolls Online (NA)',
+    rawStatus: 'UP',
+    slugs: [ 'server_pc_na' ],
+    support: 'pc',
+    zone: 'na',
+    status: 'up'
+  },
+  {
+    sources: [ 'https://live-services.elderscrollsonline.com/status/realms' ],
+    raw: [ 'The Elder Scrolls Online (PS4 - EU)', 'UP' ],
+    rawSlug: 'The Elder Scrolls Online (PS4 - EU)',
+    rawStatus: 'UP',
+    slugs: [ 'server_ps_eu' ],
+    support: 'ps',
+    zone: 'eu',
+    status: 'up'
+  },
+  {
+    sources: [ 'https://live-services.elderscrollsonline.com/status/realms' ],
+    raw: [ 'The Elder Scrolls Online (PS4 - US)', 'UP' ],
+    rawSlug: 'The Elder Scrolls Online (PS4 - US)',
+    rawStatus: 'UP',
+    slugs: [ 'server_ps_na' ],
+    support: 'ps',
+    zone: 'na',
+    status: 'up'
+  },
+  {
+    sources: [ 'https://live-services.elderscrollsonline.com/status/realms' ],
+    raw: [ 'The Elder Scrolls Online (PTS)', 'UP' ],
+    rawSlug: 'The Elder Scrolls Online (PTS)',
+    rawStatus: 'UP',
+    slugs: [ 'server_pc_pts' ],
+    support: 'pc',
+    zone: 'pts',
+    status: 'up'
+  },
+  {
+    sources: [ 'https://live-services.elderscrollsonline.com/status/realms' ],
+    raw: [ 'The Elder Scrolls Online (XBox - EU)', 'UP' ],
+    rawSlug: 'The Elder Scrolls Online (XBox - EU)',
+    rawStatus: 'UP',
+    slugs: [ 'server_xbox_eu' ],
+    support: 'xbox',
+    zone: 'eu',
+    status: 'up'
+  },
+  {
+    sources: [ 'https://live-services.elderscrollsonline.com/status/realms' ],
+    raw: [ 'The Elder Scrolls Online (XBox - US)', 'UP' ],
+    rawSlug: 'The Elder Scrolls Online (XBox - US)',
+    rawStatus: 'UP',
+    slugs: [ 'server_xbox_na' ],
+    support: 'xbox',
+    zone: 'na',
+    status: 'up'
+  }
+]
+```

package/lib/classes/LiveServicesElement.d.ts

@@ -0,0 +1,46 @@
+import { Support, Slug, Status, Zone } from '@eso-status/types';
+/**
+ * Class with methode for LiveServices element
+ */
+export default class LiveServicesElement {
+    /**
+       * Methode used to get slug of raw slug
+       *
+       * @public
+       * @static
+       *
+       * @param rawSlug string Raw slug
+       * @return Slug Slug
+       */
+    static getSlug(rawSlug: string): Slug;
+    /**
+       * Methode used to get support of slug
+       *
+       * @public
+       * @static
+       *
+       * @param slug Slug Slug
+       * @return Support Support of slug
+       */
+    static getSupport(slug: Slug): Support;
+    /**
+       * Methode used to get zone of slug
+       *
+       * @public
+       * @static
+       *
+       * @param slug Slug Slug
+       * @return Zone Zone of slug
+       */
+    static getZone(slug: Slug): Zone;
+    /**
+       * Methode used to get status of raw status
+       *
+       * @public
+       * @static
+       *
+       * @param rawStatus string Raw status
+       * @return Status Status of raw data
+       */
+    static getStatus(rawStatus: string): Status;
+}

package/lib/classes/LiveServicesElement.js

@@ -0,0 +1,83 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Class with methode for LiveServices element
+ */
+var LiveServicesElement = /** @class */ (function () {
+    function LiveServicesElement() {
+    }
+    /**
+       * Methode used to get slug of raw slug
+       *
+       * @public
+       * @static
+       *
+       * @param rawSlug string Raw slug
+       * @return Slug Slug
+       */
+    LiveServicesElement.getSlug = function (rawSlug) {
+        switch (rawSlug) {
+            case 'The Elder Scrolls Online (NA)':
+                return 'server_pc_na';
+            case 'The Elder Scrolls Online (EU)':
+                return 'server_pc_eu';
+            case 'The Elder Scrolls Online (XBox - US)':
+                return 'server_xbox_na';
+            case 'The Elder Scrolls Online (XBox - EU)':
+                return 'server_xbox_eu';
+            case 'The Elder Scrolls Online (PS4 - US)':
+                return 'server_ps_na';
+            case 'The Elder Scrolls Online (PS4 - EU)':
+                return 'server_ps_eu';
+            case 'The Elder Scrolls Online (PTS)':
+                return 'server_pc_pts';
+            default:
+                return 'undefined';
+        }
+    };
+    /**
+       * Methode used to get support of slug
+       *
+       * @public
+       * @static
+       *
+       * @param slug Slug Slug
+       * @return Support Support of slug
+       */
+    LiveServicesElement.getSupport = function (slug) {
+        return slug.split('_')[1];
+    };
+    /**
+       * Methode used to get zone of slug
+       *
+       * @public
+       * @static
+       *
+       * @param slug Slug Slug
+       * @return Zone Zone of slug
+       */
+    LiveServicesElement.getZone = function (slug) {
+        return slug.split('_')[2];
+    };
+    /**
+       * Methode used to get status of raw status
+       *
+       * @public
+       * @static
+       *
+       * @param rawStatus string Raw status
+       * @return Status Status of raw data
+       */
+    LiveServicesElement.getStatus = function (rawStatus) {
+        switch (rawStatus) {
+            case 'UP':
+                return 'up';
+            case 'DOWN':
+                return 'down';
+            default:
+                return 'undefined';
+        }
+    };
+    return LiveServicesElement;
+}());
+exports.default = LiveServicesElement;

package/lib/connectors/LiveServicesConnector.d.ts

@@ -0,0 +1,54 @@
+import { RawEsoStatus } from '@eso-status/types';
+/**
+ * Connector used to get data from https://live-services.elderscrollsonline.com/status/realms
+ */
+export default class LiveServicesConnector {
+    /**
+     * URL to get remote content
+     *
+     * @public
+     * @static
+     *
+     * @return string URL to get remote content
+     */
+    static url: string;
+    /**
+     * Methode used to get raw content of the remote website
+     *
+     * @public
+     * @static
+     *
+     * @return Promise<string> Raw content of the remote website
+     */
+    static getRemoteContent(): Promise<string>;
+    /**
+     * Methode used to select raw content containing eso servers status information
+     *
+     * @public
+     * @static
+     *
+     * @param remoteContent Raw content of the remote website
+     * @return string Raw content containing eso servers status information
+     */
+    static getFilterContent(remoteContent: string): string;
+    /**
+     * Methode used to get list of each raw information
+     *
+     * @public
+     * @static
+     *
+     * @param filteredContent string Raw content containing eso servers status information
+     * @return RawEsoStatus[] List of each information
+     */
+    static changeFilterContentForList(filteredContent: string): RawEsoStatus[];
+    /**
+     * Methode used to get last eso status server with data
+     *
+     * @public
+     * @static
+     *
+     * @param lastRawData ServiceAlertsInterface[] Raw eso server status list sorted by date
+     * @return RawEsoStatus[] Last eso status server with data
+     */
+    static getData(lastRawData: RawEsoStatus[]): RawEsoStatus[];
+}

package/lib/connectors/LiveServicesConnector.js

@@ -0,0 +1,138 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var axios_1 = require("axios");
+var LiveServicesElement_1 = require("../classes/LiveServicesElement");
+/**
+ * Connector used to get data from https://live-services.elderscrollsonline.com/status/realms
+ */
+var LiveServicesConnector = /** @class */ (function () {
+    function LiveServicesConnector() {
+    }
+    /**
+     * Methode used to get raw content of the remote website
+     *
+     * @public
+     * @static
+     *
+     * @return Promise<string> Raw content of the remote website
+     */
+    LiveServicesConnector.getRemoteContent = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, axios_1.default.get(LiveServicesConnector.url)];
+                    case 1:
+                        response = _a.sent();
+                        if ((response === null || response === void 0 ? void 0 : response.status) !== 200) {
+                            throw new Error("Bad response ".concat(response === null || response === void 0 ? void 0 : response.status, " (").concat(response === null || response === void 0 ? void 0 : response.data, ")"));
+                        }
+                        else if (!(response === null || response === void 0 ? void 0 : response.data)) {
+                            throw new Error("Empty response ".concat(response === null || response === void 0 ? void 0 : response.status, " (").concat(response === null || response === void 0 ? void 0 : response.data, ")"));
+                        }
+                        else {
+                            return [2 /*return*/, JSON.stringify(response === null || response === void 0 ? void 0 : response.data)];
+                        }
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * Methode used to select raw content containing eso servers status information
+     *
+     * @public
+     * @static
+     *
+     * @param remoteContent Raw content of the remote website
+     * @return string Raw content containing eso servers status information
+     */
+    LiveServicesConnector.getFilterContent = function (remoteContent) {
+        var _a, _b;
+        return JSON.stringify((_b = (_a = JSON.parse(remoteContent)) === null || _a === void 0 ? void 0 : _a.zos_platform_response) === null || _b === void 0 ? void 0 : _b.response);
+    };
+    /**
+     * Methode used to get list of each raw information
+     *
+     * @public
+     * @static
+     *
+     * @param filteredContent string Raw content containing eso servers status information
+     * @return RawEsoStatus[] List of each information
+     */
+    LiveServicesConnector.changeFilterContentForList = function (filteredContent) {
+        return Object.entries(JSON.parse(filteredContent)).map(function (item) { return ({
+            sources: [LiveServicesConnector.url],
+            raw: [item[0], String(item[1])],
+            rawSlug: item[0],
+            rawStatus: String(item[1]),
+        }); });
+    };
+    /**
+     * Methode used to get last eso status server with data
+     *
+     * @public
+     * @static
+     *
+     * @param lastRawData ServiceAlertsInterface[] Raw eso server status list sorted by date
+     * @return RawEsoStatus[] Last eso status server with data
+     */
+    LiveServicesConnector.getData = function (lastRawData) {
+        return lastRawData.map(function (item) {
+            var _a, _b;
+            var newItem = item;
+            newItem.slugs = [LiveServicesElement_1.default.getSlug((_a = newItem.rawSlug) !== null && _a !== void 0 ? _a : '')];
+            newItem.support = LiveServicesElement_1.default.getSupport(newItem.slugs[0]);
+            newItem.zone = LiveServicesElement_1.default.getZone(newItem.slugs[0]);
+            newItem.status = LiveServicesElement_1.default.getStatus((_b = newItem.rawStatus) !== null && _b !== void 0 ? _b : '');
+            return newItem;
+        });
+    };
+    /**
+     * URL to get remote content
+     *
+     * @public
+     * @static
+     *
+     * @return string URL to get remote content
+     */
+    LiveServicesConnector.url = 'https://live-services.elderscrollsonline.com/status/realms';
+    return LiveServicesConnector;
+}());
+exports.default = LiveServicesConnector;

package/lib/index.d.ts

@@ -0,0 +1,15 @@
+import { RawEsoStatus } from '@eso-status/types';
+/**
+ * Class of Live Services
+ */
+export declare class LiveServices {
+    /**
+       * Methode used to get Live Services data
+       *
+       * @public
+       * @static
+       *
+       * @return Promise<RawEsoStatus[]> Live Services elements
+       */
+    static getData(): Promise<RawEsoStatus[]>;
+}

package/lib/index.js

@@ -0,0 +1,72 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LiveServices = void 0;
+var LiveServicesConnector_1 = require("./connectors/LiveServicesConnector");
+/**
+ * Class of Live Services
+ */
+var LiveServices = /** @class */ (function () {
+    function LiveServices() {
+    }
+    /**
+       * Methode used to get Live Services data
+       *
+       * @public
+       * @static
+       *
+       * @return Promise<RawEsoStatus[]> Live Services elements
+       */
+    LiveServices.getData = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var remoteContent, filteredContent, lastRawData;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, LiveServicesConnector_1.default.getRemoteContent()];
+                    case 1:
+                        remoteContent = _a.sent();
+                        filteredContent = LiveServicesConnector_1.default.getFilterContent(remoteContent);
+                        lastRawData = LiveServicesConnector_1.default.changeFilterContentForList(filteredContent);
+                        return [2 /*return*/, LiveServicesConnector_1.default.getData(lastRawData)];
+                }
+            });
+        });
+    };
+    return LiveServices;
+}());
+exports.LiveServices = LiveServices;

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@eso-status/live-services",
+  "version": "1.0.0",
+  "description": "Library used to get servers status of The elders scrolls Online game with https://live-services.elderscrollsonline.com/status/realms",
+  "main": "lib/index.js",
+  "scripts": {
+    "lint": "eslint tests src --ext .ts",
+    "lint:fix": "eslint tests src --ext .ts --fix",
+    "build": "rm -R -f lib/* && tsc",
+    "test": "jest",
+    "start": "node .",
+    "dev": "npm run lint && npm run build && npm run start",
+    "watch": "nodemon --exec npm run dev"
+  },
+  "files": [
+    "lib/classes/LiveServicesElement.d.ts",
+    "lib/classes/LiveServicesElement.js",
+    "lib/connectors/LiveServicesConnector.d.ts",
+    "lib/connectors/LiveServicesConnector.js",
+    "lib/index.d.ts",
+    "lib/index.js",
+    ".npmrc",
+    "LICENSE.md",
+    "package.json",
+    "README.md"
+  ],
+  "engineStrict": true,
+  "engines": {
+    "node": "^10.18.0 || ^12.14.0 || >=14.15.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:eso-status/live-services-dev.git"
+  },
+  "author": "@dov118 <contact@dov118.dev> (https://dov118.dev)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/eso-status/live-services-dev/issues"
+  },
+  "homepage": "https://github.com/eso-status/live-services-dev#readme",
+  "devDependencies": {
+    "@eso-status/types": "1.0.0",
+    "@types/jest": "^27.0.3",
+    "@types/node": "16.11.11",
+    "@typescript-eslint/eslint-plugin": "5.5.0",
+    "@typescript-eslint/parser": "5.5.0",
+    "@typescript-eslint/typescript-estree": "5.5.0",
+    "eslint": "8.3.0",
+    "eslint-config-airbnb-base": "15.0.0",
+    "eslint-plugin-import": "2.25.3",
+    "eslint-plugin-jest": "25.3.0",
+    "jest": "27.4.2",
+    "nodemon": "2.0.15",
+    "ts-jest": "27.0.7",
+    "typescript": "4.5.2"
+  },
+  "dependencies": {
+    "axios": "0.24.0"
+  }
+}