@equinor/echo-framework 0.11.2 → 0.11.4

package/dist/services/api/api-tag-list-for-3D.d.ts

@@ -0,0 +1,25 @@
+import { TemporaryEchoHubListDto, TemporaryHubListCreatedResponse } from '../../types/api-echohub';
+/**
+ * Method for creating a temporarily hub list, method will return urls to open this list in 3D App and 3D web
+ * List is valid for 1 month when using this method
+ * Will throw error if api call goes wrong
+ *
+ * @param {string} instCode the users instCode
+ * @param {TemporaryEchoHubListDto} request the request used to create the list. See type description
+ * @param {(AbortSignal | undefined)} [abortSignal] the abort signal
+ * @return {*} returns urls to open created list in 3D app and 3D web.
+ */
+export declare const getTemporarilyEchoHubListFor3D: (instCode: string, request: TemporaryEchoHubListDto, abortSignal?: AbortSignal | undefined) => Promise<{
+    app3dUrl: string;
+    web3dUrl: string;
+}>;
+/**
+ * Method for creating a temporarily hub list, method will return urls to open this list in 3D App and the lists ID
+ * Use getTemporarilyEchoHubListFor3D method for getting url for both 3D App and 3D web
+ * Will throw error if api call goes wrong
+ *
+ * @param {TemporaryEchoHubListDto} request the request used to create the list. See type description
+ * @param {(AbortSignal | undefined)} [abortSignal] the abort signal
+ * @return {*}  {(Promise<TemporaryHubListCreatedResponse>)} returns url to open created list in 3D app and lists ID.
+ */
+export declare const createTemporarilyEchoHubListFor3D: (request: TemporaryEchoHubListDto, abortSignal?: AbortSignal | undefined) => Promise<TemporaryHubListCreatedResponse>;

package/dist/services/api/api-tag-list-for-3D.test.d.ts

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

package/dist/services/api/index.d.ts

@@ -1,2 +1,3 @@
 export * from './api-plantinfo';
 export { getTagDetails } from './api-tag-details';
+export * from './api-tag-list-for-3D';

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

@@ -0,0 +1,36 @@
+export interface TemporaryEchoHubListDto {
+    /**  The main name of the list  */
+    name: string;
+    /** The description for the list */
+    description: string;
+    /** The user name that created this list */
+    createdBy: string;
+    /** Sender ID, used for identify the sender for diagnostics and logging.*/
+    source: string;
+    /** Which plant the list and its tags belong to */
+    plant: string;
+    /**  Ideally could be used for plant section id */
+    section?: string;
+    /**  The list of tags in the Echo hub list, can be multiple lists */
+    results: TemporaryHubResultsList[];
+    /**  How long the list is valid, timeToLiveSeconds is -1 it will never be removed, if its Zero (0) or Undefined then the api will fail the request */
+    timeToLiveSeconds?: number;
+}
+export interface TemporaryHubResultsList {
+    /**  The display name for this list of tags */
+    name: string;
+    /**  The list of tag no's to highlight */
+    tags: string[];
+    /** The color that should be applied to the highlighted tags */
+    color: string;
+    /**  properties that can be added to a list */
+    properties?: {
+        [key: string]: string;
+    };
+}
+export interface TemporaryHubListCreatedResponse {
+    /**  The id of the list created */
+    id: string;
+    /**  The url to the 3D App */
+    url: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@equinor/echo-framework",
-    "version": "0.11.2",
+    "version": "0.11.4",
     "description": "Modules and components for EchoWeb, utilizing EchoCore",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -52,7 +52,7 @@
         "@babel/preset-env": "^7.20.2",
         "@babel/preset-react": "^7.18.6",
         "@equinor/echo-base": "^0.6.22",
-        "@equinor/echo-components": "^0.5.24",
+        "@equinor/echo-components": "^0.5.26",
         "@equinor/echo-core": "^0.7.5",
         "@equinor/echo-scripts": "^0.1.5",
         "@equinor/echo-search": "^0.13.13",