@eso-status/live-services 2.0.0-dev.0 → 2.0.0-dev.1

package/lib/connector.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Class for retrieving information from announcements
+ */
+export default class Connector {
+    /**
+     * Method for retrieving remote content via a URL
+     * @private
+     */
+    static getRemoteContent(): Promise<string>;
+}

package/lib/connector.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = require("axios");
+const const_1 = require("./const");
+/**
+ * Class for retrieving information from announcements
+ */
+class Connector {
+    /**
+     * Method for retrieving remote content via a URL
+     * @private
+     */
+    static async getRemoteContent() {
+        const response = await axios_1.default.get(const_1.LiveServicesURL);
+        return response?.status === 200 && !!response?.data
+            ? JSON.stringify(response?.data)
+            : '';
+    }
+}
+exports.default = Connector;
+//# sourceMappingURL=connector.js.map

package/lib/const.d.ts

@@ -0,0 +1,10 @@
+import { RawAssociation } from './interface/rawAssociation.interface';
+import { SourceUrl } from './type/sourceUrl.type';
+/**
+ * URL serving as source for retrieving maintenance announcements
+ */
+export declare const LiveServicesURL: SourceUrl;
+/**
+ * Association between raw data and its support and zone
+ */
+export declare const rawSupportZoneAssociations: RawAssociation[];

package/lib/const.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rawSupportZoneAssociations = exports.LiveServicesURL = void 0;
+const types_1 = require("@eso-status/types");
+/**
+ * URL serving as source for retrieving maintenance announcements
+ */
+exports.LiveServicesURL = 'https://live-services.elderscrollsonline.com/status/realms';
+/**
+ * Association between raw data and its support and zone
+ */
+exports.rawSupportZoneAssociations = [
+    {
+        raw: 'The Elder Scrolls Online (EU)',
+        support: types_1.PcSupport,
+        zone: types_1.EuZone,
+    },
+    {
+        raw: 'The Elder Scrolls Online (NA)',
+        support: types_1.PcSupport,
+        zone: types_1.NaZone,
+    },
+    {
+        raw: 'The Elder Scrolls Online (PS4 - EU)',
+        support: types_1.PsSupport,
+        zone: types_1.EuZone,
+    },
+    {
+        raw: 'The Elder Scrolls Online (PS4 - US)',
+        support: types_1.PsSupport,
+        zone: types_1.NaZone,
+    },
+    {
+        raw: 'The Elder Scrolls Online (PTS)',
+        support: types_1.PcSupport,
+        zone: types_1.PtsZone,
+    },
+    {
+        raw: 'The Elder Scrolls Online (XBox - EU)',
+        support: types_1.XboxSupport,
+        zone: types_1.EuZone,
+    },
+    {
+        raw: 'The Elder Scrolls Online (XBox - US)',
+        support: types_1.XboxSupport,
+        zone: types_1.NaZone,
+    },
+];
+//# sourceMappingURL=const.js.map

package/lib/index.d.ts

@@ -0,0 +1,10 @@
+import { EsoStatusRawData } from './interface/esoStatusRawData.interface';
+/**
+ * Class for retrieving announcement information
+ */
+export default class LiveServices {
+    /**
+     * Method for retrieving announcement information
+     */
+    static getData(): Promise<EsoStatusRawData[]>;
+}

package/lib/interface/esoStatusRawData.interface.d.ts

@@ -0,0 +1,46 @@
+import { ServerTypeType, Slug, Status, Support, Zone } from '@eso-status/types';
+import { RemoteRawStatus } from '../type/remoteRawStatus.type';
+import { RemoteRawSlug } from '../type/remoteRawSlug.type';
+import { RemoteRaw } from '../type/remoteRaw.type';
+import { SourceUrl } from '../type/sourceUrl.type';
+/**
+ * Raw data of an ESO server/service status
+ */
+export interface EsoStatusRawData {
+    /**
+     * URL of the data source
+     */
+    source: SourceUrl;
+    /**
+     * Raw data used to identify the server/service and its status
+     */
+    raw: RemoteRaw;
+    /**
+     * Status of the server/service
+     */
+    status: Status;
+    /**
+     * Raw data used to identify the status
+     */
+    rawStatus?: RemoteRawStatus;
+    /**
+     * Slug of the server/service
+     */
+    slug: Slug;
+    /**
+     * Raw data used to identify the slug
+     */
+    rawSlug: RemoteRawSlug;
+    /**
+     * Type of the server/service
+     */
+    type: ServerTypeType;
+    /**
+     * Support of the server/service
+     */
+    support: Support;
+    /**
+     * Zone of the server/service
+     */
+    zone: Zone;
+}

package/lib/interface/esoStatusRawData.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=esoStatusRawData.interface.js.map

package/lib/interface/rawAssociation.interface.d.ts

@@ -0,0 +1,10 @@
+import { Support, Zone } from '@eso-status/types';
+import { RemoteRawSlug } from '../type/remoteRawSlug.type';
+/**
+ * Structure of an association between a server, its support, and its zone
+ */
+export interface RawAssociation {
+    raw: RemoteRawSlug;
+    support: Support;
+    zone: Zone;
+}

package/lib/interface/rawAssociation.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=rawAssociation.interface.js.map

package/lib/interface/remoteData.interface.d.ts

@@ -0,0 +1,21 @@
+import { RemoteResultMessage } from '../type/remoteResultMessage.type';
+import { RemoteResultCode } from '../type/remoteResultCode.type';
+import { RemoteRawStatus } from '../type/remoteRawStatus.type';
+/**
+ * Structure of the data returned by the API
+ */
+export interface RemoteData {
+    zos_platform_response: {
+        response: {
+            'The Elder Scrolls Online (EU)': RemoteRawStatus;
+            'The Elder Scrolls Online (NA)': RemoteRawStatus;
+            'The Elder Scrolls Online (PS4 - EU)': RemoteRawStatus;
+            'The Elder Scrolls Online (PS4 - US)': RemoteRawStatus;
+            'The Elder Scrolls Online (PTS)': RemoteRawStatus;
+            'The Elder Scrolls Online (XBox - EU)': RemoteRawStatus;
+            'The Elder Scrolls Online (XBox - US)': RemoteRawStatus;
+        };
+        result_code: RemoteResultCode;
+        result_message: RemoteResultMessage;
+    };
+}

package/lib/interface/remoteData.interface.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=remoteData.interface.js.map

package/lib/type/remoteRaw.type.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Different raw data from announcements
+ */
+export type RemoteRaw = '"The Elder Scrolls Online (EU)":"UP"' | '"The Elder Scrolls Online (EU)":"DOWN"' | '"The Elder Scrolls Online (NA)":"UP"' | '"The Elder Scrolls Online (NA)":"DOWN"' | '"The Elder Scrolls Online (PS4 - EU)":"UP"' | '"The Elder Scrolls Online (PS4 - EU)":"DOWN"' | '"The Elder Scrolls Online (PS4 - US)":"UP"' | '"The Elder Scrolls Online (PS4 - US)":"DOWN"' | '"The Elder Scrolls Online (XBox - EU)":"UP"' | '"The Elder Scrolls Online (XBox - EU)":"DOWN"' | '"The Elder Scrolls Online (XBox - US)":"UP"' | '"The Elder Scrolls Online (XBox - US)":"DOWN"' | '"The Elder Scrolls Online (PTS)":"UP"' | '"The Elder Scrolls Online (PTS)":"DOWN"';

package/lib/type/remoteRaw.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=remoteRaw.type.js.map

package/lib/type/remoteRawSlug.type.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Different slugs of announcements
+ */
+export type RemoteRawSlug = 'The Elder Scrolls Online (EU)' | 'The Elder Scrolls Online (NA)' | 'The Elder Scrolls Online (PS4 - EU)' | 'The Elder Scrolls Online (PS4 - US)' | 'The Elder Scrolls Online (PTS)' | 'The Elder Scrolls Online (XBox - EU)' | 'The Elder Scrolls Online (XBox - US)';

package/lib/type/remoteRawSlug.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=remoteRawSlug.type.js.map

package/lib/type/remoteRawStatus.type.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Different statuses of announcements
+ */
+export type RemoteRawStatus = 'UP' | 'DOWN';

package/lib/type/remoteRawStatus.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=remoteRawStatus.type.js.map

package/lib/type/remoteResultCode.type.d.ts

@@ -0,0 +1,4 @@
+/**
+ * API result code
+ */
+export type RemoteResultCode = 200;

package/lib/type/remoteResultCode.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=remoteResultCode.type.js.map

package/lib/type/remoteResultMessage.type.d.ts

@@ -0,0 +1,4 @@
+/**
+ * API result message
+ */
+export type RemoteResultMessage = 'success';

package/lib/type/remoteResultMessage.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=remoteResultMessage.type.js.map

package/lib/type/sourceUrl.type.d.ts

@@ -0,0 +1,4 @@
+/**
+ * URL serving as source for retrieving maintenance announcements
+ */
+export type SourceUrl = 'https://live-services.elderscrollsonline.com/status/realms';

package/lib/type/sourceUrl.type.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=sourceUrl.type.js.map

package/package.json

@@ -1,12 +1,41 @@
 {
   "name": "@eso-status/live-services",
-  "version": "2.0.0-dev.0",
+  "version": "2.0.0-dev.1",
   "description": "Library for retrieving and formatting data, which can be found at https://live-services.elderscrollsonline.com/status/realms",
   "author": "@dov118 <contact@dov118.dev> (https://dov118.dev)",
   "main": "lib/index.js",
   "license": "MIT",
   "engineStrict": true,
-  "files": [],
+  "files": [
+    "lib/interface/esoStatusRawData.interface.d.ts",
+    "lib/interface/esoStatusRawData.interface.js",
+    "lib/interface/rawAssociation.interface.d.ts",
+    "lib/interface/rawAssociation.interface.js",
+    "lib/interface/remoteData.interface.d.ts",
+    "lib/interface/remoteData.interface.js",
+    "lib/type/remoteRaw.type.d.ts",
+    "lib/type/remoteRaw.type.js",
+    "lib/type/remoteRawSlug.type.d.ts",
+    "lib/type/remoteRawSlug.type.js",
+    "lib/type/remoteRawStatus.type.d.ts",
+    "lib/type/remoteRawStatus.type.js",
+    "lib/type/remoteResultCode.type.d.ts",
+    "lib/type/remoteResultCode.type.js",
+    "lib/type/remoteResultMessage.type.d.ts",
+    "lib/type/remoteResultMessage.type.js",
+    "lib/type/sourceUrl.type.d.ts",
+    "lib/type/sourceUrl.type.js",
+    "lib/connector.d.ts",
+    "lib/connector.js",
+    "lib/const.d.ts",
+    "lib/const.js",
+    "lib/index.d.ts",
+    "lib/index.js",
+    ".npmrc,",
+    "LICENSE.md",
+    "package.json",
+    "README.md"
+  ],
   "engines": {
     "node": "^18.18.0 || ^20.0.0"
   },