@equinor/echo-framework 0.8.4 → 0.8.7

package/dist/src/services/api/api-tag-details.js

@@ -0,0 +1,66 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+});
+
+var _tslib = require('../../../_virtual/_tslib.js');
+
+var echoBase = require('@equinor/echo-base');
+
+var echoSearch = require('@equinor/echo-search');
+/**
+ * Wraps Search.Tags.getTagDetailsAsync(), and throws proper NotFoundError if search was unable to find the given tag.
+ * It also converts Search's result.error responses to proper errors and throws them.
+ *
+ * @param {Object} param
+ * @param {string} params.tagNo The tag number to query.
+ * @param {string} params.instCode Plant installation code for the given tag.
+ * @param {AbortSignal} params.abortSignal A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object.
+ * @throws {NotFoundError} NotFoundError when there are no matches for the tagNo instCode pair.
+ * @throws {BaseError} In any other failed API call.
+ * @returns {Promise<TagDetailsDto>} Promise resolving in tag details DTO.
+ */
+
+
+function getTagDetails(_ref) {
+  var tagNo = _ref.tagNo,
+      instCode = _ref.instCode,
+      abortSignal = _ref.abortSignal;
+  return _tslib.__awaiter(this, void 0, void 0, /*#__PURE__*/regeneratorRuntime.mark(function _callee() {
+    var result;
+    return regeneratorRuntime.wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            _context.next = 2;
+            return echoSearch.Search.Tags.getTagDetailsAsync(tagNo, instCode, abortSignal);
+
+          case 2:
+            result = _context.sent;
+            echoSearch.resultHelper.throwIfError(result);
+
+            if (result.value) {
+              _context.next = 6;
+              break;
+            }
+
+            throw new echoBase.NotFoundError({
+              message: "Could not find ".concat(instCode, " ").concat(tagNo),
+              httpStatusCode: 404,
+              url: 'getTagDetails'
+            });
+
+          case 6:
+            return _context.abrupt("return", result.value);
+
+          case 7:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  }));
+}
+
+exports.getTagDetails = getTagDetails;

package/dist/src/services/api/api-tags.js

@@ -0,0 +1,29 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+});
+
+var apiManager = require('./api-manager.js');
+/**
+ * Fetches tag information from ProCoSys.
+ *
+ * @param {Object} param
+ * @param {string} params.tagNo The tag number to query.
+ * @param {string} params.instCode Plant installation code for the given tag.
+ * @param {AbortSignal} params.abortSignal A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object.
+ * @throws {BaseError} If the response can't be parsed to JSON.
+ * @throws {Error} In any other API call issues.
+ * @returns {Promise<TProCoSysApiTag[]>} Promise resolving in array of tags.
+ */
+
+
+function getTagFromProCoSys(_ref) {
+  var instCode = _ref.instCode,
+      tagNo = _ref.tagNo,
+      abortSignal = _ref.abortSignal;
+  var url = "".concat(apiManager.baseApiUrl, "/").concat(instCode, "/tags/procosys?tagNo=").concat(tagNo);
+  return apiManager.request(url, [], abortSignal);
+}
+
+exports.getTagFromProCoSys = getTagFromProCoSys;

package/dist/src/services/echopediaAnalyticsModule/echopediaAnalyticsModule.js

@@ -0,0 +1,10 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+});
+
+var EchoCore = require('@equinor/echo-core');
+
+var echopediaAnalyticsModule = EchoCore.analytics.createAnalyticsModule('ep');
+exports.echopediaAnalyticsModule = echopediaAnalyticsModule;

package/dist/src/types/pingableSources.js

@@ -7,4 +7,5 @@ exports.PingableSources = void 0;
 
 (function (PingableSources) {
   PingableSources["Sap"] = "https://p03web.statoil.no/sap/public/icmandir/its/lsgui/images/img/splashscreen_corbu.png";
+  PingableSources["Statos"] = "https://satos.equinor.com/files/4/bilder/johan_svedrup.png";
 })(exports.PingableSources || (exports.PingableSources = {}));

package/dist/src/utils/navigationUtils.js

@@ -0,0 +1,28 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', {
+  value: true
+});
+
+var echopediaAnalyticsModule = require('../services/echopediaAnalyticsModule/echopediaAnalyticsModule.js');
+/**
+ * Helper function to execute a redirection to an outer source.
+ *
+ * @param {string} link Link to navigate to.
+ * @param {boolean} redirect Set this to 'true' to load the given url to navigate to in the current tab / window.
+ */
+
+
+var goToExternalLink = function goToExternalLink(link, redirect) {
+  echopediaAnalyticsModule.echopediaAnalyticsModule.trackEventBy('ExternalLink', 'Opened', {
+    linkTo: link
+  });
+
+  if (redirect) {
+    window.location.href = link;
+  } else {
+    window.open(link, '_blank');
+  }
+};
+
+exports.goToExternalLink = goToExternalLink;

package/dist/src/utils/plantInfo.js

@@ -528,3 +528,4 @@ exports.getPlant = getPlant;
 exports.getPlantBySapId = getPlantBySapId;
 exports.getPlantCodesOnInstallation = getPlantCodesOnInstallation;
 exports.getPlantsOnInstallation = getPlantsOnInstallation;
+exports.setPlantInfo = setPlantInfo;

package/dist/types/api-proCoSysTagResponse.d.ts

@@ -0,0 +1,8 @@
+export declare type ProCoSysApiTag = {
+    id: number;
+    tagNo: string;
+    description: string;
+    isMaster: boolean;
+    projectName: string;
+    registerId: string;
+};

package/dist/types/pingableSources.d.ts

@@ -1,3 +1,4 @@
 export declare enum PingableSources {
-    Sap = "https://p03web.statoil.no/sap/public/icmandir/its/lsgui/images/img/splashscreen_corbu.png"
+    Sap = "https://p03web.statoil.no/sap/public/icmandir/its/lsgui/images/img/splashscreen_corbu.png",
+    Statos = "https://satos.equinor.com/files/4/bilder/johan_svedrup.png"
 }

package/dist/utils/index.d.ts

@@ -1 +1,2 @@
+export * from './navigationUtils';
 export * from './plantInfo';

package/dist/utils/navigationUtils.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Helper function to execute a redirection to an outer source.
+ *
+ * @param {string} link Link to navigate to.
+ * @param {boolean} redirect Set this to 'true' to load the given url to navigate to in the current tab / window.
+ */
+export declare const goToExternalLink: (link: string, redirect?: boolean | undefined) => void;

package/dist/utils/navigationUtils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/plantInfo.d.ts

@@ -1,4 +1,10 @@
 import { EchoHubPlant } from '../types/echoHubPlant';
+/**
+ * Method for setting echo hub plant information in local storage under the key echoHubPlantInfo
+ *
+ * @param {EchoHubPlant[]} plants list of plant information to add to local storage
+ */
+export declare function setPlantInfo(plants: EchoHubPlant[]): void;
 /**
  * Method for getting echo hub plant information from local storage.
  * If plant information is not in local storage, then this method will try to fetch the information

package/dist/utils/plantInfo.test.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@equinor/echo-framework",
-    "version": "0.8.4",
+    "version": "0.8.7",
     "description": "Modules and components for EchoWeb, utilizing EchoCore",
     "main": "dist/src/index.js",
     "types": "dist/index.d.ts",
@@ -38,7 +38,7 @@
         "@equinor/echo-components": "^0.4.0",
         "@equinor/echo-core": "^0.6.11",
         "@equinor/echo-search": "^0.12.1",
-        "@equinor/echo-utils": "^0.2.9",
+        "@equinor/echo-utils": "^0.2.11",
         "@equinor/eds-core-react": "^0.19.0",
         "react": "^17.0.2",
         "react-dom": "^17.0.2",
@@ -55,7 +55,7 @@
         "@equinor/echo-scripts": "^0.1.5",
         "@equinor/echo-search": "^0.12.1",
         "@equinor/echo-update": "^1.3.0",
-        "@equinor/echo-utils": "^0.2.9",
+        "@equinor/echo-utils": "^0.2.10",
         "@equinor/eds-core-react": "^0.19.0",
         "@modular-css/rollup": "^28.0.0",
         "@rollup/plugin-babel": "^5.3.1",