@equinor/echo-framework 0.11.0-rc9 → 0.11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (131) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +11 -11
  3. package/dist/{f4c85313e79b1662.svg → 1bd97dd2170d0f64.svg} +850 -850
  4. package/dist/{063009f06499d102.svg → 47deeba42768c5d1.svg} +8 -8
  5. package/dist/__tests__/3dButtonUtils.test.d.ts +1 -0
  6. package/dist/components/containers/layouts.d.ts +1 -1
  7. package/dist/components/contextualAppLinks/contextualAppLinks.context.d.ts +1 -1
  8. package/dist/components/contextualAppLinks/contextualAppLinks.d.ts +1 -1
  9. package/dist/components/contextualAppLinks/externalAppsMenu.d.ts +1 -1
  10. package/dist/components/contextualAppLinks/externalLinkButtons/externalLinkButtons.helpers.d.ts +2 -2
  11. package/dist/components/contextualAppLinks/externalLinkButtons/externalLinkToCommApp.d.ts +1 -1
  12. package/dist/components/contextualAppLinks/externalLinkButtons/externalLinkToConditionAdviser.d.ts +1 -1
  13. package/dist/components/contextualAppLinks/externalLinkButtons/externalLinkToMcApp.d.ts +1 -1
  14. package/dist/components/contextualAppLinks/externalLinkButtons/externalLinkToProCoSys.d.ts +1 -1
  15. package/dist/components/contextualAppLinks/externalLinkButtons/externalLinkToSafeX.d.ts +1 -1
  16. package/dist/components/contextualAppLinks/externalLinkButtons/externalLinkToSap.d.ts +1 -1
  17. package/dist/components/contextualAppLinks/externalLinkButtons/externalLinkToSemiDoc.d.ts +1 -1
  18. package/dist/components/contextualAppLinks/externalLinkButtons/externalLinkToStid.d.ts +1 -1
  19. package/dist/components/contextualAppLinks/externalLinkButtons/externalLinkToTr2000.d.ts +1 -1
  20. package/dist/components/contextualAppLinks/externalLinkButtons/externalLinkToTrendingApp.d.ts +1 -1
  21. package/dist/components/contextualAppLinks/externalLinkButtons/iconButtonSpinner.d.ts +1 -1
  22. package/dist/components/contextualAppLinks/externalLinkButtons/trainingCenterForValvesMenu.d.ts +7 -0
  23. package/dist/components/contextualAppLinks/hooks/useContextualAppLinks.d.ts +1 -1
  24. package/dist/components/contextualAppLinks/index.d.ts +1 -1
  25. package/dist/components/contextualAppLinks/internalAppLinks.d.ts +1 -1
  26. package/dist/components/contextualAppLinks/linkButton.d.ts +2 -2
  27. package/dist/components/echo3DButton/3dButtonUtils.d.ts +12 -0
  28. package/dist/components/echo3DButton/OpenIn3dDropdown.d.ts +11 -0
  29. package/dist/components/echo3DButton/echo3DButton.d.ts +18 -0
  30. package/dist/components/echo3DButton/echo3DIconButton.d.ts +26 -0
  31. package/dist/components/echo3DButton/icons/E3DWebBetaIcon.d.ts +6 -0
  32. package/dist/components/echo3DButton/index.d.ts +2 -0
  33. package/dist/components/echo3DButton/missingEcho3dAccessDialog.d.ts +8 -0
  34. package/dist/components/echo3DButton/plantNotAvailableInfo.d.ts +6 -0
  35. package/dist/components/echo3DButton/useGetOpenIn3d.d.ts +5 -0
  36. package/dist/components/echo3DButton/useGoToEcho3DWebLink.d.ts +1 -0
  37. package/dist/components/externalLinkButton/externalLinkButton.d.ts +6 -5
  38. package/dist/components/homePage/HomePage.d.ts +1 -2
  39. package/dist/components/index.d.ts +2 -1
  40. package/dist/components/pageMenu/defaultAccordionItem.d.ts +1 -1
  41. package/dist/components/panel/corePanelLeft.d.ts +1 -4
  42. package/dist/components/panel/corePanelRight.d.ts +1 -4
  43. package/dist/components/prepview/Prepview.d.ts +3 -1
  44. package/dist/components/prepview/api/attachment.d.ts +1 -1
  45. package/dist/components/prepview/api/resources.d.ts +1 -0
  46. package/dist/components/prepview/common/access/request/RequestAccess.d.ts +1 -1
  47. package/dist/components/prepview/common/additionalInformation/AdditionalDetails.d.ts +11 -0
  48. package/dist/components/prepview/common/additionalInformation/tabsPanels/TabsPanels.d.ts +15 -0
  49. package/dist/components/prepview/common/additionalInformation/tabsPanels/index.d.ts +1 -0
  50. package/dist/components/prepview/common/index.d.ts +1 -0
  51. package/dist/components/prepview/common/info/section/longText/LongTextSection.d.ts +1 -0
  52. package/dist/components/prepview/common/link/Link.d.ts +7 -0
  53. package/dist/components/prepview/context/PrepviewContext.d.ts +1 -0
  54. package/dist/components/prepview/hooks/index.d.ts +1 -0
  55. package/dist/components/prepview/hooks/useFetch.d.ts +1 -1
  56. package/dist/components/prepview/hooks/useOnClickDownload.d.ts +1 -1
  57. package/dist/components/prepview/hooks/useSetActiveSearchItem.d.ts +10 -0
  58. package/dist/components/prepview/notification/details/{Details.d.ts → DetailsNotification.d.ts} +3 -2
  59. package/dist/components/prepview/notification/details/index.d.ts +1 -1
  60. package/dist/components/prepview/notification/header/Header.d.ts +8 -0
  61. package/dist/components/prepview/notification/header/index.d.ts +1 -0
  62. package/dist/components/prepview/notification/index.d.ts +1 -0
  63. package/dist/components/prepview/panels/history/items/Items.d.ts +1 -1
  64. package/dist/components/prepview/punch/details/Details.d.ts +2 -1
  65. package/dist/components/prepview/{workorder → punch}/header/Header.d.ts +2 -2
  66. package/dist/components/prepview/punch/header/index.d.ts +1 -0
  67. package/dist/components/prepview/punch/index.d.ts +1 -0
  68. package/dist/components/prepview/types/attachment.d.ts +1 -1
  69. package/dist/components/prepview/types/common.d.ts +40 -3
  70. package/dist/components/prepview/types/document.d.ts +2 -2
  71. package/dist/components/prepview/types/notification.d.ts +5 -5
  72. package/dist/components/prepview/types/operation.d.ts +1 -1
  73. package/dist/components/prepview/types/punch.d.ts +3 -2
  74. package/dist/components/prepview/types/safety.d.ts +1 -1
  75. package/dist/components/prepview/types/tag.d.ts +2 -2
  76. package/dist/components/prepview/types/workorder.d.ts +5 -5
  77. package/dist/components/prepview/utils/index.d.ts +1 -1
  78. package/dist/components/prepview/utils/logger.d.ts +10 -10
  79. package/dist/components/prepview/utils/notification.d.ts +3 -0
  80. package/dist/components/prepview/utils/punch.d.ts +1 -0
  81. package/dist/components/prepview/utils/url.d.ts +1 -1
  82. package/dist/components/prepview/utils/workorder.d.ts +1 -1
  83. package/dist/components/prepview/workorder/details/{Details.d.ts → DetailsWorkOrder.d.ts} +3 -2
  84. package/dist/components/prepview/workorder/details/index.d.ts +1 -1
  85. package/dist/components/prepview/workorder/header/WorkOrderHeader.d.ts +9 -0
  86. package/dist/components/prepview/workorder/header/index.d.ts +1 -1
  87. package/dist/components/prepview/workorder/index.d.ts +3 -1
  88. package/dist/components/realTimeData/hooks/useRealTimeHub.d.ts +1 -1
  89. package/dist/components/realTimeData/hooks/useSignalRListener.d.ts +1 -1
  90. package/dist/components/tagNumber/tagNumber.d.ts +3 -2
  91. package/dist/coreApplication/EchoBarComponent.d.ts +0 -8
  92. package/dist/coreApplication/EchoSetup.d.ts +1 -1
  93. package/dist/coreApplication/EchoToolBar.d.ts +16 -2
  94. package/dist/coreApplication/{EchoUserInterfaceContextProvider.d.ts → EchoUserInterfaceStore.d.ts} +8 -8
  95. package/dist/coreApplication/index.d.ts +1 -1
  96. package/dist/hooks/index.d.ts +3 -0
  97. package/dist/hooks/useEchoHistory.d.ts +2 -2
  98. package/dist/hooks/useHas3dAccess.d.ts +1 -0
  99. package/dist/hooks/usePlantAvailableIn3d.d.ts +1 -0
  100. package/dist/hooks/usePlantAvailableIn3dWeb.d.ts +1 -0
  101. package/dist/hooks/useScreenValues.d.ts +1 -1
  102. package/dist/hooks/useSemi.d.ts +1 -1
  103. package/dist/hooks/useWindowSize.d.ts +1 -1
  104. package/dist/index.css +1 -1
  105. package/dist/index.d.ts +25 -1
  106. package/dist/index.js +30 -3
  107. package/dist/services/api/api-manager.d.ts +1 -1
  108. package/dist/services/componentRegistry/componentRegistry.d.ts +27 -7
  109. package/dist/services/deviceInformation/deepDeviceInfo.d.ts +41 -0
  110. package/dist/services/deviceInformation/deviceInfo.d.ts +45 -0
  111. package/dist/services/searchItemDetails/searchItemDetails.store.d.ts +26 -0
  112. package/dist/services/searchItemDetails/searchItemDetails.store.test.d.ts +1 -0
  113. package/dist/services/searchItemDetails/searchItemDetailsContainer.d.ts +6 -0
  114. package/dist/theme/themeConst.d.ts +1 -0
  115. package/dist/types/api-proCoSysTagResponse.d.ts +1 -1
  116. package/dist/types/device.d.ts +53 -0
  117. package/dist/types/eventTypes/index.d.ts +1 -0
  118. package/dist/types/eventTypes/searchDetailsContainerEvents.d.ts +3 -0
  119. package/dist/types/hookLibrary.d.ts +20 -5
  120. package/dist/types/legend.d.ts +1 -0
  121. package/dist/utils/arrayUtils.d.ts +8 -0
  122. package/dist/utils/arrayUtils.test.d.ts +1 -0
  123. package/dist/utils/legendUtils.d.ts +7 -4
  124. package/dist/utils/tagUtils.d.ts +23 -0
  125. package/dist/utils/tagUtils.test.d.ts +1 -0
  126. package/package.json +126 -123
  127. package/dist/components/prepview/notification/additionalDetails/AdditionalDetails.d.ts +0 -9
  128. package/dist/components/prepview/notification/additionalDetails/index.d.ts +0 -1
  129. package/dist/components/prepview/utils/status.d.ts +0 -3
  130. package/dist/components/prepview/workorder/additionalDetails/AdditionalDetails.d.ts +0 -9
  131. package/dist/components/prepview/workorder/additionalDetails/index.d.ts +0 -1
@@ -1,4 +1,7 @@
1
1
  export * from './useEchoHistory';
2
+ export * from './useHas3dAccess';
3
+ export * from './usePlantAvailableIn3d';
4
+ export * from './usePlantAvailableIn3dWeb';
2
5
  export * from './useScreenOrientation';
3
6
  export * from './useScreenValues';
4
7
  export * from './useTagDetails';
@@ -1,7 +1,7 @@
1
- declare type EchoHistoryParams = {
1
+ type EchoHistoryParams = {
2
2
  [key: string]: string;
3
3
  };
4
- declare type EchoHistory = (path: string, params?: EchoHistoryParams | undefined, state?: any) => void;
4
+ type EchoHistory = (path: string, params?: EchoHistoryParams | undefined, state?: any) => void;
5
5
  /**
6
6
  * Hook returns a Echo compliant push function for the browser history
7
7
  * Which supports deeplinking functionality via EchoHistoryParams and forces to use instCode.
@@ -0,0 +1 @@
1
+ export declare function useHas3dAccess(plantCode?: string): boolean;
@@ -0,0 +1 @@
1
+ export declare function usePlantAvailableIn3d(plantCode?: string): boolean;
@@ -0,0 +1 @@
1
+ export declare function usePlantAvailableIn3dWeb(plantCode?: string): boolean;
@@ -5,7 +5,7 @@ import { ScreenOrientation } from '../types/hookLibrary';
5
5
  * @returns {boolean} response.isScreenMobileSize If the device screen is small or not
6
6
  * @returns {ScreenOrientation} response.screenOrientation
7
7
  */
8
- declare type DeviceValues = {
8
+ type DeviceValues = {
9
9
  isScreenMobileSize: boolean;
10
10
  screenOrientation: ScreenOrientation;
11
11
  };
@@ -13,7 +13,7 @@ export declare function useSemi({ tagNo, instCode }: {
13
13
  tagNo: string;
14
14
  instCode: string;
15
15
  }): Semi;
16
- declare type Semi = {
16
+ type Semi = {
17
17
  isSemiDocumentAvailable: boolean;
18
18
  semiDocumentId: string;
19
19
  isSemiLoading: boolean;
@@ -1,7 +1,7 @@
1
1
  /**
2
2
  * Get the current size of the browser window.
3
3
  * @returns {width?: number; height?: number} Width and height of the current browser size.
4
-
4
+
5
5
  */
6
6
  export declare function useWindowSize(): {
7
7
  width: number;
package/dist/index.css CHANGED
@@ -1 +1 @@
1
- :root{--xSmall:0.25rem;--small:0.5rem;--medium:1rem;--large:1.5rem;--xLarge:2rem;--black:#000;--white:#fff;--equiBlue1:#233746;--equiBlue2:#d7e1ed;--equiBlue3:#d5eaf4;--equiGray1:#87929a;--equiGray2:#b4bbc0;--equiGray3:#d1d5d8;--equiGray4:#e3e6e8;--equiRed1:#ff1243;--darkEquiRed:#ce183e;--equiGreen1:#006f79;--equiGreen2:#deedee;--equiGreen3:#e6faec;--echoText:#3d3d3d;--disabledBackgroundColor:#eaeaea;--disabledColor:#6f6f6f;--onGoing:#fbca36;--done:#4bb748;--asBuilt:#007079;--planned:#4bb748;--future:#52c0ff;--historic:#ff7d98;--outOfService:#ff9200;--reserved:#243746;--voided:#eb0000;--default:#dcdcdc;--ok:#23ef2a;--os:#adaead;--pa:#f94693;--pb:#fd0;--unknown:#525252;--rfccSent:#bcf316;--rfccPartly:#c7f316;--rfcc:#60f316;--rfocSent:#0dccf2;--rfocPartly:#1accf2;--rfoc:#0d59f2;--rfccRejected:#ff1243;--rfocRejected:#ff1243;--handoverError:#eb0000;--priorityHigh:#ff1243;--priorityMedium:#fbca36;--systems:#d5eaf4;--locations:#3eb54a;--warningText:#ad6200;--warningIcon:#ff9200;--warningBackground:#ffe7d6;--dropDownButtonBackground:#f0f0f0;--dropDownTextColor:grey;--searchBarBackground:#f7f7f7;--highSeverity:#ffc1c1;--mediumSeverity:#ffe7d6;--lowSeverity:#dce6ee;--defaultSeverity:#d5eaf4;--highSeverityText:#eb0000;--mediumSeverityText:#52c0ff;--lowSeverityText:#4bb748;--defaultSeverityText:#3d3d3d;--toggleActive:#4bb748;--toggleInactive:#b30d2f;--hoverIcon:#004f55;--tertiaryText:#6f6f6f}#root,body,html{height:100%;overflow:hidden;width:100%}html[data-theme=dark]{--equiGreen1:#006f79}body,h1,h2,h3,h4,h5,h6,label,p{color:var(--echoText)}body,html,span{font-family:Equinor!important}::-webkit-scrollbar{width:10px}::-webkit-scrollbar-track{background:#f7f7f7;border-radius:5px}::-webkit-scrollbar-thumb{background:#007079;border-radius:5px}::-webkit-scrollbar-thumb:hover{background:#004f55}button,input{appearance:none;background:transparent;border:inherit;color:inherit;font:inherit;outline:0}input,input:after,input:before{-webkit-user-select:initial;-khtml-user-select:initial;-moz-user-select:initial;-ms-user-select:initial;user-select:auto}
1
+ :root{--xSmall:0.25rem;--small:0.5rem;--medium:1rem;--large:1.5rem;--xLarge:2rem;--black:#000;--white:#fff;--equiBlue1:#233746;--equiBlue2:#d7e1ed;--equiBlue3:#d5eaf4;--equiGray1:#87929a;--equiGray2:#b4bbc0;--equiGray3:#d1d5d8;--equiGray4:#e3e6e8;--equiRed1:#ff1243;--darkEquiRed:#ce183e;--equiGreen1:#006f79;--equiGreen2:#deedee;--equiGreen3:#e6faec;--echoText:#3d3d3d;--disabledBackgroundColor:#eaeaea;--disabledColor:#6f6f6f;--onGoing:#fbca36;--done:#4bb748;--asBuilt:#007079;--planned:#4bb748;--future:#52c0ff;--historic:#ff7d98;--outOfService:#ff9200;--reserved:#243746;--voided:#eb0000;--default:#dcdcdc;--ok:#23ef2a;--os:#adaead;--pa:#f94693;--pb:#fd0;--unknown:#525252;--rfccSent:#bcf316;--rfccPartly:#c7f316;--rfcc:#60f316;--rfocSent:#0dccf2;--rfocPartly:#1accf2;--rfoc:#0d59f2;--rfccRejected:#ff1243;--rfocRejected:#ff1243;--handoverError:#eb0000;--priorityHigh:#ff1243;--priorityMedium:#fbca36;--systems:#d5eaf4;--locations:#3eb54a;--warningText:#ad6200;--warningIcon:#ff9200;--warningBackground:#ffe7d6;--dropDownButtonBackground:#f0f0f0;--dropDownTextColor:grey;--searchBarBackground:#f7f7f7;--highSeverity:#ffc1c1;--mediumSeverity:#ffe7d6;--lowSeverity:#dce6ee;--defaultSeverity:#d5eaf4;--highSeverityText:#eb0000;--mediumSeverityText:#52c0ff;--lowSeverityText:#4bb748;--defaultSeverityText:#3d3d3d;--toggleActive:#4bb748;--toggleInactive:#b30d2f;--hoverIcon:#004f55;--tertiaryText:#6f6f6f;--dividerColor:#dcdcdc}#root,body,html{height:100%;overflow:hidden;width:100%}html[data-theme=dark]{--equiGreen1:#006f79}body,h1,h2,h3,h4,h5,h6,label,p{color:var(--echoText)}body,html,span{font-family:Equinor!important}::-webkit-scrollbar{width:10px}::-webkit-scrollbar-track{background:#f7f7f7;border-radius:5px}::-webkit-scrollbar-thumb{background:#007079;border-radius:5px}::-webkit-scrollbar-thumb:hover{background:#004f55}button,input{appearance:none;background:transparent;border:inherit;color:inherit;font:inherit;outline:0}input,input:after,input:before{-webkit-user-select:initial;-khtml-user-select:initial;-moz-user-select:initial;-ms-user-select:initial;user-select:auto}
package/dist/index.d.ts CHANGED
@@ -10,7 +10,11 @@ export { useIsCompactLayout } from './hooks/useIsCompactLayout';
10
10
  export { useScreenOrientation } from './hooks/useScreenOrientation';
11
11
  export { useScreenValues } from './hooks/useScreenValues';
12
12
  export { RegisteredComponentName } from './services/componentRegistry/componentRegistry';
13
+ export { DetailedDeviceInformationProvider, detailedDeviceInformationProvider } from './services/deviceInformation/deepDeviceInfo';
14
+ export { deviceInfo, DeviceInformation } from './services/deviceInformation/deviceInfo';
13
15
  export * from './services/eventHubActions';
16
+ export * from './services/searchItemDetails/searchItemDetails.store';
17
+ export { SearchItemDetailsContainer } from './services/searchItemDetails/searchItemDetailsContainer';
14
18
  export * from './theme/themeConst';
15
19
  export type { EchoHubPlant } from './types/echoHubPlant';
16
20
  export * from './types/eventTypes';
@@ -20,7 +24,7 @@ export { LegendStatus, LegendType } from './types/legend';
20
24
  export type { ModelPermissions } from './types/modelPermissions';
21
25
  export { PingableSources } from './types/pingableSources';
22
26
  export * from './utils';
23
- export { getLegendStatusColor, legendTypeToLegendStatus, valueToEnum } from './utils/legendUtils';
27
+ export { getLegendStatusColor, legendTypeToLegendStatus, toLegendStatusOrString, valueToEnum } from './utils/legendUtils';
24
28
  export * from './utils/startup';
25
29
  export declare const registerEchopediaComponent: ({ name, component }: {
26
30
  name: import("./services/componentRegistry/componentRegistry").RegisteredComponentName;
@@ -36,9 +40,17 @@ declare const EchoFramework: Readonly<{
36
40
  }>;
37
41
  }>;
38
42
  Hooks: Readonly<{
43
+ searchItems: Readonly<{
44
+ useSearchItemDetailsStore: import("zustand").UseBoundStore<Omit<import("zustand").StoreApi<import("./services/searchItemDetails/searchItemDetails.store").SearchItemDetailsState>, "setState"> & {
45
+ setState(nextStateOrUpdater: import("./services/searchItemDetails/searchItemDetails.store").SearchItemDetailsState | Partial<import("./services/searchItemDetails/searchItemDetails.store").SearchItemDetailsState> | ((state: import("immer/dist/internal").WritableDraft<import("./services/searchItemDetails/searchItemDetails.store").SearchItemDetailsState>) => void), shouldReplace?: boolean | undefined): void;
46
+ }>;
47
+ }>;
39
48
  useEchoHistory(): (path: string, params?: {
40
49
  [key: string]: string;
41
50
  } | undefined, state?: any) => void;
51
+ useHas3dAccess(plantCode?: string | undefined): boolean;
52
+ usePlantAvailableIn3d(plantCode?: string | undefined): boolean;
53
+ usePlantAvailableIn3dWeb(plantCode?: string | undefined): boolean;
42
54
  useScreenOrientation(): import("./types/hookLibrary").ScreenOrientation;
43
55
  useScreenValues(): {
44
56
  isScreenMobileSize: boolean;
@@ -60,7 +72,19 @@ declare const EchoFramework: Readonly<{
60
72
  useSetActiveMcPackNo: () => import("./types/hookLibrary").SetActiveMcPackNo;
61
73
  }>;
62
74
  EchopediaComponentLibrary: Readonly<{
75
+ /**
76
+ * @deprecated Please use 'getTagListItem()' instead - that supports the new search flow
77
+ * Returns with the TagItem component, which is used in EchopediaWeb's search panel
78
+ * and pdf side drawer when listing out tags.
79
+ * @returns {React.FC<any>} legacy TagItem component
80
+ */
63
81
  getTagItem: () => import("react").FunctionComponent<any>;
82
+ /**
83
+ * Returns with the TagItem component, which is used in EchopediaWeb's search panel
84
+ * and pdf side drawer when listing out tags.
85
+ * @returns {React.FC<any>} TagListItem component
86
+ */
87
+ getTagListItem: () => import("react").FunctionComponent<any>;
64
88
  }>;
65
89
  APIs: Readonly<{
66
90
  getPlantsInfo: typeof getPlantsInfo;